FeatureSummary.cmake 19.6 KB
Newer Older
Alexander Neundorf's avatar
 
Alexander Neundorf committed
1 2
# - Macros for generating a summary of enabled/disabled features
#
3
# This module provides the macros feature_summary(), set_package_properties() and
4
# add_feature_info().
5
# For compatibility it also still provides set_package_info(), set_feature_info(),
6
# print_enabled_features() and print_disabled_features().
7 8 9 10
#
# These macros can be used to generate a summary of enabled and disabled
# packages and/or feature for a build tree:
#
11
#    -- The following OPTIONAL packages have been found:
12
#    LibXml2 (required version >= 2.4) , XML processing library. , <http://xmlsoft.org>
13 14
#       * Enables HTML-import in MyWordProcessor
#       * Enables odt-export in MyWordProcessor
15
#    PNG , A PNG image library. , <http://www.libpng.org/pub/png/>
16 17
#       * Enables saving screenshots
#    -- The following OPTIONAL packages have not been found:
18
#    Lua51 , The Lua scripting language. , <http://www.lua.org>
19
#       * Enables macros in MyWordProcessor
20 21 22
#    Foo , Foo provides cool stuff.
#
#
Alexander Neundorf's avatar
Alexander Neundorf committed
23 24 25
#    FEATURE_SUMMARY( [FILENAME <file>]
#                     [APPEND]
#                     [VAR <variable_name>]
26
#                     [INCLUDE_QUIET_PACKAGES]
27
#                     [FATAL_ON_MISSING_REQUIRED_PACKAGES]
Alexander Neundorf's avatar
Alexander Neundorf committed
28
#                     [DESCRIPTION "Found packages:"]
29 30 31
#                     WHAT (ALL | PACKAGES_FOUND | PACKAGES_NOT_FOUND
#                          | ENABLED_FEATURES | DISABLED_FEATURES]
#                   )
Alexander Neundorf's avatar
Alexander Neundorf committed
32 33
#
# The FEATURE_SUMMARY() macro can be used to print information about enabled
34
# or disabled packages or features of a project.
Alexander Neundorf's avatar
Alexander Neundorf committed
35
# By default, only the names of the features/packages will be printed and their
36 37 38
# 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.
Alexander Neundorf's avatar
Alexander Neundorf committed
39 40 41
#
# The WHAT option is the only mandatory option. Here you specify what information
# will be printed:
42
#    ALL: print everything
43 44
#    ENABLED_FEATURES: the list of all features which are enabled
#    DISABLED_FEATURES: the list of all features which are disabled
45 46
#    PACKAGES_FOUND: the list of all packages which have been found
#    PACKAGES_NOT_FOUND: the list of all packages which have not been found
47 48 49 50 51 52 53 54
#    OPTIONAL_PACKAGES_FOUND: only those packages which have been found which have the type OPTIONAL
#    OPTIONAL_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type OPTIONAL
#    RECOMMENDED_PACKAGES_FOUND: only those packages which have been found which have the type RECOMMENDED
#    RECOMMENDED_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type RECOMMENDED
#    REQUIRED_PACKAGES_FOUND: only those packages which have been found which have the type REQUIRED
#    REQUIRED_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type REQUIRED
#    RUNTIME_PACKAGES_FOUND: only those packages which have been found which have the type RUNTIME
#    RUNTIME_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type RUNTIME
Alexander Neundorf's avatar
Alexander Neundorf committed
55 56 57 58 59 60 61 62 63
#
# 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.
64 65 66 67
# 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 REQUIRED
# has not been found.
Alexander Neundorf's avatar
Alexander Neundorf committed
68 69
#
# Example 1, append everything to a file:
70
#   feature_summary(WHAT ALL
Alexander Neundorf's avatar
Alexander Neundorf committed
71
#                   FILENAME ${CMAKE_BINARY_DIR}/all.log APPEND)
Alexander Neundorf's avatar
 
Alexander Neundorf committed
72
#
73
# Example 2, print the enabled features into the variable enabledFeaturesText, including QUIET packages:
74
#   feature_summary(WHAT ENABLED_FEATURES
75
#                   INCLUDE_QUIET_PACKAGES
Alexander Neundorf's avatar
Alexander Neundorf committed
76 77
#                   DESCRIPTION "Enabled Features:"
#                   VAR enabledFeaturesText)
78
#   message(STATUS "${enabledFeaturesText}")
Alexander Neundorf's avatar
 
Alexander Neundorf committed
79
#
Alexander Neundorf's avatar
Alexander Neundorf committed
80
#
81 82 83 84 85 86
#    SET_PACKAGE_PROPERTIES(<name> PROPERTIES [ URL <url> ]
#                                             [ DESCRIPTION <description> ]
#                                             [ TYPE (RUNTIME|OPTIONAL|RECOMMENDED|REQUIRED) ]
#                                             [ PURPOSE <purpose> ]
#                          )
#
87 88
# Use this macro to set up information about the named package, which can
# then be displayed via FEATURE_SUMMARY().
Alexander Neundorf's avatar
Alexander Neundorf committed
89 90 91
# 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
92
# find_package() command.
Alexander Neundorf's avatar
Alexander Neundorf committed
93
#
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
# URL: this should be the homepage of the package, or something similar. Ideally this is set
# already directly in the Find-module.
#
# DESCRIPTION: A short description what that package is, at most one sentence.
# Ideally this is set already directly in the Find-module.
#
# 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.
#
# 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.
#
#
121
# Example for setting the info for a package:
122
#   find_package(LibXml2)
123 124
#   set_package_properties(LibXml2 PROPERTIES DESCRIPTION "A XML processing library."
#                                             URL "http://xmlsoft.org/")
125
#
126 127 128 129 130
#   set_package_properties(LibXml2 PROPERTIES TYPE RECOMMENDED
#                                             PURPOSE "Enables HTML-import in MyWordProcessor")
# ...
#   set_package_properties(LibXml2 PROPERTIES TYPE OPTIONAL
#                                             PURPOSE "Enables odt-export in MyWordProcessor")
131
#
132
#   find_package(DBUS)
133
#   set_package_properties(DBUS PROPERTIES TYPE RUNTIME
134
#                                             PURPOSE "Necessary to disable the screensaver during a presentation" )
Alexander Neundorf's avatar
Alexander Neundorf committed
135
#
136 137 138
#    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>
139
# is a text describing the feature.
140 141 142 143 144 145 146 147 148
# 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:
149
#
150 151 152 153 154 155 156 157
#    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 FIND_PACKAGE() call.
# The features for which information can be set are added automatically by the
# find_package() command.
#
Alexander Neundorf's avatar
Alexander Neundorf committed
158 159 160 161 162
#    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:")
163
#
164 165
#    SET_FEATURE_INFO(<name> <description> [<url>] )
# Does the same as SET_PACKAGE_INFO(<name> <description> <url> )
Alexander Neundorf's avatar
 
Alexander Neundorf committed
166

167 168 169 170 171 172 173 174 175 176
#=============================================================================
# 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.
#=============================================================================
177
# (To distribute this file outside of CMake, substitute the full
178
#  License text for the above reference.)
Alexander Neundorf's avatar
 
Alexander Neundorf committed
179

180 181
INCLUDE(CMakeParseArguments)

182 183 184 185 186 187 188 189 190

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}" )
191
ENDFUNCTION(ADD_FEATURE_INFO)
192 193


194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211

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)
212
    IF(_info AND NOT "${_info}" STREQUAL "${_SPP_DESCRIPTION}")
213 214 215 216 217 218 219 220 221
      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)
222
    IF(_info AND NOT "${_info}" STREQUAL "${_SPP_URL}")
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
      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()

240 241
  # List the supported types, according to their priority
  SET(validTypes "RUNTIME" "OPTIONAL" "RECOMMENDED" "REQUIRED" )
242 243 244 245 246 247
  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()

248 249 250 251 252 253 254
  GET_PROPERTY(_previousType  GLOBAL PROPERTY _CMAKE_${_name}_TYPE)
  LIST(FIND validTypes "${_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()
255 256 257 258 259

ENDFUNCTION(SET_PACKAGE_PROPERTIES)



260
FUNCTION(_FS_GET_FEATURE_SUMMARY _property _var _includeQuiet)
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279

  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()


280
  SET(_currentFeatureText "")
281
  GET_PROPERTY(_EnabledFeatures  GLOBAL PROPERTY ${_property})
282

Alexander Neundorf's avatar
 
Alexander Neundorf committed
283
  FOREACH(_currentFeature ${_EnabledFeatures})
284 285 286 287 288 289 290 291 292

    # 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}")

293 294
      # check whether the current feature/package should be in the output depending on whether it was QUIET or not
      SET(includeThisOne TRUE)
295 296
      # skip QUIET packages, except if they are REQUIRED or INCLUDE_QUIET_PACKAGES has been set
      IF((NOT "${_currentType}" STREQUAL "REQUIRED") AND NOT _includeQuiet)
297 298 299 300 301 302 303 304
        GET_PROPERTY(_isQuiet  GLOBAL PROPERTY _CMAKE_${_currentFeature}_QUIET)
        IF(_isQuiet)
          SET(includeThisOne FALSE)
        ENDIF()
      ENDIF()

      IF(includeThisOne)

305
        SET(_currentFeatureText "${_currentFeatureText}\n * ${_currentFeature}")
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
        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}_PURPOSE)
        FOREACH(_purpose ${_info})
          SET(_currentFeatureText "${_currentFeatureText}\n   * ${_purpose}")
        ENDFOREACH()

      ENDIF(includeThisOne)
325 326 327

    ENDIF("${_type}" STREQUAL ANY  OR  "${_type}" STREQUAL "${_currentType}")

Alexander Neundorf's avatar
 
Alexander Neundorf committed
328
  ENDFOREACH(_currentFeature)
329 330
  SET(${_var} "${_currentFeatureText}" PARENT_SCOPE)
ENDFUNCTION(_FS_GET_FEATURE_SUMMARY)
Alexander Neundorf's avatar
 
Alexander Neundorf committed
331 332


333 334 335

FUNCTION(FEATURE_SUMMARY)
# CMAKE_PARSE_ARGUMENTS(<prefix> <options> <one_value_keywords> <multi_value_keywords> args...)
336
  SET(options APPEND INCLUDE_QUIET_PACKAGES FATAL_ON_MISSING_REQUIRED_PACKAGES)
337 338 339 340 341 342 343
  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}\"")
344
  ENDIF()
345 346

  IF(NOT _FS_WHAT)
347
    MESSAGE(FATAL_ERROR "The call to FEATURE_SUMMARY() doesn't set the required WHAT argument.")
348
  ENDIF()
349

350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
  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")
365
    _FS_GET_FEATURE_SUMMARY( ${_FS_WHAT} _featureSummary ${_FS_INCLUDE_QUIET_PACKAGES} )
366
    SET(_fullText "${_FS_DESCRIPTION}${_featureSummary}\n")
367 368 369 370
    IF (("${_FS_WHAT}" STREQUAL "REQUIRED_PACKAGES_NOT_FOUND") AND _featureSummary)
      SET(requiredPackagesNotFound TRUE)
    ENDIF()

371
  ELSEIF("${_FS_WHAT}" STREQUAL "ALL")
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396

    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:")

397
    SET(_fullText "${_FS_DESCRIPTION}")
398 399
    FOREACH(part ${allWhatParts})
      SET(_tmp)
400
      _FS_GET_FEATURE_SUMMARY( ${part} _tmp ${_FS_INCLUDE_QUIET_PACKAGES})
401
      IF(_tmp)
402
        SET(_fullText "${_fullText}\n\n-- ${title_${part}}\n${_tmp}")
403 404 405
        IF("${part}" STREQUAL "REQUIRED_PACKAGES_NOT_FOUND")
          SET(requiredPackagesNotFound TRUE)
        ENDIF()
406 407
      ENDIF()
    ENDFOREACH()
408 409 410 411 412 413 414
  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}")
415 416
    ELSE(_FS_APPEND)
      FILE(WRITE  "${_FS_FILENAME}" "${_fullText}")
417
    ENDIF()
418 419 420 421

  ELSE(_FS_FILENAME)
    IF(NOT _FS_VAR)
      MESSAGE(STATUS "${_fullText}")
422 423
    ENDIF()
  ENDIF()
424 425 426

  IF(_FS_VAR)
    SET(${_FS_VAR} "${_fullText}" PARENT_SCOPE)
427
  ENDIF()
428

429 430 431 432
  IF(requiredPackagesNotFound  AND  _FS_FATAL_ON_MISSING_REQUIRED_PACKAGES)
    MESSAGE(FATAL_ERROR "feature_summary() Error: REQUIRED package(s) are missing, aborting CMake run.")
  ENDIF()

433
ENDFUNCTION(FEATURE_SUMMARY)
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466


# The stuff below is only kept for compatibility

FUNCTION(SET_PACKAGE_INFO _name _desc)
  SET(_url "${ARGV2}")
  SET(_purpose "${ARGV3}")
  SET_PROPERTY(GLOBAL PROPERTY _CMAKE_${_name}_DESCRIPTION "${_desc}" )
  IF(_url MATCHES ".+")
    SET_PROPERTY(GLOBAL PROPERTY _CMAKE_${_name}_URL "${_url}" )
  ENDIF()
  IF(_purpose MATCHES ".+")
    SET_PROPERTY(GLOBAL APPEND PROPERTY _CMAKE_${_name}_PURPOSE "${_purpose}" )
  ENDIF()
ENDFUNCTION(SET_PACKAGE_INFO)



FUNCTION(SET_FEATURE_INFO)
  SET_PACKAGE_INFO(${ARGN})
ENDFUNCTION(SET_FEATURE_INFO)



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)