cmake 常用变量和常用环境变量

最新推荐文章于 2024-07-05 00:31:49 发布

yygr

最新推荐文章于 2024-07-05 00:31:49 发布

阅读量499

点赞数

分类专栏： c语言文章标签： cmake

原文链接：https://blog.csdn.net/qq_42676511/article/details/124960410

版权

c语言专栏收录该内容

39 篇文章 5 订阅

订阅专栏

文章详细介绍了CMake中变量的引用方式，包括隐式和显式定义自定义变量，以及常用的CMake变量如CMAKE_BINARY_DIR和CMAKE_SOURCE_DIR的含义和使用场景。同时，还讲解了如何调用和设置环境变量，以及CMAKE_INCLUDE_CURRENT_DIR等相关开关选项的功能。

摘要由CSDN通过智能技术生成

https://blog.csdn.net/qq_42676511/article/details/124960410

1. cmake 变量的引用方式

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

2. cmake 自定义变量的方式

主要有隐式定义和显式定义两种。

隐式定义：比如PROJECT 指令，它会隐式的定义_BINARY_DIR 和_SOURCE_DIR 两个变量。
显式定义：使用SET 指令，就可以构建一个自定义变量了。

3. cmake 常用变量

CMAKE_BINARY_DIR、PROJECT_BINARY_DIR、_BINARY_DIR

这三个变量指代的内容是一致的。如果是内部编译，指得就是工程顶层目录，如果是外部编译，指的是工程编译发生的目录。

CMAKE_SOURCE_DIR、PROJECT_SOURCE_DIR、_SOURCE_DIR

这三个变量指代的内容是一致的，不论采用何种编译方式，都是工程顶层目录。

CMAKE_CURRENT_SOURCE_DIR

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

CMAKE_CURRRENT_BINARY_DIR

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

CMAKE_CURRENT_LIST_FILE

输出调用这个变量的CMakeLists.txt 的完整路径。

CMAKE_CURRENT_LIST_LINE

输出这个变量所在的行。

CMAKE_MODULE_PATH

这个变量用来定义自己的cmake 模块所在的路径。为了让cmake 在处理CMakeLists.txt 时找到这些模块，你需要通过SET指令，将自己的cmake 模块路径设置一下。比如：

SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)

这时候你就可以通过INCLUDE 指令来调用自己的模块了。

EXECUTABLE_OUTPUT_PATH 和LIBRARY_OUTPUT_PATH

分别用来重新定义最终结果的存放目录，前面我们已经提到了这两个变量。

PROJECT_NAME

返回通过PROJECT 指令定义的项目名称。

4. cmake 调用环境变量的方式

使用$ENV{NAME} 指令就可以调用系统的环境变量了。比如：

MESSAGE(STATUS "HOME dir: $ENV{HOME}")

设置环境变量的方式是：

SET(ENV{变量名} 值)

CMAKE_INCLUDE_CURRENT_DIR

自动添加CMAKE_CURRENT_BINARY_DIR 和CMAKE_CURRENT_SOURCE_DIR 到当前处理的CMakeLists.txt 。相当于在每个CMakeLists.txt 加入：

INCLUDE_DIRECTORIES(${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR})

CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE

将工程提供的头文件目录始终至于系统头文件目录的前面，当你定义的头文件确实跟系统发生冲突时可以提供一些帮助。

CMAKE_INCLUDE_PATH 和CMAKE_LIBRARY_PATH

上一节说过了。

5. 系统信息

CMAKE_MAJOR_VERSION：CMAKE 主版本号，比如2.4.6 中的2
CMAKE_MINOR_VERSION：CMAKE 次版本号，比如2.4.6 中的4
CMAKE_PATCH_VERSION：CMAKE 补丁等级，比如2.4.6 中的6
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

6. 主要的开关选项

CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS：用来控制IF ELSE 语句的书写方式，在下一节语法部分会讲到。
BUILD_SHARED_LIBS：用来控制默认的库编译方式，如果不进行设置，使用ADD_LIBRARY 并没有指定库类型的情况下，默认编译生成的库都是静态库。如果SET(BUILD_SHARED_LIBS ON) 后，默认生成的为动态库。
CMAKE_C_FLAGS：设置C编译选项，也可以通过指令ADD_DEFINITIONS() 添加。
CMAKE_CXX_FLAGS：设置C++ 编译选项，也可以通过指令ADD_DEFINITIONS() 添加。