cmake variable and cache

Local Variables

# Sets the MY_VARIABLE in the current function or directory scope.
set(MY_VARIABLE "value")
  • 变量名一般都是大写的。
  • 你可以通过%{}访问一个变量。
  • cmake中的变量是有作用域的。在subdirectory的cmake中,你将无法再访问当前文件中定义的变量。
  • 当变量的值中存在空格时,必须加上引号。特别是指定路径时,因为路径是很有可能含有引号的。所以指定路径不应该写%{MY_PATH},而应该写"%{MY_PATH}"

Cache Variables

当你运行cmake的时候,在build路径下会生成CMakeCache.txt文件,里面会保存你在命令行中设置的options等,所以你下一次运行cmake的时候不需要再次列出。

如果你要在CMakeLists.txt中set命令行中未设置的变量,可以这样做:

# Sets the given cache MY_CACHE_VARIABLE (cache entry).
# Since cache entries are meant to provide user-settable values this does not
# overwrite existing cache entries by default.
# Use the FORCE option to overwrite existing entries.
set(MY_CACHE_VARIABLE "VALUE" CACHE STRING "Description")

如果该变量已经在命令行中被set过,则上面的指令不会覆盖其值。

如果在上述指令中加入FORCE,则会覆盖原有的值。

set(MY_CACHE_VARIABLE "VALUE" CACHE STRING "" FORCE)

variable的type除了STRING之外,还可以为BOOL,PATH,INTERNAL等。
设置BOOL值,有更简单的写法:

option(MY_OPTION "This is settable from the command line" OFF)

这里列出了cmake中的一些特定variable。


Properties

Cmake中还有一种存储信息的方式,就是用property。它就像一个变量,但需要依附于其他item,比如directory或target。
设置property有2种方式:

# Sets one property on zero or more objects of a scope.
set_property(TARGET TargetName
             PROPERTY CXX_STANDARD 11)

# Sets properties on targets. Targets can have properties that affect how they are built.
set_target_properties(TargetName PROPERTIES
                      CXX_STANDARD 11)

第一种方式通用性更好,且可以指定多个target/file/test等。
第二种方式就是专门用来给target设置property的,它可以为单个target设置多个property。

get property则可以用

# Gets one property from one object in a scope.
get_property(ResultVariable TARGET TargetName PROPERTY CXX_STANDARD)

ResultVariable用于保存读取出的property的值。

这里列出了cmake中一些特定的property。


Scope
CMake中的变量也有scope的概念。这里分别介绍4种情况下,scope会有何不同。
参考链接

  1. add_subdirectory()
    parent directory中的CMakeLists.txt(以下简称P CMakeList)用add_subdirectory(),包含了child directory中的CMakeLists.txt(以下简称C CMakeList)。
    但是P CMakeList是感知不到C CMakeList中的local variable的。
    原因是,当add_subdirectory被执行时,它创建了一个新的scope,用于处理C CMakeList中的变量。

  2. include()
    P CMakeList用include(child/CMakeLists.txt)包含了C CMakeList。在这种情况下,P CMakeList是可以感知到C CMakeList中的变量的。因为include()指令并没有创建新的scope,P CMakeList与C CMakeList共享同一个scope。

  3. function

    # CMakeLists.txt
    cmake_minimum_required(VERSION 3.2)
    project(CMakeVariableScopeTutorial)
    
    function(func)
        set(A "Child")
    endfunction()
    
    set(A "Parent")
    
    func()
    
    message(STATUS ${A})
    # Prints "Parent"
    

    如上所示,在CMakeLists.txt中定义了一个函数func,该函数设置了一个变量A,值为"Child"。
    然后设置了一个变量A,值为"Parent"。
    接着调用func,并打印A的值,最后打印"Parent"。

    即使我们将A作为参数传给func,结果也是一样的。

    # CMakeLists.txt
    cmake_minimum_required(VERSION 3.2)
    project(CMakeVariableScopeTutorial)
    
    function(func param)
        set(${param} "Child")
    endfunction()
    
    set(A "Parent")
    
    func(A)
    
    message(STATUS ${A})
    # Prints "Parent"
    

    之所以会出现这样的结果,是因为function会创建一个新的scope,其中的variable与其外的variable没有关系,就像上面提到的add_subdirectory()。

  4. macro

    # CMakeLists.txt
    cmake_minimum_required(VERSION 3.2)
    project(CMakeVariableScopeTutorial)
    
    macro(mac)
        set(A "Child")
    endmacro()
    
    set(A "Parent")
    
    mac(A)
    
    message(STATUS ${A}) # Prints "Child"
    

    现在把function换成Macro,结果打印"Child"。
    这是因为macro并不会建立新的scope。

如果在add_subdirectory()时,在set variable时加上"PARENT_SCOPE",那么P CMakeList是可以感知到 C CMakeList中的变量的。如下例:

# parent CMakeLists.txt
cmake_minimum_required(VERSION 3.2)
project(CMakeVariableScopeTutorial)

set(A "Parent")

add_subdirectory(child)

message(STATUS ${A})
# Prints "Child"
# child CMakeLists.txt
set(A "Child" PARENT_SCOPE)
message(STATUS ${A})
# Prints "Parent"

在P CMakeList中,打印A的内容为"Child"。这我们是可以理解的,因为其内容在C CMakeList中被修改了。
但是为什么在C CMakeList中,打印A的内容为Parent呢?

因为add_subdirectory()在创建新的scope的时候,创建了变量A的一份copy,即A'。
A在parent scope中,A'在child scope中。

C CMakeList中的2句code:

  • set(A "Child" PARENT_SCOPE),因为加上了PARENT_SCOPE,设置的是parent scope中的A。
  • message(STATUS ${A})打印的是child scope中的A'。

同理,在function的例子中,加上PARENT_SCOPE,也可以达到相同的效果。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,544评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,430评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,764评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,193评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,216评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,182评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,063评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,917评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,329评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,543评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,722评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,425评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,019评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,671评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,825评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,729评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,614评论 2 353

推荐阅读更多精彩内容