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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#pragma once
#include "extensionsystem_global.h"
#include "iplugin.h"
#include <utils/expected.h>
#include <QHash>
#include <QStaticPlugin>
#include <QString>
#include <QVector>
QT_BEGIN_NAMESPACE
class QRegularExpression;
QT_END_NAMESPACE
class tst_PluginSpec;
namespace ExtensionSystem {
namespace Internal {
class OptionsParser;
class PluginSpecImplPrivate;
class PluginManagerPrivate;
class PluginSpecPrivate;
} // Internal
class PluginView;
struct EXTENSIONSYSTEM_EXPORT PluginDependency
{
enum Type {
Required,
Optional,
Test
};
PluginDependency() : type(Required) {}
QString name;
QString version;
Type type;
bool operator==(const PluginDependency &other) const;
QString toString() const;
};
size_t EXTENSIONSYSTEM_EXPORT qHash(const PluginDependency &value);
struct EXTENSIONSYSTEM_EXPORT PluginArgumentDescription
{
QString name;
QString parameter;
QString description;
};
struct EXTENSIONSYSTEM_EXPORT PerformanceData
{
qint64 load = 0;
qint64 initialize = 0;
qint64 extensionsInitialized = 0;
qint64 delayedInitialize = 0;
qint64 total() const { return load + initialize + extensionsInitialized + delayedInitialize; }
QString summary() const
{
return QString("l: %1ms, i: %2ms, x: %3ms, d: %4ms")
.arg(load, 3)
.arg(initialize, 3)
.arg(extensionsInitialized, 3)
.arg(delayedInitialize, 3);
}
};
class EXTENSIONSYSTEM_EXPORT PluginSpec
{
friend class ::tst_PluginSpec;
friend class Internal::PluginManagerPrivate;
friend class Internal::OptionsParser;
public:
PluginSpec();
virtual ~PluginSpec();
using PluginArgumentDescriptions = QVector<PluginArgumentDescription>;
enum State { Invalid, Read, Resolved, Loaded, Initialized, Running, Stopped, Deleted};
// information read from the plugin, valid after 'Read' state is reached
virtual QString name() const;
virtual QString version() const;
virtual QString compatVersion() const;
virtual QString vendor() const;
virtual QString copyright() const;
virtual QString license() const;
virtual QString description() const;
virtual QString longDescription() const;
virtual QString url() const;
virtual QString category() const;
virtual QString revision() const;
virtual QRegularExpression platformSpecification() const;
virtual bool isAvailableForHostPlatform() const;
virtual bool isRequired() const;
virtual bool isExperimental() const;
virtual bool isDeprecated() const;
virtual bool isEnabledByDefault() const;
virtual bool isEnabledBySettings() const;
virtual bool isEffectivelyEnabled() const;
virtual bool isEnabledIndirectly() const;
virtual bool isForceEnabled() const;
virtual bool isForceDisabled() const;
virtual bool isSoftLoadable() const;
virtual QVector<PluginDependency> dependencies() const;
virtual QJsonObject metaData() const;
virtual PerformanceData &performanceData() const;
virtual PluginArgumentDescriptions argumentDescriptions() const;
virtual QString location() const;
virtual QString filePath() const;
virtual QStringList arguments() const;
virtual void setArguments(const QStringList &arguments);
virtual void addArgument(const QString &argument);
virtual QHash<PluginDependency, PluginSpec *> dependencySpecs() const;
virtual bool provides(const QString &pluginName, const QString &pluginVersion) const;
virtual bool requiresAny(const QSet<PluginSpec *> &plugins) const;
virtual QVector<PluginSpec *> enableDependenciesIndirectly(bool enableTestDependencies);
virtual bool resolveDependencies(const QVector<PluginSpec *> &pluginSpecs);
virtual IPlugin *plugin() const = 0;
virtual State state() const;
virtual bool hasError() const;
virtual QString errorString() const;
static bool isValidVersion(const QString &version);
static int versionCompare(const QString &version1, const QString &version2);
virtual void setEnabledBySettings(bool value);
protected:
virtual void setEnabledByDefault(bool value);
virtual void setEnabledIndirectly(bool value);
virtual void setForceDisabled(bool value);
virtual void setForceEnabled(bool value);
virtual bool loadLibrary() = 0;
virtual bool initializePlugin() = 0;
virtual bool initializeExtensions() = 0;
virtual bool delayedInitialize() = 0;
virtual IPlugin::ShutdownFlag stop() = 0;
virtual void kill() = 0;
virtual void setError(const QString &errorString);
protected:
virtual void setState(State state);
virtual void setLocation(const QString &location);
virtual void setFilePath(const QString &filePath);
virtual Utils::expected_str<void> readMetaData(const QJsonObject &metaData);
Utils::expected_str<void> reportError(const QString &error);
private:
std::unique_ptr<Internal::PluginSpecPrivate> d;
};
EXTENSIONSYSTEM_EXPORT Utils::expected_str<PluginSpec *> readCppPluginSpec(const QString &filePath);
EXTENSIONSYSTEM_EXPORT Utils::expected_str<PluginSpec *> readCppPluginSpec(
const QStaticPlugin &plugin);
class EXTENSIONSYSTEM_TEST_EXPORT CppPluginSpec : public PluginSpec
{
friend EXTENSIONSYSTEM_EXPORT Utils::expected_str<PluginSpec *> readCppPluginSpec(
const QString &filePath);
friend EXTENSIONSYSTEM_EXPORT Utils::expected_str<PluginSpec *> readCppPluginSpec(
const QStaticPlugin &plugin);
public:
~CppPluginSpec() override;
// linked plugin instance, valid after 'Loaded' state is reached
IPlugin *plugin() const override;
bool loadLibrary() override;
bool initializePlugin() override;
bool initializeExtensions() override;
bool delayedInitialize() override;
IPlugin::ShutdownFlag stop() override;
void kill() override;
Utils::expected_str<void> readMetaData(const QJsonObject &pluginMetaData) override;
protected:
CppPluginSpec();
private:
std::unique_ptr<Internal::PluginSpecImplPrivate> d;
friend class PluginView;
friend class Internal::OptionsParser;
friend class Internal::PluginManagerPrivate;
friend class Internal::PluginSpecImplPrivate;
friend class ::tst_PluginSpec;
};
} // namespace ExtensionSystem
|
