时间戳

首页 > 解决方案 > 使用 CMake 运行预构建步骤的最佳实践

c++ - 使用 CMake 运行预构建步骤的最佳实践

问题描述

假设您有一个存储库，其中包含一个文件夹（名为 dataset），其中包含多个 .csv 文件和一个 python 脚本（名为 csvcut.py），该脚本获取数据集中的所有 .csv 并生成相应的 .h 文件。

这些 .h 文件包含在一些 .cpp 文件中，以构建add_executable(testlib...用于测试的可执行文件 ( )。

假设您使用add_custom_target(test_pattern...创建一个运行 csvcut.py 的目标（名为 test_pattern），并add_dependencies(testlib test_pattern)在构建 testlib 之前运行该脚本。

这可行，但如果：

您对进行这些改进/优化有什么建议吗？

谢谢，阿尔贝托

标签： c++cmakeprebuild

解决方案

这需要多个步骤，但都可以使用标准 CMake 处理。首先，我们将用于add_custom_command实际生成文件。我还添加了一个自定义目标，但只是因为我无法弄清楚如何在INTERFACE没有它的情况下使库工作。

add_custom_command(
    OUTPUT
        "${CMAKE_CURRENT_BINARY_DIR}/include/foo.h"
    COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/gen.py"
    DEPENDS
        gen.py
        foo.h.in
    WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/include"
)
add_custom_target(gen_files
    DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/include/foo.h"
)

就我而言，gen.py只是吐出一个基本的头文件，但这无关紧要。列出你需要的任何文件作为输出，你的 csv 文件应该在下面DEPENDS（对我来说，foo.h.in尝试模拟这个）。

由于您只提到了生成头文件，因此我创建了一个INTERFACE依赖于gen_files目标的库。我还添加了适当的包含目录。

add_library(foo INTERFACE)
target_include_directories(foo
    INTERFACE "${CMAKE_CURRENT_BINARY_DIR}/include"
)
add_dependencies(foo
    gen_files
)

如果构建STATIC/SHARED库，我可以直接添加生成的文件作为源和依赖项，但INTERFACE库需要额外的目标（即使我尝试在 下列出文件add_dependencies）。由于您已经有一个自定义目标，我认为这不会是一个大问题。

最后，我有一个链接到foo.

add_executable(main
    main.c
)
target_link_libraries(main
    PRIVATE
        foo
)

演示：

$ make clean 
$ ls
CMakeCache.txt  CMakeFiles  cmake_install.cmake  include  Makefile
$ make
[ 33%] Generating include/foo.h
[ 33%] Built target gen_files
[ 66%] Building C object CMakeFiles/main.dir/main.c.o
[100%] Linking C executable main
[100%] Built target main
$ make clean
$ make main
[ 33%] Generating include/foo.h
[ 33%] Built target gen_files
[ 66%] Building C object CMakeFiles/main.dir/main.c.o
[100%] Linking C executable main
[100%] Built target main
$ make
[ 33%] Built target gen_files
[100%] Built target main
$ touch ../foo.h.in 
$ make
[ 33%] Generating include/foo.h
[ 33%] Built target gen_files
[100%] Built target main
$ touch ../gen.py 
$ make
[ 33%] Generating include/foo.h
[ 33%] Built target gen_files
[100%] Built target main
$ ls include/
foo.h

如果输入 ( foo.h.in) 或生成脚本 ( gen.py) 发生变化，则重新构建目标。

推荐阅读