c6a8da67c281eb9bbaf9baddf987a112058ff426
[bertos.git] / wizard / BModulePage.py
1 #!/usr/bin/env python
2 # encoding: utf-8
3 #
4 # This file is part of BeRTOS.
5 #
6 # Bertos is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
10 #
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19 #
20 # As a special exception, you may use this file as part of a free software
21 # library without restriction.  Specifically, if other files instantiate
22 # templates or use macros or inline functions from this file, or you compile
23 # this file and link it with other files to produce an executable, this
24 # file does not by itself cause the resulting executable to be covered by
25 # the GNU General Public License.  This exception does not however
26 # invalidate any other reasons why the executable file might be covered by
27 # the GNU General Public License.
28 #
29 # Copyright 2008 Develer S.r.l. (http://www.develer.com/)
30 #
31 # $Id$
32 #
33 # Author: Lorenzo Berni <duplo@develer.com>
34 #
35
36 import os
37
38 from PyQt4.QtCore import *
39 from PyQt4.QtGui import *
40 from BWizardPage import *
41 import bertos_utils
42
43 from bertos_utils import SupportedException
44 from DefineException import *
45 from const import *
46
47 class BModulePage(BWizardPage):
48     """
49     Page of the wizard that permits to select and configurate the BeRTOS modules.
50     """
51     
52     def __init__(self):
53         BWizardPage.__init__(self, UI_LOCATION + "/module_select.ui")
54         self.setTitle(self.tr("Configure the BeRTOS modules"))
55         self._control_group = QControlGroup()
56         ## special connection needed for the QControlGroup
57         self.connect(self._control_group, SIGNAL("stateChanged"), self.saveValue)
58     
59     ## Overloaded BWizardPage methods ##
60
61     def setupUi(self):
62         """
63         Overload of BWizardPage setupUi method.
64         """
65         self.pageContent.moduleTree.clear()
66         self.pageContent.moduleTree.setHeaderHidden(True)
67         self.pageContent.propertyTable.horizontalHeader().setResizeMode(QHeaderView.Stretch)
68         self.pageContent.propertyTable.horizontalHeader().setVisible(False)
69         self.pageContent.propertyTable.verticalHeader().setResizeMode(QHeaderView.ResizeToContents)
70         self.pageContent.propertyTable.verticalHeader().setVisible(False)
71         self.pageContent.propertyTable.setColumnCount(2)
72         self.pageContent.propertyTable.setRowCount(0)
73         self.pageContent.moduleLabel.setVisible(False)
74         self.pageContent.warningLabel.setVisible(False)
75     
76     def connectSignals(self):
77         """
78         Overload of the BWizardPage connectSignals method.
79         """
80         self.connect(self.pageContent.moduleTree, SIGNAL("itemPressed(QTreeWidgetItem*, int)"), self.fillPropertyTable)
81         self.connect(self.pageContent.moduleTree, SIGNAL("itemPressed(QTreeWidgetItem*, int)"), self.moduleClicked)
82         self.connect(self.pageContent.moduleTree, SIGNAL("itemChanged(QTreeWidgetItem*, int)"), self.dependencyCheck)
83         self.connect(self.pageContent.propertyTable, SIGNAL("itemSelectionChanged()"), self.showPropertyDescription)
84
85     def reloadData(self):
86         """
87         Overload of the BWizardPage reloadData method.
88         """
89         try:
90             QApplication.instance().setOverrideCursor(Qt.WaitCursor)
91             self.setupUi()
92             self.loadModuleData()
93             self.fillModuleTree()
94         finally:
95             QApplication.instance().restoreOverrideCursor()
96     
97     ####
98     
99     ## Slots ##
100
101     def moduleClicked(self, item, column):
102         self.setBold(item, False)
103
104     def fillPropertyTable(self):
105         """
106         Slot called when the user selects a module from the module tree.
107         Fills the property table using the configuration parameters defined in
108         the source tree.
109         """
110         module = self.currentModule()
111         if module:
112             try:
113                 supported = bertos_utils.isSupported(self.project, module=module)
114             except SupportedException, e:
115                 self.exceptionOccurred(self.tr("Error evaluating \"%1\" for module %2").arg(e.support_string).arg(module))
116                 supported = True
117             self._control_group.clear()
118             configuration = self.projectInfo("MODULES")[module]["configuration"]
119             module_description = self.projectInfo("MODULES")[module]["description"]
120             self.pageContent.moduleLabel.setText(module_description)
121             self.pageContent.moduleLabel.setVisible(True)
122             if not supported:
123                 self.pageContent.warningLabel.setVisible(True)
124                 selected_cpu = self.projectInfo("CPU_NAME")
125                 self.pageContent.warningLabel.setText(self.tr("<font color='#FF0000'>Warning: the selected module, \
126                     is not completely supported by the %1.</font>").arg(selected_cpu))
127             else:
128                 self.pageContent.warningLabel.setVisible(False)
129             self.pageContent.propertyTable.clear()
130             self.pageContent.propertyTable.setRowCount(0)
131             if configuration != "":
132                 configurations = self.projectInfo("CONFIGURATIONS")[configuration]
133                 param_list = sorted(configurations["paramlist"])
134                 index = 0
135                 for i, property in param_list:
136                     if "type" in configurations[property]["informations"] and configurations[property]["informations"]["type"] == "autoenabled":
137                         # Doesn't show the hidden fields
138                         continue
139                     try:
140                         param_supported = bertos_utils.isSupported(self.project, property_id=(configuration, property))
141                     except SupportedException, e:
142                         self.exceptionOccurred(self.tr("Error evaluating \"%1\" for parameter %2").arg(e.support_string).arg(property))
143                         param_supported = True
144                     if not param_supported:
145                         # Doesn't show the unsupported parameters
146                         continue
147                     # Set the row count to the current index + 1
148                     self.pageContent.propertyTable.setRowCount(index + 1)
149                     item = QTableWidgetItem(configurations[property]["brief"])
150                     item.setData(Qt.UserRole, qvariant_converter.convertString(property))
151                     self.pageContent.propertyTable.setItem(index, 0, item)
152                     if "type" in configurations[property]["informations"] and configurations[property]["informations"]["type"] == "boolean":
153                         self.insertCheckBox(index, configurations[property]["value"])
154                     elif "type" in configurations[property]["informations"] and configurations[property]["informations"]["type"] == "enum":
155                         self.insertComboBox(index, configurations[property]["value"], configurations[property]["informations"]["value_list"])
156                     elif "type" in configurations[property]["informations"] and configurations[property]["informations"]["type"] == "int":
157                         self.insertSpinBox(index, configurations[property]["value"], configurations[property]["informations"])
158                     else:
159                         # Not defined type, rendered as a text field
160                         self.pageContent.propertyTable.setItem(index, 1, QTableWidgetItem(configurations[property]["value"]))
161                     index += 1
162             if self.pageContent.propertyTable.rowCount() == 0:
163                 module_label = self.pageContent.moduleLabel.text()
164                 module_label += "\n\nNo configuration needed."
165                 self.pageContent.moduleLabel.setText(module_label) 
166         else:
167             self.pageContent.moduleLabel.setText("")
168             self.pageContent.moduleLabel.setVisible(False)
169             self.pageContent.propertyTable.clear()
170             self.pageContent.propertyTable.setRowCount(0)
171
172     def dependencyCheck(self, item):
173         """
174         Checks the dependencies of the module associated with the given item.
175         """
176         checked = False
177         module = unicode(item.text(0))
178         if item.checkState(0) == Qt.Checked:
179             self.moduleSelected(module)
180         else:
181             self.moduleUnselected(module)
182             self.removeFileDependencies(module)
183
184     def showPropertyDescription(self):
185         """
186         Slot called when the property selection changes. Shows the description
187         of the selected property.
188         """
189         self.resetPropertyDescription()
190         configurations = self.currentModuleConfigurations()
191         if self.currentProperty() in configurations:
192             description = configurations[self.currentProperty()]["brief"]
193             name = self.currentProperty()
194             self.currentPropertyItem().setText(description + "\n" + name)
195
196     def saveValue(self, index):
197         """
198         Slot called when the user modifies one of the configuration parameters.
199         It stores the new value."""
200         property = qvariant_converter.getString(self.pageContent.propertyTable.item(index, 0).data(Qt.UserRole))
201         configuration = self.projectInfo("MODULES")[self.currentModule()]["configuration"]
202         configurations = self.projectInfo("CONFIGURATIONS")
203         if "type" not in configurations[configuration][property]["informations"] or configurations[configuration][property]["informations"]["type"] == "int":
204             configurations[configuration][property]["value"] = unicode(int(self.pageContent.propertyTable.cellWidget(index, 1).value()))
205         elif configurations[configuration][property]["informations"]["type"] == "enum":
206             configurations[configuration][property]["value"] = unicode(self.pageContent.propertyTable.cellWidget(index, 1).currentText())
207         elif configurations[configuration][property]["informations"]["type"] == "boolean":
208             if self.pageContent.propertyTable.cellWidget(index, 1).isChecked():
209                 configurations[configuration][property]["value"] = "1"
210             else:
211                 configurations[configuration][property]["value"] = "0"
212         self.setProjectInfo("CONFIGURATIONS", configurations)
213         if self.moduleItem(self.currentModule()).checkState(0) == Qt.Checked:
214             self.dependencyCheck(self.moduleItem(self.currentModule()))
215
216     ####
217     
218     def loadModuleData(self):
219         """
220         Loads the module data.
221         """
222         if not self.project.edit:
223             # Load the module data every time so that if the user changed the cpu
224             # the right configurations are picked up.
225             try:
226                 self.project.loadModuleData()
227             except ModuleDefineException, e:
228                 self.exceptionOccurred(self.tr("Error parsing line '%2' in file %1").arg(e.path).arg(e.line))
229             except EnumDefineException, e:
230                 self.exceptionOccurred(self.tr("Error parsing line '%2' in file %1").arg(e.path).arg(e.line))
231             except ConfigurationDefineException, e:
232                 self.exceptionOccurred(self.tr("Error parsing line '%2' in file %1").arg(e.path).arg(e.line))
233     
234     def fillModuleTree(self):
235         """
236         Fills the module tree with the module entries separated in categories.
237         """
238         self.pageContent.moduleTree.clear()
239         modules = self.projectInfo("MODULES")
240         if not modules:
241             return
242         categories = {}
243         for module, information in modules.items():
244             if information["category"] not in categories:
245                 categories[information["category"]] = []
246             categories[information["category"]].append(module)
247         for category, module_list in categories.items():
248             item = QTreeWidgetItem(QStringList([category]))
249             for module in module_list:
250                 enabled = modules[module]["enabled"]
251                 module_item = QTreeWidgetItem(item, QStringList([module]))
252                 try:
253                     supported = bertos_utils.isSupported(self.project, module=module)
254                 except SupportedException, e:
255                     self.exceptionOccurred(self.tr("Error evaluating \"%1\" for module %2").arg(e.support_string).arg(module))
256                     supported = True
257                 if not supported:
258                     module_item.setForeground(0, QBrush(QColor(Qt.red)))
259                 if enabled:
260                     module_item.setCheckState(0, Qt.Checked)
261                 else:
262                     module_item.setCheckState(0, Qt.Unchecked)
263             self.pageContent.moduleTree.addTopLevelItem(item)
264         self.pageContent.moduleTree.sortItems(0, Qt.AscendingOrder)
265         self.fillPropertyTable()
266             
267     def insertCheckBox(self, index, value):
268         """
269         Inserts in the table at index a checkbox for a boolean property setted
270         to value.
271         """
272         check_box = QCheckBox()
273         self.pageContent.propertyTable.setCellWidget(index, 1, check_box)
274         if value == "1":
275             check_box.setChecked(True)
276         else:
277             check_box.setChecked(False)
278         self._control_group.addControl(index, check_box)
279     
280     def insertComboBox(self, index, value, value_list):
281         """
282         Inserts in the table at index a combobox for an enum property setted
283         to value.
284         """
285         try:
286             enum = self.projectInfo("LISTS")[value_list]
287             combo_box = QComboBox()
288             self.pageContent.propertyTable.setCellWidget(index, 1, combo_box)
289             for i, element in enumerate(enum):
290                 combo_box.addItem(element)
291                 if element == value:
292                     combo_box.setCurrentIndex(i)
293             self._control_group.addControl(index, combo_box)
294         except KeyError:
295             self.exceptionOccurred(self.tr("Define list \"%1\" not found. Check definition files.").arg(value_list))
296             self.pageContent.propertyTable.setItem(index, 1, QTableWidgetItem(value))
297     
298     def insertSpinBox(self, index, value, informations):
299         """
300         Inserts in the table at index a spinbox for an int, a long or an unsigned
301         long property setted to value.
302         """
303         # int, long or undefined type property
304         spin_box = None
305         if bertos_utils.isLong(informations) or bertos_utils.isUnsignedLong(informations):
306             spin_box = QDoubleSpinBox()
307             spin_box.setDecimals(0)
308         else:
309             spin_box = QSpinBox()
310         self.pageContent.propertyTable.setCellWidget(index, 1, spin_box)
311         minimum = -32768
312         maximum = 32767
313         suff = ""
314         if bertos_utils.isLong(informations):
315             minimum = -2147483648
316             maximum = 2147483647
317             suff = "L"
318         elif bertos_utils.isUnsigned(informations):
319             minimum = 0
320             maximum = 65535
321             suff = "U"
322         elif bertos_utils.isUnsignedLong(informations):
323             minimum = 0
324             maximum = 4294967295
325             suff = "UL"
326         if "min" in informations:
327             minimum = int(informations["min"])
328         if "max" in informations:
329             maximum = int(informations["max"])
330         spin_box.setRange(minimum, maximum)
331         spin_box.setSuffix(suff)
332         spin_box.setValue(int(value.replace("L", "").replace("U", "")))
333         self._control_group.addControl(index, spin_box)
334         
335     
336     def currentModule(self):
337         """
338         Retuns the current module name.
339         """
340         current_module = self.pageContent.moduleTree.currentItem()
341         # return only the child items
342         if current_module and current_module.parent():
343             return unicode(current_module.text(0))
344         else:
345             return None
346
347     def moduleItem(self, module):
348         for top_level_index in range(self.pageContent.moduleTree.topLevelItemCount()):
349             top_level_item = self.pageContent.moduleTree.topLevelItem(top_level_index)
350             for child_index in range(top_level_item.childCount()):
351                 child_item = top_level_item.child(child_index)
352                 if unicode(child_item.text(0)) == module:
353                     return child_item
354         return None
355     
356     def currentModuleConfigurations(self):
357         """
358         Returns the current module configuration.
359         """
360         return self.configurations(self.currentModule())
361     
362     def currentProperty(self):
363         """
364         Rerturns the current property from the property table.
365         """
366         return qvariant_converter.getString(self.pageContent.propertyTable.item(self.pageContent.propertyTable.currentRow(), 0).data(Qt.UserRole))
367     
368     def currentPropertyItem(self):
369         """
370         Returns the QTableWidgetItem of the current property.
371         """
372         return self.pageContent.propertyTable.item(self.pageContent.propertyTable.currentRow(), 0)
373     
374     def configurations(self, module):
375         """
376         Returns the configuration for the selected module.
377         """
378         configuration = []
379         if module:
380             # On linux platform it seems that the behaviour of the focus
381             # changing is a bit different from the mac one. So if module is
382             # None then no configurations should be returned.
383             configuration = self.projectInfo("MODULES")[module]["configuration"]
384         if len(configuration) > 0:
385             return self.projectInfo("CONFIGURATIONS")[configuration]
386         else:
387             return {}
388     
389     def resetPropertyDescription(self):
390         """
391         Resets the label for each property table entry.
392         """
393         for index in range(self.pageContent.propertyTable.rowCount()):
394             property_name = qvariant_converter.getString(self.pageContent.propertyTable.item(index, 0).data(Qt.UserRole))
395             # Awful solution! Needed because if the user change the module, the selection changed...
396             if property_name not in self.currentModuleConfigurations():
397                 break
398             self.pageContent.propertyTable.item(index, 0).setText(self.currentModuleConfigurations()[property_name]['brief'])
399     
400     def setBold(self, item, bold):
401         self.pageContent.moduleTree.blockSignals(True)
402         font = item.font(0)
403         font.setBold(bold)
404         item.setFont(0, font)
405         self.pageContent.moduleTree.blockSignals(False)
406
407     def moduleSelected(self, selectedModule):
408         """
409         Resolves the selection dependencies.
410         """
411         try:
412             qApp.setOverrideCursor(Qt.WaitCursor)
413             modules = self.projectInfo("MODULES")
414             modules[selectedModule]["enabled"] = True
415             self.setProjectInfo("MODULES", modules)
416             depends = self.projectInfo("MODULES")[selectedModule]["depends"]
417             unsatisfied = []
418             if self.pageContent.automaticFix.isChecked():
419                 unsatisfied = self.selectDependencyCheck(selectedModule)
420             if len(unsatisfied) > 0:
421                 for module in unsatisfied:
422                     modules = self.projectInfo("MODULES")
423                     modules[module]["enabled"] = True
424                 for category in range(self.pageContent.moduleTree.topLevelItemCount()):
425                     item = self.pageContent.moduleTree.topLevelItem(category)
426                     for child in range(item.childCount()):
427                         if unicode(item.child(child).text(0)) in unsatisfied:
428                             self.setBold(item.child(child), True)
429                             self.setBold(item, True)
430                             item.child(child).setCheckState(0, Qt.Checked)
431         finally:
432             qApp.restoreOverrideCursor()
433     
434     def moduleUnselected(self, unselectedModule):
435         """
436         Resolves the unselection dependencies.
437         """
438         try:
439             qApp.setOverrideCursor(Qt.WaitCursor)
440             modules = self.projectInfo("MODULES")
441             modules[unselectedModule]["enabled"] = False
442             self.setProjectInfo("MODULES", modules)
443             unsatisfied = []
444             unsatisfied_params = []
445             if self.pageContent.automaticFix.isChecked():
446                 unsatisfied, unsatisfied_params = self.unselectDependencyCheck(unselectedModule)
447             if len(unsatisfied) > 0 or len(unsatisfied_params) > 0:
448                 message = []
449                 heading = self.tr("The module %1 is needed by").arg(unselectedModule)
450                 message.append(heading)
451                 module_list = ", ".join(unsatisfied)
452                 param_list = ", ".join(["%s (%s)" %(param_name, module) for module, param_name in unsatisfied_params])
453                 if module_list:
454                     message.append(QString(module_list))
455                 if module_list and param_list:
456                     message.append(self.tr("and by"))
457                 if param_list:
458                     message.append(QString(param_list))
459                 message_str = QStringList(message).join(" ")
460                 message_str.append(self.tr("\n\nDo you want to automatically fix these conflicts?"))
461                 qApp.restoreOverrideCursor()
462                 choice = QMessageBox.warning(self, self.tr("Dependency error"), message_str, QMessageBox.Yes | QMessageBox.No, QMessageBox.Yes)
463                 qApp.setOverrideCursor(Qt.WaitCursor)
464                 if choice == QMessageBox.Yes:
465                     for module in unsatisfied:
466                         modules = self.projectInfo("MODULES")
467                         modules[module]["enabled"] = False
468                     for category in range(self.pageContent.moduleTree.topLevelItemCount()):
469                         item = self.pageContent.moduleTree.topLevelItem(category)
470                         for child in range(item.childCount()):
471                             if unicode(item.child(child).text(0)) in unsatisfied:
472                                 item.child(child).setCheckState(0, Qt.Unchecked)
473                     for module, param in unsatisfied_params:
474                         configuration_file = self.projectInfo("MODULES")[module]["configuration"]
475                         configurations = self.projectInfo("CONFIGURATIONS")
476                         configurations[configuration_file][param]["value"] = "0"
477                         self.setProjectInfo("CONFIGURATIONS", configurations)
478         finally:
479             qApp.restoreOverrideCursor()
480     
481     def selectDependencyCheck(self, module):
482         """
483         Returns the list of unsatisfied dependencies after a selection.
484         """
485         unsatisfied = set()
486         modules = self.projectInfo("MODULES")
487         files = self.projectInfo("FILES")
488         configurations = self.projectInfo("CONFIGURATIONS").get(modules[module]["configuration"], {"paramlist": ()})
489         conditional_deps = ()
490         for i, param_name in configurations["paramlist"]:
491             information = configurations[param_name]
492             if information["informations"]["type"] == "boolean" and \
493                 information["value"] != "0" and \
494                 "conditional_deps" in information["informations"]:
495
496                 conditional_deps += information["informations"]["conditional_deps"]
497
498         for dependency in modules[module]["depends"] + conditional_deps:
499             if dependency in modules and not modules[dependency]["enabled"]:
500                 unsatisfied |= set([dependency])
501                 if dependency not in unsatisfied:
502                     unsatisfied |= self.selectDependencyCheck(dependency)
503             if dependency not in modules:
504                 if dependency in files:
505                     files[dependency] += 1
506                 else:
507                     files[dependency] = 1
508         self.setProjectInfo("FILES", files)
509         return unsatisfied
510     
511     def unselectDependencyCheck(self, dependency):
512         """
513         Returns the list of unsatisfied dependencies after an unselection.
514         """
515         unsatisfied = set()
516         unsatisfied_params = set()
517         modules = self.projectInfo("MODULES")
518         for module, informations in modules.items():
519             configurations = self.projectInfo("CONFIGURATIONS").get(informations["configuration"], {"paramlist": ()})
520             conditional_deps = {}
521             for i, param_name in configurations["paramlist"]:
522                 information = configurations[param_name]
523                 if information["informations"]["type"] == "boolean" and information["value"] != "0" and "conditional_deps" in information["informations"]:
524                     for dep in information["informations"]["conditional_deps"]:
525                         if not dep in conditional_deps:
526                             conditional_deps[dep] = []
527                         conditional_deps[dep].append((module, param_name))
528             if dependency in informations["depends"] and informations["enabled"]:
529                 unsatisfied |= set([module])
530                 if dependency not in unsatisfied:
531                     tmp = self.unselectDependencyCheck(module)
532                     unsatisfied |= tmp[0]
533                     unsatisfied_params |= tmp[1]
534             if dependency in conditional_deps:
535                 unsatisfied_params |= set(conditional_deps[dependency])
536         return unsatisfied, unsatisfied_params
537     
538     def removeFileDependencies(self, module):
539         """
540         Removes the files dependencies of the given module.
541         """
542         modules = self.projectInfo("MODULES")
543         files = self.projectInfo("FILES")
544         dependencies = modules[module]["depends"]
545         for dependency in dependencies:
546             if dependency in files:
547                 files[dependency] -= 1
548                 if files[dependency] == 0:
549                     del files[dependency]
550         self.setProjectInfo("FILES", files)
551
552 class QControlGroup(QObject):
553     """
554     Simple class that permit to connect different signals of different widgets
555     with a slot that emit a signal. Permits to group widget and to understand which of
556     them has sent the signal.
557     """
558     
559     def __init__(self):
560         QObject.__init__(self)
561         self._controls = {}
562     
563     def addControl(self, id, control):
564         """
565         Add a control.
566         """
567         self._controls[id] = control
568         if type(control) == QCheckBox:
569             self.connect(control, SIGNAL("stateChanged(int)"), lambda: self.stateChanged(id))
570         elif type(control) == QSpinBox:
571             self.connect(control, SIGNAL("valueChanged(int)"), lambda: self.stateChanged(id))
572         elif type(control) == QComboBox:
573             self.connect(control, SIGNAL("currentIndexChanged(int)"), lambda: self.stateChanged(id))
574         elif type(control) == QDoubleSpinBox:
575             self.connect(control, SIGNAL("valueChanged(double)"), lambda: self.stateChanged(id))
576     
577     def clear(self):
578         """
579         Remove all the controls.
580         """
581         self._controls = {}
582     
583     def stateChanged(self, id):
584         """
585         Slot called when the value of one of the stored widget changes. It emits
586         another signal.
587         """
588         self.emit(SIGNAL("stateChanged"), id)