C++：CMake常用变量【CMAKE_CXX_FLAGS、CMAKE_BUILD_TYPE、×_BINARY_DIR】

CMake共用七种变量，如下所示：

1. 提供信息的变量。
2. 控制变量。
3. 描述系统的变量。
4. 控制构建过程的变量。
5. 语言变量。
6. CTest变量。
7. CPack变量。

一、CMake变量引用的方式

使⽤ ${} 进⾏变量的引⽤。在 IF 等语句中，是直接使⽤变量名⽽不通过 ${} 取值。

二、cmake 定义变量的⽅式

主要有隐式定义和显式定义两种，举⼀个隐式定义的例⼦，就是 PROJECT 指令，他会隐式的定义_BINARY_DIR 和
_SOURCE_DIR 两个变量。

⽽显式定义的例⼦，可以使⽤ SET 指令，就可以构建⼀个⾃定义变量了。

三、常用变量

预定义变量

• PROJECT_SOURCE_DIR：工程的根目录
• PROJECT_BINARY_DIR：运行 cmake 命令的目录，通常是 ${PROJECT_SOURCE_DIR}/build
• PROJECT_NAME：返回通过 project 命令定义的项目名称
• CMAKE_CURRENT_SOURCE_DIR：当前处理的 CMakeLists.txt 所在的路径
• CMAKE_CURRENT_BINARY_DIR：target 编译目录
• CMAKE_CURRENT_LIST_DIR：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：重新定义目标链接库文件的存放位置

环境变量

• 使用环境变量：$ENV{Name}；
• 写入环境变量：set(ENV{Name} value)，这里没有“$”符号；

系统信息

• CMAKE_MAJOR_VERSION：cmake 主版本号，比如 3.4.1 中的 3
• ­CMAKE_MINOR_VERSION：cmake 次版本号，比如 3.4.1 中的 4
• ­CMAKE_PATCH_VERSION：cmake 补丁等级，比如 3.4.1 中的 1
• ­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
• APPLE：在所有苹果平台下该值为TRUE

主要开关选项

• BUILD_SHARED_LIBS：这个开关用来控制默认的库编译方式，如果不进行设置，使用 add_library 又没有指定库类型的情况下，默认编译生成的库都是静态库。如果 set(BUILD_SHARED_LIBS ON) 后，默认生成的为动态库
• CMAKE_C_FLAGS：设置 C 编译选项，也可以通过指令 add_definitions() 添加
• CMAKE_CXX_FLAGS：设置 C++ 编译选项，也可以通过指令 add_definitions() 添加，add_definitions(-DENABLE_DEBUG -DABC) # 参数之间用空格分隔

其他常用变量

• CMAKE_C_COMPILER：指定C编译器

• CMAKE_CXX_COMPILER：指定C++编译器

• EXECUTABLE_OUTPUT_PATH：可执行文件输出的存放路径

• LIBRARY_OUTPUT_PATH：库文件输出的存放路径

• CMAKE_CURRENT_SOURCE_DIR：当前处理的CMakeLists.txt位于目录

• CMAKE_CURRENT_LIST_DIR：这是当前正在处理的listfile中的目录

• 编译选项：CMAKE_CXX_FLAGS【CMAKE_C_FLAGS gcc编译选项】【CMAKE_CXX_FLAGS g++编译选项】

  # 在CMAKE_CXX_FLAGS编译选项后追加-std=c++11
  set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
  1
  2

• 编译类型：CMAKE_BUILD_TYPE (Debug, Release)

  # 设定编译类型为debug，调试时需要选择debug
  set(CMAKE_BUILD_TYPE Debug) 
  # 设定编译类型为release，发布时需要选择release
  set(CMAKE_BUILD_TYPE Release) 
  1
  2
  3
  4

• ×××_BINARY_DIR【CMAKE_BINARY_DIR、PROJECT_BINARY_DIR、__BINARY_DIR】

  1. 这三个变量指代的内容是一致的。
  2. 如果是 in source build，指的就是工程顶层目录。
  3. 如果是 out-of-source 编译,指的是工程编译发生的目录。
  4. PROJECT_BINARY_DIR 跟其他指令稍有区别，不过现在，你可以理解为他们是一致的。

• ×××_SOURCE_DIR【CMAKE_SOURCE_DIR、PROJECT_SOURCE_DIR、__SOURCE_DIR】

  1. 这三个变量指代的内容是一致的,不论采用何种编译方式,都是工程顶层目录。
  2. 也就是在 in source build时,他跟 CMAKE_BINARY_DIR 等变量一致。
  3. PROJECT_SOURCE_DIR 跟其他指令稍有区别,现在,你可以理解为他们是一致的。

---

---

---

参考资料：
CMAKE_CURRENT_SOURCE_DIR和CMAKE_CURRENT_LIST_DIR的区别
CMake教程（常见变量）
CMake常用变量