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 FRAMEWORK и BUNDLE, ищутся следующие каталоги Frameworks или Application Bundles, содержащие файл конфигурации:

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

Каждый вызов find_package, не помеченный как ОБОБЩЕННЫЙ, может быть отключён или сделан ОБОБЩЕННЫМ:

• Установка переменной CMAKE_DISABLE_FIND_PACKAGE_<PackageName> в значение TRUE отключает пакет. Это также отключает перенаправление на пакет, предоставленный FetchContent.
• Установка переменной CMAKE_REQUIRE_FIND_PACKAGE_<PackageName> в значение TRUE делает пакет ОБОБЩЕННЫМ.

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

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

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