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