cmake 提供了很多内置变量,每一个变量都有它自己的含义,cmake官方关于变量的介绍为https://cmake.org/cmake/help/v3.5/manual/cmake-variables.7.html。在这份文档中,对变量进行分类,分为: 提供信息的变量、改变行为的变量、描述系统的变量、控制编译的变量等等。
一、提供信息的变量
提供信息的变量可以提供某种信息,通常只需要读取变量即可,而不需要对变量进行修改。
PROJECT_SOURCE_DIR 工程顶层目录,也就是顶层 CMakeLists.txt 源码所在目录
PROJECT_BINARY_DIR 工 程 BINARY_DIR , 也 就 是 顶 层 CMakeLists.txt 源 码 的BINARY_DIR
CMAKE_SOURCE_DIR 与 PROJECT_SOURCE_DIR 等价
CMAKE_BINARY_DIR 与 PROJECT_BINARY_DIR 等价
CMAKE_CURRENT_SOURCE_DIR 当前源码所在路径
CMAKE_CURRENT_BINARY_DIR 当前源码的 BINARY_DIR
CMAKE_MAJOR_VERSION cmake 的主版本号
CMAKE_MINOR_VERSION cmake 的次版本号
CMAKE_VERSION cmake 的版本号(主+次+修订)
PROJECT_VERSION_MAJOR 工程的主版本号
PROJECT_VERSION_MINOR 工程的次版本号
PROJECT_VERSION 工程的版本号
CMAKE_PROJECT_NAME 工程的名字
PROJECT_NAME 工程名,与 CMAKE_PROJECT_NAME 等价
1.1、PROJECT_SOURCE_DIR 和 PROJECT_BINARY_DIR
PROJECT_SOURCE_DIR 变量表示工程的顶级目录,也就是顶层 CMakeLists.txt 文件所在目录;PROJECT_BINARY_DIR 变 量 表示 工程 的 BINARY_DIR ,也 就是 顶 层 CMakeLists.txt 源 码 对 应的BINARY_DIR(输出文件目录) 。
譬如工程目录结构如下所示:
├── build
├── CMakeLists.txt
└── main.c
CMakeLists.txt 文件内容如下:
# CMakeLists.txt
cmake_minimum_required("VERSION" "3.5")
project(HELLO)
message(${PROJECT_SOURCE_DIR})
message(${PROJECT_BINARY_DIR})
CMakeLists.txt 中我们打印了 PROJECT_SOURCE_DIR 和 PROJECT_BINARY_DIR 变量,进入到 build目录下,执行 cmake:
从打印信息可知, PROJECT_SOURCE_DIR 指的就是工程的顶层 CMakeLists.txt 源码所在路径,而PROJECT_BINARY_DIR 指的是我们执行 cmake 命令的所在目录,也是顶层 CMakeLists.txt 源码的BINARY_DIR。
1.2、CMAKE_SOURCE_DIR 和 CMAKE_BINARY_DIR
与上面两个等价
1.3、CMAKE_CURRENT_SOURCE_DIR 和 CMAKE_CURRENT_BINARY_DIR
指的是当前源码的路径以及当前源码的 BINARY_DIR
二、改变行为的变量
改变行为的变量是指这些变量可以改变某些行为,所以我们可以通过对这些变量进行设置以改变行为。
BUILD_SHARED_LIBS 控制 cmake 是否生成动态库
CMAKE_BUILD_TYPE 指定工程的构建类型, release 或 debug
CMAKE_SYSROOT 对应编译器的在–sysroot 选项
CMAKE_IGNORE_PATH 设置被 find_xxx 命令忽略的目录列表
CMAKE_INCLUDE_PATH 为 find_file()和 find_path()命令指定搜索路径的目录列表
CMAKE_INCLUDE_DIRECTORIES_BEFORE 用于控制 include_directories()命令的行为
CMAKE_LIBRARY_PATH 指定 find_library()命令的搜索路径的目录列表
CMAKE_MODULE_PATH 指定要由 include()或 find_package()命令加载的CMake 模块的搜索路径的目录列表
CMAKE_PROGRAM_PATH 指定 find_program()命令的搜索路径的目录列表
三、描述系统的变量
这些变量描述了系统相关的一些信息:
CMAKE_HOST_SYSTEM_NAME 运行 cmake 的操作系统的名称(其实就是 uname -s)
CMAKE_HOST_SYSTEM_PROCESSOR 运行 cmake 的操作系统的处理器名称(uname -p)
CMAKE_HOST_SYSTEM 运行 cmake 的操作系统(复合信息)
CMAKE_HOST_SYSTEM_VERSION 运行 cmake 的操作系统的版本号(uname -r)
CMAKE_HOST_UNIX 如果运行 cmake 的操作系统是 UNIX 和类 UNIX,则该变量为 true,否则是空值
CMAKE_HOST_WIN32 如果运行 cmake 的操作系统是 Windows,则该变量为 true,否则是空值
CMAKE_SYSTEM_NAME 目标主机操作系统的名称
CMAKE_SYSTEM_PROCESSOR 目标主机的处理器名称
CMAKE_SYSTEM 目标主机的操作系统(复合信息)
CMAKE_SYSTEM_VERSION 目标主机操作系统的版本号
ENV 用于访问环境变量
UNIX 与 CMAKE_HOST_UNIX 等价
WIN32 与 CMAKE_HOST_WIN32 等价
四、控制编译的变量
这些变量可以控制编译过程
EXECUTABLE_OUTPUT_PATH 可执行程序的输出路径
LIBRARY_OUTPUT_PATH 库文件的输出路径