CMake 常用变量

概述

CMake 变量引用的方式

前面我们已经提到了,使用 ${} 进行变量的引用。在 IF 等语句中,是直接使用变量名而不通过 ${} 取值。

CMake 自定义变量的方式

主要有隐式定义和显式定义两种,前面举了一个隐式定义的例子,就是 PROJECT 指令,它会隐式的定义 _BINARY_DIR_SOURCE_DIR 两个变量。

显式定义的例子我们前面也提到了,使用 SET 指令,就可以构建一个自定义变量了。比如:

SET(HELLO_SRC main.c SOURCE_PATH)

PROJECT_BINARY_DIR 就可以通过 ${HELLO_SRC} 来引用这个自定义变量了。

常用变量

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

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

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

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

系统信息

变量 描述
CMAKE_MAJOR_VERSION CMAKE 主版本号,比如 5.2.0 中的 5
CMAKE_MINOR_VERSION CMAKE 次版本号,比如 5.2.0 中的 2
CMAKE_PATCH_VERSION CMAKE 补丁等级,比如 5.2.0 中的 0
CMAKE_SYSTEM 系统名称,比如 Linux-5.2.0
CMAKE_SYSTEM_NAME 不包含版本的系统名,比如 Linux
CMAKE_SYSTEM_VERSION 系统版本,比如 5.2.0
CMAKE_SYSTEM_PROCESSOR 处理器名称,比如 x86_64
UNIX 在所有的类 UNIX 平台为 TRUE,包括 OS X 和 cygwin
WIN32 在所有的 win32 平台为 TRUE,包括 cygwin

CMake 判断操作系统类型示例:cmake-courses/which-os

环境变量

CMake 可以调用系统的环境变量,调用方法是使用 $ENV{NAME} 指令包含环境变量。

示例:打印 HOME 和 PATH 变量值

message(STATUS "HOME dir: ENV{HOME}")
message(STATUS "PATH dir:ENV{PATH}")

示例:设置 CC 编译器环境变量

set(ENV{CC} gcc)
message(STATUS "Compiler: $ENV{CC}")

CMake 环境变量示例:cmake-courses/env