CMake: target_include_directories() prints an error when I try to add the source directory itself, or one of its subdirectories

by

The origin of the problem is not the target_include_directories command itself, but the attempt to install a target that has a public or interface include directory prefixed in the source path (i.e. the include directory is a subdirectory of your ${PROJECT_SOURCE_DIR}.)

While it is perfectly fine and desirable to use absolute paths when building the library from scratch, a third party library that pulls in a prebuilt version of that library will probably want to use a different include path. After all, you do not want all of your users to mirror the directory structure of your build machine, just to end up in the right include path.

CMake’s packaging mechanism provides support for both of these use cases: You may pull in a library directly from the build tree (that is, check out the source, build it, and point find_package() to the directory), or from an install directory (run make INSTALL to copy built stuff to the install directory and point find_package() to that directory). The latter approach needs to be relocatable (that is, I build and install on my machine, send you the resulting directory and you will be able to use it on your machine from a different directory structure), while the former is not.

This is a very neat feature, but you have to account for it when setting up the include directories. Quoting the manual for target_include_directories:

Include directories usage requirements commonly differ between the
build-tree and the install-tree. The BUILD_INTERFACE and
INSTALL_INTERFACE generator expressions can be used to describe
separate usage requirements based on the usage location. Relative
paths are allowed within the INSTALL_INTERFACE expression and are
interpreted relative to the installation prefix. For example:

target_include_directories(mylib PUBLIC  
    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include/mylib>  
    $<INSTALL_INTERFACE:include/mylib>  # <prefix>/include/mylib
)

The BUILD_INTERFACE and INSTALL_INTERFACE generator expressions do all the magic:

$<INSTALL_INTERFACE:...>

Content of ... when the property is exported using install(EXPORT), and empty otherwise.

$<BUILD_INTERFACE:...>

Content of ... when the property is exported using export(), or when the target is used by another target in the same buildsystem.
Expands to the empty string otherwise.

More Related Contents:

  1. How to properly add include directories with CMake
  2. How to link C++ program with Boost using CMake
  3. Debug vs Release in CMake
  4. How to detect C++11 support of a compiler with CMake
  5. Combining several static libraries into one using CMake
  6. How to properly link libraries with cmake?
  7. Using CMake with multiple compilers for the same language
  8. Error LNK1104: cannot open file ‘Debug\MyProjectLib.lib’
  9. Override compile flags for single files
  10. CMake unable to determine linker language with C++
  11. Benefits of header-only libraries
  12. CMake is not finding Boost
  13. How do I tell CMake to use Clang on Windows?
  14. cmake include header into every source file
  15. Handling header files dependencies with cmake
  16. How to handle a transitive dependency conflict using Git submodules and CMake?
  17. CMake cannot determine linker language for target
  18. Possible causes for Boost not being found by CMake in certain situations?
  19. Add external libraries to CMakeList.txt c++
  20. How do I iterate over all CMake targets programmatically?
  21. cmake – Global linker flag setting (for all targets in directory)
  22. preferred cmake project structure
  23. What is the difference between include_directories and target_include_directories in CMake?
  24. Using pre-compiled headers with CMake
  25. How to use CMAKE_EXPORT_COMPILE_COMMANDS?
  26. The proper way of forcing a 32-bit compile using CMake
  27. How to enable /std:c++17 in VS2017 with CMake
  28. Passing reference to STL vector over dll boundary
  29. Unable to find Eigen3 with CMake
  30. Adding multiple executables in CMake

Leave a Comment