Update dspx processing

Author: CrSjimo

src/plugins/coreplugin/core/CoreInterface.cpp

@@ -38,6 +38,7 @@
 #include <SVSCraftCore/SVSCraftNamespace.h>
 #include <SVSCraftQuick/Theme.h>
 
+#include <coreplugin/DspxCheckerRegistry.h>
 #include <coreplugin/HomeWindowInterface.h>
 #include <coreplugin/internal/BehaviorPreference.h>
 #include <coreplugin/internal/CoreAchievementsModel.h>
@@ -58,11 +59,13 @@ namespace Core {
 
         QQmlEngine *qmlEngine;
         QAK::ActionRegistry *actionRegistry;
+        DspxCheckerRegistry *dspxCheckerRegistry;
 
         void init() {
             Q_Q(CoreInterface);
             qmlEngine = new QQmlEngine(q);
             actionRegistry = new QAK::ActionRegistry(q);
+            dspxCheckerRegistry = new DspxCheckerRegistry(q);
         }
     };
 
@@ -82,6 +85,11 @@ namespace Core {
         return instance()->d_func()->actionRegistry;
     }
 
+    DspxCheckerRegistry * CoreInterface::dspxCheckerRegistry() {
+        Q_ASSERT(instance());
+        return instance()->d_func()->dspxCheckerRegistry;
+    }
+
     int CoreInterface::execSettingsDialog(const QString &id, QWindow *parent) {
         static std::unique_ptr<QWindow> dlg;
 

src/plugins/coreplugin/core/CoreInterface.h

@@ -23,6 +23,7 @@ namespace Core {
     }
 
     class ProjectWindowInterface;
+    class DspxCheckerRegistry;
 
     class CoreInterfacePrivate;
 
@@ -38,6 +39,12 @@ namespace Core {
 
         static QAK::ActionRegistry *actionRegistry();
 
+        static DspxCheckerRegistry *dspxCheckerRegistry();
+
+        static constexpr const char *dspxEditorId() {
+            return "org.diffscope.diffscope";
+        }
+
         Q_INVOKABLE static int execSettingsDialog(const QString &id, QWindow *parent);
         Q_INVOKABLE static void execPluginsDialog(QWindow *parent);
         Q_INVOKABLE static void execAboutAppDialog(QWindow *parent);

src/plugins/coreplugin/project/DspxCheckerRegistry.cpp

@@ -0,0 +1,34 @@
+#include "DspxCheckerRegistry.h"
+#include "DspxCheckerRegistry_p.h"
+
+
+namespace Core {
+
+    DspxCheckerRegistry::DspxCheckerRegistry(QObject *parent) : IDspxChecker(parent), d_ptr(new DspxCheckerRegistryPrivate) {
+        Q_D(DspxCheckerRegistry);
+        d->q_ptr = this;
+    }
+
+    DspxCheckerRegistry::~DspxCheckerRegistry() = default;
+
+    void DspxCheckerRegistry::registerChecker(IDspxChecker *checker) {
+        Q_D(DspxCheckerRegistry);
+        d->checkers.append(checker);
+    }
+
+    QList<IDspxChecker *> DspxCheckerRegistry::checkers() const {
+        Q_D(const DspxCheckerRegistry);
+        return d->checkers;
+    }
+
+    QList<DspxCheckWarning> DspxCheckerRegistry::runCheck(const QDspx::Model &model, Level level, bool failFast) {
+        Q_D(DspxCheckerRegistry);
+        for (auto checker : d->checkers) {
+            auto warnings = checker->runCheck(model, level, failFast);
+            if (failFast && !warnings.isEmpty())
+                return warnings;
+        }
+        return {};
+    }
+
+}

src/plugins/coreplugin/project/DspxCheckerRegistry.h

@@ -0,0 +1,34 @@
+#ifndef DIFFSCOPE_COREPLUGIN_DSPXCHECKERREGISTRY_H
+#define DIFFSCOPE_COREPLUGIN_DSPXCHECKERREGISTRY_H
+
+#include <QObject>
+
+#include <coreplugin/IDspxChecker.h>
+
+namespace QDspx {
+    struct Model;
+}
+
+namespace Core {
+
+    class DspxCheckerRegistryPrivate;
+
+    class DspxCheckerRegistry : public IDspxChecker {
+        Q_OBJECT
+        Q_DECLARE_PRIVATE(DspxCheckerRegistry)
+    public:
+        explicit DspxCheckerRegistry(QObject *parent = nullptr);
+        ~DspxCheckerRegistry() override;
+
+        void registerChecker(IDspxChecker *checker);
+        QList<IDspxChecker *> checkers() const;
+
+        QList<DspxCheckWarning> runCheck(const QDspx::Model &model, Level level, bool failFast) override;
+
+    private:
+        QScopedPointer<DspxCheckerRegistryPrivate> d_ptr;
+    };
+
+}
+
+#endif //DIFFSCOPE_COREPLUGIN_DSPXCHECKERREGISTRY_H

src/plugins/coreplugin/project/DspxCheckerRegistry_p.h

@@ -0,0 +1,15 @@
+#ifndef DIFFSCOPE_COREPLUGIN_DSPXCHECKERREGISTRY_P_H
+#define DIFFSCOPE_COREPLUGIN_DSPXCHECKERREGISTRY_P_H
+
+#include <coreplugin/DspxCheckerRegistry.h>
+
+namespace Core {
+    class DspxCheckerRegistryPrivate {
+        Q_DECLARE_PUBLIC(DspxCheckerRegistry)
+    public:
+        DspxCheckerRegistry *q_ptr;
+        QList<IDspxChecker *> checkers;
+    };
+}
+
+#endif //DIFFSCOPE_COREPLUGIN_DSPXCHECKERREGISTRY_P_H

src/plugins/coreplugin/project/DspxInspectorDialog.cpp

@@ -1,6 +1,8 @@
 #include "DspxInspectorDialog.h"
 #include "DspxInspectorDialog_p.h"
 
+#include <application_config.h>
+
 #include <QApplication>
 #include <QDir>
 #include <QVBoxLayout>
@@ -14,10 +16,29 @@
 #include <opendspx/model.h>
 #include <opendspxserializer/serializer.h>
 
+#include <SVSCraftCore/Semver.h>
+
+#include <coreplugin/CoreInterface.h>
+#include <coreplugin/DspxCheckerRegistry.h>
 #include <coreplugin/OpenSaveProjectFileScenario.h>
 
 namespace Core {
 
+    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;
+    }
+
     DspxInspectorDialog::DspxInspectorDialog(QWidget *parent) : QDialog(parent), d_ptr(new DspxInspectorDialogPrivate) {
         Q_D(DspxInspectorDialog);
         d->q_ptr = this;
@@ -126,7 +147,7 @@ namespace Core {
         if (!f.open(QIODevice::ReadOnly)) {
             addErrorItem(
                 problemModel,
-                tr("Failed to open file"),
+                tr("Fatal: Failed to open file"),
                 {},
                 style()->standardIcon(QStyle::SP_MessageBoxCritical),
                 {
@@ -190,7 +211,7 @@ namespace Core {
                         }
                         addErrorItem(
                             problemModel,
-                            tr("Error: Invalid data type") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
+                            tr("Invalid data type") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
                             e->path(),
                             style()->standardIcon(QStyle::SP_MessageBoxCritical),
                             {
@@ -205,7 +226,7 @@ namespace Core {
                         auto e = error.staticCast<QDspx::InvalidObjectTypeError>();
                         addErrorItem(
                             problemModel,
-                            tr("Error: Invalid object type") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
+                            tr("Invalid object type") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
                             e->path(),
                             style()->standardIcon(QStyle::SP_MessageBoxCritical),
                             {
@@ -220,7 +241,7 @@ namespace Core {
                         auto e = error.staticCast<QDspx::RangeConstraintViolationError>();
                         addErrorItem(
                             problemModel,
-                            tr("Error: Range constraint violation") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
+                            tr("Range constraint violation") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
                             e->path(),
                             style()->standardIcon(QStyle::SP_MessageBoxCritical),
                             {
@@ -241,7 +262,7 @@ namespace Core {
                         info.emplace_back(tr("Actual enum value"), e->actualEnumValue().toString());
                         addErrorItem(
                             problemModel,
-                            tr("Error: Enum constraint violation") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
+                            tr("Enum constraint violation") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
                             e->path(),
                             style()->standardIcon(QStyle::SP_MessageBoxCritical),
                             info,
@@ -257,7 +278,7 @@ namespace Core {
                         }
                         addErrorItem(
                             problemModel,
-                            tr("Error: Missing properties") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
+                            tr("Missing properties") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
                             e->path(),
                             style()->standardIcon(QStyle::SP_MessageBoxCritical),
                             info,
@@ -273,7 +294,7 @@ namespace Core {
                         }
                         addErrorItem(
                             problemModel,
-                            tr("Error: Redundant properties") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
+                            tr("Redundant properties") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
                             e->path(),
                             style()->standardIcon(QStyle::SP_MessageBoxCritical),
                             info,
@@ -289,9 +310,9 @@ namespace Core {
                         }
                         addErrorItem(
                             problemModel,
-                            tr("Warning: Overlapping items") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
+                            tr("Overlapping items") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
                             e->path(),
-                            style()->standardIcon(QStyle::SP_MessageBoxWarning),
+                            {},
                             info,
                             tr("Items at specific indexes in the array at the specific path overlap.")
                         );
@@ -301,9 +322,9 @@ namespace Core {
                         auto e = error.staticCast<QDspx::ZeroLengthRangeError>();
                         addErrorItem(
                             problemModel,
-                            tr("Warning: Zero-length range") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
+                            tr("Zero-length range") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
                             e->path(),
-                            style()->standardIcon(QStyle::SP_MessageBoxWarning),
+                            {},
                             {},
                             tr("The range length of the entity object at the specific path is zero.")
                         );
@@ -313,9 +334,9 @@ namespace Core {
                         auto e = error.staticCast<QDspx::ErroneousClipRangeError>();
                         addErrorItem(
                             problemModel,
-                            tr("Warning: Erroneous clip range") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
+                            tr("Erroneous clip range") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
                             e->path(),
-                            style()->standardIcon(QStyle::SP_MessageBoxWarning),
+                            {},
                             {},
                             tr("The clipping range of the clip entity object at the specific path exceeds its range limit.")
                         );
@@ -325,9 +346,9 @@ namespace Core {
                         auto e = error.staticCast<QDspx::ErroneousClipPositionError>();
                         addErrorItem(
                             problemModel,
-                            tr("Warning: Erroneous clip position") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
+                            tr("Erroneous clip position") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
                             e->path(),
-                            style()->standardIcon(QStyle::SP_MessageBoxWarning),
+                            {},
                             {},
                             tr("The position of the clip entity object at the specific path exceeds the view range limit. It might be not visible in the viewport.")
                         );
@@ -337,7 +358,7 @@ namespace Core {
                         auto e = error.staticCast<QDspx::SafeRangeLimitExceededError>();
                         addErrorItem(
                             problemModel,
-                            tr("Warning: Safe range limit exceeded") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
+                            tr("Safe range limit exceeded") + QStringLiteral(" (0x%1)").arg(QString::number(error->type(), 16), 4, '0'),
                             e->path(),
                             style()->standardIcon(QStyle::SP_MessageBoxWarning),
                             {},
@@ -348,6 +369,43 @@ namespace Core {
                 }
             }
 
+            if (dspxModel.content.global.editorId != CoreInterface::dspxEditorId()) {
+                addErrorItem(
+                    problemModel,
+                    tr("File Created With Another Application"),
+                    QStringLiteral("$.content.global.editorId"),
+                    style()->standardIcon(QStyle::SP_MessageBoxWarning),
+                    {
+                        {tr("Editor ID"), dspxModel.content.global.editorId},
+                        {tr("Editor name"), dspxModel.content.global.editorName},
+                    },
+                    tr("This project file was created with another application. Some features may not be fully compatible or may behave differently.")
+                );
+            } else if (auto version = dspxModel.content.workspace.value("diffscope").value("editorVersion").toString(); !checkIsVersionCompatible(version)) {
+                addErrorItem(
+                    problemModel,
+                    tr("File Created With Incompatible Version"),
+                    QStringLiteral("$.content.workspace.diffscope.editorVersion"),
+                    style()->standardIcon(QStyle::SP_MessageBoxWarning),
+                    {
+                        {tr("Version"), version},
+                    },
+                    tr("This project file was created with an newer version or test version of %1. Some features may not be fully compatible or may behave differently.").arg(QApplication::applicationDisplayName())
+                );
+            }
+
+            auto customCheckResult = CoreInterface::dspxCheckerRegistry()->runCheck(dspxModel, IDspxChecker::Weak, false);
+            for (const auto &warning : customCheckResult) {
+                addErrorItem(
+                    problemModel,
+                    warning.message,
+                    warning.jsonPath,
+                    warning.level == IDspxChecker::Strong ? style()->standardIcon(QStyle::SP_MessageBoxWarning) : QIcon(),
+                    warning.info,
+                    warning.description
+                );
+            }
+
             // TODO show file structure
         }
 

src/plugins/coreplugin/project/IDspxChecker.cpp

@@ -0,0 +1,9 @@
+#include "IDspxChecker.h"
+
+namespace Core {
+
+    IDspxChecker::IDspxChecker(QObject *parent) : QObject(parent) {}
+
+    IDspxChecker::~IDspxChecker() = default;
+
+}

src/plugins/coreplugin/project/IDspxChecker.h

@@ -0,0 +1,39 @@
+#ifndef DIFFSCOPE_COREPLUGIN_IDSPXCHECKER_H
+#define DIFFSCOPE_COREPLUGIN_IDSPXCHECKER_H
+
+#include <QObject>
+#include <QVariant>
+
+namespace QDspx {
+    struct Model;
+}
+
+namespace Core {
+
+    struct DspxCheckWarning;
+
+    class IDspxChecker : public QObject {
+        Q_OBJECT
+    public:
+        explicit IDspxChecker(QObject *parent = nullptr);
+        ~IDspxChecker() override;
+
+        enum Level {
+            Weak,
+            Strong,
+        };
+
+        virtual QList<DspxCheckWarning> runCheck(const QDspx::Model &model, Level level, bool failFast) = 0;
+    };
+
+    struct DspxCheckWarning {
+        IDspxChecker::Level level;
+        QString message;
+        QString jsonPath;
+        QString description;
+        QList<QPair<QString, QVariant>> info;
+    };
+
+}
+
+#endif //DIFFSCOPE_COREPLUGIN_IDSPXCHECKER_H