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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#include "iplugin.h"
#include <utils/algorithm.h>
/*!
\class ExtensionSystem::IPlugin
\inheaderfile extensionsystem/iplugin.h
\inmodule QtCreator
\ingroup mainclasses
\brief The IPlugin class is an abstract base class that must be implemented
once for each plugin.
A plugin needs to provide meta data in addition to the actual plugin
library, so the plugin manager can find the plugin, resolve its
dependencies, and load it. For more information, see \l{Plugin Meta Data}.
Plugins must provide one implementation of the IPlugin class, located
in a library that matches the \c name attribute given in their
meta data. The IPlugin implementation must be exported and
made known to Qt's plugin system, using the \c Q_PLUGIN_METADATA macro with
an IID set to \c "org.qt-project.Qt.QtCreatorPlugin".
For more information, see \l{Plugin Life Cycle}.
*/
/*!
\enum IPlugin::ShutdownFlag
This enum type holds whether the plugin is shut down synchronously or
asynchronously.
\value SynchronousShutdown
The plugin is shut down synchronously.
\value AsynchronousShutdown
The plugin needs to perform asynchronous
actions before it shuts down.
*/
/*!
\fn bool ExtensionSystem::IPlugin::initialize(const QStringList &arguments, QString *errorString)
Called after the plugin has been loaded and the IPlugin instance
has been created.
The initialize functions of plugins that depend on this plugin are called
after the initialize function of this plugin has been called with
\a arguments. Plugins should initialize their internal state in this
function.
Returns whether initialization succeeds. If it does not, \a errorString
should be set to a user-readable message describing the reason.
\sa extensionsInitialized()
\sa delayedInitialize()
*/
/*!
\fn void ExtensionSystem::IPlugin::initialize()
This function is called as the default implementation of
\c initialize(const QStringList &arguments, QString *errorString) and can be
overwritten instead of the full-args version in cases the parameters
are not used by the implementation and there is no error to report.
\sa extensionsInitialized()
\sa delayedInitialize()
*/
/*!
\fn void ExtensionSystem::IPlugin::extensionsInitialized()
Called after the initialize() function has been called,
and after both the initialize() and \c extensionsInitialized()
functions of plugins that depend on this plugin have been called.
In this function, the plugin can assume that plugins that depend on
this plugin are fully \e {up and running}. It is a good place to
look in the global object pool for objects that have been provided
by weakly dependent plugins.
\sa initialize()
\sa delayedInitialize()
*/
/*!
\fn bool ExtensionSystem::IPlugin::delayedInitialize()
Called after all plugins' extensionsInitialized() function has been called,
and after the \c delayedInitialize() function of plugins that depend on this
plugin have been called.
The plugins' \c delayedInitialize() functions are called after the
application is already running, with a few milliseconds delay to
application startup, and between individual \c delayedInitialize()
function calls. To avoid unnecessary delays, a plugin should return
\c true from the function if it actually implements it, to indicate
that the next plugins' \c delayedInitialize() call should be delayed
a few milliseconds to give input and paint events a chance to be processed.
This function can be used if a plugin needs to do non-trivial setup that doesn't
necessarily need to be done directly at startup, but still should be done within a
short time afterwards. This can decrease the perceived plugin or application startup
time a lot, with very little effort.
\sa initialize()
\sa extensionsInitialized()
*/
/*!
\fn ExtensionSystem::IPlugin::ShutdownFlag ExtensionSystem::IPlugin::aboutToShutdown()
Called during a shutdown sequence in the same order as initialization
before the plugins get deleted in reverse order.
This function should be used to disconnect from other plugins,
hide all UI, and optimize shutdown in general.
If a plugin needs to delay the real shutdown for a while, for example if
it needs to wait for external processes to finish for a clean shutdown,
the plugin can return IPlugin::AsynchronousShutdown from this function. This
will keep the main event loop running after the aboutToShutdown() sequence
has finished, until all plugins requesting asynchronous shutdown have sent
the asynchronousShutdownFinished() signal.
The default implementation of this function does nothing and returns
IPlugin::SynchronousShutdown.
Returns IPlugin::AsynchronousShutdown if the plugin needs to perform
asynchronous actions before shutdown.
\sa asynchronousShutdownFinished()
*/
/*!
\fn QObject *ExtensionSystem::IPlugin::remoteCommand(const QStringList &options,
const QString &workingDirectory,
const QStringList &arguments)
When \QC is executed with the \c -client argument while another \QC instance
is running, this function of the plugin is called in the running instance.
The \a workingDirectory argument specifies the working directory of the
calling process. For example, if you're in a directory, and you execute
\c { qtcreator -client file.cpp}, the working directory of the calling
process is passed to the running instance and \c {file.cpp} is transformed
into an absolute path starting from this directory.
Plugin-specific arguments are passed in \a options, while the rest of the
arguments are passed in \a arguments.
Returns a QObject that blocks the command until it is destroyed, if \c -block
is used.
*/
/*!
\fn void ExtensionSystem::IPlugin::asynchronousShutdownFinished()
Sent by the plugin implementation after an asynchronous shutdown
is ready to proceed with the shutdown sequence.
\sa aboutToShutdown()
*/
namespace ExtensionSystem {
namespace Internal {
class ObjectInitializer
{
public:
ObjectCreator creator;
ObjectDestructor destructor;
ObjectCreationPolicy policy;
};
class IPluginPrivate
{
public:
void tryCreateObjects();
QList<TestCreator> testCreators;
QList<ObjectInitializer> objectInitializers;
QList<std::function<void()>> objectDestructors;
// For debugging purposes:
QList<void *> createdObjects; // Not owned.
};
void IPluginPrivate::tryCreateObjects()
{
QList<ObjectInitializer> unhandledObjectInitializers;
for (const ObjectInitializer &initializer : std::as_const(objectInitializers)) {
if (!initializer.policy.dependsOn.isEmpty()) {
qWarning("Initialization dependencies are not supported yet");
unhandledObjectInitializers.append(initializer);
continue;
}
void *object = initializer.creator();
createdObjects.append(object);
objectDestructors.append([initializer, object] { initializer.destructor(object); });
}
objectInitializers = unhandledObjectInitializers;
}
} // Internal
/*!
\internal
*/
IPlugin::IPlugin()
: d(new Internal::IPluginPrivate())
{
}
/*!
\internal
*/
IPlugin::~IPlugin()
{
for (const std::function<void()> &dtor : std::as_const(d->objectDestructors))
dtor();
delete d;
d = nullptr;
}
void IPlugin::addManagedHelper(const ObjectCreator &creator,
const ObjectDestructor &destructor,
const ObjectCreationPolicy &policy)
{
d->objectInitializers.append({creator, destructor, policy});
}
bool IPlugin::initialize(const QStringList &arguments, QString *errorString)
{
Q_UNUSED(arguments)
Q_UNUSED(errorString)
initialize();
return true;
}
/*!
\internal
*/
void IPlugin::tryCreateObjects()
{
d->tryCreateObjects();
}
/*!
Registers a function object that creates a test object with the owner
\a creator.
The created objects are meant to be passed on to \l QTest::qExec().
The function objects will be called if the user starts \QC with
\c {-test PluginName} or \c {-test all}.
The ownership of the created object is transferred to the plugin.
*/
void IPlugin::addTestCreator(const TestCreator &creator)
{
d->testCreators.append(creator);
}
/*!
\deprecated [10.0] Use \c addTest() instead.
*/
QVector<QObject *> IPlugin::createTestObjects() const
{
return Utils::transform(d->testCreators, &TestCreator::operator());
}
} // ExtensionSystem
|
