New class QgsScopedProxyProgressTask, which makes it easy

nyalldawson · nyalldawson · commit 2a12c6feeb6c · 2018-08-18T08:42:34.000+10:00
to create proxy progress tasks and have their lifetime
managed automatically.
diff --git a/python/core/auto_generated/qgsproxyprogresstask.sip.in b/python/core/auto_generated/qgsproxyprogresstask.sip.in
@@ -52,6 +52,36 @@ This method is safe to call from the main thread.
 
 };
 
+class QgsScopedProxyProgressTask
+{
+%Docstring
+
+Scoped :py:class:`QgsScopedProxyProgressTask`, which automatically adds the proxy task
+to the application task manager on construction and finalizes the task
+when it goes out of scope.
+
+.. versionadded:: 3.4
+%End
+
+%TypeHeaderCode
+#include "qgsproxyprogresstask.h"
+%End
+  public:
+
+    QgsScopedProxyProgressTask( const QString &description );
+%Docstring
+Constructor for QgsScopedProxyProgressTask, with the specified ``description``.
+%End
+
+    ~QgsScopedProxyProgressTask();
+
+    void setProgress( double progress );
+%Docstring
+Sets the ``progress`` (from 0 to 100) for the proxied operation.
+%End
+
+};
+
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *
diff --git a/src/app/qgisapp.cpp b/src/app/qgisapp.cpp
@@ -1712,8 +1712,7 @@ void QgisApp::handleDropUriList( const QgsMimeDataUtils::UriList &lst )
   // added all layers, and only emit the signal once for the final layer added
   mBlockActiveLayerChanged = true;
 
-  QgsProxyProgressTask *proxyTask = new QgsProxyProgressTask( tr( "Loading layers" ) );
-  QgsApplication::taskManager()->addTask( proxyTask );
+  QgsScopedProxyProgressTask task( tr( "Loading layers" ) );
 
   // insert items in reverse order as each one is inserted on top of previous one
   int count = 0;
@@ -1756,11 +1755,9 @@ void QgisApp::handleDropUriList( const QgsMimeDataUtils::UriList &lst )
       openFile( u.uri, QStringLiteral( "project" ) );
     }
 
-    proxyTask->setProxyProgress( 100.0 * static_cast< double >( count ) / lst.size() );
+    task.setProgress( 100.0 * static_cast< double >( count ) / lst.size() );
   }
 
-  proxyTask->finalize( true );
-
   mBlockActiveLayerChanged = false;
   emit activeLayerChanged( activeLayer() );
 }
diff --git a/src/core/qgsproxyprogresstask.cpp b/src/core/qgsproxyprogresstask.cpp
@@ -41,3 +41,23 @@ void QgsProxyProgressTask::setProxyProgress( double progress )
 {
   QMetaObject::invokeMethod( this, "setProgress", Qt::AutoConnection, Q_ARG( double, progress ) );
 }
+
+//
+// QgsScopedProxyProgressTask
+//
+
+QgsScopedProxyProgressTask::QgsScopedProxyProgressTask( const QString &description )
+  : mTask( new QgsProxyProgressTask( description ) )
+{
+  QgsApplication::taskManager()->addTask( mTask );
+}
+
+QgsScopedProxyProgressTask::~QgsScopedProxyProgressTask()
+{
+  mTask->finalize( true );
+}
+
+void QgsScopedProxyProgressTask::setProgress( double progress )
+{
+  mTask->setProxyProgress( progress );
+}
diff --git a/src/core/qgsproxyprogresstask.h b/src/core/qgsproxyprogresstask.h
@@ -69,4 +69,35 @@ class CORE_EXPORT QgsProxyProgressTask : public QgsTask
 
 };
 
+/**
+ * \ingroup core
+ *
+ * Scoped QgsScopedProxyProgressTask, which automatically adds the proxy task
+ * to the application task manager on construction and finalizes the task
+ * when it goes out of scope.
+ *
+ * \since QGIS 3.4
+ */
+class CORE_EXPORT QgsScopedProxyProgressTask
+{
+  public:
+
+    /**
+     * Constructor for QgsScopedProxyProgressTask, with the specified \a description.
+     */
+    QgsScopedProxyProgressTask( const QString &description );
+
+    ~QgsScopedProxyProgressTask();
+
+    /**
+     * Sets the \a progress (from 0 to 100) for the proxied operation.
+     */
+    void setProgress( double progress );
+
+  private:
+
+    QgsProxyProgressTask *mTask = nullptr;
+
+};
+
 #endif // QGSPROXYPROGRESSTASK_H

Original file line number	Diff line number	Diff line change
`@@ -1712,8 +1712,7 @@ void QgisApp::handleDropUriList( const QgsMimeDataUtils::UriList &lst )`
`1712`	`1712`	`// added all layers, and only emit the signal once for the final layer added`
`1713`	`1713`	`mBlockActiveLayerChanged = true;`
`1714`	`1714`
`1715`		`- QgsProxyProgressTask *proxyTask = new QgsProxyProgressTask( tr( "Loading layers" ) );`
`1716`		`- QgsApplication::taskManager()->addTask( proxyTask );`
	`1715`	`+ QgsScopedProxyProgressTask task( tr( "Loading layers" ) );`
`1717`	`1716`
`1718`	`1717`	`// insert items in reverse order as each one is inserted on top of previous one`
`1719`	`1718`	`int count = 0;`
`@@ -1756,11 +1755,9 @@ void QgisApp::handleDropUriList( const QgsMimeDataUtils::UriList &lst )`
`1756`	`1755`	`openFile( u.uri, QStringLiteral( "project" ) );`
`1757`	`1756`	`}`
`1758`	`1757`
`1759`		`- proxyTask->setProxyProgress( 100.0 * static_cast< double >( count ) / lst.size() );`
	`1758`	`+ task.setProgress( 100.0 * static_cast< double >( count ) / lst.size() );`
`1760`	`1759`	`}`
`1761`	`1760`
`1762`		`- proxyTask->finalize( true );`
`1763`		`-`
`1764`	`1761`	`mBlockActiveLayerChanged = false;`
`1765`	`1762`	`emit activeLayerChanged( activeLayer() );`
`1766`	`1763`	`}`