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