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)
152 item.setToolTip(property)
153 item.setData(Qt.UserRole, qvariant_converter.convertString(property))
154 self.pageContent.propertyTable.setItem(index, 0, item)
155 if "type" in configurations[property]["informations"] and configurations[property]["informations"]["type"] == "boolean":
156 self.insertCheckBox(index, configurations[property]["value"])
157 elif "type" in configurations[property]["informations"] and configurations[property]["informations"]["type"] == "enum":
158 self.insertComboBox(index, configurations[property]["value"], configurations[property]["informations"]["value_list"])
159 elif "type" in configurations[property]["informations"] and configurations[property]["informations"]["type"] == "int":
160 self.insertSpinBox(index, configurations[property]["value"], configurations[property]["informations"])
162 # Not defined type, rendered as a text field
163 self.pageContent.propertyTable.setItem(index, 1, QTableWidgetItem(configurations[property]["value"]))
165 if self.pageContent.propertyTable.rowCount() == 0:
166 module_label = self.pageContent.moduleLabel.text()
167 module_label += "\n\nNo configuration needed."
168 self.pageContent.moduleLabel.setText(module_label)
170 self.pageContent.moduleLabel.setText("")
171 self.pageContent.moduleLabel.setVisible(False)
172 self.pageContent.propertyTable.clear()
173 self.pageContent.propertyTable.setRowCount(0)
175 def dependencyCheck(self, item):
177 Checks the dependencies of the module associated with the given item.
180 module = unicode(item.text(0))
181 if item.checkState(0) == Qt.Checked:
182 self.moduleSelected(module)
184 self.moduleUnselected(module)
185 self.removeFileDependencies(module)
187 def showPropertyDescription(self):
189 Slot called when the property selection changes. Shows the description
190 of the selected property.
192 self.resetPropertyDescription()
193 configurations = self.currentModuleConfigurations()
194 if self.currentProperty() in configurations:
195 description = configurations[self.currentProperty()]["brief"]
196 name = self.currentProperty()
197 self.currentPropertyItem().setText(description + "\n" + name)
199 def saveValue(self, index):
201 Slot called when the user modifies one of the configuration parameters.
202 It stores the new value."""
203 property = qvariant_converter.getString(self.pageContent.propertyTable.item(index, 0).data(Qt.UserRole))
204 configuration = self.projectInfo("MODULES")[self.currentModule()]["configuration"]
205 configurations = self.projectInfo("CONFIGURATIONS")
206 if "type" not in configurations[configuration][property]["informations"] or configurations[configuration][property]["informations"]["type"] == "int":
207 configurations[configuration][property]["value"] = unicode(int(self.pageContent.propertyTable.cellWidget(index, 1).value()))
208 elif configurations[configuration][property]["informations"]["type"] == "enum":
209 configurations[configuration][property]["value"] = unicode(self.pageContent.propertyTable.cellWidget(index, 1).currentText())
210 elif configurations[configuration][property]["informations"]["type"] == "boolean":
211 if self.pageContent.propertyTable.cellWidget(index, 1).isChecked():
212 configurations[configuration][property]["value"] = "1"
214 configurations[configuration][property]["value"] = "0"
215 self.setProjectInfo("CONFIGURATIONS", configurations)
216 if self.moduleItem(self.currentModule()).checkState(0) == Qt.Checked:
217 self.dependencyCheck(self.moduleItem(self.currentModule()))
221 def loadModuleData(self):
223 Loads the module data.
225 # Do not load the module data again when the Wizard is in editing mode
226 # or when it's working on a preset.
227 if not self.project.edit and not self.project.from_preset:
228 # Load the module data every time so that if the user changed the cpu
229 # the right configurations are picked up.
231 self.project.loadModuleData()
232 except ModuleDefineException, e:
233 self.exceptionOccurred(self.tr("Error parsing line '%2' in file %1").arg(e.path).arg(e.line))
234 except EnumDefineException, e:
235 self.exceptionOccurred(self.tr("Error parsing line '%2' in file %1").arg(e.path).arg(e.line))
236 except ConfigurationDefineException, e:
237 self.exceptionOccurred(self.tr("Error parsing line '%2' in file %1").arg(e.path).arg(e.line))
239 def fillModuleTree(self):
241 Fills the module tree with the module entries separated in categories.
243 self.pageContent.moduleTree.clear()
244 modules = self.projectInfo("MODULES")
248 for module, information in modules.items():
249 if information["category"] not in categories:
250 categories[information["category"]] = []
251 categories[information["category"]].append(module)
252 for category, module_list in categories.items():
253 item = QTreeWidgetItem(QStringList([category]))
254 for module in module_list:
255 enabled = modules[module]["enabled"]
256 module_item = QTreeWidgetItem(item, QStringList([module]))
258 supported = bertos_utils.isSupported(self.project, module=module)
259 except SupportedException, e:
260 self.exceptionOccurred(self.tr("Error evaluating \"%1\" for module %2").arg(e.support_string).arg(module))
263 module_item.setForeground(0, QBrush(QColor(Qt.red)))
265 module_item.setCheckState(0, Qt.Checked)
267 module_item.setCheckState(0, Qt.Unchecked)
268 self.pageContent.moduleTree.addTopLevelItem(item)
269 self.pageContent.moduleTree.sortItems(0, Qt.AscendingOrder)
270 self.fillPropertyTable()
272 def insertCheckBox(self, index, value):
274 Inserts in the table at index a checkbox for a boolean property setted
277 check_box = QCheckBox()
278 self.pageContent.propertyTable.setCellWidget(index, 1, check_box)
280 check_box.setChecked(True)
282 check_box.setChecked(False)
283 self._control_group.addControl(index, check_box)
285 def insertComboBox(self, index, value, value_list):
287 Inserts in the table at index a combobox for an enum property setted
291 enum = self.projectInfo("LISTS")[value_list]
292 combo_box = QComboBox()
293 self.pageContent.propertyTable.setCellWidget(index, 1, combo_box)
294 for i, element in enumerate(enum):
295 combo_box.addItem(element)
297 combo_box.setCurrentIndex(i)
298 self._control_group.addControl(index, combo_box)
300 self.exceptionOccurred(self.tr("Define list \"%1\" not found. Check definition files.").arg(value_list))
301 self.pageContent.propertyTable.setItem(index, 1, QTableWidgetItem(value))
303 def insertSpinBox(self, index, value, informations):
305 Inserts in the table at index a spinbox for an int, a long or an unsigned
306 long property setted to value.
308 # int, long or undefined type property
310 if bertos_utils.isLong(informations) or bertos_utils.isUnsignedLong(informations):
311 spin_box = QDoubleSpinBox()
312 spin_box.setDecimals(0)
314 spin_box = QSpinBox()
315 self.pageContent.propertyTable.setCellWidget(index, 1, spin_box)
319 if bertos_utils.isLong(informations):
320 minimum = -2147483648
323 elif bertos_utils.isUnsigned(informations):
327 elif bertos_utils.isUnsignedLong(informations):
331 if "min" in informations:
332 minimum = int(informations["min"])
333 if "max" in informations:
334 maximum = int(informations["max"])
335 spin_box.setRange(minimum, maximum)
336 spin_box.setSuffix(suff)
337 spin_box.setValue(int(value.replace("L", "").replace("U", "")))
338 self._control_group.addControl(index, spin_box)
341 def currentModule(self):
343 Retuns the current module name.
345 current_module = self.pageContent.moduleTree.currentItem()
346 # return only the child items
347 if current_module and current_module.parent():
348 return unicode(current_module.text(0))
352 def moduleItem(self, module):
353 for top_level_index in range(self.pageContent.moduleTree.topLevelItemCount()):
354 top_level_item = self.pageContent.moduleTree.topLevelItem(top_level_index)
355 for child_index in range(top_level_item.childCount()):
356 child_item = top_level_item.child(child_index)
357 if unicode(child_item.text(0)) == module:
361 def currentModuleConfigurations(self):
363 Returns the current module configuration.
365 return self.configurations(self.currentModule())
367 def currentProperty(self):
369 Rerturns the current property from the property table.
371 return qvariant_converter.getString(self.pageContent.propertyTable.item(self.pageContent.propertyTable.currentRow(), 0).data(Qt.UserRole))
373 def currentPropertyItem(self):
375 Returns the QTableWidgetItem of the current property.
377 return self.pageContent.propertyTable.item(self.pageContent.propertyTable.currentRow(), 0)
379 def configurations(self, module):
381 Returns the configuration for the selected module.
385 # On linux platform it seems that the behaviour of the focus
386 # changing is a bit different from the mac one. So if module is
387 # None then no configurations should be returned.
388 configuration = self.projectInfo("MODULES")[module]["configuration"]
389 if len(configuration) > 0:
390 return self.projectInfo("CONFIGURATIONS")[configuration]
394 def resetPropertyDescription(self):
396 Resets the label for each property table entry.
398 for index in range(self.pageContent.propertyTable.rowCount()):
399 property_name = qvariant_converter.getString(self.pageContent.propertyTable.item(index, 0).data(Qt.UserRole))
400 # Awful solution! Needed because if the user change the module, the selection changed...
401 if property_name not in self.currentModuleConfigurations():
403 self.pageContent.propertyTable.item(index, 0).setText(self.currentModuleConfigurations()[property_name]['brief'])
405 def setBold(self, item, bold):
406 self.pageContent.moduleTree.blockSignals(True)
409 item.setFont(0, font)
410 self.pageContent.moduleTree.blockSignals(False)
412 def isBold(self, item):
413 return item.font(0).bold()
415 def moduleSelected(self, selectedModule):
417 Resolves the selection dependencies.
420 qApp.setOverrideCursor(Qt.WaitCursor)
421 modules = self.projectInfo("MODULES")
422 modules[selectedModule]["enabled"] = True
423 self.setProjectInfo("MODULES", modules)
424 depends = self.projectInfo("MODULES")[selectedModule]["depends"]
426 if self.pageContent.automaticFix.isChecked():
427 unsatisfied = self.selectDependencyCheck(selectedModule)
428 if len(unsatisfied) > 0:
429 for module in unsatisfied:
430 modules = self.projectInfo("MODULES")
431 modules[module]["enabled"] = True
432 for category in range(self.pageContent.moduleTree.topLevelItemCount()):
433 item = self.pageContent.moduleTree.topLevelItem(category)
434 for child in range(item.childCount()):
435 if unicode(item.child(child).text(0)) in unsatisfied:
436 self.setBold(item.child(child), True)
437 self.setBold(item, True)
438 item.child(child).setCheckState(0, Qt.Checked)
440 qApp.restoreOverrideCursor()
442 def moduleUnselected(self, unselectedModule):
444 Resolves the unselection dependencies.
447 qApp.setOverrideCursor(Qt.WaitCursor)
448 modules = self.projectInfo("MODULES")
449 modules[unselectedModule]["enabled"] = False
450 self.setProjectInfo("MODULES", modules)
452 unsatisfied_params = []
453 if self.pageContent.automaticFix.isChecked():
454 unsatisfied, unsatisfied_params = self.unselectDependencyCheck(unselectedModule)
455 if len(unsatisfied) > 0 or len(unsatisfied_params) > 0:
457 heading = self.tr("The module %1 is needed by").arg(unselectedModule)
458 message.append(heading)
459 module_list = ", ".join(unsatisfied)
460 param_list = ", ".join(["%s (%s)" %(param_name, module) for module, param_name in unsatisfied_params])
462 message.append(QString(module_list))
463 if module_list and param_list:
464 message.append(self.tr("and by"))
466 message.append(QString(param_list))
467 message_str = QStringList(message).join(" ")
468 message_str.append(self.tr("\n\nDo you want to automatically fix these conflicts?"))
469 qApp.restoreOverrideCursor()
470 choice = QMessageBox.warning(self, self.tr("Dependency error"), message_str, QMessageBox.Yes | QMessageBox.No, QMessageBox.Yes)
471 qApp.setOverrideCursor(Qt.WaitCursor)
472 if choice == QMessageBox.Yes:
473 for module in unsatisfied:
474 modules = self.projectInfo("MODULES")
475 modules[module]["enabled"] = False
476 for category in range(self.pageContent.moduleTree.topLevelItemCount()):
477 item = self.pageContent.moduleTree.topLevelItem(category)
478 self.setBold(item, False)
479 for child in range(item.childCount()):
480 if unicode(item.child(child).text(0)) in unsatisfied:
481 self.setBold(item.child(child), False)
482 item.child(child).setCheckState(0, Qt.Unchecked)
484 if self.isBold(item.child(child)):
485 self.setBold(item, True)
486 for module, param in unsatisfied_params:
487 configuration_file = self.projectInfo("MODULES")[module]["configuration"]
488 configurations = self.projectInfo("CONFIGURATIONS")
489 configurations[configuration_file][param]["value"] = "0"
490 self.setProjectInfo("CONFIGURATIONS", configurations)
492 qApp.restoreOverrideCursor()
494 def selectDependencyCheck(self, module):
496 Returns the list of unsatisfied dependencies after a selection.
499 modules = self.projectInfo("MODULES")
500 files = self.projectInfo("FILES")
501 configurations = self.projectInfo("CONFIGURATIONS").get(modules[module]["configuration"], {"paramlist": ()})
502 conditional_deps = ()
503 for i, param_name in configurations["paramlist"]:
504 information = configurations[param_name]
505 if information["informations"]["type"] == "boolean" and \
506 information["value"] != "0" and \
507 "conditional_deps" in information["informations"]:
509 conditional_deps += information["informations"]["conditional_deps"]
511 for dependency in modules[module]["depends"] + conditional_deps:
512 if dependency in modules and not modules[dependency]["enabled"]:
513 unsatisfied |= set([dependency])
514 if dependency not in unsatisfied:
515 unsatisfied |= self.selectDependencyCheck(dependency)
516 if dependency not in modules:
517 if dependency in files:
518 files[dependency] += 1
520 files[dependency] = 1
521 self.setProjectInfo("FILES", files)
524 def unselectDependencyCheck(self, dependency):
526 Returns the list of unsatisfied dependencies after an unselection.
529 unsatisfied_params = set()
530 modules = self.projectInfo("MODULES")
531 for module, informations in modules.items():
532 configurations = self.projectInfo("CONFIGURATIONS").get(informations["configuration"], {"paramlist": ()})
533 conditional_deps = {}
534 for i, param_name in configurations["paramlist"]:
535 information = configurations[param_name]
536 if information["informations"]["type"] == "boolean" and information["value"] != "0" and "conditional_deps" in information["informations"]:
537 for dep in information["informations"]["conditional_deps"]:
538 if not dep in conditional_deps:
539 conditional_deps[dep] = []
540 conditional_deps[dep].append((module, param_name))
541 if dependency in informations["depends"] and informations["enabled"]:
542 unsatisfied |= set([module])
543 if dependency not in unsatisfied:
544 tmp = self.unselectDependencyCheck(module)
545 unsatisfied |= tmp[0]
546 unsatisfied_params |= tmp[1]
547 if dependency in conditional_deps:
548 unsatisfied_params |= set(conditional_deps[dependency])
549 return unsatisfied, unsatisfied_params
551 def removeFileDependencies(self, module):
553 Removes the files dependencies of the given module.
555 modules = self.projectInfo("MODULES")
556 files = self.projectInfo("FILES")
557 dependencies = modules[module]["depends"]
558 for dependency in dependencies:
559 if dependency in files:
560 files[dependency] -= 1
561 if files[dependency] == 0:
562 del files[dependency]
563 self.setProjectInfo("FILES", files)
565 class QControlGroup(QObject):
567 Simple class that permit to connect different signals of different widgets
568 with a slot that emit a signal. Permits to group widget and to understand which of
569 them has sent the signal.
573 QObject.__init__(self)
576 def addControl(self, id, control):
580 self._controls[id] = control
581 if type(control) == QCheckBox:
582 self.connect(control, SIGNAL("stateChanged(int)"), lambda: self.stateChanged(id))
583 elif type(control) == QSpinBox:
584 self.connect(control, SIGNAL("valueChanged(int)"), lambda: self.stateChanged(id))
585 elif type(control) == QComboBox:
586 self.connect(control, SIGNAL("currentIndexChanged(int)"), lambda: self.stateChanged(id))
587 elif type(control) == QDoubleSpinBox:
588 self.connect(control, SIGNAL("valueChanged(double)"), lambda: self.stateChanged(id))
592 Remove all the controls.
596 def stateChanged(self, id):
598 Slot called when the value of one of the stored widget changes. It emits
601 self.emit(SIGNAL("stateChanged"), id)