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

#include <package_manager.hpp>

Public Member Functions
virtual bool	Initialize ()=0
	Initialize the package manager.

virtual void	Terminate ()=0
	Terminate the package manager.

virtual bool	IsInitialized () const =0
	Check if the package manager is initialized.

virtual bool	Reload ()=0
	Reload the package manager.

virtual void	InstallPackage (std::string_view packageName, std::optional< int32_t > requiredVersion={})=0
	Install a package.

virtual void	InstallPackages (std::span< const std::string > packageNames)=0
	Install multiple packages.

virtual void	InstallAllPackages (const std::filesystem::path &manifestFilePath, bool reinstall)=0
	Install all packages listed in a manifest file.

virtual void	InstallAllPackages (const std::string &manifestUrl, bool reinstall)=0
	Install all packages listed in a manifest file from a remote location.

virtual void	UpdatePackage (std::string_view packageName, std::optional< int32_t > requiredVersion={})=0
	Update a specific package.

virtual void	UpdatePackages (std::span< const std::string > packageNames)=0
	Update multiple packages.

virtual void	UpdateAllPackages ()=0
	Update all installed packages.

virtual void	UninstallPackage (std::string_view packageName)=0
	Uninstall a specific package.

virtual void	UninstallPackages (std::span< const std::string > packageNames)=0
	Uninstall multiple packages.

virtual void	UninstallAllPackages ()=0
	Uninstall all installed packages.

virtual void	SnapshotPackages (const std::filesystem::path &manifestFilePath, bool prettify)=0
	Snapshot the list of installed packages to a manifest file.

virtual bool	HasMissedPackages () const =0
	Check if there are missed packages (not installed but required by other packages).

virtual bool	HasConflictedPackages () const =0
	Check if there are conflicted packages (installed with conflicting versions).

virtual void	InstallMissedPackages ()=0
	Install missed packages.

virtual void	UninstallConflictedPackages ()=0
	Uninstall conflicted packages.

virtual LocalPackagePtr	FindLocalPackage (std::string_view packageName) const =0
	Find a local package by name.

virtual RemotePackagePtr	FindRemotePackage (std::string_view packageName) const =0
	Find a remote package by name.

virtual std::vector< LocalPackagePtr >	GetLocalPackages () const =0
	Get a vector of all local packages.

virtual std::vector< RemotePackagePtr >	GetRemotePackages () const =0
	Get a vector of all remote packages.

Detailed Description

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

Definition at line 36 of file package_manager.hpp.

Member Function Documentation

◆ FindLocalPackage()

virtual LocalPackagePtr plugify::IPackageManager::FindLocalPackage ( std::string_view packageName ) const

pure virtual

Find a local package by name.

Parameters

packageName Name of the package to find.

Returns: Shared pointer to the found local package.

◆ FindRemotePackage()

virtual RemotePackagePtr plugify::IPackageManager::FindRemotePackage ( std::string_view packageName ) const

pure virtual

Find a remote package by name.

Parameters

packageName Name of the package to find.

Returns: Shared pointer to the found remote package.

◆ GetLocalPackages()

virtual std::vector< LocalPackagePtr > plugify::IPackageManager::GetLocalPackages ( ) const

pure virtual

Get a vector of all local packages.

Returns: Vector of local package shared pointers.

◆ GetRemotePackages()

virtual std::vector< RemotePackagePtr > plugify::IPackageManager::GetRemotePackages ( ) const

pure virtual

Get a vector of all remote packages.

Returns: Vector of remote package shared pointers.

◆ HasConflictedPackages()

virtual bool plugify::IPackageManager::HasConflictedPackages ( ) const

pure virtual

Check if there are conflicted packages (installed with conflicting versions).

Returns: True if there are conflicted packages, false otherwise.

◆ HasMissedPackages()

virtual bool plugify::IPackageManager::HasMissedPackages ( ) const

pure virtual

Check if there are missed packages (not installed but required by other packages).

Returns: True if there are missed packages, false otherwise.

◆ Initialize()

virtual bool plugify::IPackageManager::Initialize ( )

pure virtual

Initialize the package manager.

Returns: True if initialization is successful, false otherwise.

◆ InstallAllPackages() [1/2]

virtual void plugify::IPackageManager::InstallAllPackages	(	const std::filesystem::path &	manifestFilePath,
		bool	reinstall
	)

pure virtual

Install all packages listed in a manifest file.

Parameters

manifestFilePath	Path to the manifest file.
reinstall	True to reinstall packages, false otherwise.

◆ InstallAllPackages() [2/2]

virtual void plugify::IPackageManager::InstallAllPackages	(	const std::string &	manifestUrl,
		bool	reinstall
	)

pure virtual

Install all packages listed in a manifest file from a remote location.

Parameters

manifestUrl	URL of the manifest file.
reinstall	True to reinstall packages, false otherwise.

◆ InstallPackage()

virtual void plugify::IPackageManager::InstallPackage	(	std::string_view	packageName,
		std::optional< int32_t >	requiredVersion = `{}`
	)

pure virtual

Install a package.

Parameters

packageName	Name of the package to install.
requiredVersion	Optional required version of the package.

◆ InstallPackages()

virtual void plugify::IPackageManager::InstallPackages ( std::span< const std::string > packageNames )

pure virtual

Install multiple packages.

Parameters

packageNames Span of package names to install.

◆ IsInitialized()

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

pure virtual

Check if the package manager is initialized.

Returns: True if the package manager is initialized, false otherwise.

◆ Reload()

virtual bool plugify::IPackageManager::Reload ( )

pure virtual

Reload the package manager.

Returns: True if was initialized, false otherwise.

◆ SnapshotPackages()

virtual void plugify::IPackageManager::SnapshotPackages	(	const std::filesystem::path &	manifestFilePath,
		bool	prettify
	)

pure virtual

Snapshot the list of installed packages to a manifest file.

Parameters

manifestFilePath	Path to the manifest file.
prettify	True to prettify the output, false for compact format.

◆ UninstallPackage()

virtual void plugify::IPackageManager::UninstallPackage ( std::string_view packageName )

pure virtual

Uninstall a specific package.

Parameters

packageName Name of the package to uninstall.

◆ UninstallPackages()

virtual void plugify::IPackageManager::UninstallPackages ( std::span< const std::string > packageNames )

pure virtual

Uninstall multiple packages.

Parameters

packageNames Span of package names to uninstall.

◆ UpdatePackage()

virtual void plugify::IPackageManager::UpdatePackage	(	std::string_view	packageName,
		std::optional< int32_t >	requiredVersion = `{}`
	)

pure virtual

Update a specific package.

Parameters

packageName	Name of the package to update.
requiredVersion	Optional required version of the package.

◆ UpdatePackages()

virtual void plugify::IPackageManager::UpdatePackages ( std::span< const std::string > packageNames )

pure virtual

Update multiple packages.

Parameters

packageNames Span of package names to update.

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

include/plugify/package_manager.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ FindLocalPackage()

◆ FindRemotePackage()

◆ GetLocalPackages()

◆ GetRemotePackages()

◆ HasConflictedPackages()

◆ HasMissedPackages()

◆ Initialize()

◆ InstallAllPackages() [1/2]

◆ InstallAllPackages() [2/2]

◆ InstallPackage()

◆ InstallPackages()

◆ IsInitialized()

◆ Reload()

◆ SnapshotPackages()

◆ UninstallPackage()

◆ UninstallPackages()

◆ UpdatePackage()

◆ UpdatePackages()