/
qgssettings.cpp
306 lines (271 loc) · 7.35 KB
/
qgssettings.cpp
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
/***************************************************************************
qgssettings.cpp
--------------------------------------
Date : January 2017
Copyright : (C) 2017 by Alessandro Pasotti
Email : apasotti at boundlessgeo dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#include <cstdlib>
#include <QFileInfo>
#include <QSettings>
#include <QDir>
#include "qgssettings.h"
#include "qgslogger.h"
QString QgsSettings::sGlobalSettingsPath = QString();
bool QgsSettings::setGlobalSettingsPath( const QString &path )
{
if ( QFileInfo::exists( path ) )
{
sGlobalSettingsPath = path;
return true;
}
return false;
}
void QgsSettings::init()
{
if ( ! sGlobalSettingsPath.isEmpty() )
{
mGlobalSettings = new QSettings( sGlobalSettingsPath, QSettings::IniFormat );
mGlobalSettings->setIniCodec( "UTF-8" );
}
}
QgsSettings::QgsSettings( const QString &organization, const QString &application, QObject *parent )
{
mUserSettings = new QSettings( organization, application, parent );
init();
}
QgsSettings::QgsSettings( QSettings::Scope scope, const QString &organization,
const QString &application, QObject *parent )
{
mUserSettings = new QSettings( scope, organization, application, parent );
init();
}
QgsSettings::QgsSettings( QSettings::Format format, QSettings::Scope scope,
const QString &organization, const QString &application, QObject *parent )
{
mUserSettings = new QSettings( format, scope, organization, application, parent );
init();
}
QgsSettings::QgsSettings( const QString &fileName, QSettings::Format format, QObject *parent )
{
mUserSettings = new QSettings( fileName, format, parent );
init();
}
QgsSettings::QgsSettings( QObject *parent )
{
mUserSettings = new QSettings( parent );
init();
}
QgsSettings::~QgsSettings()
{
delete mUserSettings;
delete mGlobalSettings;
}
void QgsSettings::beginGroup( const QString &prefix, const QgsSettings::Section section )
{
QString pKey = prefixedKey( prefix, section );
mUserSettings->beginGroup( pKey );
if ( mGlobalSettings )
{
mGlobalSettings->beginGroup( pKey );
}
}
void QgsSettings::endGroup()
{
mUserSettings->endGroup();
if ( mGlobalSettings )
{
mGlobalSettings->endGroup();
}
}
QString QgsSettings::group() const
{
return mUserSettings->group();
}
QStringList QgsSettings::allKeys() const
{
QStringList keys = mUserSettings->allKeys();
if ( mGlobalSettings )
{
for ( auto &s : mGlobalSettings->allKeys() )
{
if ( ! keys.contains( s ) )
{
keys.append( s );
}
}
}
return keys;
}
QStringList QgsSettings::childKeys() const
{
QStringList keys = mUserSettings->childKeys();
if ( mGlobalSettings )
{
for ( auto &s : mGlobalSettings->childKeys() )
{
if ( ! keys.contains( s ) )
{
keys.append( s );
}
}
}
return keys;
}
QStringList QgsSettings::childGroups() const
{
QStringList keys = mUserSettings->childGroups();
if ( mGlobalSettings )
{
for ( auto &s : mGlobalSettings->childGroups() )
{
if ( ! keys.contains( s ) )
{
keys.append( s );
}
}
}
return keys;
}
QStringList QgsSettings::globalChildGroups() const
{
QStringList keys;
if ( mGlobalSettings )
{
keys = mGlobalSettings->childGroups();
}
return keys;
}
QVariant QgsSettings::value( const QString &key, const QVariant &defaultValue, const QgsSettings::Section section ) const
{
QString pKey = prefixedKey( key, section );
if ( !mUserSettings->value( pKey ).isNull() )
{
return mUserSettings->value( pKey );
}
if ( mGlobalSettings )
{
return mGlobalSettings->value( pKey, defaultValue );
}
return defaultValue;
}
bool QgsSettings::contains( const QString &key, const QgsSettings::Section section ) const
{
QString pKey = prefixedKey( key, section );
return mUserSettings->contains( pKey ) ||
( mGlobalSettings && mGlobalSettings->contains( pKey ) );
}
QString QgsSettings::fileName() const
{
return mUserSettings->fileName();
}
void QgsSettings::sync()
{
mUserSettings->sync();
}
void QgsSettings::remove( const QString &key, const QgsSettings::Section section )
{
QString pKey = prefixedKey( key, section );
mUserSettings->remove( pKey );
}
QString QgsSettings::prefixedKey( const QString &key, const Section section ) const
{
QString prefix;
switch ( section )
{
case Section::Core :
prefix = QStringLiteral( "core" );
break;
case Section::Server :
prefix = QStringLiteral( "server" );
break;
case Section::Gui :
prefix = QStringLiteral( "gui" );
break;
case Section::Plugins :
prefix = QStringLiteral( "plugins" );
break;
case Section::Misc :
prefix = QStringLiteral( "misc" );
break;
case Section::Auth :
prefix = QStringLiteral( "auth" );
break;
case Section::App :
prefix = QStringLiteral( "app" );
break;
case Section::Providers :
prefix = QStringLiteral( "providers" );
break;
case Section::NoSection:
default:
return sanitizeKey( key );
}
return prefix + "/" + sanitizeKey( key );
}
int QgsSettings::beginReadArray( const QString &prefix )
{
int size = mUserSettings->beginReadArray( sanitizeKey( prefix ) );
if ( 0 == size && mGlobalSettings )
{
size = mGlobalSettings->beginReadArray( sanitizeKey( prefix ) );
mUsingGlobalArray = ( size > 0 );
}
return size;
}
void QgsSettings::beginWriteArray( const QString &prefix, int size )
{
mUsingGlobalArray = false;
mUserSettings->beginWriteArray( prefix, size );
}
void QgsSettings::endArray()
{
mUserSettings->endArray();
if ( mGlobalSettings )
{
mGlobalSettings->endArray();
}
mUsingGlobalArray = false;
}
void QgsSettings::setArrayIndex( int i )
{
if ( mGlobalSettings && mUsingGlobalArray )
{
mGlobalSettings->setArrayIndex( i );
}
else
{
mUserSettings->setArrayIndex( i );
}
}
void QgsSettings::setValue( const QString &key, const QVariant &value, const QgsSettings::Section section )
{
// TODO: add valueChanged signal
// Do not store if it hasn't changed from default value
QVariant v = QgsSettings::value( prefixedKey( key, section ) );
QVariant currentValue { QgsSettings::value( prefixedKey( key, section ) ) };
if ( ( currentValue.isValid() || value.isValid() ) && ( currentValue != value ) )
{
mUserSettings->setValue( prefixedKey( key, section ), value );
}
else if ( mGlobalSettings && mGlobalSettings->value( prefixedKey( key, section ) ) == currentValue )
{
mUserSettings->remove( prefixedKey( key, section ) );
}
}
// To lower case and clean the path
QString QgsSettings::sanitizeKey( const QString &key ) const
{
return QDir::cleanPath( key );
}
void QgsSettings::clear()
{
mUserSettings->clear();
}