cmake include 写法

在 CMake 中，include() 命令用于包含并执行其他 CMake 脚本文件的内容。以下是不同场景下的正确使用方法和示例：

一、基本语法

include(<file|module> [OPTIONAL] [RESULT_VARIABLE <var>])

二、基本用法示例

1. 包含本地文件

# 包含同级目录文件
include(helper.cmake)

# 包含子目录文件
include(src/utils.cmake)

# 包含上级目录文件
include(../config/project_options.cmake)

2. 包含路径变量

# 使用当前文件所在目录
include(${CMAKE_CURRENT_LIST_DIR}/version.cmake)

# 使用绝对路径
include(/opt/myproject/config.cmake)

三、高级用法

1. 可选包含（文件不存在时不报错）

include(deprecated.cmake OPTIONAL)

2. 获取包含结果

include(important.cmake RESULT_VARIABLE included_file)
if(NOT included_file)
    message(WARNING "未找到重要配置文件!")
endif()

3. 包含模块（带查找功能）

# 先在模块路径中查找
include(FindOpenSSL)

# 自定义模块路径
list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
include(FindMyLibrary)

四、实际应用场景

场景1：共享通用配置

common.cmake:

set(COMMON_COMPILE_OPTIONS "-Wall -Wextra")
set(PROJECT_VERSION "1.0.0")

CMakeLists.txt:

include(common.cmake)

add_executable(app main.cpp)
target_compile_options(app PRIVATE ${COMMON_COMPILE_OPTIONS})

场景2：自定义函数模块

utils.cmake:

function(print_target target)
    message(STATUS "配置目标: ${target}")
    get_target_property(target_type ${target} TYPE)
    message(STATUS "目标类型: ${target_type}")
endfunction()

CMakeLists.txt:

include(utils.cmake)

add_library(mylib STATIC lib.cpp)
print_target(mylib)  # 调用自定义函数

五、特殊包含方式

1. 包含远端文件

# 需要CMake 3.18+
file(DOWNLOAD 
    https://example.com/config.cmake
    ${CMAKE_CURRENT_BINARY_DIR}/remote_config.cmake
)
include(${CMAKE_CURRENT_BINARY_DIR}/remote_config.cmake)

2. 动态包含（条件判断）

if(WIN32)
    include(windows_config.cmake)
elseif(UNIX)
    include(unix_config.cmake)
endif()

六、常见错误解决方案

1. 文件未找到：

   # 使用绝对路径
   include(${CMAKE_CURRENT_SOURCE_DIR}/missing_file.cmake)
   

2. 循环包含：

   • 避免文件A包含B，同时B又包含A

3. 变量污染：

   # 使用函数封装代替全局变量
   function(load_config)
       set(CONFIG_VALUE "secret" PARENT_SCOPE)
   endfunction()
   

七、最佳实践

1. 使用相对路径时结合 CMAKE_CURRENT_LIST_DIR

   include(${CMAKE_CURRENT_LIST_DIR}/local_config.cmake)
   

2. 模块化组织：

   project/
   ├── CMakeLists.txt
   ├── cmake/
   │   ├── FindDependencies.cmake
   │   ├── ProjectOptions.cmake
   │   └── Utils.cmake
   └── src/
   

3. 重要文件校验：

   if(EXISTS "${CMAKE_CURRENT_LIST_DIR}/critical.cmake")
       include(critical.cmake)
   else()
       message(FATAL_ERROR "缺少关键配置文件")
   endif()
   

通过合理使用 include()，可以实现 CMake 脚本的模块化和复用，提高构建系统的可维护性。