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()