1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
/****************************************************************************
**
** 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 UserFileVersionHandler;
}
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 addVersionHandler(Internal::UserFileVersionHandler *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::UserFileVersionHandler *> m_handlers;
int m_firstVersion;
int m_lastVersion;
const FileAccessor m_userFileAcessor;
const FileAccessor m_sharedFileAcessor;
Project *m_project;
};
} // namespace ProjectExplorer
#endif // SETTINGSACCESSOR_H
|
