plugify::IPluginManager Class Reference

Interface for the plugin manager provided to the user, implemented in the core. More...

#include <plugin_manager.hpp>

Public Member Functions
virtual bool	Initialize ()=0
	Initialize the plugin manager. More...
virtual void	Terminate ()=0
	Terminate the plugin manager.
virtual bool	IsInitialized () const =0
	Check if the plugin manager is initialized. More...
virtual ModuleOpt	FindModule (std::string_view moduleName) const =0
	Find a module by name. More...
virtual ModuleOpt	FindModuleFromId (UniqueId moduleId) const =0
	Find a module by unique identifier. More...
virtual ModuleOpt	FindModuleFromLang (std::string_view moduleLang) const =0
	Find a module by language. More...
virtual ModuleOpt	FindModuleFromPath (const std::filesystem::path &moduleFilePath) const =0
	Find a module by file path. More...
virtual std::vector< ModuleRef >	GetModules () const =0
	Get a vector of references to all modules. More...
virtual PluginOpt	FindPlugin (std::string_view pluginName) const =0
	Find a plugin by name. More...
virtual PluginOpt	FindPluginFromId (UniqueId pluginId) const =0
	Find a plugin by unique identifier. More...
virtual PluginOpt	FindPluginFromDescriptor (const PluginReferenceDescriptorRef &pluginDescriptor) const =0
	Find a plugin by its descriptor. More...
virtual std::vector< PluginRef >	GetPlugins () const =0
	Get a vector of references to all plugins. More...

Detailed Description

Interface for the plugin manager provided to the user, implemented in the core.

Definition at line 36 of file plugin_manager.hpp.

Member Function Documentation

FindModule()

virtual ModuleOpt plugify::IPluginManager::FindModule ( std::string_view  moduleName ) const

pure virtual

Find a module by name.

Parameters

moduleName

Name of the module to find.

Returns

Optional reference to the found module.

FindModuleFromId()

virtual ModuleOpt plugify::IPluginManager::FindModuleFromId ( UniqueId  moduleId ) const

pure virtual

Find a module by unique identifier.

Parameters

moduleId

Unique identifier of the module to find.

Returns

Optional reference to the found module.

FindModuleFromLang()

virtual ModuleOpt plugify::IPluginManager::FindModuleFromLang ( std::string_view  moduleLang ) const

pure virtual

Find a module by language.

Parameters

moduleLang

Language of the module to find.

Returns

Optional reference to the found module.

FindModuleFromPath()

virtual ModuleOpt plugify::IPluginManager::FindModuleFromPath ( const std::filesystem::path &  moduleFilePath ) const

pure virtual

Find a module by file path.

Parameters

moduleFilePath

File path of the module to find.

Returns

Optional reference to the found module.

FindPlugin()

virtual PluginOpt plugify::IPluginManager::FindPlugin ( std::string_view  pluginName ) const

pure virtual

Find a plugin by name.

Parameters

pluginName

Name of the plugin to find.

Returns

Optional reference to the found plugin.

FindPluginFromDescriptor()

virtual PluginOpt plugify::IPluginManager::FindPluginFromDescriptor ( const PluginReferenceDescriptorRef &  pluginDescriptor ) const

pure virtual

Find a plugin by its descriptor.

Parameters

pluginDescriptor

Descriptor of the plugin to find.

Returns

Optional reference to the found plugin.

FindPluginFromId()

virtual PluginOpt plugify::IPluginManager::FindPluginFromId ( UniqueId  pluginId ) const

pure virtual

Find a plugin by unique identifier.

Parameters

pluginId

Unique identifier of the plugin to find.

Returns

Optional reference to the found plugin.

GetModules()

virtual std::vector<ModuleRef> plugify::IPluginManager::GetModules ( ) const

pure virtual

Get a vector of references to all modules.

Returns

Vector of module references.

GetPlugins()

virtual std::vector<PluginRef> plugify::IPluginManager::GetPlugins ( ) const

pure virtual

Get a vector of references to all plugins.

Returns

Vector of plugin references.

Initialize()

virtual bool plugify::IPluginManager::Initialize ( )

pure virtual

Initialize the plugin manager.

Returns

True if initialization is successful, false otherwise.

IsInitialized()

virtual bool plugify::IPluginManager::IsInitialized ( ) const

pure virtual

Check if the plugin manager is initialized.

Returns

True if the plugin manager is initialized, false otherwise.

---

The documentation for this class was generated from the following file:

• include/plugify/plugin_manager.hpp