Merge pull request #23783 from mike-spa/ensureGapRestConsistency

Ensure gap rest consistency  - and several other fixes and improvements for situations with complext track mappings

src/engraving/dom/check.cpp

@@ -272,19 +272,6 @@ void Measure::fillGap(const Fraction& pos, const Fraction& len, track_idx_t trac
          stretch.numerator(), stretch.denominator(),
          track);
 
-    if (useGapRests) {
-        // fill this gap with a single gap rest, where the duration does not need to correspond to a valid DurationType
-        TDuration d;
-        d.setVal(len.ticks());
-        Rest* rest = Factory::createRest(score()->dummy()->segment());
-        rest->setTicks(len);
-        rest->setDurationType(d);
-        rest->setTrack(track);
-        rest->setGap(useGapRests);
-        score()->undoAddCR(rest, this, (pos / stretch) + tick());
-        return;
-    }
-
     // break the gap into shorter durations if necessary
     std::vector<TDuration> durationList = toRhythmicDurationList(len, true, pos, score()->sigmap()->timesig(tick()).nominal(), this, 0);
 

src/engraving/dom/property.cpp

@@ -269,7 +269,7 @@ static constexpr PropertyMetaData propertyList[] = {
     { Pid::HARMONY_DURATION,        true,  "harmonyDuration",       P_TYPE::INT,                PropertyGroup::APPEARANCE,      DUMMY_QT_TR_NOOP("propertyName", "harmony duration") },
 
     { Pid::SYSTEM_BRACKET,          false, "type",                  P_TYPE::INT,                PropertyGroup::APPEARANCE,      DUMMY_QT_TR_NOOP("propertyName", "type") },
-    { Pid::GAP,                     false, 0,                       P_TYPE::BOOL,               PropertyGroup::APPEARANCE,      DUMMY_QT_TR_NOOP("propertyName", "gap") },
+    { Pid::GAP,                     false, 0,                       P_TYPE::BOOL,               PropertyGroup::NONE,      DUMMY_QT_TR_NOOP("propertyName", "gap") },
     { Pid::AUTOPLACE,               false, "autoplace",             P_TYPE::BOOL,               PropertyGroup::POSITION,        DUMMY_QT_TR_NOOP("propertyName", "autoplace") },
     { Pid::DASH_LINE_LEN,           false, "dashLineLength",        P_TYPE::REAL,               PropertyGroup::APPEARANCE,      DUMMY_QT_TR_NOOP("propertyName", "dash line length") },
     { Pid::DASH_GAP_LEN,            false, "dashGapLength",         P_TYPE::REAL,               PropertyGroup::APPEARANCE,      DUMMY_QT_TR_NOOP("propertyName", "dash gap length") },

src/engraving/dom/staff.cpp

@@ -125,69 +125,97 @@ Staff* Staff::findLinkedInScore(const Score* score) const
     return nullptr;
 }
 
-std::vector<track_idx_t> Staff::getLinkedTracksInStaff(const Staff* linkedStaff, const track_idx_t originalTrack) const
+track_idx_t Staff::getLinkedTrackInStaff(const Staff* linkedStaff, const track_idx_t originalTrack) const
 {
-    // For linked staves the length of staffList is always > 1 since the list contains the staff itself too!
-    const bool linked = staffList().size() > 1;
+    IF_ASSERT_FAILED(linkedStaff && originalTrack != muse::nidx) {
+        return muse::nidx;
+    }
 
-    staff_idx_t staffIdx = linkedStaff->idx();
+    Score* thisScore = score();
+    Score* linkedStaffScore = linkedStaff->score();
+    staff_idx_t linkedStaffIdx = linkedStaff->idx();
 
-    std::vector<track_idx_t> linkedTracks;
-    if (!linkedStaff->score()->excerpt()) {
-        // On masterScore.
-        track_idx_t track = staffIdx * VOICES + (originalTrack % VOICES);
-        linkedTracks.push_back(track);
-    } else {
-        const TracksMap& mapping = linkedStaff->score()->excerpt()->tracksMapping();
-        if (mapping.empty()) {
-            // This can happen during reading the score and there is
-            // no Tracklist tag specified.
-            // TODO solve this in read302.cpp.
-            linkedTracks.push_back(originalTrack);
-        } else {
-            std::vector<track_idx_t> mappedTracks = muse::values(mapping, originalTrack);
-            if (mappedTracks.empty()) {
-                // This is a linked staff in a part and the element has been added to a linked staff in the main score
-                track_idx_t track = staffIdx * VOICES + (originalTrack % VOICES);
-                track_idx_t mappedTrack = muse::value(mapping, track, muse::nidx);
-                mappedTrack = (mappedTrack != muse::nidx) ? mappedTrack : track;
-                if (linkedStaff->isVoiceVisible(originalTrack % VOICES)) {
-                    mappedTracks.push_back(mappedTrack);
-                }
+    if (thisScore == linkedStaffScore) {
+        // For staves linked within the same score, voices are always mapped 1 to 1
+        voice_idx_t voice = track2voice(originalTrack);
+        return staff2track(linkedStaffIdx, voice);
+    }
+
+    // NOTE 1: if linkedStaff has a different id than *this, it means that there isn't direct voice mapping between
+    // the two. Example: if we have guitar+TAB in the score, with corresponding guitar+TAB in the part, *this
+    // may be the notation-staff of the score and linkedStaff may be the TAB-staff of the part. In that case, the
+    // correct voice mapping must be obtained by looking for the staff with same id in thisScore.
+
+    track_idx_t refTrack = originalTrack;
+    if (linkedStaff->id() != id()) {
+        Staff* correspondingStaffInThisScore = linkedStaff->findLinkedInScore(thisScore);
+        if (!correspondingStaffInThisScore) {
+            return muse::nidx;
+        }
+        voice_idx_t originalVoice = track2voice(originalTrack);
+        refTrack = staff2track(correspondingStaffInThisScore->idx(), originalVoice);
+    }
+
+    // NOTE 2: TracksMap is a map from a track in the *score* to track(s) in the *part*.
+    // If we are in the master score, refTrack corresponds to one of the keys in the map, so we can retrieve
+    // the linked tracks by simply querying the map by key. However, if we are in a part, we need to search for
+    // refTrack among the *values* of the map, and the corresponding key gives us the linked track in the score.
+    // If linkedStaff is *also* in a part, we need to do it in two steps: first find the linked track in the score,
+    // then use it to find the linked track in linkeStaff's part.
+
+    if (thisScore->isMaster()) {
+        const TracksMap& tracksMap = linkedStaffScore->excerpt()->tracksMapping();
+        std::vector<track_idx_t> linkedTracks = muse::values(tracksMap, refTrack);
+        for (track_idx_t track : linkedTracks) {
+            if (track2staff(track) == linkedStaffIdx) {
+                return track;
             }
-            for (track_idx_t track : mappedTracks) {
-                const bool isLinkedWithinSameScore  = linked && (linkedStaff != this) && (linkedStaff->score() == this->score());
-                const bool isLinkedToDifferentScore = linked && (linkedStaff != this) && (linkedStaff->score() != this->score());
-                if (isLinkedWithinSameScore && !isLinkedToDifferentScore) {
-                    track_idx_t mappedTrack = muse::value(mapping, track, muse::nidx);
-                    if (mappedTrack == muse::nidx) {
-                        continue;
-                    }
-                    track_idx_t linkedTrack = staffIdx * VOICES + mappedTrack % VOICES;
-                    if (!linkedStaff->isVoiceVisible(originalTrack % VOICES)) {
-                        continue;
-                    }
-                    linkedTracks.push_back(linkedTrack);
-                } else if (!isLinkedWithinSameScore && isLinkedToDifferentScore) {
-                    // Staff in linked score
-                    const staff_idx_t trackStaff = track2staff(track);
-                    if (trackStaff != staffIdx) {
-                        // Element on linked staff in linked part
-                        track += (staffIdx - trackStaff) * VOICES;
-                        if (!linkedStaff->isVoiceVisible(originalTrack % VOICES)) {
-                            continue;
-                        }
-                    }
-                    linkedTracks.push_back(track);
-                } else {
-                    // Staff in part edit was performed on
-                    linkedTracks.push_back(track);
-                }
+        }
+
+        return muse::nidx;
+    }
+
+    const TracksMap& thisTracksMap = thisScore->excerpt()->tracksMapping();
+    track_idx_t linkedTrackInScore = muse::nidx;
+    for (auto pair : thisTracksMap) {
+        track_idx_t trackInScore = pair.first;
+        std::vector<track_idx_t> tracksInPart = muse::values(thisTracksMap, trackInScore);
+        for (track_idx_t trackInPart : tracksInPart) {
+            if (trackInPart == refTrack) {
+                linkedTrackInScore = trackInScore;
+                break;
             }
         }
+        if (linkedTrackInScore != muse::nidx) {
+            break;
+        }
+    }
+
+    if (linkedStaffScore->isMaster() || linkedTrackInScore == muse::nidx) {
+        return linkedTrackInScore;
+    }
+
+    const TracksMap& linkedTracksMap = linkedStaffScore->excerpt()->tracksMapping();
+    std::vector<track_idx_t> linkedTracks = muse::values(linkedTracksMap, linkedTrackInScore);
+    for (track_idx_t track : linkedTracks) {
+        if (track2staff(track) == linkedStaffIdx) {
+            return track;
+        }
+    }
+
+    return muse::nidx;
+}
+
+bool Staff::trackHasLinksInVoiceZero(track_idx_t track)
+{
+    for (Staff* linkedStaff : staffList()) {
+        track_idx_t linkedTrack = getLinkedTrackInStaff(linkedStaff, track);
+        if (linkedTrack != muse::nidx && track2voice(linkedTrack) == 0) {
+            return true;
+        }
     }
 
-    return linkedTracks;
+    return false;
 }
 
 //---------------------------------------------------------

src/engraving/dom/staff.h

@@ -261,7 +261,8 @@ class Staff final : public EngravingItem
 
     Staff* findLinkedInScore(const Score* score) const override;
 
-    std::vector<track_idx_t> getLinkedTracksInStaff(const Staff* linkedStaff, const track_idx_t strack) const;
+    track_idx_t getLinkedTrackInStaff(const Staff* linkedStaff, const track_idx_t strack) const;
+    bool trackHasLinksInVoiceZero(track_idx_t track);
 
 private:
 

src/engraving/tests/exchangevoices_data/undoChangeVoice02-ref.mscx

@@ -211,6 +211,9 @@
               <tpc>15</tpc>
               </Note>
             </Chord>
+          <location>
+            <fractions>1/4</fractions>
+            </location>
           </voice>
         </Measure>
       <Measure>
@@ -769,6 +772,9 @@
                 <tpc>15</tpc>
                 </Note>
               </Chord>
+            <location>
+              <fractions>1/4</fractions>
+              </location>
             </voice>
           </Measure>
         <Measure>

src/engraving/tests/implode_explode_data/implodeScore.mscx

@@ -678,6 +678,9 @@
               <tpc>14</tpc>
               </Note>
             </Chord>
+          <location>
+            <fractions>1/4</fractions>
+            </location>
           </voice>
         </Measure>
       <Measure>

src/engraving/tests/implode_explode_data/implodeScore01-ref.mscx

@@ -1110,6 +1110,9 @@
               <tpc>14</tpc>
               </Note>
             </Chord>
+          <location>
+            <fractions>1/4</fractions>
+            </location>
           </voice>
         </Measure>
       <Measure>

src/engraving/tests/implode_explode_data/implodeScore02-ref.mscx

@@ -678,6 +678,9 @@
               <tpc>14</tpc>
               </Note>
             </Chord>
+          <location>
+            <fractions>1/4</fractions>
+            </location>
           </voice>
         </Measure>
       <Measure>

src/engraving/tests/readwriteundoreset_data/slurs.mscx

@@ -349,6 +349,9 @@
               <tpc>16</tpc>
               </Note>
             </Chord>
+          <location>
+            <fractions>1/4</fractions>
+            </location>
           </voice>
         </Measure>
       <Measure>

src/engraving/tests/split_data/split184061-other-inst-only-one-tie-ref.mscx

@@ -288,6 +288,9 @@
               <tpc>18</tpc>
               </Note>
             </Chord>
+          <location>
+            <fractions>1/4</fractions>
+            </location>
           </voice>
         </Measure>
       </Staff>

src/importexport/mei/internal/meiexporter.cpp

@@ -1353,7 +1353,7 @@ bool MeiExporter::writeRest(const Rest* rest, const Staff* staff)
         this->writeBeamAndTupletEnd(closingBeam, closingTuplet, closingBeamInTuplet);
 
         // Change invisible rests to space by simply adjusting the element name
-        if (!rest->visible()) {
+        if (!rest->visible() || rest->isGap()) {
             restNode.set_name("space");
         }
     }