1 /****************************************************************************
2 **
3 ** Copyright (C) 2017 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of Qbs.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QBS_PLUGINS_H
41 #define QBS_PLUGINS_H
42 
43 #include "qbs_export.h"
44 
45 #include <memory>
46 #include <string>
47 #include <vector>
48 
49 namespace qbs {
50 namespace Internal {
51 class Logger;
52 
53 typedef void (*QbsPluginLoadFunction)();
54 typedef void (*QbsPluginUnloadFunction)();
55 
56 class QbsPluginManagerPrivate;
57 
58 class QBS_EXPORT QbsPluginManager
59 {
60 public:
61     ~QbsPluginManager();
62     static QbsPluginManager *instance();
63     void registerStaticPlugin(QbsPluginLoadFunction, QbsPluginUnloadFunction);
64     void loadStaticPlugins();
65     void unloadStaticPlugins();
66     void loadPlugins(const std::vector<std::string> &paths, const Logger &logger);
67 
68 protected:
69     QbsPluginManager();
70 
71 private:
72     std::unique_ptr<QbsPluginManagerPrivate> d;
73 };
74 
75 } // namespace Internal
76 } // namespace qbs
77 
78 #ifdef QBS_STATIC_LIB
79 #define QBS_REGISTER_STATIC_PLUGIN(exportmacro, name, load, unload) \
80     extern "C" bool qbs_static_plugin_register_##name = [] { \
81         qbs::Internal::QbsPluginManager::instance()->registerStaticPlugin(load, unload); \
82         return true; \
83     }();
84 #else
85 #define QBS_REGISTER_STATIC_PLUGIN(exportmacro, name, load, unload) \
86     exportmacro void QbsPluginLoad() { load(); } \
87     exportmacro void QbsPluginUnload() { unload(); }
88 #endif
89 
90 #endif
91