Attempt to fix bug #153.
[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         # Load the module data only if it isn't already loaded
223         if not self.projectInfo("MODULES") \
224                 and not self.projectInfo("LISTS") \
225                 and not self.projectInfo("CONFIGURATIONS"):
226             try:
227                 self.project.loadModuleData()
228             except ModuleDefineException, e:
229                 self.exceptionOccurred(self.tr("Error parsing line '%2' in file %1").arg(e.path).arg(e.line))
230             except EnumDefineException, e:
231                 self.exceptionOccurred(self.tr("Error parsing line '%2' in file %1").arg(e.path).arg(e.line))
232             except ConfigurationDefineException, e:
233                 self.exceptionOccurred(self.tr("Error parsing line '%2' in file %1").arg(e.path).arg(e.line))
234     
235     def fillModuleTree(self):
236         """
237         Fills the module tree with the module entries separated in categories.
238         """
239         self.pageContent.moduleTree.clear()
240         modules = self.projectInfo("MODULES")
241         if not modules:
242             return
243         categories = {}
244         for module, information in modules.items():
245             if information["category"] not in categories:
246                 categories[information["category"]] = []
247             categories[information["category"]].append(module)
248         for category, module_list in categories.items():
249             item = QTreeWidgetItem(QStringList([category]))
250             for module in module_list:
251                 enabled = modules[module]["enabled"]
252                 module_item = QTreeWidgetItem(item, QStringList([module]))
253                 try:
254                     supported = bertos_utils.isSupported(self.project, module=module)
255                 except SupportedException, e:
256                     self.exceptionOccurred(self.tr("Error evaluating \"%1\" for module %2").arg(e.support_string).arg(module))
257                     supported = True
258                 if not supported:
259                     module_item.setForeground(0, QBrush(QColor(Qt.red)))
260                 if enabled:
261                     module_item.setCheckState(0, Qt.Checked)
262                 else:
263                     module_item.setCheckState(0, Qt.Unchecked)
264             self.pageContent.moduleTree.addTopLevelItem(item)
265         self.pageContent.moduleTree.sortItems(0, Qt.AscendingOrder)
266         self.fillPropertyTable()
267             
268     def insertCheckBox(self, index, value):
269         """
270         Inserts in the table at index a checkbox for a boolean property setted
271         to value.
272         """
273         check_box = QCheckBox()
274         self.pageContent.propertyTable.setCellWidget(index, 1, check_box)
275         if value == "1":
276             check_box.setChecked(True)
277         else:
278             check_box.setChecked(False)
279         self._control_group.addControl(index, check_box)
280     
281     def insertComboBox(self, index, value, value_list):
282         """
283         Inserts in the table at index a combobox for an enum property setted
284         to value.
285         """
286         try:
287             enum = self.projectInfo("LISTS")[value_list]
288             combo_box = QComboBox()
289             self.pageContent.propertyTable.setCellWidget(index, 1, combo_box)
290             for i, element in enumerate(enum):
291                 combo_box.addItem(element)
292                 if element == value:
293                     combo_box.setCurrentIndex(i)
294             self._control_group.addControl(index, combo_box)
295         except KeyError:
296             self.exceptionOccurred(self.tr("Define list \"%1\" not found. Check definition files.").arg(value_list))
297             self.pageContent.propertyTable.setItem(index, 1, QTableWidgetItem(value))
298     
299     def insertSpinBox(self, index, value, informations):
300         """
301         Inserts in the table at index a spinbox for an int, a long or an unsigned
302         long property setted to value.
303         """
304         # int, long or undefined type property
305         spin_box = None
306         if bertos_utils.isLong(informations) or bertos_utils.isUnsignedLong(informations):
307             spin_box = QDoubleSpinBox()
308             spin_box.setDecimals(0)
309         else:
310             spin_box = QSpinBox()
311         self.pageContent.propertyTable.setCellWidget(index, 1, spin_box)
312         minimum = -32768
313         maximum = 32767
314         suff = ""
315         if bertos_utils.isLong(informations):
316             minimum = -2147483648
317             maximum = 2147483647
318             suff = "L"
319         elif bertos_utils.isUnsigned(informations):
320             minimum = 0
321             maximum = 65535
322             suff = "U"
323         elif bertos_utils.isUnsignedLong(informations):
324             minimum = 0
325             maximum = 4294967295
326             suff = "UL"
327         if "min" in informations:
328             minimum = int(informations["min"])
329         if "max" in informations:
330             maximum = int(informations["max"])
331         spin_box.setRange(minimum, maximum)
332         spin_box.setSuffix(suff)
333         spin_box.setValue(int(value.replace("L", "").replace("U", "")))
334         self._control_group.addControl(index, spin_box)
335         
336     
337     def currentModule(self):
338         """
339         Retuns the current module name.
340         """
341         current_module = self.pageContent.moduleTree.currentItem()
342         # return only the child items
343         if current_module and current_module.parent():
344             return unicode(current_module.text(0))
345         else:
346             return None
347
348     def moduleItem(self, module):
349         for top_level_index in range(self.pageContent.moduleTree.topLevelItemCount()):
350             top_level_item = self.pageContent.moduleTree.topLevelItem(top_level_index)
351             for child_index in range(top_level_item.childCount()):
352                 child_item = top_level_item.child(child_index)
353                 if unicode(child_item.text(0)) == module:
354                     return child_item
355         return None
356     
357     def currentModuleConfigurations(self):
358         """
359         Returns the current module configuration.
360         """
361         return self.configurations(self.currentModule())
362     
363     def currentProperty(self):
364         """
365         Rerturns the current property from the property table.
366         """
367         return qvariant_converter.getString(self.pageContent.propertyTable.item(self.pageContent.propertyTable.currentRow(), 0).data(Qt.UserRole))
368     
369     def currentPropertyItem(self):
370         """
371         Returns the QTableWidgetItem of the current property.
372         """
373         return self.pageContent.propertyTable.item(self.pageContent.propertyTable.currentRow(), 0)
374     
375     def configurations(self, module):
376         """
377         Returns the configuration for the selected module.
378         """
379         configuration = []
380         if module:
381             # On linux platform it seems that the behaviour of the focus
382             # changing is a bit different from the mac one. So if module is
383             # None then no configurations should be returned.
384             configuration = self.projectInfo("MODULES")[module]["configuration"]
385         if len(configuration) > 0:
386             return self.projectInfo("CONFIGURATIONS")[configuration]
387         else:
388             return {}
389     
390     def resetPropertyDescription(self):
391         """
392         Resets the label for each property table entry.
393         """
394         for index in range(self.pageContent.propertyTable.rowCount()):
395             property_name = qvariant_converter.getString(self.pageContent.propertyTable.item(index, 0).data(Qt.UserRole))
396             # Awful solution! Needed because if the user change the module, the selection changed...
397             if property_name not in self.currentModuleConfigurations():
398                 break
399             self.pageContent.propertyTable.item(index, 0).setText(self.currentModuleConfigurations()[property_name]['brief'])
400     
401     def setBold(self, item, bold):
402         self.pageContent.moduleTree.blockSignals(True)
403         font = item.font(0)
404         font.setBold(bold)
405         item.setFont(0, font)
406         self.pageContent.moduleTree.blockSignals(False)
407
408     def moduleSelected(self, selectedModule):
409         """
410         Resolves the selection dependencies.
411         """
412         try:
413             qApp.setOverrideCursor(Qt.WaitCursor)
414             modules = self.projectInfo("MODULES")
415             modules[selectedModule]["enabled"] = True
416             self.setProjectInfo("MODULES", modules)
417             depends = self.projectInfo("MODULES")[selectedModule]["depends"]
418             unsatisfied = []
419             if self.pageContent.automaticFix.isChecked():
420                 unsatisfied = self.selectDependencyCheck(selectedModule)
421             if len(unsatisfied) > 0:
422                 for module in unsatisfied:
423                     modules = self.projectInfo("MODULES")
424                     modules[module]["enabled"] = True
425                 for category in range(self.pageContent.moduleTree.topLevelItemCount()):
426                     item = self.pageContent.moduleTree.topLevelItem(category)
427                     for child in range(item.childCount()):
428                         if unicode(item.child(child).text(0)) in unsatisfied:
429                             self.setBold(item.child(child), True)
430                             self.setBold(item, True)
431                             item.child(child).setCheckState(0, Qt.Checked)
432         finally:
433             qApp.restoreOverrideCursor()
434     
435     def moduleUnselected(self, unselectedModule):
436         """
437         Resolves the unselection dependencies.
438         """
439         try:
440             qApp.setOverrideCursor(Qt.WaitCursor)
441             modules = self.projectInfo("MODULES")
442             modules[unselectedModule]["enabled"] = False
443             self.setProjectInfo("MODULES", modules)
444             unsatisfied = []
445             unsatisfied_params = []
446             if self.pageContent.automaticFix.isChecked():
447                 unsatisfied, unsatisfied_params = self.unselectDependencyCheck(unselectedModule)
448             if len(unsatisfied) > 0 or len(unsatisfied_params) > 0:
449                 message = []
450                 heading = self.tr("The module %1 is needed by").arg(unselectedModule)
451                 message.append(heading)
452                 module_list = ", ".join(unsatisfied)
453                 param_list = ", ".join(["%s (%s)" %(param_name, module) for module, param_name in unsatisfied_params])
454                 if module_list:
455                     message.append(QString(module_list))
456                 if module_list and param_list:
457                     message.append(self.tr("and by"))
458                 if param_list:
459                     message.append(QString(param_list))
460                 message_str = QStringList(message).join(" ")
461                 message_str.append(self.tr("\n\nDo you want to automatically fix these conflicts?"))
462                 qApp.restoreOverrideCursor()
463                 choice = QMessageBox.warning(self, self.tr("Dependency error"), message_str, QMessageBox.Yes | QMessageBox.No, QMessageBox.Yes)
464                 qApp.setOverrideCursor(Qt.WaitCursor)
465                 if choice == QMessageBox.Yes:
466                     for module in unsatisfied:
467                         modules = self.projectInfo("MODULES")
468                         modules[module]["enabled"] = False
469                     for category in range(self.pageContent.moduleTree.topLevelItemCount()):
470                         item = self.pageContent.moduleTree.topLevelItem(category)
471                         for child in range(item.childCount()):
472                             if unicode(item.child(child).text(0)) in unsatisfied:
473                                 item.child(child).setCheckState(0, Qt.Unchecked)
474                     for module, param in unsatisfied_params:
475                         configuration_file = self.projectInfo("MODULES")[module]["configuration"]
476                         configurations = self.projectInfo("CONFIGURATIONS")
477                         configurations[configuration_file][param]["value"] = "0"
478                         self.setProjectInfo("CONFIGURATIONS", configurations)
479         finally:
480             qApp.restoreOverrideCursor()
481     
482     def selectDependencyCheck(self, module):
483         """
484         Returns the list of unsatisfied dependencies after a selection.
485         """
486         unsatisfied = set()
487         modules = self.projectInfo("MODULES")
488         files = self.projectInfo("FILES")
489         configurations = self.projectInfo("CONFIGURATIONS").get(modules[module]["configuration"], {"paramlist": ()})
490         conditional_deps = ()
491         for i, param_name in configurations["paramlist"]:
492             information = configurations[param_name]
493             if information["informations"]["type"] == "boolean" and \
494                 information["value"] != "0" and \
495                 "conditional_deps" in information["informations"]:
496
497                 conditional_deps += information["informations"]["conditional_deps"]
498
499         for dependency in modules[module]["depends"] + conditional_deps:
500             if dependency in modules and not modules[dependency]["enabled"]:
501                 unsatisfied |= set([dependency])
502                 if dependency not in unsatisfied:
503                     unsatisfied |= self.selectDependencyCheck(dependency)
504             if dependency not in modules:
505                 if dependency in files:
506                     files[dependency] += 1
507                 else:
508                     files[dependency] = 1
509         self.setProjectInfo("FILES", files)
510         return unsatisfied
511     
512     def unselectDependencyCheck(self, dependency):
513         """
514         Returns the list of unsatisfied dependencies after an unselection.
515         """
516         unsatisfied = set()
517         unsatisfied_params = set()
518         modules = self.projectInfo("MODULES")
519         for module, informations in modules.items():
520             configurations = self.projectInfo("CONFIGURATIONS").get(informations["configuration"], {"paramlist": ()})
521             conditional_deps = {}
522             for i, param_name in configurations["paramlist"]:
523                 information = configurations[param_name]
524                 if information["informations"]["type"] == "boolean" and information["value"] != "0" and "conditional_deps" in information["informations"]:
525                     for dep in information["informations"]["conditional_deps"]:
526                         if not dep in conditional_deps:
527                             conditional_deps[dep] = []
528                         conditional_deps[dep].append((module, param_name))
529             if dependency in informations["depends"] and informations["enabled"]:
530                 unsatisfied |= set([module])
531                 if dependency not in unsatisfied:
532                     tmp = self.unselectDependencyCheck(module)
533                     unsatisfied |= tmp[0]
534                     unsatisfied_params |= tmp[1]
535             if dependency in conditional_deps:
536                 unsatisfied_params |= set(conditional_deps[dependency])
537         return unsatisfied, unsatisfied_params
538     
539     def removeFileDependencies(self, module):
540         """
541         Removes the files dependencies of the given module.
542         """
543         modules = self.projectInfo("MODULES")
544         files = self.projectInfo("FILES")
545         dependencies = modules[module]["depends"]
546         for dependency in dependencies:
547             if dependency in files:
548                 files[dependency] -= 1
549                 if files[dependency] == 0:
550                     del files[dependency]
551         self.setProjectInfo("FILES", files)
552
553 class QControlGroup(QObject):
554     """
555     Simple class that permit to connect different signals of different widgets
556     with a slot that emit a signal. Permits to group widget and to understand which of
557     them has sent the signal.
558     """
559     
560     def __init__(self):
561         QObject.__init__(self)
562         self._controls = {}
563     
564     def addControl(self, id, control):
565         """
566         Add a control.
567         """
568         self._controls[id] = control
569         if type(control) == QCheckBox:
570             self.connect(control, SIGNAL("stateChanged(int)"), lambda: self.stateChanged(id))
571         elif type(control) == QSpinBox:
572             self.connect(control, SIGNAL("valueChanged(int)"), lambda: self.stateChanged(id))
573         elif type(control) == QComboBox:
574             self.connect(control, SIGNAL("currentIndexChanged(int)"), lambda: self.stateChanged(id))
575         elif type(control) == QDoubleSpinBox:
576             self.connect(control, SIGNAL("valueChanged(double)"), lambda: self.stateChanged(id))
577     
578     def clear(self):
579         """
580         Remove all the controls.
581         """
582         self._controls = {}
583     
584     def stateChanged(self, id):
585         """
586         Slot called when the value of one of the stored widget changes. It emits
587         another signal.
588         """
589         self.emit(SIGNAL("stateChanged"), id)