135 lines
4.4 KiB
Python
135 lines
4.4 KiB
Python
"""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 74b2c53bc42290e911b334a6b44f187da698a668 2017/11/14 13:16:53 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:
|