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]
  [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. Команда автоматически проверит, был ли найден файл конфигурации пакета.

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