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