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