Spec-Zone.ru › CMake 3.22

find_package

  • Режимы поиска
  • Основной синтаксис
  • Полный синтаксис
  • Процедура поиска в режиме конфигурации
  • Выбор версии в режиме конфигурации
  • Переменные интерфейса файла пакета

Найти пакет (обычно предоставляемый чем-то внешним по отношению к проекту) и загрузить его пакетные детали.

Режимы поиска

У команды есть два очень разных способа проведения поиска:

Режим модуля

В этом режиме CMake ищет файл Find<PackageName>.cmake, сначала в расположениях, перечисленных в CMAKE_MODULE_PATH, а затем среди Модулей поиска, предоставляемых установкой CMake. Если файл найден, он читается и обрабатывается CMake. Он отвечает за поиск пакета, проверку версии и вывод необходимых сообщений. Некоторые модули поиска предоставляют ограниченную или никакую поддержку версионирования; обратитесь к документации модуля поиска.

Файл Find<PackageName>.cmake обычно не предоставляется самим пакетом. Вместо этого он обычно предоставляется чем-то внешним по отношению к пакету, таким как операционная система, сам CMake или даже проект, из которого был вызван команда find_package(). Будучи предоставленным внешне, Модули поиска имеют тенденцию быть эвристическими по своей природе и подвержены устареванию. Они обычно ищут определённые библиотеки, файлы и другие артефакты пакета.

Режим модуля поддерживается только основным синтаксисом команды.

Режим конфигурации

В этом режиме CMake ищет файл <lowercasePackageName>-config.cmake или <PackageName>Config.cmake. Он также будет искать <lowercasePackageName>-config-version.cmake или <PackageName>ConfigVersion.cmake, если были указаны детали версии (см. Выбор версии в режиме конфигурации для объяснения того, как используются эти отдельные файлы версии).

В режиме конфигурации команде можно передать список имён для поиска в качестве имён пакетов. Расположения, где CMake ищет файлы конфигурации и версии, значительно сложнее, чем в режиме модуля (см. Процедура поиска в режиме конфигурации).

Файлы конфигурации и версии обычно устанавливаются в составе пакета, поэтому они, как правило, более надёжны, чем модули поиска. Они обычно содержат прямые сведения о содержимом пакета, поэтому внутри самих файлов конфигурации или файлов версии не требуется поиск или эвристика.

Режим конфигурации поддерживается как основным основным, так и полным синтаксисом команды.

Аргументы команды определяют, какой из указанных выше режимов используется. При использовании основного синтаксиса команда сначала выполняет поиск в режиме модуля. Если пакет не найден, поиск переходит в режим конфигурации. Пользователь может установить переменную CMAKE_FIND_PACKAGE_PREFER_CONFIG в значение true, чтобы изменить приоритет и направить CMake на поиск в режиме конфигурации, прежде чем перейти к режиму модуля. Основной синтаксис также может быть принудительно задействован только в режиме модуля с ключевым словом MODULE. Если используется полный синтаксис, команда ищет только в режиме конфигурации.

По возможности пользовательский код обычно должен искать пакеты, используя основной синтаксис, так как это позволяет найти пакет в любом режиме. Авторы проектов, желающие предоставить пакет конфигурации, должны понимать общую картину, как описано в Полном синтаксисе и последующих разделах этой страницы.

Основной синтаксис

find_package(<PackageName> [version] [EXACT] [QUIET] [MODULE]
             [REQUIRED] [[COMPONENTS] [components...]]
             [OPTIONAL_COMPONENTS components...]
             [NO_POLICY_SCOPE])

Основной синтаксис поддерживается как в режиме модуля, так и в режиме конфигурации. Ключевое слово MODULE подразумевает, что для поиска пакета может использоваться только режим модуля без перехода в режим конфигурации.

Независимо от используемого режима, переменная <PackageName>_FOUND будет установлена, чтобы указать, был ли пакет найден. Когда пакет найден, пакетная информация может быть предоставлена через другие переменные и импортированные цели, задокументированные самим пакетом. Опция QUIET отключает информационные сообщения, включая те, которые указывают на то, что пакет не может быть найден, если он не REQUIRED. Опция REQUIRED останавливает обработку с сообщением об ошибке, если пакет не найден.

Список необходимых компонентов, специфичный для пакета, может быть перечислен после ключевого слова COMPONENTS. Если любой из этих компонентов не может быть удовлетворён, пакет в целом считается не найденным. Если также присутствует опция REQUIRED, это рассматривается как ошибка, в противном случае выполнение продолжается. В качестве сокращения, если присутствует опция REQUIRED, ключевое слово COMPONENTS можно опустить, и необходимые компоненты можно перечислить непосредственно после REQUIRED.

Дополнительные необязательные компоненты могут быть перечислены после OPTIONAL_COMPONENTS. Если их нельзя удовлетворить, пакет в целом может считаться найденным, если все необходимые компоненты удовлетворены.

Набор доступных компонентов и их значение определяются целевым пакетом. Формально, целевой пакет определяет, как интерпретировать информацию о компонентах, предоставленную ему, но он должен соответствовать ожидаемому поведению, указанному выше. Для вызовов, где не указаны компоненты, нет единого ожидаемого поведения, и целевые пакеты должны чётко определить, что происходит в таких случаях. Общие варианты включают предположение, что он должен найти все компоненты, не использовать компоненты или некоторое хорошо определённое подмножество доступных компонентов.

Аргумент [version] запрашивает версию, с которой должен быть совместим найденный пакет. Есть два возможных формата, в которых он может быть указан:

  • Единая версия в формате major[.minor[.patch[.tweak]]], где каждый компонент является числовым значением.
  • Диапазон версий в формате versionMin...[<]versionMax, где versionMin и versionMax имеют тот же формат и ограничения на компоненты, что и одиночная версия, являющиеся целыми числами. По умолчанию оба конечных значения включены. Указав <, верхнее конечное значение будет исключено. Диапазоны версий поддерживаются только с CMake 3.19 и более поздними версиями.

Опция EXACT запрашивает точное совпадение версии. Эта опция несовместима с указанием диапазона версий.

Если для рекурсивного вызова внутри модуля поиска не указаны [version] и/или список компонентов, соответствующие аргументы автоматически передаются из внешнего вызова (включая флаг EXACT для [version]). Поддержка версий в настоящее время предоставляется только на основе пакета (см. раздел «Выбор версии» ниже). Когда указан диапазон версий, но пакет разработан только для ожидания одной версии, пакет проигнорирует верхнюю границу диапазона и учтёт только версию в нижней границе диапазона.

См. документацию команды cmake_policy() для обсуждения опции NO_POLICY_SCOPE.

Полный синтаксис

find_package(<PackageName> [version] [EXACT] [QUIET]
             [REQUIRED] [[COMPONENTS] [components...]]
             [OPTIONAL_COMPONENTS components...]
             [CONFIG|NO_MODULE]
             [NO_POLICY_SCOPE]
             [NAMES name1 [name2 ...]]
             [CONFIGS config1 [config2 ...]]
             [HINTS path1 [path2 ... ]]
             [PATHS path1 [path2 ... ]]
             [PATH_SUFFIXES suffix1 [suffix2 ...]]
             [NO_DEFAULT_PATH]
             [NO_PACKAGE_ROOT_PATH]
             [NO_CMAKE_PATH]
             [NO_CMAKE_ENVIRONMENT_PATH]
             [NO_SYSTEM_ENVIRONMENT_PATH]
             [NO_CMAKE_PACKAGE_REGISTRY]
             [NO_CMAKE_BUILDS_PATH] # Deprecated; does nothing.
             [NO_CMAKE_SYSTEM_PATH]
             [NO_CMAKE_SYSTEM_PACKAGE_REGISTRY]
             [CMAKE_FIND_ROOT_PATH_BOTH |
              ONLY_CMAKE_FIND_ROOT_PATH |
              NO_CMAKE_FIND_ROOT_PATH])

Опция CONFIG, синонимичная опция NO_MODULE, или использование опций, не указанных в основном синтаксисе, принудительно применяют только режим конфигурации. В чистом режиме конфигурации команда пропускает поиск в режиме модуля и сразу переходит к поиску в режиме конфигурации.

Поиск в режиме конфигурации пытается найти файл конфигурации, предоставленный искомым пакетом. В кэше создаётся запись с именем <PackageName>_DIR, содержащая каталог, содержащий файл. По умолчанию команда ищет пакет с именем <PackageName>. Если указана опция NAMES, вместо <PackageName> используются имена, следующие за ней. Команда ищет файл <PackageName>Config.cmake или <lowercasePackageName>-config.cmake для каждого указанного имени. Заменить набор возможных имён файлов конфигурации можно с помощью опции CONFIGS. Процедура поиска в режиме конфигурации указана ниже. После нахождения проверяется соответствие любым ограничениям на версию, и если они соблюдены, файл конфигурации читается и обрабатывается CMake. Так как файл предоставляется пакетом, он уже знает расположение содержимого пакета. Полный путь к файлу конфигурации хранится в переменной cmake <PackageName>_CONFIG.

Все файлы конфигурации, которые были рассмотрены CMake во время поиска пакета с подходящей версией, хранятся в переменной <PackageName>_CONSIDERED_CONFIGS, а соответствующие версии — в переменной <PackageName>_CONSIDERED_VERSIONS.

Если файл конфигурации пакета не найден, CMake сгенерирует ошибку, описывающую проблему, если не указан аргумент QUIET. Если REQUIRED указан, и пакет не найден, генерируется ошибка и выполнение шага конфигурации прекращается. Если <PackageName>_DIR был установлен в каталог, не содержащий файл конфигурации, CMake проигнорирует его и начнёт поиск заново.

Авторам пакетов CMake, предоставляющих файлы конфигурации пакетов, рекомендуется называть и устанавливать их таким образом, чтобы Процедура поиска в режиме конфигурации, описанная ниже, находила их без необходимости использования дополнительных опций.

Процедура поиска в режиме конфигурации

Примечание

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

CMake создаёт набор возможных префиксов установки для пакета. Под каждым префиксом ищутся несколько директорий с конфигурационным файлом. В таблицах ниже показаны ищущие директории. Каждый элемент предназначен для деревьев установки, следующих конвенциям Windows (W), UNIX (U) или Apple (A):

<prefix>/                                                       (W)
<prefix>/(cmake|CMake)/                                         (W)
<prefix>/<name>*/                                               (W)
<prefix>/<name>*/(cmake|CMake)/                                 (W)
<prefix>/(lib/<arch>|lib*|share)/cmake/<name>*/                 (U)
<prefix>/(lib/<arch>|lib*|share)/<name>*/                       (U)
<prefix>/(lib/<arch>|lib*|share)/<name>*/(cmake|CMake)/         (U)
<prefix>/<name>*/(lib/<arch>|lib*|share)/cmake/<name>*/         (W/U)
<prefix>/<name>*/(lib/<arch>|lib*|share)/<name>*/               (W/U)
<prefix>/<name>*/(lib/<arch>|lib*|share)/<name>*/(cmake|CMake)/ (W/U)

В системах, поддерживающих macOS, ищутся следующие директории для фреймворков или пакетов приложений, содержащих конфигурационный файл:

<prefix>/<name>.framework/Resources/                    (A)
<prefix>/<name>.framework/Resources/CMake/              (A)
<prefix>/<name>.framework/Versions/*/Resources/         (A)
<prefix>/<name>.framework/Versions/*/Resources/CMake/   (A)
<prefix>/<name>.app/Contents/Resources/                 (A)
<prefix>/<name>.app/Contents/Resources/CMake/           (A)

Во всех случаях <name> обрабатывается как регистронезависимый и соответствует любому из указанных имён (<PackageName> или именам, заданным NAMES).

Пути с lib/<arch> активируются, если переменная CMAKE_LIBRARY_ARCHITECTURE установлена. lib* включает один или несколько значений lib64, lib32, libx32 или lib (в указанном порядке).

  • Пути с lib64 ищутся на 64-битных платформах, если свойство FIND_LIBRARY_USE_LIB64_PATHS установлено в TRUE.
  • Пути с lib32 ищутся на 32-битных платформах, если свойство FIND_LIBRARY_USE_LIB32_PATHS установлено в TRUE.
  • Пути с libx32 ищутся на платформах, использующих ABI x32, если свойство FIND_LIBRARY_USE_LIBX32_PATHS установлено в TRUE.
  • Путь lib всегда ищется.

Если PATH_SUFFIXES указано, суффиксы добавляются к каждому (W) или (U) элементу каталога по одному.

Этот набор директорий предназначен для работы с проектами, которые предоставляют конфигурационные файлы в своих деревьях установки. Директории, помеченные (W), предназначены для установки на Windows, где префикс может указывать на верхнюю часть каталога установки приложения. Те, что помечены (U), предназначены для установки на платформах UNIX, где префикс общий для нескольких пакетов. Это всего лишь соглашение, поэтому все (W) и (U) каталоги по-прежнему ищутся на всех платформах. Директории, помеченные (A), предназначены для установок на платформах Apple. Переменные CMAKE_FIND_FRAMEWORK и CMAKE_FIND_APPBUNDLE определяют порядок предпочтения.

Набор префиксов установки строится по следующим шагам. Если NO_DEFAULT_PATH указано, все NO_* опции активированы.

END_OF_DOCUMENT_MARKER

  1. Новое в версии 3.12: Пути поиска, указанные в переменной CMake <PackageName>_ROOT и переменной среды <PackageName>_ROOT, где <PackageName> — это пакет, который нужно найти. Переменные корня пакета хранятся в стеке, поэтому при вызове из модуля поиска будут также просматриваться корневые пути модуля родителя после путей текущего пакета. Это можно пропустить, если передано NO_PACKAGE_ROOT_PATH или установив CMAKE_FIND_USE_PACKAGE_ROOT_PATH на значение FALSE. См. политику CMP0074.

  2. Пути поиска, указанные в переменных кэша, специфичных для CMake. Они предназначены для использования в командной строке с -DVAR=value. Значения интерпретируются как списки, разделенные точкой с запятой. Это можно пропустить, если передано NO_CMAKE_PATH или установив CMAKE_FIND_USE_CMAKE_PATH на значение FALSE.

    • CMAKE_PREFIX_PATH
    • CMAKE_FRAMEWORK_PATH
    • CMAKE_APPBUNDLE_PATH

  3. Пути поиска, указанные в переменных среды, специфичных для CMake. Они предназначены для установки в конфигурации оболочки пользователя и, следовательно, используют разделитель путей хоста (; в Windows и : в UNIX). Это можно пропустить, если передано NO_CMAKE_ENVIRONMENT_PATH или установив CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH на значение FALSE:

    • <PackageName>_DIR
    • CMAKE_PREFIX_PATH
    • CMAKE_FRAMEWORK_PATH
    • CMAKE_APPBUNDLE_PATH
  4. Пути поиска, указанные опцией HINTS. Эти пути обычно вычисляются путем анализа системы, например, с помощью подсказки, предоставленной местоположением другого найденного элемента. Зашифрованные предположения должны быть указаны с помощью опции PATHS.

  5. Поиск по стандартным переменным среды системы. Это можно пропустить, если передано NO_SYSTEM_ENVIRONMENT_PATH или установив CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH на значение FALSE. Элементы пути, заканчивающиеся на /bin или /sbin, автоматически преобразуются в родительские директории:

    • PATH

  6. Поиск путей, хранящихся в реестре пакетов CMake Пользователя. Это можно пропустить, если передано NO_CMAKE_PACKAGE_REGISTRY или установив переменную CMAKE_FIND_USE_PACKAGE_REGISTRY на значение FALSE или устаревшую переменную CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY на значение TRUE.

    См. руководство cmake-packages(7) для получения подробной информации о реестре пакетов пользователя.

  7. Поиск переменных cmake, определенных в файлах платформы для текущей системы. Это можно пропустить, если передано NO_CMAKE_SYSTEM_PATH или установив CMAKE_FIND_USE_CMAKE_SYSTEM_PATH на значение FALSE:

    • CMAKE_SYSTEM_PREFIX_PATH
    • CMAKE_SYSTEM_FRAMEWORK_PATH
    • CMAKE_SYSTEM_APPBUNDLE_PATH

    Пути платформы, содержащиеся в этих переменных, представляют собой расположения, которые обычно включают установленное программное обеспечение. Например, /usr/local для систем на основе UNIX.

  8. Поиск путей, сохраненных в реестре пакетов CMake Системы. Это можно пропустить, если передано NO_CMAKE_SYSTEM_PACKAGE_REGISTRY или установив CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY на значение FALSE или устаревшую переменную CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY на значение TRUE.

    См. руководство cmake-packages(7) для получения подробной информации о системном реестре пакетов.

  9. Поиск путей, указанных опцией PATHS. Обычно это зашифрованные предположения.

Новое в версии 3.16: Добавлены переменные CMAKE_FIND_USE_<CATEGORY>, чтобы глобально отключить различные места поиска.

Переменная CMake CMAKE_FIND_ROOT_PATH указывает один или несколько каталогов, которые должны быть добавлены перед всеми другими каталогами поиска. Это эффективно "переопределяет корень" всего поиска в заданных расположениях. Пути, являющиеся подкаталогами CMAKE_STAGING_PREFIX, исключаются из этого переопределения корня, поскольку эта переменная всегда является путем на системе хоста. По умолчанию CMAKE_FIND_ROOT_PATH пуста.

Переменная CMAKE_SYSROOT также может быть использована для указания ровно одного каталога в качестве префикса. Установка CMAKE_SYSROOT также имеет другие эффекты. См. документацию по этой переменной для получения дополнительной информации.

Эти переменные особенно полезны при кросс-компиляции для указания корневого каталога целевой среды, и CMake также будет искать там. По умолчанию сначала ищутся каталоги, перечисленные в CMAKE_FIND_ROOT_PATH, затем каталог CMAKE_SYSROOT, а затем непереопределённые каталоги будут просматриваться. Поведение по умолчанию может быть скорректировано путем установки CMAKE_FIND_ROOT_PATH_MODE_PACKAGE. Это поведение можно вручную переопределить для каждого вызова, используя следующие опции:

CMAKE_FIND_ROOT_PATH_BOTH

Поиск в указанном выше порядке.

NO_CMAKE_FIND_ROOT_PATH

Не использовать переменную CMAKE_FIND_ROOT_PATH.

ONLY_CMAKE_FIND_ROOT_PATH

Поиск только в переопределённых каталогах и каталогах ниже CMAKE_STAGING_PREFIX.

По умолчанию порядок поиска оптимизирован для частых случаев использования, для максимальной специфичности. Проекты могут переопределить порядок, просто вызвав команду несколько раз и используя опции NO_*:

find_package (<PackageName> PATHS paths... NO_DEFAULT_PATH)
find_package (<PackageName>)

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

По умолчанию значение, хранящееся в переменной результата, будет путем, в котором найден файл. Переменная CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS может быть установлена в TRUE перед вызовом find_package, чтобы разрешить символические ссылки и сохранить реальный путь к файлу.

Каждый вызов find_package, который не является REQUIRED, может быть отключён или сделан REQUIRED:

  • Установка переменной CMAKE_DISABLE_FIND_PACKAGE_<PackageName> в TRUE отключает пакет.
  • Установка переменной CMAKE_REQUIRE_FIND_PACKAGE_<PackageName> в TRUE делает пакет REQUIRED.

Установка обеих переменных в TRUE одновременно является ошибкой.

Выбор версии в режиме конфигурации

Примечание

При использовании режима конфигурации этот процесс выбора версии применяется независимо от того, была ли задана полная полная или базовая подпись.

При задании аргумента [version], режим конфигурации будет искать только версию пакета, которая заявляет о совместимости с запрошенной версией (см. спецификацию формата). При задании опции EXACT, может быть найдена только версия пакета, заявляющая о точном соответствии запрошенной версии. CMake не устанавливает никаких соглашений о значении версий. Номера версий пакетов проверяются файлами «version», предоставляемыми самими пакетами. Для кандидатского файла конфигурации пакета <config-file>.cmake соответствующий файл версии расположен рядом с ним и называется либо <config-file>-version.cmake, либо <config-file>Version.cmake. Если такой файл версии недоступен, то предполагается, что файл конфигурации не совместим ни с какой запрошенной версией. Базовый файл версии, содержащий код соответствия версий, можно создать с помощью модуля CMakePackageConfigHelpers. При обнаружении файла версии он загружается для проверки запрошенного номера версии. Файл версии загружается вложенном контексте, в котором определены следующие переменные:

PACKAGE_FIND_NAME

<PackageName>

PACKAGE_FIND_VERSION

Полная строка запрошенной версии

PACKAGE_FIND_VERSION_MAJOR

Основная версия, если запрошена, иначе 0

PACKAGE_FIND_VERSION_MINOR

Дополнительная версия, если запрошена, иначе 0

PACKAGE_FIND_VERSION_PATCH

Версия исправления, если запрошена, иначе 0

PACKAGE_FIND_VERSION_TWEAK

Версия уточнения, если запрошена, иначе 0

PACKAGE_FIND_VERSION_COUNT

Количество компонентов версии, от 0 до 4

При указании диапазона версий, вышеперечисленные переменные версии будут содержать значения, основанные на нижнем конце диапазона версии. Это делается для сохранения совместимости с пакетами, которые не были реализованы для ожиданий диапазонов версий. Кроме того, диапазон версий будет описан следующими переменными:

PACKAGE_FIND_VERSION_RANGE

Полная строка диапазона запрошенной версии

PACKAGE_FIND_VERSION_RANGE_MIN

Указывает, должна ли нижняя граница диапазона версии включаться или исключаться. В настоящее время единственное поддерживаемое значение для этой переменной — INCLUDE.

PACKAGE_FIND_VERSION_RANGE_MAX

Указывает, должна ли верхняя граница диапазона версии включаться или исключаться. Поддерживаемые значения для этой переменной — INCLUDE и EXCLUDE.

PACKAGE_FIND_VERSION_MIN

Полная запрошенная строка версии нижней границы диапазона

PACKAGE_FIND_VERSION_MIN_MAJOR

Основная версия нижней границы диапазона, если запрошена, иначе 0

PACKAGE_FIND_VERSION_MIN_MINOR

Дополнительная версия нижней границы диапазона, если запрошена, иначе 0

PACKAGE_FIND_VERSION_MIN_PATCH

Версия исправления нижней границы диапазона, если запрошена, иначе 0

PACKAGE_FIND_VERSION_MIN_TWEAK

Версия уточнения нижней границы диапазона, если запрошена, иначе 0

PACKAGE_FIND_VERSION_MIN_COUNT

Количество компонентов версии нижней границы, от 0 до 4

PACKAGE_FIND_VERSION_MAX

Полная запрошенная строка версии верхней границы диапазона

PACKAGE_FIND_VERSION_MAX_MAJOR

Основная версия верхней границы диапазона, если запрошена, иначе 0

PACKAGE_FIND_VERSION_MAX_MINOR

Дополнительная версия верхней границы диапазона, если запрошена, иначе 0

PACKAGE_FIND_VERSION_MAX_PATCH

Версия исправления верхней границы диапазона, если запрошена, иначе 0

PACKAGE_FIND_VERSION_MAX_TWEAK

Версия уточнения верхней границы диапазона, если запрошена, иначе 0

PACKAGE_FIND_VERSION_MAX_COUNT

Количество компонентов версии верхней границы, от 0 до 4

Независимо от того, указывается ли одна версия или диапазон версий, переменная PACKAGE_FIND_VERSION_COMPLETE будет определена и будет содержать полную запрошенную строку версии, как указано.

Файл версии проверяет, удовлетворяет ли он запрошенной версии, и устанавливает эти переменные:

PACKAGE_VERSION

Полная предоставленная строка версии

PACKAGE_VERSION_EXACT

True, если версия — точное совпадение

PACKAGE_VERSION_COMPATIBLE

True, если версия совместима

PACKAGE_VERSION_UNSUITABLE

True, если не подходит как любая версия

Эти переменные проверяются командой find_package, чтобы определить, предоставляет ли файл конфигурации приемлемую версию. Они недоступны после возвращения вызова find_package. Если версия приемлема, устанавливаются следующие переменные:

<PackageName>_VERSION

Полная предоставленная строка версии

<PackageName>_VERSION_MAJOR

Основная версия, если предоставлена, иначе 0

<PackageName>_VERSION_MINOR

Дополнительная версия, если предоставлена, иначе 0

<PackageName>_VERSION_PATCH

Версия исправления, если предоставлена, иначе 0

<PackageName>_VERSION_TWEAK

Версия уточнения, если предоставлена, иначе 0

<PackageName>_VERSION_COUNT

Количество компонентов версии, от 0 до 4

и загружается соответствующий файл конфигурации пакета. Если доступны несколько файлов конфигурации пакета, файлы версий которых утверждают о совместимости с запрошенной версией, то выбор конкретного файла не определён: если переменная CMAKE_FIND_PACKAGE_SORT_ORDER не установлена, то не предпринимается попытка выбрать наибольшую или ближайшую версию.

Для управления порядком, в котором find_package проверяет совместимость, используйте две переменные CMAKE_FIND_PACKAGE_SORT_ORDER и CMAKE_FIND_PACKAGE_SORT_DIRECTION. Например, чтобы выбрать наибольшую версию, можно установить

SET(CMAKE_FIND_PACKAGE_SORT_ORDER NATURAL)
SET(CMAKE_FIND_PACKAGE_SORT_DIRECTION DEC)

перед вызовом find_package.

Переменные интерфейса файлов пакетов

При загрузке модуля поиска или файла конфигурации пакета find_package определяет переменные, чтобы предоставить информацию о параметрах вызова (и восстанавливает их исходное состояние перед возвратом):

CMAKE_FIND_PACKAGE_NAME

Имя пакета, который ищется

<PackageName>_FIND_REQUIRED

True, если опция REQUIRED была задана

<PackageName>_FIND_QUIETLY

True, если опция QUIET была задана

<PackageName>_FIND_VERSION

Полная строка запрошенной версии

<PackageName>_FIND_VERSION_MAJOR

Основная версия, если запрошена, иначе 0

<PackageName>_FIND_VERSION_MINOR

Дополнительная версия, если запрошена, иначе 0

<PackageName>_FIND_VERSION_PATCH

Версия исправления, если запрошена, иначе 0

<PackageName>_FIND_VERSION_TWEAK

Версия уточнения, если запрошена, иначе 0

<PackageName>_FIND_VERSION_COUNT

Количество компонентов версии, от 0 до 4

<PackageName>_FIND_VERSION_EXACT

True, если опция EXACT была задана

<PackageName>_FIND_COMPONENTS

Список указанных компонентов (обязательные и необязательные)

<PackageName>_FIND_REQUIRED_<c>

True, если компонент <c> обязателен, false, если компонент <c> необязателен

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

<PackageName>_FIND_VERSION_RANGE

Полная строка запрошенного диапазона версий

<PackageName>_FIND_VERSION_RANGE_MIN

Указывает, включается или исключается нижняя граница диапазона версий. В настоящее время поддерживается только значение INCLUDE.

<PackageName>_FIND_VERSION_RANGE_MAX

Указывает, включается или исключается верхняя граница диапазона версий. Возможные значения для этой переменной — INCLUDE или EXCLUDE.

<PackageName>_FIND_VERSION_MIN

Полная строка запрошенной версии нижней границы диапазона

<PackageName>_FIND_VERSION_MIN_MAJOR

Главная версия нижней границы диапазона, если запрошена, иначе 0

<PackageName>_FIND_VERSION_MIN_MINOR

Дополнительная версия нижней границы диапазона, если запрошена, иначе 0

<PackageName>_FIND_VERSION_MIN_PATCH

Версия исправления нижней границы диапазона, если запрошена, иначе 0

<PackageName>_FIND_VERSION_MIN_TWEAK

Версия доработки нижней границы диапазона, если запрошена, иначе 0

<PackageName>_FIND_VERSION_MIN_COUNT

Количество компонентов версии нижней границы диапазона, от 0 до 4

<PackageName>_FIND_VERSION_MAX

Полная строка запрошенной версии верхней границы диапазона

<PackageName>_FIND_VERSION_MAX_MAJOR

Главная версия верхней границы диапазона, если запрошена, иначе 0

<PackageName>_FIND_VERSION_MAX_MINOR

Дополнительная версия верхней границы диапазона, если запрошена, иначе 0

<PackageName>_FIND_VERSION_MAX_PATCH

Версия исправления верхней границы диапазона, если запрошена, иначе 0

<PackageName>_FIND_VERSION_MAX_TWEAK

Версия доработки верхней границы диапазона, если запрошена, иначе 0

<PackageName>_FIND_VERSION_MAX_COUNT

Количество компонентов версии верхней границы диапазона, от 0 до 4

Независимо от того, указана ли одна версия или диапазон версий, переменная <PackageName>_FIND_VERSION_COMPLETE будет определена и содержать полную запрошенную строку версии как указано.

В режиме модуля загруженный модуль поиска отвечает за выполнение запроса, подробности см. в модуле поиска. В режиме конфигурации find_package автоматически обрабатывает опции REQUIRED, QUIET, и [version], но оставляет обработку компонентов файлу конфигурации пакета, что имеет смысл для пакета. Файл конфигурации пакета может установить <PackageName>_FOUND в значение false, чтобы сообщить find_package, что требования к компонентам не выполнены.

© 2000–2021 Kitware, Inc. and Contributors
Licensed under the BSD 3-clause License.
https://cmake.org/cmake/help/v3.22/command/find_package.html

Spec-Zone.ru

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