# Distributed under the OSI-approved BSD 3-Clause License. See accompanying | |
# file Copyright.txt or https://cmake.org/licensing for details. | |
#[=======================================================================[.rst: | |
FindPackageHandleStandardArgs | |
----------------------------- | |
This module provides a function intended to be used in :ref:`Find Modules` | |
implementing :command:`find_package(<PackageName>)` calls. It handles the | |
``REQUIRED``, ``QUIET`` and version-related arguments of ``find_package``. | |
It also sets the ``<PackageName>_FOUND`` variable. The package is | |
considered found if all variables listed contain valid results, e.g. | |
valid filepaths. | |
.. command:: find_package_handle_standard_args | |
There are two signatures:: | |
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>] | |
) | |
The ``<PackageName>_FOUND`` variable will be set to ``TRUE`` if all | |
the variables ``<required-var>...`` are valid and any optional | |
constraints are satisfied, and ``FALSE`` otherwise. A success or | |
failure message may be displayed based on the results and on | |
whether the ``REQUIRED`` and/or ``QUIET`` option was given to | |
the :command:`find_package` call. | |
The options are: | |
``(DEFAULT_MSG|<custom-failure-message>)`` | |
In the simple signature this specifies the failure message. | |
Use ``DEFAULT_MSG`` to ask for a default message to be computed | |
(recommended). Not valid in the full signature. | |
``FOUND_VAR <result-var>`` | |
Obsolete. Specifies either ``<PackageName>_FOUND`` or | |
``<PACKAGENAME>_FOUND`` as the result variable. This exists only | |
for compatibility with older versions of CMake and is now ignored. | |
Result variables of both names are always set for compatibility. | |
``REQUIRED_VARS <required-var>...`` | |
Specify the variables which are required for this package. | |
These may be named in the generated failure message asking the | |
user to set the missing variable values. Therefore these should | |
typically be cache entries such as ``FOO_LIBRARY`` and not output | |
variables like ``FOO_LIBRARIES``. | |
``VERSION_VAR <version-var>`` | |
Specify the name of a variable that holds the version of the package | |
that has been found. This version will be checked against the | |
(potentially) specified required version given to the | |
:command:`find_package` call, including its ``EXACT`` option. | |
The default messages include information about the required | |
version and the version which has been actually found, both | |
if the version is ok or not. | |
``HANDLE_COMPONENTS`` | |
Enable handling of package components. In this case, the command | |
will report which components have been found and which are missing, | |
and the ``<PackageName>_FOUND`` variable will be set to ``FALSE`` | |
if any of the required components (i.e. not the ones listed after | |
the ``OPTIONAL_COMPONENTS`` option of :command:`find_package`) are | |
missing. | |
``CONFIG_MODE`` | |
Specify that the calling find module is a wrapper around a | |
call to ``find_package(<PackageName> NO_MODULE)``. This implies | |
a ``VERSION_VAR`` value of ``<PackageName>_VERSION``. The command | |
will automatically check whether the package configuration file | |
was found. | |
``FAIL_MESSAGE <custom-failure-message>`` | |
Specify a custom failure message instead of using the default | |
generated message. Not recommended. | |
Example for the simple signature: | |
.. code-block:: cmake | |
find_package_handle_standard_args(LibXml2 DEFAULT_MSG | |
LIBXML2_LIBRARY LIBXML2_INCLUDE_DIR) | |
The ``LibXml2`` package is considered to be found if both | |
``LIBXML2_LIBRARY`` and ``LIBXML2_INCLUDE_DIR`` are valid. | |
Then also ``LibXml2_FOUND`` is set to ``TRUE``. If it is not found | |
and ``REQUIRED`` was used, it fails with a | |
:command:`message(FATAL_ERROR)`, independent whether ``QUIET`` was | |
used or not. If it is found, success will be reported, including | |
the content of the first ``<required-var>``. On repeated CMake runs, | |
the same message will not be printed again. | |
Example for the full signature: | |
.. code-block:: cmake | |
find_package_handle_standard_args(LibArchive | |
REQUIRED_VARS LibArchive_LIBRARY LibArchive_INCLUDE_DIR | |
VERSION_VAR LibArchive_VERSION) | |
In this case, the ``LibArchive`` package is considered to be found if | |
both ``LibArchive_LIBRARY`` and ``LibArchive_INCLUDE_DIR`` are valid. | |
Also the version of ``LibArchive`` will be checked by using the version | |
contained in ``LibArchive_VERSION``. Since no ``FAIL_MESSAGE`` is given, | |
the default messages will be printed. | |
Another example for the full signature: | |
.. code-block:: cmake | |
find_package(Automoc4 QUIET NO_MODULE HINTS /opt/automoc4) | |
find_package_handle_standard_args(Automoc4 CONFIG_MODE) | |
In this case, a ``FindAutmoc4.cmake`` module wraps a call to | |
``find_package(Automoc4 NO_MODULE)`` and adds an additional search | |
directory for ``automoc4``. Then the call to | |
``find_package_handle_standard_args`` produces a proper success/failure | |
message. | |
#]=======================================================================] | |
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageMessage.cmake) | |
# internal helper macro | |
macro(_FPHSA_FAILURE_MESSAGE _msg) | |
if (${_NAME}_FIND_REQUIRED) | |
message(FATAL_ERROR "${_msg}") | |
else () | |
if (NOT ${_NAME}_FIND_QUIETLY) | |
message(STATUS "${_msg}") | |
endif () | |
endif () | |
endmacro() | |
# internal helper macro to generate the failure message when used in CONFIG_MODE: | |
macro(_FPHSA_HANDLE_FAILURE_CONFIG_MODE) | |
# <name>_CONFIG is set, but FOUND is false, this means that some other of the REQUIRED_VARS was not found: | |
if(${_NAME}_CONFIG) | |
_FPHSA_FAILURE_MESSAGE("${FPHSA_FAIL_MESSAGE}: missing: ${MISSING_VARS} (found ${${_NAME}_CONFIG} ${VERSION_MSG})") | |
else() | |
# If _CONSIDERED_CONFIGS is set, the config-file has been found, but no suitable version. | |
# List them all in the error message: | |
if(${_NAME}_CONSIDERED_CONFIGS) | |
set(configsText "") | |
list(LENGTH ${_NAME}_CONSIDERED_CONFIGS configsCount) | |
math(EXPR configsCount "${configsCount} - 1") | |
foreach(currentConfigIndex RANGE ${configsCount}) | |
list(GET ${_NAME}_CONSIDERED_CONFIGS ${currentConfigIndex} filename) | |
list(GET ${_NAME}_CONSIDERED_VERSIONS ${currentConfigIndex} version) | |
string(APPEND configsText " ${filename} (version ${version})\n") | |
endforeach() | |
if (${_NAME}_NOT_FOUND_MESSAGE) | |
string(APPEND configsText " Reason given by package: ${${_NAME}_NOT_FOUND_MESSAGE}\n") | |
endif() | |
_FPHSA_FAILURE_MESSAGE("${FPHSA_FAIL_MESSAGE} ${VERSION_MSG}, checked the following files:\n${configsText}") | |
else() | |
# Simple case: No Config-file was found at all: | |
_FPHSA_FAILURE_MESSAGE("${FPHSA_FAIL_MESSAGE}: found neither ${_NAME}Config.cmake nor ${_NAME_LOWER}-config.cmake ${VERSION_MSG}") | |
endif() | |
endif() | |
endmacro() | |
function(FIND_PACKAGE_HANDLE_STANDARD_ARGS _NAME _FIRST_ARG) | |
# set up the arguments for CMAKE_PARSE_ARGUMENTS and check whether we are in | |
# new extended or in the "old" mode: | |
set(options CONFIG_MODE HANDLE_COMPONENTS) | |
set(oneValueArgs FAIL_MESSAGE VERSION_VAR FOUND_VAR) | |
set(multiValueArgs REQUIRED_VARS) | |
set(_KEYWORDS_FOR_EXTENDED_MODE ${options} ${oneValueArgs} ${multiValueArgs} ) | |
list(FIND _KEYWORDS_FOR_EXTENDED_MODE "${_FIRST_ARG}" INDEX) | |
if(${INDEX} EQUAL -1) | |
set(FPHSA_FAIL_MESSAGE ${_FIRST_ARG}) | |
set(FPHSA_REQUIRED_VARS ${ARGN}) | |
set(FPHSA_VERSION_VAR) | |
else() | |
CMAKE_PARSE_ARGUMENTS(FPHSA "${options}" "${oneValueArgs}" "${multiValueArgs}" ${_FIRST_ARG} ${ARGN}) | |
if(FPHSA_UNPARSED_ARGUMENTS) | |
message(FATAL_ERROR "Unknown keywords given to FIND_PACKAGE_HANDLE_STANDARD_ARGS(): \"${FPHSA_UNPARSED_ARGUMENTS}\"") | |
endif() | |
if(NOT FPHSA_FAIL_MESSAGE) | |
set(FPHSA_FAIL_MESSAGE "DEFAULT_MSG") | |
endif() | |
endif() | |
# now that we collected all arguments, process them | |
if("x${FPHSA_FAIL_MESSAGE}" STREQUAL "xDEFAULT_MSG") | |
set(FPHSA_FAIL_MESSAGE "Could NOT find ${_NAME}") | |
endif() | |
# In config-mode, we rely on the variable <package>_CONFIG, which is set by find_package() | |
# when it successfully found the config-file, including version checking: | |
if(FPHSA_CONFIG_MODE) | |
list(INSERT FPHSA_REQUIRED_VARS 0 ${_NAME}_CONFIG) | |
list(REMOVE_DUPLICATES FPHSA_REQUIRED_VARS) | |
set(FPHSA_VERSION_VAR ${_NAME}_VERSION) | |
endif() | |
if(NOT FPHSA_REQUIRED_VARS) | |
message(FATAL_ERROR "No REQUIRED_VARS specified for FIND_PACKAGE_HANDLE_STANDARD_ARGS()") | |
endif() | |
list(GET FPHSA_REQUIRED_VARS 0 _FIRST_REQUIRED_VAR) | |
string(TOUPPER ${_NAME} _NAME_UPPER) | |
string(TOLOWER ${_NAME} _NAME_LOWER) | |
if(FPHSA_FOUND_VAR) | |
if(FPHSA_FOUND_VAR MATCHES "^${_NAME}_FOUND$" OR FPHSA_FOUND_VAR MATCHES "^${_NAME_UPPER}_FOUND$") | |
set(_FOUND_VAR ${FPHSA_FOUND_VAR}) | |
else() | |
message(FATAL_ERROR "The argument for FOUND_VAR is \"${FPHSA_FOUND_VAR}\", but only \"${_NAME}_FOUND\" and \"${_NAME_UPPER}_FOUND\" are valid names.") | |
endif() | |
else() | |
set(_FOUND_VAR ${_NAME_UPPER}_FOUND) | |
endif() | |
# collect all variables which were not found, so they can be printed, so the | |
# user knows better what went wrong (#6375) | |
set(MISSING_VARS "") | |
set(DETAILS "") | |
# check if all passed variables are valid | |
set(FPHSA_FOUND_${_NAME} TRUE) | |
foreach(_CURRENT_VAR ${FPHSA_REQUIRED_VARS}) | |
if(NOT ${_CURRENT_VAR}) | |
set(FPHSA_FOUND_${_NAME} FALSE) | |
string(APPEND MISSING_VARS " ${_CURRENT_VAR}") | |
else() | |
string(APPEND DETAILS "[${${_CURRENT_VAR}}]") | |
endif() | |
endforeach() | |
if(FPHSA_FOUND_${_NAME}) | |
set(${_NAME}_FOUND TRUE) | |
set(${_NAME_UPPER}_FOUND TRUE) | |
else() | |
set(${_NAME}_FOUND FALSE) | |
set(${_NAME_UPPER}_FOUND FALSE) | |
endif() | |
# component handling | |
unset(FOUND_COMPONENTS_MSG) | |
unset(MISSING_COMPONENTS_MSG) | |
if(FPHSA_HANDLE_COMPONENTS) | |
foreach(comp ${${_NAME}_FIND_COMPONENTS}) | |
if(${_NAME}_${comp}_FOUND) | |
if(NOT DEFINED FOUND_COMPONENTS_MSG) | |
set(FOUND_COMPONENTS_MSG "found components: ") | |
endif() | |
string(APPEND FOUND_COMPONENTS_MSG " ${comp}") | |
else() | |
if(NOT DEFINED MISSING_COMPONENTS_MSG) | |
set(MISSING_COMPONENTS_MSG "missing components: ") | |
endif() | |
string(APPEND MISSING_COMPONENTS_MSG " ${comp}") | |
if(${_NAME}_FIND_REQUIRED_${comp}) | |
set(${_NAME}_FOUND FALSE) | |
string(APPEND MISSING_VARS " ${comp}") | |
endif() | |
endif() | |
endforeach() | |
set(COMPONENT_MSG "${FOUND_COMPONENTS_MSG} ${MISSING_COMPONENTS_MSG}") | |
string(APPEND DETAILS "[c${COMPONENT_MSG}]") | |
endif() | |
# version handling: | |
set(VERSION_MSG "") | |
set(VERSION_OK TRUE) | |
set(VERSION ${${FPHSA_VERSION_VAR}}) | |
# check with DEFINED here as the requested or found version may be "0" | |
if (DEFINED ${_NAME}_FIND_VERSION) | |
if(DEFINED ${FPHSA_VERSION_VAR}) | |
if(${_NAME}_FIND_VERSION_EXACT) # exact version required | |
# count the dots in the version string | |
string(REGEX REPLACE "[^.]" "" _VERSION_DOTS "${VERSION}") | |
# add one dot because there is one dot more than there are components | |
string(LENGTH "${_VERSION_DOTS}." _VERSION_DOTS) | |
if (_VERSION_DOTS GREATER ${_NAME}_FIND_VERSION_COUNT) | |
# Because of the C++ implementation of find_package() ${_NAME}_FIND_VERSION_COUNT | |
# is at most 4 here. Therefore a simple lookup table is used. | |
if (${_NAME}_FIND_VERSION_COUNT EQUAL 1) | |
set(_VERSION_REGEX "[^.]*") | |
elseif (${_NAME}_FIND_VERSION_COUNT EQUAL 2) | |
set(_VERSION_REGEX "[^.]*\\.[^.]*") | |
elseif (${_NAME}_FIND_VERSION_COUNT EQUAL 3) | |
set(_VERSION_REGEX "[^.]*\\.[^.]*\\.[^.]*") | |
else () | |
set(_VERSION_REGEX "[^.]*\\.[^.]*\\.[^.]*\\.[^.]*") | |
endif () | |
string(REGEX REPLACE "^(${_VERSION_REGEX})\\..*" "\\1" _VERSION_HEAD "${VERSION}") | |
unset(_VERSION_REGEX) | |
if (NOT ${_NAME}_FIND_VERSION VERSION_EQUAL _VERSION_HEAD) | |
set(VERSION_MSG "Found unsuitable version \"${VERSION}\", but required is exact version \"${${_NAME}_FIND_VERSION}\"") | |
set(VERSION_OK FALSE) | |
else () | |
set(VERSION_MSG "(found suitable exact version \"${VERSION}\")") | |
endif () | |
unset(_VERSION_HEAD) | |
else () | |
if (NOT ${_NAME}_FIND_VERSION VERSION_EQUAL VERSION) | |
set(VERSION_MSG "Found unsuitable version \"${VERSION}\", but required is exact version \"${${_NAME}_FIND_VERSION}\"") | |
set(VERSION_OK FALSE) | |
else () | |
set(VERSION_MSG "(found suitable exact version \"${VERSION}\")") | |
endif () | |
endif () | |
unset(_VERSION_DOTS) | |
else() # minimum version specified: | |
if (${_NAME}_FIND_VERSION VERSION_GREATER VERSION) | |
set(VERSION_MSG "Found unsuitable version \"${VERSION}\", but required is at least \"${${_NAME}_FIND_VERSION}\"") | |
set(VERSION_OK FALSE) | |
else () | |
set(VERSION_MSG "(found suitable version \"${VERSION}\", minimum required is \"${${_NAME}_FIND_VERSION}\")") | |
endif () | |
endif() | |
else() | |
# if the package was not found, but a version was given, add that to the output: | |
if(${_NAME}_FIND_VERSION_EXACT) | |
set(VERSION_MSG "(Required is exact version \"${${_NAME}_FIND_VERSION}\")") | |
else() | |
set(VERSION_MSG "(Required is at least version \"${${_NAME}_FIND_VERSION}\")") | |
endif() | |
endif() | |
else () | |
if(VERSION) | |
set(VERSION_MSG "(found version \"${VERSION}\")") | |
endif() | |
endif () | |
if(VERSION_OK) | |
string(APPEND DETAILS "[v${VERSION}(${${_NAME}_FIND_VERSION})]") | |
else() | |
set(${_NAME}_FOUND FALSE) | |
endif() | |
# print the result: | |
if (${_NAME}_FOUND) | |
FIND_PACKAGE_MESSAGE(${_NAME} "Found ${_NAME}: ${${_FIRST_REQUIRED_VAR}} ${VERSION_MSG} ${COMPONENT_MSG}" "${DETAILS}") | |
else () | |
if(FPHSA_CONFIG_MODE) | |
_FPHSA_HANDLE_FAILURE_CONFIG_MODE() | |
else() | |
if(NOT VERSION_OK) | |
_FPHSA_FAILURE_MESSAGE("${FPHSA_FAIL_MESSAGE}: ${VERSION_MSG} (found ${${_FIRST_REQUIRED_VAR}})") | |
else() | |
_FPHSA_FAILURE_MESSAGE("${FPHSA_FAIL_MESSAGE} (missing: ${MISSING_VARS}) ${VERSION_MSG}") | |
endif() | |
endif() | |
endif () | |
set(${_NAME}_FOUND ${${_NAME}_FOUND} PARENT_SCOPE) | |
set(${_NAME_UPPER}_FOUND ${${_NAME}_FOUND} PARENT_SCOPE) | |
endfunction() |