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
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Build Suite.
**
** 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.
**
****************************************************************************/
#include "profile.h"
#include "qbsassert.h"
#include "settings.h"
#include <logging/translator.h>
#include <tools/error.h>
namespace qbs {
/*!
* \class Profile
* \brief The \c Profile class gives access to the settings of a given profile.
*/
/*!
* \enum Profile::KeySelection
* This enum type specifies whether to enumerate keys recursively.
* \value KeySelectionRecursive Indicates that key enumeration should happen recursively, i.e.
* it should go up the base profile chain.
* \value KeySelectionNonRecursive Indicates that only keys directly attached to a profile
* should be listed.
*/
/*!
* \brief Creates an object giving access to the settings for profile \c name.
*/
Profile::Profile(const QString &name, Settings *settings) : m_name(name), m_settings(settings)
{
QBS_ASSERT(name == cleanName(name), return);
}
bool Profile::exists() const
{
return !m_settings->allKeysWithPrefix(profileKey()).isEmpty();
}
/*!
* \brief Returns the value for property \c key in this profile.
*/
QVariant Profile::value(const QString &key, const QVariant &defaultValue, ErrorInfo *error) const
{
try {
return possiblyInheritedValue(key, defaultValue, QStringList());
} catch (const ErrorInfo &e) {
if (error)
*error = e;
return QVariant();
}
}
/*!
* \brief Gives value \c value to the property \c key in this profile.
*/
void Profile::setValue(const QString &key, const QVariant &value)
{
m_settings->setValue(fullyQualifiedKey(key), value);
if (key == baseProfileKey()) {
QBS_ASSERT(value.toString() == cleanName(value.toString()), return);
}
}
/*!
* \brief Removes a key and the associated value from this profile.
*/
void Profile::remove(const QString &key)
{
m_settings->remove(fullyQualifiedKey(key));
}
/*!
* \brief Returns the name of this profile.
*/
QString Profile::name() const
{
return m_name;
}
/*!
* \brief Returns all property keys in this profile.
* If and only if selection is Profile::KeySelectionRecursive, this will also list keys defined
* in base profiles.
*/
QStringList Profile::allKeys(KeySelection selection, ErrorInfo *error) const
{
try {
return allKeysInternal(selection, QStringList());
} catch (const ErrorInfo &e) {
if (error)
*error = e;
return QStringList();
}
}
/*!
* \brief Returns the name of this profile's base profile.
* The returned value is empty if the profile does not have a base profile.
*/
QString Profile::baseProfile() const
{
return localValue(baseProfileKey()).toString();
}
/*!
* \brief Sets a new base profile for this profile.
*/
void Profile::setBaseProfile(const QString &baseProfile)
{
setValue(baseProfileKey(), baseProfile);
}
/*!
* \brief Removes this profile's base profile setting.
*/
void Profile::removeBaseProfile()
{
remove(baseProfileKey());
}
/*!
* \brief Removes this profile from the settings.
*/
void Profile::removeProfile()
{
m_settings->remove(profileKey());
}
/*!
* \brief Returns a string suitiable as a profile name.
* Removes all dots and replaces them with hyphens.
*/
QString Profile::cleanName(const QString &name)
{
QString newName = name;
return newName.replace(QLatin1Char('.'), QLatin1Char('-'));
}
QString Profile::profileKey() const
{
return QLatin1String("profiles.") + m_name;
}
QString Profile::baseProfileKey()
{
return QLatin1String("baseProfile");
}
void Profile::checkBaseProfileExistence(const Profile &baseProfile) const
{
if (!baseProfile.exists())
throw ErrorInfo(Internal::Tr::tr("Profile \"%1\" has a non-existent base profile \"%2\".").arg(
name(), baseProfile.name()));
}
QVariant Profile::localValue(const QString &key) const
{
return m_settings->value(fullyQualifiedKey(key));
}
QString Profile::fullyQualifiedKey(const QString &key) const
{
return profileKey() + QLatin1Char('.') + key;
}
QVariant Profile::possiblyInheritedValue(const QString &key, const QVariant &defaultValue,
QStringList profileChain) const
{
extendAndCheckProfileChain(profileChain);
const QVariant v = localValue(key);
if (v.isValid())
return v;
const QString baseProfileName = baseProfile();
if (baseProfileName.isEmpty())
return defaultValue;
Profile parentProfile(baseProfileName, m_settings);
checkBaseProfileExistence(parentProfile);
return parentProfile.possiblyInheritedValue(key, defaultValue, profileChain);
}
QStringList Profile::allKeysInternal(Profile::KeySelection selection,
QStringList profileChain) const
{
extendAndCheckProfileChain(profileChain);
QStringList keys = m_settings->allKeysWithPrefix(profileKey());
if (selection == KeySelectionNonRecursive)
return keys;
const QString baseProfileName = baseProfile();
if (baseProfileName.isEmpty())
return keys;
Profile parentProfile(baseProfileName, m_settings);
checkBaseProfileExistence(parentProfile);
keys += parentProfile.allKeysInternal(KeySelectionRecursive, profileChain);
keys.removeDuplicates();
keys.removeOne(baseProfileKey());
keys.sort();
return keys;
}
void Profile::extendAndCheckProfileChain(QStringList &chain) const
{
chain << m_name;
if (Q_UNLIKELY(chain.count(m_name) > 1)) {
throw ErrorInfo(Internal::Tr::tr("Circular profile inheritance. Cycle is '%1'.")
.arg(chain.join(QLatin1String(" -> "))));
}
}
} // namespace qbs
|
