Debian Codegraph @

cmake/tribits/core/package_arch/TribitsPrintEnabledPackagesLists.cmake

raw
1 # @HEADER
2 # *****************************************************************************
3 # TriBITS: Tribal Build, Integrate, and Test System
4 #
5 # Copyright 2013-2016 NTESS and the TriBITS contributors.
6 # SPDX-License-Identifier: BSD-3-Clause
7 # *****************************************************************************
8 # @HEADER
9
10 include(TribitsGetPackageSublists)
11
12
13 # @FUNCTION: tribits_print_enables_before_adjust_package_enables()
14 #
15 # Call this to print the package enables before calling
16 # tribits_adjust_package_enables().
17 #
18 # Usage::
19 #
20 # tribits_print_enables_before_adjust_package_enables()
21 #
22 function(tribits_print_enables_before_adjust_package_enables)
23 tribits_print_toplevel_package_list_enable_status(
24 "\nExplicitly enabled top-level packages on input (by user)"
25 INTERNAL ON NONEMPTY)
26 tribits_print_package_list_enable_status(
27 "\nExplicitly enabled packages on input (by user)" INTERNAL ON NONEMPTY)
28 tribits_print_toplevel_package_list_enable_status(
29 "\nExplicitly disabled top-level packages on input (by user or by default)"
30 INTERNAL OFF NONEMPTY)
31 tribits_print_package_list_enable_status(
32 "\nExplicitly disabled packages on input (by user or by default)"
33 INTERNAL OFF NONEMPTY)
34 tribits_print_package_list_enable_status(
35 "\nExplicitly enabled external packages/TPLs on input (by user)" EXTERNAL ON NONEMPTY)
36 tribits_print_package_list_enable_status(
37 "\nExplicitly disabled external packages/TPLs on input (by user or by default)"
38 EXTERNAL OFF NONEMPTY)
39 tribits_print_package_build_status("\nInitial package build status:\n"
40 "-- Initial: " PRINT_ALL)
41 endfunction()
42
43
44 # @FUNCTION: tribits_print_enables_after_adjust_package_enables()
45 #
46 # Call this to print the package enables before calling
47 # tribits_adjust_package_enables().
48 #
49 # Usage::
50 #
51 # tribits_print_enables_after_adjust_package_enables()
52 #
53 function(tribits_print_enables_after_adjust_package_enables)
54 tribits_print_toplevel_package_list_enable_status(
55 "\nFinal set of enabled top-level packages" INTERNAL ON NONEMPTY)
56 tribits_print_package_list_enable_status(
57 "\nFinal set of enabled packages" INTERNAL ON NONEMPTY)
58 tribits_print_toplevel_package_list_enable_status(
59 "\nFinal set of non-enabled top-level packages" INTERNAL OFF INCLUDE_EMPTY)
60 tribits_print_package_list_enable_status(
61 "\nFinal set of non-enabled packages" INTERNAL OFF INCLUDE_EMPTY)
62 tribits_print_toplevel_package_list_enable_status(
63 "\nFinal set of enabled top-level external packages/TPLs" EXTERNAL ON NONEMPTY)
64 tribits_print_package_list_enable_status(
65 "\nFinal set of enabled external packages/TPLs" EXTERNAL ON NONEMPTY)
66 tribits_print_toplevel_package_list_enable_status(
67 "\nFinal set of non-enabled top-level external packages/TPLs" EXTERNAL OFF INCLUDE_EMPTY)
68 tribits_print_package_list_enable_status(
69 "\nFinal set of non-enabled external packages/TPLs" EXTERNAL OFF INCLUDE_EMPTY)
70 tribits_print_package_build_status("\nFinal package build status (enabled only):\n"
71 "-- Final: " PRINT_ONLY_ENABLED)
72 endfunction()
73
74
75 # Function that prints the current set of enabled internal or external
76 # top-level packages
77 #
78 function(tribits_print_toplevel_package_list_enable_status
79 docString internalOrExternal enabledFlag enableEmptyStatus
80 )
81 tribits_print_packages_list_enable_status_from_var(
82 ${PROJECT_NAME}_DEFINED_TOPLEVEL_PACKAGES
83 "${docString}" "${internalOrExternal}" ${enabledFlag} ${enableEmptyStatus} )
84 endfunction()
85
86
87 # Prints the current set of enabled/disabled internal packages
88 #
89 function(tribits_print_package_list_enable_status
90 docString internalOrExternal enabledFlag enableEmptyStatus
91 )
92 tribits_print_packages_list_enable_status_from_var(
93 ${PROJECT_NAME}_DEFINED_PACKAGES
94 "${docString}" "${internalOrExternal}" ${enabledFlag} ${enableEmptyStatus} )
95 endfunction()
96
97
98 # Print the current set of enabled/disabled packages given input list of
99 # packages
100 #
101 function(tribits_print_packages_list_enable_status_from_var packageListVarName
102 docString internalOrExternal enabledFlag enableEmptyStatus
103 )
104 tribits_filter_package_list_from_var(${packageListVarName}
105 "${internalOrExternal}" "${enabledFlag}" ${enableEmptyStatus} packageSublist)
106 tribits_print_prefix_string_and_list("${docString}" packageSublist)
107 endfunction()
108
109
110 # Print out a list with white-space separators with an initial doc string
111 #
112 function(tribits_print_prefix_string_and_list docString listNameToPrint)
113 string(REPLACE ";" " " listToPrintStr "${${listNameToPrint}}")
114 list(LENGTH ${listNameToPrint} numElements)
115 if (numElements GREATER "0")
116 message("${docString}: ${listToPrintStr} ${numElements}")
117 else()
118 message("${docString}: ${numElements}")
119 endif()
120 endfunction()
121
122
123 # Print out the `<Package>_PACKAGE_BUILD_STATUS` vars
124 #
125 function(tribits_print_package_build_status summaryHeaderStr prefixStr
126 printEnabledOpt
127 )
128 if (printEnabledOpt STREQUAL "PRINT_ALL")
129 set(printAll ON)
130 elseif (printEnabledOpt STREQUAL "PRINT_ONLY_ENABLED")
131 set(printAll OFF)
132 else()
133 message(FATAL_ERROR
134 "Error, invalid value for printEnabledOpt='${printEnabledOpt}'")
135 endif()
136
137 if (${PROJECT_NAME}_DUMP_PACKAGE_BUILD_STATUS)
138 message("${summaryHeaderStr}")
139 foreach(packageName IN LISTS ${PROJECT_NAME}_DEFINED_PACKAGES)
140 tribits_get_package_enable_status(${packageName} packageEnable "")
141 if (printAll OR packageEnable)
142 message("${prefixStr}${packageName}_PACKAGE_BUILD_STATUS="
143 "${${packageName}_PACKAGE_BUILD_STATUS}")
144 endif()
145 endforeach()
146 endif()
147 endfunction()