cmake include header into every source file

by

CMake doesn’t have a feature for this specific use case, but as you’ve hinted, compilers such as GCC have the -include flag which acts as if there was an #include "foo.h" in the source file, and since CMake can pass arguments to compilers, you can do it via add_definitions.

This answer covers what the flag is for GCC, Clang and MSVC which should cover a lot of bases. So in CMake, detect what the compiler is and pass the appropriate flag.

Here’s what the CMake code might look like:

if(MSVC)
    add_definitions(/FI"foo.h")
else()
    # GCC or Clang
    add_definitions(-include foo.h)
endif()

Comments

In general, doing this is a bad idea. Code inspection tools (like IDEs, or doxygen) will be confused by it, not to mention other humans looking at the code. If not all source files actually require the definition, adding extra #includes will slow down compile time. If you actually do need the same header (and it’s not a system header) in all your source files, it may be symptomatic of high coupling in your code. And for what benefit? Not having to add one line to your files?

However, it’s necessary to note that compilers support this for a reason; there are a few weird edge cases (example 1, example 2) where it’s a useful thing to do.

Just be aware that you’re doing this for the right reasons.

More Related Contents:

  1. How to properly add include directories with CMake
  2. CMake error at CMakeLists.txt:30 (project): No CMAKE_C_COMPILER could be found
  3. How to detect C++11 support of a compiler with CMake
  4. OS specific instructions in CMAKE: How to?
  5. How do I add a library path in cmake?
  6. How to create a shared library with cmake?
  7. Override compile flags for single files
  8. CMake output/build directory
  9. CMake unable to determine linker language with C++
  10. CMake: include library dependencies in a static library
  11. CMake linking against shared library on windows: error about not finding .lib file
  12. How do I use CMake?
  13. CMake does not find Visual C++ compiler
  14. CMake ExternalProject_Add() and FindPackage()
  15. In CMake, how can I test if the compiler is Clang?
  16. How to Use CCache with CMake?
  17. CMake – remove a compile flag for a single translation unit
  18. How to use c++20 modules with CMake?
  19. How to build cmake ExternalProject while configurating main one?
  20. cmake find_package specify path
  21. CMake Error: “add_subdirectory not given a binary directory”
  22. How do I iterate over all CMake targets programmatically?
  23. What is the difference between include_directories and target_include_directories in CMake?
  24. CMake: Project structure with unit tests
  25. rc.exe no longer found in VS 2015 Command Prompt
  26. CMake and MsVS-NuGet
  27. How to get CMake to recognize pthread on Ubuntu?
  28. Cmake link library target link error
  29. OpenCV GTK+2.x error – “Unspecified error (The function is not implemented…)”
  30. CMake imported library behaviour

Leave a Comment