CMake set_source_files_properties用法详解
set_source_files_properties
是 CMake 中用于为特定源文件设置属性的命令,可以控制编译选项、文件类型、依赖生成等。它支持设置头文件属性,但需注意头文件一般不参与编译(除非显式包含在 add_executable
/add_library
中)。以下是具体用法和示例:
https://cmake.org/cmake/help/latest/command/set_source_files_properties.html
基本语法
set_source_files_properties(<files>... PROPERTIES <prop1> <value1> <prop2> <value2>...)
示例 1:设置单个文件的编译选项
# 为 main.cpp 添加特定的编译选项(如禁用警告)
set_source_files_properties(main.cpp PROPERTIES COMPILE_FLAGS "-Wno-unused-variable")
示例 2:标记头文件为“仅头文件”
# 头文件不参与编译,但需要包含在项目中(如 IDE 文件树显示)
set_source_files_properties(my_header.h PROPERTIES HEADER_FILE_ONLY TRUE)
示例 3:标记生成的文件(如自动生成的头文件)
# 告诉 CMake 该文件是生成的,避免检查文件是否存在
set_source_files_properties(generated_code.h PROPERTIES GENERATED TRUE)
示例 4:设置多个属性
# 为多个文件设置不同属性
set_source_files_properties(
file1.cpp file2.cpp
PROPERTIES
COMPILE_FLAGS "-O3" # 优化级别
SKIP_AUTOMOC TRUE # 跳过 Qt 的自动 moc 处理
)
示例 5:设置对象文件的输出名称
# 强制 file.cpp 编译后的对象文件名为 custom_name.obj
set_source_files_properties(file.cpp PROPERTIES OUTPUT_NAME "custom_name")
常见属性说明
属性名 | 作用 |
---|---|
COMPILE_FLAGS | 指定文件的编译选项 |
GENERATED | 标记文件为生成(避免 CMake 检查) |
HEADER_FILE_ONLY | 标记文件为仅头文件(不参与编译) |
SKIP_AUTOMOC | 跳过 Qt 的自动 moc 处理 |
OUTPUT_NAME | 自定义生成的对象文件/库的名称 |
注意事项
-
头文件是否需要设置属性?
- 如果头文件被显式添加到
add_executable()
或add_library()
中,可以设置属性(如标记为GENERATED
)。 - 一般情况,头文件通过
target_include_directories()
包含路径即可,无需额外设置。
- 如果头文件被显式添加到
-
现代 CMake 替代方案
对于编译选项,更推荐使用target_compile_options()
按目标设置:target_compile_options(my_target PRIVATE -Wno-unused-variable)
但
set_source_files_properties
在需要文件级精细控制时仍然有效。
希望这些示例能帮助你灵活管理 CMake 项目的文件属性!