target_include_directories

Добавление каталогов включаемых файлов в целевой объект.

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

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

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

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