FindPackageHandleStandardArgs

Этот модуль предоставляет функции, предназначенные для использования в модулях поиска при реализации вызовов find_package(<PackageName>).

find_package_handle_standard_args

Эта команда обрабатывает REQUIRED, QUIET и аргументы, связанные с версией, вызова find_package(). Она также устанавливает переменную <PackageName>_FOUND. Пакет считается найденным, если все перечисленные переменные содержат корректные результаты, например, корректные пути к файлам.

Существует два варианта синтаксиса:

find_package_handle_standard_args(<PackageName>
  (DEFAULT_MSG|<custom-failure-message>)
  <required-var>...
  )

find_package_handle_standard_args(<PackageName>
  [FOUND_VAR <result-var>]
  [REQUIRED_VARS <required-var>...]
  [VERSION_VAR <version-var>]
  [HANDLE_VERSION_RANGE]
  [HANDLE_COMPONENTS]
  [CONFIG_MODE]
  [NAME_MISMATCHED]
  [REASON_FAILURE_MESSAGE <reason-failure-message>]
  [FAIL_MESSAGE <custom-failure-message>]
  )

Переменная <PackageName>_FOUND будет установлена в значение TRUE, если все переменные <required-var>... являются корректными и выполняются все дополнительные ограничения, и в FALSE в противном случае. В зависимости от результатов и от того, был ли передан параметр REQUIRED или QUIET вызову find_package(), может быть выведено сообщение об успехе или об ошибке.

Параметры:

(DEFAULT_MSG|<custom-failure-message>)

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

FOUND_VAR <result-var>

Устарело начиная с версии 3.3.

Задаёт переменную результата в виде <PackageName>_FOUND или <PACKAGENAME>_FOUND. Этот параметр существует только для совместимости со старыми версиями CMake и теперь игнорируется. Переменные результата с обоими именами всегда устанавливаются для совместимости.

REQUIRED_VARS <required-var>...

Укажите переменные, необходимые для этого пакета. Эти имена могут быть включены в сгенерированное сообщение об ошибке, прося пользователя установить пропущенные значения переменных. Поэтому они обычно должны быть записями кэша, такими как FOO_LIBRARY, а не выходными переменными, такими как FOO_LIBRARIES.

Изменено в версии 3.18: Если указан параметр HANDLE_COMPONENTS, этот параметр может быть опущен.

VERSION_VAR <version-var>

Укажите имя переменной, которая содержит версию найденного пакета. Эта версия будет проверена на соответствие (возможно) указанной требуемой версии, заданной в вызове find_package(), включая её параметр EXACT. Стандартные сообщения содержат информацию о требуемой версии и фактически найденной версии, как в случае корректной, так и некорректной версии.

HANDLE_VERSION_RANGE

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

Включить обработку диапазона версий, если он указан. Без этого параметра будет отображено предупреждение разработчику, если указан диапазон версий.

HANDLE_COMPONENTS

Включить обработку компонентов пакета. В этом случае команда будет сообщать, какие компоненты найдены, а какие отсутствуют, и переменная <PackageName>_FOUND будет установлена в значение FALSE, если любой из требуемых компонентов (то есть не те, которые перечислены после параметра OPTIONAL_COMPONENTS вызова find_package()) отсутствует.

CONFIG_MODE

Укажите, что вызывающий модуль поиска является оболочкой вокруг вызова find_package(<PackageName> NO_MODULE). Это подразумевает значение VERSION_VAR в <PackageName>_VERSION. Команда автоматически проверит, был ли найден файл конфигурации пакета.

REASON_FAILURE_MESSAGE <reason-failure-message>

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

Укажите пользовательское сообщение о причине ошибки, которое будет добавлено к стандартному сгенерированному сообщению.

FAIL_MESSAGE <custom-failure-message>

Укажите пользовательское сообщение об ошибке вместо использования стандартного сгенерированного сообщения. Не рекомендуется.

NAME_MISMATCHED

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

Укажите, что <PackageName> не соответствует ${CMAKE_FIND_PACKAGE_NAME}. Обычно это ошибка и выдаётся предупреждение, но это может быть намеренным при использовании команды для компонентов более крупного пакета.

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

find_package_handle_standard_args(LibXml2 DEFAULT_MSG
  LIBXML2_LIBRARY LIBXML2_INCLUDE_DIR)

Пакет LibXml2 считается найденным, если LIBXML2_LIBRARY и LIBXML2_INCLUDE_DIR являются корректными. Затем LibXml2_FOUND устанавливается в значение TRUE. Если он не найден и был использован параметр REQUIRED, произойдёт ошибка с помощью message(FATAL_ERROR), независимо от использования параметра QUIET. Если он найден, будет сообщено об успехе, включая содержание первого <required-var>. При повторных запусках CMake это сообщение не будет выводиться снова.

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

find_package_handle_standard_args(LibArchive
  REQUIRED_VARS LibArchive_LIBRARY LibArchive_INCLUDE_DIR
  VERSION_VAR LibArchive_VERSION)

В этом случае пакет LibArchive считается найденным, если LibArchive_LIBRARY и LibArchive_INCLUDE_DIR являются корректными. Также версия LibArchive будет проверена с использованием версии, содержащейся в LibArchive_VERSION. Поскольку параметр FAIL_MESSAGE не передан, будут выведены стандартные сообщения.

Ещё один пример для полного варианта синтаксиса:

find_package(Automoc4 QUIET NO_MODULE HINTS /opt/automoc4)
find_package_handle_standard_args(Automoc4  CONFIG_MODE)

В этом случае модуль FindAutmoc4.cmake оборачивает вызов find_package(Automoc4 NO_MODULE) и добавляет дополнительный каталог поиска для automoc4. Затем вызов find_package_handle_standard_args генерирует соответствующее сообщение об успехе/ошибке.

find_package_check_version

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

Вспомогательная функция, которую можно использовать для проверки соответствия <version> связанным с версией аргументам вызова find_package().

find_package_check_version(<version> <result-var>
  [HANDLE_VERSION_RANGE]
  [RESULT_MESSAGE_VARIABLE <message-var>]
  )

Переменная <result-var> будет содержать булево значение, отражающее результат проверки.

Параметры:

HANDLE_VERSION_RANGE

Включить обработку диапазона версий, если он указан. Без этого параметра будет отображено предупреждение разработчику, если указан диапазон версий.

RESULT_MESSAGE_VARIABLE <message-var>

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

Пример использования:

find_package_check_version(1.2.3 result HANDLE_VERSION_RANGE
  RESULT_MESSAGE_VARIABLE reason)
if (result)
  message (STATUS "${reason}")
else()
  message (FATAL_ERROR "${reason}")
endif()