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) для получения дополнительной информации о определении свойств системы сборки.

См. также HEADER_FILE_ONLY о том, что делать, если некоторые исходные файлы предварительно обработаны, и вы хотите иметь доступ к исходным файлам из среды IDE.

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

add_library(<name> <SHARED|STATIC|MODULE|OBJECT|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). <name> не может использоваться для изменения свойств <target>, то есть не может использоваться в качестве операнда set_property(), set_target_properties(), target_link_libraries() и т. д. Цель-псевдоним не может быть установлена или экспортирована.

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

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

Создаёт библиотеку интерфейса. Целевая библиотека интерфейса не создаёт напрямую выходные данные сборки, хотя на ней могут быть установлены свойства, и она может быть установлена, экспортирована и импортирована. Обычно свойства 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().