src/engine/SCons/Variables/ListVariable.py

   1 """engine.SCons.Variables.ListVariable
   2
   3 This file defines the option type for SCons implementing 'lists'.
   4
   5 A 'list' option may either be 'all', 'none' or a list of names
   6 separated by comma. After the option has been processed, the option
   7 value holds either the named list elements, all list elemens or no
   8 list elements at all.
   9
  10 Usage example:
  11
  12   list_of_libs = Split('x11 gl qt ical')
  13
  14   opts = Variables()
  15   opts.Add(ListVariable('shared',
  16                       'libraries to build as shared libraries',
  17                       'all',
  18                       elems = list_of_libs))
  19   ...
  20   for lib in list_of_libs:
  21      if lib in env['shared']:
  22          env.SharedObject(...)
  23      else:
  24          env.Object(...)
  25 """
  26
  27 #
  28 # __COPYRIGHT__
  29 #
  30 # Permission is hereby granted, free of charge, to any person obtaining
  31 # a copy of this software and associated documentation files (the
  32 # "Software"), to deal in the Software without restriction, including
  33 # without limitation the rights to use, copy, modify, merge, publish,
  34 # distribute, sublicense, and/or sell copies of the Software, and to
  35 # permit persons to whom the Software is furnished to do so, subject to
  36 # the following conditions:
  37 #
  38 # The above copyright notice and this permission notice shall be included
  39 # in all copies or substantial portions of the Software.
  40 #
  41 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  42 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  43 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  44 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  45 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  46 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  47 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  48 #
  49 from __future__ import generators  ### KEEP FOR COMPATIBILITY FIXERS
  50
  51 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
  52
  53 # Know Bug: This should behave like a Set-Type, but does not really,
  54 # since elements can occur twice.
  55
  56 __all__ = ['ListVariable',]
  57
  58 import UserList
  59
  60 import SCons.Util
  61
  62
  63 class _ListVariable(UserList.UserList):
  64     def __init__(self, initlist=[], allowedElems=[]):
  65         UserList.UserList.__init__(self, [_f for _f in initlist if _f])
  66         self.allowedElems = sorted(allowedElems)
  67
  68     def __cmp__(self, other):
  69         raise NotImplementedError
  70     def __eq__(self, other):
  71         raise NotImplementedError
  72     def __ge__(self, other):
  73         raise NotImplementedError
  74     def __gt__(self, other):
  75         raise NotImplementedError
  76     def __le__(self, other):
  77         raise NotImplementedError
  78     def __lt__(self, other):
  79         raise NotImplementedError
  80     def __str__(self):
  81         if len(self) == 0:
  82             return 'none'
  83         self.data.sort()
  84         if self.data == self.allowedElems:
  85             return 'all'
  86         else:
  87             return ','.join(self)
  88     def prepare_to_store(self):
  89         return self.__str__()
  90
  91 def _converter(val, allowedElems, mapdict):
  92     """
  93     """
  94     if val == 'none':
  95         val = []
  96     elif val == 'all':
  97         val = allowedElems
  98     else:
  99         val = [_f for _f in val.split(',') if _f]
 100         val = [mapdict.get(v, v) for v in val]
 101         notAllowed = [v for v in val if not v in allowedElems]
 102         if notAllowed:
 103             raise ValueError("Invalid value(s) for option: %s" %
 104                              ','.join(notAllowed))
 105     return _ListVariable(val, allowedElems)
 106
 107
 108 ## def _validator(key, val, env):
 109 ##     """
 110 ##     """
 111 ##     # todo: write validater for pgk list
 112 ##     return 1
 113
 114
 115 def ListVariable(key, help, default, names, map={}):
 116     """
 117     The input parameters describe a 'package list' option, thus they
 118     are returned with the correct converter and validater appended. The
 119     result is usable for input to opts.Add() .
 120
 121     A 'package list' option may either be 'all', 'none' or a list of
 122     package names (separated by space).
 123     """
 124     names_str = 'allowed names: %s' % ' '.join(names)
 125     if SCons.Util.is_List(default):
 126         default = ','.join(default)
 127     help = '\n    '.join(
 128         (help, '(all|none|comma-separated list of names)', names_str))
 129     return (key, help, default,
 130             None, #_validator,
 131             lambda val: _converter(val, names, map))
 132
 133 # Local Variables:
 134 # tab-width:4
 135 # indent-tabs-mode:nil
 136 # End:
 137 # vim: set expandtab tabstop=4 shiftwidth=4: