Add DspxDocument and update model loading

Author: CrSjimo

src/plugins/coreplugin/CMakeLists.txt

@@ -58,7 +58,7 @@ qm_configure_target(${PROJECT_NAME}
         svscraft::QmlExtras
         # ChorusKit::AppCore
         # JetBrainsDockingSystem
-        # dspxmodel
+        dspxmodel
         opendspx::model
         opendspx::serializer
         ScopicFlowCore

src/plugins/coreplugin/project/DspxDocument.cpp

@@ -0,0 +1,26 @@
+#include "DspxDocument.h"
+#include "DspxDocument_p.h"
+
+#include <dspxmodel/Model.h>
+#include <dspxmodel/BasicModelStrategy.h>
+
+namespace Core {
+
+    DspxDocument::DspxDocument(QObject *parent) : QObject(parent), d_ptr(new DspxDocumentPrivate) {
+        Q_D(DspxDocument);
+        d->q_ptr = this;
+        auto strategy = new dspx::BasicModelStrategy; // TODO use substate in future
+        d->model = new dspx::Model(strategy, this);
+        strategy->setParent(d->model);
+    }
+
+    DspxDocument::~DspxDocument() = default;
+
+    dspx::Model * DspxDocument::model() const {
+        Q_D(const DspxDocument);
+        return d->model;
+    }
+
+}
+
+#include "moc_DspxDocument.cpp"

src/plugins/coreplugin/project/DspxDocument.h

@@ -0,0 +1,32 @@
+#ifndef DIFFSCOPE_COREPLUGIN_DSPXDOCUMENT_H
+#define DIFFSCOPE_COREPLUGIN_DSPXDOCUMENT_H
+
+#include <QObject>
+#include <qqmlintegration.h>
+
+namespace dspx {
+    class Model;
+}
+
+namespace Core {
+
+    class DspxDocumentPrivate;
+
+    class DspxDocument : public QObject {
+        Q_OBJECT
+        QML_ELEMENT
+        Q_DECLARE_PRIVATE(DspxDocument)
+        Q_PROPERTY(dspx::Model *model READ model CONSTANT)
+    public:
+        explicit DspxDocument(QObject *parent = nullptr);
+        ~DspxDocument() override;
+
+        dspx::Model *model() const;
+
+    private:
+        QScopedPointer<DspxDocumentPrivate> d_ptr;
+    };
+
+}
+
+#endif //DIFFSCOPE_COREPLUGIN_DSPXDOCUMENT_H

src/plugins/coreplugin/project/DspxDocument_p.h

@@ -0,0 +1,15 @@
+#ifndef DIFFSCOPE_COREPLUGIN_DSPXDOCUMENT_P_H
+#define DIFFSCOPE_COREPLUGIN_DSPXDOCUMENT_P_H
+
+#include <coreplugin/DspxDocument.h>
+
+namespace Core {
+    class DspxDocumentPrivate {
+        Q_DECLARE_PUBLIC(DspxDocument)
+    public:
+        DspxDocument *q_ptr;
+        dspx::Model *model;
+    };
+}
+
+#endif //DIFFSCOPE_COREPLUGIN_DSPXDOCUMENT_P_H

src/plugins/coreplugin/project/OpenSaveProjectFileScenario.cpp

@@ -1,6 +1,7 @@
 #include "OpenSaveProjectFileScenario.h"
 #include "OpenSaveProjectFileScenario_p.h"
 
+#include <QApplication>
 #include <QFileDialog>
 #include <QQmlComponent>
 #include <QQuickWindow>
@@ -120,4 +121,26 @@ namespace Core {
         SVS::MessageBox::customExec(mb.get());
     }
 
+    bool OpenSaveProjectFileScenario::confirmFileCreatedByAnotherApplication(const QString &name) const {
+        Q_D(const OpenSaveProjectFileScenario);
+        return SVS::MessageBox::question(
+            RuntimeInterface::qmlEngine(),
+            d->window,
+            tr("File Created With Another Application"),
+            QStringLiteral("This project file was created with another application (%1). Some features may not be fully compatible or may behave differently.\n\nDo you want to continue opening it?")
+                .arg(name.isEmpty() ? tr("name unknown") : name)
+        ) == SVS::SVSCraft::Yes;
+    }
+
+    bool OpenSaveProjectFileScenario::confirmFileCreatedByIncompatibleVersion(const QString &version) const {
+        Q_D(const OpenSaveProjectFileScenario);
+        return SVS::MessageBox::question(
+            RuntimeInterface::qmlEngine(),
+            d->window,
+            tr("File Created With Incompatible Version"),
+            QStringLiteral("This project file was created with an newer version or test version of %1 (%2). Some features may not be fully compatible or may behave differently.\n\nDo you want to continue opening it?")
+                .arg(QApplication::applicationDisplayName(), version)
+        ) == SVS::SVSCraft::Yes;
+    }
+
 }

src/plugins/coreplugin/project/OpenSaveProjectFileScenario.h

@@ -28,6 +28,8 @@ namespace Core {
         Q_INVOKABLE void showOpenFailMessageBox(const QString &path, const QString &error) const;
         Q_INVOKABLE void showSaveFailMessageBox(const QString &path, const QString &error) const;
         Q_INVOKABLE void showDeserializationFailMessageBox(const QString &path) const;
+        Q_INVOKABLE bool confirmFileCreatedByAnotherApplication(const QString &name) const;
+        Q_INVOKABLE bool confirmFileCreatedByIncompatibleVersion(const QString &version) const;
 
     Q_SIGNALS:
         void windowChanged();

src/plugins/coreplugin/project/ProjectDocumentContext.cpp

@@ -1,6 +1,8 @@
 #include "ProjectDocumentContext.h"
 #include "ProjectDocumentContext_p.h"
 
+#include <application_config.h>
+
 #include <QDir>
 #include <QLoggingCategory>
 
@@ -10,34 +12,80 @@
 #include <opendspx/model.h>
 #include <opendspxserializer/serializer.h>
 
+#include <SVSCraftCore/Semver.h>
 #include <SVSCraftQuick/MessageBox.h>
 
+#include <dspxmodel/Model.h>
+
 #include <coreplugin/OpenSaveProjectFileScenario.h>
 #include <coreplugin/internal/BehaviorPreference.h>
+#include <coreplugin/DspxDocument.h>
 
 namespace Core {
 
     Q_LOGGING_CATEGORY(lcProjectDocumentContext, "diffscope.core.projectdocumentcontext")
 
+    constexpr char kEditorId[] = "org.diffscope.diffscope";
+
+    static void writeEditorInfo(QDspx::Model &model) {
+        model.content.global.editorId = kEditorId;
+        model.content.global.editorName = QStringLiteral("DiffScope");
+        model.content.workspace["diffscope"].insert("editorVersion", QStringLiteral(APPLICATION_SEMVER));
+    }
+
+    static bool checkIsVersionCompatible(const QString &version) {
+        if (version.isEmpty())
+            return true;
+        SVS::Semver currentSemver(QStringLiteral(APPLICATION_SEMVER));
+        SVS::Semver fileSemver(version);
+        if (fileSemver == currentSemver)
+            return true;
+        if (fileSemver > currentSemver)
+            return false;
+        if (!fileSemver.preRelease().isEmpty() || !fileSemver.build().isEmpty()) {
+            return false;
+        }
+        return true;
+    }
+
     void ProjectDocumentContextPrivate::markSaved() {
         // TODO
     }
 
     QByteArray ProjectDocumentContextPrivate::serializeDocument() const {
-        // TODO
         QDspx::SerializationErrorList errors;
-        return QDspx::Serializer::serialize(model_TODO, errors, QDspx::Serializer::CheckError);
+        auto model = document->model()->toQDspx();
+        writeEditorInfo(model);
+        return QDspx::Serializer::serialize(model, errors, QDspx::Serializer::CheckError);
+    }
+
+    bool ProjectDocumentContextPrivate::initializeDocument(const QDspx::Model &model, bool doCheck) {
+        Q_Q(ProjectDocumentContext);
+        document = new DspxDocument(q);
+        if (doCheck) {
+            if (model.content.global.editorId != kEditorId) {
+                if (!openSaveProjectFileScenario->confirmFileCreatedByAnotherApplication(model.content.global.editorName)) {
+                    return false;
+                }
+            } else if (auto version = model.content.workspace.value("diffscope").value("editorVersion").toString(); !checkIsVersionCompatible(version)) {
+                if (!openSaveProjectFileScenario->confirmFileCreatedByIncompatibleVersion(version)) {
+                    return false;
+                }
+            }
+        }
+        auto postProcessedModel = model;
+        writeEditorInfo(postProcessedModel);
+        document->model()->fromQDspx(postProcessedModel);
+        return true;
     }
 
-    bool ProjectDocumentContextPrivate::deserializeDocument(const QByteArray &data) {
+    bool ProjectDocumentContextPrivate::deserializeAndInitializeDocument(const QByteArray &data) {
         QDspx::SerializationErrorList errors;
         auto model = QDspx::Serializer::deserialize(data, errors);
         if (errors.containsFatal() || errors.containsError()) {
             return false;
         }
-        // TODO
-        model_TODO = model;
-        return true;
+        return initializeDocument(model, true);
     }
 
     ProjectDocumentContext::ProjectDocumentContext(QObject *parent) : QObject(parent), d_ptr(new ProjectDocumentContextPrivate) {
@@ -55,7 +103,7 @@ namespace Core {
 
     DspxDocument *ProjectDocumentContext::document() const {
         Q_D(const ProjectDocumentContext);
-        return nullptr; // TODO
+        return d->document;
     }
 
     OpenSaveProjectFileScenario * ProjectDocumentContext::openSaveProjectFileScenario() const {
@@ -65,16 +113,16 @@ namespace Core {
 
     bool ProjectDocumentContext::openFile(const QString &filePath) {
         Q_D(ProjectDocumentContext);
-        if (false) {
-            return false; // TODO document should not be opened
+        if (d->document) {
+            qCWarning(lcProjectDocumentContext) << "Cannot open file: document already exists.";
+            return false;
         }
         d->fileLocker = new FileLocker(this);
         if (!d->fileLocker->open(filePath)) {
             qCCritical(lcProjectDocumentContext) << "Failed to open file:" << filePath;
             d->openSaveProjectFileScenario->showOpenFailMessageBox(filePath, d->fileLocker->errorString());
             return false;
         }
-        // TODO initialize document
         bool ok;
         auto data = d->fileLocker->readData(&ok);
         if (
@@ -91,7 +139,7 @@ namespace Core {
             d->openSaveProjectFileScenario->showOpenFailMessageBox(filePath, d->fileLocker->errorString());
             return false;
         }
-        if (!d->deserializeDocument(data)) {
+        if (!d->deserializeAndInitializeDocument(data)) {
             qCCritical(lcProjectDocumentContext) << "Failed to deserialize file:" << filePath;
             d->openSaveProjectFileScenario->showDeserializationFailMessageBox(filePath);
             return false;
@@ -101,20 +149,21 @@ namespace Core {
 
     void ProjectDocumentContext::newFile(const QDspx::Model &templateModel, bool isNonFileDocument) {
         Q_D(ProjectDocumentContext);
-        if (false) {
-            return; // TODO document should not be opened
+        if (d->document) {
+            qCWarning(lcProjectDocumentContext) << "Cannot create new file: document already exists.";
+            return;
         }
         if (!isNonFileDocument) {
             d->fileLocker = new FileLocker(this);
         }
-        // TODO initialize document
-        d->model_TODO = templateModel;
+        d->initializeDocument(templateModel, false);
     }
 
     bool ProjectDocumentContext::newFile(const QString &templateFilePath, bool isNonFileDocument) {
         Q_D(ProjectDocumentContext);
-        if (false) {
-            return false; // TODO document should not be opened
+        if (d->document) {
+            qCWarning(lcProjectDocumentContext) << "Cannot create new file: document already exists.";
+            return false;
         }
         if (!isNonFileDocument) {
             d->fileLocker = new FileLocker(this);
@@ -132,7 +181,7 @@ namespace Core {
             d->openSaveProjectFileScenario->showOpenFailMessageBox(templateFilePath, d->fileLocker->errorString());
             return false;
         }
-        if (!d->deserializeDocument(data)) {
+        if (!d->deserializeAndInitializeDocument(data)) {
             qCCritical(lcProjectDocumentContext) << "Failed to deserialize template file:" << templateFilePath;
             d->openSaveProjectFileScenario->showDeserializationFailMessageBox(templateFilePath);
             return false;

src/plugins/coreplugin/project/ProjectDocumentContext.h

@@ -21,6 +21,7 @@ namespace Core {
         Q_OBJECT
         Q_DECLARE_PRIVATE(ProjectDocumentContext)
         Q_PROPERTY(FileLocker *fileLocker READ fileLocker CONSTANT)
+        Q_PROPERTY(DspxDocument *document READ document CONSTANT)
         Q_PROPERTY(OpenSaveProjectFileScenario *openSaveProjectFileScenario READ openSaveProjectFileScenario CONSTANT)
     public:
         explicit ProjectDocumentContext(QObject *parent = nullptr);

src/plugins/coreplugin/project/ProjectDocumentContext_p.h

@@ -13,13 +13,14 @@ namespace Core {
         ProjectDocumentContext *q_ptr;
 
         FileLocker *fileLocker{};
+        DspxDocument *document{};
         OpenSaveProjectFileScenario *openSaveProjectFileScenario;
 
-        QDspx::Model model_TODO; // TODO
-
         void markSaved();
         QByteArray serializeDocument() const;
-        bool deserializeDocument(const QByteArray &data);
+
+        bool deserializeAndInitializeDocument(const QByteArray &data);
+        bool initializeDocument(const QDspx::Model &model, bool doCheck);
     };
 
 }