add_library

• Библиотеки обычного типа
• Импортированные библиотеки
• Библиотеки объектов
• Псевдонимы библиотек
• Библиотеки интерфейсов

Добавляет библиотеку в проект, используя указанные исходные файлы.

Библиотеки обычного типа

add_library(<name> [STATIC | SHARED | MODULE]
            [EXCLUDE_FROM_ALL]
            source1 [source2 ...])

Добавляет целевой объект библиотеки, названный <name>, для построения из исходных файлов, перечисленных в вызове команды. <name> соответствует логическому имени целевого объекта и должно быть уникальным в рамках проекта. Фактическое имя создаваемой библиотеки формируется на основе соглашений целевой платформы (например, lib<name>.a или <name>.lib).

STATIC, SHARED, или MODULE могут быть указаны для определения типа создаваемой библиотеки. STATIC библиотеки — это архивы объектных файлов, используемые при линковке других целевых объектов. SHARED библиотеки подключаются динамически и загружаются во время выполнения. MODULE библиотеки — это плагины, которые не подключаются к другим целевым объектам, но могут загружаться динамически во время выполнения с помощью функций наподобие dlopen. Если тип не указан явно, тип определяется как STATIC или SHARED, в зависимости от значения переменной BUILD_SHARED_LIBS, равного ON. Для SHARED и MODULE библиотек свойство целевого объекта POSITION_INDEPENDENT_CODE устанавливается в значение ON автоматически. SHARED или STATIC библиотеки могут быть помечены свойством целевого объекта FRAMEWORK для создания фреймворка в OS X.

Если библиотека не экспортирует какие-либо символы, её не следует объявлять как SHARED библиотеку. Например, DLL ресурсов Windows или управляемая C++/CLI DLL, не экспортирующая неуправляемые символы, должна быть MODULE библиотекой. Это связано с тем, что CMake ожидает, что SHARED библиотека всегда будет иметь ассоциированную библиотеку импорта в Windows.

По умолчанию файл библиотеки будет создан в каталоге дерева сборки, соответствующем каталогу дерева исходников, в котором была вызвана команда. См. документацию свойств целевого объекта ARCHIVE_OUTPUT_DIRECTORY, LIBRARY_OUTPUT_DIRECTORY и RUNTIME_OUTPUT_DIRECTORY для изменения этого расположения. См. документацию свойства целевого объекта OUTPUT_NAME для изменения части имени конечного файла <name>.

Если EXCLUDE_FROM_ALL задано, соответствующее свойство будет установлено для созданного целевого объекта. См. документацию свойства целевого объекта EXCLUDE_FROM_ALL для получения подробной информации.

Аргументы исходных файлов для add_library могут использовать «генераторские выражения» со синтаксисом $<...>. См. руководство cmake-generator-expressions(7) для доступных выражений. См. руководство cmake-buildsystem(7) для получения дополнительной информации о определении свойств системы сборки.

Импортированные библиотеки

add_library(<name> <SHARED|STATIC|MODULE|UNKNOWN> IMPORTED
            [GLOBAL])

Целевой объект импортированной библиотеки ссылается на файл библиотеки, расположенный вне проекта. Для него не генерируются правила сборки, и свойство целевого объекта IMPORTED установлено в значение True. Имя целевого объекта имеет область действия в каталоге, в котором он создан, и ниже, но параметр GLOBAL расширяет видимость. К нему можно обратиться как к любому целевому объекту, созданному в рамках проекта. IMPORTED библиотеки полезны для удобной ссылки из команд, таких как target_link_libraries().

Подробности об импортированной библиотеке задаются свойств, имена которых начинаются с IMPORTED_ и INTERFACE_. Самое важное такое свойство — IMPORTED_LOCATION (и его конфигурационная версия IMPORTED_LOCATION_<CONFIG>), которое указывает местоположение основного файла библиотеки на диске. См. документацию свойств IMPORTED_* и INTERFACE_* для получения дополнительной информации.

Библиотеки объектов

add_library(<name> OBJECT <src>...)

Создаёт библиотеку объектов. Библиотека объектов компилирует исходные файлы, но не архивирует или лин кует их объектные файлы в библиотеку. Вместо этого другие целевые объекты, созданные командой add_library() или add_executable(), могут ссылаться на объекты, используя выражение вида $<TARGET_OBJECTS:objlib>, где objlib — имя библиотеки объектов. Например:

add_library(... $<TARGET_OBJECTS:objlib> ...)
add_executable(... $<TARGET_OBJECTS:objlib> ...)

включает объектные файлы objlib в библиотеку и исполняемый файл вместе с объектами, скомпилированными из собственных исходников. Библиотеки объектов могут содержать только исходные файлы, которые компилируются, заголовочные файлы и другие файлы, не влияющие на линковку обычной библиотеки (например, .txt). Они могут содержать пользовательские команды, генерирующие такие файлы, но не команды PRE_BUILD, PRE_LINK, или POST_BUILD. Библиотеки объектов нельзя импортировать, экспортировать, устанавливать или линковать. Некоторые системы сборки могут не поддерживать целевые объекты, содержащие только объектные файлы, поэтому добавьте, по крайней мере, один реальный исходный файл в любой целевой объект, ссылающийся на $<TARGET_OBJECTS:objlib>.

Псевдонимы библиотек

add_library(<name> ALIAS <target>)

Создаёт Псевдоним целевого объекта, так что <name> может использоваться для ссылки на <target> в последующих командах. <name> не появляется в генерируемой системе сборки как целевой объект make. <target> не может быть импортированным целевым объектом или ALIAS. Целевые объекты-псевдонимы могут использоваться как линковимые целевые объекты и как объекты для считывания свойств. Они также могут проверяться на существование с помощью обычной команды if(TARGET). Псевдоним не может использоваться для изменения свойств <target>, т. е. он не может использоваться в качестве операнда команд set_property(), set_target_properties(), target_link_libraries() и т. д. Целевой объект-псевдоним не может быть установлен или экспортирован.

Библиотеки интерфейсов

add_library(<name> INTERFACE [IMPORTED [GLOBAL]])

Создаёт библиотеку интерфейса. Целевой объект INTERFACE библиотеки непосредственно не создаёт выходные данные сборки, хотя на нём могут быть установлены свойства, и он может быть установлен, экспортирован и импортирован. Обычно свойства INTERFACE_* заполняются для целевого объекта интерфейса с помощью команд:

• set_property(),
• target_link_libraries(INTERFACE),
• target_include_directories(INTERFACE),
• target_compile_options(INTERFACE),
• target_compile_definitions(INTERFACE), и
• target_sources(INTERFACE),

а затем используется в качестве аргумента для target_link_libraries(), как и любой другой целевой объект.

Также может быть создан INTERFACE Импортированный целевой объект с этой сигнатурой. IMPORTED Целевой объект библиотеки ссылается на библиотеку, определенную за пределами проекта. Название целевого объекта имеет область действия в каталоге, в котором он создается, и ниже, но опция GLOBAL расширяет видимость. К нему можно обратиться как к любому целевому объекту, созданному внутри проекта. IMPORTED Библиотеки полезны для удобной ссылки из команд, таких как target_link_libraries().