EnumVariable.py
上传用户:market2
上传日期:2018-11-18
资源大小:18786k
文件大小:4k
源码类别:

外挂编程

开发平台:

Windows_Unix

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