Works callback/multi/master-slave
[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, index=None):
34     "a function that carries out a calculation for an option's value"
35     #callback, callback_params = option.getcallback()
36     #if callback_params is None:
37     #    callback_params = {}
38     tcparams = {}
39     one_is_multi = False
40     len_multi = 0
41
42     for key, values in callback_params.items():
43         for value in values:
44             if type(value) == tuple:
45                 path, check_disabled = value
46                 if config is None:
47                     if check_disabled:
48                         continue
49                     raise ConfigError(_('no config specified but needed'))
50                 try:
51                     opt_value = config._getattr(path, force_permissive=True)
52                     opt = config.unwrap_from_path(path)
53                 except PropertiesOptionError, err:
54                     if check_disabled:
55                         continue
56                     raise PropertiesOptionError(err, err.proptype)
57                 is_multi = opt.impl_is_multi()
58                 if is_multi:
59                     if opt_value is not None:
60                         len_value = len(opt_value)
61                         if len_multi != 0 and len_multi != len_value:
62                             raise ConfigError('unable to carry out a '
63                                               'calculation, option values with'
64                                               ' multi types must have same '
65                                               'length for: ' + name)
66                         len_multi = len_value
67                     one_is_multi = True
68                 tcparams.setdefault(key, []).append((opt_value, is_multi))
69             else:
70                 tcparams.setdefault(key, []).append((value, False))
71
72     if one_is_multi:
73         ret = []
74         if index:
75             range_ = [index]
76         else:
77             range_ = range(len_multi)
78         for incr in range_:
79             tcp = {}
80             params = []
81             for key, couples in tcparams.items():
82                 for couple in couples:
83                     value, ismulti = couple
84                     if ismulti and value is not None:
85                         if key == '':
86                             params.append(value[incr])
87                         else:
88                             if len(value) > incr:
89                                 tcp[key] = value[incr]
90                             else:
91                                 tcp[key] = ''
92                     else:
93                         if key == '':
94                             params.append(value)
95                         else:
96                             tcp[key] = value
97             calc = calculate(name, callback, params, tcp)
98             if index:
99                 ret = calc
100             else:
101                 if isinstance(calc, list):
102                     ret.extend(calc)
103                 else:
104                     ret.append(calc)
105
106         return ret
107     else:
108         tcp = {}
109         params = []
110         for key, couples in tcparams.items():
111             for couple in couples:
112                 if key == '':
113                     value = couple[0]
114                     params.append(value)
115                 else:
116                     tcp[key] = couple[0]
117         return calculate(name, callback, params, tcp)
118
119
120 def calculate(name, callback, params, tcparams):
121     """wrapper that launches the 'callback'
122
123     :param callback: callback name
124     :param params: in the callback's arity, the unnamed parameters
125     :param tcparams: in the callback's arity, the named parameters
126
127     """
128     return callback(*params, **tcparams)