Upgrade old settings key

Author: Reedbeta

src/engraving/internal/engravingconfiguration.cpp

@@ -43,7 +43,6 @@ using namespace mu::engraving;
 static const Settings::Key DEFAULT_STYLE_FILE_PATH("engraving", "engraving/style/defaultStyleFile");
 static const Settings::Key PART_STYLE_FILE_PATH("engraving", "engraving/style/partStyleFile");
 
-static const Settings::Key INVERT_SCORE_COLOR("engraving", "engraving/scoreColorInversion");
 static const Settings::Key SCORE_COLOR_INVERSION_MODE("engraving", "engraving/scoreColorInversionMode");
 
 static const Settings::Key ALL_VOICES_COLOR("engraving", "engraving/colors/allVoicesColor");
@@ -86,17 +85,22 @@ void EngravingConfiguration::init()
         m_partStyleFilePathChanged.send(val.toPath());
     });
 
-    // TODO: How to upgrade old setting to new one?
-    settings()->setDefaultValue(INVERT_SCORE_COLOR, Val(false));
-    settings()->valueChanged(INVERT_SCORE_COLOR).onReceive(nullptr, [this](const Val&) {
-        m_scoreInversionChanged.notify();
-    });
-
     settings()->setDefaultValue(SCORE_COLOR_INVERSION_MODE, Val(ScoreInversionMode::Disabled));
     settings()->valueChanged(SCORE_COLOR_INVERSION_MODE).onReceive(nullptr, [this](const Val&) {
         m_scoreInversionChanged.notify();
     });
 
+    // Upgrade old scoreColorInversion setting to new inversion mode
+    {
+        static const Settings::Key INVERT_SCORE_COLOR_deprecated("engraving", "engraving/scoreColorInversion");
+        if (!settings()->contains(SCORE_COLOR_INVERSION_MODE) && settings()->contains(INVERT_SCORE_COLOR_deprecated)) {
+            ScoreInversionMode mode
+                = settings()->value(INVERT_SCORE_COLOR_deprecated).toBool() ? ScoreInversionMode::Always : ScoreInversionMode::Disabled;
+            settings()->setSharedValue(SCORE_COLOR_INVERSION_MODE, Val(mode));
+            settings()->remove(INVERT_SCORE_COLOR_deprecated);
+        }
+    }
+
     for (voice_idx_t voice = 0; voice < VOICES; ++voice) {
         Settings::Key key("engraving", "engraving/colors/voice" + std::to_string(voice + 1));
 

src/framework/global/settings.cpp

@@ -68,6 +68,22 @@ io::path_t Settings::filePath() const
     return m_settings->fileName();
 }
 
+void Settings::remove(const Key& key)
+{
+#ifdef MUSE_MODULE_MULTIINSTANCES
+    muse::mi::WriteResourceLockGuard resource_lock(multiInstancesProvider.get(), SETTINGS_RESOURCE_NAME);
+#endif
+    m_settings->remove(QString::fromStdString(key.key));
+}
+
+bool Settings::contains(const Key& key) const
+{
+#ifdef MUSE_MODULE_MULTIINSTANCES
+    muse::mi::ReadResourceLockGuard resource_lock(multiInstancesProvider.get(), SETTINGS_RESOURCE_NAME);
+#endif
+    return m_settings->contains(QString::fromStdString(key.key));
+}
+
 const Settings::Items& Settings::items() const
 {
     return m_isTransactionStarted ? m_localSettings : m_items;

src/framework/global/settings.h

@@ -112,6 +112,9 @@ class Settings
 
     io::path_t filePath() const;
 
+    void remove(const Key& key);
+    bool contains(const Key& key) const;
+
 private:
     Settings();
     ~Settings();