Improvements to new settings system

Author: timothyschoen

Source/Components/SuggestionComponent.h

@@ -629,7 +629,7 @@ class SuggestionComponent final : public Component
             if (!_this || !_this->currentObject)
                 return;
 
-            if (!SettingsFile::getInstance()->getLibrariesTree().contains("Gem")) {
+            if (!SettingsFile::getInstance()->getProperty<VarArray>("libraries").contains("Gem")) {
                 StringArray noGemObjects;
                 for (auto& object : toFilter) {
                     if (object.startsWith("Gem/") || !library->isGemObject(object)) // Don't suggest Gem objects without "Gem/" prefix unless gem library is loaded

Source/Dialogs/PathsSettingsPanel.h

@@ -272,7 +272,7 @@ class SearchPathPanel final : public Component
     {
         paths.clear();
 
-        for (auto& child : SettingsFile::getInstance()->getPathsTree()) {
+        for (auto& child : SettingsFile::getInstance()->getProperty<VarArray>("paths")) {
             paths.add(child);
         }
 
@@ -283,7 +283,7 @@ class SearchPathPanel final : public Component
     }
     void internalChange()
     {
-        auto& pathsTree = SettingsFile::getInstance()->getPathsTree();
+        auto& pathsTree = SettingsFile::getInstance()->getProperty<VarArray>("paths");
         pathsTree.clear();
 
         for (auto const& path : paths) {
@@ -573,7 +573,7 @@ class LibraryLoadPanel final : public Component
     {
         librariesToLoad.clear();
 
-        for (auto& child : SettingsFile::getInstance()->getLibrariesTree()) {
+        for (auto& child : SettingsFile::getInstance()->getProperty<VarArray>("libraries")) {
             librariesToLoad.addIfNotAlreadyThere(child.toString());
         }
 
@@ -584,7 +584,7 @@ class LibraryLoadPanel final : public Component
     }
     void internalChange()
     {
-        auto& librariesTree = SettingsFile::getInstance()->getLibrariesTree();
+        auto& librariesTree = SettingsFile::getInstance()->getProperty<VarArray>("libraries");
         librariesTree.clear();
 
         for (auto const& name : librariesToLoad) {

Source/Dialogs/ThemeSettingsPanel.h

@@ -274,7 +274,7 @@ class ThemeSettingsPanel final : public SettingsDialogPanel
             if (newThemeName.isEmpty())
                 return;
 
-            SettingsFile::getInstance()->getActiveThemes().getReference(themeSlot) = newThemeName;
+            SettingsFile::getInstance()->getProperty<VarArray>("active_themes").getReference(themeSlot) = newThemeName;
             PlugDataLook::selectedThemes.set(themeSlot, newThemeName);
 
             updateThemeNames(primaryThemeSelector->getText(), secondaryThemeSelector->getText());
@@ -310,7 +310,7 @@ class ThemeSettingsPanel final : public SettingsDialogPanel
                 DynamicObject::Ptr newTheme = theme->clone().release();
                 newTheme->setProperty("name", name);
 
-                SettingsFile::getInstance()->getThemeTree().add(var(newTheme.get()));
+                SettingsFile::getInstance()->getProperty<VarArray>("themes").add(var(newTheme.get()));
                 updateSwatches();
             };
 
@@ -352,7 +352,7 @@ class ThemeSettingsPanel final : public SettingsDialogPanel
                         themeName = finalThemeName;
                     }
                     themeObj->setProperty("name", themeName);
-                    SettingsFile::getInstance()->getThemeTree().add(themeJson);
+                    SettingsFile::getInstance()->getProperty<VarArray>("themes").add(themeJson);
                 }
                 updateSwatches();
             },
@@ -403,11 +403,11 @@ class ThemeSettingsPanel final : public SettingsDialogPanel
                 if (result < 1)
                     return;
 
-                auto& selectedThemes = SettingsFile::getInstance()->getActiveThemes();
+                auto& selectedThemes = SettingsFile::getInstance()->getProperty<VarArray>("active_themes");
                 auto const& themeName = allThemes[result - 1];
                 auto currentTheme = SettingsFile::getInstance()->getProperty<String>("theme");
 
-                SettingsFile::getInstance()->getThemeTree().remove(result - 1);
+                SettingsFile::getInstance()->getProperty<VarArray>("themes").remove(result - 1);
                 if (selectedThemes[0].toString() == themeName) {
                     selectedThemes.set(0, "light");
                     PlugDataLook::selectedThemes.set(0, "light");
@@ -560,7 +560,7 @@ class ThemeSettingsPanel final : public SettingsDialogPanel
             return;
         }
 
-        auto const themeTree = SettingsFile::getInstance()->getThemeTree();
+        auto const themeTree = SettingsFile::getInstance()->getProperty<VarArray>("themes");
         bool isInTheme = false;
         bool ioletGeometryNeedsUpdate = false;
         for (auto theme : PlugDataLook::selectedThemes) {
@@ -656,8 +656,8 @@ class ThemeSettingsPanel final : public SettingsDialogPanel
         primaryThemeSelector->setSelectedItem(firstThemes.indexOf(PlugDataLook::selectedThemes[0]));
         secondaryThemeSelector->setSelectedItem(secondThemes.indexOf(PlugDataLook::selectedThemes[1]));
 
-        SettingsFile::getInstance()->getActiveThemes().set(0, "light");
-        SettingsFile::getInstance()->getActiveThemes().set(1, "dark");
+        SettingsFile::getInstance()->getProperty<VarArray>("active_themes").set(0, "light");
+        SettingsFile::getInstance()->getProperty<VarArray>("active_themes").set(1, "dark");
         SettingsFile::getInstance()->setProperty("theme", "light");
 
         updateSwatches();

Source/LookAndFeel.cpp

@@ -1411,7 +1411,7 @@ void PlugDataLook::setTheme(DynamicObject::Ptr themeTree)
 
 StringArray PlugDataLook::getAllThemes()
 {
-    auto const themeTree = SettingsFile::getInstance()->getThemeTree();
+    auto const themeTree = SettingsFile::getInstance()->getProperty<VarArray>("themes");
     StringArray allThemes;
     for (auto& theme : themeTree) {
         allThemes.add(theme.getDynamicObject()->getProperty("name").toString());

Source/PluginProcessor.cpp

@@ -519,7 +519,7 @@ bool PluginProcessor::initialiseFilesystem()
 void PluginProcessor::updateSearchPaths()
 {
     // Reload pd search paths from settings
-    auto const& pathTree = settingsFile->getPathsTree();
+    auto const& pathTree = settingsFile->getProperty<VarArray>("paths");
 
     setThis();
 
@@ -542,7 +542,7 @@ void PluginProcessor::updateSearchPaths()
         libpd_add_to_search_path(path.replace("\\", "/").toRawUTF8());
     }
 
-    auto librariesTree = settingsFile->getLibrariesTree();
+    auto librariesTree = settingsFile->getProperty<VarArray>("libraries");
 
     for (auto& library : librariesTree) {
         if (library.toString().isEmpty()) {

Source/Utility/SettingsFile.cpp

@@ -190,6 +190,8 @@ SettingsFile* SettingsFile::initialise()
 
     isInitialised = true;
 
+    FileSystemWatcher::addGlobalIgnorePath(lockFile);
+
     // Check if settings file exists, if not, create the default
     // This is expected behaviour for first run / deleting plugdata folder
     // No need to alert the user to this
@@ -216,7 +218,7 @@ SettingsFile* SettingsFile::initialise()
 
         auto settingsFileToUse = settingsFile;
         bool xmlSettings = false;
-        if (oldSettingsFile.existsAsFile()) {
+        if (oldSettingsFile.existsAsFile() && !settingsFile.existsAsFile()) {
             settingsFileToUse = oldSettingsFile;
             xmlSettings = true;
         }
@@ -317,26 +319,6 @@ String SettingsFile::getKeyMap() const
     return memOut.toString();
 }
 
-Array<var>& SettingsFile::getThemeTree() const
-{
-    return getProperty<VarArray>("themes");
-}
-
-Array<var>& SettingsFile::getPathsTree() const
-{
-    return getProperty<VarArray>("paths");
-}
-
-Array<var>& SettingsFile::getActiveThemes() const
-{
-    return getProperty<VarArray>("active_themes");
-}
-
-Array<var>& SettingsFile::getLibrariesTree() const
-{
-    return getProperty<VarArray>("libraries");
-}
-
 DynamicObject::Ptr SettingsFile::getTheme(String const& name) const
 {
     for (auto& theme : getProperty<VarArray>("themes")) {
@@ -386,7 +368,7 @@ void SettingsFile::initialisePathsTree()
     HeapArray<File> currentPaths;
     currentPaths.reserve(10);
 
-    auto& pathTree = getPathsTree();
+    auto& pathTree = getProperty<VarArray>("paths");
 
     // on iOS, the containerisation of apps leads to problems with custom search paths
     // So we completely reset them every time
@@ -474,7 +456,7 @@ bool SettingsFile::wantsNativeDialog() const
 void SettingsFile::initialiseThemesTree()
 {
     // Initialise selected themes tree
-    auto selectedThemes = getActiveThemes();
+    auto selectedThemes = getProperty<VarArray>("active_themes");
     auto currentTheme = getProperty<String>("theme");
 
     if(!getTheme(currentTheme))
@@ -580,6 +562,7 @@ void SettingsFile::reloadSettings()
     if (acquireFileLock()) {
         auto const newSettings = settingsFile.loadFileAsString();
         auto const contentHash = newSettings.hashCode64();
+
         if (contentHash == lastContentHash) {
             releaseFileLock();
             return;
@@ -591,6 +574,16 @@ void SettingsFile::reloadSettings()
             return;
         }
 
+        for (auto& [name, var] : defaultSettings) {
+            if(name == "themes")
+            {
+                settings["themes"] = JSON::fromString(PlugDataLook::defaultThemesJSON);
+                loadThemeFromDiff(*var.getArray());
+                continue;
+            }
+            settings[name] = var;
+        }
+
         auto* jsonObject = settingsToLoad.getDynamicObject();
         for (auto& var : jsonObject->getProperties()) {
             if(var.name == Identifier("themes"))
@@ -610,11 +603,9 @@ void SettingsFile::reloadSettings()
     }
 }
 
-void SettingsFile::fileChanged(File const file, FileSystemWatcher::FileSystemEvent fileEvent)
+void SettingsFile::filesystemChanged()
 {
-    if (file == settingsFile) {
-        reloadSettings();
-    }
+    reloadSettings();
 }
 
 void SettingsFile::triggerSettingsChange(String const& name)

Source/Utility/SettingsFile.h

@@ -39,11 +39,6 @@ class SettingsFile final
     void setKeyMap(String const& keymap);
     String getKeyMap() const;
 
-    Array<var>& getThemeTree() const;
-    Array<var>& getPathsTree() const;
-    Array<var>& getActiveThemes() const;
-    Array<var>& getLibrariesTree() const;
-
     DynamicObject::Ptr getTheme(String const& name) const;
     DynamicObject::Ptr getCurrentTheme() const;
 
@@ -60,7 +55,7 @@ class SettingsFile final
 
     void reloadSettings();
 
-    void fileChanged(File file, FileSystemWatcher::FileSystemEvent fileEvent) override;
+    void filesystemChanged() override;
 
     void triggerSettingsChange(String const&);
     void valueChanged(Value& v) override;