new api documentation
[tiramisu.git] / tiramisu / autolib.py
1 # Copyright (C) 2012-2013 Team tiramisu (see AUTHORS for all contributors)
2 #
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 2 of the License, or
6 # (at your option) any later version.
7 #
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 # GNU General Public License for more details.
12 #
13 # You should have received a copy of the GNU General Public License
14 # along with this program; if not, write to the Free Software
15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16 #
17 # The original `Config` design model is unproudly borrowed from
18 # the rough gus of pypy: pypy: http://codespeak.net/svn/pypy/dist/pypy/config/
19 # the whole pypy projet is under MIT licence
20 # ____________________________________________________________
21 "enables us to carry out a calculation and return an option's value"
22 from tiramisu.error import PropertiesOptionError, ConfigError
23 from tiramisu.i18n import _
24 # ____________________________________________________________
25 # automatic Option object
26 #def special_owner_factory(name, owner, value,
27 #                          callback, callback_params=None, config=None):
28 #    # in case of an 'auto' and a 'fill' without a value,
29 #    # we have to carry out a calculation
30 #    return calc_factory(name, callback, callback_params, config)
31
32
33 def carry_out_calculation(name, config, callback, callback_params):
34     #callback, callback_params = option.getcallback()
35     #if callback_params is None:
36     #    callback_params = {}
37     tcparams = {}
38     one_is_multi = False
39     len_multi = 0
40
41     for key, values in callback_params.items():
42         for value in values:
43             if type(value) == tuple:
44                 path, check_disabled = value
45                 if config is None:
46                     if check_disabled:
47                         continue
48                     raise ConfigError(_('no config specified but needed'))
49                 try:
50                     opt_value = config._getattr(path, force_permissive=True)
51                     opt = config.unwrap_from_path(path)
52                 except PropertiesOptionError, err:
53                     if check_disabled:
54                         continue
55                     raise PropertiesOptionError(err, err.proptype)
56                 is_multi = opt.impl_is_multi()
57                 if is_multi:
58                     if opt_value is not None:
59                         len_value = len(opt_value)
60                         if len_multi != 0 and len_multi != len_value:
61                             raise ConfigError('unable to carry out a '
62                                               'calculation, option values with'
63                                               ' multi types must have same '
64                                               'length for: ' + name)
65                         len_multi = len_value
66                     one_is_multi = True
67                 tcparams.setdefault(key, []).append((opt_value, is_multi))
68             else:
69                 tcparams.setdefault(key, []).append((value, False))
70
71     if one_is_multi:
72         ret = []
73         for incr in range(len_multi):
74             tcp = {}
75             params = []
76             for key, couples in tcparams.items():
77                 for couple in couples:
78                     value, ismulti = couple
79                     if ismulti and value is not None:
80                         if key == '':
81                             params.append(value[incr])
82                         else:
83                             if len(value) > incr:
84                                 tcp[key] = value[incr]
85                             else:
86                                 tcp[key] = ''
87                     else:
88                         if key == '':
89                             params.append(value)
90                         else:
91                             tcp[key] = value
92             calc = calculate(name, callback, params, tcp)
93             if isinstance(calc, list):
94                 ret.extend(calc)
95             else:
96                 ret.append(calc)
97
98         return ret
99     else:
100         tcp = {}
101         params = []
102         for key, couples in tcparams.items():
103             for couple in couples:
104                 if key == '':
105                     value = couple[0]
106                     params.append(value)
107                 else:
108                     tcp[key] = couple[0]
109         return calculate(name, callback, params, tcp)
110
111
112 def calculate(name, callback, params, tcparams):
113     """wrapper that launches the callback, that is a function
114     that carries out a calculation for an option's value
115
116     :param callback: callback name
117     :param params: in the callback's arity, the unnamed parameters
118     :param tcparams: in the callback's arity, the named parameters
119     
120     """
121     return callback(*params, **tcparams)