Add Score.spanners and Score.spannersOfType() to plugin API

Author: simonchatts

src/engraving/api/v1/score.cpp

@@ -28,6 +28,8 @@
 #include "dom/measure.h"
 #include "dom/score.h"
 #include "dom/segment.h"
+#include "dom/spanner.h"
+#include "dom/spannermap.h"
 #include "dom/text.h"
 #include "editing/editsystemlocks.h"
 #include "types/typesconv.h"
@@ -39,6 +41,84 @@
 
 using namespace mu::engraving::apiv1;
 
+Score::SpannerListContext* Score::acquireSpannerContext(bool hasFilter, mu::engraving::ElementType filterType)
+{
+    for (const auto& ctx : m_spannerListContexts) {
+        if (ctx->hasFilter == hasFilter && ctx->filterType == filterType) {
+            return ctx.get();
+        }
+    }
+
+    auto context = std::make_unique<SpannerListContext>();
+    context->owner = this;
+    context->hasFilter = hasFilter;
+    context->filterType = filterType;
+    m_spannerListContexts.push_back(std::move(context));
+    return m_spannerListContexts.back().get();
+}
+
+qsizetype Score::spannerListCount(QQmlListProperty<Spanner>* list)
+{
+    auto* ctx = static_cast<SpannerListContext*>(list->data);
+    if (!ctx || !ctx->owner) {
+        return 0;
+    }
+
+    mu::engraving::Score* nativeScore = ctx->owner->score();
+    if (!nativeScore) {
+        return 0;
+    }
+
+    const auto& spanMap = nativeScore->spannerMap().map();
+    if (!ctx->hasFilter) {
+        return static_cast<qsizetype>(spanMap.size());
+    }
+
+    qsizetype count = 0;
+    for (const auto& [tick, spanner] : spanMap) {
+        UNUSED(tick);
+        if (spanner && spanner->type() == ctx->filterType) {
+            ++count;
+        }
+    }
+
+    return count;
+}
+
+Spanner* Score::spannerListAt(QQmlListProperty<Spanner>* list, qsizetype index)
+{
+    auto* ctx = static_cast<SpannerListContext*>(list->data);
+    if (!ctx || !ctx->owner || index < 0) {
+        return nullptr;
+    }
+
+    mu::engraving::Score* nativeScore = ctx->owner->score();
+    if (!nativeScore) {
+        return nullptr;
+    }
+
+    const auto& spanMap = nativeScore->spannerMap().map();
+    qsizetype current = 0;
+    for (const auto& [tick, spanner] : spanMap) {
+        UNUSED(tick);
+        if (!spanner) {
+            continue;
+        }
+
+        if (ctx->hasFilter && spanner->type() != ctx->filterType) {
+            continue;
+        }
+
+        if (current == index) {
+            return qobject_cast<Spanner*>(wrap(spanner, Ownership::SCORE));
+        }
+
+        ++current;
+    }
+
+    return nullptr;
+}
+
 Cursor* Score::newCursor()
 {
     return new Cursor(score());
@@ -262,6 +342,37 @@ QQmlListProperty<System> Score::systems()
     return wrapContainerProperty<System>(this, score()->systems());
 }
 
+//---------------------------------------------------------
+//   Score::spanners
+//---------------------------------------------------------
+
+QQmlListProperty<Spanner> Score::spanners()
+{
+    auto* context = acquireSpannerContext(false, mu::engraving::ElementType::INVALID);
+    return QQmlListProperty<Spanner>(this, context, &Score::spannerListCount, &Score::spannerListAt);
+}
+
+//---------------------------------------------------------
+//   Score::spannersOfType
+//---------------------------------------------------------
+
+QQmlListProperty<Spanner> Score::spannersOfType(int elementType)
+{
+    using mu::engraving::ElementType;
+
+    if (elementType == int(ElementType::INVALID)) {
+        return spanners();
+    }
+
+    if (elementType <= int(ElementType::INVALID)
+        || elementType >= int(ElementType::ROOT_ITEM)) {
+        return QQmlListProperty<Spanner>();
+    }
+
+    auto* context = acquireSpannerContext(true, static_cast<ElementType>(elementType));
+    return QQmlListProperty<Spanner>(this, context, &Score::spannerListCount, &Score::spannerListAt);
+}
+
 //---------------------------------------------------------
 //   Score::startCmd
 //---------------------------------------------------------

src/engraving/api/v1/score.h

@@ -30,6 +30,10 @@
 #include "engraving/dom/masterscore.h"
 
 // api
+#include <memory>
+#include <utility>
+#include <vector>
+
 #include "excerpt.h"
 #include "apistructs.h"
 #include "style.h"
@@ -41,6 +45,8 @@ Q_MOC_INCLUDE("engraving/api/v1/selection.h")
 namespace mu::engraving {
 class InstrumentTemplate;
 class Selection;
+class Spanner;
+enum class ElementType : unsigned char;
 }
 
 namespace mu::engraving::apiv1 {
@@ -53,6 +59,7 @@ class System;
 class Selection;
 class Score;
 class Staff;
+class Spanner;
 
 extern Selection* selectionWrap(mu::engraving::Selection* select);
 
@@ -165,6 +172,9 @@ class Score : public apiv1::ScoreElement, public muse::Injectable
     /// List of systems in this score.
     /// \since MuseScore 4.6
     Q_PROPERTY(QQmlListProperty<apiv1::System> systems READ systems)
+    /// List of score-level spanners stored in the SpannerMap.
+    /// \since MuseScore 4.7
+    Q_PROPERTY(QQmlListProperty<apiv1::Spanner> spanners READ spanners)
 
     muse::Inject<mu::context::IGlobalContext> context = { this };
 
@@ -345,12 +355,26 @@ class Score : public apiv1::ScoreElement, public muse::Injectable
     QQmlListProperty<apiv1::Staff> staves();
     QQmlListProperty<apiv1::Page> pages();
     QQmlListProperty<apiv1::System> systems();
+    QQmlListProperty<apiv1::Spanner> spanners();
+    Q_INVOKABLE QQmlListProperty<apiv1::Spanner> spannersOfType(int elementType);
 
     static const mu::engraving::InstrumentTemplate* instrTemplateFromName(const QString& name);   // used by PluginAPI::newScore()
     /// \endcond
 
 private:
     mu::notation::INotationPtr notation() const;
     mu::notation::INotationUndoStackPtr undoStack() const;
+
+    struct SpannerListContext {
+        Score* owner = nullptr;
+        bool hasFilter = false;
+        mu::engraving::ElementType filterType = mu::engraving::ElementType::INVALID;
+    };
+
+    SpannerListContext* acquireSpannerContext(bool hasFilter, mu::engraving::ElementType filterType);
+    static qsizetype spannerListCount(QQmlListProperty<Spanner>* list);
+    static Spanner* spannerListAt(QQmlListProperty<Spanner>* list, qsizetype index);
+
+    std::vector<std::unique_ptr<SpannerListContext>> m_spannerListContexts;
 };
 }