cmake 常用变量和常用环境变量

• 使用${}进行变量的引用。在 IF 等语句中,是直接使用变量名而不通过${}取值

• cmake 自定义变量的方式主要有隐式定义和显式定义两种

PROJECT 指令会隐式的定PROJECT_BINARY_DIR 和PROJECT_SOURCE_DIR 两个变量。

使用 SET 指令进行显式定义

• cmake 常用变量:

CMAKE_BINARY_DIR
PROJECT_BINARY_DIR
<projectname>_BINARY_DIR

这三个变量指代的内容是一致的,如果是 in source 编译,指得就是工程顶层目录,如果是 out-of-source 编译,指的是工程编译发生的目录。PROJECT_BINARY_DIR 跟其他指令稍有区别。

CMAKE_SOURCE_DIR
PROJECT_SOURCE_DIR
<projectname>_SOURCE_DIR

这三个变量指代的内容是一致的,不论采用何种编译方式,都是工程顶层目录。也就是在 in source 编译时,跟 CMAKE_BINARY_DIR 等变量一致。PROJECT_SOURCE_DIR 跟其他指令稍有区别。

CMAKE_CURRENT_SOURCE_DIR

指的是当前处理的 CMakeLists.txt 所在的路径,比如上面我们提到的 src 子目录。

CMAKE_CURRRENT_BINARY_DIR

如果是 in-source 编译,它跟 CMAKE_CURRENT_SOURCE_DIR 一致,如果是 out-of-source 编译,指的是 target 编译目录。使用上面提到的 ADD_SUBDIRECTORY(src bin)可以更改这个变量的值。使用 SET(EXECUTABLE_OUTPUT_PATH <新路径>)并不会对这个变量造成影响,它仅仅修改了最终目标文件存放的路径。

CMAKE_CURRENT_LIST_FILE

输出调用这个变量的 CMakeLists.txt 的完整路径

CMAKE_CURRENT_LIST_LINE

输出这个变量所在的行

CMAKE_MODULE_PATH

这个变量用来定义自己的 cmake 模块所在的路径。如果工程比较复杂,有可能会编写一些 cmake 模块,这些 cmake 模块是随工程发布的,为了让 cmake 在处理CMakeLists.txt 时找到这些模块,通过 SET 指令,将cmake 模块路径设置一下。例如：

SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)

这时候就可以通过 INCLUDE 指令来调用cmake模块了。

EXECUTABLE_OUTPUT_PATH 和 LIBRARY_OUTPUT_PATH

分别用来重新定义最终结果的存放目录

PROJECT_NAME

返回通过 PROJECT 指令定义的项目名称。

• cmake 调用环境变量的方式

  使用$ENV{NAME}指令就可以调用系统的环境变量，例如：

  MESSAGE(STATUS “HOME dir: $ENV{HOME}”)
  

  设置环境变量的方式是:　　SET(ENV{变量名} 值)

• CMAKE_INCLUDE_CURRENT_DIR

自动添加 CMAKE_CURRENT_BINARY_DIR 和 CMAKE_CURRENT_SOURCE_DIR 到当前处理的 CMakeLists.txt。相当于在每个 CMakeLists.txt 加入:

INCLUDE_DIRECTORIES(${CMAKE_CURRENT_BINARY_DIR}
${CMAKE_CURRENT_SOURCE_DIR})

• CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE

  将工程提供的头文件目录始终至于系统头文件目录的前面,当定义的头文件确实跟系统发生冲突时可以提供一些帮助。

• CMAKE_INCLUDE_PATH 和 CMAKE_LIBRARY_PATH

• 系统信息

  CMAKE_MAJOR_VERSION,CMAKE 主版本号,比如 2.4.6 中的 2
  CMAKE_MINOR_VERSION,CMAKE 次版本号,比如 2.4.6 中的 4
  CMAKE_PATCH_VERSION,CMAKE 补丁等级,比如 2.4.6 中的 6
  CMAKE_SYSTEM,系统名称,比如 Linux-2.6.22
  CMAKE_SYSTEM_NAME,不包含版本的系统名,比如 Linux
  CMAKE_SYSTEM_VERSION,系统版本,比如 2.6.22
  CMAKE_SYSTEM_PROCESSOR,处理器名称,比如 i686.
  UNIX,在所有的类 UNIX 平台为 TRUE,包括 OS X 和 cygwin
  WIN32,在所有的 win32 平台为 TRUE,包括 cygwin
  

  • 主要的开关选项

    CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS,用来控制 IF ELSE 语句的书写方式。

    BUILD_SHARED_LIBS，这个开关用来控制默认的库编译方式,如果不进行设置,使用 ADD_LIBRARY 并没有指定库类型的情况下,默认编译生成的库都是静态库。如果 SET(BUILD_SHARED_LIBS ON)后,默认生成的为动态库。

    CMAKE_C_FLAGS设置 C 编译选项,也可以通过指令 ADD_DEFINITIONS()添加。

    CMAKE_CXX_FLAGS设置 C++编译选项,也可以通过指令 ADD_DEFINITIONS()添加。

• cmake常用指令

  ADD_DEFINITIONS向 C/C++编译器添加-D 定义,比如:

  ADD_DEFINITIONS(-DENABLE_DEBUG　-DABC)　　#参数之间用空格分割。
  

  如果代码中定义了#ifdef ENABLE_DEBUG #endif,这个代码块就会生效。如果要添加其他的编译器开关,可以通过 CMAKE_C_FLAGS 变量和 CMAKE_CXX_FLAGS 变量设置。

  ADD_DEPENDENCIES,定义 target 依赖的其他 target,确保在编译本 target 之前,其他的 target 已经被构建。

  ADD_DEPENDENCIES(target-name depend-target1 depend-target2 ...)
  

  ADD_EXECUTABLE、ADD_LIBRARY、ADD_SUBDIRECTORY

  ADD_TEST 与 ENABLE_TESTING 指令

  ENABLE_TESTING 指令用来控制 Makefile 是否构建 test 目标,涉及工程所有目录。语
  法很简单,没有任何参数,ENABLE_TESTING(),一般情况这个指令放在工程的主CMakeLists.txt 中.

  ADD_TEST 指令的语法是:

  ADD_TEST(testname Exename arg1 arg2 ...)
  

  testname 是自定义的 test 名称,Exename 可以是构建的目标文件也可以是外部脚本等等。后面连接传递给可执行文件的参数。如果没有在同一个 CMakeLists.txt 中打开ENABLE_TESTING()指令,任何 ADD_TEST 都是无效的。

  比如前面的 Helloworld 例子,可以在工程目录中的 CMakeLists.txt 中添加

  ADD_TEST(mytest ${PROJECT_BINARY_DIR}/bin/main)
  ENABLE_TESTING()
  

  生成 Makefile 后,就可以运行 make test 来执行测试了。

  AUX_SOURCE_DIRECTORY基本语法是

  AUX_SOURCE_DIRECTORY(dir VARIABLE)
  

  作用是发现一个目录下所有的源代码文件并将列表存储在一个变量中,这个指令临时被用来自动构建源文件列表。

AUX_SOURCE_DIRECTORY(. SRC_LIST)
ADD_EXECUTABLE(main ${SRC_LIST})

CMAKE_MINIMUM_REQUIRED其语法为

CMAKE_MINIMUM_REQUIRED(VERSION versionNumber [FATAL_ERROR])
CMAKE_MINIMUM_REQUIRED(VERSION 3.5 FATAL_ERROR)

​ 如果 cmake 版本小与 3.5,则出现严重错误,整个过程中止。

​ EXEC_PROGRAM在 CMakeLists.txt 处理过程中执行命令,并不会在生成的 Makefile 中执行。具体语法为:

EXEC_PROGRAM(Executable [directory in which to run]
[ARGS <arguments to executable>]
[OUTPUT_VARIABLE <var>]
[RETURN_VALUE <var>])

用于在指定的目录运行某个程序,通过 ARGS 添加参数,如果要获取输出和返回值,可通过
OUTPUT_VARIABLE 和 RETURN_VALUE 分别定义两个变量.这个指令可以帮助在 CMakeLists.txt 处理过程中支持任何命令,比如根据系统情况去修改代码文件等等

举个例子,要在 src 目录执行 ls 命令,并把结果和返回值存下来,可以直接在 src/CMakeLists.txt 中添加:

EXEC_PROGRAM(ls ARGS "*.c" OUTPUT_VARIABLE LS_OUTPUT RETURN_VALUE
LS_RVALUE)
IF(not LS_RVALUE)
MESSAGE(STATUS "ls result: " ${LS_OUTPUT})
ENDIF(not LS_RVALUE)

在 cmake 生成 Makefile 的过程中,就会执行 ls 命令,如果返回 0,则说明成功执行,那么就输出 ls *.c 的结果。关于 IF 语句,后面的控制指令会提到。

• FILE 指令文件操作指令,基本语法为:

  FILE(WRITE filename "message to write"... )
  FILE(APPEND filename "message to write"... )
  FILE(READ filename variable)
  FILE(GLOB
  expressions]...)
  variable [RELATIVE path] [globbing
  FILE(GLOB_RECURSE variable [RELATIVE path]
  [globbing expressions]...)
  FILE(REMOVE [directory]...)
  FILE(REMOVE_RECURSE [directory]...)
  FILE(MAKE_DIRECTORY [directory]...)
  FILE(RELATIVE_PATH variable directory file)
  FILE(TO_CMAKE_PATH path result)
  FILE(TO_NATIVE_PATH path result)
  

• INCLUDE 指令,用来载入 CMakeLists.txt 文件,也用于载入预定义的 cmake 模块.

  INCLUDE(file1 [OPTIONAL])
  INCLUDE(module [OPTIONAL])
  

  OPTIONAL 参数的作用是文件不存在也不会产生错误。可以指定载入一个文件,如果定义的是一个模块,那么将在 CMAKE_MODULE_PATH 中搜索这个模块并载入。载入的内容将在处理到 INCLUDE 语句是直接执行。

• FIND_指令

FIND_FILE(<VAR> name1 path1 path2 ...)
VAR 变量代表找到的文件全路径,包含文件名
FIND_LIBRARY(<VAR> name1 path1 path2 ...)
VAR 变量表示找到的库全路径,包含库文件名
FIND_PATH(<VAR> name1 path1 path2 ...)
VAR 变量代表包含这个文件的路径。
FIND_PROGRAM(<VAR> name1 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)将其放入工程的某个目录中供工程使用,后面介绍 FIND_PACKAGE 的使用方法和 Find 模块的编写。

FIND_LIBRARY 示例:

FIND_LIBRARY(libX X11 /usr/lib)
IF(NOT libX)
MESSAGE(FATAL_ERROR “libX not found”)
ENDIF(NOT libX)

• 控制指令:

IF 指令,基本语法为:

IF(expression)
# THEN section.
COMMAND1(ARGS ...)COMMAND2(ARGS ...)
...
ELSE(expression)
# ELSE section.
COMMAND1(ARGS ...)
COMMAND2(ARGS ...)
...
ENDIF(expression)

另外一个指令是 ELSEIF,总体把握一个原则,凡是出现 IF 的地方一定要有对应的ENDIF.出现 ELSEIF 的地方,ENDIF 是可选的。

表达式的使用方法如下:

IF(var),如果变量不是:空,0,N, NO, OFF, FALSE, NOTFOUND 或_NOTFOUND 时,表达式为真。

IF(NOT var ),与上述条件相反。
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 dirname),当 dirname 是目录时,为真。

IF(variable MATCHES regex)
IF(string MATCHES regex)
当给定的变量或者字符串能够匹配正则表达式 regex 时为真。比如:

IF("hello" MATCHES "ell")
MESSAGE("true")
ENDIF("hello" MATCHES "ell")

数字比较表达式：

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)

IF(DEFINED variable),如果变量被定义,为真。

用来判断平台差异:

IF(WIN32)
MESSAGE(STATUS “This is windows.”)
#作一些 Windows 相关的操作
ELSE(WIN32)
MESSAGE(STATUS “This is not windows”)
#作一些非 Windows 相关的操作
ENDIF(WIN32)

上述代码用来控制在不同的平台进行不同的控制，但是，阅读起来却并不是那么舒服，
ELSE(WIN32)之类的语句很容易引起歧义。

这时候就可以使用CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS 开关。

SET(CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS ON)

这时候就可以写成:

IF(WIN32)
ELSE()
ENDIF()

如果配合 ELSEIF 使用,可能的写法是这样:

IF(WIN32)
#do something related to WIN32
ELSEIF(UNIX)
#do something related to UNIX
ELSEIF(APPLE)
#do something related to APPLE
ENDIF(WIN32)

• WHILE 指令的语法是:

WHILE(condition)
COMMAND1(ARGS ...)
COMMAND2(ARGS ...)
...
ENDWHILE(condition)

真假判断条件可以参考 IF 指令。

• FOREACH指令的使用方法有三种形式

  # 1 列表
  FOREACH(loop_var arg1 arg2 ...)
  COMMAND1(ARGS ...)
  COMMAND2(ARGS ...)
  ...
  ENDFOREACH(loop_var)
  

  像前面使用的 AUX_SOURCE_DIRECTORY 的例子：

  AUX_SOURCE_DIRECTORY(. SRC_LIST)
  FOREACH(F ${SRC_LIST})
  MESSAGE(${F})
  ENDFOREACH(F)
  

  # 2 范围
  FOREACH(loop_var RANGE total)
  ENDFOREACH(loop_var)
  

  举例：

  FOREACH(VAR RANGE 10)
  MESSAGE(${VAR})
  ENDFOREACH(VAR)
  最终得到的输出是:
  0
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  

  # 3 范围和步进　从 start 开始到 stop 结束,以 step 为步进,
  FOREACH(loop_var RANGE start stop [step])
  ENDFOREACH(loop_var)
  

  举例：

  FOREACH(A RANGE 5 15 3)
  MESSAGE(${A})
  ENDFOREACH(A)
  最终得到的结果是:
  5
  8
  11
  14
  

  这个指令需要注意的是,直到遇到 ENDFOREACH 指令,整个语句块才会得到真正的执行。