target_link_libraries

• Обзор
• Библиотеки для целевого объекта и/или его зависимостей
• Библиотеки для целевого объекта и его зависимостей
• Библиотеки для целевого объекта и/или его зависимостей (устаревшее)
• Библиотеки только для зависимостей (устаревшее)
• Связывание библиотек объектов
• Циклические зависимости статических библиотек
• Создание переносимых пакетов

Укажите библиотеки или флаги, используемые при связывании данного целевого объекта и/или его зависимостей. Требования к использованию от связанных целевых библиотек будут переданы. Требования к использованию зависимостей целевого объекта влияют на компиляцию его собственных исходных кодов.

Обзор

Эта команда имеет несколько синтаксисов, как подробно описано в подразделах ниже. Все они имеют общий вид

target_link_libraries(<target> ... <item>... ...)

Именованный <target> должен быть создан командой, такой как add_executable() или add_library() и не должен быть целевым объектом-псевдонимом. Если политика CMP0079 не установлена в NEW, то целевой объект должен быть создан в текущем каталоге. Повторные вызовы для одного и того же <target> добавляют элементы в порядке вызова.

Каждый <item> может быть:

• Имя целевого объекта библиотеки: Сгенерированная строка для связывания будет содержать полный путь к файлу связуемой библиотеки, связанной с целевым объектом. Система сборки будет иметь зависимость от пересвязывания <target> в случае изменения файла библиотеки.

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

  Если у импортированной библиотеки установлено свойство целевого объекта IMPORTED_NO_SONAME, CMake может попросить компоновщик найти библиотеку вместо использования полного пути (например, /usr/lib/libfoo.so становится -lfoo).

  Полный путь к артефакту целевого объекта будет автоматически заключён в кавычки/экранирован для оболочки.

• Полный путь к файлу библиотеки: Сгенерированная строка для связывания обычно сохраняет полный путь к файлу. Система сборки будет иметь зависимость от пересвязывания <target> в случае изменения файла библиотеки.

  Существуют случаи, когда CMake может попросить компоновщик найти библиотеку (например, /usr/lib/libfoo.so становится -lfoo), например, когда обнаружено, что у разделяемой библиотеки нет поля SONAME. См. политику CMP0060 для обсуждения другого случая.

  Если файл библиотеки находится в macOS-фреймворке, каталог Headers фреймворка также будет обработан как требование к использованию. Это имеет тот же эффект, что и передача каталога фреймворка в качестве каталога включения.

  В генераторах Visual Studio для VS 2010 и выше файлы библиотек, заканчивающиеся на .targets, будут обрабатываться как файлы целевых объектов MSBuild и импортироваться в сгенерированные файлы проекта. Это не поддерживается другими генераторами.

  Полный путь к файлу библиотеки будет автоматически заключён в кавычки/экранирован для оболочки.

• Простое имя библиотеки: Сгенерированная строка для связывания попросит компоновщик найти библиотеку (например, foo становится -lfoo или foo.lib).

  Имя/флаг библиотеки обрабатывается как фрагмент строки командной строки и будет использоваться без дополнительных кавычек или экранирования.

• Флаг связывания: Имена элементов, начинающиеся с -, но не с -l или -framework, обрабатываются как флаги компоновщика. Обратите внимание, что такие флаги будут обрабатываться как любой другой элемент связывания библиотек для целей транзитивных зависимостей, поэтому их в общих случаях безопасно указывать только как частные элементы связывания, которые не будут передаваться зависимостям.

  Флаги связывания, указанные здесь, вставляются в команду связывания в том же месте, что и библиотеки. Это может быть неверно в зависимости от компоновщика. Используйте свойство целевого объекта LINK_OPTIONS или команду target_link_options(), чтобы добавить флаги связывания явно. Затем флаги будут размещены в определённой инструментом цепочки инструментов позиции в команде связывания.

  Флаг связывания обрабатывается как фрагмент строки командной строки и будет использоваться без дополнительных кавычек или экранирования.

• Выражение генератора: $<...> generator expression может привести к любому из вышеперечисленных элементов или к списку, разделённому точкой с запятой таких элементов. Если ... содержит символы ;, например, после вычисления переменной ${list}, обязательно используйте явно указанный аргумент "$<...>", чтобы эта команда получила его как один <item>.

  Кроме того, выражение генератора может использоваться как фрагмент любого из вышеперечисленных элементов, например foo$<1:_d>.

  Обратите внимание, что выражения генератора не будут использоваться в старом способе обработки политики CMP0003 или политики CMP0004.

• Ключевое слово debug, optimized, или general, непосредственно за которым следует другой <item>. Элемент, следующий за таким ключевым словом, будет использоваться только для соответствующей конфигурации сборки. Ключевое слово debug соответствует конфигурации Debug (или конфигурациям, именованным в свойстве глобальной переменной DEBUG_CONFIGURATIONS, если оно установлено). Ключевое слово optimized соответствует всем другим конфигурациям. Ключевое слово general соответствует всем конфигурациям и чисто необязательно. Более тонкая настройка для правил по конфигурациям может быть достигнута путём создания и связывания с импортированными целевыми объектами библиотек.

Элементы, содержащие ::, такие как Foo::Bar, предполагаются именами импортированных или псевдонимных целевых объектов библиотек и приведут к ошибке, если такой целевой объект не существует. См. политику CMP0028.

См. руководство cmake-buildsystem(7) для получения более подробной информации об определении свойств системы сборки.

Библиотеки для целевого объекта и/или его зависимостей

target_link_libraries(<target>
                      <PRIVATE|PUBLIC|INTERFACE> <item>...
                     [<PRIVATE|PUBLIC|INTERFACE> <item>...]...)

Ключевые слова PUBLIC, PRIVATE и INTERFACE могут использоваться для указания как зависимостей связывания, так и интерфейса связывания в одной команде. Библиотеки и целевые объекты, следующие за PUBLIC, связываются и включаются в интерфейс связывания. Библиотеки и целевые объекты, следующие за PRIVATE, связываются, но не включаются в интерфейс связывания. Библиотеки, следующие за INTERFACE, добавляются в интерфейс связывания и не используются для связывания <target>.

Библиотеки для целевого объекта и его зависимостей

target_link_libraries(<target> <item>...)

Зависимости библиотек по умолчанию транзитивны с этим синтаксисом. Когда этот целевой объект связывается с другим целевым объектом, библиотеки, связанные с этим целевым объектом, также появятся в строке связывания для другого целевого объекта. Этот транзитивный «интерфейс связывания» хранится в свойстве целевого объекта INTERFACE_LINK_LIBRARIES и может быть переопределен прямым указанием свойства. Когда CMP0022 не установлено в NEW, транзитивное связывание встроенное, но может быть переопределено свойством LINK_INTERFACE_LIBRARIES. Вызовы других синтаксисов этой команды могут установить свойство, делая любые библиотеки, связанные исключительно этим синтаксисом, частными.

Библиотеки для целевого объекта и/или его зависимых (Legacy)

target_link_libraries(<target>
                      <LINK_PRIVATE|LINK_PUBLIC> <lib>...
                     [<LINK_PRIVATE|LINK_PUBLIC> <lib>...]...)

Режимы LINK_PUBLIC и LINK_PRIVATE могут использоваться для указания как зависимостей ссылок, так и интерфейса ссылок в одной команде.

Эта сигнатура предназначена только для совместимости. Предпочтите использование ключевых слов PUBLIC или PRIVATE.

Библиотеки и целевые объекты, следующие за LINK_PUBLIC, связаны с INTERFACE_LINK_LIBRARIES и включены в него. Если политика CMP0022 не NEW, они также включены в LINK_INTERFACE_LIBRARIES. Библиотеки и целевые объекты, следующие за LINK_PRIVATE, связаны, но не включены в INTERFACE_LINK_LIBRARIES (или LINK_INTERFACE_LIBRARIES).

Библиотеки только для зависимых (Legacy)

target_link_libraries(<target> LINK_INTERFACE_LIBRARIES <item>...)

Режим LINK_INTERFACE_LIBRARIES добавляет библиотеки в свойство целевого объекта INTERFACE_LINK_LIBRARIES, а не использует их для связывания. Если политика CMP0022 не NEW, этот режим также добавляет библиотеки в LINK_INTERFACE_LIBRARIES и его эквивалент для каждой конфигурации.

Эта сигнатура предназначена только для совместимости. Предпочтите режим INTERFACE.

Библиотеки, указанные как debug, заключены в выражение генератора, соответствующее сборкам отладки. Если политика CMP0022 не NEW, библиотеки также добавляются к свойству LINK_INTERFACE_LIBRARIES_DEBUG (или к свойствам, соответствующим конфигурациям, перечисленным в глобальном свойстве DEBUG_CONFIGURATIONS, если оно задано). Библиотеки, указанные как optimized, добавляются к свойству INTERFACE_LINK_LIBRARIES. Если политика CMP0022 не NEW, они также добавляются к свойству LINK_INTERFACE_LIBRARIES. Библиотеки, указанные как general (или без какого-либо ключевого слова), обрабатываются так, как если бы они были указаны как для debug, так и для optimized.

Связывание библиотек объектов

Библиотеки объектов могут быть использованы в качестве первого аргумента <target> из target_link_libraries для указания зависимостей их исходных кодов от других библиотек. Например, код

add_library(A SHARED a.c)
target_compile_definitions(A PUBLIC A)

add_library(obj OBJECT obj.c)
target_compile_definitions(obj PUBLIC OBJ)
target_link_libraries(obj PUBLIC A)

компилирует obj.c с -DA -DOBJ и устанавливает требования к использованию для obj, которые распространяются на его зависимые объекты.

Обычные библиотеки и исполняемые файлы могут связываться с библиотеками объектов для получения их объектов и требований к использованию. Продолжая пример выше, код

add_library(B SHARED b.c)
target_link_libraries(B PUBLIC obj)

компилирует b.c с -DA -DOBJ, создаёт разделяемую библиотеку B с объектами из b.c и obj.c и связывает B с A. Кроме того, код

add_executable(main main.c)
target_link_libraries(main B)

компилирует main.c с -DA -DOBJ и связывает исполняемый файл main с B и A. Требования к использованию библиотеки объектов распространяются транзитивно через B, но её объектные файлы не включаются.

Библиотеки объектов могут «связываться» с другими библиотеками объектов для получения требований к использованию, но поскольку у них нет шага связывания, их объектные файлы не используются. Продолжая пример выше, код:

add_library(obj2 OBJECT obj2.c)
target_link_libraries(obj2 PUBLIC obj)

add_executable(main2 main2.c)
target_link_libraries(main2 obj2)

компилирует obj2.c с -DA -DOBJ, создаёт исполняемый файл main2 с объектами из main2.c и obj2.c и связывает main2 с A.

Другими словами, когда Библиотеки объектов появляются в свойстве INTERFACE_LINK_LIBRARIES целевого объекта, они будут обрабатываться как Библиотеки интерфейса, но когда они появляются в свойстве LINK_LIBRARIES целевого объекта, их объектные файлы также будут включены в процесс связывания.

Циклические зависимости статических библиотек

Граф зависимостей библиотек обычно является ациклическим (DAG), но в случае взаимно-зависимых STATIC библиотек CMake разрешает наличие циклов (сильно связных компонент). Когда другой целевой объект связывается с одной из библиотек, CMake повторяет всю связную компоненту. Например, код

add_library(A STATIC a.c)
add_library(B STATIC b.c)
target_link_libraries(A B)
target_link_libraries(B A)
add_executable(main main.c)
target_link_libraries(main A)

связывает main с A B A B. Хотя одного повторения обычно достаточно, патологические расположения объектных файлов и символов могут потребовать большего. Такие случаи можно обработать, используя свойство целевого объекта LINK_INTERFACE_MULTIPLICITY, или вручную повторив компонент в последнем вызове target_link_libraries. Однако, если две библиотеки настолько взаимозависимы, их, вероятно, следует объединить в одну, возможно, используя Библиотеки объектов.

Создание переносимых пакетов

Не рекомендуется заполнять INTERFACE_LINK_LIBRARIES целевого объекта абсолютными путями к зависимостям. Это жёстко закодирует в установленных пакетах пути к файлам библиотек зависимостей так, как они были найдены на машине, на которой был создан пакет.

См. раздел Создание переносимых пакетов в руководстве cmake-packages(7) для обсуждения дополнительных мер предосторожности, которые необходимо принять при указании требований к использованию при создании пакетов для перераспределения.