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 указан и пакет не найден, генерируется фатальная ошибка, и этап конфигурирования прекращает свою работу. Если <PackageName>_DIR установлена в каталог, не содержащий файла конфигурации, CMake проигнорирует его и начнет поиск с нуля.

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

Процедура поиска в режиме 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 всегда проверяется.

Укажите, какие представления реестра необходимо запросить. Этот параметр имеет смысл только на платформах Windows и будет проигнорирован на других. При отсутствии указания используется представление TARGET, когда политика CMP0134 установлена в NEW. Обратитесь к CMP0134 для получения значения по умолчанию, когда политика установлена в OLD.

64

Запрос в 64-разрядную базу данных реестра. В 32-разрядных системах Windows всегда возвращает строку /REGISTRY-NOTFOUND.

32

Запрос в 32-разрядную базу данных реестра.

64_32

Запрос обоих представлений (64 и 32) и генерация пути для каждого.

32_64

Запрос обоих представлений (32 и 64) и генерация пути для каждого.

HOST

Запрос реестра, соответствующего архитектуре хоста: 64 в 64-разрядных системах Windows и 32 в 32-разрядных системах Windows.

TARGET

Запрос реестра, соответствующего архитектуре, заданной переменной CMAKE_SIZEOF_VOID_P. Если она не определена, используется представление HOST.

BOTH

Запрос обоих представлений (32 и 64). Порядок зависит от следующих правил: Если переменная CMAKE_SIZEOF_VOID_P определена, используется следующее представление в зависимости от её значения:

• 8: 64_32
• 4: 32_64

Если переменная CMAKE_SIZEOF_VOID_P не определена, используется архитектура хоста:

• 64-разрядная: 64_32
• 32-разрядная: 32

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

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

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

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

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

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

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