Refactor to use new protocol module and sipo.
[bertos.git] / wizard / BToolchainPage.py
index 346eb6480051c346ac31e966ff03b6e2a259c64b..041a8069a8c86cb62034ae8d33d9daa4da984d1f 100644 (file)
 #!/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>
 #
 
 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, "toolchain_select.ui")
+        BWizardPage.__init__(self, UI_LOCATION + "/toolchain_select.ui")
         self.setTitle(self.tr("Select toolchain"))
-        self._validationProcess = None
-        self._populateToolchainList()
-        self._connectSignals()
-    
-    def _updateUi(self):
-        if self.pageContent.customDirBox.isChecked():
-            self._enableCustomDir()
+        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:
-            self._disableCustomDir()
-        if self.pageContent.pathBox.isChecked() or (self.pageContent.customDirBox.isChecked() and self.pageContent.customDirList.count() != 0):
-            self.pageContent.doSearchButton.setEnabled(True)
+            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:
-            self.pageContent.doSearchButton.setEnabled(False)
-    
-    def _populateToolchainList(self):
-        toolchains = qvariant_converter.getStringList(self._settingsRetrieve("toolchains"))
-        for element in toolchains:
-            item = QListWidgetItem(element)
-            item.setData(Qt.UserRole, QVariant(element))
-            self.pageContent.toolchainList.addItem(item)
-            
-    def _clearList(self):
-        self.pageContent.toolchainList.clear()
-    
-    def _selectionChanged(self):
-        self.emit(SIGNAL("completeChanged()"))
-    
-    def _search(self):
-        dirList = qvariant_converter.getStringList(self._settingsRetrieve("search_dir_list"))
-        if(qvariant_converter.getBool(self._settingsRetrieve("path_search"))):
-            dirList += [element for element in bertos_utils.getSystemPath()]
-        toolchainList = bertos_utils.findToolchains(dirList)
-        storedToolchainList = qvariant_converter.getStringList(self._settingsRetrieve("toolchains"))
-        toolchainList = set(toolchainList) - set(storedToolchainList)
-        for element in toolchainList:
-            item = QListWidgetItem(element)
-            item.setData(Qt.UserRole, QVariant(element))
-            self.pageContent.toolchainList.addItem(item)
-        self._settingsStore("toolchains", list(toolchainList.union(storedToolchainList)))
-        
-    def _connectSignals(self):
-        self.connect(self.pageContent.toolchainList, SIGNAL("itemSelectionChanged()"), self._selectionChanged)
+            return QWizardPage.nextId(self)
+
+    ####
+
+    ## Overloaded BWizardPage methods. ##
+
+    def setupUi(self):
+        """
+        Sets up the user interface.
+        """
+        self.pageContent.infoLabel.setVisible(False)
+
+    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.validateToolchains)
-    
-    def _validItem(self, index, infos):
-        item = self.pageContent.toolchainList.item(index)
-        needed = self._projectInfoRetrieve("CPU_INFOS")
-        if infos["target"].find(needed["TOOLCHAIN"]) != -1:
-            item.setIcon(QIcon(":/images/ok.png"))
-        else:
-            item.setIcon(QIcon(":/images/warning.png"))
-        item.setText(infos["version"] + " " + infos["target"])
-    
-    def _invalidItem(self, index):
-        item = self.pageContent.toolchainList.item(index)
-        item.setIcon(QIcon(":/images/error.png"))
-    
+        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 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(sel_toolchain))
+            item.setData(Qt.UserRole, qvariant_converter.convertStringDict({"path": sel_toolchain}))
             self.pageContent.toolchainList.addItem(item)
-            toolchains = qvariant_convert.getStringList(self._settingsRetrieve("toolchains"))
-            toolchains = set(toolchains + [sel_toolchain])
-            self._settingsStore("toolchains", list(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.getString(item.data(Qt.UserRole))
-            toolchains = qvariant_converter.getStringList(self._settingsRetrieve("toolchains"))
-            toolchains.remove(toolchain)
-            self._settingsStore("toolchains", toolchains)
-    
+            toolchain = qvariant_converter.getStringDict(item.data(Qt.UserRole))["path"]
+            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 validateToolchains(self):
-        for i in range(self.pageContent.toolchainList.count()):
-            filename = qvariant_converter.getString(self.pageContent.toolchainList.item(i).data(Qt.UserRole))
-            self._validationProcess = QProcess()
-            self._validationProcess.start(filename, ["-v"])
-            self._validationProcess.waitForStarted(1000)
-            if self._validationProcess.waitForFinished(200):
-                description = str(self._validationProcess.readAllStandardError())
-                infos = bertos_utils.getToolchainInfo(description)
-                if len(infos.keys()) == 4:
-                    self._validItem(i, infos)
+
+    def validateAllToolchains(self):
+        """
+        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:
-                    self._invalidItem(i)
+                    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._validationProcess.kill()
-                self._invalidItem(i)
-    
-    def isComplete(self):
-        if self.pageContent.toolchainList.currentRow() != -1:
-            self._projectInfoStore("TOOLCHAIN", 
-                qvariant_converter.getString(self.pageContent.toolchainList.item(self.pageContent.toolchainList.currentRow()).data(Qt.UserRole)))
-            return True
+                return 'non-valid', info
         else:
-            return False
\ No newline at end of file
+            return 'unknown', {'path': filename}
+    
+    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 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()