target_include_directories

Добавить каталоги заголовков в целевой объект.

target_include_directories(<target> [SYSTEM] [AFTER|BEFORE]
  <INTERFACE|PUBLIC|PRIVATE> [items1...]
  [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])

Указывает каталоги заголовков, которые следует использовать при компиляции данного целевого объекта. Указанный <target> должен быть создан командой, такой как add_executable() или add_library(), и не должен быть целевым объектом-псевдонимом.

Используя AFTER или BEFORE явно, вы можете выбрать добавление или вставку каталогов, независимо от значения по умолчанию.

Ключевые слова INTERFACE, PUBLIC и PRIVATE необходимы для указания области действия следующих аргументов. PRIVATE и PUBLIC элементы будут заполнять свойство INCLUDE_DIRECTORIES объекта <target>. PUBLIC и INTERFACE элементы будут заполнять свойство INTERFACE_INCLUDE_DIRECTORIES объекта <target>. Следующие аргументы указывают каталоги заголовков.

Повторные вызовы для одного и того же <target> добавляют элементы в вызываемом порядке.

Если указан SYSTEM, компилятор получит указание считать каталоги системными каталогами заголовков на некоторых платформах. Это может привести к подавлению предупреждений или пропуску содержащихся в них заголовков при расчете зависимостей (см. документацию компилятора). Кроме того, каталоги системных заголовков просматриваются после обычных каталогов заголовков независимо от указанного порядка.

Если SYSTEM используется вместе с PUBLIC или INTERFACE, свойство целевого объекта INTERFACE_SYSTEM_INCLUDE_DIRECTORIES будет заполнено указанными каталогами.

Аргументы к target_include_directories могут использовать выражения генератора с синтаксисом $<...>. См. руководство cmake-generator-expressions(7) для доступных выражений. См. руководство cmake-buildsystem(7) для получения дополнительной информации о определении свойств системы построения.

Указанные каталоги заголовков могут быть абсолютными или относительными путями. Относительный путь будет интерпретирован как относительный к текущей директории исходного кода (т.е. CMAKE_CURRENT_SOURCE_DIR) и преобразован в абсолютный путь перед сохранением его в соответствующем свойстве целевого объекта. Если путь начинается с выражения генератора, он всегда будет предполагаться абсолютным путём (за исключением одного случая, указанного ниже) и будет использоваться без изменений.

Требования к использованию каталогов заголовков обычно различаются между деревом построения и деревом установки. Выражения генератора BUILD_INTERFACE и INSTALL_INTERFACE могут использоваться для описания отдельных требований к использованию, основанных на месте использования. Относительные пути разрешены в выражении INSTALL_INTERFACE и интерпретируются как относительные к префиксу установки. Относительные пути не должны использоваться в выражениях BUILD_INTERFACE, поскольку они не будут преобразованы в абсолютные. Например:

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

Создание переносимых пакетов

Обратите внимание, что не рекомендуется заполнять INSTALL_INTERFACE свойств INTERFACE_INCLUDE_DIRECTORIES целевого объекта абсолютными путями к каталогам заголовков зависимостей. Это жёстко закодирует в установленных пакетах пути к каталогам заголовков зависимостей так, как они найдены на машине, на которой был создан пакет.

Свойство INSTALL_INTERFACE свойств INTERFACE_INCLUDE_DIRECTORIES подходит только для указания необходимых каталогов заголовков для заголовков, предоставляемых самим целевым объектом, а не для тех, которые предоставляются транзитивными зависимостями, перечисленными в его свойстве целевого объекта INTERFACE_LINK_LIBRARIES. Эти зависимости должны сами быть целевыми объектами, которые указывают свои собственные расположения заголовков в INTERFACE_INCLUDE_DIRECTORIES.

См. раздел «Создание переносимых пакетов» руководства cmake-packages(7) для обсуждения дополнительной осторожности, которую необходимо соблюдать при указании требований к использованию при создании пакетов для перераспределения.

См. также

• include_directories()
• target_compile_definitions()
• target_compile_features()
• target_compile_options()
• target_link_libraries()
• target_link_directories()
• target_link_options()
• target_precompile_headers()
• target_sources()