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
|
/*
* Copyright (c) 2007, 2015, Oracle and/or its affiliates. All rights reserved.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; version 2 of the
* License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA
*/
#pragma once
#include <grtpp.h>
#include <grtpp_module_cpp.h>
#include "grts/structs.h"
#include "grts/structs.app.h"
#include "wbpublic_public_interface.h"
#ifdef _WIN32
typedef uintptr_t NativeHandle;
#else
// Don't make this "id" on OSX or we risk a strong reference cycle.
typedef void* NativeHandle;
#endif
// GUI plugins with native code that are loaded and managed by the Workbench process
#define GUI_PLUGIN_TYPE "gui"
// GUI plugins that are standalone and can be called directly by the module system (eg mforms)
#define STANDALONE_GUI_PLUGIN_TYPE "standalone"
// normal plugins with no UI
#define NORMAL_PLUGIN_TYPE "normal"
// internal plugins without dedicated assemblies (usually is a part of backend)
#define INTERNAL_PLUGIN_TYPE "internal"
// custom plugins (validation on load is not applied)
#define CUSTOM_PLUGIN_TYPE "custom"
namespace bec {
#define PluginManager_VERSION "1.0.0"
class BaseEditor;
class GRTManager;
typedef enum {
NoFlags= 0,
ForceNewWindowFlag = (1<<0),
StandaloneWindowFlag = (1<<1)
} GUIPluginFlags;
class WBPUBLICBACKEND_PUBLIC_FUNC ArgumentPool : public std::map<std::string, grt::ValueRef>
{
public:
grt::BaseListRef build_argument_list(const app_PluginRef &plugin);
static app_PluginFileInputRef needs_file_input(const app_PluginRef &plugin);
static bool needs_simple_input(const app_PluginRef &plugin, const std::string &name);
grt::ValueRef find_match(const app_PluginInputDefinitionRef &pdef, std::string &searched_key_name_ret, bool strict=true) const;
void dump_keys(const boost::function<void (std::string)> &dump_function) const;
void add_file_input(const app_PluginFileInputRef &pdef,
const std::string &value);
void add_simple_value(const std::string &name, const grt::ValueRef &value);
void add_list_for_selection(const std::string &source_name,
const grt::ObjectListRef &list);
void add_entries_for_object(const std::string &name,
const grt::ObjectRef &object,
const std::string &topmost_class_name="");
};
class WBPUBLICBACKEND_PUBLIC_FUNC PluginManagerImpl : public grt::CPPModule
{
typedef grt::CPPModule superclass;
public:
typedef boost::function<NativeHandle (GRTManager*, grt::Module*, std::string, std::string, grt::BaseListRef, GUIPluginFlags)> OpenGUIPluginSlot;
typedef boost::function<void (NativeHandle)> ShowGUIPluginSlot;
typedef boost::function<void (NativeHandle)> CloseGUIPluginSlot;
public:
// NOTE: not to be directly instantiated
PluginManagerImpl(grt::CPPModuleLoader *loader);
virtual ~PluginManagerImpl() {}
void set_registry_paths(const std::string &plugins_path,
const std::string &groups_path);
void rescan_plugins();
DEFINE_INIT_MODULE(PluginManager_VERSION, "MySQL AB", grt::ModuleImplBase,
DECLARE_MODULE_FUNCTION(PluginManagerImpl::show_plugin),
DECLARE_MODULE_FUNCTION(PluginManagerImpl::close_plugin)
);
// generic plugin interface
// ordered by rating
std::vector<app_PluginRef> get_plugins_for_objects(const grt::ObjectListRef &objects,
const std::string &group="");
std::vector<app_PluginRef> get_plugins_for_group(const std::string &group);
app_PluginRef get_plugin(const std::string &name);
std::string open_plugin(const app_PluginRef &plugin, const grt::BaseListRef &args);
std::string open_gui_plugin(const app_PluginRef &plugin, const grt::BaseListRef &args, GUIPluginFlags flags);
std::string open_plugin_with_object(const app_PluginRef &plugin, GrtObjectRef object);
std::string open_plugin_with_selection(const app_PluginRef &plugin, const grt::ObjectListRef &selection);
std::string open_plugin_with_file(const app_PluginRef &plugin, const std::string &filename);
grt::ValueRef execute_plugin_function(const app_PluginRef &plugin, const grt::BaseListRef &args);
int show_plugin(const std::string &handle);
int close_plugin(const std::string &handle);
app_PluginRef select_plugin_for_input(const std::string &group, const grt::BaseListRef &args);
bool check_plugin_input(const app_PluginInputDefinitionRef &def, const grt::ValueRef &value);
void set_plugin_enabled(const app_PluginRef &plugin, bool flag);
bool plugin_enabled(const std::string &plugin_name);
public: // for frontends
void register_plugins(grt::ListRef<app_Plugin> plugins);
void set_gui_plugin_callbacks(const OpenGUIPluginSlot &open,
const ShowGUIPluginSlot &show,
const CloseGUIPluginSlot &close);
void forget_gui_plugin_handle(NativeHandle handle);
void close_and_forget_gui_plugin(NativeHandle handle);
std::vector<NativeHandle> get_similar_open_plugins(grt::Module*, const std::string &class_name, grt::BaseListRef);
grt::ListRef<app_Plugin> get_plugin_list(const std::string &group="");
protected:
GRTManager *_grtm;
std::string _registry_path;
std::string _group_registry_path;
OpenGUIPluginSlot _open_gui_plugin_slot;
ShowGUIPluginSlot _show_gui_plugin_slot;
CloseGUIPluginSlot _close_gui_plugin_slot;
// plugin-name+oid -> editor handle
std::map<std::string, NativeHandle> _open_gui_plugins;
// plugin name -> module name
std::map<std::string, std::string> _plugin_source_module;
private:
grt::ListRef<app_PluginGroup> get_plugin_groups();
bool check_input_for_plugin(const app_PluginRef &plugin, const grt::BaseListRef &args);
grt::ValueRef open_normal_plugin_grt(grt::GRT *grt, const app_PluginRef &plugin, const grt::BaseListRef &args);
std::string open_gui_plugin_main(const app_PluginRef &plugin, const grt::BaseListRef &args, GUIPluginFlags flags);
int show_gui_plugin_main(const std::string &handle);
int close_gui_plugin_main(const std::string &handle);
void open_standalone_plugin_main(const app_PluginRef &plugin, const grt::BaseListRef &args);
app_PluginGroupRef get_group(const std::string &path);
void add_plugin_to_group(const app_PluginRef &plugin, const std::string &path);
bool check_plugin_validity(const app_PluginRef &plugin, grt::Module *module);
grt::StringListRef get_disabled_plugin_names();
};
typedef ::bec::PluginManagerImpl PluginManager;
};
|
