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

Love The Way You Lie 2023-09-25 13:05 11阅读 0赞

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")
 *  编译类型：CMAKE\_BUILD\_TYPE (Debug, Release)
    
        # 设定编译类型为debug，调试时需要选择debug
        set(CMAKE_BUILD_TYPE Debug) 
        # 设定编译类型为release，发布时需要选择release
        set(CMAKE_BUILD_TYPE Release)
 *  ×××\_BINARY\_DIR【`CMAKE_BINARY_DIR`、`PROJECT_BINARY_DIR`、`<projectname>__BINARY_DIR`】
    
    1.  这三个变量指代的内容是一致的。
    2.  如果是 in source build，指的就是工程顶层目录。
    3.  如果是 out-of-source 编译,指的是工程编译发生的目录。
    4.  PROJECT\_BINARY\_DIR 跟其他指令稍有区别，不过现在，你可以理解为他们是一致的。
 *  ×××\_SOURCE\_DIR【`CMAKE_SOURCE_DIR`、`PROJECT_SOURCE_DIR`、`<projectname>__SOURCE_DIR`】
    
    1.  这三个变量指代的内容是一致的,不论采用何种编译方式,都是工程顶层目录。
    2.  也就是在 in source build时,他跟 CMAKE\_BINARY\_DIR 等变量一致。
    3.  PROJECT\_SOURCE\_DIR 跟其他指令稍有区别,现在,你可以理解为他们是一致的。

--------------------

参考资料：  
[CMAKE\_CURRENT\_SOURCE\_DIR和CMAKE\_CURRENT\_LIST\_DIR的区别][CMAKE_CURRENT_SOURCE_DIR_CMAKE_CURRENT_LIST_DIR]  
[CMake教程（常见变量）][CMake]  
[CMake常用变量][CMake 1]

[CMAKE_CURRENT_SOURCE_DIR_CMAKE_CURRENT_LIST_DIR]: https://www.manongdao.com/article-1209121.html
[CMake]: https://blog.csdn.net/fanrongwoaini/article/details/126559472
[CMake 1]: https://www.cnblogs.com/liuzhenbo/p/11184608.html