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
|
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Author: Milian Wolff, KDAB (milian.wolff@kdab.com)
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Lesser General Public License Usage
**
** 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, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**************************************************************************/
#ifndef ANALYZER_INTERNAL_ANALYZERSETTINGS_H
#define ANALYZER_INTERNAL_ANALYZERSETTINGS_H
#include <QtCore/QObject>
#include <QtCore/QVariant>
#include "analyzerbase_global.h"
#include <projectexplorer/runconfiguration.h>
namespace Analyzer {
class AnalyzerSettings;
/**
* Utility function to set @p val if @p key is present in @p map.
*/
template <typename T> static void setIfPresent(const QVariantMap &map, const QString &key, T *val)
{
if (!map.contains(key))
return;
*val = map.value(key).template value<T>();
}
/**
* Subclass this to add configuration to your analyzer tool.
*
* If global and project-specific settings differ for your tool,
* create one subclass for each.
*/
class ANALYZER_EXPORT AbstractAnalyzerSubConfig : public QObject
{
Q_OBJECT
public:
AbstractAnalyzerSubConfig(QObject *parent);
virtual ~AbstractAnalyzerSubConfig();
/// return a list of default values
virtual QVariantMap defaults() const = 0;
/// convert current configuration into map for storage
virtual QVariantMap toMap() const = 0;
/// read configuration from @p map
virtual bool fromMap(const QVariantMap &map) = 0;
/// unique ID for this configuration
virtual QString id() const = 0;
/// user readable display name for this configuration
virtual QString displayName() const = 0;
/// create a configuration widget for this configuration
virtual QWidget *createConfigWidget(QWidget *parent) = 0;
};
/**
* Interface for registering configuration to the Manager.
* You probably want to use the template class below.
*/
class ANALYZER_EXPORT AbstractAnalyzerSubConfigFactory
{
public:
AbstractAnalyzerSubConfigFactory(){}
virtual ~AbstractAnalyzerSubConfigFactory(){}
virtual AbstractAnalyzerSubConfig *createGlobalSubConfig(QObject *parent) = 0;
virtual AbstractAnalyzerSubConfig *createProjectSubConfig(QObject *parent) = 0;
};
/**
* Makes it easy to register custom configuration for a tool:
*
* @code
* bool MemcheckPlugin::initialize(const QStringList &arguments, QString *errorString)
* {
* typedef AnalyzerSubConfigFactory<YourGlobalSettings, YourProjectSettings> YourConfigFactory;
* AnalyzerGlobalSettings::instance()->registerSubConfigFactory(new YourConfigFactory);
* }
* @endcode
*/
template<class GlobalConfigT, class ProjectConfigT>
class ANALYZER_EXPORT AnalyzerSubConfigFactory : public AbstractAnalyzerSubConfigFactory
{
public:
AnalyzerSubConfigFactory(){}
AbstractAnalyzerSubConfig *createGlobalSubConfig(QObject *parent)
{
return new GlobalConfigT(parent);
}
AbstractAnalyzerSubConfig *createProjectSubConfig(QObject *parent)
{
return new ProjectConfigT(parent);
}
};
/**
* Shared interface for the global and per-project settings.
*
* Use this to get the subConfig for your tool.
*/
class ANALYZER_EXPORT AnalyzerSettings : public QObject
{
Q_OBJECT
public:
virtual ~AnalyzerSettings();
template<class T>
T *subConfig() const
{
return findChild<T *>();
}
QList<AbstractAnalyzerSubConfig *> subConfigs() const
{
return findChildren<AbstractAnalyzerSubConfig *>();
}
QVariantMap defaults() const;
virtual QVariantMap toMap() const;
protected:
void addSubConfig(AbstractAnalyzerSubConfig *config)
{
config->setParent(this);
}
virtual bool fromMap(const QVariantMap &map);
AnalyzerSettings(QObject *parent);
};
// global and local settings are loaded and saved differently, and they also handle suppressions
// differently.
/**
* Global settings
*
* To access your custom configuration use:
* @code
* AnalyzerGlobalSettings::instance()->subConfig<YourGlobalConfig>()->...
* @endcode
*/
class ANALYZER_EXPORT AnalyzerGlobalSettings : public AnalyzerSettings
{
Q_OBJECT
public:
static AnalyzerGlobalSettings *instance();
~AnalyzerGlobalSettings();
void writeSettings() const;
void readSettings();
void registerSubConfigFactory(AbstractAnalyzerSubConfigFactory *factory);
QList<AbstractAnalyzerSubConfigFactory *> subConfigFactories() const;
private:
AnalyzerGlobalSettings(QObject *parent);
static AnalyzerGlobalSettings *m_instance;
QList<AbstractAnalyzerSubConfigFactory *> m_subConfigFactories;
};
/**
* Settings associated with a single project/run configuration
*
* To access your custom configuration use:
* @code
* ProjectExplorer::RunConfiguration *rc = ...;
* rc->extraAspect<AnalyzerProjectSettings>()->subConfig<YourProjectConfig>()->...
* @endcode
*/
class ANALYZER_EXPORT AnalyzerProjectSettings : public AnalyzerSettings, public ProjectExplorer::IRunConfigurationAspect
{
Q_OBJECT
public:
AnalyzerProjectSettings(QObject *parent = 0);
virtual ~AnalyzerProjectSettings();
QString displayName() const;
virtual QVariantMap toMap() const;
protected:
virtual bool fromMap(const QVariantMap &map);
};
}
#endif // ANALYZER_INTERNAL_ANALYZERSETTINGS_H
|
