CMake笔记:add_custom_command不执行

0x00. 前言

在网上看别人做一些手工教程视频,经常能看到这样的评论:

脑子:我感觉我会了。
手:你行你来。

之前一直通过编译脚本去寻找代码入口,感觉我已经懂得CMake的语法了,直到今天寄己要写一个脚本去编译一个工程才发现,事情并不简单:脚本并没有按照我期望的去执行。

此工程需要用到Protocol Buffer,因此当代码构建的时候需要使用使用Protocol Buffer编译器去编译.proto文件获得对应的生成文件。理论上,想要达到这个目的,我们只需要在CMakeLists.txt中使用add_custom_command命令就可以可以生成对应的构建规则。但出人意料的是,这条命令并没有被执行,也就是说,并没有编译.proto文件的规则生成,因此当最终使用Make去构建工程的时候,没能通过.proto文件得到对应的源代码。

0x01. 踩雷

整个命令的使用如下面的代码所示,作用就是将位${REPO_ROOT}/protobuf/onnx-operators-ml.proto以及${REPO_ROOT}/protobuf/onnx-ml.proto这两个文件编译成C++头文件以及源文件,并存放到{REPO_ROOT}/src目录下,其中${REPO_ROOT}是项目的根目录,例如在我的例子中为/home/sunny/workspace/model-tool/

set(PROTOBUF_PROTOC_EXECUTABLE ${REPO_ROOT}/build/third_party/protobuf/cmake/protoc)

list(APPEND PROTO_FILES 
     "${REPO_ROOT}/protobuf/onnx-operators-ml.proto"
     "${REPO_ROOT}/protobuf/onnx-ml.proto")

set(output_dir ${REPO_ROOT}/include)
set(protoc_include ${REPO_ROOT}/protobuf)

foreach(fil ${PROTO_FILES})
    get_filename_component(abs_fil ${fil} ABSOLUTE)
    get_filename_component(fil_we ${fil} NAME_WE)

    list(APPEND ${srcs_var} "${output_dir}/${fil_we}.pb.cc")
    list(APPEND ${hdrs_var} "${output_dir}/${fil_we}.pb.h")

    add_custom_command(
        OUTPUT "${output_dir}/${fil_we}.pb.cc"
                "${output_dir}/${fil_we}.pb.h"
        COMMAND ${PROTOBUF_PROTOC_EXECUTABLE} --cpp_out    ${output_dir} -I${protoc_include} ${abs_fil}
        DEPENDS ${abs_file}
        COMMENT "Running C++ protocol buffer compiler on ${fil}" VERBATIM )
endforeach()

官方文档中该命令的签名有两个形式,在开源的项目中经常看到的是下面这个形式:

add_custom_command(OUTPUT output1 [output2 ...]
                   COMMAND command1 [ARGS] [args1...]
                   [COMMAND command2 [ARGS] 
  • 2
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
### 回答1: `add_custom_command` 是 CMake 的一个命令,用于添加自定义命令。它可以用于在生成目标文件或其他输出文件之前或之后执行一些自定义命令,例如编译代码生成器、生成一些中间文件、拷贝文件等等。 `add_custom_command` 的语法如下: ```cmake add_custom_command(TARGET target POST_BUILD|PRE_BUILD|PRE_LINK COMMAND command1 [ARGS] [args1...] [COMMAND command2 [ARGS] [args2...] ...] [WORKING_DIRECTORY dir] [COMMENT comment] [VERBATIM]) ``` 其中,`TARGET` 参数指定了添加自定义命令的目标文件或输出文件。`POST_BUILD`、`PRE_BUILD` 和 `PRE_LINK` 参数用于指定命令在生成目标文件之前、之后或者在链接之前执行。`COMMAND` 参数指定了需要执行的命令,可以是任何可执行程序或脚本。`ARGS` 参数用于指定命令的参数,`WORKING_DIRECTORY` 参数用于指定执行命令时的工作目录,`COMMENT` 参数用于添加注释,`VERBATIM` 参数用于告诉 CMake 不要对命令进行任何转义或处理。 下面是一个示例,演示如何使用 `add_custom_command` 命令来编译 Protobuf 文件: ```cmake # 设置 Protobuf 文件的路径 set(PROTO_FILE ${CMAKE_CURRENT_SOURCE_DIR}/myproto.proto) # 生成对应的 .pb.cc 和 .pb.h 文件 add_custom_command( OUTPUT myproto.pb.cc myproto.pb.h COMMAND protoc --cpp_out=${CMAKE_CURRENT_BINARY_DIR} ${PROTO_FILE} DEPENDS ${PROTO_FILE} ) # 将生成的 .pb.cc 文件添加到可执行文件的源文件中 add_executable(myapp main.cpp myproto.pb.cc) ``` 在这个例子中,我们使用 `add_custom_command` 命令来生成 Protobuf 文件对应的 `.pb.cc` 和 `.pb.h` 文件。我们指定了需要执行的命令是 `protoc --cpp_out=${CMAKE_CURRENT_BINARY_DIR} ${PROTO_FILE}`,其中 `${CMAKE_CURRENT_BINARY_DIR}` 是 CMake 的一个变量,表示当前的二进制目录,`${PROTO_FILE}` 是我们在前面设置的 Protobuf 文件的路径。我们还指定了这个自定义命令的输出文件是 `myproto.pb.cc` 和 `myproto.pb.h`,并且这个自定义命令依赖于 `PROTO_FILE` 文件。最后,我们将生成的 `.pb.cc` 文件添加到可执行文件的源文件列表中。 ### 回答2: 在CMake中,add_custom_command函数用于向构建系统添加自定义命令。这允许我们在构建过程中执行一些自定义的操作。 add_custom_command函数的语法如下: add_custom_command(TARGET target POST_BUILD COMMAND command1 [ARGS] [args1...] [COMMAND command2 [ARGS] [args2...] ...] [WORKING_DIRECTORY dir] [COMMENT comment] [VERBATIM] [USES_TERMINAL]) 选项TARGET指定要应用自定义命令的目标。POST_BUILD表示将在构建目标之后执行自定义命令。 COMMAND用于指定要执行的命令,可以是一个可执行文件或脚本文件,还可以带有参数。 WORKING_DIRECTORY用于指定命令的工作目录。 COMMENT用于添加描述性的注释。 VERBATIM表示命令参数不会被分析或扩展,原样传递给命令。 USES_TERMINAL用于表示是否应将命令在终端中执行。 使用add_custom_command的一个典型示例是在构建目标之后复制生成的文件到指定目录。例如: add_custom_command(TARGET myTarget POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:myTarget> ${CMAKE_CURRENT_BINARY_DIR}/output/) 上述命令将在构建myTarget目标之后执行,它调用CMake命令行工具的-E选项来执行复制动作,将生成的myTarget目标文件复制到output目录。 在CMakeLists.txt文件中使用add_custom_command函数可以实现更复杂的自定义构建操作,例如生成文档、运行测试等。这使得CMake具有很大的灵活性,可以满足各种项目的构建需求。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值