Move processing algorithm configuration code to gui lib

Author: m-kuhn

python/core/core_auto.sip

@@ -367,7 +367,6 @@
 %Include locator/qgslocator.sip
 %Include locator/qgslocatorfilter.sip
 %Include locator/qgslocatormodel.sip
-%Include processing/qgsprocessingalgorithmconfigurationwidget.sip
 %Include processing/qgsprocessingalgrunnertask.sip
 %Include processing/qgsprocessingfeedback.sip
 %Include processing/qgsprocessingprovider.sip

python/core/processing/qgsprocessingparameters.sip.in

@@ -168,6 +168,7 @@ their acceptable ranges, defaults, etc.
       FlagAdvanced,
       FlagHidden,
       FlagOptional,
+      FlagIsModelOutput,
     };
     typedef QFlags<QgsProcessingParameterDefinition::Flag> Flags;
 

python/core/processing/qgsprocessingregistry.sip.in

@@ -143,30 +143,6 @@ Return a list with all known parameter types.
 .. versionadded:: 3.2
 %End
 
-    void addAlgorithmConfigurationWidgetFactory( QgsProcessingAlgorithmConfigurationWidgetFactory *factory /Transfer/ );
-%Docstring
-Add a new configuration widget factory for customized algorithm configuration
-widgets. Ownership is taken.
-
-.. versionadded:: 3.2
-%End
-
-    void removeAlgorithmConfigurationWidgetFactory( QgsProcessingAlgorithmConfigurationWidgetFactory *factory );
-%Docstring
-Remove a configuration widget factory for customized algorithm configuration
-widgets.
-
-.. versionadded:: 3.2
-%End
-
-    QgsProcessingAlgorithmConfigurationWidget *algorithmConfigurationWidget( QgsProcessingAlgorithm *algorithm ) const;
-%Docstring
- algorithmConfigurationWidget
-@param algorithm
-@return
-%End
-
-
   signals:
 
     void providerAdded( const QString &id );

python/gui/gui_auto.sip

@@ -311,6 +311,8 @@
 %Include layout/qgslayoutviewtooltemporarymousepan.sip
 %Include layout/qgslayoutviewtoolzoom.sip
 %Include locator/qgslocatorwidget.sip
+%Include processing/qgsprocessingalgorithmconfigurationwidget.sip
 %Include processing/qgsprocessingalgorithmdialogbase.sip
 %Include processing/qgsprocessingconfigurationwidgets.sip
+%Include processing/qgsprocessingguiregistry.sip
 %Include qgsadvanceddigitizingcanvasitem.sip

python/core/processing/qgsprocessingalgorithmconfigurationwidget.sip.in renamed to python/gui/processing/qgsprocessingalgorithmconfigurationwidget.sip.in

@@ -11,44 +11,6 @@
 
 
 
-class QgsProcessingConfigurationWidgets
-{
-%Docstring
-This class is responsible for the management of processing widgets which
-QGIS internally.
-
-Standalone applications that require to show configuration widgets for processing
-algorithms will need to execute the following code to have the configuration
-interfaces available.
-
-.. code-block:: python
-
-     # At startup time
-     QgsApplicationProcessingConfigurationWidgets.initialize()
-
-     # At exit time
-     QgsApplicationProcessingConfigurationWidgets.cleanup()
-%End
-
-%TypeHeaderCode
-#include "qgsprocessingconfigurationwidgets.h"
-%End
-  public:
-
-    static void initialize();
-%Docstring
-Initialize native configuration widgets.
-%End
-
-    static void cleanup();
-%Docstring
-Cleanup native configuration widgets.
-%End
-
-  private:
-    QgsProcessingConfigurationWidgets();
-};
-
 
 
 

python/gui/processing/qgsprocessingconfigurationwidgets.sip.in

@@ -0,0 +1,61 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/processing/qgsprocessingguiregistry.h                        *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
+
+class QgsProcessingGuiRegistry
+{
+%Docstring
+The QgsProcessingGuiRegistry is a home for widgets for processing
+configuration widgets.
+
+.. versionadded:: 3.2
+%End
+
+%TypeHeaderCode
+#include "qgsprocessingguiregistry.h"
+%End
+  public:
+    QgsProcessingGuiRegistry();
+    ~QgsProcessingGuiRegistry();
+
+    void addAlgorithmConfigurationWidgetFactory( QgsProcessingAlgorithmConfigurationWidgetFactory *factory /Transfer/ );
+%Docstring
+Add a new configuration widget factory for customized algorithm configuration
+widgets. Ownership is taken.
+
+.. versionadded:: 3.2
+%End
+
+    void removeAlgorithmConfigurationWidgetFactory( QgsProcessingAlgorithmConfigurationWidgetFactory *factory );
+%Docstring
+Remove a configuration widget factory for customized algorithm configuration
+widgets.
+
+.. versionadded:: 3.2
+%End
+
+    QgsProcessingAlgorithmConfigurationWidget *algorithmConfigurationWidget( QgsProcessingAlgorithm *algorithm ) const;
+%Docstring
+ algorithmConfigurationWidget
+@param algorithm
+@return
+%End
+
+};
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/processing/qgsprocessingguiregistry.h                        *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/

python/gui/processing/qgsprocessingguiregistry.sip.in

@@ -62,6 +62,8 @@ Returns the global map layer action registry, used for registering map layer act
 Returns the global layout item GUI registry, used for registering the GUI behavior of layout items.
 %End
 
+    static QgsProcessingGuiRegistry *processingGuiRegistry();
+
     static void enableAutoGeometryRestore( QWidget *widget, const QString &key = QString() );
 %Docstring
 Register the widget to allow its position to be automatically saved and restored when open and closed.

python/gui/qgsgui.sip.in

@@ -53,7 +53,8 @@
                        QgsProcessingOutputDefinition,
                        QgsSettings)
 
-from qgis.gui import (QgsMessageBar,
+from qgis.gui import (QgsGui,
+                      QgsMessageBar,
                       QgsScrollArea,
                       QgsFilterLineEdit,
                       QgsHelp)
@@ -119,7 +120,7 @@ def setupUi(self):
         line.setFrameShape(QFrame.HLine)
         line.setFrameShadow(QFrame.Sunken)
         self.verticalLayout.addWidget(line)
-        self.algorithmItem = QgsApplication.instance().processingRegistry().algorithmConfigurationWidget(self._alg)
+        self.algorithmItem = QgsGui.instance().processingGuiRegistry().algorithmConfigurationWidget(self._alg)
         if self.configuration:
             self.algorithmItem.setConfiguration(self.configuration)
         self.verticalLayout.addWidget(self.algorithmItem)
@@ -332,6 +333,13 @@ def createAlgorithm(self):
                     output.setChildOutputName(dest.name())
                     outputs[name] = output
 
+            if dest.flags() & QgsProcessingParameterDefinition.FlagIsModelOutput:
+                if not name in outputs:
+                    output = QgsProcessingModelOutput(dest.name(), dest.name())
+                    output.setChildId(alg.childId())
+                    output.setChildOutputName(dest.name())
+                    outputs[dest.name()] = output
+
         alg.setModelOutputs(outputs)
 
         selectedOptions = self.dependenciesPanel.selectedoptions

python/plugins/processing/modeler/ModelerParametersDialog.py

@@ -75,7 +75,11 @@ void QgsFilterAlgorithm::initAlgorithm( const QVariantMap &configuration )
     const QVariantMap outputDef = output.toMap();
     const QString name = QStringLiteral( "OUTPUT_%1" ).arg( outputDef.value( QStringLiteral( "name" ) ).toString() );
     QgsProcessingParameterFeatureSink *outputParam = new QgsProcessingParameterFeatureSink( name, outputDef.value( QStringLiteral( "name" ) ).toString() );
-    outputParam->setFlags( QgsProcessingParameterDefinition::FlagHidden );
+    QgsProcessingParameterDefinition::Flags flags = QgsProcessingParameterDefinition::Flags();
+    flags |= QgsProcessingParameterDefinition::FlagHidden;
+    if ( outputDef.value( QStringLiteral( "isModelOutput" ) ).toBool() )
+      flags |= QgsProcessingParameterDefinition::FlagIsModelOutput;
+    outputParam->setFlags( flags );
     addParameter( outputParam );
     mOutputs.append( new Output( name, outputDef.value( QStringLiteral( "expression" ) ).toString() ) );
   }
@@ -92,6 +96,8 @@ QVariantMap QgsFilterAlgorithm::processAlgorithm( const QVariantMap &parameters,
   for ( Output *output : qgis::as_const( mOutputs ) )
   {
     output->sink.reset( parameterAsSink( parameters, output->name, context, output->destinationIdentifier, source->fields(), source->wkbType(), source->sourceCrs() ) );
+    if ( !output->sink )
+      return QVariantMap();
     output->expression.prepare( &expressionContext );
   }
 
@@ -115,7 +121,9 @@ QVariantMap QgsFilterAlgorithm::processAlgorithm( const QVariantMap &parameters,
     for ( Output *output : qgis::as_const( mOutputs ) )
     {
       if ( output->expression.evaluate( &expressionContext ).toBool() )
+      {
         output->sink->addFeature( f, QgsFeatureSink::FastInsert );
+      }
     }
 
     feedback->setProgress( current * step );