add_library

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

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

Библиотеки по умолчанию

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

Добавляет целевую библиотеку, называемую <name>, которая будет построена из исходных файлов, перечисленных в вызове команды. (Исходные файлы можно опустить, если они будут добавлены позже с помощью target_sources().) <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 или DLL управляемого C++/CLI, не экспортирующая неуправляемые символы, должна быть библиотекой 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_OBJECTS (и IMPORTED_OBJECTS_<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. Некоторые системы native сборки (например, Xcode) могут не поддерживать цели, содержащие только объектные файлы, поэтому добавьте хотя бы один реальный исходный файл в любую цель, которая ссылается на $<TARGET_OBJECTS:objlib>.

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

add_library(<name> ALIAS <target>)

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

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

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().