FindPackageHandleStandardArgs

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

find_package_handle_standard_args

Существуют две подписи:

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_COMPONENTS]
  [CONFIG_MODE]
  [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>

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

REQUIRED_VARS <required-var>...

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

VERSION_VAR <version-var>

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

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>

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

FAIL_MESSAGE <custom-failure-message>

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

Пример для простой подписи:

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 генерирует правильное сообщение об успехе или об ошибке.