cmake常⽤变量和常⽤环境变量查表⼿册---整理.
⼀,cmake 变量引⽤的⽅式:
前⾯我们已经提到了，使⽤${}进⾏变量的引⽤。在 IF 等语句中，是直接使⽤变量名⽽不通过${}取值
⼆,cmake ⾃定义变量的⽅式:
主要有隐式定义和显式定义两种，前⾯举了⼀个隐式定义的例⼦，就是 PROJECT 指令，他会隐式的定义<projectname>_BINARY_DIR 和
<projectname>_SOURCE_DIR 两个变量。
显式定义的例⼦我们前⾯也提到了，使⽤ SET 指令，就可以构建⼀个⾃定义变量了。
⽐如:
SET(HELLO_SRC main.SOURCE_PATHc)，就 PROJECT_BINARY_DIR 可以通过${HELLO_SRC}来引⽤这个⾃定义变量了.
三,cmake 常⽤变量:
1,CMAKE_BINARY_DIR
PROJECT_BINARY_DIR
<projectname>_BINARY_DIR
这三个变量指代的内容是⼀致的，如果是 in source 编译，指得就是⼯程顶层⽬录，如果是 out-of-source 编译，指的是⼯程编译发⽣的⽬录。PROJECT_BINARY_DIR 跟其他指令稍有区别，现在，你可以理解为他们是⼀致的。
2,CMAKE_SOURCE_DIR
PROJECT_SOURCE_DIR
<projectname>_SOURCE_DIR
这三个变量指代的内容是⼀致的，不论采⽤何种编译⽅式，都是⼯程顶层⽬录。
也就是在 in source 编译时，他跟 CMAKE_BINARY_DIR 等变量⼀致。
PROJECT_SOURCE_DIR 跟其他指令稍有区别，现在，你可以理解为他们是⼀致的。
3,CMAKE_CURRENT_SOURCE_DIR
指的是当前处理的 所在的路径,⽐如上⾯我们提到的 src ⼦⽬录。
4,CMAKE_CURRRENT_BINARY_DIR
如果是 in-source 编译，它跟 CMAKE_CURRENT_SOURCE_DIR ⼀致，如果是 out-of-source 编译，他指的是 target 编译⽬录。
使⽤我们上⾯提到的 ADD_SUBDIRECTORY(src bin)可以更改这个变量的值。
使⽤ SET(EXECUTABLE_OUTPUT_PATH <；新路径>)并不会对这个变量造成影响，它仅仅修改了最终⽬标⽂件存放的路径。
5,CMAKE_CURRENT_LIST_FILE
输出调⽤这个变量的 的完整路径
6,CMAKE_CURRENT_LIST_LINE
输出这个变量所在的⾏
7,CMAKE_MODULE_PATH
这个变量⽤来定义⾃⼰的 cmake 模块所在的路径。如果你的⼯程⽐较复杂，有可能会⾃⼰编写⼀些 cmake 模块，这些 cmake 模块是随你的⼯程发布的，为了让 cmake 在处理 时到这些模块，你需要通过 SET 指令，将⾃⼰的 cmake 模块路径设置⼀下。
⽐如
SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
这时候你就可以通过 INCLUDE 指令来调⽤⾃⼰的模块了。
8,EXECUTABLE_OUTPUT_PATH 和 LIBRARY_OUTPUT_PATH
分别⽤来重新定义最终结果的存放⽬录，前⾯我们已经提到了这两个变量。
9,PROJECT_NAME
返回通过 PROJECT 指令定义的项⽬名称。
四,cmake 调⽤环境变量的⽅式
使⽤$ENV{NAME}指令就可以调⽤系统的环境变量了。
⽐如
MESSAGE(STATUS “HOME dir: $ENV{HOME}”)
设置环境变量的⽅式是:
SET(ENV{变量名} 值)
1,CMAKE_INCLUDE_CURRENT_DIR
⾃动添加 CMAKE_CURRENT_BINARY_DIR 和 CMAKE_CURRENT_SOURCE_DIR 到当前处理
的 。相当于在每个 加⼊:
INCLUDE_DIRECTORIES(${CMAKE_CURRENT_BINARY_DIR}
${CMAKE_CURRENT_SOURCE_DIR})
2,CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE
将⼯程提供的头⽂件⽬录始终⾄于系统头⽂件⽬录的前⾯，当你定义的头⽂件确实跟系统发⽣冲突时可以提供⼀些帮助。
3,CMAKE_INCLUDE_PATH 和 CMAKE_LIBRARY_PATH 我们在上⼀节已经提及。为什么现在都用cmake
五，系统信息
1,CMAKE_MAJOR_VERSION,CMAKE 主版本号,⽐如 2.4.6 中的 2
2,CMAKE_MINOR_VERSION,CMAKE 次版本号,⽐如 2.4.6 中的 4
3,CMAKE_PATCH_VERSION,CMAKE 补丁等级,⽐如 2.4.6 中的 6
4,CMAKE_SYSTEM，系统名称,⽐如 Linux-2.6.22
5,CMAKE_SYSTEM_NAME，不包含版本的系统名,⽐如 Linux
6,CMAKE_SYSTEM_VERSION，系统版本,⽐如 2.6.22
7,CMAKE_SYSTEM_PROCESSOR，处理器名称,⽐如 i686.
8,UNIX，在所有的类 UNIX 平台为 TRUE，包括 OS X 和 cygwin
9,WIN32，在所有的 win32 平台为 TRUE，包括 cygwin
六，主要的开关选项:
1,CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS,⽤来控制 IF ELSE 语句的书写⽅式，在
下⼀节语法部分会讲到。
2,BUILD_SHARED_LIBS
这个开关⽤来控制默认的库编译⽅式，如果不进⾏设置，使⽤ ADD_LIBRARY 并没有指定库
类型的情况下，默认编译⽣成的库都是静态库。
如果 SET(BUILD_SHARED_LIBS ON)后，默认⽣成的为动态库。
3,CMAKE_C_FLAGS
设置 C 编译选项，也可以通过指令 ADD_DEFINITIONS()添加。
4,CMAKE_CXX_FLAGS
设置 C++编译选项，也可以通过指令 ADD_DEFINITIONS()添加。
⼩结:
本章介绍了⼀些较常⽤的 cmake 变量，这些变量仅仅是所有 cmake 变量的很少⼀部分,⽬
前 cmake 的英⽂⽂档也是⽐较缺乏的，如果需要了解更多的 cmake 变量，更好的⽅式是阅
读⼀些成功项⽬的 cmake ⼯程⽂件,⽐如 KDE4 的代码。
⼋,cmake 常⽤指令
前⾯我们讲到了 cmake 常⽤的变量，相信“cmake 即编程”的感觉会越来越明显,⽆论如何，我们仍然可以看到 cmake ⽐ autotools 要简单很多。接下来我们就要集中的看⼀看cmake 所提供的常⽤指令。在前⾯的章节我们已经讨论了很多指令的⽤法，如
PROJECT,ADD_EXECUTABLE,INSTALL,ADD_SUBDIRECTORY,SUBDIRS,
INCLUDE_DIRECTORIES,LINK_DIRECTORIES,TARGET_LINK_LIBRARIES,SET 等。
本节会引⼊更多的 cmake 指令，为了编写的⽅便，我们将按照 cmake man page 的顺序来介绍各种指
令，不再推荐使⽤的指令将不再介
绍,INSTALL 系列指令在安装部分已经做了⾮常详细的说明，本节也不在提及。(你可以将本章理解成选择性翻译，但是会加⼊更多的个⼈理解)⼀，基本指令
1,ADD_DEFINITIONS
向 C/C++编译器添加-D 定义,⽐如:
ADD_DEFINITIONS(-DENABLE_DEBUG -DABC)，参数之间⽤空格分割。
如果你的代码中定义了#ifdef ENABLE_DEBUG #endif，这个代码块就会⽣效。
如果要添加其他的编译器开关，可以通过 CMAKE_C_FLAGS 变量和 CMAKE_CXX_FLAGS 变量设置。
2,ADD_DEPENDENCIES
定义 target 依赖的其他 target，确保在编译本 target 之前，其他的 target 已经被构建。
ADD_DEPENDENCIES(target-name depend-target1
depend-target2 ...)
3,ADD_EXECUTABLE、ADD_LIBRARY、ADD_SUBDIRECTORY 前⾯已经介绍过了，这⾥不再罗唆。
4,ADD_TEST 与 ENABLE_TESTING 指令。
ENABLE_TESTING 指令⽤来控制 Makefile 是否构建 test ⽬标，涉及⼯程所有⽬录。语法很简单，没有任何参数,ENABLE_TESTING(),⼀般情况这个指令放在⼯程的主 中.
ADD_TEST 指令的语法是:
ADD_TEST(testname Exename arg1 arg2 ...)
testname 是⾃定义的 test 名称,Exename 可以是构建的⽬标⽂件也可以是外部脚本等等。后⾯连接传递给可执⾏⽂件的参数。如果没有在同⼀个 中打开ENABLE_TESTING()指令，任何 ADD_TEST 都是⽆效的。
⽐如我们前⾯的 Helloworld 例⼦，可以在⼯程主 中添加
ADD_TEST(mytest ${PROJECT_BINARY_DIR}/bin/main)
ENABLE_TESTING()
⽣成 Makefile 后，就可以运⾏ make test 来执⾏测试了。
5,AUX_SOURCE_DIRECTORY
基本语法是:
AUX_SOURCE_DIRECTORY(dir VARIABLE)
作⽤是发现⼀个⽬录下所有的源代码⽂件并将列表存储在⼀个变量中，这个指令临时被⽤来⾃动构建源⽂件列表。因为⽬前 cmake 还不能⾃动发现新添加的源⽂件。
⽐如
AUX_SOURCE_DIRECTORY(. SRC_LIST)
ADD_EXECUTABLE(main ${SRC_LIST})
你也可以通过后⾯提到的 FOREACH 指令来处理这个 LIST
6,CMAKE_MINIMUM_REQUIRED
其语法为 CMAKE_MINIMUM_REQUIRED(VERSION versionNumber [FATAL_ERROR])
⽐如 CMAKE_MINIMUM_REQUIRED(VERSION 2.5 FATAL_ERROR)
如果 cmake 版本⼩与 2.5，则出现严重错误，整个过程中⽌。
7,EXEC_PROGRAM
在 处理过程中执⾏命令，并不会在⽣成的 Makefile 中执⾏。
具体语法为:
EXEC_PROGRAM(Executable [directory in which to run]
[ARGS <arguments to executable>]
[OUTPUT_VARIABLE <var>]
[RETURN_VALUE <var>])
⽤于在指定的⽬录运⾏某个程序，通过 ARGS 添加参数，如果要获取输出和返回值，可通过OUTPUT_VARIABLE 和 RETURN_VALUE 分别定义两个变量.
这个指令可以帮助你在 处理过程中⽀持任何命令,⽐如根据系统情况去修改代码⽂件等等。
举个简单的例⼦，我们要在 src ⽬录执⾏ ls 命令，并把结果和返回值存下来。
可以直接在 中添加:
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 语句，后⾯的控制指令会提到。
8,FILE 指令
⽂件操作指令，基本语法为:
FILE(WRITE filename "message to write"... )
FILE(APPEND filename "message to write"... )
FILE(READ filename variable)
FILE(GLOB variable [RELATIVE path] [globbing expression_r_rs]...)
FILE(GLOB_RECURSE variable [RELATIVE path] [globbing expression_r_rs]...)
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)
这⾥的语法都⽐较简单，不在展开介绍了。
9,INCLUDE 指令,⽤来载⼊ ⽂件，也⽤于载⼊预定义的 cmake 模块.
INCLUDE(file1 [OPTIONAL])
INCLUDE(module [OPTIONAL])
OPTIONAL 参数的作⽤是⽂件不存在也不会产⽣错误。
你可以指定载⼊⼀个⽂件，如果定义的是⼀个模块，那么将在 CMAKE_MODULE_PATH 中搜索这个模块并载⼊。
载⼊的内容将在处理到 INCLUDE 语句是直接执⾏。
⼆,INSTALL 指令
INSTALL 系列指令已经在前⾯的章节有⾮常详细的说明，这⾥不在赘述，可参考前⾯的安装部分。
三,FIND_指令
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] []])
⽤来调⽤预定义在 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)
四，控制指令:
1,IF 指令，基本语法为:
IF(expression_r_r)
# THEN section.
COMMAND1(ARGS ...)
COMMAND2(ARGS ...)
...
ELSE(expression_r_r)
# ELSE section.
COMMAND1(ARGS ...)
COMMAND2(ARGS ...)
...
ENDIF(expression_r_r)
另外⼀个指令是 ELSEIF，总体把握⼀个原则，凡是出现 IF 的地⽅⼀定要有对应的ENDIF.出现 ELSEIF 的地⽅,ENDIF 是可选的。
表达式的使⽤⽅法如下:
IF(var)，如果变量不是：空,0,N, NO, OFF, FALSE, NOTFOUND 或<var>_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)
2,WHILE
WHILE 指令的语法是:
WHILE(condition)
COMMAND1(ARGS ...)
COMMAND2(ARGS ...)
...
ENDWHILE(condition)
其真假判断条件可以参考 IF 指令。
3,FOREACH
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)
从 0 到 total 以1为步进
举例如下:

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。