4 # This file is part of BeRTOS.
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.
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.
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
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.
29 # Copyright 2008 Develer S.r.l. (http://www.develer.com/)
33 # Author: Lorenzo Berni <duplo@develer.com>
38 from PyQt4.QtCore import *
39 from PyQt4.QtGui import *
40 from BWizardPage import *
43 from bertos_utils import SupportedException
44 from DefineException import *
47 class BModulePage(BWizardPage):
49 Page of the wizard that permits to select and configurate the BeRTOS modules.
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)
59 ## Overloaded BWizardPage methods ##
63 Overload of BWizardPage setupUi method.
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)
76 def connectSignals(self):
78 Overload of the BWizardPage connectSignals method.
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)
84 def reloadData(self, previous_id=None):
86 Overload of the BWizardPage reloadData method.
88 # Check if the user are approaching this page from the previous or the
90 if previous_id is None or previous_id < self.wizard().currentId():
92 QApplication.instance().setOverrideCursor(Qt.WaitCursor)
97 QApplication.instance().restoreOverrideCursor()
103 def moduleClicked(self, item, column):
104 self.setBold(item, False)
106 def fillPropertyTable(self):
108 Slot called when the user selects a module from the module tree.
109 Fills the property table using the configuration parameters defined in
112 module = self.currentModule()
115 supported = bertos_utils.isSupported(self.project, module=module)
116 except SupportedException, e:
117 self.exceptionOccurred(self.tr("Error evaluating \"%1\" for module %2").arg(e.support_string).arg(module))
119 self._control_group.clear()
120 configuration = self.projectInfo("MODULES")[module]["configuration"]
121 module_description = self.projectInfo("MODULES")[module]["description"]
122 self.pageContent.moduleLabel.setText(module_description)
123 self.pageContent.moduleLabel.setVisible(True)
125 self.pageContent.warningLabel.setVisible(True)
126 selected_cpu = self.projectInfo("CPU_NAME")
127 self.pageContent.warningLabel.setText(self.tr("<font color='#FF0000'>Warning: the selected module, \
128 is not completely supported by the %1.</font>").arg(selected_cpu))
130 self.pageContent.warningLabel.setVisible(False)
131 self.pageContent.propertyTable.clear()
132 self.pageContent.propertyTable.setRowCount(0)
133 if configuration != "":
134 configurations = self.projectInfo("CONFIGURATIONS")[configuration]
135 param_list = sorted(configurations["paramlist"])
137 for i, property in param_list:
138 if "type" in configurations[property]["informations"] and configurations[property]["informations"]["type"] == "autoenabled":
139 # Doesn't show the hidden fields
142 param_supported = bertos_utils.isSupported(self.project, property_id=(configuration, property))
143 except SupportedException, e:
144 self.exceptionOccurred(self.tr("Error evaluating \"%1\" for parameter %2").arg(e.support_string).arg(property))
145 param_supported = True
146 if not param_supported:
147 # Doesn't show the unsupported parameters
149 # Set the row count to the current index + 1
150 self.pageContent.propertyTable.setRowCount(index + 1)
151 item = QTableWidgetItem(configurations[property]["brief"])
152 item.setFlags(item.flags() & ~Qt.ItemIsSelectable)
153 item.setToolTip(property)
154 item.setData(Qt.UserRole, qvariant_converter.convertString(property))
155 self.pageContent.propertyTable.setItem(index, 0, item)
156 if "type" in configurations[property]["informations"] and configurations[property]["informations"]["type"] == "boolean":
157 self.insertCheckBox(index, configurations[property]["value"])
158 elif "type" in configurations[property]["informations"] and configurations[property]["informations"]["type"] == "enum":
159 self.insertComboBox(index, configurations[property]["value"], configurations[property]["informations"]["value_list"])
160 elif "type" in configurations[property]["informations"] and configurations[property]["informations"]["type"] == "int":
161 self.insertSpinBox(index, configurations[property]["value"], configurations[property]["informations"])
163 # Not defined type, rendered as a text field
164 self.pageContent.propertyTable.setItem(index, 1, QTableWidgetItem(configurations[property]["value"]))
166 if self.pageContent.propertyTable.rowCount() == 0:
167 module_label = self.pageContent.moduleLabel.text()
168 module_label += "\n\nNo configuration needed."
169 self.pageContent.moduleLabel.setText(module_label)
171 self.pageContent.moduleLabel.setText("")
172 self.pageContent.moduleLabel.setVisible(False)
173 self.pageContent.propertyTable.clear()
174 self.pageContent.propertyTable.setRowCount(0)
176 def dependencyCheck(self, item):
178 Checks the dependencies of the module associated with the given item.
181 module = unicode(item.text(0))
182 if item.checkState(0) == Qt.Checked:
183 self.moduleSelected(module)
185 self.moduleUnselected(module)
186 self.removeFileDependencies(module)
188 def showPropertyDescription(self):
190 Slot called when the property selection changes. Shows the description
191 of the selected property.
193 self.resetPropertyDescription()
194 configurations = self.currentModuleConfigurations()
195 if self.currentProperty() in configurations:
196 description = configurations[self.currentProperty()]["brief"]
197 name = self.currentProperty()
198 self.currentPropertyItem().setText(description + "\n" + name)
200 def saveValue(self, index):
202 Slot called when the user modifies one of the configuration parameters.
203 It stores the new value."""
204 property = qvariant_converter.getString(self.pageContent.propertyTable.item(index, 0).data(Qt.UserRole))
205 configuration = self.projectInfo("MODULES")[self.currentModule()]["configuration"]
206 configurations = self.projectInfo("CONFIGURATIONS")
207 if "type" not in configurations[configuration][property]["informations"] or configurations[configuration][property]["informations"]["type"] == "int":
208 configurations[configuration][property]["value"] = unicode(int(self.pageContent.propertyTable.cellWidget(index, 1).value()))
209 elif configurations[configuration][property]["informations"]["type"] == "enum":
210 configurations[configuration][property]["value"] = unicode(self.pageContent.propertyTable.cellWidget(index, 1).currentText())
211 elif configurations[configuration][property]["informations"]["type"] == "boolean":
212 if self.pageContent.propertyTable.cellWidget(index, 1).isChecked():
213 configurations[configuration][property]["value"] = "1"
215 configurations[configuration][property]["value"] = "0"
216 self.setProjectInfo("CONFIGURATIONS", configurations)
217 if self.moduleItem(self.currentModule()).checkState(0) == Qt.Checked:
218 self.dependencyCheck(self.moduleItem(self.currentModule()))
222 def loadModuleData(self):
224 Loads the module data.
226 # Do not load the module data again when the Wizard is in editing mode
227 # or when it's working on a preset.
228 if not self.project.edit and not self.project.from_preset:
229 # Load the module data every time so that if the user changed the cpu
230 # the right configurations are picked up.
232 self.project.loadModuleData()
233 except ModuleDefineException, e:
234 self.exceptionOccurred(self.tr("Error parsing line '%2' in file %1").arg(e.path).arg(e.line))
235 except EnumDefineException, e:
236 self.exceptionOccurred(self.tr("Error parsing line '%2' in file %1").arg(e.path).arg(e.line))
237 except ConfigurationDefineException, e:
238 self.exceptionOccurred(self.tr("Error parsing line '%2' in file %1").arg(e.path).arg(e.line))
240 def fillModuleTree(self):
242 Fills the module tree with the module entries separated in categories.
244 self.pageContent.moduleTree.clear()
245 modules = self.projectInfo("MODULES")
249 for module, information in modules.items():
250 if information["category"] not in categories:
251 categories[information["category"]] = []
252 categories[information["category"]].append(module)
253 for category, module_list in categories.items():
254 item = QTreeWidgetItem(QStringList([category]))
255 for module in module_list:
256 enabled = modules[module]["enabled"]
257 module_item = QTreeWidgetItem(item, QStringList([module]))
259 supported = bertos_utils.isSupported(self.project, module=module)
260 except SupportedException, e:
261 self.exceptionOccurred(self.tr("Error evaluating \"%1\" for module %2").arg(e.support_string).arg(module))
264 module_item.setForeground(0, QBrush(QColor(Qt.red)))
266 module_item.setCheckState(0, Qt.Checked)
268 module_item.setCheckState(0, Qt.Unchecked)
269 self.pageContent.moduleTree.addTopLevelItem(item)
270 self.pageContent.moduleTree.sortItems(0, Qt.AscendingOrder)
271 self.fillPropertyTable()
273 def insertCheckBox(self, index, value):
275 Inserts in the table at index a checkbox for a boolean property setted
278 check_box = QCheckBox()
279 self.pageContent.propertyTable.setCellWidget(index, 1, check_box)
281 check_box.setChecked(True)
283 check_box.setChecked(False)
284 self._control_group.addControl(index, check_box)
286 def insertComboBox(self, index, value, value_list):
288 Inserts in the table at index a combobox for an enum property setted
292 enum = self.projectInfo("LISTS")[value_list]
293 combo_box = QComboBox()
294 self.pageContent.propertyTable.setCellWidget(index, 1, combo_box)
295 for i, element in enumerate(enum):
296 combo_box.addItem(element)
298 combo_box.setCurrentIndex(i)
299 self._control_group.addControl(index, combo_box)
301 self.exceptionOccurred(self.tr("Define list \"%1\" not found. Check definition files.").arg(value_list))
302 self.pageContent.propertyTable.setItem(index, 1, QTableWidgetItem(value))
304 def insertSpinBox(self, index, value, informations):
306 Inserts in the table at index a spinbox for an int, a long or an unsigned
307 long property setted to value.
309 # int, long or undefined type property
311 if bertos_utils.isLong(informations) or bertos_utils.isUnsignedLong(informations):
312 spin_box = QDoubleSpinBox()
313 spin_box.setDecimals(0)
315 spin_box = QSpinBox()
316 self.pageContent.propertyTable.setCellWidget(index, 1, spin_box)
320 if bertos_utils.isLong(informations):
321 minimum = -2147483648
324 elif bertos_utils.isUnsigned(informations):
328 elif bertos_utils.isUnsignedLong(informations):
332 if "min" in informations:
333 minimum = int(informations["min"])
334 if "max" in informations:
335 maximum = int(informations["max"])
336 spin_box.setRange(minimum, maximum)
337 spin_box.setSuffix(suff)
338 spin_box.setValue(int(value.replace("L", "").replace("U", "")))
339 self._control_group.addControl(index, spin_box)
342 def currentModule(self):
344 Retuns the current module name.
346 current_module = self.pageContent.moduleTree.currentItem()
347 # return only the child items
348 if current_module and current_module.parent():
349 return unicode(current_module.text(0))
353 def moduleItem(self, module):
354 for top_level_index in range(self.pageContent.moduleTree.topLevelItemCount()):
355 top_level_item = self.pageContent.moduleTree.topLevelItem(top_level_index)
356 for child_index in range(top_level_item.childCount()):
357 child_item = top_level_item.child(child_index)
358 if unicode(child_item.text(0)) == module:
362 def currentModuleConfigurations(self):
364 Returns the current module configuration.
366 return self.configurations(self.currentModule())
368 def currentProperty(self):
370 Rerturns the current property from the property table.
372 return qvariant_converter.getString(self.pageContent.propertyTable.item(self.pageContent.propertyTable.currentRow(), 0).data(Qt.UserRole))
374 def currentPropertyItem(self):
376 Returns the QTableWidgetItem of the current property.
378 return self.pageContent.propertyTable.item(self.pageContent.propertyTable.currentRow(), 0)
380 def configurations(self, module):
382 Returns the configuration for the selected module.
386 # On linux platform it seems that the behaviour of the focus
387 # changing is a bit different from the mac one. So if module is
388 # None then no configurations should be returned.
389 configuration = self.projectInfo("MODULES")[module]["configuration"]
390 if len(configuration) > 0:
391 return self.projectInfo("CONFIGURATIONS")[configuration]
395 def resetPropertyDescription(self):
397 Resets the label for each property table entry.
399 for index in range(self.pageContent.propertyTable.rowCount()):
400 property_name = qvariant_converter.getString(self.pageContent.propertyTable.item(index, 0).data(Qt.UserRole))
401 # Awful solution! Needed because if the user change the module, the selection changed...
402 if property_name not in self.currentModuleConfigurations():
404 self.pageContent.propertyTable.item(index, 0).setText(self.currentModuleConfigurations()[property_name]['brief'])
406 def setBold(self, item, bold):
407 self.pageContent.moduleTree.blockSignals(True)
410 item.setFont(0, font)
411 self.pageContent.moduleTree.blockSignals(False)
413 def moduleSelected(self, selectedModule):
415 Resolves the selection dependencies.
418 qApp.setOverrideCursor(Qt.WaitCursor)
419 modules = self.projectInfo("MODULES")
420 modules[selectedModule]["enabled"] = True
421 self.setProjectInfo("MODULES", modules)
422 depends = self.projectInfo("MODULES")[selectedModule]["depends"]
424 if self.pageContent.automaticFix.isChecked():
425 unsatisfied = self.selectDependencyCheck(selectedModule)
426 if len(unsatisfied) > 0:
427 for module in unsatisfied:
428 modules = self.projectInfo("MODULES")
429 modules[module]["enabled"] = True
430 for category in range(self.pageContent.moduleTree.topLevelItemCount()):
431 item = self.pageContent.moduleTree.topLevelItem(category)
432 for child in range(item.childCount()):
433 if unicode(item.child(child).text(0)) in unsatisfied:
434 self.setBold(item.child(child), True)
435 self.setBold(item, True)
436 item.child(child).setCheckState(0, Qt.Checked)
438 qApp.restoreOverrideCursor()
440 def moduleUnselected(self, unselectedModule):
442 Resolves the unselection dependencies.
445 qApp.setOverrideCursor(Qt.WaitCursor)
446 modules = self.projectInfo("MODULES")
447 modules[unselectedModule]["enabled"] = False
448 self.setProjectInfo("MODULES", modules)
450 unsatisfied_params = []
451 if self.pageContent.automaticFix.isChecked():
452 unsatisfied, unsatisfied_params = self.unselectDependencyCheck(unselectedModule)
453 if len(unsatisfied) > 0 or len(unsatisfied_params) > 0:
455 heading = self.tr("The module %1 is needed by").arg(unselectedModule)
456 message.append(heading)
457 module_list = ", ".join(unsatisfied)
458 param_list = ", ".join(["%s (%s)" %(param_name, module) for module, param_name in unsatisfied_params])
460 message.append(QString(module_list))
461 if module_list and param_list:
462 message.append(self.tr("and by"))
464 message.append(QString(param_list))
465 message_str = QStringList(message).join(" ")
466 message_str.append(self.tr("\n\nDo you want to automatically fix these conflicts?"))
467 qApp.restoreOverrideCursor()
468 choice = QMessageBox.warning(self, self.tr("Dependency error"), message_str, QMessageBox.Yes | QMessageBox.No, QMessageBox.Yes)
469 qApp.setOverrideCursor(Qt.WaitCursor)
470 if choice == QMessageBox.Yes:
471 for module in unsatisfied:
472 modules = self.projectInfo("MODULES")
473 modules[module]["enabled"] = False
474 for category in range(self.pageContent.moduleTree.topLevelItemCount()):
475 item = self.pageContent.moduleTree.topLevelItem(category)
476 for child in range(item.childCount()):
477 if unicode(item.child(child).text(0)) in unsatisfied:
478 item.child(child).setCheckState(0, Qt.Unchecked)
479 for module, param in unsatisfied_params:
480 configuration_file = self.projectInfo("MODULES")[module]["configuration"]
481 configurations = self.projectInfo("CONFIGURATIONS")
482 configurations[configuration_file][param]["value"] = "0"
483 self.setProjectInfo("CONFIGURATIONS", configurations)
485 qApp.restoreOverrideCursor()
487 def selectDependencyCheck(self, module):
489 Returns the list of unsatisfied dependencies after a selection.
492 modules = self.projectInfo("MODULES")
493 files = self.projectInfo("FILES")
494 configurations = self.projectInfo("CONFIGURATIONS").get(modules[module]["configuration"], {"paramlist": ()})
495 conditional_deps = ()
496 for i, param_name in configurations["paramlist"]:
497 information = configurations[param_name]
498 if information["informations"]["type"] == "boolean" and \
499 information["value"] != "0" and \
500 "conditional_deps" in information["informations"]:
502 conditional_deps += information["informations"]["conditional_deps"]
504 for dependency in modules[module]["depends"] + conditional_deps:
505 if dependency in modules and not modules[dependency]["enabled"]:
506 unsatisfied |= set([dependency])
507 if dependency not in unsatisfied:
508 unsatisfied |= self.selectDependencyCheck(dependency)
509 if dependency not in modules:
510 if dependency in files:
511 files[dependency] += 1
513 files[dependency] = 1
514 self.setProjectInfo("FILES", files)
517 def unselectDependencyCheck(self, dependency):
519 Returns the list of unsatisfied dependencies after an unselection.
522 unsatisfied_params = set()
523 modules = self.projectInfo("MODULES")
524 for module, informations in modules.items():
525 configurations = self.projectInfo("CONFIGURATIONS").get(informations["configuration"], {"paramlist": ()})
526 conditional_deps = {}
527 for i, param_name in configurations["paramlist"]:
528 information = configurations[param_name]
529 if information["informations"]["type"] == "boolean" and information["value"] != "0" and "conditional_deps" in information["informations"]:
530 for dep in information["informations"]["conditional_deps"]:
531 if not dep in conditional_deps:
532 conditional_deps[dep] = []
533 conditional_deps[dep].append((module, param_name))
534 if dependency in informations["depends"] and informations["enabled"]:
535 unsatisfied |= set([module])
536 if dependency not in unsatisfied:
537 tmp = self.unselectDependencyCheck(module)
538 unsatisfied |= tmp[0]
539 unsatisfied_params |= tmp[1]
540 if dependency in conditional_deps:
541 unsatisfied_params |= set(conditional_deps[dependency])
542 return unsatisfied, unsatisfied_params
544 def removeFileDependencies(self, module):
546 Removes the files dependencies of the given module.
548 modules = self.projectInfo("MODULES")
549 files = self.projectInfo("FILES")
550 dependencies = modules[module]["depends"]
551 for dependency in dependencies:
552 if dependency in files:
553 files[dependency] -= 1
554 if files[dependency] == 0:
555 del files[dependency]
556 self.setProjectInfo("FILES", files)
558 class QControlGroup(QObject):
560 Simple class that permit to connect different signals of different widgets
561 with a slot that emit a signal. Permits to group widget and to understand which of
562 them has sent the signal.
566 QObject.__init__(self)
569 def addControl(self, id, control):
573 self._controls[id] = control
574 if type(control) == QCheckBox:
575 self.connect(control, SIGNAL("stateChanged(int)"), lambda: self.stateChanged(id))
576 elif type(control) == QSpinBox:
577 self.connect(control, SIGNAL("valueChanged(int)"), lambda: self.stateChanged(id))
578 elif type(control) == QComboBox:
579 self.connect(control, SIGNAL("currentIndexChanged(int)"), lambda: self.stateChanged(id))
580 elif type(control) == QDoubleSpinBox:
581 self.connect(control, SIGNAL("valueChanged(double)"), lambda: self.stateChanged(id))
585 Remove all the controls.
589 def stateChanged(self, id):
591 Slot called when the value of one of the stored widget changes. It emits
594 self.emit(SIGNAL("stateChanged"), id)