CMake 基本使用方法--写CMakeList.txt

最新推荐文章于 2025-03-12 14:25:37 发布

转载最新推荐文章于 2025-03-12 14:25:37 发布 · 693 阅读

编程语言与技巧专栏收录该内容

11 篇文章

订阅专栏

本文详细介绍如何使用CMake进行软件项目构建管理。从简单的HelloWorld示例出发，逐步讲解CMakeLists.txt文件的编写方法，包括如何设置项目名称、添加可执行文件、库文件等，并深入探讨条件编译、依赖管理和跨平台支持等高级特性。

这一章将从软件开发者的角度来描述如何实用CMake。也就是说，如果你的目标是用CMake来管理你的生成过程，请阅读这一章。

CMake的输入

COMMAND(args)

这里的 COMMAND 是命令行的名称，args是用空格分割的参数列表。典型的，对与每一个项目的目录存在一个CMakeLists.txt。下面我们将从一个简单的Hello world例子开始介绍, 它的源代码树形文件包含这些文件：

Hello.c CMakeLists.txt

CMakeLists.txt将包含下面两行：

PROJECT（Hello)
ADD_EXECUTABLE(Hello Hello.c）

为了生成Hello的可执行程序，你只需依照上面CMake运行的过程描述来生成makefiles文件。 PROJECT 命令表明了产生的工作空间的名称。 ADD_EXECUTABLE命令添加可执行的目标到生成程序。这个简单的程序就只需要这些设置。如歌你的项目需要一些文件才能编译也很容易，只想修改ADD_EXECUTABLE命令行如下：

ADD_EXECUTABLE（Hello Hello.c File2.c File3.c File4.c)

ADD_EXECUTABLE只是很多CMake命令中的一种。比如更复杂的如下：

PROJECT(HELLO)
SET(HELLO_SRCS Hell.c File2.c File3.c)
IF(WIN32)
  SET(HELLO_SRCS ${HELLO_SRCS} WinSupport.c)
ELSE (WIN32)
  SET(HELLO_SRCS ${HELLO_SRCS} UnixSupport.c)
ENDIF (WIN32)

ADD_EXECUTABLE (Hello ${HELLO_SRCS})

#look for the Tcl library
FIND_LIBRARY(TCL_LIBRARY NAMES tcl tc184 tc183 tc 182 tc 180
  PATHS /usr/lib /usr/local/lib)
IF (TCL_LIBRARY)
  TARGET_ADD_LIBRARY (Hello TCL_LIBRARY)
ENDIF(TCL_LIBRARY)

在这个例子中 SET 命令用于将源文件组成一个列表。 IF 命令用于增加WinSupport.c或者UnixSupport.c到列表中。最后 ADD_EXECUTABLE 命令用于采用源文件列表HELLO_SRCS中列出的文件生成可执行文件。FIND_LIBRARY命令用于寻找在一些指定目录下的特定的Tcl库文件。如果找到了，就将他们添加到Hello可执行程序的链接命令。 #行为注释行。

CMake 是会定义一些使用的变量在CMakeList文件中。比如，WIN32总是会在windows系统中被定义，而UNIX
总是在UNIX系统中被定义。

生成目标：（Build Targets)

SET()
SUBDIRS()
ADD_LIBRARY()
  这里生成静态链接文件，例如ADD_LIBRARY(Whole ${HELLO_SRC}),就会生成一个libWhole.a可供链接

ADD_EXECUTABLE()
AUX_SOURCE_DIRECTORY()
PROJECT()

CMake会循环的查找从当前目录到SUBDIRS列出的任何子目录的文件。SET命令用于设定一个变量。ADD_LIBRARY将添加一个库到目标之中。 ADD_EXECUTABLE添加一个可执行程序到目标列表中。（Note:编译器执行的顺序是先编译源文件，然后生成库文件，最后生成可执行文件）。AUX_SOURCE_DIRECTORY表示一个不在当前目录的包含源文件的目录。这些源代码将插入当前的库（LIBRARY）中。所有在AUX_SOURCE_DIRECTORY的文件将被编译（如，*.c,*.cxx,*.cpp等等）。PROJECT（ProjectName）是一个用在MSVC中的特殊变量，用于为编译器生成项目。他也为CMAKE定义连个有用的变量:ProjectName_SOURCE_DIR和ProjectName_BINARY_DIR.

编译的标示和选项。除了上面列出的命令外，CMakeLists.txt还包含如下的命令：
INCLUDE_DIRECTORIES()
LINK_DIRECTORIES()
LINK_LIBRARIES()
TARGET_LINK_LIBRARIES()

这些命令定义了用于编译源代码和生成可执行程序的目录和库。上面列出的目录的一个很重要的特性是它们会被任何子目录继承。也就是说，CMake依照目录的分层结构来承袭这些命令。在每次遇到对这些命令的描述的时候都会被展开一次。比如说，如果在顶层的CMakeLists文件中有定义INCLUDE_DIRECTORIES(/usr/include)和SUBDIRS（./subdir1),并且在./subdir1/CMakeLists.txt有INCLUDE_DIRECTORIES(/tmp/foobar),于是最后网状的结果是
INCLUDE_DIRECTORIES(/usr/include /tmp/foobar)

CMake会定义许多的模块来查找通常会用到的包，比如OpenGL或Java。这些模块为你节省了很多的时间来编写这些查找包。这些模块可以像这样加到你的CMakeList文件中，如下：

INCLUDE(${CMAKE_ROOT}/Modules/FindTCL.cmake)

CMAKE_ROOT 总是定义在CMake中，用于指向CMake安装的路径。查看Modules子目录下的一些文件可以给你提供一些很好的idea关于怎样用这些CMake命令。

给项目文件添加一个新的目录
一个通用的方法来扩展一个项目文件是给他添加一个新的文件夹。这将包含三个步骤：
1.创建一个新的目录在你的源代码的分层目录中
2.将这个新的目录添加到SUBDIRS命令中
3.在这个新创建的目录中用适当的命令建立一个CMakeLists.txt文件