Merge pull request #31719 from miiizen/migratePalettes

Use correct file reader for palettes and migrate old workspaces

Author: mike-spa

src/palette/internal/palette.cpp

@@ -456,8 +456,8 @@ bool Palette::readFromFile(const QString& p)
         if (e.name() == "museScore") {
             QString version = e.attribute("version");
             QStringList sl = version.split('.');
-            int versionId = sl[0].toInt() * 100 + sl[1].toInt();
-            gpaletteScore->setMscVersion(versionId); // TODO: what is this?
+            int mscVersion = sl[0].toInt() * 100 + sl[1].toInt();
+            gpaletteScore->setMscVersion(mscVersion);
 
             while (e.readNextStartElement()) {
                 if (e.name() == "Palette") {

src/palette/internal/palettecell.cpp

@@ -222,7 +222,7 @@ bool PaletteCell::read(XmlReader& e, bool pasteMode)
         } else if (s == "Tremolo") {
             compat::TremoloCompat tc;
             tc.parent = gpaletteScore->dummy()->chord();
-            rw::RWRegister::reader()->readTremoloCompat(&tc, e);
+            rw::RWRegister::reader(gpaletteScore->mscVersion())->readTremoloCompat(&tc, e);
             if (tc.single) {
                 element.reset(tc.single);
             } else if (tc.two) {
@@ -239,7 +239,7 @@ bool PaletteCell::read(XmlReader& e, bool pasteMode)
             if (!element) {
                 e.unknown();
             } else {
-                rw::RWRegister::reader()->readItem(element.get(), e);
+                rw::RWRegister::reader(gpaletteScore->mscVersion())->readItem(element.get(), e);
             }
         }
     }

src/palette/internal/palettetree.cpp

@@ -57,7 +57,7 @@ bool PaletteTree::read(mu::engraving::XmlReader& e, bool pasteMode, const muse::
 
 void PaletteTree::write(mu::engraving::XmlWriter& xml, bool pasteMode) const
 {
-    xml.startElement("PaletteBox"); // for compatibility with old palettes file format
+    xml.startElement("PaletteBox", { { "version", engraving::Constants::MSC_VERSION_STR } }); // for compatibility with old palettes file format
 
     for (const PalettePtr& palette : palettes) {
         palette->write(xml, pasteMode);

src/palette/internal/paletteworkspacesetup.cpp

@@ -26,6 +26,7 @@
 #include "palettecreator.h"
 #include "../palettetypes.h"
 
+#include "engraving/dom/masterscore.h"
 #include "engraving/rw/xmlreader.h"
 #include "engraving/rw/xmlwriter.h"
 
@@ -39,7 +40,7 @@ using namespace muse::workspace;
 
 static const AsciiStringView PALETTE_XML_TAG("PaletteBox");
 
-static PaletteTreePtr readPalette(const ByteArray& data, const muse::modularity::ContextPtr& iocCtx)
+PaletteTreePtr PaletteWorkspaceSetup::readPalette(const ByteArray& data, const muse::modularity::ContextPtr& iocCtx)
 {
     ByteArray ba = ByteArray::fromRawData(data.constData(), data.size());
     Buffer buf(&ba);
@@ -50,6 +51,17 @@ static PaletteTreePtr readPalette(const ByteArray& data, const muse::modularity:
         reader.readNextStartElement();
 
         if (reader.name() == PALETTE_XML_TAG) {
+            int mscVersion = 0;
+            if (reader.hasAttribute("version")) {
+                const String version = reader.attribute("version");
+                const StringList sl = version.split(u'.');
+                mscVersion = sl.size() == 2 ? sl[0].toInt() * 100 + sl[1].toInt() : 0;
+            } else {
+                // Versioning workspace palette files started in 4.7. All unversioned files should be treated like 4.6 files
+                mscVersion = 460;
+            }
+            engraving::gpaletteScore->setMscVersion(mscVersion);
+
             PaletteTreePtr tree = std::make_shared<PaletteTree>();
             tree->read(reader, false, iocCtx);
             return tree;
@@ -59,7 +71,7 @@ static PaletteTreePtr readPalette(const ByteArray& data, const muse::modularity:
     return nullptr;
 }
 
-static void writePalette(const PaletteTreePtr& tree, QByteArray& data)
+void PaletteWorkspaceSetup::writePalette(const PaletteTreePtr& tree, QByteArray& data)
 {
     Buffer buf;
     buf.open(IODevice::WriteOnly);
@@ -77,16 +89,18 @@ void PaletteWorkspaceSetup::setup()
 
     paletteProvider()->setDefaultPaletteTree(PaletteCreator(iocContext()).newDefaultPaletteTree());
 
-    paletteProvider()->userPaletteTreeChanged().onNotify(this, [this]() {
+    auto saveData = [this]() {
         PaletteTreePtr tree = paletteProvider()->userPaletteTree();
 
         QByteArray newData;
         writePalette(tree, newData);
 
         workspacesDataProvider()->setRawData(WS_Palettes, newData);
-    });
+    };
+
+    paletteProvider()->userPaletteTreeChanged().onNotify(this, saveData);
 
-    auto loadData = [this]() {
+    auto loadData = [this, saveData]() {
         RetVal<QByteArray> data = workspacesDataProvider()->rawData(WS_Palettes);
         PaletteTreePtr tree;
         if (data.ret && !data.val.isEmpty()) {
@@ -98,6 +112,12 @@ void PaletteWorkspaceSetup::setup()
             tree = PaletteCreator(iocContext()).newDefaultPaletteTree();
         }
         paletteProvider()->setUserPaletteTree(tree);
+
+        if (engraving::gpaletteScore->mscVersion() < engraving::Constants::MSC_VERSION) {
+            LOGD() << "Workspace file found with palette file version " << engraving::gpaletteScore->mscVersion() <<
+                ". Migrating palette file to " << engraving::Constants::MSC_VERSION;
+            saveData();
+        }
     };
 
     workspacesDataProvider()->workspaceChanged().onNotify(this, loadData);

src/palette/internal/paletteworkspacesetup.h

@@ -41,6 +41,10 @@ class PaletteWorkspaceSetup : public muse::async::Asyncable, public muse::Inject
     }
 
     void setup();
+
+private:
+    PaletteTreePtr readPalette(const muse::ByteArray& data, const muse::modularity::ContextPtr& iocCtx);
+    void writePalette(const PaletteTreePtr& tree, QByteArray& data);
 };
 }