Add BeRTOS versions contained in the windows registry
[bertos.git] / wizard / BVersionPage.py
index a5a9bd5ee58597eef58559d4a6bd709812fa126a..fde94dbb84dae030ef9a20034a02788de946cd19 100644 (file)
 # Copyright 2008 Develer S.r.l. (http://www.develer.com/)
 # All rights reserved.
 #
-# $Id:$
+# $Id$
 #
 # Author: Lorenzo Berni <duplo@develer.com>
 #
 
+import os
+
 from PyQt4.QtGui import *
 from BWizardPage import *
 import bertos_utils
+import qvariant_converter
+
+from const import *
 
 class BVersionPage(BWizardPage):
+    """
+    Page of the wizard that permits to choose which BeRTOS version the user wants
+    to use. This page show some pieces of information about the version.
+    """
     
     def __init__(self):
-        BWizardPage.__init__(self, "bertos_versions.ui")
-        self._connectSignals()
-        self._fillVersionList()
-        self._setupUi()
-        self.setTitle(self.tr("Select the BeRTOS version needed"))
-    
-    def _connectSignals(self):
-        self.connect(self.pageContent.versionList, SIGNAL("itemClicked(QListWidgetItem *)"), self.itemClicked)
+        BWizardPage.__init__(self, UI_LOCATION + "/bertos_versions.ui")
+        self.setTitle(self.tr("Select the BeRTOS directory"))
+        self.setSubTitle(self.tr("The project created will be based on the BeRTOS version found"))
+
+    ## Overloaded QWizardPage methods ##
+    
+    def isComplete(self):
+        """
+        Overload of the QWizardPage isComplete method.
+        """
+        if self.pageContent.versionList.currentRow() != -1:
+            sources_path = qvariant_converter.getString(self.pageContent.versionList.currentItem().data(Qt.UserRole))
+            # Remove the trailing slash
+            if sources_path.endswith(os.sep):
+                sources_path = sources_path[:-1]
+            self.setProjectInfo("SOURCES_PATH", sources_path)
+            return True
+        else:
+            return False
+    
+    ####
+    
+    ## Overloaded BWizardPage methods ##
+
+    def connectSignals(self):
+        """
+        Overload of the BWizardPage connectSignals method.
+        """
+        self.connect(self.pageContent.versionList, SIGNAL("itemSelectionChanged()"), self.rowChanged)
         self.connect(self.pageContent.addButton, SIGNAL("clicked()"), self.addVersion)
         self.connect(self.pageContent.removeButton, SIGNAL("clicked()"), self.removeVersion)
         # Fake signal connection for the update button
         self.connect(self.pageContent.updateButton, SIGNAL("clicked()"), self.updateClicked)
     
-    def _setupUi(self):
-        pass
+    def reloadData(self):
+        """
+        Overload of the BWizardPage reloadData method.
+        """
+        self.resetVersionList()
+        self.pageContent.versionList.setCurrentRow(-1)
+        self.fillVersionList()
     
-    def _storeVersion(self, directory):
-        versions = self._settingsRetrieve("versions").toList()
-        versions = set([x.toString() for x in versions] + [directory])
-        self._settingsStore("versions", list(versions))
+    def setupUi(self):
+        """
+        Overload of the BWizardPage setupUi method.
+        """
+        self.pageContent.updateButton.setVisible(False)
     
-    def _deleteVersion(self, directory):
-        versions = self._settingsRetrieve(QString("versions")).toList()
-        versions = [x.toString() for x in versions]
-        versions.remove(directory)
-        self._settingsStore("versions", versions)
-        
-    def _insertListElement(self, directory):
-        if bertos_utils.isBertosDir(directory):
-            item = QListWidgetItem(QIcon(":/images/ok.png"), bertos_utils.bertosVersion(directory) + " (\"" + directory + "\")")
-            item.setData(Qt.UserRole, QVariant(directory))
-            self.pageContent.versionList.addItem(item)
-        elif not directory.isEmpty():
-            item = QListWidgetItem(QIcon(":/images/warning.png"), "UNKNOWN" + " (\"" + directory + "\")")
-            item.setData(Qt.UserRole, QVariant(directory))
-            self.pageContent.versionList.addItem(item)
+    ####
     
-    def _fillVersionList(self):
-        versions = self._settingsRetrieve("versions").toList()
-        for directory in versions:
-            self._insertListElement(directory.toString())
-
-    def isComplete(self):
-        if self.pageContent.versionList.currentRow() != -1:
-            self._projectInfoStore("SOURCES_PATH", unicode(self.pageContent.versionList.currentItem().data(Qt.UserRole).toString()))
-            return True
-        else:
-            return False
+    ## Slots ##
     
     def addVersion(self):
+        """
+        Slot called when the user add a BeRTOS version.
+        """
         directory = QFileDialog.getExistingDirectory(self, self.tr("Choose a directory"), "", QFileDialog.ShowDirsOnly | QFileDialog.DontResolveSymlinks)
         if not directory.isEmpty():
-            self._storeVersion(directory)
+            self.storeVersion(unicode(directory))
             self.pageContent.versionList.clear()
-            self._fillVersionList()
+            self.fillVersionList()
             self.emit(SIGNAL("completeChanged()"))
     
     def removeVersion(self):
+        """
+        Slot called when the user remove a BeRTOS version.
+        """
         item = self.pageContent.versionList.takeItem(self.pageContent.versionList.currentRow())
-        self._deleteVersion(item.data(Qt.UserRole).toString())
+        self.deleteVersion(qvariant_converter.getString(item.data(Qt.UserRole)))
         self.emit(SIGNAL("completeChanged()"))
     
+    def rowChanged(self):
+        """
+        Slot called when the user select an entry from the version list.
+        """
+        self.emit(SIGNAL("completeChanged()"))
+
     def updateClicked(self):
-        print "fake update checking"
+        """
+        Slot called when the user clicks on the 'update' button. It checks for
+        update (TO BE IMPLEMENTED).
+        """
+        pass    
+
+    ####
     
-    def itemClicked(self, item):
-        self.emit(SIGNAL("completeChanged()"))
-    
\ No newline at end of file
+    def storeVersion(self, directory):
+        """
+        Stores the directory selected by the user in the QSettings.
+        """
+        versions = self.versions()
+        versions = set(versions + [directory])
+        self.setVersions(list(versions))
+    
+    def deleteVersion(self, directory):
+        """
+        Removes the given directory from the QSettings.
+        """
+        versions = self.versions()
+        versions.remove(directory)
+        self.setVersions(versions)
+    
+    def resetVersionList(self):
+        """
+        Remove all the version entries from the list.
+        """
+        self.pageContent.versionList.clear()
+    
+    def insertListElement(self, directory):
+        """
+        Inserts the given directory in the version list and returns the
+        inserted item.
+        """
+        if bertos_utils.isBertosDir(directory):
+            item = QListWidgetItem(QIcon(":/images/ok.png"), bertos_utils.bertosVersion(directory) + " (\"" + os.path.normpath(directory) + "\")")
+            item.setData(Qt.UserRole, qvariant_converter.convertString(directory))
+            self.pageContent.versionList.addItem(item)
+            return item
+        elif len(directory) > 0:
+            item = QListWidgetItem(QIcon(":/images/warning.png"), "UNKNOWN" + " (\"" + os.path.normpath(directory) + "\")")
+            item.setData(Qt.UserRole, qvariant_converter.convertString(directory))
+            self.pageContent.versionList.addItem(item)
+            return item
+    
+    def fillVersionList(self):
+        """
+        Fills the version list with all the BeRTOS versions founded in the QSettings.
+        """
+        versions = set([])
+        if os.name == "nt":
+            import winreg_importer
+            versions |= set(winreg_importer.getBertosDirs())
+        versions |= set(self.versions())
+        selected = self.projectInfo("SOURCES_PATH")
+        for directory in versions:
+            item = self.insertListElement(directory)
+            if selected and selected == directory:
+                self.setCurrentItem(item)
+    
+    def setCurrentItem(self, item):
+        """
+        Select the given item in the version list.
+        """
+        self.pageContent.versionList.setCurrentItem(item)
\ No newline at end of file