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 элементы.) Следующие аргументы задают каталоги включения.

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