juce_PropertiesFile.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  PropertiesFile  : public PropertySet,
                                  public ChangeBroadcaster,
                                  private Timer
{
public:
    //==============================================================================
    enum StorageFormat
    {
        storeAsBinary,
        storeAsCompressedBinary,
        storeAsXML
    };
 
    //==============================================================================
    struct JUCE_API  Options
    {
        Options();

        String applicationName;

        String filenameSuffix;

        String folderName;

        String osxLibrarySubFolder;

        bool commonToAllUsers;

        bool ignoreCaseOfKeyNames;

        bool doNotSave;

        int millisecondsBeforeSaving;

        StorageFormat storageFormat;

        InterProcessLock* processLock;

        File getDefaultFile() const;
    };
 
    //==============================================================================
    explicit PropertiesFile (const Options& options);

    PropertiesFile (const File& file,
                    const Options& options);

    ~PropertiesFile() override;
 
    //==============================================================================
    bool isValidFile() const noexcept               { return loadedOk; }
 
    //==============================================================================
    bool saveIfNeeded();

    bool save();

    bool needsToBeSaved() const;

    void setNeedsToBeSaved (bool needsToBeSaved);

    bool reload();
 
    //==============================================================================
    const File& getFile() const noexcept            { return file; }
 
 
protected:
    void propertyChanged() override;
 
private:
    //==============================================================================
    File file;
    Options options;
    bool loadedOk = false, needsWriting = false;
 
    using ProcessScopedLock = const std::unique_ptr<InterProcessLock::ScopedLockType>;
    InterProcessLock::ScopedLockType* createProcessLock() const;
 
    void timerCallback() override;
    bool saveAsXml();
    bool saveAsBinary();
    bool loadAsXml();
    bool loadAsBinary();
    bool loadAsBinary (InputStream&);
    bool writeToStream (OutputStream&);
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (PropertiesFile)
};
 
} // namespace juce