FeatureSummary.cmake 8.81 KB
Newer Older
Alexander Neundorf's avatar
   
Alexander Neundorf committed
1
2
# - Macros for generating a summary of enabled/disabled features
#
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# 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.
#
#
Alexander Neundorf's avatar
Alexander Neundorf committed
19
20
21
22
#    FEATURE_SUMMARY( [FILENAME <file>]
#                     [APPEND]
#                     [VAR <variable_name>]
#                     [DESCRIPTION "Found packages:"]
23
24
25
#                     WHAT (ALL | PACKAGES_FOUND | PACKAGES_NOT_FOUND
#                          | ENABLED_FEATURES | DISABLED_FEATURES]
#                   )
Alexander Neundorf's avatar
Alexander Neundorf committed
26
27
28
29
30
31
32
33
34
#
# 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:
35
36
37
38
39
40
#    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
Alexander Neundorf's avatar
Alexander Neundorf committed
41
42
43
44
45
46
47
48
49
50
51
52
#    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:
53
#   feature_summary(WHAT ALL
Alexander Neundorf's avatar
Alexander Neundorf committed
54
#                   FILENAME ${CMAKE_BINARY_DIR}/all.log APPEND)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
55
#
Alexander Neundorf's avatar
Alexander Neundorf committed
56
# Example 2, print the enabled features into the variable enabledFeaturesText:
57
#   feature_summary(WHAT ENABLED_FEATURES
Alexander Neundorf's avatar
Alexander Neundorf committed
58
59
#                   DESCRIPTION "Enabled Features:"
#                   VAR enabledFeaturesText)
60
#   message(STATUS "${enabledFeaturesText}")
Alexander Neundorf's avatar
   
Alexander Neundorf committed
61
#
Alexander Neundorf's avatar
Alexander Neundorf committed
62
#
63
64
65
#    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().
Alexander Neundorf's avatar
Alexander Neundorf committed
66
67
68
# 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
69
# find_package() command.
Alexander Neundorf's avatar
Alexander Neundorf committed
70
#
71
# Example for setting the info for a package:
72
73
74
#   find_package(LibXml2)
#   set_package_info(LibXml2 "XML processing library." "http://xmlsoft.org/")
#
Alexander Neundorf's avatar
Alexander Neundorf committed
75
#
76
77
78
79
80
81
82
83
84
85
86
87
88
#    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:
89
#
Alexander Neundorf's avatar
Alexander Neundorf committed
90
91
92
93
94
#    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:")
95
96
97
#
#    SET_FEATURE_INFO(<name> <description> [<url> [<comment>] ] )
# Does the same as SET_PACKAGE_INFO(<name> <description> <url> <comment> )
Alexander Neundorf's avatar
   
Alexander Neundorf committed
98

99
100
101
102
103
104
105
106
107
108
#=============================================================================
# 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.
#=============================================================================
109
# (To distribute this file outside of CMake, substitute the full
110
#  License text for the above reference.)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
111

112
113
INCLUDE(CMakeParseArguments)

114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

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


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


FUNCTION(SET_PACKAGE_INFO _name _desc)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
132
133
  SET(_url "${ARGV2}")
  SET(_comment "${ARGV3}")
134
  SET_PROPERTY(GLOBAL PROPERTY _CMAKE_${_name}_DESCRIPTION "${_desc}" )
Alexander Neundorf's avatar
   
Alexander Neundorf committed
135
  IF(_url MATCHES ".+")
136
    SET_PROPERTY(GLOBAL PROPERTY _CMAKE_${_name}_URL "${_url}" )
Alexander Neundorf's avatar
   
Alexander Neundorf committed
137
138
  ENDIF(_url MATCHES ".+")
  IF(_comment MATCHES ".+")
139
    SET_PROPERTY(GLOBAL PROPERTY _CMAKE_${_name}_COMMENT "${_comment}" )
Alexander Neundorf's avatar
   
Alexander Neundorf committed
140
  ENDIF(_comment MATCHES ".+")
141
ENDFUNCTION(SET_PACKAGE_INFO)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
142
143


144
145
FUNCTION(_FS_GET_FEATURE_SUMMARY _property _var)
  SET(_currentFeatureText "")
146
  GET_PROPERTY(_EnabledFeatures  GLOBAL PROPERTY ${_property})
Alexander Neundorf's avatar
   
Alexander Neundorf committed
147
148
  FOREACH(_currentFeature ${_EnabledFeatures})
    SET(_currentFeatureText "${_currentFeatureText}\n${_currentFeature}")
149
150
151
152
153
    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)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
154
155
156
    IF(_info)
      SET(_currentFeatureText "${_currentFeatureText} , ${_info}")
    ENDIF(_info)
157
    GET_PROPERTY(_info  GLOBAL PROPERTY _CMAKE_${_currentFeature}_URL)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
158
159
160
    IF(_info)
      SET(_currentFeatureText "${_currentFeatureText} , <${_info}>")
    ENDIF(_info)
161
    GET_PROPERTY(_info  GLOBAL PROPERTY _CMAKE_${_currentFeature}_COMMENT)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
162
163
164
165
    IF(_info)
      SET(_currentFeatureText "${_currentFeatureText} , ${_info}")
    ENDIF(_info)
  ENDFOREACH(_currentFeature)
166
167
  SET(${_var} "${_currentFeatureText}" PARENT_SCOPE)
ENDFUNCTION(_FS_GET_FEATURE_SUMMARY)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
168
169


170
FUNCTION(PRINT_ENABLED_FEATURES)
171
  FEATURE_SUMMARY(WHAT ENABLED_FEATURES  DESCRIPTION "Enabled features:")
172
ENDFUNCTION(PRINT_ENABLED_FEATURES)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
173
174


175
FUNCTION(PRINT_DISABLED_FEATURES)
176
  FEATURE_SUMMARY(WHAT DISABLED_FEATURES  DESCRIPTION "Disabled features:")
177
ENDFUNCTION(PRINT_DISABLED_FEATURES)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
178

179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229


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)

  IF(   "${_FS_WHAT}" STREQUAL "ENABLED_FEATURES"
     OR "${_FS_WHAT}" STREQUAL "DISABLED_FEATURES"
     OR "${_FS_WHAT}" STREQUAL "PACKAGES_FOUND"
     OR "${_FS_WHAT}" STREQUAL "PACKAGES_NOT_FOUND")
    _FS_GET_FEATURE_SUMMARY( ${_FS_WHAT} _featureSummary)
  ELSEIF("${_FS_WHAT}" STREQUAL "ALL")
    _FS_GET_FEATURE_SUMMARY( PACKAGES_FOUND _tmp1)
    _FS_GET_FEATURE_SUMMARY( PACKAGES_NOT_FOUND _tmp2)
    SET(_featureSummary "${_tmp1}${_tmp2}")
  ELSE()
    MESSAGE(FATAL_ERROR "The WHAT argument of FEATURE_SUMMARY() is set to ${_FS_WHAT}, which is not a valid value.")
  ENDIF()

  SET(_fullText "${_FS_DESCRIPTION}${_featureSummary}\n")

  IF(_FS_FILENAME)
    IF(_FS_APPEND)
      FILE(WRITE  "${_FS_FILENAME}" "${_fullText}")
    ELSE(_FS_APPEND)
      FILE(APPEND "${_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)