Spec-Zone.ru › CMake 3.18

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, сообщения о статусе не будут выводиться.

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

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

Каждый <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, имеет несколько значений.

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

<YYY>_VERSION

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

<YYY>_PREFIX

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

<YYY>_INCLUDEDIR

директория заголовочных файлов модуля

<YYY>_LIBDIR

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

Примеры:

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

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

Пример:

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

Получает значение переменной 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() внутри. Переменная среды PKG_CONFIG может использоваться в качестве подсказки.

PKG_CONFIG_USE_CMAKE_PREFIX_PATH

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

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

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API