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
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#include "iplugin.h"
#include "iplugin_p.h"
#include "pluginmanager.h"
#include "pluginspec.h"
/*!
\class ExtensionSystem::IPlugin
\mainclass
\brief The IPlugin class is the base class for all plugins.
The IPlugin class is an abstract class that must be implemented
once for each plugin.
A plugin consists of two parts: A description file, and a library
that at least contains the IPlugin implementation.
\tableofcontents
\section1 Plugin Specification
A plugin needs to provide a plugin specification file 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 Specifications}.
\section1 Plugin Implementation
Plugins must provide one implementation of the IPlugin class, located
in a library that matches the \c name attribute given in their
XML description. 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".
After the plugins' XML files have been read, and dependencies have been
found, the plugin loading is done in three phases:
\list 1
\li All plugin libraries are loaded in \e{root-to-leaf} order of the
dependency tree.
\li All plugins' initialize functions are called in \e{root-to-leaf} order
of the dependency tree. This is a good time to create objects
needed by other plugins and register them via appropriate core functions
or, if a weak dependency is neceessary to be implemented, to put
them into the global object pool.
\li All plugins' extensionsInitialized functions are called in \e{leaf-to-root}
order of the dependency tree. At this point, plugins can
be sure that all plugins that depend on this plugin have
been initialized completely and objects these plugins wish to
share have been registered or are available in the global object pool.
\endlist
If library loading or initialization of a plugin fails, all plugins
that depend on that plugin also fail.
*/
/*!
\fn bool IPlugin::initialize(const QStringList &arguments, QString *errorString)
\brief 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. Plugins should initialize their internal state in this
function. Returns if initialization of successful. If it wasn't successful,
the \a errorString should be set to a user-readable message
describing the reason.
\sa extensionsInitialized()
\sa delayedInitialize()
*/
/*!
\fn void IPlugin::extensionsInitialized()
\brief Called after the IPlugin::initialize() function has been called,
and after both the IPlugin::initialize() and IPlugin::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 '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 IPlugin::delayedInitialize()
\brief Called after all plugins' IPlugin::extensionsInitialized() function has been called,
and after the IPlugin::delayedInitialize() function of plugins that depend on this plugin
have been called.
The plugins' delayedInitialize() functions are called after the application is already running,
with a few milliseconds delay to application startup, and between individual delayedInitialize
function calls. To avoid unnecessary delays, a plugin should return true from the function if it
actually implements it, to indicate that the next plugins' 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 felt plugin/application startup
time a lot, with very little effort.
\sa initialize()
\sa extensionsInitialized()
*/
/*!
\fn IPlugin::ShutdownFlag IPlugin::aboutToShutdown()
\brief 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 AsynchronousShutdown 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 performing the shutdown.
\sa asynchronousShutdownFinished()
*/
/*!
\fn QObject *IPlugin::remoteCommand(const QStringList &options, const QStringList &arguments)
\brief When \QC is executed with the -client argument while already another instance of \QC
is running, this function of plugins is called in the running instance.
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 -block is used.
\sa PluginManager::serializedArguments()
*/
/*!
\fn void IPlugin::asynchronousShutdownFinished()
Sent by the plugin implementation after a asynchronous shutdown
is ready to proceed with the shutdown sequence.
\sa aboutToShutdown()
*/
using namespace ExtensionSystem;
/*!
\fn IPlugin::IPlugin()
\internal
*/
IPlugin::IPlugin()
: d(new Internal::IPluginPrivate())
{
}
/*!
\fn IPlugin::~IPlugin()
\internal
*/
IPlugin::~IPlugin()
{
delete d;
d = nullptr;
}
/*!
\fn QVector<QObject *> IPlugin::createTestObjects() const
Returns objects that are meant to be passed on to QTest::qExec().
This function will be called if the user starts \QC with '-test PluginName' or '-test all'.
The ownership of returned objects is transferred to caller.
*/
QVector<QObject *> IPlugin::createTestObjects() const
{
return {};
}
/*!
\fn PluginSpec *IPlugin::pluginSpec() const
Returns the PluginSpec corresponding to this plugin.
This is not available in the constructor.
*/
PluginSpec *IPlugin::pluginSpec() const
{
return d->pluginSpec;
}
|
