Refactor: move mandatory migrations into EngravingCompat

Author: cbjeukendrup

src/engraving/compat/engravingcompat.cpp

@@ -65,6 +65,29 @@ void EngravingCompat::doPreLayoutCompatIfNeeded(MasterScore* score)
             undoStaffTextExcludeFromPart(score);
         }
     }
+
+    if (mscVersion < 400) {
+        migrateStyleSettingsForPre400(score);
+    }
+}
+
+void EngravingCompat::migrateStyleSettingsForPre400(MasterScore* masterScore)
+{
+    // TODO: move to style compat reading when we have it
+    MStyle& style = masterScore->style();
+    const double sp = style.spatium();
+    style.set(Sid::dynamicsFontSize, 10.0);
+    double doubleBarDistance = style.styleAbsolute(Sid::doubleBarDistance);
+    doubleBarDistance -= style.styleAbsolute(Sid::doubleBarWidth);
+    style.set(Sid::doubleBarDistance, doubleBarDistance / sp);
+    double endBarDistance = style.styleAbsolute(Sid::endBarDistance);
+    endBarDistance -= (style.styleAbsolute(Sid::barWidth) + style.styleAbsolute(Sid::endBarWidth)) / 2;
+    style.set(Sid::endBarDistance, endBarDistance / sp);
+    double repeatBarlineDotSeparation = style.styleAbsolute(Sid::repeatBarlineDotSeparation);
+    double dotWidth = masterScore->engravingFont()->width(SymId::repeatDot, 1.0);
+    repeatBarlineDotSeparation -= (style.styleAbsolute(Sid::barWidth) + dotWidth) / 2;
+    style.set(Sid::repeatBarlineDotSeparation, repeatBarlineDotSeparation / sp);
+    style.set(Sid::measureSpacing, DefaultStyle::defaultStyle().value(Sid::measureSpacing));
 }
 
 void EngravingCompat::correctPedalEndPoints(MasterScore* score)
@@ -295,6 +318,12 @@ void EngravingCompat::doPostLayoutCompatIfNeeded(MasterScore* score)
 
     int mscVersion = score->mscVersion();
 
+    if (mscVersion < 300) {
+        resetAllElementsPositions(score);
+        resetCrossBeams(score);
+        needRelayout = true;
+    }
+
     if (mscVersion < 440) {
         needRelayout |= relayoutUserModifiedCrossStaffBeams(score);
     }
@@ -304,6 +333,31 @@ void EngravingCompat::doPostLayoutCompatIfNeeded(MasterScore* score)
     }
 }
 
+void EngravingCompat::resetAllElementsPositions(MasterScore* score)
+{
+    score->scanElements([](EngravingItem* e) {
+        if (e->generated()) {
+            return;
+        }
+        e->resetProperty(Pid::AUTOPLACE);
+        e->resetProperty(Pid::OFFSET);
+        e->resetProperty(Pid::LEADING_SPACE);
+        e->setOffsetChanged(false);
+        if (e->isSpanner()) {
+            e->resetProperty(Pid::OFFSET2);
+        }
+    });
+}
+
+void EngravingCompat::resetCrossBeams(MasterScore* score)
+{
+    score->scanElements([](EngravingItem* e) {
+        if (e->isBeam() && toBeam(e)->fullCross()) {
+            e->reset();
+        }
+    });
+}
+
 bool EngravingCompat::relayoutUserModifiedCrossStaffBeams(MasterScore* score)
 {
     if (score->mscVersion() >= 440) {

src/engraving/compat/engravingcompat.h

@@ -34,6 +34,7 @@ class EngravingCompat
     static void doPostLayoutCompatIfNeeded(MasterScore* score);
 
 private:
+    static void migrateStyleSettingsForPre400(MasterScore* masterScore);
     static void correctPedalEndPoints(MasterScore* score);
     static void undoStaffTextExcludeFromPart(MasterScore* masterScore);
     static void migrateDynamicPosOnVocalStaves(MasterScore* masterScore);
@@ -44,5 +45,8 @@ class EngravingCompat
     static void migrateNoteParens(MasterScore* masterScore);
 
     static bool relayoutUserModifiedCrossStaffBeams(MasterScore* score);
+
+    static void resetAllElementsPositions(MasterScore* score);
+    static void resetCrossBeams(MasterScore* score);
 };
 } // namespace mu::engraving::compat

src/engraving/dom/score.cpp

@@ -5977,16 +5977,6 @@ void Score::doLayoutRange(const Fraction& st, const Fraction& et)
     }
 
     renderer()->layoutScore(this, start, end);
-
-    if (m_resetAutoplace) {
-        m_resetAutoplace = false;
-        resetAutoplace();
-    }
-
-    if (m_resetCrossBeams) {
-        m_resetCrossBeams = false;
-        resetCrossBeams();
-    }
 }
 
 void Score::createPaddingTable()

src/engraving/dom/score.h

@@ -379,16 +379,9 @@ class Score : public EngravingObject, public muse::Contextable
     void removeStaff(Staff*);
     void addMeasure(MeasureBase*, MeasureBase*);
     void linkMeasures(Score* score);
-    void setResetAutoplace() { m_resetAutoplace = true; }
-    void setResetCrossBeams() { m_resetCrossBeams = true; }
-
     Excerpt* excerpt() { return m_excerpt; }
     void setExcerpt(Excerpt* e) { m_excerpt = e; }
 
-    // methods for resetting elements for pre-4.0 score migration
-    void resetAutoplace();
-    void resetCrossBeams();
-
     void cmdAddBracket();
     void cmdToggleParentheses();
     void cmdToggleParentheses(EngravingItem* el);
@@ -418,7 +411,7 @@ class Score : public EngravingObject, public muse::Contextable
     void cmdAddStretch(double);
     void cmdAddGrace(NoteType, int);
     void cmdResetNoteAndRestGroupings();
-    void cmdResetAllPositions(bool undoable = true);
+
     void cmdDoubleDuration() { cmdIncDecDuration(-1, false); }
     void cmdHalfDuration() { cmdIncDecDuration(1, false); }
     void cmdIncDurationDotted() { cmdIncDecDuration(-1, true); }
@@ -1215,8 +1208,7 @@ class Score : public EngravingObject, public muse::Contextable
     ShowAnchors m_showAnchors;
 
     ScoreOrder m_scoreOrder;                 // used for score ordering
-    bool m_resetAutoplace = false;
-    bool m_resetCrossBeams = false;
+
     int m_mscVersion = Constants::MSC_VERSION;     // version of current loading *.msc file
 
     bool m_isOpen = false;

src/engraving/editing/cmd.cpp

@@ -2897,44 +2897,6 @@ void Score::cmdResetNoteAndRestGroupings()
     selection().updateSelectedElements();
 }
 
-static void resetBeamOffSet(EngravingItem* e)
-{
-    // Reset completely cross staff beams from MU1&2
-    if (e->isBeam() && toBeam(e)->fullCross()) {
-        e->reset();
-    }
-}
-
-//---------------------------------------------------------
-//   cmdResetAllPositions
-//---------------------------------------------------------
-void Score::cmdResetAllPositions(bool undoable)
-{
-    TRACEFUNC;
-
-    if (undoable) {
-        startCmd(TranslatableString("undoableAction", "Reset all positions"));
-    }
-    resetAutoplace();
-    if (undoable) {
-        endCmd();
-    }
-}
-
-void Score::resetAutoplace()
-{
-    TRACEFUNC;
-
-    scanElements(resetElementPosition);
-}
-
-void Score::resetCrossBeams()
-{
-    TRACEFUNC;
-
-    scanElements(resetBeamOffSet);
-}
-
 //---------------------------------------------------------
 //   move
 //    move current selection

src/engraving/tests/readwriteundoreset_tests.cpp

@@ -35,28 +35,6 @@ class Engraving_ReadWriteUndoResetTests : public ::testing::Test
 {
 };
 
-TEST_F(Engraving_ReadWriteUndoResetTests, testReadWriteResetPositions)
-{
-    std::vector<const char16_t*> files = {
-        u"barlines",
-        u"slurs",
-        u"mmrestBarlineTextLinks" // see issue #296426
-    };
-
-    for (const char16_t* file : files) {
-        String readFile(RWUNDORESET_DATA_DIR + file + u".mscx");
-        String writeFile(String(file) + u"-undoreset-test.mscx");
-
-        MasterScore* score = ScoreRW::readScore(readFile);
-        EXPECT_TRUE(score);
-        score->cmdResetAllPositions();
-        score->undoRedo(/* undo */ true, nullptr);
-        EXPECT_TRUE(ScoreComp::saveCompareScore(score, writeFile, readFile));
-
-        delete score;
-    }
-}
-
 //---------------------------------------------------------
 //   testMMRestLinksRecreateMMRest
 ///   For barlines links with MM rests a separate test is

src/project/internal/projectmigrator.cpp

@@ -71,7 +71,6 @@ Ret ProjectMigrator::migrateEngravingProjectIfNeed(engraving::EngravingProjectPt
     //! When migrating, the version becomes the current one, so remember the version of the default style before migrating
     project->masterScore()->style().setDefaultStyleVersion(ReadStyleHook::styleDefaultByMscVersion(project->mscVersion()));
     MigrationType migrationType = migrationTypeFromMscVersion(project->mscVersion());
-    m_resetStyleSettings = true;
 
     MigrationOptions migrationOptions = configuration()->migrationOptions(migrationType);
     if (migrationOptions.isAskAgain) {
@@ -135,33 +134,6 @@ Ret ProjectMigrator::askAboutMigration(MigrationOptions& out, const QString& app
     return true;
 }
 
-void ProjectMigrator::resetStyleSettings(mu::engraving::MasterScore* score)
-{
-    // there are a few things that need to be updated no matter which version the score is from (#10499)
-    // primarily, the differences made concerning barline thickness and distance
-    // these updates take place no matter whether or not the other migration options are checked
-    qreal sp = score->style().spatium();
-    mu::engraving::MStyle* style = &score->style();
-    style->set(mu::engraving::Sid::dynamicsFontSize, 10.0);
-    qreal doubleBarDistance = style->styleAbsolute(mu::engraving::Sid::doubleBarDistance);
-    doubleBarDistance -= style->styleAbsolute(mu::engraving::Sid::doubleBarWidth);
-    style->set(mu::engraving::Sid::doubleBarDistance, doubleBarDistance / sp);
-    qreal endBarDistance = style->styleAbsolute(mu::engraving::Sid::endBarDistance);
-    endBarDistance -= (style->styleAbsolute(mu::engraving::Sid::barWidth) + style->styleAbsolute(mu::engraving::Sid::endBarWidth)) / 2;
-    style->set(mu::engraving::Sid::endBarDistance, endBarDistance / sp);
-    qreal repeatBarlineDotSeparation = style->styleAbsolute(mu::engraving::Sid::repeatBarlineDotSeparation);
-    qreal dotWidth = score->engravingFont()->width(mu::engraving::SymId::repeatDot, 1.0);
-    repeatBarlineDotSeparation -= (style->styleAbsolute(mu::engraving::Sid::barWidth) + dotWidth) / 2;
-    style->set(mu::engraving::Sid::repeatBarlineDotSeparation, repeatBarlineDotSeparation / sp);
-    score->resetStyleValue(mu::engraving::Sid::measureSpacing);
-}
-
-bool ProjectMigrator::resetCrossBeams(engraving::MasterScore* score)
-{
-    score->setResetCrossBeams();
-    return true;
-}
-
 Ret ProjectMigrator::migrateProject(engraving::EngravingProjectPtr project, const MigrationOptions& opt)
 {
     TRACEFUNC;
@@ -176,34 +148,20 @@ Ret ProjectMigrator::migrateProject(engraving::EngravingProjectPtr project, cons
     bool ok = true;
     if (opt.isApplyLeland) {
         ok = applyLelandStyle(score);
-        m_resetStyleSettings = false;
     }
 
     if (ok && opt.isApplyEdwin) {
         ok = applyEdwinStyle(score);
-        m_resetStyleSettings = false;
     }
 
     if (ok && opt.isRemapPercussion) {
         MdlMigrator(score).remapPercussion();
     }
 
-    if (ok && score->mscVersion() < 300) {
-        ok = resetAllElementsPositions(score);
-    }
-
-    if (ok && score->mscVersion() <= 206) {
-        ok = resetCrossBeams(score);
-    }
-
     if (ok && score->mscVersion() != mu::engraving::Constants::MSC_VERSION) {
         score->undo(new mu::engraving::ChangeMetaText(score, u"mscVersion", String::fromAscii(mu::engraving::Constants::MSC_VERSION_STR)));
     }
 
-    if (ok && m_resetStyleSettings) {
-        resetStyleSettings(score);
-        score->setLayoutAll();
-    }
     score->endCmd();
 
     return ok ? make_ret(Ret::Code::Ok) : make_ret(Ret::Code::InternalError);
@@ -232,9 +190,3 @@ bool ProjectMigrator::applyEdwinStyle(mu::engraving::MasterScore* score)
 
     return score->loadStyle(styleFile, /*ign*/ false, /*overlap*/ true);
 }
-
-bool ProjectMigrator::resetAllElementsPositions(mu::engraving::MasterScore* score)
-{
-    score->setResetAutoplace();
-    return true;
-}

src/project/internal/projectmigrator.h

@@ -19,8 +19,8 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
-#ifndef MU_PROJECT_PROJECTMIGRATOR_H
-#define MU_PROJECT_PROJECTMIGRATOR_H
+
+#pragma once
 
 #include "iprojectmigrator.h"
 
@@ -49,12 +49,5 @@ class ProjectMigrator : public IProjectMigrator, public muse::Contextable
 
     bool applyLelandStyle(mu::engraving::MasterScore* score);
     bool applyEdwinStyle(mu::engraving::MasterScore* score);
-    bool resetAllElementsPositions(mu::engraving::MasterScore* score);
-    bool resetCrossBeams(mu::engraving::MasterScore* score);
-    void resetStyleSettings(mu::engraving::MasterScore* score);
-
-    bool m_resetStyleSettings{ false };
 };
 }
-
-#endif // MU_PROJECT_PROJECTMIGRATOR_H