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