SC::PluginRegistry Struct Reference

Holds a registry of plugins, loading and compiling them on the fly. More...

#include <Plugin.h>

Public Types
enum class	LoadMode {   Load = 0 ,   Reload = 1 }
	Instructs loadPlugin to Load or Reload the plugin. More...

Public Member Functions
void	init (Span< PluginDynamicLibrary > librariesStorage)
	Init a PluginRegistry with some given storage.
Result	close ()
	Unregisters all plugins.
Result	replaceDefinitions (Span< PluginDefinition > &&definitions)
	Appends the definitions to registry.
Result	loadPlugin (const StringView identifier, const PluginCompiler &compiler, const PluginSysroot &sysroot, StringView executablePath, LoadMode loadMode=LoadMode::Load)
	Loads a plugin with given identifier, compiling it with given PluginCompiler.
Result	unloadPlugin (const StringView identifier)
	Unloads an already loaded plugin by its identifier.
Result	removeAllBuildProducts (const StringView identifier)
	Removes all temporary build products of the Plugin with given identifier.
PluginDynamicLibrary *	findPlugin (const StringView identifier)
	Find a PluginDynamicLibrary in the registry with a given identifier.
size_t	getNumberOfEntries () const
	Returns the total number of registry entries (counting both loaded and unloaded plugins)
const PluginIdentifier &	getIdentifierAt (size_t index) const
	Returns the PluginIdentifier corresponding to the index entry of the registry.
const PluginDynamicLibrary &	getPluginDynamicLibraryAt (size_t index)
	Returns the PluginIdentifier corresponding to the index entry of the registry.
void	getPluginsToReloadBecauseOf (StringView relativePath, TimeMs tolerance, Function< void(const PluginIdentifier &)> onPlugin)
	Enumerates all plugins that must be reloaded when relativePath is modified.

Detailed Description

Holds a registry of plugins, loading and compiling them on the fly.

Member Enumeration Documentation

LoadMode

enum class SC::PluginRegistry::LoadMode

strong

Instructs loadPlugin to Load or Reload the plugin.

Member Function Documentation

close()

Result SC::PluginRegistry::close

(

)

Unregisters all plugins.

findPlugin()

PluginDynamicLibrary * SC::PluginRegistry::findPlugin ( const StringView identifier )

nodiscard

Find a PluginDynamicLibrary in the registry with a given identifier.

Parameters

identifier

Identifier of the Plugin to find

Returns

Pointer to the found PluginDynamicLibrary if found (or nullptr)

getIdentifierAt()

const PluginIdentifier & SC::PluginRegistry::getIdentifierAt ( size_t index ) const

inlinenodiscard

Returns the PluginIdentifier corresponding to the index entry of the registry.

getNumberOfEntries()

size_t SC::PluginRegistry::getNumberOfEntries ( ) const

inlinenodiscard

Returns the total number of registry entries (counting both loaded and unloaded plugins)

getPluginDynamicLibraryAt()

const PluginDynamicLibrary & SC::PluginRegistry::getPluginDynamicLibraryAt ( size_t index )

inlinenodiscard

Returns the PluginIdentifier corresponding to the index entry of the registry.

getPluginsToReloadBecauseOf()

void SC::PluginRegistry::getPluginsToReloadBecauseOf	(	StringView	relativePath,
		TimeMs	tolerance,
		Function< void(const PluginIdentifier &)>	onPlugin )

Enumerates all plugins that must be reloaded when relativePath is modified.

Parameters

relativePath	A relative path of the file that has been modified
tolerance	How many milliseconds must be passed to consider a file as modified
onPlugin	Callback that will be called with Plugins affected by the modification

init()

void SC::PluginRegistry::init

(

Span< PluginDynamicLibrary >

librariesStorage

)

Init a PluginRegistry with some given storage.

loadPlugin()

Result SC::PluginRegistry::loadPlugin	(	const StringView	identifier,
		const PluginCompiler &	compiler,
		const PluginSysroot &	sysroot,
		StringView	executablePath,
		LoadMode	loadMode = LoadMode::Load )

Loads a plugin with given identifier, compiling it with given PluginCompiler.

Parameters

identifier	The Plugin identifier that must be loaded
compiler	The compiler used
sysroot	The sysroot (library / include files) used
executablePath	The loader executable path holding symbols used by the plugin
loadMode	If to load or force reload of the plugin

Returns

Valid Result if the plugin has been found, compiled, loaded and inited successfully

removeAllBuildProducts()

Result SC::PluginRegistry::removeAllBuildProducts

(

const StringView

identifier

)

Removes all temporary build products of the Plugin with given identifier.

Parameters

identifier

Identifier of the plugin

Returns

Valid Result if all build products for the given plugin can be successfully removed

replaceDefinitions()

Result SC::PluginRegistry::replaceDefinitions

(

Span< PluginDefinition > &&

definitions

)

Appends the definitions to registry.

Parameters

definitions

found plugin definitions

Returns

Valid Result if definitions have been replaced successfully

unloadPlugin()

Result SC::PluginRegistry::unloadPlugin

(

const StringView

identifier

)

Unloads an already loaded plugin by its identifier.

Parameters

identifier

Identifier of a plugin that must be unloaded

Returns

Valid Result if an already loaded plugin exists with the given identifier and it can be unloaded

---

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

• Plugin.h