FindPkgConfig

Модуль pkg-config для CMake.

Находит исполняемый файл pkg-config и добавляет команды pkg_get_variable(), pkg_check_modules() и pkg_search_module(). Также будут установлены следующие переменные:

PKG_CONFIG_FOUND

если исполняемый файл pkg-config найден

PKG_CONFIG_EXECUTABLE

путь к программе pkg-config

PKG_CONFIG_VERSION_STRING

версия pkg-config (с CMake 2.8.8)

pkg_check_modules

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

pkg_check_modules(<prefix>
                  [REQUIRED] [QUIET]
                  [NO_CMAKE_PATH]
                  [NO_CMAKE_ENVIRONMENT_PATH]
                  [IMPORTED_TARGET [GLOBAL]]
                  <moduleSpec> [<moduleSpec>...])

Если задан аргумент REQUIRED, команда завершится ошибкой, если модуль(и) не найдены.

Если задан аргумент QUIET, сообщения об успехе не будут выводиться.

Новая в версии 3.1: Переменные кэша и среды CMAKE_PREFIX_PATH, CMAKE_FRAMEWORK_PATH и CMAKE_APPBUNDLE_PATH будут добавлены в путь поиска pkg-config. Аргументы NO_CMAKE_PATH и NO_CMAKE_ENVIRONMENT_PATH отключат это поведение для переменных кэша и переменных среды соответственно. Переменная PKG_CONFIG_USE_CMAKE_PREFIX_PATH, установленная в значение FALSE, отключит это поведение глобально.

Новая в версии 3.6: Аргумент IMPORTED_TARGET создаст импортированный целевой объект с именем PkgConfig::<prefix>, который можно напрямую передать в качестве аргумента к команде target_link_libraries().

Новая в версии 3.13: Аргумент GLOBAL сделает импортированный целевой объект доступным в глобальной области видимости.

Новая в версии 3.15: Небиблиотечные параметры линковщика, сообщённые pkg-config, сохраняются в свойстве цели INTERFACE_LINK_OPTIONS.

Изменено в версии 3.18: Директории заголовков, указанные с помощью -isystem, хранятся в свойстве цели INTERFACE_INCLUDE_DIRECTORIES. Предыдущие версии CMake оставляли их в свойстве INTERFACE_COMPILE_OPTIONS.

Каждый <moduleSpec> может быть либо именем модуля, либо именем модуля с ограничением версии (поддерживаются операторы =, <, >, <= и >=). Ниже приведены примеры для модуля под названием foo с различными ограничениями:

• foo соответствует любой версии.
• foo<2 соответствует только версиям до 2.
• foo>=3.1 соответствует любой версии от 3.1 или позже.
• foo=1.2.3 требует, чтобы foo был ровно версии 1.2.3.

После возврата могут быть установлены следующие переменные. Существуют два набора значений: один для общего случая (<XXX> = <prefix>) и другой для информации, которую pkg-config предоставляет при вызове с опцией --static (<XXX> = <prefix>_STATIC).

<XXX>_FOUND

устанавливается в 1, если модуль(и) существуют

<XXX>_LIBRARIES

только библиотеки (без '-l')

<XXX>_LINK_LIBRARIES

библиотеки и их абсолютные пути

<XXX>_LIBRARY_DIRS

пути к библиотекам (без '-L')

<XXX>_LDFLAGS

все необходимые флаги линковщика

<XXX>_LDFLAGS_OTHER

все остальные флаги линковщика

<XXX>_INCLUDE_DIRS

флаги препроцессора '-I' (без '-I')

<XXX>_CFLAGS

все необходимые флаги компилятора

<XXX>_CFLAGS_OTHER

другие флаги компилятора

Все, кроме <XXX>_FOUND, могут быть списком, если связанная переменная, возвращаемая pkg-config, имеет несколько значений.

Изменено в версии 3.18: Директории заголовков, указанные с помощью -isystem, хранятся в переменной <XXX>_INCLUDE_DIRS. Предыдущие версии CMake оставляли их в переменной <XXX>_CFLAGS_OTHER.

Есть некоторые специальные переменные, префикс которых зависит от количества <moduleSpec> . Если задано только одно <moduleSpec>, <YYY> будет просто <prefix>, но если задано два или более <moduleSpec> , то <YYY> будет <prefix>_<moduleName>.

<YYY>_VERSION

версия модуля

<YYY>_PREFIX

директория префикса модуля

<YYY>_INCLUDEDIR

директория заголовков модуля

<YYY>_LIBDIR

директория lib модуля

Изменено в версии 3.8: Для любого данного <prefix>, pkg_check_modules() может быть вызван несколько раз с различными параметрами. В предыдущих версиях CMake кэшировалось и возвращалось первое успешное значение.

Изменено в версии 3.16: Если полный путь к найденной библиотеке определить нельзя, но она всё ещё видна для линковщика, передать её как -l<name>. Предыдущие версии CMake в этом случае завершались ошибкой.

Примеры:

pkg_check_modules (GLIB2 glib-2.0)

Ищет любую версию glib2. Если найдена, переменная результата GLIB2_VERSION будет содержать фактическую найденную версию.

pkg_check_modules (GLIB2 glib-2.0>=2.10)

Ищет версию glib2 не ниже 2.10. Если найдена, переменная результата GLIB2_VERSION будет содержать фактическую найденную версию.

pkg_check_modules (FOO glib-2.0>=2.10 gtk+-2.0)

Ищет glib2-2.0 (не ниже версии 2.10) и любую версию gtk2+-2.0. Только если оба найдены, будет считаться найденным FOO. Переменные FOO_glib-2.0_VERSION и FOO_gtk+-2.0_VERSION будут установлены на соответствующие версии найденных модулей.

pkg_check_modules (XRENDER REQUIRED xrender)

Требует любую версию xrender. Примеры переменных результата, установленных при успешном вызове:

XRENDER_LIBRARIES=Xrender;X11
XRENDER_STATIC_LIBRARIES=Xrender;X11;pthread;Xau;Xdmcp

pkg_search_module

Поведение этой команды аналогично команде pkg_check_modules(), за исключением того, что она ищет только первое успешно найденное совпадение, а не проверяет все указанные модули.

pkg_search_module(<prefix>
                  [REQUIRED] [QUIET]
                  [NO_CMAKE_PATH]
                  [NO_CMAKE_ENVIRONMENT_PATH]
                  [IMPORTED_TARGET [GLOBAL]]
                  <moduleSpec> [<moduleSpec>...])

Новая в версии 3.16: Если модуль найден, переменная <prefix>_MODULE_NAME будет содержать имя соответствующего модуля. Эта переменная может быть использована, если вам нужно вызвать команду pkg_get_variable().

Пример:

pkg_search_module (BAR libxml-2.0 libxml2 libxml>=2)

pkg_get_variable

Новая в версии 3.4.

Извлекает значение переменной pkg-config varName и сохраняет его в переменной результата resultVar в области вызова.

pkg_get_variable(<resultVar> <moduleName> <varName>)

Если pkg-config возвращает несколько значений для указанной переменной, то resultVar будет содержать ;-список.

Например:

pkg_get_variable(GI_GIRDIR gobject-introspection-1.0 girdir)

Переменные, влияющие на поведение

PKG_CONFIG_EXECUTABLE

Может быть установлена в путь к исполняемому файлу pkg-config. Если не указана, она будет установлена модулем в результате внутреннего вызова find_program().

Новая в версии 3.1: Переменная среды PKG_CONFIG может быть использована в качестве подсказки.

PKG_CONFIG_USE_CMAKE_PREFIX_PATH

Новое в версии 3.1.

Указывает, следует ли pkg_check_modules() и pkg_search_module() добавлять пути из кэша CMAKE_PREFIX_PATH, CMAKE_FRAMEWORK_PATH и CMAKE_APPBUNDLE_PATH и переменных среды в pkg-config путь поиска.

Если эта переменная не задана, это поведение включено по умолчанию, если CMAKE_MINIMUM_REQUIRED_VERSION 3.1 или выше, в противном случае — отключено.