讲师中心 微信公众号
AI工具推荐 视频效率加速

C++ 怎么在 CMake 中编写高级的自定义命令(add_custom_command)与目标生成器

胖杰大大_8361

胖杰大大_8361

发布时间:2026-10-22 11:51:02

|

378人浏览过

|

来源于php中文网

原创

关键看生成文件用途:编译前需的(如头文件)用OUTPUT+add_dependencies;构建后操作(如打包)用POST_BUILD(仅限add_custom_target)。BYPRODUCTS适用于无确定输出的场景,如linter或动态路径生成。

c++ 怎么在 cmake 中编写高级的自定义命令(add_custom_command)与目标生成器

add_custom_command 的两种执行时机怎么选

关键看你要生成的文件是编译前需要的(比如头文件、协议缓冲区代码),还是构建后要做的(比如打包、压缩、校验)。add_custom_command 本质只有两类触发方式:OUTPUT 和 PRE_BUILD/POST_BUILD,但后者仅对 add_custom_target 有效,不能直接挂到库或可执行目标上。

常见错误是把生成 proto.h 的命令写成 COMMAND + POST_BUILD —— 这会导致编译器在第一次编译时找不到头文件而失败。正确做法是用 OUTPUT 声明产出,并让 CMake 知道这个输出是某个源文件的依赖:

add_custom_command(
  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/generated.pb.h
  COMMAND protoc --cpp_out=${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/msg.proto
  DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/msg.proto
  COMMENT "Generating protobuf headers"
)

然后必须显式告诉目标它依赖这个输出:

add_executable(myapp main.cpp)
add_dependencies(myapp ${CMAKE_CURRENT_BINARY_DIR}/generated.pb.h)
target_sources(myapp PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/generated.pb.h)

为什么 add_custom_target 配合 BYPRODUCTS 更适合“伪生成”场景

当命令不产生真实文件(比如运行 linter、触发 CI 通知),或产出文件路径动态不可知(如 git describe 写入版本字符串到临时变量),就不能靠 OUTPUT 触发重执行。BYPRODUCTS 是更安全的替代:它声明“这个命令可能生成这些文件”,但不强制要求它们存在;CMake 会把它当作构建图中的一个节点,支持 add_dependencies,且不会因缺失 byproduct 报错。

立即学习“C++免费学习笔记(深入)”;

典型用法:

Command Guardian
Command Guardian

用于在执行删除、覆盖、移动、部署、重写 Git 历史、修改权限等命令前的安全检查。

下载
  • BYPRODUCTS 必须配合 OUTPUT 或 COMMAND 使用,单独写无效
  • 若命令实际没生成对应文件,CMake 不报错,但下次构建仍会执行(除非加 VERBATIM + 手动缓存)
  • 不要把 BYPRODUCTS 当作“忽略输出检查”的捷径——它解决的是“产出不确定”问题,不是“不想管输出”
add_custom_target(update_version
  COMMAND ${CMAKE_COMMAND} -E echo "$$(${GIT_EXECUTABLE} describe --tags)" > ${CMAKE_CURRENT_BINARY_DIR}/VERSION
  BYPRODUCTS ${CMAKE_CURRENT_BINARY_DIR}/VERSION
  COMMENT "Updating VERSION file"
)

COMMAND 中的路径和变量为什么总出错

CMake 在 add_custom_command 里展开变量是“惰性的”:所有 ${...} 在配置阶段(cmake ..)就被替换成绝对路径,而 $<...></...> 是生成器表达式,延迟到构建阶段(make/ninja)才求值。混用就会崩溃。

常见陷阱:

  • 在 COMMAND 里写 ${CMAKE_SOURCE_DIR}/script.py → 没问题,但若脚本本身要读相对路径参数,就失效
  • 想传当前构建配置(Debug/Release)给命令?必须用 $<CONFIG>,写成 ${CMAKE_BUILD_TYPE} 会变成空或错误值
  • Windows 上用 cmd.exe /c 调命令时,%CD% 不可靠,应统一用 $<TARGET_FILE_DIR:xxx> 或 $<CURRENT_SOURCE_DIR>

正确示例(跨平台获取当前源目录并传给 Python 脚本):

add_custom_command(
  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/config.json
  COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/gen_config.py
    $<CURRENT_SOURCE_DIR>
    $<CONFIG>
  DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/gen_config.py
)

自定义目标生成器(generator expression)的边界在哪

生成器表达式($<...>)不是万能的。它只能用于 CMake 已知上下文:比如 target_compile_definitions、source_group、add_custom_command(COMMAND)。但它不能出现在 if()、set() 或 shell 命令内部(除非该命令本身由 CMake 解析,如 COMMAND ${CMAKE_COMMAND} -E ...)。

容易被忽略的限制:

  • $<TARGET_PROPERTY:mylib,INTERFACE_INCLUDE_DIRECTORIES> 只在 target-aware 上下文有效,不能塞进 add_custom_command(OUTPUT ...) 的文件名里
  • $<JOIN:...> 和 $<SEMICOLON> 很有用,但嵌套过深(>3 层)会让 Ninja 构建失败,建议拆成多个 add_custom_command
  • 调试技巧:运行 cmake --build . --verbose 查看最终展开的命令,比猜 $<...> 合理性更直接

真正难的是让生成逻辑可复现——比如用 $<TARGET_FILE:mylib> 作为输入依赖时,若 mylib 尚未定义,CMake 配置会静默失败。务必确保 add_custom_command 出现在相关 add_library 之后,且依赖关系用 add_dependencies 显式连接。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

相关专题

更多
c++和c语言的区别有哪些
c++和c语言的区别有哪些

c++和c语言的区别:1、面向对象编程(OOP)支持不同;2、新增特性不同;3、标准库不同;4、编译方式不同;5、命名空间不同等等。想了解更多c++的相关内容,可以阅读本专题下面的文章。

2248

2024.03.14

c++和python学习顺序推荐
c++和python学习顺序推荐

一般建议先学习C++,再学习Python,因为这样可以逐步从较为底层的编程语言向更高级的语言过渡。想了解更多python的相关内容,可以阅读本专题下面的文章。

1019

2024.03.14

python和c++学习性价比分析
python和c++学习性价比分析

Python易于学习,广泛应用于Web开发、数据科学和人工智能等领域,但性能较低。C语言性能高,适用于对性能要求较高的场景,如游戏开发和系统编程,但学习曲线陡峭,错误处理复杂。想了解更多python的相关内容,可以阅读本专题下面的文章。

447

2024.03.14

c语言和c++一样吗
c语言和c++一样吗

c语言和c++是两种不同的编程语言,虽然有相似之处,但存在显著差异。c语言专注于过程式编程和系统级开发,以简洁、高效著称。c++作为c语言的超集,引入了面向对象编程,增强了代码组织和管理能力,但学习曲线也更陡峭。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

327

2024.03.14

c语言和c++先学哪个好
c语言和c++先学哪个好

初学者选择学习c语言还是c++语言,需要根据个人学习目标、背景以及编程兴趣和预期应用方向来决定。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

406

2024.03.14

c语言和c++的区别和联系
c语言和c++的区别和联系

c语言和c++是计算机科学领域应用广泛的编程语言。虽然它们有着相似的基础,但它们在语言类型、语法功能和内存管理方面存在着显著差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

580

2024.03.14

c++软件中文更改教程
c++软件中文更改教程

对于 ide,可通过打开设置,找到语言设置,选择中文,并保存更改。对于非 ide 应用程序,可查找设置或选项,选择语言设置,更改为中文,并保存更改。想了解更多c++的相关内容,可以阅读本专题下面的文章。

1409

2024.03.21

python和java和c++学习性价比分析
python和java和c++学习性价比分析

Python以其易学性、丰富的库和活跃的社区而著称,适合数据科学、人工智能和Web开发。Java以其跨平台性、企业级应用开发和Android应用开发而闻名。C++以其底层控制能力、高效性能和游戏开发而著称。选择哪种语言取决于个人兴趣、职业方向和特定需求。想了解更多python和java和c++的相关内容,可以阅读本专题下面的文章。

1217

2024.03.22

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

0

2026.10.22

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C语言中文开发手册
C语言中文开发手册

共0课时 | 0.2万人学习

极客学院ASP.NET视频教程
极客学院ASP.NET视频教程

共90课时 | 24.3万人学习

Go语言教程手册
Go语言教程手册

共23课时 | 27万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn