CMake获取属性命令get_property简介

CMake中有很多内置的变量，以CMAKE_开头，本文要介绍的是另外一种“变量”，叫做属性，它与一个范围绑定。当CMake添加一个目录、创建一个目标、创建缓存条目、创建测试、创建安装目录时，也同时会生成与这些范围相关联的属性（范围可以关联多个不同属性）。属性无法通变量的获取方式${}直接得到，需要使用本文介绍的get_propery()命令进行获取。

命令简介

命令格式为：

get_property(<variable>
<GLOBAL |
DIRECTORY [<dir>] |
TARGET <target> |
SOURCE <source>
[DIRECTORY <dir> | TARGET_DIRECTORY <target>] |
INSTALL <file> |
TEST <test> |
CACHE <entry> |
VARIABLE >
PROPERTY <name>
[SET | DEFINED | BRIEF_DOCS | FULL_DOCS])

命令的第一个参数<variable>是存储属性获取的结果，第二个参数表示待获取的属性归属的范围，第三个参数是PROPERTY选项后面跟着属性的名称（可以是CMake默认定义的属性，也可以自定义属性）。

简单的示例

例如，当CMake读取CMakeLists.txt文件启动构建时，会对CMakeLists.txt文件所在的目录，添加一个名为INCLUDE_DIRECTORIES属性，表示在CMake位于当前目录下的头文件搜索目录列表（通过include_directories()命令CMake会为该属性赋值），下面来简单演示下如何获取这个属性。

CMakeLists.txt文件内容：

cmake_minimum_required(VERSION 3.22.1)
project(get_property_test)

get_property(dirs DIRECTORY ${CMAKE_CURRENT_SRC_DIR} PROPERTY INCLUDE_DIRECTORIES)
message("# Get current directory property INCLUDE_DIRECTORIES: ${dirs}")

include_directories(test)
get_property(dirs DIRECTORY ${CMAKE_CURRENT_SRC_DIR} PROPERTY INCLUDE_DIRECTORIES)
message("# Get current directory property INCLUDE_DIRECTORIES after include 'test': ${dirs}")

运行cmake .输出结果：

# Get current directory property INCLUDE_DIRECTORIES: 
# Get current directory property INCLUDE_DIRECTORIES after include 'test': /XXX/test

说明在使用include_directories(test)后，当前目录的属性INCLUDE_DIRECTORIES被修改了，把test目录增加了进去。

参数详解

范围参数

指定的范围必须是如下的选项之一：

• GLOBAL

  全局范围，后面不需要指定范围名称。使用该选项时，等同于命令get_cmake_property，可以参考get_cmake_property命令介绍。

  获取CMAKE_ROLE全局属性：

  cmake_minimum_required(VERSION 3.22.1)
  project(get_property_test)
  
  get_property(role GLOBAL PROPERTY CMAKE_ROLE)
  message("# Get GLOBAL property CMAKE_ROLE: ${role}")
  

  输出结果

  $ cmake .
  # Get GLOBAL property CMAKE_ROLE: PROJECT
  

• DIRECTORY

  目录范围，如果选项后不指定目录名称，默认是当前目录。指定的目录可以使绝对路径也可以是相对路径，如果是相对路径，那么是相对于当前的目录路径。该选项等同于命令get_directory_property。

• TARGET

  获取指定构建目标的属性，等同于命令get_target_property()。

  获取NAME属性

  cmake_minimum_required(VERSION 3.22.1)
  project(get_property_test)
  
  add_executable(hello .)
  get_property(target_name TARGET hello PROPERTY NAME)
  message("# Get target property NAME: ${target_name}")
  

  输出结果

  # Get GLOBAL property CMAKE_ROLE: PROJECT
  

• SOURCE

  获取指定源文件属性，该参数后面必须跟一个源文件名，默认情况下，源文件的属性会赋值当前源文件所在目录的属性。目录也可以通过选项进行指定。

  • DIRECTORY <dir>：从指定的<dir>目录获取属性，前提是该目录是已经通过add_subdirectory()添加或者是CMake构建的顶层目录。如果是相对路径，则是针对当前目录的相对路径。
  • TARGET_DIRECTORY <target>：从构建目标<target>被创建的目录中获取属性，前提是<target>必须已经存在（通过add_executable或add_libraray创建）

• INSTALL

  获取指定安装目录的属性。

• TEST

  获取指定测试的属性。

• CACHE

  获取缓存条目的属性。

• VARIABLE

  获取变量的属性。

其他参数选项

• SET

  如果指定SET选项，则获取的变量，表示的是属性是否被设置过，是一个布尔值。

• DEFINED

  如果指定DEFINED选项，则获取的变量，表示的是属性是否被定义，是一个布尔值。

• BRIEF_DOCS或FULL_DOCS

  如果指定了这两个选型，则获取的变量是一个属性文档的字符串。