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) для получения дополнительной информации об определении свойств системы сборки.

Требования к использованию каталогов включения обычно различаются между деревом сборки и деревом установки. Генераторные выражения BUILD_INTERFACE и INSTALL_INTERFACE могут использоваться для описания отдельных требований к использованию, основанных на месте использования. Относительные пути разрешены в выражении INSTALL_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) для обсуждения дополнительной заботы, которую необходимо принять при указании требований к использованию при создании пакетов для распространения.