target_include_directories

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

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

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

Если BEFORE указано, содержимое будет добавлено в начало свойства, а не в конец.

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

Указанные директории заголовков могут быть абсолютными или относительными путями. Повторные вызовы для одного и того же <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) для обсуждения дополнительных мер предосторожности, которые необходимо принять при создании пакетов для распространения.