target_include_directories

Добавление каталогов включения к целевому объекту.

target_include_directories(<target> [SYSTEM] [BEFORE]
  <INTERFACE|PUBLIC|PRIVATE> [items1...]
  [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])

Укажите каталоги включения, которые нужно использовать при компиляции данного целевого объекта. Названный <target> должен быть создан командой, такой как add_executable() или add_library(), и не должен быть целевым объектом типа IMPORTED.

Если BEFORE указан, содержимое будет добавлено в начало свойства вместо его окончания.

Ключевые слова INTERFACE, PUBLIC и PRIVATE необходимы для указания области действия следующих аргументов. PRIVATE и PUBLIC элементы заполнят свойство INCLUDE_DIRECTORIES целевого объекта <target>. PUBLIC и INTERFACE элементы заполнят свойство INTERFACE_INCLUDE_DIRECTORIES целевого объекта <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).