qt-creator/src/plugins/projectexplorer/settingsaccessor.h

/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#ifndef SETTINGSACCESSOR_H
#define SETTINGSACCESSOR_H

#include <utils/fileutils.h>

#include <QVariantMap>

namespace Utils { class PersistentSettingsWriter; }

namespace ProjectExplorer {

class Project;

namespace Internal { class VersionUpgrader; }

class SettingsAccessor
{
public:
    SettingsAccessor(Project *project);
    ~SettingsAccessor();

    Project *project() const;

    QVariantMap restoreSettings() const;
    bool saveSettings(const QVariantMap &map) const;

private:
    // Takes ownership of the handler!
    void addVersionUpgrader(Internal::VersionUpgrader *handler);

    QStringList findSettingsFiles(const QString &suffix) const;
    static QByteArray creatorId();
    QString defaultFileName(const QString &suffix) const;
    int currentVersion() const;
    void backupUserFile() const;

    // The relevant data from the settings currently in use.
    class SettingsData
    {
    public:
        SettingsData() : m_version(-1), m_usingBackup(false) {}
        SettingsData(const QVariantMap &map) : m_version(-1), m_usingBackup(false), m_map(map) {}

        void clear();
        bool isValid() const;
        QByteArray environmentId() const { return m_environmentId; }
        int version() const { return m_version; }
        Utils::FileName fileName() const { return m_fileName; }

        int m_version;
        QByteArray m_environmentId;
        bool m_usingBackup;
        QVariantMap m_map;
        Utils::FileName m_fileName;
    };

    void incrementVersion(SettingsData &data) const;

    SettingsData readUserSettings() const;
    SettingsData readSharedSettings() const;
    SettingsData findBestSettings(const QStringList &candidates) const;
    SettingsData mergeSettings(const SettingsData &user, const SettingsData &shared) const;

    // The entity which actually reads/writes to the settings file.
    class FileAccessor
    {
    public:
        FileAccessor(const QString &defaultSuffix,
                     const QString &environmentSuffix,
                     bool envSpecific,
                     SettingsAccessor *accessor);
        ~FileAccessor();

        bool readFile(SettingsData *settings) const;
        bool writeFile(const SettingsData *settings) const;

        QString suffix() const { return m_suffix; }

    private:
        void assignSuffix(const QString &defaultSuffix, const QString &environmentSuffix);

        QString m_suffix;
        bool m_environmentSpecific;
        SettingsAccessor *m_accessor;
        mutable Utils::PersistentSettingsWriter *m_writer;
    };

    QMap<int, Internal::VersionUpgrader *> m_handlers;
    int m_firstVersion;
    int m_lastVersion;
    const FileAccessor m_userFileAcessor;
    const FileAccessor m_sharedFileAcessor;

    Project *m_project;
};

} // namespace ProjectExplorer

#endif // SETTINGSACCESSOR_H