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