settingsaccessor.h 3.53 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** 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.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** 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
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
29

30 31
#ifndef SETTINGSACCESSOR_H
#define SETTINGSACCESSOR_H
32

33
#include <utils/fileutils.h>
34 35 36 37

#include <QVariantMap>

namespace Utils { class PersistentSettingsWriter; }
38

39 40 41 42
namespace ProjectExplorer {

class Project;

43
namespace Internal { class VersionUpgrader; }
44

45 46
class SettingsAccessorPrivate;

47
class SettingsAccessor
48 49
{
public:
Tobias Hunger's avatar
Tobias Hunger committed
50
    SettingsAccessor(Project *project);
51
    virtual ~SettingsAccessor();
52

Tobias Hunger's avatar
Tobias Hunger committed
53
    Project *project() const;
54

55
    QVariantMap restoreSettings(QWidget *parent) const;
56
    bool saveSettings(const QVariantMap &data, QWidget *parent) const;
57

58 59 60 61 62
    static QVariantMap setVersionInMap(const QVariantMap &data, int version);
    static int versionFromMap(const QVariantMap &data);
    static int originalVersionFromMap(const QVariantMap &data);
    static QVariantMap setOriginalVersionInMap(const QVariantMap &data, int version);

63 64 65 66
    int currentVersion() const;
    int firstSupportedVersion() const;

    bool addVersionUpgrader(Internal::VersionUpgrader *upgrader); // takes ownership of upgrader
67 68 69 70

protected:
    QVariantMap readFile(const Utils::FileName &path) const;
    QVariantMap upgradeSettings(const QVariantMap &data, int toVersion) const;
71
    virtual QVariantMap prepareSettings(const QVariantMap &data) const;
72

73
private:
74
    QStringList findSettingsFiles(const QString &suffix) const;
75
    static QByteArray creatorId();
76
    QString defaultFileName(const QString &suffix) const;
77
    void backupUserFile() const;
78

79 80 81
    QVariantMap readUserSettings(QWidget *parent) const;
    QVariantMap readSharedSettings(QWidget *parent) const;
    QVariantMap mergeSettings(const QVariantMap &userMap, const QVariantMap &sharedMap) const;
82

83
    static QByteArray environmentIdFromMap(const QVariantMap &data);
84

85 86
    QString m_userSuffix;
    QString m_sharedSuffix;
Tobias Hunger's avatar
Tobias Hunger committed
87 88

    Project *m_project;
89 90 91 92

    SettingsAccessorPrivate *d;

    friend class SettingsAccessorPrivate;
93 94
};

95 96 97 98 99
namespace Internal {
class UserFileAccessor : public SettingsAccessor
{
public:
    UserFileAccessor(Project *project);
100 101 102

protected:
    QVariantMap prepareSettings(const QVariantMap &data) const;
103 104 105
};

} // namespace Internal
106 107
} // namespace ProjectExplorer

108
#endif // SETTINGSACCESSOR_H