1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of Qt Creator.
7 **
8 ** Commercial License Usage
9 ** Licensees holding valid commercial Qt licenses may use this file in
10 ** accordance with the commercial license agreement provided with the
11 ** Software or, alternatively, in accordance with the terms contained in
12 ** a written agreement between you and The Qt Company. For licensing terms
13 ** and conditions see https://www.qt.io/terms-conditions. For further
14 ** information use the contact form at https://www.qt.io/contact-us.
15 **
16 ** GNU General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU
18 ** General Public License version 3 as published by the Free Software
19 ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
20 ** included in the packaging of this file. Please review the following
21 ** information to ensure the GNU General Public License requirements will
22 ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
23 **
24 ****************************************************************************/
25 
26 #pragma once
27 
28 #include "extensionsystem_global.h"
29 
30 #include <QObject>
31 
32 namespace ExtensionSystem {
33 
34 namespace Internal {
35     class IPluginPrivate;
36     class PluginSpecPrivate;
37 }
38 
39 class PluginManager;
40 class PluginSpec;
41 
42 class EXTENSIONSYSTEM_EXPORT IPlugin : public QObject
43 {
44     Q_OBJECT
45 
46 public:
47     enum ShutdownFlag {
48         SynchronousShutdown,
49         AsynchronousShutdown
50     };
51 
52     IPlugin();
53     ~IPlugin() override;
54 
55     virtual bool initialize(const QStringList &arguments, QString *errorString) = 0;
extensionsInitialized()56     virtual void extensionsInitialized() {}
delayedInitialize()57     virtual bool delayedInitialize() { return false; }
aboutToShutdown()58     virtual ShutdownFlag aboutToShutdown() { return SynchronousShutdown; }
remoteCommand(const QStringList &,const QString &,const QStringList &)59     virtual QObject *remoteCommand(const QStringList & /* options */,
60                                    const QString & /* workingDirectory */,
61                                    const QStringList & /* arguments */) { return nullptr; }
62     virtual QVector<QObject *> createTestObjects() const;
63 
64     PluginSpec *pluginSpec() const;
65 
66 signals:
67     void asynchronousShutdownFinished();
68 
69 private:
70     Internal::IPluginPrivate *d;
71 
72     friend class Internal::PluginSpecPrivate;
73 };
74 
75 } // namespace ExtensionSystem
76