tracktion_PropertyStorage.h

Go to the documentation of this file.

 /*
    ,--.                     ,--.     ,--.  ,--.
  ,-'  '-.,--.--.,--,--.,---.|  |,-.,-'  '-.`--' ,---. ,--,--,      Copyright 2024
  '-.  .-'|  .--' ,-.  | .--'|     /'-.  .-',--.| .-. ||      \   Tracktion Software
    |  |  |  |  \ '-'  \ `--.|  \  \  |  |  |  |' '-' '|  ||  |       Corporation
    `---' `--'   `--`--'`---'`--'`--' `---' `--' `---' `--''--'    www.tracktion.com
 
    Tracktion Engine uses a GPL/commercial licence - see LICENCE.md for details.
*/
 
namespace tracktion { inline namespace engine
{
 
class PropertyStorage
{
public:
    //==============================================================================
    PropertyStorage (juce::String appName_) : appName (appName_) {}
    virtual ~PropertyStorage() {}
 
    static juce::StringRef settingToString (SettingID);
 
    //==============================================================================
    virtual juce::File getAppCacheFolder();
    virtual juce::File getAppPrefsFolder();
 
    virtual void flushSettingsToDisk() {}
 
    //==============================================================================
    virtual void removeProperty (SettingID);
 
    virtual juce::var getProperty (SettingID setting, const juce::var& defaultValue = {});
    virtual void setProperty (SettingID setting, const juce::var& value);
 
    virtual std::unique_ptr<juce::XmlElement> getXmlProperty (SettingID setting);
    virtual void setXmlProperty (SettingID setting, const juce::XmlElement&);
 
    //==============================================================================
    virtual void removePropertyItem (SettingID setting, juce::StringRef item);
 
    virtual juce::var getPropertyItem (SettingID setting, juce::StringRef item, const juce::var& defaultValue = {});
    virtual void setPropertyItem (SettingID setting, juce::StringRef item, const juce::var& value);
 
    virtual std::unique_ptr<juce::XmlElement> getXmlPropertyItem (SettingID setting, juce::StringRef item);
    virtual void setXmlPropertyItem (SettingID setting, juce::StringRef item, const juce::XmlElement&);
 
    //==============================================================================
    virtual juce::File getDefaultLoadSaveDirectory (juce::StringRef label);
    virtual void setDefaultLoadSaveDirectory (juce::StringRef label, const juce::File& newPath);
 
    virtual juce::File getDefaultLoadSaveDirectory (ProjectItem::Category);
 
    //==============================================================================
    virtual juce::String getUserName();
    virtual juce::String getApplicationName()       { return appName; }
    virtual juce::String getApplicationVersion()    { return "Unknown"; }
 
    //==============================================================================
    // If you are using the default implementation of PropertyStorage, it uses a
    // PropertiesFile to store its state. This accessor method lets you use it in
    // case you need it for things like a juce::PluginListComponent.
    virtual juce::PropertiesFile& getPropertiesFile();
 
private:
    juce::String appName;
 
    std::unique_ptr<juce::PropertiesFile> propertiesFile;
};
 
}} // namespace tracktion { inline namespace engine