juce_PropertiesFile.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
   A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_PROPERTIESFILE_H_INCLUDED
#define JUCE_PROPERTIESFILE_H_INCLUDED
 
 
//==============================================================================
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();
 
    //==============================================================================
    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, needsWriting;
 
    typedef const ScopedPointer<InterProcessLock::ScopedLockType> ProcessScopedLock;
    InterProcessLock::ScopedLockType* createProcessLock() const;
 
    void timerCallback() override;
    bool saveAsXml();
    bool saveAsBinary();
    bool loadAsXml();
    bool loadAsBinary();
    bool loadAsBinary (InputStream&);
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (PropertiesFile)
};
 
#endif   // JUCE_PROPERTIESFILE_H_INCLUDED