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) для получения дополнительной информации о определении свойств системы сборки.

Указанные каталоги включаемых файлов могут быть абсолютными или относительными путями. Относительный путь будет интерпретирован как относительный к текущей директории исходных кодов (т. е. CMAKE_CURRENT_SOURCE_DIR) и преобразован в абсолютный путь перед сохранением в связанном свойстве целевого объекта. Если путь начинается с выражения генератора, он всегда будет считаться абсолютным путём (за исключением одного случая, описанного ниже) и будет использован без изменений.

Требования к использованию каталогов включаемых файлов обычно различаются между деревом сборки и деревом установки. Выражения генератора BUILD_INTERFACE и INSTALL_INTERFACE могут использоваться для описания отдельных требований к использованию в зависимости от места использования. Относительные пути разрешены в выражении INSTALL_INTERFACE и интерпретируются как относительные к префиксу установки. Относительные пути не должны использоваться в выражениях BUILD_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) для обсуждения дополнительных мер предосторожности, которые необходимо принять при указании требований к использованию при создании пакетов для перераспределения.

См. также

• include_directories()
• target_compile_definitions()
• target_compile_features()
• target_compile_options()
• target_link_libraries()
• target_link_directories()
• target_link_options()
• target_precompile_headers()
• target_sources()