Merge pull request #3966 from nyalldawson/proc_prov_c

[processing] Port some stuff to c++

doc/CMakeLists.txt

@@ -58,6 +58,7 @@ IF(WITH_APIDOC)
       ${CMAKE_SOURCE_DIR}/src/core/gps
       ${CMAKE_SOURCE_DIR}/src/core/layertree
       ${CMAKE_SOURCE_DIR}/src/core/pal
+      ${CMAKE_SOURCE_DIR}/src/core/processing
       ${CMAKE_SOURCE_DIR}/src/core/raster
       ${CMAKE_SOURCE_DIR}/src/core/symbology-ng
       ${CMAKE_SOURCE_DIR}/src/gui

doc/api_break.dox

@@ -1826,7 +1826,11 @@ optional property map passing down layer level properties to the SLD encoders. I
 - setScaleMethodToSymbol was removed. This is now handled using data defined scaling at a symbol layer level
 - usedAttributes is now a const method and returns QSet<QString> instead of QStringList
 
+Processing        {#qgis_api_break_3_0_Processing}
+----------
 
+- Algorithm providers now subclass the c++ QgsProcessingProvider class, and must be adapted to the API for QgsProcessingProvider. Specifically,
+getName() should be replaced with id(), getDescription() with name(), and getIcon with icon().
 
 
 QGIS 2.4        {#qgis_api_break_2_4}

images/images.qrc

@@ -550,6 +550,14 @@
         <file>themes/default/mTaskRunning.svg</file>
         <file>themes/default/mTaskTerminated.svg</file>
         <file>themes/default/mTaskCancel.svg</file>
+        <file>themes/default/providerGdal.svg</file>
+        <file>themes/default/providerGrass.svg</file>
+        <file>themes/default/providerQgis.svg</file>
+        <file>themes/default/providerR.svg</file>
+        <file>themes/default/providerTaudem.svg</file>
+        <file>themes/default/processingModel.svg</file>
+        <file>themes/default/processingScript.svg</file>
+        <file>themes/default/processingAlgorithm.svg</file>
     </qresource>
     <qresource prefix="/images/tips">
         <file alias="symbol_levels.png">qgis_tips/symbol_levels.png</file>

python/CMakeLists.txt

@@ -106,6 +106,7 @@ INCLUDE_DIRECTORIES(
   ../src/core/geometry
   ../src/core/gps
   ../src/core/layertree
+  ../src/core/processing
   ../src/core/raster
   ../src/core/symbology-ng
 

python/core/core.sip

@@ -259,6 +259,9 @@
 %Include layertree/qgslayertreeregistrybridge.sip
 %Include layertree/qgslayertreeutils.sip
 
+%Include processing/qgsprocessingprovider.sip
+%Include processing/qgsprocessingregistry.sip
+
 %Include raster/qgsbilinearrasterresampler.sip
 %Include raster/qgsbrightnesscontrastfilter.sip
 %Include raster/qgscliptominmaxenhancement.sip

python/core/processing/qgsprocessingprovider.sip

@@ -0,0 +1,56 @@
+/**
+ * \class QgsProcessingProvider
+ * \ingroup core
+ * Abstract base class for processing providers. An algorithm provider is a set of
+ * related algorithms, typically from the same external application or related
+ * to a common area of analysis.
+ * \note added in QGIS 3.0
+ */
+class QgsProcessingProvider
+{
+%TypeHeaderCode
+#include <qgsprocessingprovider.h>
+%End
+
+  public:
+
+    QgsProcessingProvider();
+
+    virtual ~QgsProcessingProvider();
+
+    /**
+     * Returns an icon for the provider.
+     * @see svgIcon()
+     */
+    virtual QIcon icon() const;
+
+    /**
+     * Returns a path to an SVG version of the provider's icon.
+     * @see icon()
+     */
+    virtual QString svgIconPath() const;
+
+    /**
+     * Returns the unique provider id, used for identifying the provider. This string
+     * should be a unique, short, character only string, eg "qgis" or "gdal". This
+     * string should not be localised.
+     * @see name()
+     */
+    virtual QString id() const = 0;
+
+    /**
+     * Returns the full provider name, which is used to describe the provider within the GUI.
+     * This string should be localised.
+     * @see id()
+     */
+    virtual QString name() const = 0;
+
+    virtual bool canBeActivated() const;
+
+  private:
+
+    //! Providers cannot be copied
+    QgsProcessingProvider( const QgsProcessingProvider& other );
+    //! Providers cannot be copied
+    //QgsProcessingProvider& operator=( const QgsProcessingProvider& other );
+};

python/core/processing/qgsprocessingregistry.sip

@@ -0,0 +1,72 @@
+/**
+ * \class QgsProcessingRegistry
+ * \ingroup core
+ * Registry for various processing components, including providers, algorithms
+ * and various parameters and outputs.
+ *
+ * QgsProcessingRegistry is not usually directly created, but rather accessed through
+ * QgsApplication::processingRegistry().
+ * \note added in QGIS 3.0
+ */
+class QgsProcessingRegistry : QObject
+{
+%TypeHeaderCode
+#include <qgsprocessingregistry.h>
+%End
+
+  public:
+
+    /**
+     * Constructor for QgsProcessingRegistry.
+     */
+    QgsProcessingRegistry( QObject* parent /TransferThis/ = nullptr );
+
+    ~QgsProcessingRegistry();
+
+    /**
+     * Get list of available providers.
+     */
+    QList<QgsProcessingProvider*> providers() const;
+
+    /**
+     * Add a processing provider to the registry. Ownership of the provider is transferred to the registry.
+     * Returns false if the provider could not be added (eg if a provider with a duplicate ID already exists
+     * in the registry).
+     * @see removeProvider()
+     */
+    bool addProvider( QgsProcessingProvider* provider /Transfer/ );
+
+    /**
+     * Removes a provider implementation from the registry (the provider object is deleted).
+     * Returns false if the provider could not be removed (eg provider does not exist in the registry).
+     * @see addProvider()
+     */
+    bool removeProvider( QgsProcessingProvider* provider );
+
+    /**
+     * Removes a provider implementation from the registry (the provider object is deleted).
+     * Returns false if the provider could not be removed (eg provider does not exist in the registry).
+     * @see addProvider()
+     */
+    bool removeProvider( const QString& providerId );
+
+    /**
+     * Returns a matching provider by provider ID.
+     */
+    QgsProcessingProvider* providerById( const QString& id );
+
+  signals:
+
+    //! Emitted when a provider has been added to the registry.
+    void providerAdded( const QString& id );
+
+    //! Emitted when a provider is removed from the registry
+    void providerRemoved( const QString& id );
+
+  private:
+
+    //! Registry cannot be copied
+    QgsProcessingRegistry( const QgsProcessingRegistry& other );
+    //! Registry cannot be copied
+    //QgsProcessingRegistry& operator=( const QgsProcessingRegistry& other );
+};

python/core/qgsapplication.sip

@@ -442,6 +442,13 @@ static void qtgui_UpdatePyArgv(PyObject *argvlist, int argc, char **argv)
      */
     static QgsMessageLog* messageLog();
 
+    /**
+     * Returns the application's processing registry, used for managing processing providers,
+     * algorithms, and various parameters and outputs.
+     * @note added in QGIS 3.0
+     */
+    static QgsProcessingRegistry* processingRegistry();
+
 %If(ANDROID)
     //dummy method to workaround sip generation issue issue
     bool x11EventFilter ( XEvent * event );

python/plugins/processing/ProcessingPlugin.py

@@ -72,13 +72,13 @@ def initGui(self):
         self.toolboxAction = self.toolbox.toggleViewAction()
         self.toolboxAction.setObjectName('toolboxAction')
         self.toolboxAction.setIcon(
-            QIcon(os.path.join(cmd_folder, 'images', 'alg.svg')))
+            QgsApplication.getThemeIcon("/processingAlgorithm.svg"))
         self.toolboxAction.setText(self.tr('&Toolbox'))
         self.iface.registerMainWindowAction(self.toolboxAction, 'Ctrl+Alt+T')
         self.menu.addAction(self.toolboxAction)
 
         self.modelerAction = QAction(
-            QIcon(os.path.join(cmd_folder, 'images', 'model.svg')),
+            QgsApplication.getThemeIcon("/processingModel.svg"),
             self.tr('Graphical &Modeler...'), self.iface.mainWindow())
         self.modelerAction.setObjectName('modelerAction')
         self.modelerAction.triggered.connect(self.openModeler)

python/plugins/processing/algs/exampleprovider/ExampleAlgorithmProvider.py

@@ -35,7 +35,7 @@ class ExampleAlgorithmProvider(AlgorithmProvider):
     MY_DUMMY_SETTING = 'MY_DUMMY_SETTING'
 
     def __init__(self):
-        AlgorithmProvider.__init__(self)
+        super().__init__()
 
         # Deactivate provider by default
         self.activate = False
@@ -66,23 +66,23 @@ def unload(self):
         ProcessingConfig.removeSetting(
             ExampleAlgorithmProvider.MY_DUMMY_SETTING)
 
-    def getName(self):
+    def id(self):
         """This is the name that will appear on the toolbox group.
 
         It is also used to create the command line name of all the
         algorithms from this provider.
         """
         return 'Example provider'
 
-    def getDescription(self):
+    def name(self):
         """This is the provired full name.
         """
         return 'Example algorithms'
 
-    def getIcon(self):
+    def icon(self):
         """We return the default icon.
         """
-        return AlgorithmProvider.getIcon(self)
+        return AlgorithmProvider.icon(self)
 
     def _loadAlgorithms(self):
         """Here we fill the list of algorithms in self.algs.

python/plugins/processing/algs/gdal/GdalAlgorithm.py

@@ -31,6 +31,8 @@
 from qgis.PyQt.QtGui import QIcon
 from qgis.PyQt.QtCore import QUrl
 
+from qgis.core import QgsApplication
+
 from processing.core.GeoAlgorithm import GeoAlgorithm
 from processing.algs.gdal.GdalAlgorithmDialog import GdalAlgorithmDialog
 from processing.algs.gdal.GdalUtils import GdalUtils
@@ -48,7 +50,7 @@ def __init__(self):
 
     def getIcon(self):
         if self._icon is None:
-            self._icon = QIcon(os.path.join(pluginPath, 'images', 'gdal.svg'))
+            self._icon = QgsApplication.getThemeIcon("/providerGdal.svg")
         return self._icon
 
     def getCustomParametersDialog(self):