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()