[ext] added enum support

Author: igorkorsukov

share/extensions/apitests/Main.qml share/extensions/apitests/Form.qmlshare/extensions/apitests/Main.qml renamed to share/extensions/apitests/Form.qml

@@ -1,6 +1,7 @@
 import QtQuick
 
 import MuseApi.Controls
+import MuseApi.Engraving
 
 ExtensionBlank {
 
@@ -11,6 +12,24 @@ ExtensionBlank {
 
     color: api.theme.backgroundPrimaryColor
 
+    Component.onCompleted: {
+        const score = api.engraving.curScore;
+        const measure = score.firstMeasure;
+        console.log("measure.type:", measure.type
+                    , ", api.engraving.Element.MEASURE:", api.engraving.Element.MEASURE
+                    , ", Element:", Element
+                    , ", Element.MEASURE:", Element.MEASURE
+                    , ", IconCode:", IconCode
+                    , ", IconCode.STAR:", IconCode.STAR
+                    )
+
+        if (measure.type === api.engraving.Element.MEASURE) {
+            console.log("this is measure")
+        } else {
+            console.log("this is not measure")
+        }
+    }
+
     StyledFlickable {
         anchors.fill: parent
 

share/extensions/apitests/macros.js

@@ -0,0 +1,15 @@
+
+const Element = api.engraving.Element;
+
+function main()
+{
+    console.log("macros.js")
+
+    const score = api.engraving.curScore;
+    const measure = score.firstMeasure;
+    console.log("measure.type:", measure.type, "Element.Measure:", Element.MEASURE)
+
+    if (measure.type === Element.MEASURE) {
+        console.log("this is measure")
+    }
+}

share/extensions/apitests/manifest.json

@@ -1,9 +1,22 @@
 {
     "uri": "musescore://extensions/dev/apitests",
-    "type": "form",
+    "type": "composite",
     "title": "Api tests",
     "description": "This is a development extension for API tests.",
     "ui_context": "Any",
 
-    "path": "Main.qml"
+    "actions": [
+        {
+            "code": "myform",
+            "type": "form",
+            "title": "Form",
+            "path": "Form.qml"
+        },
+        {
+            "code": "mymacros",
+            "type": "macros",
+            "title": "Macros",
+            "path": "macros.js"
+        }
+    ]
 }

src/engraving/api/v1/engravingapiv1.cpp

@@ -22,8 +22,11 @@
 
 #include "engravingapiv1.h"
 
+#include <QQmlEngine>
 #include <QJSValueIterator>
 
+#include "apitypes.h"
+
 #include "qmlpluginapi.h"
 
 #include "log.h"
@@ -95,3 +98,9 @@ PluginAPI* EngravingApiV1::api() const
 
     return m_api;
 }
+
+QJSValue EngravingApiV1::elementTypeEnum() const
+{
+    static const QJSValue enval = makeEnum<enums::ElementType>(muse::api::EnumType::Int);
+    return enval;
+}

src/engraving/api/v1/engravingapiv1.h

@@ -21,7 +21,10 @@
  */
 #pragma once
 
+#include <QJSValue>
+
 #include "global/api/apiobject.h"
+#include "global/api/apiutils.h"
 
 #include "extensions/api/v1/iapiv1object.h"
 
@@ -44,7 +47,7 @@ class EngravingApiV1 : public muse::api::ApiObject, public muse::extensions::api
 
     Q_PROPERTY(apiv1::Score * curScore READ curScore CONSTANT)
 
-    Q_PROPERTY(apiv1::Enum * Element READ elementTypeEnum CONSTANT)
+    Q_PROPERTY(QJSValue Element READ elementTypeEnum CONSTANT)
     Q_PROPERTY(apiv1::Enum * Accidental READ accidentalTypeEnum CONSTANT)
     Q_PROPERTY(apiv1::Enum * AccidentalBracket READ accidentalBracketEnum CONSTANT)
     Q_PROPERTY(apiv1::Enum * OrnamentStyle READ ornamentStyleEnum CONSTANT)
@@ -167,7 +170,7 @@ class EngravingApiV1 : public muse::api::ApiObject, public muse::extensions::api
 
     apiv1::Score* curScore() const { return api()->curScore(); }
 
-    apiv1::Enum* elementTypeEnum() const { return api()->get_elementTypeEnum(); }
+    QJSValue elementTypeEnum() const;
     apiv1::Enum* accidentalTypeEnum() const { return api()->get_accidentalTypeEnum(); }
     apiv1::Enum* accidentalBracketEnum() const { return api()->get_accidentalBracketEnum(); }
     apiv1::Enum* ornamentStyleEnum() const { return api()->get_ornamentStyleEnum(); }
@@ -330,6 +333,15 @@ class EngravingApiV1 : public muse::api::ApiObject, public muse::extensions::api
     Q_INVOKABLE void quit() { api()->quit(); }
 
 private:
+
+    template<typename T>
+    QJSValue makeEnum(muse::api::EnumType type) const
+    {
+        return muse::api::enumToJsValue(engine(),
+                                        QMetaEnum::fromType<T>(),
+                                        type);
+    }
+
     mutable PluginAPI* m_api = nullptr;
     mutable bool m_selfApi = false;
 };

src/engraving/api/v1/qmlpluginapi.cpp

@@ -231,6 +231,7 @@ void PluginAPI::setup(QQmlEngine* e)
     }
 
     engravingApi->setApi(this);
+    m_engine = engravingApi->engine();
 }
 
 PluginAPI::PluginAPI(QQuickItem* parent)

src/engraving/api/v1/qmlpluginapi.h

@@ -25,6 +25,8 @@
 
 #include "extensions/api/v1/ipluginapiv1.h"
 
+#include "global/api/apiutils.h"
+
 #include "modularity/ioc.h"
 #include "actions/iactionsdispatcher.h"
 #include "context/iglobalcontext.h"
@@ -36,6 +38,8 @@
 #include "cursor.h"
 #include "enums.h"
 
+#include "log.h"
+
 namespace mu::engraving {
 class EngravingItem;
 class Score;
@@ -65,6 +69,14 @@ class Score;
         return cppName; \
     }
 
+#define DECLARE_API_ENUM_JSVAL(qmlName, getterName, enumType) \
+/** Accessed using qmlName.VALUE*/ \
+    Q_PROPERTY(QJSValue qmlName READ getterName CONSTANT) \
+    QJSValue getterName() const { \
+        static const QJSValue enval = makeEnum(qmlName); \
+        return enval; \
+    }
+
 #define DECLARE_API_ENUM2(qmlName, cppName, enumName1, enumName2) \
     /** Accessed using qmlName.VALUE*/ \
     Q_PROPERTY(mu::engraving::apiv1::Enum * qmlName READ get_##cppName CONSTANT) \
@@ -139,7 +151,8 @@ class PluginAPI : public QQuickItem, public muse::extensions::apiv1::IPluginApiV
 public:
     // Should be initialized in qmlpluginapi.cpp
     /// Contains mu::engraving::ElementType enumeration values
-    DECLARE_API_ENUM(Element,          elementTypeEnum,        mu::engraving::apiv1::enums::ElementType)
+    DECLARE_API_ENUM(Element, elementTypeEnum, mu::engraving::apiv1::enums::ElementType)
+    //DECLARE_API_ENUM_JSVAL(Element, elementTypeEnum, mu::engraving::apiv1::enums::ElementType)
     /// Contains mu::engraving::AccidentalType enumeration values
     DECLARE_API_ENUM(Accidental,       accidentalTypeEnum,     mu::engraving::apiv1::enums::AccidentalType)
     /// Contains mu::engraving::AccidentalBracket enumeration values
@@ -591,6 +604,19 @@ class PluginAPI : public QQuickItem, public muse::extensions::apiv1::IPluginApiV
 private:
     mu::engraving::Score* currentScore() const;
 
+    template<typename T>
+    QJSValue makeEnum(const QString& name) const
+    {
+        IF_ASSERT_FAILED(m_engine) {
+            return QJSValue();
+        }
+        return muse::api::enumToJsValue(m_engine,
+                                        QMetaEnum::fromType<T>(),
+                                        muse::api::EnumType::Int,
+                                        name);
+    }
+
+    muse::api::IApiEngine* m_engine = nullptr;
     QString m_pluginType;
     QString m_title;
     QString m_version;

src/engraving/engravingmodule.cpp

@@ -144,6 +144,8 @@ void EngravingModule::registerApi()
     auto api = ioc()->resolve<muse::api::IApiRegister>(moduleName());
     if (api) {
         api->regApiCreator(moduleName(), "api.engraving.v1", new muse::api::ApiCreator<apiv1::EngravingApiV1>());
+
+        api->regEnum<apiv1::enums::ElementType>("MuseApi.Engraving", muse::api::EnumType::Int, "Element");
     }
 #endif
 }

src/framework/autobot/internal/scriptengine.cpp

@@ -210,7 +210,7 @@ void ScriptEngine::dump(const QString& name, const QJSValue& val)
     }
 
     QString str = name + "\n";
-    for (const QString& prop : props) {
+    for (const QString& prop : std::as_const(props)) {
         str += "  " + prop + ": " + val.property(prop).toString() + "\n";
     }
 
@@ -259,3 +259,9 @@ QJSValue ScriptEngine::newArray(size_t length)
 {
     return m_engine->newArray(uint(length));
 }
+
+QJSValue ScriptEngine::freeze(const QJSValue& val)
+{
+    static QJSValue freezeFn = m_engine->evaluate("Object.freeze");
+    return freezeFn.call({ val });
+}

src/framework/autobot/internal/scriptengine.h

@@ -72,6 +72,7 @@ class ScriptEngine : public muse::api::IApiEngine
     QJSValue newQObject(QObject* o) override;
     QJSValue newObject() override;
     QJSValue newArray(size_t length = 0) override;
+    QJSValue freeze(const QJSValue& val) override;
 
     static void dump(const QString& name, const QJSValue& val);