Refactor ActiveProject to QML singleton

Author: Withalion

app/activeproject.cpp

@@ -28,26 +28,26 @@
 const QString ActiveProject::LOADING_FLAG_FILE_PATH = QString( "%1/.input_loading_project" ).arg( QStandardPaths::standardLocations( QStandardPaths::TempLocation ).first() );
 const int ActiveProject::LOADING_FLAG_FILE_EXPIRATION_MS = 5000;
 
-ActiveProject::ActiveProject( AppSettings &appSettings
-                              , ActiveLayer &activeLayer
-                              , LocalProjectsManager &localProjectsManager
-                              , QObject *parent ) :
-
-  QObject( parent )
-  , mAppSettings( appSettings )
-  , mActiveLayer( activeLayer )
-  , mLocalProjectsManager( localProjectsManager )
-  , mProjectLoadingLog( "" )
+ActiveProject::ActiveProject( QObject *parent ) : QObject( parent )
 {
   // we used to have our own QgsProject instance, but unfortunately few pieces of qgis_core
   // still work with QgsProject::instance() singleton hardcoded (e.g. vector layer's feature
   // iterator uses it for virtual fields, causing minor bugs with expressions)
   // so for the time being let's just stick to using the singleton until qgis_core is completely fixed
   mQgsProject = QgsProject::instance();
+  mProjectLoadingLog = QLatin1String();
+}
+
+void ActiveProject::setup( AppSettings &appSettings, ActiveLayer &activeLayer,
+                           LocalProjectsManager &localProjectsManager )
+{
+  mAppSettings = &appSettings;
+  mActiveLayer = &activeLayer;
+  mLocalProjectsManager = &localProjectsManager;
 
   // listen to local project removal event to invalidate mProject
-  QObject::connect(
-    &mLocalProjectsManager,
+  connect(
+    mLocalProjectsManager,
     &LocalProjectsManager::aboutToRemoveLocalProject,
     this, [this]( const LocalProject & project )
   {
@@ -58,8 +58,8 @@ ActiveProject::ActiveProject( AppSettings &appSettings
   } );
 
   // listen to metadata changes of opened LocalProject (e.g. local version update or namespace update)
-  QObject::connect(
-    &mLocalProjectsManager,
+  connect(
+    mLocalProjectsManager,
     &LocalProjectsManager::localProjectDataChanged,
     this, [this]( const LocalProject & project )
   {
@@ -70,13 +70,11 @@ ActiveProject::ActiveProject( AppSettings &appSettings
     }
   } );
 
-  setAutosyncEnabled( mAppSettings.autosyncAllowed() );
+  setAutosyncEnabled( mAppSettings->autosyncAllowed() );
 
-  QObject::connect( &mAppSettings, &AppSettings::autosyncAllowedChanged, this, &ActiveProject::setAutosyncEnabled );
+  connect( mAppSettings, &AppSettings::autosyncAllowedChanged, this, &ActiveProject::setAutosyncEnabled );
 }
 
-ActiveProject::~ActiveProject() = default;
-
 QgsProject *ActiveProject::qgsProject() const
 {
   return mQgsProject;
@@ -115,7 +113,7 @@ bool ActiveProject::forceLoad( const QString &filePath, bool force )
   {
     emit projectWillBeReloaded();
 
-    whileBlocking( &mActiveLayer )->resetActiveLayer();
+    whileBlocking( mActiveLayer )->resetActiveLayer();
     mLocalProject = LocalProject();
     mQgsProject->clear();
 
@@ -153,7 +151,7 @@ bool ActiveProject::forceLoad( const QString &filePath, bool force )
   if ( mQgsProject->fileName() != filePath || force )
   {
     emit projectWillBeReloaded();
-    mActiveLayer.resetActiveLayer();
+    mActiveLayer->resetActiveLayer();
 
     res = mQgsProject->read( filePath );
     if ( !res )
@@ -176,7 +174,7 @@ bool ActiveProject::forceLoad( const QString &filePath, bool force )
       return res;
     }
 
-    mLocalProject = mLocalProjectsManager.projectFromProjectFilePath( filePath );
+    mLocalProject = mLocalProjectsManager->projectFromProjectFilePath( filePath );
 
     if ( !mLocalProject.isValid() )
     {
@@ -224,7 +222,7 @@ bool ActiveProject::forceLoad( const QString &filePath, bool force )
     }
   }
 
-  if ( mAppSettings.autosyncAllowed() )
+  if ( mAppSettings->autosyncAllowed() )
   {
     setAutosyncEnabled( true );
     requestSync( SyncOptions::AutomaticRequest );
@@ -475,9 +473,9 @@ void ActiveProject::updateActiveLayer()
     return;
   }
 
-  if ( !visibleLayers.contains( mActiveLayer.layer() ) )
+  if ( !visibleLayers.contains( mActiveLayer->layer() ) )
   {
-    QgsMapLayer *defaultLayer = InputUtils::mapLayerFromName( mAppSettings.defaultLayer(), mQgsProject );
+    QgsMapLayer *defaultLayer = InputUtils::mapLayerFromName( mAppSettings->defaultLayer(), mQgsProject );
 
     if ( !recordingAllowed( defaultLayer ) )
     {
@@ -504,12 +502,12 @@ void ActiveProject::setActiveLayer( QgsMapLayer *layer ) const
 {
   if ( !layer || !layer->isValid() )
   {
-    mActiveLayer.resetActiveLayer();
+    mActiveLayer->resetActiveLayer();
   }
   else
   {
-    mActiveLayer.setActiveLayer( layer );
-    mAppSettings.setDefaultLayer( mActiveLayer.layerName() );
+    mActiveLayer->setActiveLayer( layer );
+    mAppSettings->setDefaultLayer( mActiveLayer->layerName() );
   }
 }
 

app/activeproject.h

@@ -14,14 +14,14 @@
 #include <QObject>
 
 #include "qgsproject.h"
+#include "qgslayertreenode.h"
 
 #include "appsettings.h"
 #include "activelayer.h"
 #include "recordinglayersproxymodel.h"
 #include "localprojectsmanager.h"
 #include "autosynccontroller.h"
 #include "inputmapsettings.h"
-#include "merginprojectmetadata.h"
 #include "synchronizationoptions.h"
 
 /**
@@ -30,6 +30,9 @@
 class ActiveProject: public QObject
 {
     Q_OBJECT
+    QML_ELEMENT
+    QML_SINGLETON
+
     Q_PROPERTY( LocalProject localProject READ localProject NOTIFY localProjectChanged ) // LocalProject instance of active project, changes when project is loaded
     Q_PROPERTY( QgsProject *qgsProject READ qgsProject NOTIFY qgsProjectChanged ) // QgsProject instance of active project, never changes
     Q_PROPERTY( AutosyncController *autosyncController READ autosyncController NOTIFY autosyncControllerChanged )
@@ -42,13 +45,12 @@ class ActiveProject: public QObject
     Q_PROPERTY( bool photoSketchingEnabled READ photoSketchingEnabled NOTIFY photoSketchingEnabledChanged )
 
   public:
-    explicit ActiveProject(
-      AppSettings &appSettings
-      , ActiveLayer &activeLayer
-      , LocalProjectsManager &localProjectsManager
-      , QObject *parent = nullptr );
+    explicit ActiveProject( QObject *parent = nullptr );
+
+    ~ActiveProject() override = default;
 
-    virtual ~ActiveProject();
+    // Initialize values
+    void setup( AppSettings &appSettings, ActiveLayer &activeLayer, LocalProjectsManager &localProjectsManager );
 
     //! Returns active project's QgsProject instance to do QGIS API magic
     QgsProject *qgsProject() const;
@@ -215,9 +217,9 @@ class ActiveProject: public QObject
     QgsProject *mQgsProject = nullptr;
     LocalProject mLocalProject;
 
-    AppSettings &mAppSettings;
-    ActiveLayer &mActiveLayer;
-    LocalProjectsManager &mLocalProjectsManager;
+    AppSettings *mAppSettings = nullptr;
+    ActiveLayer *mActiveLayer = nullptr;
+    LocalProjectsManager *mLocalProjectsManager = nullptr;
     InputMapSettings *mMapSettings = nullptr;
     std::unique_ptr<AutosyncController> mAutosyncController;
 

app/main.cpp

@@ -533,7 +533,9 @@ int main( int argc, char *argv[] )
   NotificationModel notificationModel;
 
   ActiveLayer al;
-  ActiveProject activeProject( *as, al, localProjectsManager );
+  // ActiveProject activeProject( *as, al, localProjectsManager );
+  ActiveProject *activeProject = engine.singletonInstance<ActiveProject *>( "MMInput", "ActiveProject" );
+  activeProject->setup( *as, al, localProjectsManager );
   std::unique_ptr<VariablesManager> vm( new VariablesManager( ma.get() ) );
   vm->registerInputExpressionFunctions();
 
@@ -558,11 +560,11 @@ int main( int argc, char *argv[] )
 
   // the automatic sync request on cold start will fail on MerginApiStatus not being initialized yet, so we call it again
   // after server ping is done
-  if ( activeProject.autosyncController() )
+  if ( activeProject->autosyncController() )
   {
     QObject::connect( ma.get(), &MerginApi::pingMerginFinished, &lambdaContext, [&activeProject]
     {
-      activeProject.requestSync( SyncOptions::AutomaticRequest );
+      activeProject->requestSync( SyncOptions::AutomaticRequest );
     }, Qt::SingleShotConnection );
   }
 
@@ -613,33 +615,33 @@ int main( int argc, char *argv[] )
     notificationModel.addError( message );
   } );
 
-  QObject::connect( &activeProject, &ActiveProject::syncActiveProject, &syncManager, [&syncManager]( const LocalProject & project, const SyncOptions::RequestOrigin requestOrigin )
+  QObject::connect( activeProject, &ActiveProject::syncActiveProject, &syncManager, [&syncManager]( const LocalProject & project, const SyncOptions::RequestOrigin requestOrigin )
   {
     syncManager.syncProject( project, SyncOptions::Authorized, SyncOptions::Retry, requestOrigin );
   } );
 
-  QObject::connect( &activeProject, &ActiveProject::projectReloaded, &lambdaContext, [merginApi = ma.get(), &activeProject]()
+  QObject::connect( activeProject, &ActiveProject::projectReloaded, &lambdaContext, [merginApi = ma.get(), &activeProject]()
   {
-    merginApi->reloadProjectRole( activeProject.projectFullName() );
+    merginApi->reloadProjectRole( activeProject->projectFullName() );
   } );
 
   QObject::connect( ma.get(), &MerginApi::authChanged, &lambdaContext, [merginApi = ma.get(), &activeProject]()
   {
-    if ( activeProject.isProjectLoaded() )
+    if ( activeProject->isProjectLoaded() )
     {
       // if you are logged in or if you just logged out
       if ( merginApi->userAuth()->hasValidToken() || !merginApi->userAuth()->hasAuthData() )
       {
-        merginApi->reloadProjectRole( activeProject.projectFullName() );
+        merginApi->reloadProjectRole( activeProject->projectFullName() );
       }
     }
   } );
 
-  QObject::connect( ma.get(), &MerginApi::projectRoleUpdated, &activeProject, [&activeProject]( const QString & projectFullName, const QString & role )
+  QObject::connect( ma.get(), &MerginApi::projectRoleUpdated, activeProject, [&activeProject]( const QString & projectFullName, const QString & role )
   {
-    if ( projectFullName == activeProject.projectFullName() )
+    if ( projectFullName == activeProject->projectFullName() )
     {
-      activeProject.setProjectRole( role );
+      activeProject->setProjectRole( role );
     }
   } );
 
@@ -659,17 +661,17 @@ int main( int argc, char *argv[] )
   } );
   // Direct connections
   QObject::connect( &app, &QGuiApplication::applicationStateChanged, &pk, &PositionKit::appStateChanged );
-  QObject::connect( &app, &QGuiApplication::applicationStateChanged, &activeProject, &ActiveProject::appStateChanged );
+  QObject::connect( &app, &QGuiApplication::applicationStateChanged, activeProject, &ActiveProject::appStateChanged );
   QObject::connect( &pw, &ProjectWizard::projectCreated, &localProjectsManager, &LocalProjectsManager::addLocalProject );
-  QObject::connect( &activeProject, &ActiveProject::projectReloaded, vm.get(), &VariablesManager::merginProjectChanged );
-  QObject::connect( &activeProject, &ActiveProject::projectWillBeReloaded, &inputProjUtils, &InputProjUtils::resetHandlers );
-  QObject::connect( &syncManager, &SynchronizationManager::syncFinished, &activeProject, [&activeProject]( const QString & projectFullName, bool successfully, int version, bool reloadNeeded )
+  QObject::connect( activeProject, &ActiveProject::projectReloaded, vm.get(), &VariablesManager::merginProjectChanged );
+  QObject::connect( activeProject, &ActiveProject::projectWillBeReloaded, &inputProjUtils, &InputProjUtils::resetHandlers );
+  QObject::connect( &syncManager, &SynchronizationManager::syncFinished, activeProject, [&activeProject]( const QString & projectFullName, bool successfully, int version, bool reloadNeeded )
   {
     Q_UNUSED( successfully );
     Q_UNUSED( version );
-    if ( reloadNeeded && activeProject.projectFullName() == projectFullName )
+    if ( reloadNeeded && activeProject->projectFullName() == projectFullName )
     {
-      activeProject.reloadProject( activeProject.qgsProject()->homePath() );
+      activeProject->reloadProject( activeProject->qgsProject()->homePath() );
     }
   } );
   QObject::connect( QgsApplication::messageLog(),
@@ -725,7 +727,7 @@ int main( int argc, char *argv[] )
   engine.rootContext()->setContextProperty( "__inputUtils", &iu );
   engine.rootContext()->setContextProperty( "__inputProjUtils", &inputProjUtils );
   engine.rootContext()->setContextProperty( "__inputHelp", &help );
-  engine.rootContext()->setContextProperty( "__activeProject", &activeProject );
+  // engine.rootContext()->setContextProperty( "__activeProject", &activeProject );
   engine.rootContext()->setContextProperty( "__syncManager", &syncManager );
   engine.rootContext()->setContextProperty( "__merginApi", ma.get() );
   engine.rootContext()->setContextProperty( "__merginProjectStatusModel", &mpsm );

app/qml/form/MMFormController.qml

@@ -187,7 +187,7 @@ Item {
 
         rememberAttributesController: MM.RememberAttributesController {
           rememberValuesAllowed: AppSettings.reuseLastEnteredValues
-          activeProjectId: __activeProject.localProject.id()
+          activeProjectId: ActiveProject.localProject.id()
         }
         // NOTE: order matters, we want to init variables manager before
         // assigning FeatureLayerPair, as VariablesManager is required

app/qml/form/MMFormPage.qml

@@ -15,6 +15,7 @@ import QtQuick.Dialogs
 
 import mm 1.0 as MM
 import qgs 1.0 as QGS
+import MMInput
 
 import "../components" as MMComponents
 import "./components" as MMFormComponents
@@ -109,7 +110,7 @@ Page {
       if ( root.state === "add" ) return qsTr( "New feature" )
       else if ( root.state === "edit" ) return qsTr( "Edit feature" )
       else if ( root.state === "multiEdit" ) return qsTr( "Edit selected features" )
-      return __inputUtils.featureTitle( root.controller.featureLayerPair, __activeProject.qgsProject )
+      return __inputUtils.featureTitle( root.controller.featureLayerPair, ActiveProject.qgsProject )
     }
 
     rightItemContent: MMComponents.MMRoundButton {
@@ -205,7 +206,7 @@ Page {
 
   footer: MMComponents.MMToolbar {
 
-    visible: !root.layerIsReadOnly && __activeProject.projectRole !== "reader" && root.state !== "multiEdit"
+    visible: !root.layerIsReadOnly && ActiveProject.projectRole !== "reader" && root.state !== "multiEdit"
 
     ObjectModel {
       id: readStateButtons
@@ -235,7 +236,7 @@ Page {
         id: editGeometry
         text: qsTr( "Edit geometry" )
         iconSource: __style.editIcon
-        visible: root.layerIsSpatial && __activeProject.projectRole !== "reader"
+        visible: root.layerIsSpatial && ActiveProject.projectRole !== "reader"
         onClicked: root.editGeometryRequested( root.controller.featureLayerPair )
       }
     }

app/qml/form/MMPreviewDrawer.qml

@@ -14,6 +14,7 @@ import QtQuick.Dialogs
 
 import mm 1.0 as MM
 import qgs 1.0 as QGS
+import MMInput
 
 import "../components" as MMComponents
 import "./components" as MMFormComponents
@@ -279,8 +280,8 @@ Item {
     property bool isHTMLType: root.controller.type === MM.AttributePreviewController.HTML
     property bool isEmptyType: root.controller.type === MM.AttributePreviewController.Empty
 
-    property bool showEditButton: !root.layerIsReadOnly && __activeProject.projectRole !== "reader"
-    property bool showSelectMoreButton: !root.layerIsReadOnly && __activeProject.projectRole !== "reader"
+    property bool showEditButton: !root.layerIsReadOnly && ActiveProject.projectRole !== "reader"
+    property bool showSelectMoreButton: !root.layerIsReadOnly && ActiveProject.projectRole !== "reader"
     property bool showStakeoutButton: __inputUtils.isPointLayerFeature( controller.featureLayerPair )
     property bool showButtons: true
 

app/qml/form/components/MMFeaturesListPageDrawer.qml

@@ -10,6 +10,8 @@
 import QtQuick
 import QtQuick.Controls
 
+import MMInput
+
 import "../../inputs" as MMInputs
 import "../../components" as MMComponents
 
@@ -103,7 +105,7 @@ Drawer {
         }
 
         text: qsTr( "Add feature" )
-        visible: __activeProject.projectRole !== "reader"
+        visible: ActiveProject.projectRole !== "reader"
 
         onClicked: root.buttonClicked()
       }

app/qml/form/editors/MMFormGalleryEditor.qml

@@ -11,6 +11,7 @@ import QtQuick
 import QtQuick.Controls
 
 import mm 1.0 as MM
+import MMInput
 
 import "../../components" as MMComponents
 import "../../components/private" as MMPrivateComponents
@@ -67,7 +68,7 @@ MMPrivateComponents.MMBaseInput {
       }
     }
 
-    header: __activeProject.projectRole !== "reader" ? addFeatureComponent : null
+    header: ActiveProject.projectRole !== "reader" ? addFeatureComponent : null
   }
 
   Component {