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()