|
|
@@ -20,18 +20,24 @@
|
|
|
# The second mode is more powerful and also supports version checking:
|
|
|
# FIND_PACKAGE_HANDLE_STANDARD_ARGS(NAME [REQUIRED_VARS <var1>...<varN>]
|
|
|
# [VERSION_VAR <versionvar>
|
|
|
+# [CONFIG_MODE]
|
|
|
# [FAIL_MESSAGE "Custom failure message"] )
|
|
|
#
|
|
|
# As above, if <var1> through <varN> are all valid, <UPPERCASED_NAME>_FOUND
|
|
|
# will be set to TRUE.
|
|
|
-# Via FAIL_MESSAGE a custom failure message can be specified, if this is not
|
|
|
-# used, the default message will be displayed.
|
|
|
+# After REQUIRED_VARS the variables which are required for this package are listed.
|
|
|
# Following VERSION_VAR the name of the variable can be specified which holds
|
|
|
# the version of the package which has been found. If this is done, this version
|
|
|
# will be checked against the (potentially) specified required version used
|
|
|
# in the find_package() call. The EXACT keyword is also handled. 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.
|
|
|
+# Use the option CONFIG_MODE if your FindXXX.cmake module is a wrapper for
|
|
|
+# a find_package(... NO_MODULE) call, in this case all the information
|
|
|
+# provided by the config-mode of find_package() will be evaluated
|
|
|
+# automatically.
|
|
|
+# Via FAIL_MESSAGE a custom failure message can be specified, if this is not
|
|
|
+# used, the default message will be displayed.
|
|
|
#
|
|
|
# Example for mode 1:
|
|
|
#
|
|
|
@@ -53,6 +59,15 @@
|
|
|
# Also the version of BISON will be checked by using the version contained
|
|
|
# in BISON_VERSION.
|
|
|
# Since no FAIL_MESSAGE is given, the default messages will be printed.
|
|
|
+#
|
|
|
+# Another example for mode 2:
|
|
|
+#
|
|
|
+# FIND_PACKAGE(Automoc4 QUIET NO_MODULE HINTS /opt/automoc4)
|
|
|
+# FIND_PACKAGE_HANDLE_STANDARD_ARGS(Automoc4 CONFIG_MODE)
|
|
|
+# In this case, FindAutmoc4.cmake wraps a call to FIND_PACKAGE(Automoc4 NO_MODULE)
|
|
|
+# and adds an additional search directory for automoc4.
|
|
|
+# The following FIND_PACKAGE_HANDLE_STANDARD_ARGS() call produces a proper
|
|
|
+# success/error message.
|
|
|
|
|
|
#=============================================================================
|
|
|
# Copyright 2007-2009 Kitware, Inc.
|
|
|
@@ -70,12 +85,50 @@
|
|
|
INCLUDE(FindPackageMessage)
|
|
|
INCLUDE(CMakeParseArguments)
|
|
|
|
|
|
-
|
|
|
-FUNCTION(FIND_PACKAGE_HANDLE_STANDARD_ARGS _NAME _FIRST_ARG _VAR1)
|
|
|
+# internal helper macro
|
|
|
+MACRO(_FPHSA_FAILURE_MESSAGE _msg)
|
|
|
+ IF (${_NAME}_FIND_REQUIRED)
|
|
|
+ MESSAGE(FATAL_ERROR "${_msg}")
|
|
|
+ ELSE (${_NAME}_FIND_REQUIRED)
|
|
|
+ IF (NOT ${_NAME}_FIND_QUIETLY)
|
|
|
+ MESSAGE(STATUS "${_msg}")
|
|
|
+ ENDIF (NOT ${_NAME}_FIND_QUIETLY)
|
|
|
+ ENDIF (${_NAME}_FIND_REQUIRED)
|
|
|
+ENDMACRO(_FPHSA_FAILURE_MESSAGE _msg)
|
|
|
+
|
|
|
+
|
|
|
+# 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(${_NAME}_CONFIG)
|
|
|
+ # 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)
|
|
|
+ SET(configsText "${configsText} ${filename} (version ${version})\n")
|
|
|
+ ENDFOREACH(currentConfigIndex)
|
|
|
+ _FPHSA_FAILURE_MESSAGE("${FPHSA_FAIL_MESSAGE} ${VERSION_MSG}, checked the following files:\n${configsText}")
|
|
|
+
|
|
|
+ ELSE(${_NAME}_CONSIDERED_CONFIGS)
|
|
|
+ # 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(${_NAME}_CONSIDERED_CONFIGS)
|
|
|
+ ENDIF(${_NAME}_CONFIG)
|
|
|
+ENDMACRO(_FPHSA_HANDLE_FAILURE_CONFIG_MODE)
|
|
|
+
|
|
|
+
|
|
|
+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) # none
|
|
|
+ SET(options CONFIG_MODE)
|
|
|
SET(oneValueArgs FAIL_MESSAGE VERSION_VAR)
|
|
|
SET(multiValueArgs REQUIRED_VARS)
|
|
|
SET(_KEYWORDS_FOR_EXTENDED_MODE ${options} ${oneValueArgs} ${multiValueArgs} )
|
|
|
@@ -83,11 +136,11 @@ FUNCTION(FIND_PACKAGE_HANDLE_STANDARD_ARGS _NAME _FIRST_ARG _VAR1)
|
|
|
|
|
|
IF(${INDEX} EQUAL -1)
|
|
|
SET(FPHSA_FAIL_MESSAGE ${_FIRST_ARG})
|
|
|
- SET(FPHSA_REQUIRED_VARS ${_VAR1} ${ARGN})
|
|
|
+ SET(FPHSA_REQUIRED_VARS ${ARGN})
|
|
|
SET(FPHSA_VERSION_VAR)
|
|
|
ELSE(${INDEX} EQUAL -1)
|
|
|
|
|
|
- CMAKE_PARSE_ARGUMENTS(FPHSA "${options}" "${oneValueArgs}" "${multiValueArgs}" ${_FIRST_ARG} ${_VAR1} ${ARGN})
|
|
|
+ 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}\"")
|
|
|
@@ -104,6 +157,14 @@ FUNCTION(FIND_PACKAGE_HANDLE_STANDARD_ARGS _NAME _FIRST_ARG _VAR1)
|
|
|
SET(FPHSA_FAIL_MESSAGE "Could NOT find ${_NAME}")
|
|
|
ENDIF("${FPHSA_FAIL_MESSAGE}" STREQUAL "DEFAULT_MSG")
|
|
|
|
|
|
+ # 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(FPHSA_CONFIG_MODE)
|
|
|
+
|
|
|
IF(NOT FPHSA_REQUIRED_VARS)
|
|
|
MESSAGE(FATAL_ERROR "No REQUIRED_VARS specified for FIND_PACKAGE_HANDLE_STANDARD_ARGS()")
|
|
|
ENDIF(NOT FPHSA_REQUIRED_VARS)
|
|
|
@@ -111,8 +172,9 @@ FUNCTION(FIND_PACKAGE_HANDLE_STANDARD_ARGS _NAME _FIRST_ARG _VAR1)
|
|
|
LIST(GET FPHSA_REQUIRED_VARS 0 _FIRST_REQUIRED_VAR)
|
|
|
|
|
|
STRING(TOUPPER ${_NAME} _NAME_UPPER)
|
|
|
+ STRING(TOLOWER ${_NAME} _NAME_LOWER)
|
|
|
|
|
|
- # collect all variables which were not found, so they can be printed, so the
|
|
|
+ # 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 "")
|
|
|
@@ -131,44 +193,42 @@ FUNCTION(FIND_PACKAGE_HANDLE_STANDARD_ARGS _NAME _FIRST_ARG _VAR1)
|
|
|
# version handling:
|
|
|
SET(VERSION_MSG "")
|
|
|
SET(VERSION_OK TRUE)
|
|
|
+ SET(VERSION ${${FPHSA_VERSION_VAR}} )
|
|
|
IF (${_NAME}_FIND_VERSION)
|
|
|
|
|
|
- # if the package was found, check for the version using <NAME>_FIND_VERSION
|
|
|
- IF (${_NAME_UPPER}_FOUND)
|
|
|
- SET(VERSION ${${FPHSA_VERSION_VAR}} )
|
|
|
-
|
|
|
- IF(VERSION)
|
|
|
-
|
|
|
- IF(${_NAME}_FIND_VERSION_EXACT) # exact version required
|
|
|
- IF (NOT "${${_NAME}_FIND_VERSION}" VERSION_EQUAL "${VERSION}")
|
|
|
- SET(VERSION_MSG " Found version \"${VERSION}\", but required is exact version \"${${_NAME}_FIND_VERSION}\"")
|
|
|
- SET(VERSION_OK FALSE)
|
|
|
- ELSE (NOT "${${_NAME}_FIND_VERSION}" VERSION_EQUAL "${VERSION}")
|
|
|
- SET(VERSION_MSG " (found exact version \"${VERSION}\")")
|
|
|
- ENDIF (NOT "${${_NAME}_FIND_VERSION}" VERSION_EQUAL "${VERSION}")
|
|
|
-
|
|
|
- ELSE(${_NAME}_FIND_VERSION_EXACT) # minimum version specified:
|
|
|
- IF ("${${_NAME}_FIND_VERSION}" VERSION_GREATER "${VERSION}")
|
|
|
- SET(VERSION_MSG " Found version \"${VERSION}\", but required is at least \"${${_NAME}_FIND_VERSION}\"")
|
|
|
- SET(VERSION_OK FALSE)
|
|
|
- ELSE ("${${_NAME}_FIND_VERSION}" VERSION_GREATER "${VERSION}")
|
|
|
- SET(VERSION_MSG " (found version \"${VERSION}\", required is \"${${_NAME}_FIND_VERSION}\")")
|
|
|
- ENDIF ("${${_NAME}_FIND_VERSION}" VERSION_GREATER "${VERSION}")
|
|
|
- ENDIF(${_NAME}_FIND_VERSION_EXACT)
|
|
|
-
|
|
|
-# Uncomment the following two lines to see to which Find-modules the VERSION_VAR keywords still need to be added:
|
|
|
-# ELSE(VERSION)
|
|
|
-# SET(VERSION_MSG " (WARNING: Required version is \"${${_NAME}_FIND_VERSION}\", but version of ${_NAME} is unknown)")
|
|
|
- ENDIF(VERSION)
|
|
|
-
|
|
|
- # if the package was not found, but a version was given, add that to the output:
|
|
|
- ELSE (${_NAME_UPPER}_FOUND)
|
|
|
+ IF(VERSION)
|
|
|
+
|
|
|
+ IF(${_NAME}_FIND_VERSION_EXACT) # exact version required
|
|
|
+ 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 (NOT "${${_NAME}_FIND_VERSION}" VERSION_EQUAL "${VERSION}")
|
|
|
+ SET(VERSION_MSG "(found suitable exact version \"${VERSION}\")")
|
|
|
+ ENDIF (NOT "${${_NAME}_FIND_VERSION}" VERSION_EQUAL "${VERSION}")
|
|
|
+
|
|
|
+ ELSE(${_NAME}_FIND_VERSION_EXACT) # 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 ("${${_NAME}_FIND_VERSION}" VERSION_GREATER "${VERSION}")
|
|
|
+ SET(VERSION_MSG "(found suitable version \"${VERSION}\", required is \"${${_NAME}_FIND_VERSION}\")")
|
|
|
+ ENDIF ("${${_NAME}_FIND_VERSION}" VERSION_GREATER "${VERSION}")
|
|
|
+ ENDIF(${_NAME}_FIND_VERSION_EXACT)
|
|
|
+
|
|
|
+ ELSE(VERSION)
|
|
|
+
|
|
|
+ # 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}\")")
|
|
|
+ SET(VERSION_MSG "(Required is exact version \"${${_NAME}_FIND_VERSION}\")")
|
|
|
ELSE(${_NAME}_FIND_VERSION_EXACT)
|
|
|
- SET(VERSION_MSG " (Required is at least version \"${${_NAME}_FIND_VERSION}\")")
|
|
|
+ SET(VERSION_MSG "(Required is at least version \"${${_NAME}_FIND_VERSION}\")")
|
|
|
ENDIF(${_NAME}_FIND_VERSION_EXACT)
|
|
|
- ENDIF (${_NAME_UPPER}_FOUND)
|
|
|
+
|
|
|
+ ENDIF(VERSION)
|
|
|
+ ELSE (${_NAME}_FIND_VERSION)
|
|
|
+ IF(VERSION)
|
|
|
+ SET(VERSION_MSG "(found version \"${VERSION}\")")
|
|
|
+ ENDIF(VERSION)
|
|
|
ENDIF (${_NAME}_FIND_VERSION)
|
|
|
|
|
|
IF(VERSION_OK)
|
|
|
@@ -182,26 +242,16 @@ FUNCTION(FIND_PACKAGE_HANDLE_STANDARD_ARGS _NAME _FIRST_ARG _VAR1)
|
|
|
IF (${_NAME_UPPER}_FOUND)
|
|
|
FIND_PACKAGE_MESSAGE(${_NAME} "Found ${_NAME}: ${${_FIRST_REQUIRED_VAR}} ${VERSION_MSG}" "${DETAILS}")
|
|
|
ELSE (${_NAME_UPPER}_FOUND)
|
|
|
- IF(NOT VERSION_OK)
|
|
|
-
|
|
|
- IF (${_NAME}_FIND_REQUIRED)
|
|
|
- MESSAGE(FATAL_ERROR "${FPHSA_FAIL_MESSAGE}: ${VERSION_MSG} (found ${${_FIRST_REQUIRED_VAR}})")
|
|
|
- ELSE (${_NAME}_FIND_REQUIRED)
|
|
|
- IF (NOT ${_NAME}_FIND_QUIETLY)
|
|
|
- MESSAGE(STATUS "${FPHSA_FAIL_MESSAGE}: ${VERSION_MSG} (found ${${_FIRST_REQUIRED_VAR}})")
|
|
|
- ENDIF (NOT ${_NAME}_FIND_QUIETLY)
|
|
|
- ENDIF (${_NAME}_FIND_REQUIRED)
|
|
|
-
|
|
|
- ELSE(NOT VERSION_OK)
|
|
|
-
|
|
|
- IF (${_NAME}_FIND_REQUIRED)
|
|
|
- MESSAGE(FATAL_ERROR "${FPHSA_FAIL_MESSAGE} (missing: ${MISSING_VARS}) ${VERSION_MSG}")
|
|
|
- ELSE (${_NAME}_FIND_REQUIRED)
|
|
|
- IF (NOT ${_NAME}_FIND_QUIETLY)
|
|
|
- MESSAGE(STATUS "${FPHSA_FAIL_MESSAGE} (missing: ${MISSING_VARS}) ${VERSION_MSG}")
|
|
|
- ENDIF (NOT ${_NAME}_FIND_QUIETLY)
|
|
|
- ENDIF (${_NAME}_FIND_REQUIRED)
|
|
|
- ENDIF(NOT VERSION_OK)
|
|
|
+
|
|
|
+ IF(FPHSA_CONFIG_MODE)
|
|
|
+ _FPHSA_HANDLE_FAILURE_CONFIG_MODE()
|
|
|
+ ELSE(FPHSA_CONFIG_MODE)
|
|
|
+ IF(NOT VERSION_OK)
|
|
|
+ _FPHSA_FAILURE_MESSAGE("${FPHSA_FAIL_MESSAGE}: ${VERSION_MSG} (found ${${_FIRST_REQUIRED_VAR}})")
|
|
|
+ ELSE(NOT VERSION_OK)
|
|
|
+ _FPHSA_FAILURE_MESSAGE("${FPHSA_FAIL_MESSAGE} (missing: ${MISSING_VARS}) ${VERSION_MSG}")
|
|
|
+ ENDIF(NOT VERSION_OK)
|
|
|
+ ENDIF(FPHSA_CONFIG_MODE)
|
|
|
|
|
|
ENDIF (${_NAME_UPPER}_FOUND)
|
|
|
|