Merge pull request #31429 from miiizen/31398-editLyricLines

Make lyric lines selectable and editable

Author: miiizen

src/engraving/dom/factory.cpp

@@ -222,6 +222,7 @@ EngravingItem* Factory::doCreateItem(ElementType type, EngravingItem* parent)
     case ElementType::GUITAR_BEND:       return new GuitarBend(parent->isNote() ? toNote(parent) : dummy->note());
     case ElementType::TREMOLOBAR:        return new TremoloBar(parent);
     case ElementType::LYRICS:            return new Lyrics(parent->isChordRest() ? toChordRest(parent) : dummy->chord());
+    case ElementType::LYRICSLINE:        return new LyricsLine(parent);
     case ElementType::FIGURED_BASS:      return new FiguredBass(parent->isSegment() ? toSegment(parent) : dummy->segment());
     case ElementType::STEM:              return new Stem(parent->isChord() ? toChord(parent) : dummy->chord());
     case ElementType::SLUR:              return new Slur(parent);
@@ -247,7 +248,6 @@ EngravingItem* Factory::doCreateItem(ElementType type, EngravingItem* parent)
     case ElementType::PARTIAL_LYRICSLINE: return new PartialLyricsLine(parent);
     case ElementType::PARENTHESIS:       return new Parenthesis(parent);
 
-    case ElementType::LYRICSLINE:
     case ElementType::TEXTLINE_BASE:
     case ElementType::TEXTLINE_SEGMENT:
     case ElementType::GLISSANDO_SEGMENT:
@@ -446,6 +446,9 @@ MAKE_ITEM_IMPL(LayoutBreak, MeasureBase)
 CREATE_ITEM_IMPL(Lyrics, ElementType::LYRICS, ChordRest, isAccessibleEnabled)
 COPY_ITEM_IMPL(Lyrics)
 
+CREATE_ITEM_IMPL(LyricsLine, ElementType::LYRICSLINE, EngravingItem, isAccessibleEnabled)
+COPY_ITEM_IMPL(LyricsLine)
+
 CREATE_ITEM_IMPL(Measure, ElementType::MEASURE, System, isAccessibleEnabled)
 COPY_ITEM_IMPL(Measure)
 

src/engraving/dom/factory.h

@@ -129,6 +129,9 @@ class Factory
     static Lyrics* createLyrics(ChordRest* parent, bool isAccessibleEnabled = true);
     static Lyrics* copyLyrics(const Lyrics& src);
 
+    static LyricsLine* createLyricsLine(EngravingItem* parent, bool isAccessibleEnabled = true);
+    static LyricsLine* copyLyricsLine(const LyricsLine& src);
+
     static Measure* createMeasure(System* parent, bool isAccessibleEnabled = true);
     static Measure* copyMeasure(const Measure& src);
 

src/engraving/dom/line.cpp

@@ -596,14 +596,6 @@ void LineSegment::rebaseAnchors(EditData& ed, Grip grip)
         return;
     }
 
-    if (isTrillSegment()) {
-        EngravingItem* startElement = spanner()->startElement();
-        if (startElement && startElement->isChord() && toChord(startElement)->staffMove() != 0) {
-            // This trill is on a cross-staff chord. Don't try to rebase its anchors when dragging.
-            return;
-        }
-    }
-
     // don't change anchors on keyboard adjustment or if Ctrl is pressed
     // (Ctrl+Left/Right is handled elsewhere!)
     if (ed.key == Key_Left || ed.key == Key_Right || ed.key == Key_Up || ed.key == Key_Down || ed.modifiers & ControlModifier) {

src/engraving/dom/line.h

@@ -79,6 +79,7 @@ class LineSegment : public SpannerSegment
 
 protected:
     virtual void rebaseOffsetsOnAnchorChanged(Grip grip, const PointF& oldPos, System* sys);
+    virtual void rebaseAnchors(EditData&, Grip);
 
 private:
     void undoMoveStartEndAndSnappedItems(EditData& ed, bool moveStart, bool moveEnd, Segment* s1, Segment* s2);
@@ -90,7 +91,6 @@ class LineSegment : public SpannerSegment
     static PointF deltaRebaseRight(const Segment* oldSeg, const Segment* newSeg);
     static Fraction lastSegmentEndTick(const Segment* lastSeg, const Spanner* s);
     LineSegment* rebaseAnchor(Grip grip, Segment* newSeg);
-    void rebaseAnchors(EditData&, Grip);
 };
 
 //---------------------------------------------------------

src/engraving/dom/lyrics.cpp

@@ -91,7 +91,13 @@ TranslatableString Lyrics::subtypeUserName() const
 
 void Lyrics::add(EngravingItem* el)
 {
-    LOGD("Lyrics::add: unknown element %s", el->typeName());
+    if (el->isLyricsLine()) {
+        LyricsLine* separator = toLyricsLine(el);
+        m_separator = separator;
+        score()->addUnmanagedSpanner(separator);
+    } else {
+        LOGD("Lyrics::add: unknown element %s", el->typeName());
+    }
 }
 
 //---------------------------------------------------------
@@ -107,7 +113,6 @@ void Lyrics::remove(EngravingItem* el)
             // be sure each finds a clean context
             LyricsLine* separ = m_separator;
             m_separator = 0;
-            separ->resetExplicitParent();
             separ->removeUnmanaged();
         }
     } else {

src/engraving/dom/lyrics.h

@@ -104,8 +104,6 @@ class Lyrics final : public TextBase
     bool avoidBarlines() const { return m_avoidBarlines; }
     void setAvoidBarlines(bool v) { m_avoidBarlines = v; }
 
-protected:
-
 private:
 
     friend class Factory;
@@ -140,14 +138,15 @@ class LyricsLine : public SLine
 
     LineSegment* createLineSegment(System* parent) override;
     void removeUnmanaged() override;
-    void styleChanged() override;
 
     virtual Lyrics* lyrics() const { return toLyrics(explicitParent()); }
     Lyrics* nextLyrics() const { return m_nextLyrics; }
     void setNextLyrics(Lyrics* l) { m_nextLyrics = l; }
     virtual bool isEndMelisma() const { return lyrics() && lyrics()->ticks().isNotZero(); }
     bool isDash() const { return !isEndMelisma(); }
     bool setProperty(Pid propertyId, const PropertyValue& v) override;
+    PropertyValue propertyDefault(Pid id) const override;
+    Sid getPropertyStyle(Pid) const override;
 
 protected:
     LyricsLine(const ElementType& type, EngravingItem* parent, ElementFlags = ElementFlag::NOTHING);
@@ -182,10 +181,15 @@ class LyricsLineSegment : public LineSegment
     virtual bool lyricsAddToSkyline() const { return lyrics()->addToSkyline(); }
     virtual double lineSpacing() const { return lyrics()->lineSpacing(); }
     Color color() const override { return lyrics()->color(); }
-    int gripsCount() const override { return 0; }
-    Grip initialEditModeGrip() const override { return Grip::NO_GRIP; }
-    Grip defaultGrip() const override { return Grip::NO_GRIP; }
-    bool needStartEditingAfterSelecting() const override { return false; }
+
+    PropertyValue getProperty(Pid propertyId) const override;
+    bool setProperty(Pid propertyId, const PropertyValue&) override;
+    PropertyValue propertyDefault(Pid propertyId) const override;
+    EngravingObject* propertyDelegate(Pid propertyId) const override;
+
+    bool allowTimeAnchor() const override { return false; }
+
+    virtual bool isEditAllowed(EditData&) const override { return false; }
 
     struct LayoutData : public LineSegment::LayoutData {
     public:
@@ -199,6 +203,7 @@ class LyricsLineSegment : public LineSegment
 
 protected:
     LyricsLineSegment(const ElementType& type, LyricsLine* sp, System* parent, ElementFlags f = ElementFlag::NOTHING);
+    void rebaseAnchors(EditData&, Grip) override;
 };
 
 class PartialLyricsLine final : public LyricsLine

src/engraving/dom/lyricsline.cpp

@@ -40,24 +40,28 @@ namespace mu::engraving {
 //   LyricsLine
 //---------------------------------------------------------
 
+static const ElementStyle lyricsLineElementStyle {
+    { Sid::lyricsDashLineThickness, Pid::LINE_WIDTH }
+};
+
 LyricsLine::LyricsLine(EngravingItem* parent)
-    : SLine(ElementType::LYRICSLINE, parent, ElementFlag::NOT_SELECTABLE)
+    : SLine(ElementType::LYRICSLINE, parent)
 {
-    setGenerated(true);             // no need to save it, as it can be re-generated
     setDiagonal(false);
-    setLineWidth(style().styleS(Sid::lyricsDashLineThickness));
+    initElementStyle(&lyricsLineElementStyle);
     setAnchor(Spanner::Anchor::SEGMENT);
     m_nextLyrics = 0;
+    setGenerated(true);             // no need to save it, as it can be re-generated
 }
 
 LyricsLine::LyricsLine(const ElementType& type, EngravingItem* parent, ElementFlags f)
     : SLine(type, parent, f)
 {
-    setGenerated(true);             // no need to save it, as it can be re-generated
     setDiagonal(false);
-    setLineWidth(style().styleS(Sid::lyricsDashLineThickness));
+    initElementStyle(&lyricsLineElementStyle);
     setAnchor(Spanner::Anchor::SEGMENT);
     m_nextLyrics = 0;
+    setGenerated(true);             // no need to save it, as it can be re-generated
 }
 
 LyricsLine::LyricsLine(const LyricsLine& g)
@@ -66,15 +70,6 @@ LyricsLine::LyricsLine(const LyricsLine& g)
     m_nextLyrics = 0;
 }
 
-//---------------------------------------------------------
-//   styleChanged
-//---------------------------------------------------------
-
-void LyricsLine::styleChanged()
-{
-    setLineWidth(style().styleS(Sid::lyricsDashLineThickness));
-}
-
 //---------------------------------------------------------
 //   createLineSegment
 //---------------------------------------------------------
@@ -128,6 +123,25 @@ bool LyricsLine::setProperty(Pid propertyId, const engraving::PropertyValue& v)
     return true;
 }
 
+PropertyValue LyricsLine::propertyDefault(Pid id) const
+{
+    switch (id) {
+    case Pid::LINE_WIDTH:
+        return styleValue(Pid::LINE_WIDTH, getPropertyStyle(Pid::LINE_WIDTH));
+    default:
+        return SLine::propertyDefault(id);
+    }
+}
+
+Sid LyricsLine::getPropertyStyle(Pid propertyId) const
+{
+    if (propertyId == Pid::LINE_WIDTH) {
+        return isEndMelisma() ? Sid::lyricsLineThickness : Sid::lyricsDashLineThickness;
+    }
+
+    return SLine::getPropertyStyle(propertyId);
+}
+
 void LyricsLine::doComputeEndElement()
 {
     if (!isEndMelisma()) {
@@ -146,8 +160,14 @@ void LyricsLine::doComputeEndElement()
 //   LyricsLineSegment
 //=========================================================
 
+void LyricsLineSegment::rebaseAnchors(EditData&, Grip)
+{
+    // Don't rebase lyric line anchors on drag
+    return;
+}
+
 LyricsLineSegment::LyricsLineSegment(LyricsLine* sp, System* parent)
-    : LineSegment(ElementType::LYRICSLINE_SEGMENT, sp, parent, ElementFlag::ON_STAFF | ElementFlag::NOT_SELECTABLE)
+    : LineSegment(ElementType::LYRICSLINE_SEGMENT, sp, parent, ElementFlag::ON_STAFF)
 {
     setGenerated(true);
 }
@@ -168,6 +188,42 @@ double LyricsLineSegment::baseLineShift() const
     return -style().styleD(Sid::lyricsDashYposRatio) * segLyrics->fontMetrics().xHeight();
 }
 
+PropertyValue LyricsLineSegment::getProperty(Pid propertyId) const
+{
+    if (EngravingObject* delegate = propertyDelegate(propertyId)) {
+        return delegate->getProperty(propertyId);
+    }
+
+    return LineSegment::getProperty(propertyId);
+}
+
+bool LyricsLineSegment::setProperty(Pid propertyId, const PropertyValue& val)
+{
+    if (EngravingObject* delegate = propertyDelegate(propertyId)) {
+        return delegate->setProperty(propertyId, val);
+    }
+
+    return LineSegment::setProperty(propertyId, val);
+}
+
+PropertyValue LyricsLineSegment::propertyDefault(Pid propertyId) const
+{
+    if (EngravingObject* delegate = propertyDelegate(propertyId)) {
+        return delegate->propertyDefault(propertyId);
+    }
+
+    return LineSegment::propertyDefault(propertyId);
+}
+
+EngravingObject* LyricsLineSegment::propertyDelegate(Pid propertyId) const
+{
+    if (propertyId == Pid::GENERATED) {
+        return lyricsLine();
+    }
+
+    return LineSegment::propertyDelegate(propertyId);
+}
+
 //=========================================================
 //   PartialLyricsLine
 //=========================================================
@@ -251,7 +307,6 @@ void PartialLyricsLine::doComputeEndElement()
 
 static const ElementStyle partialLyricsLineSegmentElementStyle {
     { Sid::lyricsPlacement, Pid::PLACEMENT },
-    { Sid::lyricsPosBelow, Pid::OFFSET },
     { Sid::lyricsMinTopDistance, Pid::MIN_DISTANCE },
 };
 

src/engraving/dom/trill.cpp

@@ -121,6 +121,17 @@ void TrillSegment::symbolLine(SymId start, SymId fill, SymId end)
     setbbox(r);
 }
 
+void TrillSegment::rebaseAnchors(EditData& ed, Grip grip)
+{
+    EngravingItem* startElement = spanner()->startElement();
+    if (startElement && startElement->isChord() && toChord(startElement)->staffMove() != 0) {
+        // This trill is on a cross-staff chord. Don't try to rebase its anchors when dragging.
+        return;
+    }
+
+    LineSegment::rebaseAnchors(ed, grip);
+}
+
 //---------------------------------------------------------
 //   scanElements
 //---------------------------------------------------------

src/engraving/dom/trill.h

@@ -58,6 +58,9 @@ class TrillSegment final : public LineSegment
     void symbolLine(SymId start, SymId fill);
     void symbolLine(SymId start, SymId fill, SymId end);
 
+protected:
+    void rebaseAnchors(EditData& ed, Grip grip) override;
+
 private:
     Sid getPropertyStyle(Pid) const override;
 

src/engraving/dom/utils.cpp

@@ -1866,4 +1866,33 @@ std::vector<EngravingItem*> filterTargetElements(const Selection& sel, Engraving
     }
     return result;
 }
+
+Lyrics* searchNextLyrics(Segment* s, staff_idx_t staffIdx, int verse, PlacementV p)
+{
+    Lyrics* l = nullptr;
+    const Segment* originalSeg = s;
+    while ((s = s->next1(SegmentType::ChordRest))) {
+        if (!segmentsAreAdjacentInRepeatStructure(originalSeg, s)) {
+            return nullptr;
+        }
+
+        track_idx_t strack = staffIdx * VOICES;
+        track_idx_t etrack = strack + VOICES;
+        // search through all tracks of current staff looking for a lyric in specified verse
+        for (track_idx_t track = strack; track < etrack; ++track) {
+            ChordRest* cr = toChordRest(s->element(track));
+            if (cr) {
+                // cr with lyrics found, but does it have a syllable in specified verse?
+                l = cr->lyrics(verse, p);
+                if (l) {
+                    break;
+                }
+            }
+        }
+        if (l) {
+            break;
+        }
+    }
+    return l;
+}
 }