503bcdd04207351a7c0fbd43f97725aa03587ad5
[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.setting import multitypes
24 from tiramisu.i18n import _
25 # ____________________________________________________________
26
27
28 def carry_out_calculation(option, config, callback, callback_params,
29                           index=None, max_len=None):
30     """a function that carries out a calculation for an option's value
31
32     :param name: the option name (`opt.impl_getname()`)
33     :param name: the option
34     :param config: the context config in order to have
35                    the whole options available
36     :param callback: the name of the callback function
37     :type callback: str
38     :param callback_params: the callback's parameters
39                             (only keyword parameters are allowed)
40     :type callback_params: dict
41     :param index: if an option is multi, only calculates the nth value
42     :type index: int
43     :param max_len: max length for a multi
44     :type max_len: int
45
46     The callback_params is a dict. Key is used to build args (if key is '')
47     and kwargs (otherwise). Values are tuple of:
48     - values
49     - tuple with option and boolean's force_permissive (True when don't raise
50     if PropertiesOptionError)
51     Values could have multiple values only when key is ''.
52
53     * if no callback_params:
54       => calculate(<function func at 0x2092320>, [], {})
55
56     * if callback_params={'': ('yes',)}
57       => calculate(<function func at 0x2092320>, ['yes'], {})
58
59     * if callback_params={'value': ('yes',)}
60       => calculate(<function func at 0x165b320>, [], {'value': 'yes'})
61
62     * if callback_params={'': ('yes', 'no')}
63       => calculate('yes', 'no')
64
65     * if callback_params={'value': ('yes', 'no')}
66       => ValueError()
67
68     * if callback_params={'': (['yes', 'no'],)}
69       => calculate(<function func at 0x176b320>, ['yes', 'no'], {})
70
71     * if callback_params={'value': ('yes', 'no')}
72       => raises ValueError()
73
74     * if callback_params={'': ((opt1, False),)}
75
76        - a simple option:
77          opt1 == 11
78          => calculate(<function func at 0x1cea320>, [11], {})
79
80        - a multi option and not master/slave:
81          opt1 == [1, 2, 3]
82          => calculate(<function func at 0x223c320>, [[1, 2, 3]], {})
83
84        - option is master or slave of opt1:
85          opt1 == [1, 2, 3]
86          => calculate(<function func at 0x223c320>, [1], {})
87          => calculate(<function func at 0x223c320>, [2], {})
88          => calculate(<function func at 0x223c320>, [3], {})
89
90       - opt is a master or slave but not related to option:
91         opt1 == [1, 2, 3]
92         => calculate(<function func at 0x11b0320>, [[1, 2, 3]], {})
93
94     * if callback_params={'value': ((opt1, False),)}
95
96        - a simple option:
97          opt1 == 11
98          => calculate(<function func at 0x17ff320>, [], {'value': 11})
99
100        - a multi option:
101          opt1 == [1, 2, 3]
102          => calculate(<function func at 0x1262320>, [], {'value': [1, 2, 3]})
103
104     * if callback_params={'': ((opt1, False), (opt2, False))}
105
106       - two single options
107           opt1 = 11
108           opt2 = 12
109           => calculate(<function func at 0x217a320>, [11, 12], {})
110
111       - a multi option with a simple option
112           opt1 == [1, 2, 3]
113           opt2 == 12
114           => calculate(<function func at 0x2153320>, [[1, 2, 3], 12], {})
115
116       - a multi option with an other multi option but with same length
117           opt1 == [1, 2, 3]
118           opt2 == [11, 12, 13]
119           => calculate(<function func at 0x1981320>, [[1, 2, 3], [11, 12, 13]], {})
120
121       - a multi option with an other multi option but with different length
122           opt1 == [1, 2, 3]
123           opt2 == [11, 12]
124           => calculate(<function func at 0x2384320>, [[1, 2, 3], [11, 12]], {})
125
126       - a multi option without value with a simple option
127           opt1 == []
128           opt2 == 11
129           => calculate(<function func at 0xb65320>, [[], 12], {})
130
131     * if callback_params={'value': ((opt1, False), (opt2, False))}
132       => raises ValueError()
133
134     If index is not None, return a value, otherwise return:
135
136     * a list if one parameters have multi option
137     * a value otherwise
138
139     If calculate return list, this list is extend to return value.
140     """
141     tcparams = {}
142     # if callback_params has a callback, launch several time calculate()
143     one_is_multi = False
144     # multi's option should have same value for all option
145     len_multi = None
146     for callbacks in callback_params:
147         key = callbacks.name
148         for callbk in callbacks.params:
149             if callbk.option is not None:
150                 # callbk is something link (opt, True|False)
151                 opt = callbk.get_option(config)
152                 force_permissive = callbk.force_permissive
153                 path = config.cfgimpl_get_description().impl_get_path_by_opt(
154                     opt)
155                 # get value
156                 try:
157                     value = config._getattr(path, force_permissive=True)
158                 except PropertiesOptionError as err:
159                     if force_permissive:
160                         continue
161                     raise ConfigError(_('unable to carry out a calculation, '
162                                         'option {0} has properties: {1} for: '
163                                         '{2}').format(option.impl_getname(),
164                                                       err.proptype,
165                                                       option._name))
166
167                 is_multi = False
168                 if opt.impl_is_multi():
169                     #opt is master, search if option is a slave
170                     if opt.impl_get_multitype() == multitypes.master:
171                         if option in opt.impl_get_master_slaves():
172                             is_multi = True
173                     #opt is slave, search if option is an other slaves
174                     elif opt.impl_get_multitype() == multitypes.slave:
175                         if option in opt.impl_get_master_slaves().impl_get_master_slaves():
176                             is_multi = True
177                 if is_multi:
178                     len_multi = len(value)
179                     one_is_multi = True
180                 tcparams.setdefault(key, []).append((value, is_multi))
181             else:
182                 # callbk is a value and not a multi
183                 tcparams.setdefault(key, []).append((callbk.value, False))
184
185     # if one value is a multi, launch several time calculate
186     # if index is set, return a value
187     # if no index, return a list
188     if one_is_multi:
189         ret = []
190         if index:
191             range_ = [index]
192         else:
193             range_ = range(len_multi)
194         for incr in range_:
195             args = []
196             kwargs = {}
197             for key, couples in tcparams.items():
198                 for couple in couples:
199                     value, ismulti = couple
200                     if ismulti:
201                         val = value[incr]
202                     else:
203                         val = value
204                     if key == '':
205                         args.append(val)
206                     else:
207                         kwargs[key] = val
208             calc = calculate(callback, args, kwargs)
209             if index:
210                 ret = calc
211             else:
212                 ret.append(calc)
213         return ret
214     else:
215         # no value is multi
216         # return a single value
217         args = []
218         kwargs = {}
219         for key, couples in tcparams.items():
220             for couple in couples:
221                 # couple[1] (ismulti) is always False
222                 if key == '':
223                     args.append(couple[0])
224                 else:
225                     kwargs[key] = couple[0]
226         ret = calculate(callback, args, kwargs)
227         if callback_params != {}:
228             if isinstance(ret, list) and max_len:
229                 ret = ret[:max_len]
230                 if len(ret) < max_len:
231                     ret = ret + [None] * (max_len - len(ret))
232             if isinstance(ret, list) and index:
233                 if len(ret) < index + 1:
234                     ret = None
235                 else:
236                     ret = ret[index]
237         return ret
238
239
240 def calculate(callback, args, kwargs):
241     """wrapper that launches the 'callback'
242
243     :param callback: callback function
244     :param args: in the callback's arity, the unnamed parameters
245     :param kwargs: in the callback's arity, the named parameters
246
247     """
248     return callback(*args, **kwargs)