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/)
32 # Author: Lorenzo Berni <duplo@develer.com>
37 from PyQt4.QtCore import *
38 from PyQt4.QtGui import *
39 from BWizardPage import *
42 from bertos_utils import SupportedException
43 from DefineException import *
46 class BModulePage(BWizardPage):
48 Page of the wizard that permits to select and configurate the BeRTOS modules.
52 BWizardPage.__init__(self, UI_LOCATION + "/module_select.ui")
53 self.setTitle(self.tr("Configure the BeRTOS modules"))
54 self._control_group = QControlGroup()
55 ## special connection needed for the QControlGroup
56 self.connect(self._control_group, SIGNAL("stateChanged"), self.saveValue)
58 ## Overloaded BWizardPage methods ##
62 Overload of BWizardPage setupUi method.
64 self.pageContent.moduleTree.clear()
65 self.pageContent.moduleTree.setHeaderHidden(True)
66 self.pageContent.propertyTable.horizontalHeader().setResizeMode(QHeaderView.Stretch)
67 self.pageContent.propertyTable.horizontalHeader().setVisible(False)
68 self.pageContent.propertyTable.verticalHeader().setResizeMode(QHeaderView.ResizeToContents)
69 self.pageContent.propertyTable.verticalHeader().setVisible(False)
70 self.pageContent.propertyTable.setColumnCount(2)
71 self.pageContent.propertyTable.setRowCount(0)
72 self.pageContent.moduleLabel.setVisible(False)
73 self.pageContent.warningLabel.setVisible(False)
75 def connectSignals(self):
77 Overload of the BWizardPage connectSignals method.
79 self.connect(self.pageContent.moduleTree, SIGNAL("itemPressed(QTreeWidgetItem*, int)"), self.fillPropertyTable)
80 self.connect(self.pageContent.moduleTree, SIGNAL("itemPressed(QTreeWidgetItem*, int)"), self.moduleClicked)
81 self.connect(self.pageContent.moduleTree, SIGNAL("itemChanged(QTreeWidgetItem*, int)"), self.dependencyCheck)
83 def reloadData(self, previous_id=None):
85 Overload of the BWizardPage reloadData method.
87 # Check if the user are approaching this page from the previous or the
89 if previous_id is None or previous_id < self.wizard().currentId():
91 QApplication.instance().setOverrideCursor(Qt.WaitCursor)
96 QApplication.instance().restoreOverrideCursor()
102 def moduleClicked(self, item, column):
103 self.setBold(item, False)
105 def fillPropertyTable(self):
107 Slot called when the user selects a module from the module tree.
108 Fills the property table using the configuration parameters defined in
111 module = self.currentModule()
114 supported = bertos_utils.isSupported(self.project, module=module)
115 except SupportedException, e:
116 self.exceptionOccurred(self.tr("Error evaluating \"%1\" for module %2").arg(e.support_string).arg(module))
118 self._control_group.clear()
119 configuration = self.projectInfo("MODULES")[module]["configuration"]
120 module_description = self.projectInfo("MODULES")[module]["description"]
121 self.pageContent.moduleLabel.setText(module_description)
122 self.pageContent.moduleLabel.setVisible(True)
124 self.pageContent.warningLabel.setVisible(True)
125 selected_cpu = self.projectInfo("CPU_NAME")
126 self.pageContent.warningLabel.setText(self.tr("<font color='#FF0000'>Warning: the selected module, \
127 is not completely supported by the %1.</font>").arg(selected_cpu))
129 self.pageContent.warningLabel.setVisible(False)
130 self.pageContent.propertyTable.clear()
131 self.pageContent.propertyTable.setRowCount(0)
132 if configuration != "":
133 configurations = self.projectInfo("CONFIGURATIONS")[configuration]
134 param_list = sorted(configurations["paramlist"])
136 for i, property in param_list:
137 if "type" in configurations[property]["informations"] and configurations[property]["informations"]["type"] == "autoenabled":
138 # Doesn't show the hidden fields
141 param_supported = bertos_utils.isSupported(self.project, property_id=(configuration, property))
142 except SupportedException, e:
143 self.exceptionOccurred(self.tr("Error evaluating \"%1\" for parameter %2").arg(e.support_string).arg(property))
144 param_supported = True
145 if not param_supported:
146 # Doesn't show the unsupported parameters
148 # Set the row count to the current index + 1
149 self.pageContent.propertyTable.setRowCount(index + 1)
150 item = QTableWidgetItem(configurations[property]["brief"])
151 item.setFlags(item.flags() & ~Qt.ItemIsSelectable)
153 description = configurations[property].get("description", None)
155 tooltip = tooltip + ": " + description
156 item.setToolTip(tooltip)
157 item.setData(Qt.UserRole, qvariant_converter.convertString(property))
158 self.pageContent.propertyTable.setItem(index, 0, item)
159 if "type" in configurations[property]["informations"] and configurations[property]["informations"]["type"] == "boolean":
160 self.insertCheckBox(index, configurations[property]["value"])
161 elif "type" in configurations[property]["informations"] and configurations[property]["informations"]["type"] == "enum":
162 self.insertComboBox(index, configurations[property]["value"], configurations[property]["informations"]["value_list"])
163 elif "type" in configurations[property]["informations"] and configurations[property]["informations"]["type"] == "int":
164 self.insertSpinBox(index, configurations[property]["value"], configurations[property]["informations"])
165 elif "type" in configurations[property]["informations"] and configurations[property]["informations"]["type"] == "hex":
166 self.insertLineEdit(index, configurations[property]["value"], configurations[property]["informations"])
168 # Not defined type, rendered as a text field
169 self.pageContent.propertyTable.setItem(index, 1, QTableWidgetItem(configurations[property]["value"]))
171 if self.pageContent.propertyTable.rowCount() == 0:
172 module_label = self.pageContent.moduleLabel.text()
173 module_label += "\n\nNo configuration needed."
174 self.pageContent.moduleLabel.setText(module_label)
176 self.pageContent.moduleLabel.setText("")
177 self.pageContent.moduleLabel.setVisible(False)
178 self.pageContent.propertyTable.clear()
179 self.pageContent.propertyTable.setRowCount(0)
181 def dependencyCheck(self, item):
183 Checks the dependencies of the module associated with the given item.
186 module = unicode(item.text(0))
187 if item.checkState(0) == Qt.Checked:
188 self.moduleSelected(module)
190 self.moduleUnselected(module)
191 self.removeFileDependencies(module)
193 def showPropertyDescription(self):
195 Slot called when the property selection changes. Shows the description
196 of the selected property.
198 self.resetPropertyDescription()
199 configurations = self.currentModuleConfigurations()
200 if self.currentProperty() in configurations:
201 description = configurations[self.currentProperty()]["brief"]
202 name = self.currentProperty()
203 self.currentPropertyItem().setText(description + "\n" + name)
205 def saveValue(self, index):
207 Slot called when the user modifies one of the configuration parameters.
208 It stores the new value."""
209 property = qvariant_converter.getString(self.pageContent.propertyTable.item(index, 0).data(Qt.UserRole))
210 configuration = self.projectInfo("MODULES")[self.currentModule()]["configuration"]
211 configurations = self.projectInfo("CONFIGURATIONS")
212 if "type" not in configurations[configuration][property]["informations"] or configurations[configuration][property]["informations"]["type"] == "int":
213 configurations[configuration][property]["value"] = unicode(int(self.pageContent.propertyTable.cellWidget(index, 1).value()))
214 elif configurations[configuration][property]["informations"]["type"] == "enum":
215 configurations[configuration][property]["value"] = unicode(self.pageContent.propertyTable.cellWidget(index, 1).currentText())
216 elif configurations[configuration][property]["informations"]["type"] == "boolean":
217 if self.pageContent.propertyTable.cellWidget(index, 1).isChecked():
218 configurations[configuration][property]["value"] = "1"
220 configurations[configuration][property]["value"] = "0"
221 elif configurations[configuration][property]["informations"]["type"] == "hex":
222 configurations[configuration][property]["value"] = unicode(self.pageContent.propertyTable.cellWidget(index, 1).text())
223 self.setProjectInfo("CONFIGURATIONS", configurations)
224 if self.moduleItem(self.currentModule()).checkState(0) == Qt.Checked:
225 self.dependencyCheck(self.moduleItem(self.currentModule()))
229 def loadModuleData(self):
231 Loads the module data.
233 # Do not load the module data again when the Wizard is in editing mode
234 # or when it's working on a preset.
235 if not self.project.edit and not self.project.from_preset:
236 # Load the module data every time so that if the user changed the cpu
237 # the right configurations are picked up.
239 self.project.loadModuleData()
240 except ModuleDefineException, e:
241 self.exceptionOccurred(self.tr("Error parsing line '%2' in file %1").arg(e.path).arg(e.line))
242 except EnumDefineException, e:
243 self.exceptionOccurred(self.tr("Error parsing line '%2' in file %1").arg(e.path).arg(e.line))
244 except ConfigurationDefineException, e:
245 self.exceptionOccurred(self.tr("Error parsing line '%2' in file %1").arg(e.path).arg(e.line))
247 def fillModuleTree(self):
249 Fills the module tree with the module entries separated in categories.
251 self.pageContent.moduleTree.clear()
252 modules = self.projectInfo("MODULES")
256 for module, information in modules.items():
257 if information["category"] not in categories:
258 categories[information["category"]] = []
259 categories[information["category"]].append(module)
260 for category, module_list in categories.items():
261 item = QTreeWidgetItem(QStringList([category]))
262 for module in module_list:
263 enabled = modules[module]["enabled"]
264 module_item = QTreeWidgetItem(item, QStringList([module]))
266 supported = bertos_utils.isSupported(self.project, module=module)
267 except SupportedException, e:
268 self.exceptionOccurred(self.tr("Error evaluating \"%1\" for module %2").arg(e.support_string).arg(module))
271 module_item.setForeground(0, QBrush(QColor(Qt.red)))
273 module_item.setCheckState(0, Qt.Checked)
275 module_item.setCheckState(0, Qt.Unchecked)
276 self.pageContent.moduleTree.addTopLevelItem(item)
277 self.pageContent.moduleTree.sortItems(0, Qt.AscendingOrder)
278 self.fillPropertyTable()
280 def insertCheckBox(self, index, value):
282 Inserts in the table at index a checkbox for a boolean property setted
285 check_box = QCheckBox()
286 self.pageContent.propertyTable.setCellWidget(index, 1, check_box)
288 check_box.setChecked(True)
290 check_box.setChecked(False)
291 self._control_group.addControl(index, check_box)
293 def insertComboBox(self, index, value, value_list):
295 Inserts in the table at index a combobox for an enum property setted
299 enum = self.projectInfo("LISTS")[value_list]
300 combo_box = QComboBox()
301 self.pageContent.propertyTable.setCellWidget(index, 1, combo_box)
302 for i, element in enumerate(enum):
303 combo_box.addItem(element)
305 combo_box.setCurrentIndex(i)
306 self._control_group.addControl(index, combo_box)
308 self.exceptionOccurred(self.tr("Define list \"%1\" not found. Check definition files.").arg(value_list))
309 self.pageContent.propertyTable.setItem(index, 1, QTableWidgetItem(value))
311 def insertSpinBox(self, index, value, informations):
313 Inserts in the table at index a spinbox for an int, a long or an unsigned
314 long property setted to value.
316 # int, long or undefined type property
318 if bertos_utils.isLong(informations) or bertos_utils.isUnsignedLong(informations):
319 spin_box = QDoubleSpinBox()
320 spin_box.setDecimals(0)
322 spin_box = QSpinBox()
323 self.pageContent.propertyTable.setCellWidget(index, 1, spin_box)
327 if bertos_utils.isLong(informations):
328 minimum = -2147483648
331 elif bertos_utils.isUnsigned(informations):
335 elif bertos_utils.isUnsignedLong(informations):
339 if "min" in informations:
340 minimum = int(informations["min"])
341 if "max" in informations:
342 maximum = int(informations["max"])
343 spin_box.setRange(minimum, maximum)
344 spin_box.setSuffix(suff)
345 spin_box.setValue(int(value.replace("L", "").replace("U", "")))
346 self._control_group.addControl(index, spin_box)
349 def insertLineEdit(self, index, value, informations):
351 Inserts in the table at index a line edit for hexadecimal property
354 edit_box = QLineEdit()
355 edit_validator = QRegExpValidator(QRegExp(r"^0x[0-9A-Fa-f]+$"), edit_box)
356 edit_box.setValidator(edit_validator)
357 self.pageContent.propertyTable.setCellWidget(index, 1, edit_box)
358 edit_box.setText(value)
359 self._control_group.addControl(index, edit_box)
361 def currentModule(self):
363 Retuns the current module name.
365 current_module = self.pageContent.moduleTree.currentItem()
366 # return only the child items
367 if current_module and current_module.parent():
368 return unicode(current_module.text(0))
372 def moduleItem(self, module):
373 for top_level_index in range(self.pageContent.moduleTree.topLevelItemCount()):
374 top_level_item = self.pageContent.moduleTree.topLevelItem(top_level_index)
375 for child_index in range(top_level_item.childCount()):
376 child_item = top_level_item.child(child_index)
377 if unicode(child_item.text(0)) == module:
381 def currentModuleConfigurations(self):
383 Returns the current module configuration.
385 return self.configurations(self.currentModule())
387 def currentProperty(self):
389 Rerturns the current property from the property table.
391 return qvariant_converter.getString(self.pageContent.propertyTable.item(self.pageContent.propertyTable.currentRow(), 0).data(Qt.UserRole))
393 def currentPropertyItem(self):
395 Returns the QTableWidgetItem of the current property.
397 return self.pageContent.propertyTable.item(self.pageContent.propertyTable.currentRow(), 0)
399 def configurations(self, module):
401 Returns the configuration for the selected module.
405 # On linux platform it seems that the behaviour of the focus
406 # changing is a bit different from the mac one. So if module is
407 # None then no configurations should be returned.
408 configuration = self.projectInfo("MODULES")[module]["configuration"]
409 if len(configuration) > 0:
410 return self.projectInfo("CONFIGURATIONS")[configuration]
414 def resetPropertyDescription(self):
416 Resets the label for each property table entry.
418 for index in range(self.pageContent.propertyTable.rowCount()):
419 property_name = qvariant_converter.getString(self.pageContent.propertyTable.item(index, 0).data(Qt.UserRole))
420 # Awful solution! Needed because if the user change the module, the selection changed...
421 if property_name not in self.currentModuleConfigurations():
423 self.pageContent.propertyTable.item(index, 0).setText(self.currentModuleConfigurations()[property_name]['brief'])
425 def setBold(self, item, bold):
426 self.pageContent.moduleTree.blockSignals(True)
429 item.setFont(0, font)
430 self.pageContent.moduleTree.blockSignals(False)
432 def isBold(self, item):
433 return item.font(0).bold()
435 def moduleSelected(self, selectedModule):
437 Resolves the selection dependencies.
440 qApp.setOverrideCursor(Qt.WaitCursor)
441 modules = self.projectInfo("MODULES")
442 modules[selectedModule]["enabled"] = True
443 self.setProjectInfo("MODULES", modules)
444 depends = self.projectInfo("MODULES")[selectedModule]["depends"]
446 if self.pageContent.automaticFix.isChecked():
447 unsatisfied = self.selectDependencyCheck(selectedModule)
448 if len(unsatisfied) > 0:
449 for module in unsatisfied:
450 modules = self.projectInfo("MODULES")
451 modules[module]["enabled"] = True
452 for category in range(self.pageContent.moduleTree.topLevelItemCount()):
453 item = self.pageContent.moduleTree.topLevelItem(category)
454 for child in range(item.childCount()):
455 if unicode(item.child(child).text(0)) in unsatisfied:
456 self.setBold(item.child(child), True)
457 self.setBold(item, True)
458 item.child(child).setCheckState(0, Qt.Checked)
460 qApp.restoreOverrideCursor()
462 def moduleUnselected(self, unselectedModule):
464 Resolves the unselection dependencies.
467 qApp.setOverrideCursor(Qt.WaitCursor)
468 modules = self.projectInfo("MODULES")
469 modules[unselectedModule]["enabled"] = False
470 self.setProjectInfo("MODULES", modules)
472 unsatisfied_params = []
473 if self.pageContent.automaticFix.isChecked():
474 unsatisfied, unsatisfied_params = self.unselectDependencyCheck(unselectedModule)
475 if len(unsatisfied) > 0 or len(unsatisfied_params) > 0:
477 heading = self.tr("The module %1 is needed by").arg(unselectedModule)
478 message.append(heading)
479 module_list = ", ".join(unsatisfied)
480 param_list = ", ".join(["%s (%s)" %(param_name, module) for module, param_name in unsatisfied_params])
482 message.append(QString(module_list))
483 if module_list and param_list:
484 message.append(self.tr("and by"))
486 message.append(QString(param_list))
487 message_str = QStringList(message).join(" ")
488 message_str.append(self.tr("\n\nDo you want to automatically fix these conflicts?"))
489 qApp.restoreOverrideCursor()
490 choice = QMessageBox.warning(self, self.tr("Dependency error"), message_str, QMessageBox.Yes | QMessageBox.No, QMessageBox.Yes)
491 qApp.setOverrideCursor(Qt.WaitCursor)
492 if choice == QMessageBox.Yes:
493 for module in unsatisfied:
494 modules = self.projectInfo("MODULES")
495 modules[module]["enabled"] = False
496 for category in range(self.pageContent.moduleTree.topLevelItemCount()):
497 item = self.pageContent.moduleTree.topLevelItem(category)
498 self.setBold(item, False)
499 for child in range(item.childCount()):
500 if unicode(item.child(child).text(0)) in unsatisfied:
501 self.setBold(item.child(child), False)
502 item.child(child).setCheckState(0, Qt.Unchecked)
504 if self.isBold(item.child(child)):
505 self.setBold(item, True)
506 for module, param in unsatisfied_params:
507 configuration_file = self.projectInfo("MODULES")[module]["configuration"]
508 configurations = self.projectInfo("CONFIGURATIONS")
509 configurations[configuration_file][param]["value"] = "0"
510 self.setProjectInfo("CONFIGURATIONS", configurations)
512 qApp.restoreOverrideCursor()
514 def selectDependencyCheck(self, module):
516 Returns the list of unsatisfied dependencies after a selection.
519 modules = self.projectInfo("MODULES")
520 files = self.projectInfo("FILES")
521 configurations = self.projectInfo("CONFIGURATIONS").get(modules[module]["configuration"], {"paramlist": ()})
522 conditional_deps = ()
523 for i, param_name in configurations["paramlist"]:
524 information = configurations[param_name]
525 if information["informations"]["type"] == "boolean" and \
526 information["value"] != "0" and \
527 "conditional_deps" in information["informations"]:
529 conditional_deps += information["informations"]["conditional_deps"]
531 for dependency in modules[module]["depends"] + conditional_deps:
532 if dependency in modules and not modules[dependency]["enabled"]:
533 unsatisfied |= set([dependency])
534 if dependency not in unsatisfied:
535 unsatisfied |= self.selectDependencyCheck(dependency)
536 if dependency not in modules:
537 if dependency in files:
538 files[dependency] += 1
540 files[dependency] = 1
541 self.setProjectInfo("FILES", files)
544 def unselectDependencyCheck(self, dependency):
546 Returns the list of unsatisfied dependencies after an unselection.
549 unsatisfied_params = set()
550 modules = self.projectInfo("MODULES")
551 for module, informations in modules.items():
552 configurations = self.projectInfo("CONFIGURATIONS").get(informations["configuration"], {"paramlist": ()})
553 conditional_deps = {}
554 for i, param_name in configurations["paramlist"]:
555 information = configurations[param_name]
556 if information["informations"]["type"] == "boolean" and information["value"] != "0" and "conditional_deps" in information["informations"]:
557 for dep in information["informations"]["conditional_deps"]:
558 if not dep in conditional_deps:
559 conditional_deps[dep] = []
560 conditional_deps[dep].append((module, param_name))
561 if dependency in informations["depends"] and informations["enabled"]:
562 unsatisfied |= set([module])
563 if dependency not in unsatisfied:
564 tmp = self.unselectDependencyCheck(module)
565 unsatisfied |= tmp[0]
566 unsatisfied_params |= tmp[1]
567 if dependency in conditional_deps:
568 unsatisfied_params |= set(conditional_deps[dependency])
569 return unsatisfied, unsatisfied_params
571 def removeFileDependencies(self, module):
573 Removes the files dependencies of the given module.
575 modules = self.projectInfo("MODULES")
576 files = self.projectInfo("FILES")
577 dependencies = modules[module]["depends"]
578 for dependency in dependencies:
579 if dependency in files:
580 files[dependency] -= 1
581 if files[dependency] == 0:
582 del files[dependency]
583 self.setProjectInfo("FILES", files)
585 class QControlGroup(QObject):
587 Simple class that permit to connect different signals of different widgets
588 with a slot that emit a signal. Permits to group widget and to understand which of
589 them has sent the signal.
593 QObject.__init__(self)
596 def addControl(self, id, control):
600 self._controls[id] = control
601 if type(control) == QCheckBox:
602 self.connect(control, SIGNAL("stateChanged(int)"), lambda: self.stateChanged(id))
603 elif type(control) == QSpinBox:
604 self.connect(control, SIGNAL("valueChanged(int)"), lambda: self.stateChanged(id))
605 elif type(control) == QComboBox:
606 self.connect(control, SIGNAL("currentIndexChanged(int)"), lambda: self.stateChanged(id))
607 elif type(control) == QDoubleSpinBox:
608 self.connect(control, SIGNAL("valueChanged(double)"), lambda: self.stateChanged(id))
609 elif type(control) == QLineEdit:
610 self.connect(control, SIGNAL("textChanged(QString)"), lambda: self.stateChanged(id))
614 Remove all the controls.
618 def stateChanged(self, id):
620 Slot called when the value of one of the stored widget changes. It emits
623 self.emit(SIGNAL("stateChanged"), id)