Refactor to use new protocol module and sipo.
[bertos.git] / wizard / BToolchainPage.py
index 7cd722a15fb68f84d3d60f83a8d0c5f5fa2351f1..041a8069a8c86cb62034ae8d33d9daa4da984d1f 100644 (file)
@@ -1,10 +1,33 @@
 #!/usr/bin/env python
 # encoding: utf-8
 #
+# This file is part of BeRTOS.
+#
+# Bertos is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+# As a special exception, you may use this file as part of a free software
+# library without restriction.  Specifically, if other files instantiate
+# templates or use macros or inline functions from this file, or you compile
+# this file and link it with other files to produce an executable, this
+# file does not by itself cause the resulting executable to be covered by
+# the GNU General Public License.  This exception does not however
+# invalidate any other reasons why the executable file might be covered by
+# the GNU General Public License.
+#
 # Copyright 2008 Develer S.r.l. (http://www.develer.com/)
-# All rights reserved.
 #
-# $Id:$
 #
 # Author: Lorenzo Berni <duplo@develer.com>
 #
@@ -13,156 +36,264 @@ import os
 import collections
 
 from BWizardPage import *
+from BCreationPage import BCreationPage
+
 import BToolchainSearch
 import bertos_utils
 import qvariant_converter
 
+from toolchain_manager import ToolchainManager
+
 from const import *
 
 class BToolchainPage(BWizardPage):
-    
+    """
+    Page of the wizard that permits to choose the toolchain to use for the
+    project.
+    """
+
     def __init__(self):
         BWizardPage.__init__(self, UI_LOCATION + "/toolchain_select.ui")
         self.setTitle(self.tr("Select toolchain"))
-        self._validation_process = None
-        self._updateUi()
-        #self._populateToolchainList()
-        self._connectSignals()
-    
-    def _updateUi(self):
+        self.setSubTitle(self.tr("You can look for more toolchains in your system by pressing the \"Search\" button, or manually add them with the \"+\" button"))
+        self._valid_items = []
+        self._toolchain_manager = ToolchainManager()
+
+    ## Overloaded QWizardPage methods. ##
+
+    def isComplete(self):
+        """
+        Overload of the QWizard isComplete method.
+        """
+        if self.pageContent.toolchainList.currentRow() != -1:
+            self.setProjectInfo("TOOLCHAIN",
+                qvariant_converter.getStringDict(self.pageContent.toolchainList.currentItem().data(Qt.UserRole)))
+            return True
+        else:
+            return False
+
+    def nextId(self):
+        """
+        Overload of the QWizardPage nextId method.
+        """
+        # Route to Output page if it's a predefined easy project.
+        if self.projectInfo("PROJECT_FROM_PRESET") and self.projectInfo("BASE_MODE"):
+            return self.wizard().pageIndex(BCreationPage)
+        else:
+            return QWizardPage.nextId(self)
+
+    ####
+
+    ## Overloaded BWizardPage methods. ##
+
+    def setupUi(self):
+        """
+        Sets up the user interface.
+        """
         self.pageContent.infoLabel.setVisible(False)
-    
-    def _populateToolchainList(self):
-        toolchains = self.toolchains()
-        sel_toolchain = self._projectInfoRetrieve("TOOLCHAIN")
-        for key, value in toolchains.items():
-            item = QListWidgetItem(key)
-            item.setData(Qt.UserRole, qvariant_converter.convertStringDict({"path": key}))
-            self.pageContent.toolchainList.addItem(item)
-            if sel_toolchain is not None and sel_toolchain["path"] == key:
-                self.pageContent.toolchainList.setCurrentItem(item)
-            if value:
-                self.validateToolchain(self.pageContent.toolchainList.row(item))
 
-    def _clearList(self):
-        self.pageContent.toolchainList.clear()
-    
-    def _selectionChanged(self):
+    def connectSignals(self):
+        """
+        Connects the signals with the related slots.
+        """
+        self.connect(self.pageContent.toolchainList, SIGNAL("currentItemChanged(QListWidgetItem *, QListWidgetItem*)"), self.selectionChanged)
+        self.connect(self.pageContent.addButton, SIGNAL("clicked()"), self.addToolchain)
+        self.connect(self.pageContent.removeButton, SIGNAL("clicked()"), self.removeToolchain)
+        self.connect(self.pageContent.searchButton, SIGNAL("clicked()"), self.searchToolchain)
+        self.connect(self.pageContent.checkButton, SIGNAL("clicked()"), self.validateAllToolchains)
+
+    def reloadData(self, previous_id=None):
+        """
+        Overload of the BWizard reloadData method.
+        """
+        if previous_id is None or previous_id < self.wizard().currentId():
+            self._clearList()
+            self.setupUi()
+            self._populateToolchainList()
+            if len(self._valid_items) >= 1:
+                self.pageContent.toolchainList.setCurrentItem(self._valid_items[0])
+
+    ####
+
+    ## Slots ##
+
+    def selectionChanged(self):
+        """
+        Slot called when the user click on an entry of the toolchain list.
+        """
         if self.pageContent.toolchainList.currentRow() != -1:
             infos = collections.defaultdict(lambda: unicode("not defined"))
             infos.update(qvariant_converter.getStringDict(self.pageContent.toolchainList.currentItem().data(Qt.UserRole)))
             self.pageContent.infoLabel.setText("GCC " + infos["version"] + " (" + infos["build"] + ")\nTarget: " + infos["target"] + "\nPath: " + os.path.normpath(infos["path"]))
             self.pageContent.infoLabel.setVisible(True)
+            if self.isDefaultToolchain(infos):
+                self.disableRemoveButton()
+            else:
+                self.enableRemoveButton()
             self.emit(SIGNAL("completeChanged()"))
-    
-    def _search(self):
-        dir_list = self.searchDirList()
-        if self.pathSearch():
-            dir_list += [element for element in bertos_utils.getSystemPath()]
-        toolchain_list = bertos_utils.findToolchains(dir_list)
-        stored_toolchains = self.toolchains()
-        for element in toolchain_list:
-            if not element in stored_toolchains.keys():
-                item = QListWidgetItem(element)
-                item.setData(Qt.UserRole, qvariant_converter.convertStringDict({"path": element}))
-                self.pageContent.toolchainList.addItem(item)
-                stored_toolchains[element] = False
-        self.setToolchains(stored_toolchains)
-        
-    def _connectSignals(self):
-        self.connect(self.pageContent.toolchainList, SIGNAL("itemSelectionChanged()"), self._selectionChanged)
-        self.connect(self.pageContent.addButton, SIGNAL("clicked()"), self.addToolchain)
-        self.connect(self.pageContent.removeButton, SIGNAL("clicked()"), self.removeToolchain)
-        self.connect(self.pageContent.searchButton, SIGNAL("clicked()"), self.searchToolchain)
-        self.connect(self.pageContent.checkButton, SIGNAL("clicked()"), self.validateAllToolchains)
-    
-    def _validItem(self, index, infos):
-        item = self.pageContent.toolchainList.item(index)
-        new_data = qvariant_converter.getStringDict(self.pageContent.toolchainList.item(index).data(Qt.UserRole))
-        new_data.update(infos)
-        item.setData(Qt.UserRole, qvariant_converter.convertStringDict(new_data))
-        needed = self._projectInfoRetrieve("CPU_INFOS")
-        if "target" in infos.keys() and infos["target"].find(needed["TOOLCHAIN"]) != -1:
-            item.setIcon(QIcon(":/images/ok.png"))
-        else:
-            item.setIcon(QIcon(":/images/warning.png"))
-        if "version" in infos.keys() and "target" in infos.keys():
-            item.setText("GCC " + infos["version"] + " - " + infos["target"])
-    
-    def _invalidItem(self, index):
-        item = self.pageContent.toolchainList.item(index)
-        item.setIcon(QIcon(":/images/error.png"))
-    
+
     def addToolchain(self):
-        sel_toolchain = QFileDialog.getOpenFileName(self, self.tr("Choose the toolchain"), "")
-        if not sel_toolchain.isEmpty():
+        """
+        Slot called when the user adds manually a toolchain.
+        """
+        sel_toolchain = unicode(QFileDialog.getOpenFileName(self, self.tr("Choose the toolchain"), ""))
+        if sel_toolchain != "":
             item = QListWidgetItem(sel_toolchain)
-            item.setData(Qt.UserRole, qvariant_converter.convertString({"path": sel_toolchain}))
+            item.setData(Qt.UserRole, qvariant_converter.convertStringDict({"path": sel_toolchain}))
             self.pageContent.toolchainList.addItem(item)
-            toolchains = self.toolchains()
-            toolchains[sel_toolchain] = False
-            self.setToolchains(toolchains)
-    
+            self._toolchain_manager.addToolchain(sel_toolchain)
+
     def removeToolchain(self):
+        """
+        Slot called when the user removes manually a toolchain.
+        """
         if self.pageContent.toolchainList.currentRow() != -1:
             item = self.pageContent.toolchainList.takeItem(self.pageContent.toolchainList.currentRow())
             toolchain = qvariant_converter.getStringDict(item.data(Qt.UserRole))["path"]
-            toolchains = self.toolchains()
-            del toolchains[toolchain]
-            self.setToolchains(toolchains)
-    
+            self._toolchain_manager.removeToolchain(toolchain)
+
     def searchToolchain(self):
+        """
+        Slot called when the user clicks on the 'search' button. It opens the
+        toolchain search dialog.
+        """
         search = BToolchainSearch.BToolchainSearch()
         self.connect(search, SIGNAL("accepted()"), self._search)
         search.exec_()
-    
+
     def validateAllToolchains(self):
-        QApplication.instance().setOverrideCursor(Qt.WaitCursor)
-        for i in range(self.pageContent.toolchainList.count()):
-            self.validateToolchain(i)
-        QApplication.instance().restoreOverrideCursor()
-    
-    def validateToolchain(self, i):
-        filename = qvariant_converter.getStringDict(self.pageContent.toolchainList.item(i).data(Qt.UserRole))["path"]
-        valid = False
-        info = {}
-        ## Check for the other tools of the toolchain
-        for tool in TOOLCHAIN_ITEMS:
-            if os.path.exists(filename.replace("gcc", tool)):
-                valid = True
-            else:
-                valid = False
-                break
-        ## Try to retrieve the informations about the toolchain only for the valid toolchains
-        if valid:
-            self._validation_process = QProcess()
-            self._validation_process.start(filename, ["-v"])
-            self._validation_process.waitForStarted(1000)
-            if self._validation_process.waitForFinished(200):
-                description = str(self._validation_process.readAllStandardError())
-                info = bertos_utils.getToolchainInfo(description)
-                if len(info.keys()) >= 4:
-                    valid = True
+        """
+        Slot called when the user clicks on the validate button. It starts the
+        toolchain validation procedure for all the toolchains.
+        """
+        try:
+            QApplication.instance().setOverrideCursor(Qt.WaitCursor)
+            for i in range(self.pageContent.toolchainList.count()):
+                data = qvariant_converter.getStringDict(self.pageContent.toolchainList.item(i).data(Qt.UserRole))
+                self.validateToolchain(data["path"])
+            self._populateToolchainList()
+        finally:
+            QApplication.instance().restoreOverrideCursor()
+
+    ####
+
+    def _populateToolchainList(self):
+        """
+        Fills the toolchain list with the toolchains stored in the QSettings.
+        """
+        self.pageContent.toolchainList.clear()
+        self._valid_items = []
+        toolchains = self._toolchain_manager.predefined_toolchains + self._toolchain_manager.toolchains
+        toolchain_dict = {
+            'valid': [],
+            'non-valid': [],
+            'unknown': [],
+            'unverified': [],
+        }
+        for key, value in toolchains:
+            if os.path.exists(key):
+                item_data = {"path":key}
+                if value:
+                    item_data.update(value)
+                if value is not None:
+                    k, data = self.validateToolchain(key)
+                    item_data.update(data)
+                    toolchain_dict[k].append(item_data)
+                else:
+                    toolchain_dict["unverified"].append(item_data)
+        self._processItems(toolchain_dict["valid"], self._validItem)
+        self._processItems(toolchain_dict["non-valid"], self._invalidItem)
+        self._processItems(toolchain_dict["unknown"], self._unknownItem)
+        self._processItems(toolchain_dict["unverified"])
+
+    def _processItems(self, item_list, procedure=lambda x: None):
+        sel_toolchain = self.projectInfo("TOOLCHAIN")
+        for item_data in item_list:
+            item = QListWidgetItem(item_data["path"])
+            item.setData(Qt.UserRole, qvariant_converter.convertStringDict(item_data))
+            self.pageContent.toolchainList.addItem(item)
+            procedure(item)
+            if sel_toolchain and sel_toolchain["path"] == item_data["path"]:
+                self.pageContent.toolchainList.setCurrentItem(item)
+
+    def currentToolchain(self):
+        selected_toolchain = qvariant_converter.getStringDict(self.pageContent.toolchainList.currentItem().data(Qt.UserRole))
+        return selected_toolchain
+
+    def _clearList(self):
+        """
+        Removes all the toolchain from the list.
+        """
+        self.pageContent.toolchainList.clear()
+
+    def _search(self):
+        """
+        Searches for toolchains in the stored directories, and stores them in the
+        QSettings.
+        """
+        dir_list = self.searchDirList()
+        if self.pathSearch():
+            dir_list += [element for element in bertos_utils.getSystemPath()]
+        _toolchain_dict = self._toolchain_manager.storedToolchainDict()
+        toolchain_list = bertos_utils.findToolchains(dir_list)
+        for toolchain in toolchain_list:
+            self._toolchain_manager.addToolchain(toolchain, _toolchain_dict.get(toolchain, False))
+        self._populateToolchainList()
+        self.showMessage(self.tr("Toolchain search result."), self.tr("%1 toolchains found").arg(len(toolchain_list)))
+
+    def _validItem(self, item):
+        """
+        Sets the item at index as a valid item and associates the given info to it.
+        """
+        data = qvariant_converter.getStringDict(item.data(Qt.UserRole))
+        item.setIcon(QIcon(":/images/ok.png"))
+        self._valid_items.append(item)
+        if "version" in data and "target" in data:
+            item.setText("GCC " + data["version"] + " - " + data["target"].strip())
+
+    def _invalidItem(self, item):
+        data = qvariant_converter.getStringDict(item.data(Qt.UserRole))
+        item.setIcon(QIcon(":/images/warning.png"))
+        if "version" in data and "target" in data:
+            item.setText("GCC " + data["version"] + " - " + data["target"].strip())
+
+    def _unknownItem(self, item):
+        """
+        Sets the item at index as an invalid item.
+        """
+        item.setIcon(QIcon(":/images/error.png"))
+
+    def validateToolchain(self, filename):
+        """
+        Toolchain validation procedure.
+        """
+        info = self._toolchain_manager.validateToolchain(filename)
+        if info:
+            needed = self.projectInfo("CPU_INFOS")
+            if "target" in info and info["target"].find(needed["TOOLCHAIN"]) != -1:
+                return 'valid', info
             else:
-                self._validation_process.kill()
-        ## Add the item in the list with the appropriate associate data.
-        if valid:
-            self._validItem(i, info)
+                return 'non-valid', info
         else:
-            self._invalidItem(i)
-        toolchains = self.toolchains()
-        toolchains[filename] = True
-        self.setToolchains(toolchains)
+            return 'unknown', {'path': filename}
     
-    def isComplete(self):
-        if self.pageContent.toolchainList.currentRow() != -1:
-            self._projectInfoStore("TOOLCHAIN", 
-                qvariant_converter.getStringDict(self.pageContent.toolchainList.currentItem().data(Qt.UserRole)))
-            return True
-        else:
-            return False
+    def isDefaultToolchain(self, toolchain):
+        """
+        Returns True if the given toolchain is one of the default toolchains.
+        """
+        return toolchain["path"] in self._toolchain_manager._predefined_toolchain_set
     
-    def reloadData(self):
-        self._clearList()
-        self._updateUi()
-        self._populateToolchainList()
\ No newline at end of file
+    def disableRemoveButton(self):
+        """
+        Disable the remove button.
+        """
+        self.pageContent.removeButton.setEnabled(False)
+    
+    def enableRemoveButton(self):
+        """
+        Enable the remove button.
+        """
+        self.pageContent.removeButton.setEnabled(True)
+        
+    def currentItem(self):
+        return self.pageContent.toolchainList.currentItem()