cmake get_directory_property指令详解

get_directory_property 指令在 CMake 中用于获取目录范围的属性值。这些属性可以是用户自定义的，也可以是 CMake 内置的属性。目录属性与目标属性、变量和其他作用域不同，通常用于控制在特定目录中的构建行为。

语法

get_directory_property(VAR [DIRECTORY dir] PROPERTY prop)

• VAR：存储属性值的变量名称。
• DIRECTORY dir：指定目录（可选）。如果未指定，则使用当前处理的目录。
• PROPERTY prop：要获取的属性名称。

常见的目录属性

• INCLUDE_DIRECTORIES：该目录中包含的目录列表。
• COMPILE_DEFINITIONS：该目录中定义的编译器宏。
• IMPORTED_TARGETS：该目录中导入的目标。
• BUILDSYSTEM_TARGETS：该目录中定义的构建系统目标。
• LISTFILE_STACK：当前目录中处理的 CMake 列表文件的堆栈。
• PARENT_DIRECTORY：当前目录的父目录。

示例
以下是一些使用 get_directory_property 的示例。

获取当前目录的包含目录

get_directory_property(includes DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
message(STATUS "Include directories: ${includes}")

获取当前目录的编译器宏

get_directory_property(definitions DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY COMPILE_DEFINITIONS)
message(STATUS "Compile definitions: ${definitions}")

获取父目录

get_directory_property(parent_dir PROPERTY PARENT_DIRECTORY)
message(STATUS "Parent directory: ${parent_dir}")

使用用户自定义属性
你也可以使用 set_directory_properties 设置自定义属性：

# 设置自定义属性
set_directory_properties(PROPERTIES MY_CUSTOM_PROPERTY "CustomValue")

# 获取自定义属性
get_directory_property(custom_prop PROPERTY MY_CUSTOM_PROPERTY)
message(STATUS "Custom property: ${custom_prop}")

结合其他指令的示例
假设我们有一个项目结构如下：

project/
├── CMakeLists.txt
└── src/
    ├── CMakeLists.txt
    └── main.cpp

在 project/CMakeLists.txt 中：

cmake_minimum_required(VERSION 3.10)
project(MyProject)

# 设置包含目录
include_directories(${CMAKE_SOURCE_DIR}/include)

# 设置编译器宏
add_definitions(-DMY_DEFINITION)

# 子目录
add_subdirectory(src)

在 project/src/CMakeLists.txt 中：

# 获取父目录的包含目录
get_directory_property(includes DIRECTORY ${CMAKE_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
message(STATUS "Include directories in src: ${includes}")

# 获取父目录的编译器宏
get_directory_property(definitions DIRECTORY ${CMAKE_SOURCE_DIR} PROPERTY COMPILE_DEFINITIONS)
message(STATUS "Compile definitions in src: ${definitions}")

# 添加可执行文件
add_executable(MyApp main.cpp)

执行 CMake 配置时，你将看到父目录中设置的包含目录和编译器宏在 src 子目录中被获取并显示出来。

这些示例展示了 get_directory_property 的基本用法，以及如何在 CMake 构建系统中获取目录范围的属性值。它对于了解和调试 CMake 脚本中的目录级别配置非常有用。