FindPkgConfig

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

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

PKG_CONFIG_FOUND: Истина, если был найден исполняемый файл pkg-config.
PKG_CONFIG_VERSION_STRING: Новая в версии 2.8.8.

Версия найденного pkg-config.
PKG_CONFIG_EXECUTABLE: Путь к программе pkg-config.
PKG_CONFIG_ARGN: Новая в версии 3.22.

Список аргументов для передачи в pkg-config.

Обе переменные PKG_CONFIG_EXECUTABLE и PKG_CONFIG_ARGN инициализируются модулем, но могут быть переопределены пользователем. См. Переменные, влияющие на поведение, чтобы узнать, как эти переменные инициализируются.

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_EXECUTABLE ещё не установлена.

Изменено в версии 3.22: Если переменная среды PKG_CONFIG установлена, при использовании её в качестве подсказки берётся только первый аргумент.

END_OF_DOCUMENT_MARKER ```

PKG_CONFIG_ARGN: Новое в версии 3.22.

Эта переменная кэша может быть установлена в список аргументов, которые дополнительно нужно передать в pkg-config при необходимости. Если она не задана, она будет инициализирована из переменной среды PKG_CONFIG, если она установлена. Первый аргумент в этой переменной среды предполагается программой pkg-config, а все последующие аргументы используются для инициализации PKG_CONFIG_ARGN. Если такая переменная среды не определена, PKG_CONFIG_ARGN инициализируется пустой строкой. Модуль не обновляет переменную после её установки в кэше.

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 или выше, в противном случае — выключено.

© 2000–2023 Kitware, Inc. and Contributors
Licensed under the BSD 3-clause License.
https://cmake.org/cmake/help/v3.26/module/FindPkgConfig.html