CMake add_custom_command not being run

by

The add_custom_target(run ALL ... solution will work for simple cases when you only have one target you’re building, but breaks down when you have multiple top level targets, e.g. app and tests.

I ran into this same problem when I was trying to package up some test data files into an object file so my unit tests wouldn’t depend on anything external. I solved it using add_custom_command and some additional dependency magic with set_property.

add_custom_command(
  OUTPUT testData.cpp
  COMMAND reswrap 
  ARGS    testData.src > testData.cpp
  DEPENDS testData.src 
)
set_property(SOURCE unit-tests.cpp APPEND PROPERTY OBJECT_DEPENDS testData.cpp)

add_executable(app main.cpp)
add_executable(tests unit-tests.cpp)

So now testData.cpp will generated before unit-tests.cpp is compiled, and any time testData.src changes. If the command you’re calling is really slow you get the added bonus that when you build just the app target you won’t have to wait around for that command (which only the tests executable needs) to finish.

It’s not shown above, but careful application of ${PROJECT_BINARY_DIR}, ${PROJECT_SOURCE_DIR} and include_directories() will keep your source tree clean of generated files.

More Related Contents:

  1. cmake add_custom_command
  2. Hinting Find.cmake Files with a custom directory
  3. Is it better to specify source files with GLOB or each file individually in CMake?
  4. CMake + GoogleTest
  5. CMake: use a custom linker
  6. Passing compiler options cmake
  7. What is the modern method for setting general compile flags in CMake?
  8. Getting a CMake Error: Cannot specify link libraries for target which is not built by the project
  9. Switching between GCC and Clang/LLVM using CMake
  10. How do I tell CMake to link in a static library in the source directory?
  11. CMake: Print out all accessible variables in a script
  12. How to set linker flags for OpenMP in CMake’s try_compile function
  13. Environment variable used by CMake to detect Visual C++ compiler tools for Ninja
  14. CMake: how create a single shared library from all static libraries of subprojects?
  15. Why add header files into ADD_LIBRARY/ADD_EXECUTABLE command in CMake
  16. Does CMake offer a method to set the working directory for a given build system to use when running/debugging the project?
  17. CMake: How to add dependency on linker script for executable
  18. Tell CMake to use C++ compiler for C files coming from CMake?
  19. How do I debug CMakeLists.txt files?
  20. CMake target_link_libraries Interface Dependencies
  21. What is common way to split string into list with CMAKE?
  22. How to Trace CMakeLists.txt [duplicate]
  23. Add all files under a folder to a CMake glob?
  24. How do I include a literal double quote in a custom CMake command?
  25. Check CMake Cache Variable in Toolchain File
  26. How to tell CMake to use relative paths
  27. Postpone making custom target until install
  28. How to list all CMake build options and their default values?
  29. Passing an argument to CMAKE via command prompt
  30. CMake: how to change compiler for individual target

Leave a Comment