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