diff options
Diffstat (limited to '3.8.2/share/cmake-3.8/Modules/FeatureSummary.cmake')
| -rw-r--r-- | 3.8.2/share/cmake-3.8/Modules/FeatureSummary.cmake | 708 |
1 files changed, 0 insertions, 708 deletions
diff --git a/3.8.2/share/cmake-3.8/Modules/FeatureSummary.cmake b/3.8.2/share/cmake-3.8/Modules/FeatureSummary.cmake deleted file mode 100644 index f29a5f0..0000000 --- a/3.8.2/share/cmake-3.8/Modules/FeatureSummary.cmake +++ /dev/null @@ -1,708 +0,0 @@ -# Distributed under the OSI-approved BSD 3-Clause License. See accompanying -# file Copyright.txt or https://cmake.org/licensing for details. - -#[=======================================================================[.rst: -FeatureSummary --------------- - -Functions for generating a summary of enabled/disabled features. - -These functions can be used to generate a summary of enabled and disabled -packages and/or feature for a build tree such as:: - - -- The following OPTIONAL packages have been found: - LibXml2 (required version >= 2.4), XML processing lib, <http://xmlsoft.org> - * Enables HTML-import in MyWordProcessor - * Enables odt-export in MyWordProcessor - PNG, A PNG image library., <http://www.libpng.org/pub/png/> - * Enables saving screenshots - -- The following OPTIONAL packages have not been found: - Lua51, The Lua scripting language., <http://www.lua.org> - * Enables macros in MyWordProcessor - Foo, Foo provides cool stuff. - -Global Properties -^^^^^^^^^^^^^^^^^ - -.. variable:: FeatureSummary_PKG_TYPES - -The global property :variable:`FeatureSummary_PKG_TYPES` defines the type of -packages used by `FeatureSummary`. - -The order in this list is important, the first package type in the list is the -least important, the last is the most important. the of a package can only be -changed to higher types. - -The default package types are , ``RUNTIME``, ``OPTIONAL``, ``RECOMMENDED`` and -``REQUIRED``, and their importance is -``RUNTIME < OPTIONAL < RECOMMENDED < REQUIRED``. - - -.. variable:: FeatureSummary_REQUIRED_PKG_TYPES - -The global property :variable:`FeatureSummary_REQUIRED_PKG_TYPES` defines which -package types are required. - -If one or more package in this categories has not been found, CMake will abort -when calling :command:`feature_summary` with the -'FATAL_ON_MISSING_REQUIRED_PACKAGES' option enabled. - -The default value for this global property is ``REQUIRED``. - - -.. variable:: FeatureSummary_DEFAULT_PKG_TYPE - -The global property :variable:`FeatureSummary_DEFAULT_PKG_TYPE` defines which -package type is the default one. -When calling :command:`feature_summary`, if the user did not set the package type -explicitly, the package will be assigned to this category. - -This value must be one of the types defined in the -:variable:`FeatureSummary_PKG_TYPES` global property unless the package type -is set for all the packages. - -The default value for this global property is ``OPTIONAL``. - -#]=======================================================================] - -get_property(_fsPkgTypeIsSet GLOBAL PROPERTY FeatureSummary_PKG_TYPES SET) -if(NOT _fsPkgTypeIsSet) - set_property(GLOBAL PROPERTY FeatureSummary_PKG_TYPES RUNTIME OPTIONAL RECOMMENDED REQUIRED) -endif() - -get_property(_fsReqPkgTypesIsSet GLOBAL PROPERTY FeatureSummary_REQUIRED_PKG_TYPES SET) -if(NOT _fsReqPkgTypesIsSet) - set_property(GLOBAL PROPERTY FeatureSummary_REQUIRED_PKG_TYPES REQUIRED) -endif() - -get_property(_fsDefaultPkgTypeIsSet GLOBAL PROPERTY FeatureSummary_DEFAULT_PKG_TYPE SET) -if(NOT _fsDefaultPkgTypeIsSet) - set_property(GLOBAL PROPERTY FeatureSummary_DEFAULT_PKG_TYPE OPTIONAL) -endif() - -#[=======================================================================[.rst: - -Functions -^^^^^^^^^ - -#]=======================================================================] - -include(CMakeParseArguments) - -function(_FS_GET_FEATURE_SUMMARY _property _var _includeQuiet) - - get_property(_fsPkgTypes GLOBAL PROPERTY FeatureSummary_PKG_TYPES) - get_property(_fsDefaultPkgType GLOBAL PROPERTY FeatureSummary_DEFAULT_PKG_TYPE) - - set(_type "ANY") - foreach(_fsPkgType ${_fsPkgTypes}) - if("${_property}" MATCHES "${_fsPkgType}_PACKAGES_(NOT_)?FOUND") - set(_type "${_fsPkgType}") - break() - endif() - endforeach() - - 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}) - if(_EnabledFeatures) - list(REMOVE_DUPLICATES _EnabledFeatures) - endif(_EnabledFeatures) - - 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) - list(FIND _fsPkgTypes "${_fsDefaultPkgType}" _defaultInPkgTypes) - if("${_defaultInPkgTypes}" STREQUAL "-1") - string(REGEX REPLACE ";([^;]+)$" " and \\1" _fsPkgTypes_msg "${_fsPkgTypes}") - string(REPLACE ";" ", " _fsPkgTypes_msg "${_fsPkgTypes_msg}") - message(FATAL_ERROR "Bad package property type ${_fsDefaultPkgType} used in global property FeatureSummary_DEFAULT_PKG_TYPE. " - "Valid types are ${_fsPkgTypes_msg}. " - "Either update FeatureSummary_DEFAULT_PKG_TYPE or add ${_fsDefaultPkgType} to the FeatureSummary_PKG_TYPES global property.") - endif() - set(_currentType ${_fsDefaultPkgType}) - endif() - - if("${_type}" STREQUAL ANY OR "${_type}" STREQUAL "${_currentType}") - # check whether the current feature/package should be in the output depending on whether it was QUIET or not - set(includeThisOne TRUE) - set(_required FALSE) - # skip QUIET packages, except if they are REQUIRED or INCLUDE_QUIET_PACKAGES has been set - get_property(_fsReqPkgTypes GLOBAL PROPERTY FeatureSummary_REQUIRED_PKG_TYPES) - foreach(_fsReqPkgType ${_fsReqPkgTypes}) - if("${_currentType}" STREQUAL "${_fsReqPkgType}") - set(_required TRUE) - break() - endif() - endforeach() - if(NOT _required AND NOT _includeQuiet) - get_property(_isQuiet GLOBAL PROPERTY _CMAKE_${_currentFeature}_QUIET) - if(_isQuiet) - set(includeThisOne FALSE) - endif() - endif() - get_property(_isTransitiveDepend - GLOBAL PROPERTY _CMAKE_${_currentFeature}_TRANSITIVE_DEPENDENCY - ) - if(_isTransitiveDepend) - set(includeThisOne FALSE) - endif() - - if(includeThisOne) - - string(APPEND _currentFeatureText "\n * ${_currentFeature}") - get_property(_info GLOBAL PROPERTY _CMAKE_${_currentFeature}_REQUIRED_VERSION) - if(_info) - string(APPEND _currentFeatureText " (required version ${_info})") - endif() - get_property(_info GLOBAL PROPERTY _CMAKE_${_currentFeature}_DESCRIPTION) - if(_info) - string(APPEND _currentFeatureText ", ${_info}") - endif() - get_property(_info GLOBAL PROPERTY _CMAKE_${_currentFeature}_URL) - if(_info) - string(APPEND _currentFeatureText ", <${_info}>") - endif() - - get_property(_info GLOBAL PROPERTY _CMAKE_${_currentFeature}_PURPOSE) - foreach(_purpose ${_info}) - string(APPEND _currentFeatureText "\n ${_purpose}") - endforeach() - - endif() - - endif() - - endforeach() - set(${_var} "${_currentFeatureText}" PARENT_SCOPE) -endfunction() - - -#[=======================================================================[.rst: -.. command:: feature_summary - - :: - - feature_summary( [FILENAME <file>] - [APPEND] - [VAR <variable_name>] - [INCLUDE_QUIET_PACKAGES] - [FATAL_ON_MISSING_REQUIRED_PACKAGES] - [DESCRIPTION "<description>"] - [QUIET_ON_EMPTY] - WHAT (ALL - | PACKAGES_FOUND | PACKAGES_NOT_FOUND - | <TYPE>_PACKAGES_FOUND | <TYPE>_PACKAGES_NOT_FOUND - | ENABLED_FEATURES | DISABLED_FEATURES) - ) - - The ``feature_summary()`` macro can be used to print information about - enabled or disabled packages or features 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_package_properties()`` - to add more useful information, like e.g. a download URL for the - respective package or their purpose in the project. - - The ``WHAT`` option is the only mandatory option. Here you specify what - information will be printed: - - ``ALL`` - print everything - ``ENABLED_FEATURES`` - the list of all features which are enabled - ``DISABLED_FEATURES`` - the list of all features which are disabled - ``PACKAGES_FOUND`` - the list of all packages which have been found - ``PACKAGES_NOT_FOUND`` - the list of all packages which have not been found - - For each package type ``<TYPE>`` defined by the - :variable:`FeatureSummary_PKG_TYPES` global property, the following - information can also be used: - - ``<TYPE>_PACKAGES_FOUND`` - only those packages which have been found which have the type <TYPE> - ``<TYPE>_PACKAGES_NOT_FOUND`` - only those packages which have not been found which have the type <TYPE> - - With the exception of the ``ALL`` value, these values can be combined - in order to customize the output. For example: - - .. code-block:: cmake - - feature_summary(WHAT ENABLED_FEATURES DISABLED_FEATURES) - - 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. - If ``INCLUDE_QUIET_PACKAGES`` is given, packages which have been searched with - ``find_package(... QUIET)`` will also be listed. By default they are skipped. - If ``FATAL_ON_MISSING_REQUIRED_PACKAGES`` is given, CMake will abort if a - package which is marked as one of the package types listed in the - :variable:`FeatureSummary_REQUIRED_PKG_TYPES` global property has not been - found. - The default value for the :variable:`FeatureSummary_REQUIRED_PKG_TYPES` global - property is ``REQUIRED``. - - The :variable:`FeatureSummary_DEFAULT_PKG_TYPE` global property can be - modified to change the default package type assigned when not explicitly - assigned by the user. - - If the ``QUIET_ON_EMPTY`` option is used, if only one type of package was - requested, and no packages belonging to that category were found, then no - output (including the ``DESCRIPTION``) is printed or added to the ``VAR`` - variable. - - Example 1, append everything to a file: - - .. code-block:: cmake - - include(FeatureSummary) - feature_summary(WHAT ALL - FILENAME ${CMAKE_BINARY_DIR}/all.log APPEND) - - Example 2, print the enabled features into the variable - enabledFeaturesText, including QUIET packages: - - .. code-block:: cmake - - include(FeatureSummary) - feature_summary(WHAT ENABLED_FEATURES - INCLUDE_QUIET_PACKAGES - DESCRIPTION "Enabled Features:" - VAR enabledFeaturesText) - message(STATUS "${enabledFeaturesText}") - - Example 3, change default package types and print only the categories that - are not empty: - - .. code-block:: cmake - - include(FeatureSummary) - set_property(GLOBAL APPEND PROPERTY FeatureSummary_PKG_TYPES BUILD) - find_package(FOO) - set_package_properties(FOO PROPERTIES TYPE BUILD) - feature_summary(WHAT BUILD_PACKAGES_FOUND - Description "Build tools found:" - QUIET_ON_EMPTY) - feature_summary(WHAT BUILD_PACKAGES_NOT_FOUND - Description "Build tools not found:" - QUIET_ON_EMPTY) - -#]=======================================================================] - -function(FEATURE_SUMMARY) -# CMAKE_PARSE_ARGUMENTS(<prefix> <options> <one_value_keywords> <multi_value_keywords> args...) - set(options APPEND INCLUDE_QUIET_PACKAGES FATAL_ON_MISSING_REQUIRED_PACKAGES QUIET_ON_EMPTY) - set(oneValueArgs FILENAME VAR DESCRIPTION) - set(multiValueArgs WHAT) - - 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() - - if(NOT _FS_WHAT) - message(FATAL_ERROR "The call to FEATURE_SUMMARY() doesn't set the required WHAT argument.") - endif() - - set(validWhatParts "ENABLED_FEATURES" - "DISABLED_FEATURES" - "PACKAGES_FOUND" - "PACKAGES_NOT_FOUND") - - get_property(_fsPkgTypes GLOBAL PROPERTY FeatureSummary_PKG_TYPES) - get_property(_fsReqPkgTypes GLOBAL PROPERTY FeatureSummary_REQUIRED_PKG_TYPES) - foreach(_fsPkgType ${_fsPkgTypes}) - list(APPEND validWhatParts "${_fsPkgType}_PACKAGES_FOUND" - "${_fsPkgType}_PACKAGES_NOT_FOUND") - endforeach() - - list(FIND validWhatParts "${_FS_WHAT}" indexInList) - if(NOT "${indexInList}" STREQUAL "-1") - _FS_GET_FEATURE_SUMMARY( ${_FS_WHAT} _featureSummary ${_FS_INCLUDE_QUIET_PACKAGES} ) - if(_featureSummary OR NOT _FS_QUIET_ON_EMPTY) - set(_fullText "${_FS_DESCRIPTION}${_featureSummary}\n") - endif() - - if(_featureSummary) - foreach(_fsReqPkgType ${_fsReqPkgTypes}) - if("${_FS_WHAT}" STREQUAL "${_fsReqPkgType}_PACKAGES_NOT_FOUND") - set(requiredPackagesNotFound TRUE) - break() - endif() - endforeach() - endif() - - else() - if("${_FS_WHAT}" STREQUAL "ALL") - - set(allWhatParts "ENABLED_FEATURES") - foreach(_fsPkgType ${_fsPkgTypes}) - list(APPEND allWhatParts "${_fsPkgType}_PACKAGES_FOUND") - endforeach() - list(APPEND allWhatParts "DISABLED_FEATURES") - foreach(_fsPkgType ${_fsPkgTypes}) - list(APPEND allWhatParts "${_fsPkgType}_PACKAGES_NOT_FOUND") - endforeach() - else() - set(allWhatParts) - foreach(part ${_FS_WHAT}) - list(FIND validWhatParts "${part}" indexInList) - if(NOT "${indexInList}" STREQUAL "-1") - list(APPEND allWhatParts "${part}") - else() - if("${part}" STREQUAL "ALL") - message(FATAL_ERROR "The WHAT argument of FEATURE_SUMMARY() contains ALL, which cannot be combined with other values.") - else() - message(FATAL_ERROR "The WHAT argument of FEATURE_SUMMARY() contains ${part}, which is not a valid value.") - endif() - endif() - endforeach() - endif() - - set(title_ENABLED_FEATURES "The following features have been enabled:") - set(title_DISABLED_FEATURES "The following features have been disabled:") - set(title_PACKAGES_FOUND "The following packages have been found:") - set(title_PACKAGES_NOT_FOUND "The following packages have not been found:") - foreach(_fsPkgType ${_fsPkgTypes}) - set(title_${_fsPkgType}_PACKAGES_FOUND "The following ${_fsPkgType} packages have been found:") - set(title_${_fsPkgType}_PACKAGES_NOT_FOUND "The following ${_fsPkgType} packages have not been found:") - endforeach() - - set(_fullText "${_FS_DESCRIPTION}") - foreach(part ${allWhatParts}) - set(_tmp) - _FS_GET_FEATURE_SUMMARY( ${part} _tmp ${_FS_INCLUDE_QUIET_PACKAGES}) - if(_tmp) - if(_fullText) - string(APPEND _fullText "\n-- ") - endif() - string(APPEND _fullText "${title_${part}}\n${_tmp}\n") - foreach(_fsReqPkgType ${_fsReqPkgTypes}) - if("${part}" STREQUAL "${_fsReqPkgType}_PACKAGES_NOT_FOUND") - set(requiredPackagesNotFound TRUE) - break() - endif() - endforeach() - endif() - endforeach() - endif() - - if(_fullText OR NOT _FS_QUIET_ON_EMPTY) - if(_FS_FILENAME) - if(_FS_APPEND) - file(APPEND "${_FS_FILENAME}" "${_fullText}") - else() - file(WRITE "${_FS_FILENAME}" "${_fullText}") - endif() - - else() - if(NOT _FS_VAR) - message(STATUS "${_fullText}") - endif() - endif() - - if(_FS_VAR) - set(${_FS_VAR} "${_fullText}" PARENT_SCOPE) - endif() - endif() - - if(requiredPackagesNotFound AND _FS_FATAL_ON_MISSING_REQUIRED_PACKAGES) - message(FATAL_ERROR "feature_summary() Error: REQUIRED package(s) are missing, aborting CMake run.") - endif() - -endfunction() - -#[=======================================================================[.rst: -.. command:: set_package_properties - - :: - - set_package_properties(<name> PROPERTIES - [ URL <url> ] - [ DESCRIPTION <description> ] - [ TYPE (RUNTIME|OPTIONAL|RECOMMENDED|REQUIRED) ] - [ PURPOSE <purpose> ] - ) - - 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. - - ``URL <url>`` - This should be the homepage of the package, or something similar. - Ideally this is set already directly in the Find-module. - - ``DESCRIPTION <description>`` - A short description what that package is, at most one sentence. - Ideally this is set already directly in the Find-module. - - ``TYPE <type>`` - What type of dependency has the using project on that package. - Default is ``OPTIONAL``. In this case it is a package which can be used - by the project when available at buildtime, but it also work without. - ``RECOMMENDED`` is similar to ``OPTIONAL``, i.e. the project will build if - the package is not present, but the functionality of the resulting - binaries will be severly limited. If a ``REQUIRED`` package is not - available at buildtime, the project may not even build. This can be - combined with the ``FATAL_ON_MISSING_REQUIRED_PACKAGES`` argument for - ``feature_summary()``. Last, a ``RUNTIME`` package is a package which is - actually not used at all during the build, but which is required for - actually running the resulting binaries. So if such a package is - missing, the project can still be built, but it may not work later on. - If ``set_package_properties()`` is called multiple times for the same - package with different TYPEs, the ``TYPE`` is only changed to higher - TYPEs (``RUNTIME < OPTIONAL < RECOMMENDED < REQUIRED``), lower TYPEs are - ignored. The ``TYPE`` property is project-specific, so it cannot be set - by the Find-module, but must be set in the project. - Type accepted can be changed by setting the - :variable:`FeatureSummary_PKG_TYPES` global property. - - ``PURPOSE <purpose>`` - This describes which features this package enables in the - project, i.e. it tells the user what functionality he gets in the - resulting binaries. If set_package_properties() is called multiple - times for a package, all PURPOSE properties are appended to a list of - purposes of the package in the project. As the TYPE property, also - the PURPOSE property is project-specific, so it cannot be set by the - Find-module, but must be set in the project. - - Example for setting the info for a package: - - .. code-block:: cmake - - find_package(LibXml2) - set_package_properties(LibXml2 PROPERTIES - DESCRIPTION "A XML processing library." - URL "http://xmlsoft.org/") - # or - set_package_properties(LibXml2 PROPERTIES - TYPE RECOMMENDED - PURPOSE "Enables HTML-import in MyWordProcessor") - # or - set_package_properties(LibXml2 PROPERTIES - TYPE OPTIONAL - PURPOSE "Enables odt-export in MyWordProcessor") - - find_package(DBUS) - set_package_properties(DBUS PROPERTIES - TYPE RUNTIME - PURPOSE "Necessary to disable the screensaver during a presentation") -#]=======================================================================] -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 AND NOT "${_info}" STREQUAL "${_SPP_DESCRIPTION}") - 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 AND NOT "${_info}" STREQUAL "${_SPP_URL}") - 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() - - get_property(_fsPkgTypes GLOBAL PROPERTY FeatureSummary_PKG_TYPES) - get_property(_fsDefaultPkgType GLOBAL PROPERTY FeatureSummary_DEFAULT_PKG_TYPE) - - # handle the TYPE - if(DEFINED _SPP_TYPE) - # Supported types are listed in FeatureSummary_PKG_TYPES according to their priority - get_property(_fsPkgTypes GLOBAL PROPERTY FeatureSummary_PKG_TYPES) - list(FIND _fsPkgTypes ${_SPP_TYPE} _typeIndexInList) - if("${_typeIndexInList}" STREQUAL "-1" ) - string(REGEX REPLACE ";([^;]+)$" " and \\1" _fsPkgTypes_msg "${_fsPkgTypes}") - string(REPLACE ";" ", " _fsPkgTypes_msg "${_fsPkgTypes_msg}") - message(FATAL_ERROR "Bad package property type ${_SPP_TYPE} used in SET_PACKAGE_PROPERTIES(). " - "Valid types are ${_fsPkgTypes_msg}." ) - endif() - - get_property(_previousType GLOBAL PROPERTY _CMAKE_${_name}_TYPE) - list(FIND _fsPkgTypes "${_previousType}" _prevTypeIndexInList) - - # make sure a previously set TYPE is not overridden with a lower new TYPE: - if("${_typeIndexInList}" GREATER "${_prevTypeIndexInList}") - set_property(GLOBAL PROPERTY _CMAKE_${_name}_TYPE "${_SPP_TYPE}" ) - endif() - endif() - -endfunction() - -#[=======================================================================[.rst: -.. command:: add_feature_info - - :: - - 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. It can be a - variable or a list of conditions. - ``<description>`` is a text describing 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: - - .. code-block:: cmake - - option(WITH_FOO "Help for foo" ON) - add_feature_info(Foo WITH_FOO "The Foo feature provides very cool stuff.") -#]=======================================================================] -function(ADD_FEATURE_INFO _name _depends _desc) - set(_enabled 1) - foreach(_d ${_depends}) - string(REGEX REPLACE " +" ";" _d "${_d}") - if(${_d}) - else() - set(_enabled 0) - break() - endif() - endforeach() - 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() - - -# The stuff below is only kept for compatibility - -#[=======================================================================[.rst: -Legacy Macros -^^^^^^^^^^^^^ - -The following macros are provided for compatibility with previous -CMake versions: - -.. command:: set_package_info - - :: - - set_package_info(<name> <description> [ <url> [<purpose>] ]) - - 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 :command:`find_package` call. The features for which information - can be set are added automatically by the ``find_package()`` command. -#]=======================================================================] -function(SET_PACKAGE_INFO _name _desc) - message(DEPRECATION "SET_PACKAGE_INFO is deprecated. Use SET_PACKAGE_PROPERTIES instead.") - unset(_url) - unset(_purpose) - if(ARGC GREATER 2) - set(_url "${ARGV2}") - endif() - if(ARGC GREATER 3) - set(_purpose "${ARGV3}") - endif() - set_property(GLOBAL PROPERTY _CMAKE_${_name}_DESCRIPTION "${_desc}" ) - if(NOT _url STREQUAL "") - set_property(GLOBAL PROPERTY _CMAKE_${_name}_URL "${_url}" ) - endif() - if(NOT _purpose STREQUAL "") - set_property(GLOBAL APPEND PROPERTY _CMAKE_${_name}_PURPOSE "${_purpose}" ) - endif() -endfunction() - -#[=======================================================================[.rst: -.. command:: set_feature_info - - :: - - set_feature_info(<name> <description> [<url>]) - - Does the same as:: - - set_package_info(<name> <description> <url>) -#]=======================================================================] -function(SET_FEATURE_INFO) - message(DEPRECATION "SET_FEATURE_INFO is deprecated. Use ADD_FEATURE_INFO instead.") - SET_PACKAGE_INFO(${ARGN}) -endfunction() - -#[=======================================================================[.rst: -.. command:: print_enabled_features - - :: - - print_enabled_features() - - Does the same as - - .. code-block:: cmake - - feature_summary(WHAT ENABLED_FEATURES DESCRIPTION "Enabled features:") -#]=======================================================================] -function(PRINT_ENABLED_FEATURES) - message(DEPRECATION "PRINT_ENABLED_FEATURES is deprecated. Use - feature_summary(WHAT ENABLED_FEATURES DESCRIPTION \"Enabled features:\")") - FEATURE_SUMMARY(WHAT ENABLED_FEATURES DESCRIPTION "Enabled features:") -endfunction() - -#[=======================================================================[.rst: -.. command:: print_disabled_features - - :: - - print_disabled_features() - - Does the same as - - .. code-block:: cmake - - feature_summary(WHAT DISABLED_FEATURES DESCRIPTION "Disabled features:") -#]=======================================================================] -function(PRINT_DISABLED_FEATURES) - message(DEPRECATION "PRINT_DISABLED_FEATURES is deprecated. Use - feature_summary(WHAT DISABLED_FEATURES DESCRIPTION \"Disabled features:\")") - FEATURE_SUMMARY(WHAT DISABLED_FEATURES DESCRIPTION "Disabled features:") -endfunction() |