plugify::IPlugify Class Reference

Interface for the Plugify system. More...

#include <plugify.hpp>

Public Member Functions
virtual bool	Initialize (const std::filesystem::path &rootDir={})=0
	Initialize the Plugify system. More...
virtual void	Terminate ()=0
	Terminate the Plugify system.
virtual bool	IsInitialized () const =0
	Check if the Plugify system is initialized. More...
virtual void	SetLogger (std::shared_ptr< ILogger > logger)=0
	Set the logger for the Plugify system. More...
virtual void	Log (std::string_view msg, Severity severity)=0
	Log a message with the specified severity level. More...
virtual bool	AddRepository (std::string_view repository)=0
	Add a repository to the config. More...
virtual std::weak_ptr< IPlugifyProvider >	GetProvider () const =0
	Get a weak pointer to the Plugify provider. More...
virtual std::weak_ptr< IPluginManager >	GetPluginManager () const =0
	Get a weak pointer to the Plugin Manager. More...
virtual std::weak_ptr< IPackageManager >	GetPackageManager () const =0
	Get a weak pointer to the Package Manager. More...
virtual const Config &	GetConfig () const =0
	Get the configuration of the Plugify system. More...
virtual Version	GetVersion () const =0
	Get the version information of the Plugify system. More...

Detailed Description

Interface for the Plugify system.

The IPlugify interface provides methods to initialize and terminate the Plugify system, set a logger, get various components, and retrieve configuration information.

Definition at line 25 of file plugify.hpp.

Member Function Documentation

AddRepository()

virtual bool plugify::IPlugify::AddRepository ( std::string_view  repository )

pure virtual

Add a repository to the config.

This method adds a new repository to the config, allowing it to search for packages in the specified repository when performing package-related operations.

Parameters

repository

The URL or path of the repository to add.

Returns

True if the repository was successfully added, false otherwise.

GetConfig()

virtual const Config& plugify::IPlugify::GetConfig ( ) const

pure virtual

Get the configuration of the Plugify system.

Returns

Reference to the configuration.

GetPackageManager()

virtual std::weak_ptr<IPackageManager> plugify::IPlugify::GetPackageManager ( ) const

pure virtual

Get a weak pointer to the Package Manager.

Returns

Weak pointer to the Package Manager.

GetPluginManager()

virtual std::weak_ptr<IPluginManager> plugify::IPlugify::GetPluginManager ( ) const

pure virtual

Get a weak pointer to the Plugin Manager.

Returns

Weak pointer to the Plugin Manager.

GetProvider()

virtual std::weak_ptr<IPlugifyProvider> plugify::IPlugify::GetProvider ( ) const

pure virtual

Get a weak pointer to the Plugify provider.

Returns

Weak pointer to the Plugify provider.

GetVersion()

virtual Version plugify::IPlugify::GetVersion ( ) const

pure virtual

Get the version information of the Plugify system.

Returns

Version information.

Initialize()

virtual bool plugify::IPlugify::Initialize ( const std::filesystem::path &  rootDir = {} )

pure virtual

Initialize the Plugify system.

Parameters

rootDir

The root directory for Plugify (optional).

Returns

True if initialization is successful, false otherwise.

IsInitialized()

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

pure virtual

Check if the Plugify system is initialized.

Returns

True if initialized, false otherwise.

Log()

virtual void plugify::IPlugify::Log ( std::string_view  msg, Severity  severity  )

pure virtual

Log a message with the specified severity level.

Parameters

msg	The log message.
severity	The severity level of the log message.

SetLogger()

virtual void plugify::IPlugify::SetLogger ( std::shared_ptr< ILogger >  logger )

pure virtual

Set the logger for the Plugify system.

Parameters

logger

The logger to set. @noreturn

---

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

• include/plugify/plugify.hpp