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

外挂编程

开发平台:

Windows_Unix

  1. """engine.SCons.Variables.BoolVariable
  2. This file defines the option type for SCons implementing true/false values.
  3. Usage example:
  4.   opts = Variables()
  5.   opts.Add(BoolVariable('embedded', 'build for an embedded system', 0))
  6.   ...
  7.   if env['embedded'] == 1:
  8.     ...
  9. """
  10. #
  11. # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The SCons Foundation
  12. #
  13. # Permission is hereby granted, free of charge, to any person obtaining
  14. # a copy of this software and associated documentation files (the
  15. # "Software"), to deal in the Software without restriction, including
  16. # without limitation the rights to use, copy, modify, merge, publish,
  17. # distribute, sublicense, and/or sell copies of the Software, and to
  18. # permit persons to whom the Software is furnished to do so, subject to
  19. # the following conditions:
  20. #
  21. # The above copyright notice and this permission notice shall be included
  22. # in all copies or substantial portions of the Software.
  23. #
  24. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  25. # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  26. # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27. # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  28. # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  29. # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  30. # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  31. #
  32. __revision__ = "src/engine/SCons/Variables/BoolVariable.py 3057 2008/06/09 22:21:00 knight"
  33. __all__ = ['BoolVariable',]
  34. import string
  35. import SCons.compat
  36. import SCons.Errors
  37. __true_strings  = ('y', 'yes', 'true', 't', '1', 'on' , 'all' )
  38. __false_strings = ('n', 'no', 'false', 'f', '0', 'off', 'none')
  39. def _text2bool(val):
  40.     """
  41.     Converts strings to True/False depending on the 'truth' expressed by
  42.     the string. If the string can't be converted, the original value
  43.     will be returned.
  44.     See '__true_strings' and '__false_strings' for values considered
  45.     'true' or 'false respectivly.
  46.     This is usable as 'converter' for SCons' Variables.
  47.     """
  48.     lval = string.lower(val)
  49.     if lval in __true_strings: return True
  50.     if lval in __false_strings: return False
  51.     raise ValueError("Invalid value for boolean option: %s" % val)
  52. def _validator(key, val, env):
  53.     """
  54.     Validates the given value to be either '0' or '1'.
  55.     
  56.     This is usable as 'validator' for SCons' Variables.
  57.     """
  58.     if not env[key] in (True, False):
  59.         raise SCons.Errors.UserError(
  60.             'Invalid value for boolean option %s: %s' % (key, env[key]))
  61. def BoolVariable(key, help, default):
  62.     """
  63.     The input parameters describe a boolen option, thus they are
  64.     returned with the correct converter and validator appended. The
  65.     'help' text will by appended by '(yes|no) to show the valid
  66.     valued. The result is usable for input to opts.Add().
  67.     """
  68.     return (key, '%s (yes|no)' % help, default,
  69.             _validator, _text2bool)