Debian Codegraph @

cmake/tribits/core/utils/TribitsAddEnumCacheVar.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(TribitsParseArgumentsHelpers)
11
12
13 # @FUNCTION: tribits_add_enum_cache_var()
14 #
15 # Set up a string cache variable that must match a fixed set of values
16 # (i.e. an enum) and assert that it matches those values.
17 #
18 # Usage::
19 #
20 # tribits_add_enum_cache_var(<cacheVarName>
21 # DEFAULT_VAL <defaultVal>
22 # DOC_STRING "<docString>"
23 # ALLOWED_STRINGS_LIST "<val0>" "<val1>" ...
24 # [IS_ADVANCED]
25 # )
26 #
27 # On output, ``<cacheVarName>`` will be set to the list of paths
28 #
29 function(tribits_add_enum_cache_var cacheVarName defaultVal docString
30 isAdvanced allowedStringsListName
31 )
32 # Parse input arguments
33 set(argOneValArgKeywords DEFAULT_VAL DOC_STRING)
34 set(argMultiValArgKeywords ALLOWED_STRINGS_LIST)
35 cmake_parse_arguments(PARSE_ARGV 1 PREFIX
36 "IS_ADVANCED" # options
37 "" # one_value_keywords
38 "${argOneValArgKeywords};${argMultiValArgKeywords}" # multi_value_keywords
39 )
40 tribits_check_for_unparsed_arguments(PREFIX)
41 tribits_assert_parse_arg_one_value(PREFIX ${argOneValArgKeywords})
42 tribits_assert_parse_arg_one_or_more_values(PREFIX ${argMultiValArgKeywords})
43 # Human readable list of allowed values: '<val0>', '<val1>', ...
44 string(REPLACE ";" "', '" validStringValuesListStr "'${PREFIX_ALLOWED_STRINGS_LIST}'")
45 # Set cache var
46 set(${cacheVarName} ${PREFIX_DEFAULT_VAL} CACHE STRING
47 "${PREFIX_DOC_STRING}. Valid values: ${validStringValuesListStr} (default '${PREFIX_DEFAULT_VAL}')")
48 if (PREFIX_IS_ADVANCED)
49 mark_as_advanced(${cacheVarName})
50 endif()
51 set_property(CACHE ${cacheVarName} PROPERTY STRINGS
52 ${PREFIX_ALLOWED_STRINGS_LIST} )
53 # Assert in list of allowed strings
54 if (NOT ${cacheVarName} IN_LIST PREFIX_ALLOWED_STRINGS_LIST)
55 message(FATAL_ERROR "Error, the cache var ${cacheVarName} with value"
56 " '${${cacheVarName}}' is not in the list of allowed values:"
57 " ${validStringValuesListStr} (default '${PREFIX_DEFAULT_VAL}')" )
58 endif()
59 endfunction()