aae13f4c8e
With the PURPOSE a project can state what the package in question
is used for in the project (as opposed to describing what the package
does in general).
TYPE can be one of OPTIONAL (default)
RUNTIME - not needed for building, only at runtime
RECOMMENDED - as OPTIONAL, but you should really have it
REQUIRED - cmake will fail if one of these is not found
This can be set using the new function set_package_properties()
Alex
372 lines
14 KiB
CMake
372 lines
14 KiB
CMake
# - Macros for generating a summary of enabled/disabled features
|
|
#
|
|
# This module provides the macros feature_summary(), set_package_info() and
|
|
# add_feature_info().
|
|
# For compatiblity it also still provides set_feature_info(),
|
|
# print_enabled_features() and print_disabled_features.
|
|
#
|
|
# These macros can be used to generate a summary of enabled and disabled
|
|
# packages and/or feature for a build tree:
|
|
#
|
|
# -- Enabled features:
|
|
# LibXml2 (required version >= 2.4) , XML processing library. , <http://xmlsoft.org>
|
|
# PNG , A PNG image library. , <http://www.libpng.org/pub/png/>
|
|
# -- Disabled features:
|
|
# Lua51 , The Lua scripting language. , <http://www.lua.org>
|
|
# Foo , Foo provides cool stuff.
|
|
#
|
|
#
|
|
# FEATURE_SUMMARY( [FILENAME <file>]
|
|
# [APPEND]
|
|
# [VAR <variable_name>]
|
|
# [DESCRIPTION "Found packages:"]
|
|
# WHAT (ALL | PACKAGES_FOUND | PACKAGES_NOT_FOUND
|
|
# | ENABLED_FEATURES | DISABLED_FEATURES]
|
|
# )
|
|
#
|
|
# The FEATURE_SUMMARY() macro can be used to print information about enabled
|
|
# or disabled features or packages of a project.
|
|
# By default, only the names of the features/packages will be printed and their
|
|
# required version when one was specified. Use SET_FEATURE_INFO() to add more
|
|
# useful information, like e.g. a download URL for the respective package.
|
|
#
|
|
# The WHAT option is the only mandatory option. Here you specify what information
|
|
# will be printed:
|
|
# ENABLED_FEATURES: the list of all features and packages which are enabled,
|
|
# excluding the QUIET packages
|
|
# DISABLED_FEATURES: the list of all features and packages which are disabled,
|
|
# excluding the QUIET packages
|
|
# PACKAGES_FOUND: the list of all packages which have been found
|
|
# PACKAGES_NOT_FOUND: the list of all packages which have not been found
|
|
# ALL: this will give all packages which have or have not been found
|
|
#
|
|
# If a FILENAME is given, the information is printed into this file. If APPEND
|
|
# is used, it is appended to this file, otherwise the file is overwritten if
|
|
# it already existed.
|
|
# If the VAR option is used, the information is "printed" into the specified
|
|
# variable.
|
|
# If FILENAME is not used, the information is printed to the terminal.
|
|
# Using the DESCRIPTION option a description or headline can be set which will
|
|
# be printed above the actual content.
|
|
#
|
|
# Example 1, append everything to a file:
|
|
# feature_summary(WHAT ALL
|
|
# FILENAME ${CMAKE_BINARY_DIR}/all.log APPEND)
|
|
#
|
|
# Example 2, print the enabled features into the variable enabledFeaturesText:
|
|
# feature_summary(WHAT ENABLED_FEATURES
|
|
# DESCRIPTION "Enabled Features:"
|
|
# VAR enabledFeaturesText)
|
|
# message(STATUS "${enabledFeaturesText}")
|
|
#
|
|
#
|
|
# SET_PACKAGE_INFO(<name> <description> [<url> [<comment>] ] )
|
|
# Use this macro to set up information about the named package, which can
|
|
# then be displayed via FEATURE_SUMMARY().
|
|
# This can be done either directly in the Find-module or in the project
|
|
# which uses the module after the FIND_PACKAGE() call.
|
|
# The features for which information can be set are added automatically by the
|
|
# find_package() command.
|
|
#
|
|
# Example for setting the info for a package:
|
|
# find_package(LibXml2)
|
|
# set_package_info(LibXml2 "XML processing library." "http://xmlsoft.org/")
|
|
#
|
|
# SET_PACKAGE_PROPERTIES(<name> PROPERTIES <description> [<url> [<purpose> [<type>] ] ] )
|
|
#
|
|
# URL: homepage of the package
|
|
# DESCRIPTION: short description of the package itself
|
|
# PURPOSE: what is the purpopse of using the package in the current project, always appended
|
|
# TYPE: OPTIONAL (default), RECOMMENDED, REQUIRED, RUNTIME
|
|
#
|
|
# ADD_FEATURE_INFO(<name> <enabled> <description>)
|
|
# Use this macro to add information about a feature with the given <name>.
|
|
# <enabled> contains whether this feature is enabled or not, <description>
|
|
# is a text descibing the feature.
|
|
# The information can be displayed using feature_summary() for ENABLED_FEATURES
|
|
# and DISABLED_FEATURES respectively.
|
|
#
|
|
# Example for setting the info for a feature:
|
|
# option(WITH_FOO "Help for foo" ON)
|
|
# add_feature_info(Foo WITH_FOO "The Foo feature provides very cool stuff.")
|
|
#
|
|
#
|
|
# The following macros are provided for compatibility with previous CMake versions:
|
|
#
|
|
# PRINT_ENABLED_FEATURES()
|
|
# Does the same as FEATURE_SUMMARY(WHAT ENABLED_FEATURES DESCRIPTION "Enabled features:")
|
|
#
|
|
# PRINT_DISABLED_FEATURES()
|
|
# Does the same as FEATURE_SUMMARY(WHAT DISABLED_FEATURES DESCRIPTION "Disabled features:")
|
|
#
|
|
# SET_FEATURE_INFO(<name> <description> [<url> [<comment>] ] )
|
|
# Does the same as SET_PACKAGE_INFO(<name> <description> <url> <comment> )
|
|
|
|
#=============================================================================
|
|
# Copyright 2007-2009 Kitware, Inc.
|
|
#
|
|
# Distributed under the OSI-approved BSD License (the "License");
|
|
# see accompanying file Copyright.txt for details.
|
|
#
|
|
# This software is distributed WITHOUT ANY WARRANTY; without even the
|
|
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
# See the License for more information.
|
|
#=============================================================================
|
|
# (To distribute this file outside of CMake, substitute the full
|
|
# License text for the above reference.)
|
|
|
|
INCLUDE(CMakeParseArguments)
|
|
|
|
|
|
FUNCTION(ADD_FEATURE_INFO _name _enabled _desc)
|
|
IF (${_enabled})
|
|
SET_PROPERTY(GLOBAL APPEND PROPERTY ENABLED_FEATURES "${_name}")
|
|
ELSE ()
|
|
SET_PROPERTY(GLOBAL APPEND PROPERTY DISABLED_FEATURES "${_name}")
|
|
ENDIF ()
|
|
|
|
SET_PROPERTY(GLOBAL PROPERTY _CMAKE_${_name}_DESCRIPTION "${_desc}" )
|
|
ENDFUNCTION(ADD_FEATURE_INFO)
|
|
|
|
|
|
FUNCTION(SET_FEATURE_INFO)
|
|
SET_PACKAGE_INFO(${ARGN})
|
|
ENDFUNCTION(SET_FEATURE_INFO)
|
|
|
|
|
|
FUNCTION(SET_PACKAGE_INFO _name _desc)
|
|
SET(_url "${ARGV2}")
|
|
SET(_comment "${ARGV3}")
|
|
SET_PROPERTY(GLOBAL PROPERTY _CMAKE_${_name}_DESCRIPTION "${_desc}" )
|
|
IF(_url MATCHES ".+")
|
|
SET_PROPERTY(GLOBAL PROPERTY _CMAKE_${_name}_URL "${_url}" )
|
|
ENDIF(_url MATCHES ".+")
|
|
IF(_comment MATCHES ".+")
|
|
SET_PROPERTY(GLOBAL PROPERTY _CMAKE_${_name}_COMMENT "${_comment}" )
|
|
ENDIF(_comment MATCHES ".+")
|
|
ENDFUNCTION(SET_PACKAGE_INFO)
|
|
|
|
|
|
|
|
FUNCTION(SET_PACKAGE_PROPERTIES _name _props)
|
|
IF(NOT "${_props}" STREQUAL "PROPERTIES")
|
|
MESSAGE(FATAL_ERROR "PROPERTIES keyword is missing in SET_PACKAGE_PROPERTIES() call.")
|
|
ENDIF()
|
|
|
|
SET(options ) # none
|
|
SET(oneValueArgs DESCRIPTION URL TYPE PURPOSE )
|
|
SET(multiValueArgs ) # none
|
|
|
|
CMAKE_PARSE_ARGUMENTS(_SPP "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
|
|
|
|
IF(_SPP_UNPARSED_ARGUMENTS)
|
|
MESSAGE(FATAL_ERROR "Unknown keywords given to SET_PACKAGE_PROPERTIES(): \"${_SPP_UNPARSED_ARGUMENTS}\"")
|
|
ENDIF()
|
|
|
|
IF(_SPP_DESCRIPTION)
|
|
GET_PROPERTY(_info GLOBAL PROPERTY _CMAKE_${_name}_DESCRIPTION)
|
|
IF(_info)
|
|
MESSAGE(STATUS "Warning: Property DESCRIPTION for package ${_name} already set to \"${_info}\", overriding it with \"${_SPP_DESCRIPTION}\"")
|
|
ENDIF()
|
|
|
|
SET_PROPERTY(GLOBAL PROPERTY _CMAKE_${_name}_DESCRIPTION "${_SPP_DESCRIPTION}" )
|
|
ENDIF()
|
|
|
|
|
|
IF(_SPP_URL)
|
|
GET_PROPERTY(_info GLOBAL PROPERTY _CMAKE_${_name}_URL)
|
|
IF(_info)
|
|
MESSAGE(STATUS "Warning: Property URL already set to \"${_info}\", overriding it with \"${_SPP_URL}\"")
|
|
ENDIF()
|
|
|
|
SET_PROPERTY(GLOBAL PROPERTY _CMAKE_${_name}_URL "${_SPP_URL}" )
|
|
ENDIF()
|
|
|
|
|
|
# handle the PURPOSE: use APPEND, since there can be multiple purposes for one package inside a project
|
|
IF(_SPP_PURPOSE)
|
|
SET_PROPERTY(GLOBAL APPEND PROPERTY _CMAKE_${_name}_PURPOSE "${_SPP_PURPOSE}" )
|
|
ENDIF()
|
|
|
|
# handle the TYPE
|
|
IF(NOT _SPP_TYPE)
|
|
SET(_SPP_TYPE OPTIONAL)
|
|
ENDIF()
|
|
|
|
SET(validTypes OPTIONAL RECOMMENDED REQUIRED RUNTIME )
|
|
LIST(FIND validTypes ${_SPP_TYPE} _typeIndexInList)
|
|
IF("${_typeIndexInList}" STREQUAL "-1" )
|
|
MESSAGE(FATAL_ERROR "Bad package property type ${_SPP_TYPE} used in SET_PACKAGE_PROPERTIES(). "
|
|
"Valid types are OPTIONAL, RECOMMENDED, REQUIRED and RUNTIME." )
|
|
ENDIF()
|
|
|
|
SET_PROPERTY(GLOBAL PROPERTY _CMAKE_${_name}_TYPE "${_SPP_TYPE}" )
|
|
|
|
ENDFUNCTION(SET_PACKAGE_PROPERTIES)
|
|
|
|
|
|
|
|
FUNCTION(_FS_GET_FEATURE_SUMMARY _property _var)
|
|
|
|
SET(_type "ANY")
|
|
IF("${_property}" MATCHES "REQUIRED_")
|
|
SET(_type "REQUIRED")
|
|
ELSEIF("${_property}" MATCHES "RECOMMENDED_")
|
|
SET(_type "RECOMMENDED")
|
|
ELSEIF("${_property}" MATCHES "RUNTIME_")
|
|
SET(_type "RUNTIME")
|
|
ELSEIF("${_property}" MATCHES "OPTIONAL_")
|
|
SET(_type "OPTIONAL")
|
|
ENDIF()
|
|
|
|
IF("${_property}" MATCHES "PACKAGES_FOUND")
|
|
SET(_property "PACKAGES_FOUND")
|
|
ELSEIF("${_property}" MATCHES "PACKAGES_NOT_FOUND")
|
|
SET(_property "PACKAGES_NOT_FOUND")
|
|
ENDIF()
|
|
|
|
|
|
SET(_currentFeatureText "")
|
|
GET_PROPERTY(_EnabledFeatures GLOBAL PROPERTY ${_property})
|
|
|
|
FOREACH(_currentFeature ${_EnabledFeatures})
|
|
|
|
# does this package belong to the type we currently want to list ?
|
|
GET_PROPERTY(_currentType GLOBAL PROPERTY _CMAKE_${_currentFeature}_TYPE)
|
|
IF(NOT _currentType)
|
|
SET(_currentType OPTIONAL)
|
|
ENDIF()
|
|
|
|
IF("${_type}" STREQUAL ANY OR "${_type}" STREQUAL "${_currentType}")
|
|
|
|
SET(_currentFeatureText "${_currentFeatureText}\n${_currentFeature}")
|
|
GET_PROPERTY(_info GLOBAL PROPERTY _CMAKE_${_currentFeature}_REQUIRED_VERSION)
|
|
IF(_info)
|
|
SET(_currentFeatureText "${_currentFeatureText} (required version ${_info})")
|
|
ENDIF(_info)
|
|
GET_PROPERTY(_info GLOBAL PROPERTY _CMAKE_${_currentFeature}_DESCRIPTION)
|
|
IF(_info)
|
|
SET(_currentFeatureText "${_currentFeatureText} , ${_info}")
|
|
ENDIF(_info)
|
|
GET_PROPERTY(_info GLOBAL PROPERTY _CMAKE_${_currentFeature}_URL)
|
|
IF(_info)
|
|
SET(_currentFeatureText "${_currentFeatureText} , <${_info}>")
|
|
ENDIF(_info)
|
|
GET_PROPERTY(_info GLOBAL PROPERTY _CMAKE_${_currentFeature}_COMMENT)
|
|
IF(_info)
|
|
SET(_currentFeatureText "${_currentFeatureText} , ${_info}")
|
|
ENDIF(_info)
|
|
|
|
GET_PROPERTY(_info GLOBAL PROPERTY _CMAKE_${_currentFeature}_PURPOSE)
|
|
FOREACH(_purpose ${_info})
|
|
SET(_currentFeatureText "${_currentFeatureText}\n * ${_purpose}")
|
|
ENDFOREACH()
|
|
|
|
ENDIF("${_type}" STREQUAL ANY OR "${_type}" STREQUAL "${_currentType}")
|
|
|
|
ENDFOREACH(_currentFeature)
|
|
SET(${_var} "${_currentFeatureText}" PARENT_SCOPE)
|
|
ENDFUNCTION(_FS_GET_FEATURE_SUMMARY)
|
|
|
|
|
|
FUNCTION(PRINT_ENABLED_FEATURES)
|
|
FEATURE_SUMMARY(WHAT ENABLED_FEATURES DESCRIPTION "Enabled features:")
|
|
ENDFUNCTION(PRINT_ENABLED_FEATURES)
|
|
|
|
|
|
FUNCTION(PRINT_DISABLED_FEATURES)
|
|
FEATURE_SUMMARY(WHAT DISABLED_FEATURES DESCRIPTION "Disabled features:")
|
|
ENDFUNCTION(PRINT_DISABLED_FEATURES)
|
|
|
|
|
|
|
|
FUNCTION(FEATURE_SUMMARY)
|
|
# CMAKE_PARSE_ARGUMENTS(<prefix> <options> <one_value_keywords> <multi_value_keywords> args...)
|
|
SET(options APPEND)
|
|
SET(oneValueArgs FILENAME VAR DESCRIPTION WHAT)
|
|
SET(multiValueArgs ) # none
|
|
|
|
CMAKE_PARSE_ARGUMENTS(_FS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${_FIRST_ARG} ${ARGN})
|
|
|
|
IF(_FS_UNPARSED_ARGUMENTS)
|
|
MESSAGE(FATAL_ERROR "Unknown keywords given to FEATURE_SUMMARY(): \"${_FS_UNPARSED_ARGUMENTS}\"")
|
|
ENDIF(_FS_UNPARSED_ARGUMENTS)
|
|
|
|
IF(NOT _FS_WHAT)
|
|
MESSAGE(FATAL_ERROR "The call to FEATURE_SUMMAY() doesn't set the required WHAT argument.")
|
|
ENDIF(NOT _FS_WHAT)
|
|
|
|
SET(validWhatParts "ENABLED_FEATURES"
|
|
"DISABLED_FEATURES"
|
|
"PACKAGES_FOUND"
|
|
"PACKAGES_NOT_FOUND"
|
|
"OPTIONAL_PACKAGES_FOUND"
|
|
"OPTIONAL_PACKAGES_NOT_FOUND"
|
|
"RECOMMENDED_PACKAGES_FOUND"
|
|
"RECOMMENDED_PACKAGES_NOT_FOUND"
|
|
"REQUIRED_PACKAGES_FOUND"
|
|
"REQUIRED_PACKAGES_NOT_FOUND"
|
|
"RUNTIME_PACKAGES_FOUND"
|
|
"RUNTIME_PACKAGES_NOT_FOUND")
|
|
|
|
LIST(FIND validWhatParts "${_FS_WHAT}" indexInList)
|
|
IF(NOT "${indexInList}" STREQUAL "-1")
|
|
_FS_GET_FEATURE_SUMMARY( ${_FS_WHAT} _featureSummary)
|
|
SET(_fullText "${_FS_DESCRIPTION}${_featureSummary}\n")
|
|
ELSEIF("${_FS_WHAT}" STREQUAL "ALL")
|
|
|
|
SET(allWhatParts "ENABLED_FEATURES"
|
|
"RUNTIME_PACKAGES_FOUND"
|
|
"OPTIONAL_PACKAGES_FOUND"
|
|
"RECOMMENDED_PACKAGES_FOUND"
|
|
"REQUIRED_PACKAGES_FOUND"
|
|
|
|
"DISABLED_FEATURES"
|
|
"RUNTIME_PACKAGES_NOT_FOUND"
|
|
"OPTIONAL_PACKAGES_NOT_FOUND"
|
|
"RECOMMENDED_PACKAGES_NOT_FOUND"
|
|
"REQUIRED_PACKAGES_NOT_FOUND"
|
|
)
|
|
|
|
SET(title_ENABLED_FEATURES "The following features have been enabled:")
|
|
SET(title_DISABLED_FEATURES "The following features have been disabled:")
|
|
SET(title_OPTIONAL_PACKAGES_FOUND "The following OPTIONAL packages have been found:")
|
|
SET(title_OPTIONAL_PACKAGES_NOT_FOUND "The following OPTIONAL packages have not been found:")
|
|
SET(title_RECOMMENDED_PACKAGES_FOUND "The following RECOMMENDED packages have been found:")
|
|
SET(title_RECOMMENDED_PACKAGES_NOT_FOUND "The following RECOMMENDED packages have not been found:")
|
|
SET(title_REQUIRED_PACKAGES_FOUND "The following REQUIRED packages have been found:")
|
|
SET(title_REQUIRED_PACKAGES_NOT_FOUND "The following REQUIRED packages have not been found:")
|
|
SET(title_RUNTIME_PACKAGES_FOUND "The following RUNTIME packages have been found:")
|
|
SET(title_RUNTIME_PACKAGES_NOT_FOUND "The following RUNTIME packages have not been found:")
|
|
|
|
SET(_fullText "${_FS_DESCRIPTION}\n")
|
|
FOREACH(part ${allWhatParts})
|
|
SET(_tmp)
|
|
_FS_GET_FEATURE_SUMMARY( ${part} _tmp)
|
|
IF(_tmp)
|
|
SET(_fullText "${_fullText}\n${title_${part}}\n${_tmp}")
|
|
ENDIF()
|
|
ENDFOREACH()
|
|
ELSE()
|
|
MESSAGE(FATAL_ERROR "The WHAT argument of FEATURE_SUMMARY() is set to ${_FS_WHAT}, which is not a valid value.")
|
|
ENDIF()
|
|
|
|
IF(_FS_FILENAME)
|
|
IF(_FS_APPEND)
|
|
FILE(APPEND "${_FS_FILENAME}" "${_fullText}")
|
|
ELSE(_FS_APPEND)
|
|
FILE(WRITE "${_FS_FILENAME}" "${_fullText}")
|
|
ENDIF(_FS_APPEND)
|
|
|
|
ELSE(_FS_FILENAME)
|
|
IF(NOT _FS_VAR)
|
|
MESSAGE(STATUS "${_fullText}")
|
|
ENDIF(NOT _FS_VAR)
|
|
ENDIF(_FS_FILENAME)
|
|
|
|
IF(_FS_VAR)
|
|
SET(${_FS_VAR} "${_fullText}" PARENT_SCOPE)
|
|
ENDIF(_FS_VAR)
|
|
|
|
ENDFUNCTION(FEATURE_SUMMARY)
|