简介
CMake其实就是建立在makefile之上的抽象框架工具，笔者在搞RTOS时使用过Scons构建工具，Scons是基于python的，原理是管理代码模块直接调用编译器构建编译，但这个CMake就与Scons不同了，它不是直接与编译器沟通，单纯的把你的构建思想转化为makefile文件或者Visual studio工程文件等(最新版本的CMake可以支持很多工程文件),然后再通过这些工程文件来编译构建，因此好处就是跨平台，一套CMake文件，linux和windows上一样管理和构建。
CMake的所有的语句都写在一个叫:CMakeLists.txt 的文件中。
这里是Cmake的源码，感兴趣的读者可以去下载来研究下。
基本语法
- 使用SET(ENV{VAR} VALUE)赋值。
- 使用${}方式取值,但是在IF控制语句中是直接使用变量名。
- 环境变量使用$ENV{}方式取值。
- 指令(参数1 参数2…)参数使用括弧括起,参数之间使用空格或分号分开。
- 指令是大小写无关的,参数和变量是大小写相关的。推荐你全部使用大写指令。
预定义变量
- PROJECT_SOURCE_DIR 工程的根目录。
- PROJECT_BINARY_DIR 运行CMake命令的目录。
- CMAKE_INCLUDE_PATH 环境变量,非CMake变量
- CMAKE_LIBRARY_PATH 环境变量
- CMAKE_CURRENT_SOURCE_DIR 当前处理的CMakeLists.txt所在的路径
- CMAKE_CURRENT_BINARY_DIR target编译目录，使用ADD_SURDIRECTORY(src bin)可以更改此变量的值，SET(EXECUTABLE_OUTPUT_PATH <新路径>)并不会对此变量有影响,只是改变了最终目标文件的存储路径
- CMAKE_CURRENT_LIST_FILE 输出调用这个变量的CMakeLists.txt的完整路径
- CMAKE_CURRENT_LIST_LINE 输出这个变量所在的行
- CMAKE_MODULE_PATH 定义自己的CMake模块所在的路径，SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake),然后可以用INCLUDE命令来调用自己的模块
- EXECUTABLE_OUTPUT_PATH 重新定义目标二进制可执行文件的存放位置
- LIBRARY_OUTPUT_PATH 重新定义目标链接库文件的存放位置
- PROJECT_NAME 返回通过PROJECT指令定义的项目名称
- CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS 用来控制IF ELSE语句的书写方式
- BUILD_SHARED_LIBS 控制默认的库编译方式。
- CMAKE_C_FLAGS 设置C编译选项。
- CMAKE_CXX_FLAGS 设置C++编译选项
常用命令
官网定义了很多命令，这里只把常用的列举下：
-
PROJECT
PROJECT(projectname [CXX] [C] [Java]) 指定工程名称,并可指定工程支持的语言。支持语言列表可忽略,默认支持所有语言 -
SET
SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]]) 定义变量(可以定义多个VALUE,如SET(SRC_LIST main.c util.c reactor.c)) -
SOURCE_GROUP(
[FILES ..] [REGULAR_EXPRESSION ]) 可以让文件分组，使用这个命令可以让工程保持和文件结构一致，组名中可以包含反斜杠，以指定子文件组：source_group(outer\\inner ...)，为了保持后向兼容性，这个命令也支持这种格式：SOURCE_GROUP(NAME REGEX) -
MESSAGE
MESSAGE([SEND_ERROR | STATUS | FATAL_ERROR] “message to display” …) 向终端输出用户定义的信息或变量的值 SEND_ERROR, 产生错误,生成过程被跳过 STATUS, 输出前缀为—的信息 FATAL_ERROR, 立即终止所有cmake过程 -
ADD_EXECUTABLE
ADD_EXECUTABLE(bin_file_name ${SRC_LIST}) 生成可执行文件 -
ADD_LIBRARY
ADD_LIBRARY(libname [SHARED | STATIC | MODULE] [EXCLUDE_FROM_ALL] SRC_LIST) 生成动态库或静态库 SHARED 动态库 STATIC 静态库 MODULE 在使用dyld的系统有效,若不支持dyld,等同于SHARED EXCLUDE_FROM_ALL 表示该库不会被默认构建 -
SET_TARGET_PROPERTIES
设置输出的名称,设置动态库的版本和API版本 -
CMAKE_MINIMUM_REQUIRED
CMAKE_MINIMUM_REQUIRED(VERSION version_number [FATAL_ERROR]) 声明CMake的版本要求 -
ADD_SUBDIRECTORY
ADD_SUBDIRECTORY(src_dir [binary_dir] [EXCLUDE_FROM_ALL]) 向当前工程添加存放源文件的子目录,并可以指定中间二进制和目标二进制的存放位置 EXCLUDE_FROM_ALL含义：将这个目录从编译过程中排除 -
INCLUDE_DIRECTORIES
INCLUDE_DIRECTORIES([AFTER | BEFORE] [SYSTEM] dir1 dir2 … ) 向工程添加多个特定的头文件搜索路径,路径之间用空格分隔,如果路径包含空格,可以使用双引号将它括起来,默认的行为为追加到当前头文件搜索路径的后面。 有如下两种方式可以控制搜索路径添加的位置： CMAKE_INCLUDE_DIRECTORIES_BEFORE,通过SET这个cmake变量为on,可以将添加的头文件搜索路径放在已有路径的前面 通过AFTER或BEFORE参数,也可以控制是追加还是置前 -
LINK_DIRECTORIES
LINK_DIRECTORIES(dir1 dir2 …) 添加非标准的共享库搜索路径 -
TARGET_LINK_LIBRARIES
TARGET_LINK_LIBRARIES(target lib1 lib2 …) 为target添加需要链接的共享库 -
ADD_DEFINITIONS
向C/C++编译器添加-D定义 ADD_DEFINITIONS(-DENABLE_DEBUG -DABC),参数之间用空格分隔 -
ADD_DEPENDENCIES
ADD_DEPENDENCIES(target-name depend-target1 depend-target2 …) 定义target依赖的其他target,确保target在构建之前,其依赖的target已经构建完毕 -
AUX_SOURCE_DIRECTORY
AUX_SOURCE_DIRECTORY(dir VAR) 发现一个目录下所有的源代码文件并将列表存储在一个变量中 把当前目录下的所有源码文件名赋给变量DIR_HELLO_SRCS -
EXEC_PROGRAM
EXEC_PROGRAM(Executable [dir where to run] [ARGS <args>][OUTPUT_VARIABLE <var>] [RETURN_VALUE <value>]) 用于在指定目录运行某个程序（默认为当前CMakeLists.txt所在目录）,通过ARGS添加参数,通过OUTPUT_VARIABLE和RETURN_VALUE获取输出和返回值,如下： EXEC_PROGRAM(ls ARGS "*.c*" OUTPUT_VARIABLE LS_OUTPUT RETURN_VALUE LS_RVALUE) IF (not LS_RVALUE) MESSAGE("ls: " ${LS_OUTPUT}) ENDIF(not LS_RVALUE) -
INCLUDE
INCLUDE(file [OPTIONAL]) 用来载入CMakeLists.txt文件 INCLUDE(module [OPTIONAL])用来载入预定义的CMake模块 OPTIONAL参数的左右是文件不存在也不会产生错误 可以载入一个文件,也可以载入预定义模块（模块会在CMAKE_MODULE_PATH指定的路径进行搜索） 载入的内容将在处理到INCLUDE语句时直接执行。 -
FIND系列
FIND_FILE(<VAR> name path1 path2 …) VAR变量代表找到的文件全路径,包含文件名 FIND_LIBRARY(<VAR> name path1 path2 …) VAR变量代表找到的库全路径,包含库文件名 如： FIND_LIBRARY(libz z /usr/lib) IF (NOT libx) MESSAGE(FATAL_ERROR "libz not found") ENDIF(NOT libz) FIND_PATH(<VAR> name path1 path2 …) VAR变量代表包含这个文件的路径 FIND_PROGRAM(<VAR> name path1 path2 …) VAR变量代表包含这个程序的全路径 FIND_PACKAGE(<name> [major.minor] [QUIET] [NO_MODULE] [[REQUIRED | COMPONENTS] [componets …]]) 用来调用预定义在CMAKE_MODULE_PATH下的Find<name>.cmake模块,你也可以自己定义Find<name> 模块,通过SET(CMAKE_MODULE_PATH dir)将其放入工程的某个目录供工程使用 -
IF系列
IF (expression) ... ELSE (expression) ... ENDIF (expression) 可以使用SET(CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS ON)来省略ELSE和ENDIF后面的(expression)，不过()还是需要的。 IF (expression), expression不为：空,0,N,NO,OFF,FALSE,NOTFOUND或<var>_NOTFOUND,为真 IF (not exp), 与上面相反 IF (var1 AND var2) IF (var1 OR var2) IF (COMMAND cmd) 如果cmd确实是命令并可调用,为真 IF (EXISTS dir) IF (EXISTS file) 如果目录或文件存在,为真 IF (file1 IS_NEWER_THAN file2),当file1比file2新,或file1/file2中有一个不存在时为真,文件名需使用全路径 IF (IS_DIRECTORY dir) 当dir是目录时,为真 IF (DEFINED var) 如果变量被定义,为真 IF (var MATCHES regex) 此处var可以用var名,也可以用${var} IF (string MATCHES regex) 数字比较表达式 IF (variable LESS number) IF (string LESS number) IF (variable GREATER number) IF (string GREATER number) IF (variable EQUAL number) IF (string EQUAL number) 按照字母表顺序进行比较 IF (variable STRLESS string) IF (string STRLESS string) IF (variable STRGREATER string) IF (string STRGREATER string) IF (variable STREQUAL string) IF (string STREQUAL string) -
WHILE
WHILE(condition) COMMAND1(ARGS ...) COMMAND2(ARGS ...) ... ENDWHILE(condition) -
FOREACH系列
列表 FOREACH(loop_var arg1 arg2 ...) COMMAND1(ARGS ...) COMMAND2(ARGS ...) ... ENDFOREACH(loop_var) 示例： AUX_SOURCE_DIRECTORY(. SRC_LIST) FOREACH(F ${SRC_LIST}) MESSAGE(${F}) ENDFOREACH(F) 范围 FOREACH(loop_var RANGE total) COMMAND1(ARGS ...) COMMAND2(ARGS ...) ... ENDFOREACH(loop_var) 示例： 从0到total以１为步进 FOREACH(VAR RANGE 10) MESSAGE(${VAR}) ENDFOREACH(VAR) 输出： 012345678910 范围和步进 FOREACH(loop_var RANGE start stop [step]) COMMAND1(ARGS ...) COMMAND2(ARGS ...) ... ENDFOREACH(loop_var) 从start开始到stop结束,以step为步进, 注意：直到遇到ENDFOREACH指令,整个语句块才会得到真正的执行。 FOREACH(A RANGE 5 15 3) MESSAGE(${A}) ENDFOREACH(A) 输出： 581114
实例
这里有个demo，读者可以去下载下来运行试试！
