find_package

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

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

Типичное использование

Большинство вызовов find_package() обычно имеют следующий вид:

find_package(<PackageName> [<version>] [REQUIRED] [COMPONENTS <components>...])

<PackageName> — единственный обязательный аргумент. <version> часто опускается, а REQUIRED необходимо указывать, если проект не может быть успешно сконфигурирован без пакета. Некоторые более сложные пакеты поддерживают компоненты, которые можно выбрать с помощью ключевого слова COMPONENTS, но у большинства пакетов нет такой сложности.

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

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

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

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

Режим перенаправления FetchContent

Добавлено в версии 3.24: Вызов find_package() может быть внутренне перенаправлен на пакет, предоставляемый модулем FetchContent. Для вызывающего стороны поведение будет похоже на режим конфигурации, за исключением того, что логика поиска пропущена, и информация о компоненте не используется. См. FetchContent_Declare() и FetchContent_MakeAvailable() для получения дополнительной информации.

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

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

find_package(<PackageName> [version] [EXACT] [QUIET] [MODULE]
             [REQUIRED] [[COMPONENTS] [components...]]
             [OPTIONAL_COMPONENTS components...]
             [REGISTRY_VIEW  (64|32|64_32|32_64|HOST|TARGET|BOTH)]
             [GLOBAL]
             [NO_POLICY_SCOPE]
             [BYPASS_PROVIDER])

Основной синтаксис поддерживается как в режиме модуля, так и в режиме конфигурации. Ключевое слово 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]
             [GLOBAL]
             [NO_POLICY_SCOPE]
             [BYPASS_PROVIDER]
             [NAMES name1 [name2 ...]]
             [CONFIGS config1 [config2 ...]]
             [HINTS path1 [path2 ... ]]
             [PATHS path1 [path2 ... ]]
             [REGISTRY_VIEW  (64|32|64_32|32_64|HOST|TARGET|BOTH)]
             [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_INSTALL_PREFIX]
             [NO_CMAKE_SYSTEM_PACKAGE_REGISTRY]
             [CMAKE_FIND_ROOT_PATH_BOTH |
              ONLY_CMAKE_FIND_ROOT_PATH |
              NO_CMAKE_FIND_ROOT_PATH])

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

Поиск в режиме Config пытается найти файл конфигурации, предоставленный искомым пакетом. В кэш создается запись под названием <PackageName>_DIR, которая хранит каталог, содержащий файл. По умолчанию команда ищет пакет с именем <PackageName>. Если задана опция NAMES, вместо <PackageName> используются указанные после неё имена. Эти имена также учитываются при определении перенаправления вызова к пакету, предоставленному модулем FetchContent.

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

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

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

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

Процедура поиска в режиме Config

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

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

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

Если хотя бы один язык компиляции включён, могут быть выполнены поиск по архитектурно-специфическим каталогам lib/<arch> и lib* на основе целевой архитектуры компилятора в следующем порядке:

lib/<arch>

Ищется, если переменная CMAKE_LIBRARY_ARCHITECTURE задана.

lib64

Ищется на 64-битных платформах (CMAKE_SIZEOF_VOID_P равно 8) и свойство FIND_LIBRARY_USE_LIB64_PATHS установлено в TRUE.

lib32

Ищется на 32-битных платформах (CMAKE_SIZEOF_VOID_P равно 4) и свойство 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_* параметры включены.

1. Поиск префиксов поиска, уникальных для текущего <PackageName>, происходит. Смотрите политику CMP0074.

   Добавлена в версии 3.12.

   В частности, префиксы поиска, задаваемые следующими переменными, в указанном порядке:

   1. <PackageName>_ROOT Переменная CMake, где <PackageName> - это имя пакета, сохраняющее регистр.

   2. <PACKAGENAME>_ROOT Переменная CMake, где <PACKAGENAME> - это имя пакета в верхнем регистре. Смотрите политику CMP0144.

      Добавлена в версии 3.27.

   3. <PackageName>_ROOT Переменная среды, где <PackageName> - это имя пакета, сохраняющее регистр.

   4. <PACKAGENAME>_ROOT Переменная среды, где <PACKAGENAME> - это имя пакета в верхнем регистре. Смотрите политику CMP0144.

      Добавлена в версии 3.27.

   Переменные корня пакета поддерживаются как стек, поэтому если вызывается из модуля поиска, пути корней родительского модуля поиска также будут просматриваться после путей текущего пакета. Это можно пропустить, если NO_PACKAGE_ROOT_PATH передано или путем установки CMAKE_FIND_USE_PACKAGE_ROOT_PATH на FALSE.

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, определённых в файлах платформы для текущей системы. Поиск CMAKE_INSTALL_PREFIX и CMAKE_STAGING_PREFIX можно пропустить, если NO_CMAKE_INSTALL_PREFIX передано или путем установки CMAKE_FIND_USE_INSTALL_PREFIX на FALSE. Все эти расположения можно пропустить, если 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. Обычно это жёстко заданные догадки.

Переменные CMAKE_IGNORE_PATH, CMAKE_IGNORE_PREFIX_PATH, CMAKE_SYSTEM_IGNORE_PATH и CMAKE_SYSTEM_IGNORE_PREFIX_PATH также могут привести к игнорированию некоторых вышеперечисленных расположений.

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

Для путей поиска, содержащих <name>*, порядок среди совпадающих путей не определён, если не установлена переменная CMAKE_FIND_PACKAGE_SORT_ORDER. Эта переменная, вместе с переменной CMAKE_FIND_PACKAGE_SORT_DIRECTION, определяет порядок, в котором CMake рассматривает пути, соответствующие одному пути поиска, содержащему <name>*. Например, если в файловой системе есть файлы конфигурации пакета

<prefix>/example-1.2/example-config.cmake
<prefix>/example-1.10/example-config.cmake
<prefix>/share/example-2.0/example-config.cmake

то не определено (когда вышеупомянутые переменные не установлены), найдёт ли find_package(example) example-1.2 или example-1.10 (предполагая, что оба работоспособны), но find_package не найдёт example-2.0, потому что один из двух других будет найден первым.

Чтобы контролировать порядок, в котором find_package ищет каталоги, соответствующие выражению glob, используйте CMAKE_FIND_PACKAGE_SORT_ORDER и CMAKE_FIND_PACKAGE_SORT_DIRECTION. Например, чтобы заставить вышеприведённый пример выбрать example-1.10, можно установить

SET(CMAKE_FIND_PACKAGE_SORT_ORDER NATURAL)
SET(CMAKE_FIND_PACKAGE_SORT_DIRECTION DEC)

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

Переменная 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 для разрешения символических ссылок и сохранения реального пути к файлу.

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

• Установив переменную CMAKE_DISABLE_FIND_PACKAGE_<PackageName> в TRUE, отключается пакет. Это также отключает перенаправление на пакет, предоставленный FetchContent.
• Установив переменную CMAKE_REQUIRE_FIND_PACKAGE_<PackageName> в TRUE, пакет становится REQUIRED.

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

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

Когда предоставляется аргумент [version], режим конфигурации будет искать только версию пакета, которая заявляет о совместимости с запрошенной версией (см. спецификация формата). Если предоставлена опция EXACT, может быть найдена только версия пакета, заявляющая о точном соответствии запрошенной версии. CMake не устанавливает никаких соглашений о значении версий. Номера версий пакетов проверяются файлами «version», предоставленными самими пакетами или модулем FetchContent. Для кандидатного файла конфигурации пакета <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

Истина, если версия является точным совпадением

PACKAGE_VERSION_COMPATIBLE

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

PACKAGE_VERSION_UNSUITABLE

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

Эти переменные проверяются командой 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

и соответствующий файл конфигурации пакета загружается.

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

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

CMAKE_FIND_PACKAGE_NAME

Модуль или пакет, который ищется

<PackageName>_FIND_REQUIRED

Истина, если был задан параметр REQUIRED

<PackageName>_FIND_QUIETLY

Истина, если был задан параметр QUIET

<PackageName>_FIND_REGISTRY_VIEW

Запрошенный вид, если задан параметр REGISTRY_VIEW

<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

Истина, если был задан параметр EXACT

<PackageName>_FIND_COMPONENTS

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

<PackageName>_FIND_REQUIRED_<c>

Истина, если компонент <c> обязателен, ложь, если компонент <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 о том, что требования к компонентам не выполнены.