LogViewer
A modern log viewer with AI-assisted analysis (Qt 6)
Loading...
Searching...
No Matches
PluginManager.hpp
Go to the documentation of this file.
1
8#ifndef PLUGIN_MANAGER_HPP
9#define PLUGIN_MANAGER_HPP
10
11#include "IPlugin.hpp"
12#include "IPluginObserver.hpp"
13#include "Result.hpp"
14#include "Error.hpp"
15#include "PluginEventsC.h"
16#include "PluginHostUiC.h"
17#include <filesystem>
18#include <map>
19#include <memory>
20#include <optional>
21#include <vector>
22
23namespace plugin
24{
25
31{
32 std::string pluginId;
33 std::filesystem::path path;
34 std::unique_ptr<IPlugin> instance;
35 void* libraryHandle = nullptr;
36 void* pluginOpaqueHandle = nullptr;
37 bool autoLoad = false;
38 bool enabled = true;
39 // Optional C-style panel creation function pointers discovered in plugin DLL
40 void* pluginCreateLeftPanel = nullptr;
41 void* pluginCreateRightPanel = nullptr;
42 void* pluginCreateBottomPanel = nullptr;
43 void* pluginCreateMainPanel = nullptr;
44 // Optional destroy function for panel widgets
45 void* pluginDestroyPanelWidget = nullptr;
46 // Optional AI service creation/destruction exported by plugins
47 void* pluginCreateAIService = nullptr;
48 void* pluginDestroyAIService = nullptr;
49 // Opaque handle returned by plugin service creation (if any)
50 void* pluginServiceHandle = nullptr;
51 // Optional plugin function to receive opaque events container from host
53 // Optional plugin function to receive event access callbacks from host
54 void* pluginSetEventsCallbacks = nullptr;
55
56 // Optional plugin function to receive host UI callbacks (e.g. set current event)
57 void* pluginSetHostUiCallbacks = nullptr;
58
59 // Prevent accidental copies — void* handles are not reference-counted.
60 PluginLoadInfo() = default;
65};
66
79{
80public:
85 static PluginManager& GetInstance();
86
87 // Disable copy/move
88 PluginManager(const PluginManager&) = delete;
90
95 void SetPluginsDirectory(const std::filesystem::path& directory);
96
101 std::filesystem::path GetPluginsDirectory() const;
102
107 std::vector<std::filesystem::path> DiscoverPlugins();
108
115 const std::filesystem::path& pluginPath);
116
124 util::Result<bool, error::Error> UnloadPlugin(const std::string& pluginId);
125
136 const std::filesystem::path& sourcePath);
137
143 util::Result<bool, error::Error> UnregisterPlugin(const std::string& pluginId);
144
150 IPlugin* GetPlugin(const std::string& pluginId);
151
156 const std::map<std::string, PluginLoadInfo>& GetLoadedPlugins() const;
157
163 std::vector<std::string> GetPluginsByType(PluginType type) const;
164
170 util::Result<bool, error::Error> EnablePlugin(const std::string& pluginId);
171
177 util::Result<bool, error::Error> DisablePlugin(const std::string& pluginId);
178
184 void SetPluginAutoLoad(const std::string& pluginId, bool autoLoad);
185
190 void RegisterObserver(IPluginObserver* observer);
191
196 void UnregisterObserver(IPluginObserver* observer);
197
203
209
215
221 std::filesystem::path GetPluginConfigDirectory(const std::string& pluginId) const;
222
228 std::filesystem::path GetPluginConfigPath(const std::string& pluginId) const;
229
230private:
231 PluginManager() = default;
233
240 const std::filesystem::path& path,
241 const std::string& expectedApiVersion,
242 /*out*/ void** outLibraryHandle,
243 /*out*/ void** outPluginOpaqueHandle);
244
249 void UnloadLibrary(void* handle);
250
257 void NotifyObservers(PluginEvent event, const std::string& pluginId, IPlugin* plugin);
258
259 std::filesystem::path m_pluginsDirectory;
260 std::map<std::string, PluginLoadInfo> m_plugins;
261 std::map<std::string, std::filesystem::path> m_registeredPlugins; // pluginId -> file path
262 std::filesystem::path m_configPath;
263 std::vector<IPluginObserver*> m_observers;
264 // Opaque events container pointer provided by application (for C API)
265 void* m_eventsContainerOpaque = nullptr;
266 EventsContainer_GetSize_Fn m_eventsGetSizeFn = nullptr;
267 EventsContainer_GetEventJson_Fn m_eventsGetEventJsonFn = nullptr;
268
269 // Optional host UI callbacks provided to plugins
270 void* m_hostUiOpaque = nullptr;
271 PluginHostUiCallbacks m_hostUiCallbacks {0u, nullptr};
272
273 // Cache for plugin configuration loaded before plugins are instantiated
277 };
278 std::map<std::string, PluginConfigCache> m_configCache;
279
280 std::vector<void*> m_dependencyHandles; // Store handles to loaded dependencies
281 // Setter for application to provide opaque events container handle
282public:
283 void SetEventsContainerOpaque(void* handle) { m_eventsContainerOpaque = handle; }
284 void SetEventsCallbacks(EventsContainer_GetSize_Fn sizeFn, EventsContainer_GetEventJson_Fn getEventFn)
285 {
286 m_eventsGetSizeFn = sizeFn;
287 m_eventsGetEventJsonFn = getEventFn;
288 }
289
290 void SetHostUiCallbacks(void* hostOpaque, const PluginHostUiCallbacks& callbacks)
291 {
292 m_hostUiOpaque = hostOpaque;
293 m_hostUiCallbacks = callbacks;
294
295 // If plugins are already enabled, push the callbacks immediately.
296 // This avoids ordering issues (e.g. host sets callbacks after plugin enable).
297 if (!m_hostUiOpaque || m_hostUiCallbacks.size < sizeof(PluginHostUiCallbacks))
298 return;
299
300 using SetHostUiCallbacksFn = void(*)(void*, void*, const PluginHostUiCallbacks*);
301 for (auto& [id, info] : m_plugins)
302 {
303 (void)id;
304 if (!info.enabled) continue;
305 if (!info.pluginOpaqueHandle) continue;
306 if (!info.pluginSetHostUiCallbacks) continue;
307 auto fn = reinterpret_cast<SetHostUiCallbacksFn>(info.pluginSetHostUiCallbacks);
308 try { fn(info.pluginOpaqueHandle, m_hostUiOpaque, &m_hostUiCallbacks); } catch(...) {}
309 }
310 }
311};
312
313} // namespace plugin
314
315#endif // PLUGIN_MANAGER_HPP
Error handling utilities.
Definition Error.hpp:62
Definition IPluginObserver.hpp:13
Definition IPlugin.hpp:36
Manages plugin lifecycle and registration.
Definition PluginManager.hpp:79
~PluginManager()
Definition PluginManager.cpp:401
std::filesystem::path m_pluginsDirectory
Definition PluginManager.hpp:259
util::Result< bool, error::Error > SaveConfiguration()
Saves plugin configuration.
Definition PluginManager.cpp:1609
std::filesystem::path GetPluginConfigPath(const std::string &pluginId) const
Gets the configuration file path for a specific plugin.
Definition PluginManager.cpp:1686
void UnloadLibrary(void *handle)
Unloads dynamic library.
Definition PluginManager.cpp:1035
const std::map< std::string, PluginLoadInfo > & GetLoadedPlugins() const
Gets all loaded plugins.
Definition PluginManager.cpp:1327
void * m_eventsContainerOpaque
Definition PluginManager.hpp:265
void RegisterObserver(IPluginObserver *observer)
Registers an observer for plugin lifecycle events.
Definition PluginManager.cpp:1520
std::map< std::string, std::filesystem::path > m_registeredPlugins
Definition PluginManager.hpp:261
void SetHostUiCallbacks(void *hostOpaque, const PluginHostUiCallbacks &callbacks)
Definition PluginManager.hpp:290
void UnregisterObserver(IPluginObserver *observer)
Unregisters an observer.
Definition PluginManager.cpp:1529
PluginManager(const PluginManager &)=delete
util::Result< std::unique_ptr< IPlugin >, error::Error > LoadPluginLibrary(const std::filesystem::path &path, const std::string &expectedApiVersion, void **outLibraryHandle, void **outPluginOpaqueHandle)
Loads plugin from dynamic library.
Definition PluginManager.cpp:682
std::filesystem::path GetPluginConfigDirectory(const std::string &pluginId) const
Gets the configuration directory path for a specific plugin.
Definition PluginManager.cpp:1678
EventsContainer_GetEventJson_Fn m_eventsGetEventJsonFn
Definition PluginManager.hpp:267
std::filesystem::path GetPluginsDirectory() const
Gets the plugins directory.
Definition PluginManager.cpp:431
void SetPluginAutoLoad(const std::string &pluginId, bool autoLoad)
Sets plugin auto-load preference.
Definition PluginManager.cpp:1510
util::Result< std::string, error::Error > LoadPlugin(const std::filesystem::path &pluginPath)
Loads a plugin from file.
Definition PluginManager.cpp:483
std::map< std::string, PluginLoadInfo > m_plugins
Definition PluginManager.hpp:260
util::Result< std::string, error::Error > RegisterPlugin(const std::filesystem::path &sourcePath)
Registers a plugin file (copies to user plugins directory)
Definition PluginManager.cpp:1105
util::Result< bool, error::Error > UnloadPlugin(const std::string &pluginId)
Unloads a plugin and removes it from GetLoadedPlugins()
Definition PluginManager.cpp:1049
PluginManager & operator=(const PluginManager &)=delete
void SetPluginsDirectory(const std::filesystem::path &directory)
Sets the plugins directory.
Definition PluginManager.cpp:424
std::vector< IPluginObserver * > m_observers
Definition PluginManager.hpp:263
static PluginManager & GetInstance()
Gets singleton instance.
Definition PluginManager.cpp:377
util::Result< bool, error::Error > DisablePlugin(const std::string &pluginId)
Disables a plugin (unloads it but keeps file registered)
Definition PluginManager.cpp:1471
void NotifyObservers(PluginEvent event, const std::string &pluginId, IPlugin *plugin)
Notifies all observers of a plugin event.
Definition PluginManager.cpp:1539
EventsContainer_GetSize_Fn m_eventsGetSizeFn
Definition PluginManager.hpp:266
std::vector< void * > m_dependencyHandles
Definition PluginManager.hpp:280
IPlugin * GetPlugin(const std::string &pluginId)
Gets a plugin by ID.
Definition PluginManager.cpp:1317
util::Result< bool, error::Error > EnablePlugin(const std::string &pluginId)
Enables a plugin (loads and initializes it)
Definition PluginManager.cpp:1347
std::vector< std::string > GetPluginsByType(PluginType type) const
Gets plugins by type.
Definition PluginManager.cpp:1332
void * m_hostUiOpaque
Definition PluginManager.hpp:270
void SetEventsCallbacks(EventsContainer_GetSize_Fn sizeFn, EventsContainer_GetEventJson_Fn getEventFn)
Definition PluginManager.hpp:284
util::Result< bool, error::Error > UnregisterPlugin(const std::string &pluginId)
Unregisters a plugin (removes from user plugins directory)
Definition PluginManager.cpp:1220
std::vector< std::filesystem::path > DiscoverPlugins()
Discovers plugins in the plugins directory.
Definition PluginManager.cpp:436
std::filesystem::path m_configPath
Definition PluginManager.hpp:262
void SetEventsContainerOpaque(void *handle)
Definition PluginManager.hpp:283
util::Result< bool, error::Error > LoadConfiguration()
Loads plugin configuration.
Definition PluginManager.cpp:1550
PluginHostUiCallbacks m_hostUiCallbacks
Definition PluginManager.hpp:271
util::Result< bool, error::Error > ValidateDependencies() const
Validates all plugin dependencies.
Definition PluginManager.cpp:1656
std::map< std::string, PluginConfigCache > m_configCache
Definition PluginManager.hpp:278
Definition Result.hpp:15
Definition IFieldConversionPlugin.hpp:8
PluginType
Definition IPlugin.hpp:30
Detailed information about plugin state change.
Definition PluginEventBus.hpp:56
Information about a loaded plugin.
Definition PluginManager.hpp:31
void * pluginCreateMainPanel
Definition PluginManager.hpp:43
void * pluginSetHostUiCallbacks
Definition PluginManager.hpp:57
void * pluginDestroyAIService
Definition PluginManager.hpp:48
std::filesystem::path path
Plugin file path.
Definition PluginManager.hpp:33
PluginLoadInfo(const PluginLoadInfo &)=delete
bool autoLoad
Auto-load on startup.
Definition PluginManager.hpp:37
void * pluginOpaqueHandle
Raw opaque handle returned by C-ABI plugins.
Definition PluginManager.hpp:36
bool enabled
Plugin enabled.
Definition PluginManager.hpp:38
PluginLoadInfo & operator=(PluginLoadInfo &&)=default
void * pluginCreateLeftPanel
Definition PluginManager.hpp:40
void * pluginCreateAIService
Definition PluginManager.hpp:47
void * libraryHandle
Dynamic library handle.
Definition PluginManager.hpp:35
void * pluginCreateRightPanel
Definition PluginManager.hpp:41
PluginLoadInfo & operator=(const PluginLoadInfo &)=delete
std::string pluginId
Plugin ID.
Definition PluginManager.hpp:32
void * pluginSetAIEventsContainer
Definition PluginManager.hpp:52
std::unique_ptr< IPlugin > instance
Plugin instance.
Definition PluginManager.hpp:34
PluginLoadInfo(PluginLoadInfo &&)=default
void * pluginCreateBottomPanel
Definition PluginManager.hpp:42
void * pluginSetEventsCallbacks
Definition PluginManager.hpp:54
void * pluginServiceHandle
Definition PluginManager.hpp:50
void * pluginDestroyPanelWidget
Definition PluginManager.hpp:45
Definition PluginManager.hpp:274
bool enabled
Definition PluginManager.hpp:275
bool autoLoad
Definition PluginManager.hpp:276