settingsaccessor.h 4.28 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2013 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
44
45
namespace Internal {
class UserFileVersionHandler;
}
46

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

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

Tobias Hunger's avatar
Tobias Hunger committed
55
56
    QVariantMap restoreSettings() const;
    bool saveSettings(const QVariantMap &map) const;
57
58
59

private:
    // Takes ownership of the handler!
60
    void addVersionHandler(Internal::UserFileVersionHandler *handler);
61

62
63
64
65
    QStringList findSettingsFiles(const QString &suffix) const;
    QByteArray creatorId() const;
    QString defaultFileName(const QString &suffix) const;
    int currentVersion() const;
66
67
68
69
70
71
72
73

    // 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) {}

74
75
        void clear();
        bool isValid() const;
76
        QByteArray environmentId() const { return m_environmentId; }
77
78
        int version() const { return m_version; }
        Utils::FileName fileName() const { return m_fileName; }
79

80
        int m_version;
81
        QByteArray m_environmentId;
82
83
        bool m_usingBackup;
        QVariantMap m_map;
84
        Utils::FileName m_fileName;
85
86
    };

87
88
    void incrementVersion(SettingsData &data) const;

89
    SettingsData readUserSettings() const;
90
    SettingsData readSharedSettings() const;
91
    SettingsData findBestSettings(const QStringList &candidates) const;
92
    SettingsData mergeSettings(const SettingsData &user, const SettingsData &shared) const;
93

94
95
96
97
98
99
100
    // The entity which actually reads/writes to the settings file.
    class FileAccessor
    {
    public:
        FileAccessor(const QByteArray &id,
                     const QString &defaultSuffix,
                     const QString &environmentSuffix,
101
                     bool envSpecific,
Tobias Hunger's avatar
Tobias Hunger committed
102
103
104
105
106
                     SettingsAccessor *accessor);
        ~FileAccessor();

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

Tobias Hunger's avatar
Tobias Hunger committed
108
109
        QString suffix() const { return m_suffix; }
        QByteArray id() const { return m_id; }
110
111
112
113
114
115
116

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

        QByteArray m_id;
        QString m_suffix;
        bool m_environmentSpecific;
Tobias Hunger's avatar
Tobias Hunger committed
117
118
        SettingsAccessor *m_accessor;
        mutable Utils::PersistentSettingsWriter *m_writer;
119
120
121
    };

    QMap<int, Internal::UserFileVersionHandler *> m_handlers;
122
123
    int m_firstVersion;
    int m_lastVersion;
124
    const FileAccessor m_userFileAcessor;
125
    const FileAccessor m_sharedFileAcessor;
Tobias Hunger's avatar
Tobias Hunger committed
126
127

    Project *m_project;
128
129
130
131
};

} // namespace ProjectExplorer

132
#endif // SETTINGSACCESSOR_H