Merge pull request #6274 from Kartikay26/gsoc-2020-scanElements-refactor

GSoC 2020: scanElements refactoring based on tree model [vtests]
musescore · Aug 11, 2020 · b7007f3 · b7007f3
2 parents 0638509 + a0ecbba
commit b7007f3
Show file tree

Hide file tree

Showing 52 changed files with 431 additions and 408 deletions.
diff --git a/libmscore/ambitus.cpp b/libmscore/ambitus.cpp
@@ -506,15 +506,11 @@ void Ambitus::draw(QPainter* p) const
 //   scanElements
 //---------------------------------------------------------
 
-void Ambitus::scanElements(void* data, void (* func)(void*, Element*), bool /*all*/)
+void Ambitus::scanElements(void* data, void (* func)(void*, Element*), bool all)
 {
+    Q_UNUSED(all);
+    ScoreElement::scanElements(data, func, all);
     func(data, this);
-    if (_topAccid.accidentalType() != AccidentalType::NONE) {
-        func(data, &_topAccid);
-    }
-    if (_bottomAccid.accidentalType() != AccidentalType::NONE) {
-        func(data, &_bottomAccid);
-    }
 }
 
 //---------------------------------------------------------

diff --git a/libmscore/barline.cpp b/libmscore/barline.cpp
@@ -1519,10 +1519,8 @@ void BarLine::scanElements(void* data, void (* func)(void*, Element*), bool all)
     if (width() == 0.0 && !all) {
         return;
     }
+    ScoreElement::scanElements(data, func, all);
     func(data, this);
-    for (Element* e : _el) {
-        e->scanElements(data, func, all);
-    }
 }
 
 //---------------------------------------------------------

diff --git a/libmscore/beam.cpp b/libmscore/beam.cpp
@@ -2708,4 +2708,17 @@ void Beam::startDrag(EditData& editData)
 {
     initBeamEditData(editData);
 }
+
+//---------------------------------------------------------
+//   scanElements
+//---------------------------------------------------------
+
+void Beam::scanElements(void* data, void (* func)(void*, Element*), bool all)
+{
+    ChordRest* cr = toChordRest(treeParent());
+    if (!all && cr->measure()->stemless(cr->staffIdx())) {
+        return;
+    }
+    Element::scanElements(data, func, all);
+}
 }
diff --git a/libmscore/beam.h b/libmscore/beam.h
@@ -86,6 +86,8 @@ class Beam final : public Element
     ScoreElement* treeChild(int idx) const override;
     int treeChildCount() const override;
 
+    void scanElements(void* data, void (* func)(void*, Element*), bool all=true) override;
+
     Beam* clone() const override { return new Beam(*this); }
     ElementType type() const override { return ElementType::BEAM; }
     QPointF pagePos() const override;      ///< position in page coordinates

diff --git a/libmscore/box.cpp b/libmscore/box.cpp
@@ -60,6 +60,18 @@ void Box::layout()
     }
 }
 
+//---------------------------------------------------------
+//   scanElements
+//---------------------------------------------------------
+
+void Box::scanElements(void* data, void (* func)(void*, Element*), bool all)
+{
+    ScoreElement::scanElements(data, func, all);
+    if (all || visible() || score()->showInvisible()) {
+        func(data, this);
+    }
+}
+
 //---------------------------------------------------------
 //   computeMinWidth
 //---------------------------------------------------------

diff --git a/libmscore/box.h b/libmscore/box.h
@@ -45,6 +45,9 @@ class Box : public MeasureBase
 
 public:
     Box(Score*);
+
+    void scanElements(void* data, void (* func)(void*, Element*), bool all=true) override;
+
     virtual void draw(QPainter*) const override;
     virtual bool isEditable() const override { return true; }
 

diff --git a/libmscore/bsymbol.cpp b/libmscore/bsymbol.cpp
@@ -114,18 +114,6 @@ void BSymbol::remove(Element* e)
     }
 }
 
-//---------------------------------------------------------
-//   scanElements
-//---------------------------------------------------------
-
-void BSymbol::scanElements(void* data, void (* func)(void*, Element*), bool all)
-{
-    func(data, this);
-    foreach (Element* e, _leafs) {
-        e->scanElements(data, func, all);
-    }
-}
-
 //---------------------------------------------------------
 //   acceptDrop
 //---------------------------------------------------------

diff --git a/libmscore/bsymbol.h b/libmscore/bsymbol.h
@@ -39,7 +39,6 @@ class BSymbol : public Element
 
     virtual void add(Element*) override;
     virtual void remove(Element*) override;
-    virtual void scanElements(void* data, void (* func)(void*, Element*), bool all=true) override;
     virtual bool acceptDrop(EditData&) const override;
     virtual Element* drop(EditData&) override;
     virtual void layout() override;

diff --git a/libmscore/chord.cpp b/libmscore/chord.cpp
@@ -1229,49 +1229,6 @@ qreal Chord::centerX() const
     return x;
 }
 
-//---------------------------------------------------------
-//   scanElements
-//---------------------------------------------------------
-
-void Chord::scanElements(void* data, void (* func)(void*, Element*), bool all)
-{
-    for (Articulation* a : _articulations) {
-        func(data, a);
-    }
-    if (_hook) {
-        func(data, _hook);
-    }
-    if (_stem) {
-        func(data, _stem);
-    }
-    if (_stemSlash) {
-        func(data, _stemSlash);
-    }
-    if (_arpeggio) {
-        func(data, _arpeggio);
-    }
-    if (_tremolo && (tremoloChordType() != TremoloChordType::TremoloSecondNote)) {
-        func(data, _tremolo);
-    }
-    const Staff* st = staff();
-    if ((st && st->showLedgerLines(tick())) || !st) {       // also for palette
-        for (LedgerLine* ll = _ledgerLines; ll; ll = ll->next()) {
-            func(data, ll);
-        }
-    }
-    size_t n = _notes.size();
-    for (size_t i = 0; i < n; ++i) {
-        _notes.at(i)->scanElements(data, func, all);
-    }
-    for (Chord* chord : _graceNotes) {
-        chord->scanElements(data, func, all);
-    }
-    for (Element* e : el()) {
-        e->scanElements(data, func, all);
-    }
-    ChordRest::scanElements(data, func, all);
-}
-
 //---------------------------------------------------------
 //   processSiblings
 //---------------------------------------------------------

diff --git a/libmscore/chord.h b/libmscore/chord.h
@@ -189,7 +189,6 @@ class Chord final : public ChordRest
     void setNoteType(NoteType t) { _noteType = t; }
     bool isGrace() const { return _noteType != NoteType::NORMAL; }
     void toGraceAfter();
-    void scanElements(void* data, void (* func)(void*, Element*), bool all=true) override;
 
     void setTrack(int val) override;
 

diff --git a/libmscore/chordrest.cpp b/libmscore/chordrest.cpp
@@ -119,29 +119,6 @@ ChordRest::~ChordRest()
     }
 }
 
-//---------------------------------------------------------
-//   scanElements
-//---------------------------------------------------------
-
-void ChordRest::scanElements(void* data, void (* func)(void*, Element*), bool all)
-{
-    if (_beam && (_beam->elements().front() == this)
-        && !measure()->stemless(staffIdx())) {
-        _beam->scanElements(data, func, all);
-    }
-    for (Lyrics* l : _lyrics) {
-        l->scanElements(data, func, all);
-    }
-    DurationElement* de = this;
-    while (de->tuplet() && de->tuplet()->elements().front() == de) {
-        de->tuplet()->scanElements(data, func, all);
-        de = de->tuplet();
-    }
-    if (_tabDur) {
-        func(data, _tabDur);
-    }
-}
-
 //---------------------------------------------------------
 //   writeProperties
 //---------------------------------------------------------

diff --git a/libmscore/chordrest.h b/libmscore/chordrest.h
@@ -89,7 +89,6 @@ class ChordRest : public DurationElement
     virtual void writeProperties(XmlWriter& xml) const;
     virtual bool readProperties(XmlReader&);
     virtual void readAddConnector(ConnectorInfoReader* info, bool pasteMode) override;
-    virtual void scanElements(void* data, void (* func)(void*, Element*), bool all=true) override;
 
     void setBeamMode(Beam::Mode m) { _beamMode = m; }
     void undoSetBeamMode(Beam::Mode m);

diff --git a/libmscore/element.cpp b/libmscore/element.cpp
@@ -228,12 +228,20 @@ void Element::deleteLater()
 
 //---------------------------------------------------------
 //   scanElements
+/// If leaf node, apply `func` on this element (after checking if it is visible).
+/// Otherwise, recurse over all children (see ScoreElement::scanElements).
+/// Note: This function is overridden in some classes to skip certain children,
+/// or to apply `func` even to non-leaf nodes.
 //---------------------------------------------------------
 
 void Element::scanElements(void* data, void (* func)(void*, Element*), bool all)
 {
-    if (all || visible() || score()->showInvisible()) {
-        func(data, this);
+    if (treeChildCount() == 0) {
+        if (all || visible() || score()->showInvisible()) {
+            func(data, this);
+        }
+    } else {
+        ScoreElement::scanElements(data, func, all);
     }
 }
 

diff --git a/libmscore/element.h b/libmscore/element.h
@@ -443,7 +443,7 @@ class Element : public ScoreElement
 
     mutable bool itemDiscovered      { false };       ///< helper flag for bsp
 
-    virtual void scanElements(void* data, void (* func)(void*, Element*), bool all=true);
+    void scanElements(void* data, void (* func)(void*, Element*), bool all=true) override;
 
     virtual void reset() override;           // reset all properties & position to default
 

diff --git a/libmscore/fret.cpp b/libmscore/fret.cpp
@@ -1283,11 +1283,8 @@ Element* FretDiagram::drop(EditData& data)
 void FretDiagram::scanElements(void* data, void (* func)(void*, Element*), bool all)
 {
     Q_UNUSED(all);
+    ScoreElement::scanElements(data, func, all);
     func(data, this);
-    // don't display harmony in palette
-    if (_harmony && !!parent()) {
-        func(data, _harmony);
-    }
 }
 
 //---------------------------------------------------------

diff --git a/libmscore/glissando.cpp b/libmscore/glissando.cpp
@@ -200,21 +200,6 @@ LineSegment* Glissando::createLineSegment()
     return seg;
 }
 
-//---------------------------------------------------------
-//   scanElements
-//---------------------------------------------------------
-
-void Glissando::scanElements(void* data, void (* func)(void*, Element*), bool all)
-{
-    func(data, this);
-    // don't scan segments belonging to systems; the systems themselves will scan them
-    for (SpannerSegment* seg : spannerSegments()) {
-        if (!seg->parent() || !seg->parent()->isSystem()) {
-            seg->scanElements(data, func, all);
-        }
-    }
-}
-
 //---------------------------------------------------------
 //   layout
 //---------------------------------------------------------

diff --git a/libmscore/glissando.h b/libmscore/glissando.h
@@ -74,7 +74,7 @@ class Glissando final : public SLine
     Glissando* clone() const override { return new Glissando(*this); }
     ElementType type() const override { return ElementType::GLISSANDO; }
     LineSegment* createLineSegment() override;
-    void scanElements(void* data, void (* func)(void*, Element*), bool all=true) override;
+
     void layout() override;
     void write(XmlWriter&) const override;
     void read(XmlReader&) override;

diff --git a/libmscore/harmony.cpp b/libmscore/harmony.cpp
@@ -2299,4 +2299,17 @@ Sid Harmony::getPropertyStyle(Pid pid) const
     }
     return TextBase::getPropertyStyle(pid);
 }
+
+//---------------------------------------------------------
+//   scanElements
+//---------------------------------------------------------
+
+void Harmony::scanElements(void* data, void (* func)(void*, Element*), bool all)
+{
+    // don't display harmony in palette
+    if (!parent()) {
+        return;
+    }
+    func(data, this);
+}
 }
diff --git a/libmscore/harmony.h b/libmscore/harmony.h
@@ -136,6 +136,8 @@ class Harmony final : public TextBase
     void setLeftParen(bool leftParen) { _leftParen = leftParen; }
     void setRightParen(bool rightParen) { _rightParen = rightParen; }
 
+    void scanElements(void* data, void (* func)(void*, Element*), bool all=true) override;
+
     Harmony* findNext() const;
     Harmony* findPrev() const;
     Fraction ticksTilNext(bool stopAtMeasureEnd = false) const;

diff --git a/libmscore/iname.cpp b/libmscore/iname.cpp
@@ -151,4 +151,15 @@ QVariant InstrumentName::propertyDefault(Pid id) const
         return TextBase::propertyDefault(id);
     }
 }
+
+//---------------------------------------------------------
+//   scanElements
+//---------------------------------------------------------
+
+void InstrumentName::scanElements(void* data, void (* func)(void*, Element*), bool all)
+{
+    if (all || sysStaff()->show()) {
+        func(data, this);
+    }
+}
 }
diff --git a/libmscore/iname.h b/libmscore/iname.h
@@ -21,6 +21,7 @@ enum class InstrumentNameType : char {
 };
 
 class System;
+class SysStaff;
 
 //---------------------------------------------------------
 //   InstrumentName
@@ -30,6 +31,7 @@ class InstrumentName final : public TextBase
 {
     InstrumentNameType _instrumentNameType;
     int _layoutPos { 0 };
+    SysStaff* _sysStaff { nullptr };
 
 public:
     InstrumentName(Score*);
@@ -47,6 +49,11 @@ class InstrumentName final : public TextBase
 
     System* system() const { return toSystem(parent()); }
 
+    SysStaff* sysStaff() const { return _sysStaff; }
+    void setSysStaff(SysStaff* s) { _sysStaff = s; }
+
+    void scanElements(void* data, void (* func)(void*, Element*), bool all=true) override;
+
     Fraction playTick() const override;
     bool isEditable() const override { return false; }
     QVariant getProperty(Pid propertyId) const override;

diff --git a/libmscore/ledgerline.cpp b/libmscore/ledgerline.cpp
@@ -133,4 +133,17 @@ bool LedgerLine::readProperties(XmlReader& e)
     }
     return true;
 }
+
+//---------------------------------------------------------
+//   scanElements
+//---------------------------------------------------------
+
+void LedgerLine::scanElements(void* data, void (* func)(void*, Element*), bool all)
+{
+    Staff* st = chord()->staff();
+    if (st && !st->showLedgerLines(tick())) {
+        return;
+    }
+    Element::scanElements(data, func, all);
+}
 }
diff --git a/libmscore/ledgerline.h b/libmscore/ledgerline.h
@@ -43,6 +43,8 @@ class LedgerLine final : public Element
     QPointF pagePos() const override;        ///< position in page coordinates
     Chord* chord() const { return toChord(parent()); }
 
+    void scanElements(void* data, void (* func)(void*, Element*), bool all=true) override;
+
     qreal len() const { return _len; }
     qreal lineWidth() const { return _width; }
     void setLen(qreal v) { _len = v; }