摘要:

本文记录一下 CMake 变量的定义、原理及其使用。CMake 变量包含 Normal Variables、Cache Variables。通过 set 指令可以设置两种不同的变量。也可以在 CMake 脚本中使用和设置环境变量。set(ENV{} …)，本文重点讲述 CMake 脚本语言特有的两种变量。
正文：

1、两种变量的定义参考

Normal Variables
通过 set( … [PARENT_SCOPE])这个命令来设置的变量就是 Normal Variables。例如 set(MY_VAL “6”) ，此时 MY_VAL 变量的值就是 6。

Cache Variables
通过 set( … CACHE [FORCE])这个命令来设置的变量就是 Cache Variables。例如 set(MY_CACHE_VAL “666” CACHE STRING INTERNAL)，此时 MY_CACHE_VAL 就是一个 CACHE 变量。

2、Cache Variables

相当于一个全局变量，我们在同一个 cmake 工程中都可以使用。Cache 变量有以下几点说明:

SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/3rd_party  CACHE INTERNAL "")
# SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/3rd_party)MESSAGE(STATUS "CMAKE_MODULE_PATH :${CMAKE_MODULE_PATH}")

Cache 变量 CMAKE_INSTALL_PREFIX 默认值是 /usr/local (可以在生成的 CMakeCache.txt 文件中查看)，这时候如果我们 在某个 CMakeLists.txt 中，仍然使用 set(CMAKE_INSTALL_PREFIX “/usr”)，那么此时我们 install 的时候，CMake 以后面的 /usr 作为 CMAKE_INSTALL_PREFIX 的值，这是因为 CMake 规定，有一个与 Cache 变量同名的 Normal 变量出现时，后面使用这个变量的值都是以 Normal 为准，如果没有同名的 Normal 变量，CMake 才会自动使用 Cache 变量。
所有的 Cache 变量都会出现在 CMakeCache.txt 文件中。这个文件是我们键入 cmake .命令后自动出现的文件。打开这个文件发现，CMake 本身会有一些默认的全局 Cache 变量。例如：CMAKE_INSTALL_PREFIX、CMAKE_BUILD_TYPE、CMAKE_CXX_FLAGSS 等等。可以自行查看。当然，我们自己定义的 Cache 变量也会出现在这个文件中。Cache 变量定义格式为 set( CACHE STRING INTERNAL)。这里的 STRING可以替换为 BOOL FILEPATH PATH ，但是要根据前面 value 类型来确定。参考。
修改 Cache 变量。可以通过 set( CACHE INSTERNAL FORCE)，另一种方式是直接在终端中使用 cmake -D var=value …来设定默认存在的CMake Cache 变量。
下面通过一个例子来说明以上三点:

首先看一下目录树结构:

$ tree

├── CMakeLists.txt
└── src└── CMakeLists.txt

1 directory, 2 files
根目录 CMakeLists.txt 文件内容如下:

cmake_minimum_required(VERSION 3.10)
set(MY_GLOBAL_VAR "666" CACHE STRING INTERNAL )
message("第一次在父目录 CMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}")
message("第一次在父目录 MY_GLOBAL_VAR=${MY_GLOBAL_VAR}")
add_subdirectory(src)
message("第二次在父目录 CMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}")
message("第二次在父目录 MY_GLOBAL_VAR=${MY_GLOBAL_VAR}")
set(CMAKE_INSTALL_PREFIX "-->usr" )
message("第三次在父目录 CMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}")
src/CMakeLists.txt 文件内容如下:cmake_minimum_required(VERSION 3.10)
message("子目录,CMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}")
message("子目录,MY_GLOBAL_VAR=${MY_GLOBAL_VAR}")
set(CMAKE_INSTALL_PREFIX "/usr" CACHE STRING INTERNAL FORCE)
set(MY_GLOBAL_VAR "777" CACHE STRING INTERNAL FORCE )

运行结果:

$ cmake .

第一次在父目录 CMAKE_INSTALL_PREFIX=/usr/local
第一次在父目录 MY_GLOBAL_VAR=666
子目录,CMAKE_INSTALL_PREFIX=/usr/local
子目录,MY_GLOBAL_VAR=666
第二次在父目录 CMAKE_INSTALL_PREFIX=/usr
第二次在父目录 MY_GLOBAL_VAR=777
第三次在父目录 CMAKE_INSTALL_PREFIX=-->usr

程序说明：首先在根目录中打印一下当前的 Cache 变量 CMAKE_INSTALL_PREFIX 值，主要看看默认值是什么，然后在子目录 src/CMakeLists.txt 中再次打印和修改该 Cache 值，目的是熟悉修改全局 Cache 变量，当返回根目录 CMakeLists.txt 文件中再次执行第二次打印该 Cache 值时，主要看一看在子目录中修改后的效果。接着在根目录中设定一个 CMAKE_INSTALL_PREFIX 的 Normal 同名变量，此时第三次打印 CMAKE_INSTALL_PREFIX 的值，此时是为了证明，当有与 Cache 同名的 Normal 变量出现时，CMake 会优先使用 Normal 属性的值。通过设定 MY_GLOBAL_VAR 主要是为了说明可以自己设定全局 Cache 变量。最后的结果如上面显示，当我们再次执行 cmake . 的时候，程序结果如下:

$ cmake .

第一次在父目录 CMAKE_INSTALL_PREFIX=/usr
第一次在父目录 MY_GLOBAL_VAR=777
子目录,CMAKE_INSTALL_PREFIX=/usr
子目录,MY_GLOBAL_VAR=777
第二次在父目录 CMAKE_INSTALL_PREFIX=/usr
第二次在父目录 MY_GLOBAL_VAR=777
第三次在父目录 CMAKE_INSTALL_PREFIX=-->usr

可以发现第一次在父目录打印 CMAKE_INSTALL_PREFIX 和 MY_GOLBAL_VAR 时，他们的结果是上次cmake .后生成的值，存储在 CMakeCache.txt 中，自己可以找到，解决方案就是可以把 CMakeCache.txt 文件删除，然后在 cmake .我们以后在实际使用时要注意这个坑。对于修改 Cache 变量的另一种方式就是cmake -D CMAKE_INSTALL_PREFIX=/usr。可以自己验证。这里说一个重要的点，就是在终端中输入的 cmake -D var=value . 如果 CMake 中默认有这个 var Cache 变量，那么此时就是赋值，没有的话，CMake 就会默认创建了一个全局 Cache 变量然后赋值。(tips: $CACHE{VAR}表示获取 CACHE 缓存变量的值)。例子如下:(目录结构同上)

根目录 CMakeLists.txt :

cmake_minimum_required(VERSION 3.10)
set(MY_GLOBAL_VAR "666")
message("第一次在父目录 MY_GLOBAL_VAR=$CACHE{MY_GLOBAL_VAR}")
add_subdirectory(src)
message("第二次在父目录局部 MY_GLOBAL_VAR=${MY_GLOBAL_VAR}")
message("第二次在父目录全局 MY_GLOBAL_VAR=$CACHE{MY_GLOBAL_VAR}")
src/CMakeLists.txt :cmake_minimum_required(VERSION 3.10)
message("子目录,MY_GLOBAL_VAR=${MY_GLOBAL_VAR}")
set(MY_GLOBAL_VAR "777" CACHE STRING INTERNAL FORCE )

运行结果：

第一次在父目录 MY_GLOBAL_VAR=8
子目录,MY_GLOBAL_VAR=666
第二次在父目录局部 MY_GLOBAL_VAR=666
第二次在父目录全局 MY_GLOBAL_VAR=777
有了上面的基础，相信这个例子很快能看明白。

3、两种变量的作用域原理及使用

1、Normal Variables
​ 作用域属于整个 CMakeLists.txt 文件，当该文件包含了 add_subdirectory()、include()、macro()、function()语句时，会出现两种不同的效果。

（1）、包含 add_subdirectory()、function()。（本质是值拷贝）
假设，我们在工程根目录 CMakeLists.txt 文件中使用 add_subdirectory(src) 包含另一个 src 目录，在 src 目录中有另一个 CMakeLists.txt 文件。在终端运行的目录结构如下：

$ tree
├── CMakeLists.txt
└── xxx└── CMakeLists.txt

1 directory, 2 files
以根目录 CMake 文件为父目录，src 目录为子目录，此时子目录 CMake 文件会拷贝一份父目录文件的 Normal 变量。需要说明的是，我们在子目录中如果想要修改父目录 CMake 文件包含的 Normal 变量。必须通过 set(… PARENT_SCOPE) 的方式。下面通过例子来说明。

在父/根目录的 CMakeLists.txt 文件内容如下:

cmake_minimum_required(VERSION 3.10)
message("父目录 CMakeLists.txt 文件")
set(MY_VAL "6")message("第一次在父目录 MY_VAL=${MY_VAL}")
add_subdirectory(src)
message("第二次在父目录，MY_VAL=${MY_VAL}")
在子目录 src/CMakeLists.txt 文件内容如下：cmake_minimum_required(VERSION 3.10)
message("进入子目录 src/CMakeLists.txt 文件")
message("在子目录，MY_VAL=${MY_VAL}")
message("退出子目录")

运行结果：

$ cmake .


```cpp
父目录 CMakeLists.txt 文件
第一次在父目录 MY_VAL=6
进入子目录 src/CMakeLists.txt 文件
在子目录，MY_VAL=6
退出子目录
第二次在父目录，MY_VAL=6

从结果可以看出，在子目录 CMake 文件中可以直接使用父目录定义的 MY_VAL 变量的值 6。当在子目录 CMake 文件中修改 MY_VAL 变量值，看看在父目录中 MY_VAL 的值如何变化。下面仅仅在子目录 CMake 文件中加入一行代码 set(MY_VAL “7”),最后的子目录 CMake 文件代码如下：

cmake_minimum_required(VERSION 3.10)
message("进入子目录 src/CMakeLists.txt 文件")
set(MY_VAL "7") # 刚刚加入的message("在子目录，MY_VAL=${MY_VAL}")
message("退出子目录")

运行结果：


$ cmake .```cpp
父目录 CMakeLists.txt 文件
第一次在父目录 MY_VAL=6
进入子目录 src/CMakeLists.txt 文件
在子目录，MY_VAL=7
退出子目录
第二次在父目录，MY_VAL=6

我们发现在 src/CMakeLists.txt 中打印的 MY_VAL 的值是 7，然后退出子目录回到根目录后，打印 MY_VAL 的值仍然是 6。**说明了：子目录的 CMakeLists.txt 文件仅仅是拷贝了一份父目录的 Normal 变量，即使在子目录 CMake 文件中修改了 MY_VAL 变量，那也只是子目录自己的变量，不是父目录的变量。**因为 Normal 变量的作用域就是以 CMakeLists.txt 文件为基本单元。那么我们如何在子目录 CMake 文件中修改父目录 CMake 文件的 Normal 变量呢? 我们需要在子目录 CMakeLists.txt 文件中设置 MY_VAL 时，加上 PARENT_SCOPE 属性。即用如下代码: set(MY_VAL “7” PARENT_SCOPE)，子目录 CMakeLists.txt 文件如下：

cmake_minimum_required(VERSION 3.10)
message("进入子目录 src/CMakeLists.txt 文件")
set(MY_VAL "7" PARENT_SCOPE) # 修改处message("在子目录，MY_VAL=${MY_VAL}")
message("退出子目录")

运行结果:

$ cmake .

父目录 CMakeLists.txt 文件
第一次在父目录 MY_VAL=6
进入子目录 src/CMakeLists.txt 文件
在子目录，MY_VAL=6
退出子目录
第二次在父目录，MY_VAL=7

可以看出在第二次回到父目录时，MY_VAL 的值已经变成了 7。同理，对于 function() 最开始的结论也适用。代码如下：

c

make_minimum_required(VERSION 3.10)
message("父目录 CMakeLists.txt 文件")
set(MY_VAL "6")message("第一次在父目录 MY_VAL=${MY_VAL}")

函数定义

function(xyz test_VAL) # 函数定义处！set(MY_VAL "888" PARENT_SCOPE)message("functions is MY_VAL=${MY_VAL}")
endfunction(xyz)xyz(${MY_VAL}) # 调用函数
message("第二次在父目录，MY_VAL=${MY_VAL}")

运行结果:

父目录 CMakeLists.txt 文件
第一次在父目录 MY_VAL=6
functions is MY_VAL=6
第二次在父目录，MY_VAL=8

可以看出在该函数中使用 MY_VAL 这个变量值，其实就是一份父目录变量的值拷贝，此时打印值为 6。在 函数中修改值，那么也是用 set(${MY_VAL} 8 PARENT_SCOPE)。此时，退出函数第二次打印变量值时。该值就是在函数中修改好的值 8。 本质讲，对于 function() 而言，刚刚说到的父目录其实不是严格正确的。因为函数定义可以是在其他 .cmake 模块文件中定义的。也可以在其他 CMakeLists.txt 文件中调用，因此准确的说，这里的父目录应该改为『调用函数的地方所属的 CMakeLists.txt 』，我们做的这个实验是在根目录 CMakeLists.txt 文件中定义了函数，又在本文件中使用了。因此之前的说法理解其意思即可。对于 add_subdirectory() 而言，其实也是说调用的地方。下面的 include()、macro() 例子会涉及到，将 function() 放在一个外部的 .cmake 文件中。那里也会说明 function() 与 macro() 的不同。
（2）、包含 include()、macro() （本质有点类似 c 中的 #include 预处理含义）
现在在上面的根目录中加入了一个 cmake_modules 目录。目录中有一个 Findtest.cmake 文件。新的目录结构如下:

$ tree

├── CMakeLists.txt
├── cmake_modules
│   └── Findtest.cmake
└── src└── CMakeLists.txt

2 directories, 3 files
在根目录中的 CMakeLists.txt 文件包含的代码如下:

cmake_minimum_required(VERSION 3.10)
message("父目录 CMakeLists.txt 文件")
set(MY_VAL "6")
message("第一次在父目录 MY_VAL=${MY_VAL}")

使用 include() 文件的宏

list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake_modules)
include(Findtest) # 从 CMAKE_MODULE_PATH 包含的路径中搜索 Findtest.cmake 文件
#test(${MY_VAL}) # 调用宏
#xyz(${MY_VAL}) # 调用函数#find_package(test REQUIRED) # 从 CMAKE_MODULE_PATH 包含的路径中搜索 Findtest.cmake 文件 与 include () 两者的效果是一样的！message("第二次在父目录，MY_VAL=${MY_VAL}")message("include test=${test_VAL}")
#message("macro_val=${macro_val}")
cmake_modules/Findtest.cmake 文件内容如下:

该文件定义了一个函数以及一个宏

message("进入 Findtest.cmake 文件")set(test_VAL "222") # 验证根目录 CMake 文件能够访问这个变量
set(MY_VAL "000") # 测试 include() 效果

宏定义

macro(test MY_VA) # 定义一个宏！set(macro_val "1") # 宏内部定义变量message("macro is MY_VAL=${MY_VA}")set(MY_VAL "999") # 直接修改的就是调用该宏所处的文件中的 Normal 变量
endmacro(test)

函数定义

function(xyz test_VAL)set(MY_VAL "888" PARENT_SCOPE)  # 修改 调用者的 变量message("function is MY_VAL=${MY_VAL}")
endfunction(xyz)

运行结果：

$ cmake .

父目录 CMakeLists.txt 文件
第一次在父目录 MY_VAL=6
进入 Findtest.cmake 文件
第二次在父目录，MY_VAL=000
include test=222

从结果可以看出，include() 内部是可以修改调用者 MY_VAL 变量。include() 包含的文件内定义的变量 test_VAL，也可以在调用 include() 的 CMakeLists.txt 文件中直接访问，同样的对于 macro() 也适用，在根目录 CMake 文件中调用宏，即取消 test(MYVAL)以及message("macroval={MY_VAL}) 以及 message("macro_val=MYV​AL)以及message("macrov​al={macro_val}") 部分的注释，此时最后输出结果 ：

$ cmake .

父目录 CMakeLists.txt 文件
第一次在父目录 MY_VAL=6
进入 Findtest.cmake 文件
macro is MY_VAL=000
第二次在父目录，MY_VAL=999
include test=222
macro_val=1

可以看出，这次输出的结果在第二次进入父目录后，MY_VAL 变量的值就是 999 了。注意到在根目录中 CMakeLists.txt 中 注释语句中有一个 find_package() ，这个和 include() 其实都是一样的结果。

总结:

结合 include() 、macro() 最后结果，能够得出一个结论：通过 include() 和 macro() 相当于把这两部分包含的代码直接加入根目录 CMakeLists.txt 文件中去执行，相当于他们是一个整体。因此变量直接都是互通的。这就有点像 C/C++ 中的 #include 包含头文件的预处理过程了。这一点其实与刚开始讲的 function() 、add_subdirectory() 完全不同，在函数以及 add_subdirectory() 中，他们本身就是一个不同的作用域范围，仅仅通过拷贝调用者的 Normal 值(仅仅在调用 add_subdirectory() / function() 之前的 Normal 变量)，如果要修改调用者包含的 Normal 变量，那么只能通过 set(MY_VAL “某个值” PARENT_SCOPE)注明我们修改的是调用者 Normal 值。虽然在 C/C++ 中，可以通过指针的方式，通过函数可以修改外部变量值，但是在 CMake 脚本语言中 function() 虽然能够传入形式参数，但是者本质上就是 C/C++ 中的值拷贝。而不是引用。上面所说的 Normal 变量其实就是一个局部变量。

参考:
1、https://stackoverflow.com/questions/31037882/whats-the-cmake-syntax-to-set-and-use-variables/31044116#31044116
2、https://stackoverflow.com/questions/3249459/for-the-cmake-include-command-what-is-the-difference-between-a-file-and-a-mod
3、https://cmake.org/cmake/help/v3.11/command/set.html#set
4、https://blog.csdn.net/weixin_39732534/article/details/110658282
5、https://guoqiang.blog.csdn.net/article/details/122214424

cmake:在各级目录之间共享变量(cmake cache变量)相关推荐

  1. cmake cache变量_反复研究好几遍，我才发现关于 CMake 变量还可以这样理解！

    本文的排版有些问题,如果您觉得本文排版不太好看,可以到这里查看: 反复研究好几遍,我才发现关于 CMake 变量还可以这样理解!​mp.weixin.qq.com 摘要: 本文记录一下 CMake 变 ...

  2. cmake编译安装完成后 执行cmake --version报错 bash: /usr/bin/cmake: 没有那个文件或目录

    cmake编译安装完成后 执行cmake --version报错 bash: /usr/bin/cmake: 没有那个文件或目录 cmake 没有那个目录 - 未完代码 - 博客园 因为直接使用cma ...

  3. cmake添加查找目录_cmake find_package路径详解

    Motivation 经常在Linux下面写C++程序,尤其是需要集成各种第三方库的工程,肯定对find_package指令不陌生. 这是条很强大的指令.可以直接帮我们解决整个工程的依赖问题,自动把头 ...

  4. cmake添加查找目录_CMake如何查找库路径（一）

    CMake如何查找库路径(一) 如果你的代码使用了外部库(external libraries),并且你事先不知道这些库的头文件和库文件在当前平台的位置.那么适当的文件夹路径和库的搜索路径就应该被添加 ...

  5. CMake 指定安装目录，CMake 指定安装路径

    CMake 指定安装目录,CMake 指定安装路径.使用CMAKE_INSTALL_PREFIX参数. 一.方法一 cmake -DCMAKE_TOOLCHAIN_FILE=../toolchain. ...

  6. cmake教程（为什么要用cmake？）（cmake编译opencv）（就是个跨平台的编译工具Linux、windows）（很重要，必须得学）（报错解决方案）opencv编译

    文章目录 cmake编译opencv源码 分割线 CMake:简介及工程应用,及为什么要用CMake,使用CMake自动构建工程 mark一下,回头更 cmake编译opencv源码 cmake官网: ...

  7. cmake的使用-为什么要使用CMake

    介绍 代码仓库地址 https://github.com/zzu-andrew/linux-sys/tree/dfew/CMake 为了将源码转化为最终用户可以实际使用的东西,需要使用到编译器.链接器 ...

  8. cmake could not find openssl_使用CMake构建C++项目

    背景 现代CMake如今开始转向使用targets和properties,比如下面文章介绍的这样: https://pabloariasal.github.io/2018/02/19/its-time ...

  9. 现代 CMake 简明教程（一）- CMake 基础

    系列文章目录 现代 CMake 简明教程(一)- CMake 基础 现代 CMake 简明教程(二)- 设计理念与使用 文章目录 系列文章目录 前言 CMake 基础 1. Modern CMake ...

最新文章

  1. Django源码分析6:auth认证及登陆保持
  2. 总结Servlet体系接口和类
  3. 如何将本地文件通过终端上传到linux服务器 /服务器/阿里云
  4. Java中的条件编译
  5. Nginx安装学习使用具体记录
  6. C++封装、继承、多态
  7. 纪念第一个正式的java程序
  8. #、%和$符号在OGNL表达式中的作用
  9. java listeners_Java ActionListeners
  10. sublime-cssrem-安装与使用
  11. 解决Could not load file or assembly CefSharp.Core.dll的问题
  12. python点击按钮弹出新窗口_PyQt5点击button如何弹出新窗口？
  13. kaldi在java中运行_Kaldi语音识别CVTE模型实战
  14. 使用CleanWipe卸载Symantec Endpoint Protection
  15. cad怎么倒圆角_CAD哪些技巧是菜鸟必备，哪些又让你相见恨晚？
  16. 通过相关系数和自由度求置信度
  17. Exposure X8 ps人像图片调色滤镜插件
  18. SecKill学习初步框架时报错记录
  19. 使用Pyecharts进行全国水质TDS地图可视化全过程9：构建字典，批量生成所有省份地图
  20. 饥荒无条件制作下载_饥荒巨人国无条件制造版

热门文章

  1. nginx php 大小写问题,Nginx实现url请求不区分大小写
  2. python中forward的参数_如何将关键字参数传递给preforward钩子使用的forward？
  3. 2017年计算机四级试题,2017年全国计算机四级考试模拟试题与答案
  4. 单位斜变函数matlab,实验二 用MATLAB实现线性系统的时域分析
  5. Python，OpenCV鼠标事件进行矩形、圆形的绘制（随机颜色、随机半径）
  6. 现代计算机三大科学计算,计算机的三大特点是什么？
  7. PCL中outofcore模块---基于核外八叉树的大规模点云的显示
  8. 编译OpenCV 2+ with CUDA 9+
  9. 强化学习（三） - Gym库介绍和使用，Markov决策程序实例，动态规划决策实例
  10. Udacity机器人软件工程师课程笔记（四）-样本搜索和找回-基于漫游者号模拟器-决策树