forked from Tom/SconsLocal
init
This commit is contained in:
89
scons-local-3.0.0/SCons/Variables/BoolVariable.py
Normal file
89
scons-local-3.0.0/SCons/Variables/BoolVariable.py
Normal file
@@ -0,0 +1,89 @@
|
||||
"""engine.SCons.Variables.BoolVariable
|
||||
|
||||
This file defines the option type for SCons implementing true/false values.
|
||||
|
||||
Usage example::
|
||||
|
||||
opts = Variables()
|
||||
opts.Add(BoolVariable('embedded', 'build for an embedded system', 0))
|
||||
...
|
||||
if env['embedded'] == 1:
|
||||
...
|
||||
"""
|
||||
|
||||
#
|
||||
# Copyright (c) 2001 - 2017 The SCons Foundation
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining
|
||||
# a copy of this software and associated documentation files (the
|
||||
# "Software"), to deal in the Software without restriction, including
|
||||
# without limitation the rights to use, copy, modify, merge, publish,
|
||||
# distribute, sublicense, and/or sell copies of the Software, and to
|
||||
# permit persons to whom the Software is furnished to do so, subject to
|
||||
# the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included
|
||||
# in all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
|
||||
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
||||
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
#
|
||||
|
||||
__revision__ = "src/engine/SCons/Variables/BoolVariable.py rel_3.0.0:4395:8972f6a2f699 2017/09/18 12:59:24 bdbaddog"
|
||||
|
||||
__all__ = ['BoolVariable',]
|
||||
|
||||
import SCons.Errors
|
||||
|
||||
__true_strings = ('y', 'yes', 'true', 't', '1', 'on' , 'all' )
|
||||
__false_strings = ('n', 'no', 'false', 'f', '0', 'off', 'none')
|
||||
|
||||
|
||||
def _text2bool(val):
|
||||
"""
|
||||
Converts strings to True/False depending on the 'truth' expressed by
|
||||
the string. If the string can't be converted, the original value
|
||||
will be returned.
|
||||
|
||||
See '__true_strings' and '__false_strings' for values considered
|
||||
'true' or 'false respectively.
|
||||
|
||||
This is usable as 'converter' for SCons' Variables.
|
||||
"""
|
||||
lval = val.lower()
|
||||
if lval in __true_strings: return True
|
||||
if lval in __false_strings: return False
|
||||
raise ValueError("Invalid value for boolean option: %s" % val)
|
||||
|
||||
|
||||
def _validator(key, val, env):
|
||||
"""
|
||||
Validates the given value to be either '0' or '1'.
|
||||
|
||||
This is usable as 'validator' for SCons' Variables.
|
||||
"""
|
||||
if not env[key] in (True, False):
|
||||
raise SCons.Errors.UserError(
|
||||
'Invalid value for boolean option %s: %s' % (key, env[key]))
|
||||
|
||||
|
||||
def BoolVariable(key, help, default):
|
||||
"""
|
||||
The input parameters describe a boolean option, thus they are
|
||||
returned with the correct converter and validator appended. The
|
||||
'help' text will by appended by '(yes|no) to show the valid
|
||||
valued. The result is usable for input to opts.Add().
|
||||
"""
|
||||
return (key, '%s (yes|no)' % help, default,
|
||||
_validator, _text2bool)
|
||||
|
||||
# Local Variables:
|
||||
# tab-width:4
|
||||
# indent-tabs-mode:nil
|
||||
# End:
|
||||
# vim: set expandtab tabstop=4 shiftwidth=4:
|
||||
101
scons-local-3.0.0/SCons/Variables/EnumVariable.py
Normal file
101
scons-local-3.0.0/SCons/Variables/EnumVariable.py
Normal file
@@ -0,0 +1,101 @@
|
||||
"""engine.SCons.Variables.EnumVariable
|
||||
|
||||
This file defines the option type for SCons allowing only specified
|
||||
input-values.
|
||||
|
||||
Usage example::
|
||||
|
||||
opts = Variables()
|
||||
opts.Add(EnumVariable('debug', 'debug output and symbols', 'no',
|
||||
allowed_values=('yes', 'no', 'full'),
|
||||
map={}, ignorecase=2))
|
||||
...
|
||||
if env['debug'] == 'full':
|
||||
...
|
||||
"""
|
||||
|
||||
#
|
||||
# Copyright (c) 2001 - 2017 The SCons Foundation
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining
|
||||
# a copy of this software and associated documentation files (the
|
||||
# "Software"), to deal in the Software without restriction, including
|
||||
# without limitation the rights to use, copy, modify, merge, publish,
|
||||
# distribute, sublicense, and/or sell copies of the Software, and to
|
||||
# permit persons to whom the Software is furnished to do so, subject to
|
||||
# the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included
|
||||
# in all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
|
||||
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
||||
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
#
|
||||
|
||||
__revision__ = "src/engine/SCons/Variables/EnumVariable.py rel_3.0.0:4395:8972f6a2f699 2017/09/18 12:59:24 bdbaddog"
|
||||
|
||||
__all__ = ['EnumVariable',]
|
||||
|
||||
|
||||
import SCons.Errors
|
||||
|
||||
def _validator(key, val, env, vals):
|
||||
if not val in vals:
|
||||
raise SCons.Errors.UserError(
|
||||
'Invalid value for option %s: %s. Valid values are: %s' % (key, val, vals))
|
||||
|
||||
|
||||
def EnumVariable(key, help, default, allowed_values, map={}, ignorecase=0):
|
||||
"""
|
||||
The input parameters describe an option with only certain values
|
||||
allowed. They are returned with an appropriate converter and
|
||||
validator appended. The result is usable for input to
|
||||
Variables.Add().
|
||||
|
||||
'key' and 'default' are the values to be passed on to Variables.Add().
|
||||
|
||||
'help' will be appended by the allowed values automatically
|
||||
|
||||
'allowed_values' is a list of strings, which are allowed as values
|
||||
for this option.
|
||||
|
||||
The 'map'-dictionary may be used for converting the input value
|
||||
into canonical values (e.g. for aliases).
|
||||
|
||||
'ignorecase' defines the behaviour of the validator:
|
||||
|
||||
If ignorecase == 0, the validator/converter are case-sensitive.
|
||||
If ignorecase == 1, the validator/converter are case-insensitive.
|
||||
If ignorecase == 2, the validator/converter is case-insensitive and the converted value will always be lower-case.
|
||||
|
||||
The 'validator' tests whether the value is in the list of allowed values. The 'converter' converts input values
|
||||
according to the given 'map'-dictionary (unmapped input values are returned unchanged).
|
||||
"""
|
||||
|
||||
help = '%s (%s)' % (help, '|'.join(allowed_values))
|
||||
# define validator
|
||||
if ignorecase >= 1:
|
||||
validator = lambda key, val, env: \
|
||||
_validator(key, val.lower(), env, allowed_values)
|
||||
else:
|
||||
validator = lambda key, val, env: \
|
||||
_validator(key, val, env, allowed_values)
|
||||
# define converter
|
||||
if ignorecase == 2:
|
||||
converter = lambda val: map.get(val.lower(), val).lower()
|
||||
elif ignorecase == 1:
|
||||
converter = lambda val: map.get(val.lower(), val)
|
||||
else:
|
||||
converter = lambda val: map.get(val, val)
|
||||
return (key, help, default, validator, converter)
|
||||
|
||||
# Local Variables:
|
||||
# tab-width:4
|
||||
# indent-tabs-mode:nil
|
||||
# End:
|
||||
# vim: set expandtab tabstop=4 shiftwidth=4:
|
||||
135
scons-local-3.0.0/SCons/Variables/ListVariable.py
Normal file
135
scons-local-3.0.0/SCons/Variables/ListVariable.py
Normal file
@@ -0,0 +1,135 @@
|
||||
"""engine.SCons.Variables.ListVariable
|
||||
|
||||
This file defines the option type for SCons implementing 'lists'.
|
||||
|
||||
A 'list' option may either be 'all', 'none' or a list of names
|
||||
separated by comma. After the option has been processed, the option
|
||||
value holds either the named list elements, all list elements or no
|
||||
list elements at all.
|
||||
|
||||
Usage example::
|
||||
|
||||
list_of_libs = Split('x11 gl qt ical')
|
||||
|
||||
opts = Variables()
|
||||
opts.Add(ListVariable('shared',
|
||||
'libraries to build as shared libraries',
|
||||
'all',
|
||||
elems = list_of_libs))
|
||||
...
|
||||
for lib in list_of_libs:
|
||||
if lib in env['shared']:
|
||||
env.SharedObject(...)
|
||||
else:
|
||||
env.Object(...)
|
||||
"""
|
||||
|
||||
#
|
||||
# Copyright (c) 2001 - 2017 The SCons Foundation
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining
|
||||
# a copy of this software and associated documentation files (the
|
||||
# "Software"), to deal in the Software without restriction, including
|
||||
# without limitation the rights to use, copy, modify, merge, publish,
|
||||
# distribute, sublicense, and/or sell copies of the Software, and to
|
||||
# permit persons to whom the Software is furnished to do so, subject to
|
||||
# the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included
|
||||
# in all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
|
||||
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
||||
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
__revision__ = "src/engine/SCons/Variables/ListVariable.py rel_3.0.0:4395:8972f6a2f699 2017/09/18 12:59:24 bdbaddog"
|
||||
|
||||
# Known Bug: This should behave like a Set-Type, but does not really,
|
||||
# since elements can occur twice.
|
||||
|
||||
__all__ = ['ListVariable',]
|
||||
|
||||
import collections
|
||||
|
||||
import SCons.Util
|
||||
|
||||
|
||||
class _ListVariable(collections.UserList):
|
||||
def __init__(self, initlist=[], allowedElems=[]):
|
||||
collections.UserList.__init__(self, [_f for _f in initlist if _f])
|
||||
self.allowedElems = sorted(allowedElems)
|
||||
|
||||
def __cmp__(self, other):
|
||||
raise NotImplementedError
|
||||
def __eq__(self, other):
|
||||
raise NotImplementedError
|
||||
def __ge__(self, other):
|
||||
raise NotImplementedError
|
||||
def __gt__(self, other):
|
||||
raise NotImplementedError
|
||||
def __le__(self, other):
|
||||
raise NotImplementedError
|
||||
def __lt__(self, other):
|
||||
raise NotImplementedError
|
||||
def __str__(self):
|
||||
if len(self) == 0:
|
||||
return 'none'
|
||||
self.data.sort()
|
||||
if self.data == self.allowedElems:
|
||||
return 'all'
|
||||
else:
|
||||
return ','.join(self)
|
||||
def prepare_to_store(self):
|
||||
return self.__str__()
|
||||
|
||||
def _converter(val, allowedElems, mapdict):
|
||||
"""
|
||||
"""
|
||||
if val == 'none':
|
||||
val = []
|
||||
elif val == 'all':
|
||||
val = allowedElems
|
||||
else:
|
||||
val = [_f for _f in val.split(',') if _f]
|
||||
val = [mapdict.get(v, v) for v in val]
|
||||
notAllowed = [v for v in val if not v in allowedElems]
|
||||
if notAllowed:
|
||||
raise ValueError("Invalid value(s) for option: %s" %
|
||||
','.join(notAllowed))
|
||||
return _ListVariable(val, allowedElems)
|
||||
|
||||
|
||||
## def _validator(key, val, env):
|
||||
## """
|
||||
## """
|
||||
## # todo: write validator for pgk list
|
||||
## return 1
|
||||
|
||||
|
||||
def ListVariable(key, help, default, names, map={}):
|
||||
"""
|
||||
The input parameters describe a 'package list' option, thus they
|
||||
are returned with the correct converter and validator appended. The
|
||||
result is usable for input to opts.Add() .
|
||||
|
||||
A 'package list' option may either be 'all', 'none' or a list of
|
||||
package names (separated by space).
|
||||
"""
|
||||
names_str = 'allowed names: %s' % ' '.join(names)
|
||||
if SCons.Util.is_List(default):
|
||||
default = ','.join(default)
|
||||
help = '\n '.join(
|
||||
(help, '(all|none|comma-separated list of names)', names_str))
|
||||
return (key, help, default,
|
||||
None, #_validator,
|
||||
lambda val: _converter(val, names, map))
|
||||
|
||||
# Local Variables:
|
||||
# tab-width:4
|
||||
# indent-tabs-mode:nil
|
||||
# End:
|
||||
# vim: set expandtab tabstop=4 shiftwidth=4:
|
||||
106
scons-local-3.0.0/SCons/Variables/PackageVariable.py
Normal file
106
scons-local-3.0.0/SCons/Variables/PackageVariable.py
Normal file
@@ -0,0 +1,106 @@
|
||||
"""engine.SCons.Variables.PackageVariable
|
||||
|
||||
This file defines the option type for SCons implementing 'package
|
||||
activation'.
|
||||
|
||||
To be used whenever a 'package' may be enabled/disabled and the
|
||||
package path may be specified.
|
||||
|
||||
Usage example:
|
||||
|
||||
Examples:
|
||||
x11=no (disables X11 support)
|
||||
x11=yes (will search for the package installation dir)
|
||||
x11=/usr/local/X11 (will check this path for existence)
|
||||
|
||||
To replace autoconf's --with-xxx=yyy ::
|
||||
|
||||
opts = Variables()
|
||||
opts.Add(PackageVariable('x11',
|
||||
'use X11 installed here (yes = search some places',
|
||||
'yes'))
|
||||
...
|
||||
if env['x11'] == True:
|
||||
dir = ... search X11 in some standard places ...
|
||||
env['x11'] = dir
|
||||
if env['x11']:
|
||||
... build with x11 ...
|
||||
"""
|
||||
|
||||
#
|
||||
# Copyright (c) 2001 - 2017 The SCons Foundation
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining
|
||||
# a copy of this software and associated documentation files (the
|
||||
# "Software"), to deal in the Software without restriction, including
|
||||
# without limitation the rights to use, copy, modify, merge, publish,
|
||||
# distribute, sublicense, and/or sell copies of the Software, and to
|
||||
# permit persons to whom the Software is furnished to do so, subject to
|
||||
# the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included
|
||||
# in all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
|
||||
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
||||
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
#
|
||||
|
||||
__revision__ = "src/engine/SCons/Variables/PackageVariable.py rel_3.0.0:4395:8972f6a2f699 2017/09/18 12:59:24 bdbaddog"
|
||||
|
||||
__all__ = ['PackageVariable',]
|
||||
|
||||
import SCons.Errors
|
||||
|
||||
__enable_strings = ('1', 'yes', 'true', 'on', 'enable', 'search')
|
||||
__disable_strings = ('0', 'no', 'false', 'off', 'disable')
|
||||
|
||||
def _converter(val):
|
||||
"""
|
||||
"""
|
||||
lval = val.lower()
|
||||
if lval in __enable_strings: return True
|
||||
if lval in __disable_strings: return False
|
||||
#raise ValueError("Invalid value for boolean option: %s" % val)
|
||||
return val
|
||||
|
||||
|
||||
def _validator(key, val, env, searchfunc):
|
||||
# NB: searchfunc is currently undocumented and unsupported
|
||||
"""
|
||||
"""
|
||||
# TODO write validator, check for path
|
||||
import os
|
||||
if env[key] is True:
|
||||
if searchfunc:
|
||||
env[key] = searchfunc(key, val)
|
||||
elif env[key] and not os.path.exists(val):
|
||||
raise SCons.Errors.UserError(
|
||||
'Path does not exist for option %s: %s' % (key, val))
|
||||
|
||||
|
||||
def PackageVariable(key, help, default, searchfunc=None):
|
||||
# NB: searchfunc is currently undocumented and unsupported
|
||||
"""
|
||||
The input parameters describe a 'package list' option, thus they
|
||||
are returned with the correct converter and validator appended. The
|
||||
result is usable for input to opts.Add() .
|
||||
|
||||
A 'package list' option may either be 'all', 'none' or a list of
|
||||
package names (separated by space).
|
||||
"""
|
||||
help = '\n '.join(
|
||||
(help, '( yes | no | /path/to/%s )' % key))
|
||||
return (key, help, default,
|
||||
lambda k, v, e: _validator(k,v,e,searchfunc),
|
||||
_converter)
|
||||
|
||||
# Local Variables:
|
||||
# tab-width:4
|
||||
# indent-tabs-mode:nil
|
||||
# End:
|
||||
# vim: set expandtab tabstop=4 shiftwidth=4:
|
||||
145
scons-local-3.0.0/SCons/Variables/PathVariable.py
Normal file
145
scons-local-3.0.0/SCons/Variables/PathVariable.py
Normal file
@@ -0,0 +1,145 @@
|
||||
"""SCons.Variables.PathVariable
|
||||
|
||||
This file defines an option type for SCons implementing path settings.
|
||||
|
||||
To be used whenever a user-specified path override should be allowed.
|
||||
|
||||
Arguments to PathVariable are:
|
||||
option-name = name of this option on the command line (e.g. "prefix")
|
||||
option-help = help string for option
|
||||
option-dflt = default value for this option
|
||||
validator = [optional] validator for option value. Predefined validators are:
|
||||
|
||||
PathAccept -- accepts any path setting; no validation
|
||||
PathIsDir -- path must be an existing directory
|
||||
PathIsDirCreate -- path must be a dir; will create
|
||||
PathIsFile -- path must be a file
|
||||
PathExists -- path must exist (any type) [default]
|
||||
|
||||
The validator is a function that is called and which
|
||||
should return True or False to indicate if the path
|
||||
is valid. The arguments to the validator function
|
||||
are: (key, val, env). The key is the name of the
|
||||
option, the val is the path specified for the option,
|
||||
and the env is the env to which the Options have been
|
||||
added.
|
||||
|
||||
Usage example::
|
||||
|
||||
Examples:
|
||||
prefix=/usr/local
|
||||
|
||||
opts = Variables()
|
||||
|
||||
opts = Variables()
|
||||
opts.Add(PathVariable('qtdir',
|
||||
'where the root of Qt is installed',
|
||||
qtdir, PathIsDir))
|
||||
opts.Add(PathVariable('qt_includes',
|
||||
'where the Qt includes are installed',
|
||||
'$qtdir/includes', PathIsDirCreate))
|
||||
opts.Add(PathVariable('qt_libraries',
|
||||
'where the Qt library is installed',
|
||||
'$qtdir/lib'))
|
||||
|
||||
"""
|
||||
|
||||
#
|
||||
# Copyright (c) 2001 - 2017 The SCons Foundation
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining
|
||||
# a copy of this software and associated documentation files (the
|
||||
# "Software"), to deal in the Software without restriction, including
|
||||
# without limitation the rights to use, copy, modify, merge, publish,
|
||||
# distribute, sublicense, and/or sell copies of the Software, and to
|
||||
# permit persons to whom the Software is furnished to do so, subject to
|
||||
# the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included
|
||||
# in all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
|
||||
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
||||
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
#
|
||||
|
||||
__revision__ = "src/engine/SCons/Variables/PathVariable.py rel_3.0.0:4395:8972f6a2f699 2017/09/18 12:59:24 bdbaddog"
|
||||
|
||||
__all__ = ['PathVariable',]
|
||||
|
||||
import os
|
||||
import os.path
|
||||
|
||||
import SCons.Errors
|
||||
|
||||
class _PathVariableClass(object):
|
||||
|
||||
def PathAccept(self, key, val, env):
|
||||
"""Accepts any path, no checking done."""
|
||||
pass
|
||||
|
||||
def PathIsDir(self, key, val, env):
|
||||
"""Validator to check if Path is a directory."""
|
||||
if not os.path.isdir(val):
|
||||
if os.path.isfile(val):
|
||||
m = 'Directory path for option %s is a file: %s'
|
||||
else:
|
||||
m = 'Directory path for option %s does not exist: %s'
|
||||
raise SCons.Errors.UserError(m % (key, val))
|
||||
|
||||
def PathIsDirCreate(self, key, val, env):
|
||||
"""Validator to check if Path is a directory,
|
||||
creating it if it does not exist."""
|
||||
if os.path.isfile(val):
|
||||
m = 'Path for option %s is a file, not a directory: %s'
|
||||
raise SCons.Errors.UserError(m % (key, val))
|
||||
if not os.path.isdir(val):
|
||||
os.makedirs(val)
|
||||
|
||||
def PathIsFile(self, key, val, env):
|
||||
"""Validator to check if Path is a file"""
|
||||
if not os.path.isfile(val):
|
||||
if os.path.isdir(val):
|
||||
m = 'File path for option %s is a directory: %s'
|
||||
else:
|
||||
m = 'File path for option %s does not exist: %s'
|
||||
raise SCons.Errors.UserError(m % (key, val))
|
||||
|
||||
def PathExists(self, key, val, env):
|
||||
"""Validator to check if Path exists"""
|
||||
if not os.path.exists(val):
|
||||
m = 'Path for option %s does not exist: %s'
|
||||
raise SCons.Errors.UserError(m % (key, val))
|
||||
|
||||
def __call__(self, key, help, default, validator=None):
|
||||
"""
|
||||
The input parameters describe a 'path list' option, thus they
|
||||
are returned with the correct converter and validator appended. The
|
||||
result is usable for input to opts.Add() .
|
||||
|
||||
The 'default' option specifies the default path to use if the
|
||||
user does not specify an override with this option.
|
||||
|
||||
validator is a validator, see this file for examples
|
||||
"""
|
||||
if validator is None:
|
||||
validator = self.PathExists
|
||||
|
||||
if SCons.Util.is_List(key) or SCons.Util.is_Tuple(key):
|
||||
return (key, '%s ( /path/to/%s )' % (help, key[0]), default,
|
||||
validator, None)
|
||||
else:
|
||||
return (key, '%s ( /path/to/%s )' % (help, key), default,
|
||||
validator, None)
|
||||
|
||||
PathVariable = _PathVariableClass()
|
||||
|
||||
# Local Variables:
|
||||
# tab-width:4
|
||||
# indent-tabs-mode:nil
|
||||
# End:
|
||||
# vim: set expandtab tabstop=4 shiftwidth=4:
|
||||
322
scons-local-3.0.0/SCons/Variables/__init__.py
Normal file
322
scons-local-3.0.0/SCons/Variables/__init__.py
Normal file
@@ -0,0 +1,322 @@
|
||||
"""engine.SCons.Variables
|
||||
|
||||
This file defines the Variables class that is used to add user-friendly
|
||||
customizable variables to an SCons build.
|
||||
"""
|
||||
|
||||
#
|
||||
# Copyright (c) 2001 - 2017 The SCons Foundation
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining
|
||||
# a copy of this software and associated documentation files (the
|
||||
# "Software"), to deal in the Software without restriction, including
|
||||
# without limitation the rights to use, copy, modify, merge, publish,
|
||||
# distribute, sublicense, and/or sell copies of the Software, and to
|
||||
# permit persons to whom the Software is furnished to do so, subject to
|
||||
# the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included
|
||||
# in all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
|
||||
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
||||
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
__revision__ = "src/engine/SCons/Variables/__init__.py rel_3.0.0:4395:8972f6a2f699 2017/09/18 12:59:24 bdbaddog"
|
||||
|
||||
import os.path
|
||||
import sys
|
||||
|
||||
import SCons.Environment
|
||||
import SCons.Errors
|
||||
import SCons.Util
|
||||
import SCons.Warnings
|
||||
|
||||
from .BoolVariable import BoolVariable # okay
|
||||
from .EnumVariable import EnumVariable # okay
|
||||
from .ListVariable import ListVariable # naja
|
||||
from .PackageVariable import PackageVariable # naja
|
||||
from .PathVariable import PathVariable # okay
|
||||
|
||||
|
||||
class Variables(object):
|
||||
instance=None
|
||||
|
||||
"""
|
||||
Holds all the options, updates the environment with the variables,
|
||||
and renders the help text.
|
||||
"""
|
||||
def __init__(self, files=None, args=None, is_global=1):
|
||||
"""
|
||||
files - [optional] List of option configuration files to load
|
||||
(backward compatibility) If a single string is passed it is
|
||||
automatically placed in a file list
|
||||
"""
|
||||
# initialize arguments
|
||||
if files is None:
|
||||
files = []
|
||||
if args is None:
|
||||
args = {}
|
||||
self.options = []
|
||||
self.args = args
|
||||
if not SCons.Util.is_List(files):
|
||||
if files:
|
||||
files = [ files ]
|
||||
else:
|
||||
files = []
|
||||
self.files = files
|
||||
self.unknown = {}
|
||||
|
||||
# create the singleton instance
|
||||
if is_global:
|
||||
self=Variables.instance
|
||||
|
||||
if not Variables.instance:
|
||||
Variables.instance=self
|
||||
|
||||
def _do_add(self, key, help="", default=None, validator=None, converter=None):
|
||||
class Variable(object):
|
||||
pass
|
||||
|
||||
option = Variable()
|
||||
|
||||
# if we get a list or a tuple, we take the first element as the
|
||||
# option key and store the remaining in aliases.
|
||||
if SCons.Util.is_List(key) or SCons.Util.is_Tuple(key):
|
||||
option.key = key[0]
|
||||
option.aliases = key[1:]
|
||||
else:
|
||||
option.key = key
|
||||
option.aliases = [ key ]
|
||||
option.help = help
|
||||
option.default = default
|
||||
option.validator = validator
|
||||
option.converter = converter
|
||||
|
||||
self.options.append(option)
|
||||
|
||||
# options might be added after the 'unknown' dict has been set up,
|
||||
# so we remove the key and all its aliases from that dict
|
||||
for alias in list(option.aliases) + [ option.key ]:
|
||||
if alias in self.unknown:
|
||||
del self.unknown[alias]
|
||||
|
||||
def keys(self):
|
||||
"""
|
||||
Returns the keywords for the options
|
||||
"""
|
||||
return [o.key for o in self.options]
|
||||
|
||||
def Add(self, key, help="", default=None, validator=None, converter=None, **kw):
|
||||
"""
|
||||
Add an option.
|
||||
|
||||
|
||||
@param key: the name of the variable, or a list or tuple of arguments
|
||||
@param help: optional help text for the options
|
||||
@param default: optional default value
|
||||
@param validator: optional function that is called to validate the option's value
|
||||
@type validator: Called with (key, value, environment)
|
||||
@param converter: optional function that is called to convert the option's value before putting it in the environment.
|
||||
"""
|
||||
|
||||
if SCons.Util.is_List(key) or isinstance(key, tuple):
|
||||
self._do_add(*key)
|
||||
return
|
||||
|
||||
if not SCons.Util.is_String(key) or \
|
||||
not SCons.Environment.is_valid_construction_var(key):
|
||||
raise SCons.Errors.UserError("Illegal Variables.Add() key `%s'" % str(key))
|
||||
|
||||
self._do_add(key, help, default, validator, converter)
|
||||
|
||||
def AddVariables(self, *optlist):
|
||||
"""
|
||||
Add a list of options.
|
||||
|
||||
Each list element is a tuple/list of arguments to be passed on
|
||||
to the underlying method for adding options.
|
||||
|
||||
Example::
|
||||
|
||||
opt.AddVariables(
|
||||
('debug', '', 0),
|
||||
('CC', 'The C compiler'),
|
||||
('VALIDATE', 'An option for testing validation', 'notset',
|
||||
validator, None),
|
||||
)
|
||||
|
||||
"""
|
||||
|
||||
for o in optlist:
|
||||
self._do_add(*o)
|
||||
|
||||
|
||||
def Update(self, env, args=None):
|
||||
"""
|
||||
Update an environment with the option variables.
|
||||
|
||||
env - the environment to update.
|
||||
"""
|
||||
|
||||
values = {}
|
||||
|
||||
# first set the defaults:
|
||||
for option in self.options:
|
||||
if not option.default is None:
|
||||
values[option.key] = option.default
|
||||
|
||||
# next set the value specified in the options file
|
||||
for filename in self.files:
|
||||
if os.path.exists(filename):
|
||||
dir = os.path.split(os.path.abspath(filename))[0]
|
||||
if dir:
|
||||
sys.path.insert(0, dir)
|
||||
try:
|
||||
values['__name__'] = filename
|
||||
with open(filename, 'r') as f:
|
||||
contents = f.read()
|
||||
exec(contents, {}, values)
|
||||
finally:
|
||||
if dir:
|
||||
del sys.path[0]
|
||||
del values['__name__']
|
||||
|
||||
# set the values specified on the command line
|
||||
if args is None:
|
||||
args = self.args
|
||||
|
||||
for arg, value in args.items():
|
||||
added = False
|
||||
for option in self.options:
|
||||
if arg in list(option.aliases) + [ option.key ]:
|
||||
values[option.key] = value
|
||||
added = True
|
||||
if not added:
|
||||
self.unknown[arg] = value
|
||||
|
||||
# put the variables in the environment:
|
||||
# (don't copy over variables that are not declared as options)
|
||||
for option in self.options:
|
||||
try:
|
||||
env[option.key] = values[option.key]
|
||||
except KeyError:
|
||||
pass
|
||||
|
||||
# Call the convert functions:
|
||||
for option in self.options:
|
||||
if option.converter and option.key in values:
|
||||
value = env.subst('${%s}'%option.key)
|
||||
try:
|
||||
try:
|
||||
env[option.key] = option.converter(value)
|
||||
except TypeError:
|
||||
env[option.key] = option.converter(value, env)
|
||||
except ValueError as x:
|
||||
raise SCons.Errors.UserError('Error converting option: %s\n%s'%(option.key, x))
|
||||
|
||||
|
||||
# Finally validate the values:
|
||||
for option in self.options:
|
||||
if option.validator and option.key in values:
|
||||
option.validator(option.key, env.subst('${%s}'%option.key), env)
|
||||
|
||||
def UnknownVariables(self):
|
||||
"""
|
||||
Returns any options in the specified arguments lists that
|
||||
were not known, declared options in this object.
|
||||
"""
|
||||
return self.unknown
|
||||
|
||||
def Save(self, filename, env):
|
||||
"""
|
||||
Saves all the options in the given file. This file can
|
||||
then be used to load the options next run. This can be used
|
||||
to create an option cache file.
|
||||
|
||||
filename - Name of the file to save into
|
||||
env - the environment get the option values from
|
||||
"""
|
||||
|
||||
# Create the file and write out the header
|
||||
try:
|
||||
fh = open(filename, 'w')
|
||||
|
||||
try:
|
||||
# Make an assignment in the file for each option
|
||||
# within the environment that was assigned a value
|
||||
# other than the default.
|
||||
for option in self.options:
|
||||
try:
|
||||
value = env[option.key]
|
||||
try:
|
||||
prepare = value.prepare_to_store
|
||||
except AttributeError:
|
||||
try:
|
||||
eval(repr(value))
|
||||
except KeyboardInterrupt:
|
||||
raise
|
||||
except:
|
||||
# Convert stuff that has a repr() that
|
||||
# cannot be evaluated into a string
|
||||
value = SCons.Util.to_String(value)
|
||||
else:
|
||||
value = prepare()
|
||||
|
||||
defaultVal = env.subst(SCons.Util.to_String(option.default))
|
||||
if option.converter:
|
||||
defaultVal = option.converter(defaultVal)
|
||||
|
||||
if str(env.subst('${%s}' % option.key)) != str(defaultVal):
|
||||
fh.write('%s = %s\n' % (option.key, repr(value)))
|
||||
except KeyError:
|
||||
pass
|
||||
finally:
|
||||
fh.close()
|
||||
|
||||
except IOError as x:
|
||||
raise SCons.Errors.UserError('Error writing options to file: %s\n%s' % (filename, x))
|
||||
|
||||
def GenerateHelpText(self, env, sort=None):
|
||||
"""
|
||||
Generate the help text for the options.
|
||||
|
||||
env - an environment that is used to get the current values
|
||||
of the options.
|
||||
"""
|
||||
|
||||
if sort:
|
||||
options = sorted(self.options, key=lambda x: x.key)
|
||||
else:
|
||||
options = self.options
|
||||
|
||||
def format(opt, self=self, env=env):
|
||||
if opt.key in env:
|
||||
actual = env.subst('${%s}' % opt.key)
|
||||
else:
|
||||
actual = None
|
||||
return self.FormatVariableHelpText(env, opt.key, opt.help, opt.default, actual, opt.aliases)
|
||||
lines = [_f for _f in map(format, options) if _f]
|
||||
|
||||
return ''.join(lines)
|
||||
|
||||
format = '\n%s: %s\n default: %s\n actual: %s\n'
|
||||
format_ = '\n%s: %s\n default: %s\n actual: %s\n aliases: %s\n'
|
||||
|
||||
def FormatVariableHelpText(self, env, key, help, default, actual, aliases=[]):
|
||||
# Don't display the key name itself as an alias.
|
||||
aliases = [a for a in aliases if a != key]
|
||||
if len(aliases)==0:
|
||||
return self.format % (key, help, default, actual)
|
||||
else:
|
||||
return self.format_ % (key, help, default, actual, aliases)
|
||||
|
||||
# Local Variables:
|
||||
# tab-width:4
|
||||
# indent-tabs-mode:nil
|
||||
# End:
|
||||
# vim: set expandtab tabstop=4 shiftwidth=4:
|
||||
Reference in New Issue
Block a user