Source Code for Module SCons.Variables.EnumVariable'

  1  """engine.SCons.Variables.EnumVariable 
  2   
  3  This file defines the option type for SCons allowing only specified 
  4  input-values. 
  5   
  6  Usage example:: 
  7   
  8      opts = Variables() 
  9      opts.Add(EnumVariable('debug', 'debug output and symbols', 'no', 
 10                        allowed_values=('yes', 'no', 'full'), 
 11                        map={}, ignorecase=2)) 
 12      ... 
 13      if env['debug'] == 'full': 
 14      ... 
 15  """ 
 16   
 17  # 
 18  # Copyright (c) 2001 - 2019 The SCons Foundation 
 19  # 
 20  # Permission is hereby granted, free of charge, to any person obtaining 
 21  # a copy of this software and associated documentation files (the 
 22  # "Software"), to deal in the Software without restriction, including 
 23  # without limitation the rights to use, copy, modify, merge, publish, 
 24  # distribute, sublicense, and/or sell copies of the Software, and to 
 25  # permit persons to whom the Software is furnished to do so, subject to 
 26  # the following conditions: 
 27  # 
 28  # The above copyright notice and this permission notice shall be included 
 29  # in all copies or substantial portions of the Software. 
 30  # 
 31  # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY 
 32  # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE 
 33  # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
 34  # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 
 35  # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 
 36  # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 
 37  # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
 38  # 
 39   
 40  __revision__ = "src/engine/SCons/Variables/EnumVariable.py 3a41ed6b288cee8d085373ad7fa02894e1903864 2019-01-23 17:30:35 bdeegan" 
 41   
 42  __all__ = ['EnumVariable',] 
 43   
 44   
 45  import SCons.Errors 
 46   
 47 -def _validator(key, val, env, vals): 
 48      if not val in vals: 
 49          raise SCons.Errors.UserError( 
 50              'Invalid value for option %s: %s.  Valid values are: %s' % (key, val, vals)) 
 51   
 52   
 53 -def EnumVariable(key, help, default, allowed_values, map={}, ignorecase=0): 
 54      """ 
 55      The input parameters describe an option with only certain values 
 56      allowed. They are returned with an appropriate converter and 
 57      validator appended. The result is usable for input to 
 58      Variables.Add(). 
 59   
 60      'key' and 'default' are the values to be passed on to Variables.Add(). 
 61   
 62      'help' will be appended by the allowed values automatically 
 63   
 64      'allowed_values' is a list of strings, which are allowed as values 
 65      for this option. 
 66   
 67      The 'map'-dictionary may be used for converting the input value 
 68      into canonical values (e.g. for aliases). 
 69   
 70      'ignorecase' defines the behaviour of the validator: 
 71   
 72          If ignorecase == 0, the validator/converter are case-sensitive. 
 73          If ignorecase == 1, the validator/converter are case-insensitive. 
 74          If ignorecase == 2, the validator/converter is case-insensitive and the converted value will always be lower-case. 
 75   
 76      The 'validator' tests whether the value is in the list of allowed values. The 'converter' converts input values 
 77      according to the given 'map'-dictionary (unmapped input values are returned unchanged). 
 78      """ 
 79   
 80      help = '%s (%s)' % (help, '|'.join(allowed_values)) 
 81      # define validator 
 82      if ignorecase >= 1: 
 83          validator = lambda key, val, env: \ 
 84                      _validator(key, val.lower(), env, allowed_values) 
 85      else: 
 86          validator = lambda key, val, env: \ 
 87                      _validator(key, val, env, allowed_values) 
 88      # define converter 
 89      if ignorecase == 2: 
 90          converter = lambda val: map.get(val.lower(), val).lower() 
 91      elif ignorecase == 1: 
 92          converter = lambda val: map.get(val.lower(), val) 
 93      else: 
 94          converter = lambda val: map.get(val, val) 
 95      return (key, help, default, validator, converter) 
 96   
 97  # Local Variables: 
 98  # tab-width:4 
 99  # indent-tabs-mode:nil 
100  # End: 
101  # vim: set expandtab tabstop=4 shiftwidth=4: 
102