Plug-ins cache. More...

#include <PluginCache.hpp>

Inheritance diagram for castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >:

[legend]

Collaboration diagram for castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >:

[legend]

Public Types
using	ElementT = castor3d::Plugin

using	ElementKeyT = String

using	ElementCacheTraitsT = castor3d::PluginCacheTraits

using	ElementCacheT = ResourceCacheBaseT< ElementT, ElementKeyT, ElementCacheTraitsT >

using	ElementPtrT = typename ElementCacheT::ElementPtrT

using	ElementContT = typename ElementCacheT::ElementContT

using	ElementInitialiserT = typename ElementCacheT::ElementInitialiserT

using	ElementCleanerT = typename ElementCacheT::ElementCleanerT

using	ElementMergerT = typename ElementCacheT::ElementMergerT

Public Types inherited from castor::ResourceCacheBaseT< castor3d::Plugin, String, castor3d::PluginCacheTraits >
using	ElementT

using	ElementKeyT

using	ElementCacheTraitsT

using	ElementCacheBaseT

using	ElementCacheT

using	ElementPtrT

using	ElementObsT

using	ElementContT

using	ElementInitialiserT

using	ElementCleanerT

using	ElementMergerT

Public Member Functions
C3D_API	ResourceCacheT (castor3d::Engine &engine)
	Constructor.

C3D_API void	clear () noexcept
	Flushes the collection.

C3D_API ElementObsT	loadPlugin (String const &pluginName, Path const &pathFolder) noexcept
	Loads a plug-in, given the plug-in name (ex: libGlRenderSystem.dll => GlRenderSystem)

C3D_API ElementObsT	loadPlugin (Path const &fileFullPath) noexcept
	Loads a plug-in, given the plug-in file's full path.

C3D_API castor::StringMap< castor3d::PluginRPtr >	getPlugins (castor3d::PluginType type)
	Retrieves the plug-ins of given type.

C3D_API void	loadAllPlugins (Path const &folder)
	Loads all the plug-ins located in working folder.

Public Member Functions inherited from castor::ResourceCacheBaseT< castor3d::Plugin, String, castor3d::PluginCacheTraits >
	ResourceCacheBaseT (ResourceCacheBaseT const &)=delete

	ResourceCacheBaseT (ResourceCacheBaseT &&) noexcept=delete

ResourceCacheBaseT &	operator= (ResourceCacheBaseT const &)=delete

ResourceCacheBaseT &	operator= (ResourceCacheBaseT &&) noexcept=delete

void	cleanup () noexcept
	Sets all the elements to be cleaned up.

void	clear () noexcept
	Flushes the collection.

ElementPtrT	create (ElementKeyT const &name, ParametersT &&... parameters) const
	Creates an element.

ElementObsT	tryAdd (ElementKeyT const &name, ElementPtrT &element, bool initialise=false)
	Adds an element.

ElementObsT	tryAdd (ElementKeyT const &name, bool initialise, ElementObsT &created, ParametersT &&... parameters)
	Add an element, constructed in-place.

ElementObsT	tryAddNoLock (ElementKeyT const &name, ElementPtrT &element, bool initialise=false)
	Adds an element.

ElementObsT	tryAddNoLock (ElementKeyT const &name, bool initialise, ElementObsT &created, ParametersT &&... parameters)
	Add an element, constructed in-place.

ElementObsT	add (ElementKeyT const &name, ElementPtrT &element, bool initialise=true)
	Logging version of tryAdd.

ElementObsT	add (ElementKeyT const &name, ParametersT &&... parameters)
	Logging version of tryAdd.

ElementObsT	addNoLock (ElementKeyT const &name, ElementPtrT &element, bool initialise=true)
	Logging version of tryAdd.

ElementObsT	addNoLock (ElementKeyT const &name, ParametersT &&... parameters)
	Logging version of tryAdd.

ElementPtrT	tryRemove (ElementKeyT const &name, bool cleanup=false) noexcept
	Removes an element, given a name.

ElementPtrT	tryRemoveNoLock (ElementKeyT const &name, bool cleanup=false) noexcept
	Removes an element, given a name.

ElementPtrT	remove (ElementKeyT const &name, bool cleanup=false) noexcept
	Logging version of tryRemove.

ElementPtrT	removeNoLock (ElementKeyT const &name, bool cleanup=false) noexcept
	Logging version of tryRemove.

void	rename (ElementKeyT const &oldName, ElementKeyT const &newName)
	Renames a resource.

ElementObsT	tryFind (ElementKeyT const &name) const noexcept
	Looks for an element with given name.

ElementObsT	tryFindNoLock (ElementKeyT const &name) const noexcept
	Looks for an element with given name.

ElementObsT	find (ElementKeyT const &name) const
	Logging version of tryRemove.

ElementObsT	findNoLock (ElementKeyT const &name) const
	Logging version of tryRemove.

void	mergeInto (ElementCacheBaseT &destination)
	Merges this cache's elements to the one given.

void	forEach (FuncType func) const

void	forEach (FuncType func)

uint32_t	getObjectCount () const noexcept

uint32_t	getObjectCountNoLock () const noexcept

String const &	getObjectTypeName () const noexcept

bool	has (ElementKeyT const &name) const noexcept

bool	hasNoLock (ElementKeyT const &name) const noexcept

bool	isEmpty () const noexcept

bool	isEmptyNoLock () const noexcept

void	lock () const

void	unlock () const noexcept

auto	begin () noexcept

auto	begin () const noexcept

auto	end () noexcept

auto	end () const noexcept

void	reportCreation (String const &name) const

void	reportAdded (String const &name) const

void	reportDuplicate (String const &name) const

void	reportNull () const

void	reportUnknown (String const &name) const

Additional Inherited Members
Protected Types inherited from castor::ResourceCacheBaseT< castor3d::Plugin, String, castor3d::PluginCacheTraits >
using	MutexT

Protected Member Functions inherited from castor::ResourceCacheBaseT< castor3d::Plugin, String, castor3d::PluginCacheTraits >
void	doCleanupNoLock () const noexcept

void	doClearNoLock () noexcept

ElementPtrT	doCreateT (ElementKeyT const &name, ParametersT &&... parameters) const

ElementObsT	doTryAddNoLock (ElementKeyT const &name, ElementPtrT &element, bool initialise=true)

ElementObsT	doAddNoLock (ElementKeyT const &name, ElementPtrT &element, bool initialise=true)

ElementObsT	doTryAddNoLockT (ElementKeyT const &name, bool initialise, ElementObsT &created, ParametersT &&... parameters)

ElementObsT	doAddNoLockT (ElementKeyT const &name, ParametersT &&... parameters)

ElementPtrT	doTryRemoveNoLock (ElementKeyT const &name, bool cleanup=false) noexcept

ElementObsT	doTryFindNoLock (ElementKeyT const &name) const noexcept

	ResourceCacheBaseT (LoggerInstance &logger, ElementInitialiserT initialise=ElementInitialiserT{}, ElementCleanerT clean=ElementCleanerT{}, ElementMergerT merge=ElementMergerT{})

virtual	~ResourceCacheBaseT () noexcept=default

Protected Attributes inherited from castor::ResourceCacheBaseT< castor3d::Plugin, String, castor3d::PluginCacheTraits >
LoggerInstance &	m_logger

CheckedMutexT< MutexT >	m_mutex

ElementContT	m_resources

ElementInitialiserT	m_initialise

ElementCleanerT	m_clean

ElementMergerT	m_merge

Detailed Description

Plug-ins cache.

Member Typedef Documentation

◆ ElementCacheT

using castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >::ElementCacheT = ResourceCacheBaseT< ElementT, ElementKeyT, ElementCacheTraitsT >

◆ ElementCacheTraitsT

using castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >::ElementCacheTraitsT = castor3d::PluginCacheTraits

◆ ElementCleanerT

using castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >::ElementCleanerT = typename ElementCacheT::ElementCleanerT

◆ ElementContT

using castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >::ElementContT = typename ElementCacheT::ElementContT

◆ ElementInitialiserT

using castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >::ElementInitialiserT = typename ElementCacheT::ElementInitialiserT

◆ ElementKeyT

using castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >::ElementKeyT = String

◆ ElementMergerT

using castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >::ElementMergerT = typename ElementCacheT::ElementMergerT

◆ ElementPtrT

using castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >::ElementPtrT = typename ElementCacheT::ElementPtrT

◆ ElementT

using castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >::ElementT = castor3d::Plugin

Constructor & Destructor Documentation

◆ ResourceCacheT()

C3D_API castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >::ResourceCacheT ( castor3d::Engine & engine )

explicit

Constructor.

Parameters

[in] engine The engine.

Member Function Documentation

◆ clear()

C3D_API void castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >::clear ( )

noexcept

Flushes the collection.

◆ getPlugins()

C3D_API castor::StringMap< castor3d::PluginRPtr > castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >::getPlugins ( castor3d::PluginType type )

Retrieves the plug-ins of given type.

Parameters

[in] type The plug-ins type

Returns: nullptr if not found

◆ loadAllPlugins()

C3D_API void castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >::loadAllPlugins ( Path const & folder )

Loads all the plug-ins located in working folder.

Parameters

[in] folder The plug-ins' folder

◆ loadPlugin() [1/2]

C3D_API ElementObsT castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >::loadPlugin ( Path const & fileFullPath )

noexcept

Loads a plug-in, given the plug-in file's full path.

Parameters

[in] fileFullPath The plug-in file path

Returns: The loaded plug-in, nullptr if path was incorrect or if it wasn't a valid plug-in

◆ loadPlugin() [2/2]

C3D_API ElementObsT castor::ResourceCacheT< castor3d::Plugin, String, castor3d::PluginCacheTraits >::loadPlugin	(	String const &	pluginName,
		Path const &	pathFolder )

noexcept

Loads a plug-in, given the plug-in name (ex: libGlRenderSystem.dll => GlRenderSystem)

Parameters

[in]	pluginName	The plug-in name
[in]	pathFolder	Optional path where the plug-in may be looked for

Returns: The loaded plug-in, nullptr if name was incorrect or path was not valid

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

Castor3D/Cache/PluginCache.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ElementCacheT

◆ ElementCacheTraitsT

◆ ElementCleanerT

◆ ElementContT

◆ ElementInitialiserT

◆ ElementKeyT

◆ ElementMergerT

◆ ElementPtrT

◆ ElementT

Constructor & Destructor Documentation

◆ ResourceCacheT()

Member Function Documentation

◆ clear()

◆ getPlugins()

◆ loadAllPlugins()

◆ loadPlugin() [1/2]

◆ loadPlugin() [2/2]