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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0 WITH Qt-GPL-exception-1.0
#pragma once
#include "extensionsystem_global.h"
#include <QHash>
#include <QStaticPlugin>
#include <QString>
#include <QVector>
QT_BEGIN_NAMESPACE
class QRegularExpression;
QT_END_NAMESPACE
namespace ExtensionSystem {
namespace Internal {
class OptionsParser;
class PluginSpecPrivate;
class PluginManagerPrivate;
} // Internal
class IPlugin;
class PluginView;
struct EXTENSIONSYSTEM_EXPORT PluginDependency
{
enum Type {
Required,
Optional,
Test
};
PluginDependency() : type(Required) {}
friend size_t qHash(const PluginDependency &value);
QString name;
QString version;
Type type;
bool operator==(const PluginDependency &other) const;
QString toString() const;
};
struct EXTENSIONSYSTEM_EXPORT PluginArgumentDescription
{
QString name;
QString parameter;
QString description;
};
class EXTENSIONSYSTEM_EXPORT PluginSpec
{
public:
enum State { Invalid, Read, Resolved, Loaded, Initialized, Running, Stopped, Deleted};
~PluginSpec();
// information from the xml file, valid after 'Read' state is reached
QString name() const;
QString version() const;
QString compatVersion() const;
QString vendor() const;
QString copyright() const;
QString license() const;
QString description() const;
QString url() const;
QString category() const;
QString revision() const;
QRegularExpression platformSpecification() const;
bool isAvailableForHostPlatform() const;
bool isRequired() const;
bool isExperimental() const;
bool isEnabledByDefault() const;
bool isEnabledBySettings() const;
bool isEffectivelyEnabled() const;
bool isEnabledIndirectly() const;
bool isForceEnabled() const;
bool isForceDisabled() const;
QVector<PluginDependency> dependencies() const;
QJsonObject metaData() const;
using PluginArgumentDescriptions = QVector<PluginArgumentDescription>;
PluginArgumentDescriptions argumentDescriptions() const;
// other information, valid after 'Read' state is reached
QString location() const;
QString filePath() const;
QStringList arguments() const;
void setArguments(const QStringList &arguments);
void addArgument(const QString &argument);
bool provides(const QString &pluginName, const QString &version) const;
// dependency specs, valid after 'Resolved' state is reached
QHash<PluginDependency, PluginSpec *> dependencySpecs() const;
bool requiresAny(const QSet<PluginSpec *> &plugins) const;
// linked plugin instance, valid after 'Loaded' state is reached
IPlugin *plugin() const;
// state
State state() const;
bool hasError() const;
QString errorString() const;
void setEnabledBySettings(bool value);
static PluginSpec *read(const QString &filePath);
static PluginSpec *read(const QStaticPlugin &plugin);
private:
PluginSpec();
Internal::PluginSpecPrivate *d;
friend class PluginView;
friend class Internal::OptionsParser;
friend class Internal::PluginManagerPrivate;
friend class Internal::PluginSpecPrivate;
};
} // namespace ExtensionSystem
|
