1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
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
|
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file LICENSE.rst or https://cmake.org/licensing for details.
#[=======================================================================[.rst:
CMakePrintHelpers
-----------------
This module provides convenience commands, primarily intended for debugging,
to print the values of properties and variables.
Load this module in CMake with:
.. code-block:: cmake
include(CMakePrintHelpers)
Commands
^^^^^^^^
This module provides the following commands:
.. command:: cmake_print_properties
Prints the values of properties for the specified targets, source files,
directories, tests, or cache entries:
.. code-block:: cmake
cmake_print_properties(
<TARGETS [<targets>...] |
SOURCES [<sources>...] |
DIRECTORIES [<dirs>...] |
TESTS [<tests>...] |
CACHE_ENTRIES [<entries>...] >
PROPERTIES [<properties>...]
)
Exactly one of the scope keywords must be specified. The scope keyword
and its arguments must appear before the ``PROPERTIES`` keyword in the
argument list.
.. command:: cmake_print_variables
Prints each variable name followed by its value:
.. code-block:: cmake
cmake_print_variables([<vars>...])
Examples
^^^^^^^^
Printing the ``LOCATION`` and ``INTERFACE_INCLUDE_DIRECTORIES`` properties for
both targets ``foo`` and ``bar``:
.. code-block:: cmake
include(CMakePrintHelpers)
cmake_print_properties(
TARGETS foo bar
PROPERTIES LOCATION INTERFACE_INCLUDE_DIRECTORIES
)
Gives::
--
Properties for TARGET foo:
foo.LOCATION = "/usr/lib/libfoo.so"
foo.INTERFACE_INCLUDE_DIRECTORIES = "/usr/include;/usr/include/foo"
Properties for TARGET bar:
bar.LOCATION = "/usr/lib/libbar.so"
bar.INTERFACE_INCLUDE_DIRECTORIES = "/usr/include;/usr/include/bar"
Printing given variables:
.. code-block:: cmake
include(CMakePrintHelpers)
cmake_print_variables(CMAKE_C_COMPILER CMAKE_MAJOR_VERSION NOT_EXISTS)
Gives::
-- CMAKE_C_COMPILER="/usr/bin/cc" ; CMAKE_MAJOR_VERSION="3" ; NOT_EXISTS=""
#]=======================================================================]
function(cmake_print_variables)
set(msg "")
foreach(var ${ARGN})
if(msg)
string(APPEND msg " ; ")
endif()
string(APPEND msg "${var}=\"${${var}}\"")
endforeach()
message(STATUS "${msg}")
endfunction()
function(cmake_print_properties)
set(options )
set(oneValueArgs )
set(cpp_multiValueArgs PROPERTIES )
set(cppmode_multiValueArgs TARGETS SOURCES TESTS DIRECTORIES CACHE_ENTRIES )
string(JOIN " " _mode_names ${cppmode_multiValueArgs})
set(_missing_mode_message
"Mode keyword missing in cmake_print_properties() call, there must be exactly one of ${_mode_names}")
cmake_parse_arguments(
CPP "${options}" "${oneValueArgs}" "${cpp_multiValueArgs}" ${ARGN})
if(NOT CPP_PROPERTIES)
message(FATAL_ERROR
"Required argument PROPERTIES missing in cmake_print_properties() call")
return()
endif()
if(NOT CPP_UNPARSED_ARGUMENTS)
message(FATAL_ERROR "${_missing_mode_message}")
return()
endif()
cmake_parse_arguments(
CPPMODE "${options}" "${oneValueArgs}" "${cppmode_multiValueArgs}"
${CPP_UNPARSED_ARGUMENTS})
if(CPPMODE_UNPARSED_ARGUMENTS)
message(FATAL_ERROR
"Unknown keywords given to cmake_print_properties(): \"${CPPMODE_UNPARSED_ARGUMENTS}\"")
return()
endif()
set(mode)
set(items)
set(keyword)
if(CPPMODE_TARGETS)
set(items ${CPPMODE_TARGETS})
set(mode ${mode} TARGETS)
set(keyword TARGET)
endif()
if(CPPMODE_SOURCES)
set(items ${CPPMODE_SOURCES})
set(mode ${mode} SOURCES)
set(keyword SOURCE)
endif()
if(CPPMODE_TESTS)
set(items ${CPPMODE_TESTS})
set(mode ${mode} TESTS)
set(keyword TEST)
endif()
if(CPPMODE_DIRECTORIES)
set(items ${CPPMODE_DIRECTORIES})
set(mode ${mode} DIRECTORIES)
set(keyword DIRECTORY)
endif()
if(CPPMODE_CACHE_ENTRIES)
set(items ${CPPMODE_CACHE_ENTRIES})
set(mode ${mode} CACHE_ENTRIES)
# This is a workaround for the fact that passing `CACHE` as an argument to
# set() causes a cache variable to be set.
set(keyword "")
string(APPEND keyword CACHE)
endif()
if(NOT mode)
message(FATAL_ERROR "${_missing_mode_message}")
return()
endif()
list(LENGTH mode modeLength)
if("${modeLength}" GREATER 1)
message(FATAL_ERROR
"Multiple mode keywords used in cmake_print_properties() call, there must be exactly one of ${_mode_names}.")
return()
endif()
set(msg "\n")
foreach(item ${items})
set(itemExists TRUE)
if(keyword STREQUAL "TARGET")
if(NOT TARGET ${item})
set(itemExists FALSE)
string(APPEND msg "\n No such TARGET \"${item}\" !\n\n")
endif()
endif()
if (itemExists)
string(APPEND msg " Properties for ${keyword} ${item}:\n")
foreach(prop ${CPP_PROPERTIES})
get_property(propertySet ${keyword} ${item} PROPERTY "${prop}" SET)
if(propertySet)
get_property(property ${keyword} ${item} PROPERTY "${prop}")
string(APPEND msg " ${item}.${prop} = \"${property}\"\n")
else()
string(APPEND msg " ${item}.${prop} = <NOTFOUND>\n")
endif()
endforeach()
endif()
endforeach()
message(STATUS "${msg}")
endfunction()
|
