A singleton for managing plugins. More...

#include <PluginManager.h>

Inheritance diagram for te::plugin::PluginManager:

Public Member Functions
void	add (const PluginInfo &plugin)
	Adds plug-in to unload list. More...

void	add (PluginInfo *plugin)
	Adds plugin to unload list and take its ownership. More...

void	addCategory (const std::string &name)
	Add a new category type. More...

void	clear ()
	Unload all plugins and them clear the internal list. More...

AbstractPlugin *	detach (const std::string &pluginName)
	It detaches the given plugin from the list of loaded plugins. More...

const boost::ptr_vector < PluginInfo > &	getBrokenPlugins () const
	It returns the list of plugins that could not be loaded. More...

void	getCategories (std::vector< std::string > &categories) const
	Get plugins category types. More...

std::vector< std::string >	getDependents (const std::string &pluginName) const
	It searches for all plugins that depends on the given plugin. More...

std::size_t	getNumPlugins () const
	It returns the number of plugins kept in the manager. More...

const PluginInfo &	getPlugin (const std::string &name) const
	It returns the plugin identified by the given name. More...

void	getPlugins (std::vector< std::string > &plugins) const
	It returns the list of plugins managed by PluginManager. More...

const boost::ptr_vector < PluginInfo > &	getUnloadedPlugins () const
	It returns the list of plugins that are not loaded. More...

bool	hasDependents (const std::string &pluginName) const
	If there is a plugin that depends on the informed plugin it returns true, otherwise, if no plugin depends on it, return false. More...

bool	isBrokenPlugin (const std::string &pluginName) const
	It returns true if the plugin is in the broken list of plugins. More...

bool	isLoaded (const std::string &pname) const
	It returns true if the plugin is loaded otherwise returns false. More...

bool	isLoaded (const std::vector< std::string > &plugins) const
	It returns true if each plugin in the list are loaded otherwise returns false. More...

bool	isUnloadedPlugin (const std::string &pluginName) const
	It returns true if the plugin is in the not-loaded list of plugins. More...

void	load (boost::ptr_vector< PluginInfo > &plugins, const bool start=true)
	It tries to load all informed plugins. More...

void	load (const PluginInfo &pInfo, const bool start=true)
	It loads the informed plugin and adds it to the list of managed plugins. More...

void	load (const std::string &pluginName)

void	loadAll (const bool start=true)
	It loads all the plugins in the not-loaded list or searchs for installed plugin with installed finders. More...

void	remove (const std::string &plugin)

void	shutdownAll ()
	It try to shutdown all plugins. More...

void	unload (const std::string &name)
	It tries to unload a given plugin. More...

void	unload (AbstractPlugin *plugin)
	It tries to unload a given plugin. More...

void	unloadAll ()
	It try to unload all plugins. More...

Static Public Member Functions
static PluginManager &	getInstance ()
	It returns a reference to the singleton instance. More...

Protected Member Functions
void	moveDependentsToBrokenList (const std::string &plugin, const bool &unloadPlugin=false)

void	moveToBrokenList (const PluginInfo &pInfo)

void	removeFromBrokenList (const PluginInfo &pInfo)

void	removeFromCategory (AbstractPlugin *plugin, const std::string &category)
	It removes the given plugin from the category and then updates the internal category index. More...

void	removeFromUnloadedList (const PluginInfo &pInfo)

void	sort (boost::ptr_vector< PluginInfo > &plugins) const
	It sorts the plugins according to their dependency. More...

void	updateDependents (const std::string &plugin)

Private Member Functions
	PluginManager ()
	It creates a new plugin. More...

	~PluginManager ()
	Singleton destructor. More...

Private Attributes
boost::ptr_vector< PluginInfo >	m_brokenPlugins
	The list of plugins that could not be loaded. More...

std::vector< AbstractFinder * >	m_finders
	The list of plugin finders. More...

std::map< std::string, std::vector< AbstractPlugin * > >	m_pluginCategoryMap
	A map from (plugin category) to (plugins in category) More...

std::vector< AbstractPlugin * >	m_plugins
	The list of managed plugins: this will be need to unload accordinly the plugins! More...

std::map< std::string, AbstractPlugin * >	m_pluginsMap
	A map from (plugin's name) to (plugin instance). More...

boost::ptr_vector< PluginInfo >	m_unloadedPlugins
	The list of plugins that are not loaded. More...

Friends
class	te::common::Singleton< PluginManager >

Detailed Description

A singleton for managing plugins.

See Also: AbstractPlugin, PluginInfo, AbstractFinder, PluginEngine, PluginEngineFactory

Definition at line 61 of file PluginManager.h.

Constructor & Destructor Documentation

te::plugin::PluginManager::PluginManager ( )

private

It creates a new plugin.

Definition at line 733 of file PluginManager.cpp.

te::plugin::PluginManager::~PluginManager ( )

private

Singleton destructor.

Definition at line 737 of file PluginManager.cpp.

References te::common::FreeContents().

Member Function Documentation

void te::plugin::PluginManager::add ( const PluginInfo & plugin )

Adds plug-in to unload list.

Parameters

plugin Information of the plug-in.

Definition at line 439 of file PluginManager.cpp.

void te::plugin::PluginManager::add ( PluginInfo * plugin )

Adds plugin to unload list and take its ownership.

Parameters

plugin Information of the plug-in.

Definition at line 444 of file PluginManager.cpp.

void te::plugin::PluginManager::addCategory ( const std::string & name )

Add a new category type.

Parameters

name	The category name.

Definition at line 562 of file PluginManager.cpp.

void te::plugin::PluginManager::clear ( )

Unload all plugins and them clear the internal list.

After calling this method if you call loadAll the manager will look for plugins using the registered finders.

Definition at line 174 of file PluginManager.cpp.

te::plugin::AbstractPlugin * te::plugin::PluginManager::detach ( const std::string & pluginName )

It detaches the given plugin from the list of loaded plugins.

Parameters

pluginName The plugin name.

Exceptions

Exception If there are plugins that depends on the plugin being detached or if the plugin is not found this method raises an exception.

Note: The caller of this method will take the ownership of the given plugin.

Definition at line 515 of file PluginManager.cpp.

References te::plugin::AbstractPlugin::getInfo(), te::plugin::PluginInfo::m_category, and TR_PLUGIN.

Referenced by te::plugin::Module::initialize().

const boost::ptr_vector< te::plugin::PluginInfo > & te::plugin::PluginManager::getBrokenPlugins ( ) const

It returns the list of plugins that could not be loaded.

Definition at line 94 of file PluginManager.cpp.

void te::plugin::PluginManager::getCategories ( std::vector< std::string > & categories ) const

Get plugins category types.

Parameters

A	vector to output the name of plugins categories managed by this singleton.

Definition at line 550 of file PluginManager.cpp.

std::vector< std::string > te::plugin::PluginManager::getDependents ( const std::string & pluginName ) const

It searches for all plugins that depends on the given plugin.

Parameters

pluginName The plugin to be checked.

Returns: It returns the list of plugins that depends on the given plugin.

Definition at line 481 of file PluginManager.cpp.

static PluginManager & te::common::Singleton< PluginManager >::getInstance ( )

staticinherited

std::size_t te::plugin::PluginManager::getNumPlugins ( ) const

It returns the number of plugins kept in the manager.

Returns: The number of plugins in the manager.

Note: This will account for loaded, unloaded and broken plugins.

Definition at line 423 of file PluginManager.cpp.

const te::plugin::PluginInfo & te::plugin::PluginManager::getPlugin ( const std::string & name ) const

It returns the plugin identified by the given name.

Parameters

name	The plugin name.

Returns: A plugin identified by the given name.

Exceptions

Exception It throws an exception if there isn't a plugin with the given name in the manager.

Definition at line 66 of file PluginManager.cpp.

Referenced by te::qt::widgets::PluginManagerDialog::fillInstalledPlugins().

void te::plugin::PluginManager::getPlugins ( std::vector< std::string > & plugins ) const

It returns the list of plugins managed by PluginManager.

Parameters

plugins A vector to output the name of plugins managed by this singleton.

Note: The list will contain: loaded, not-loaded and broken plugins.

Definition at line 51 of file PluginManager.cpp.

References m_brokenPlugins, m_plugins, and m_unloadedPlugins.

Referenced by te::qt::widgets::PluginManagerDialog::fillInstalledPlugins().

const boost::ptr_vector< te::plugin::PluginInfo > & te::plugin::PluginManager::getUnloadedPlugins ( ) const

It returns the list of plugins that are not loaded.

Definition at line 89 of file PluginManager.cpp.

bool te::plugin::PluginManager::hasDependents ( const std::string & pluginName ) const

If there is a plugin that depends on the informed plugin it returns true, otherwise, if no plugin depends on it, return false.

Parameters

pluginName The plugin to be checked.

Returns: It returns true if there is a plugin that depends on the given plugin.

Definition at line 510 of file PluginManager.cpp.

bool te::plugin::PluginManager::isBrokenPlugin ( const std::string & pluginName ) const

It returns true if the plugin is in the broken list of plugins.

Definition at line 99 of file PluginManager.cpp.

bool te::plugin::PluginManager::isLoaded ( const std::string & pname ) const

It returns true if the plugin is loaded otherwise returns false.

Parameters

pname The plugin name to be checked.

Returns: It returns true if the plugin in the list are loaded otherwise returns false.

Definition at line 117 of file PluginManager.cpp.

Referenced by te::qt::widgets::PluginManagerDialog::fillInstalledPlugins().

bool te::plugin::PluginManager::isLoaded ( const std::vector< std::string > & plugins ) const

It returns true if each plugin in the list are loaded otherwise returns false.

Parameters

plugins A list with plugin names to be checked.

Returns: It returns true if all plugins in the list are loaded otherwise returns false.

Note: This method can be used to check if a given plugin has all pre-requisites to be loaded.

Definition at line 428 of file PluginManager.cpp.

bool te::plugin::PluginManager::isUnloadedPlugin ( const std::string & pluginName ) const

It returns true if the plugin is in the not-loaded list of plugins.

Definition at line 108 of file PluginManager.cpp.

void te::plugin::PluginManager::load	(	boost::ptr_vector< PluginInfo > &	plugins,
		const bool	start = `true`
	)

It tries to load all informed plugins.

PluginManager will check the dependency between plugins before trying to load them.

Parameters

plugins	The list of plugins to be loaded
start	If true it will try to startup the plugin if false it doesn't automatically call plugin startup method.

Exceptions

Exception It throws an exception if any plugin can not be loaded or started.

Note: If a plugin in the list is already loaded this methods will throw an exception.; If a plugin load fails this method will add it to the list of broken plugins and continues. In this case at the end an exception is thrown.; The manager will sort the plugins according to their load priority.

Definition at line 181 of file PluginManager.cpp.

References te::plugin::PluginInfo::m_name, and TR_PLUGIN.

Referenced by te::plugin::Module::initialize().

void te::plugin::PluginManager::load	(	const PluginInfo &	pInfo,
		const bool	start = `true`
	)

It loads the informed plugin and adds it to the list of managed plugins.

PluginManager will check the dependency between plugins before trying to load the informed plugin.

Parameters

pInfo	Information about the plugin to be loaded.
start	If true it will try to startup the plugin if false it doesn't automatically call plugin startup method.

Exceptions

Exception It throws an exception if something goes wrong during plugin load.

Note: This method can checks for category dependency and plugin dependency. It throws an error if the dependency is not satisfied.; If a plugin in the list is already loaded this methods will raise an exception.; If an exception occurs the plugin will be added to the list of broken plugins (except if it is already loaded!).; If no plugin folder or an invalid folder was supplied the interal finders will be used to locate the plugin file.

Definition at line 210 of file PluginManager.cpp.

References te::common::Singleton< TerraLib >::getInstance(), TerraLib::getNumRegModules(), te::plugin::DefaultFinder::getPlugins(), TerraLib::initialize(), te::plugin::PluginInfo::m_category, te::plugin::PluginInfo::m_engine, te::plugin::PluginInfo::m_folder, te::plugin::PluginInfo::m_name, te::plugin::PluginInfo::m_requiredPlugins, te::common::AbstractFactory< AbstractPluginEngine, std::string >::make(), and TR_PLUGIN.

void te::plugin::PluginManager::load ( const std::string & pluginName )

Definition at line 345 of file PluginManager.cpp.

void te::plugin::PluginManager::loadAll ( const bool start = true )

It loads all the plugins in the not-loaded list or searchs for installed plugin with installed finders.

PluginManager will check the dependency between plugins before trying to load them.

The associated plugin finders will be used to locate the information about plugins.

If no plugin finder is available this method will use the default finder to look up for plugins.

After the fitrst call to this method the plugins list is cached until clear is explicitly called.

Parameters

start If true it will try to startup the plugins if false it doesn't automatically call plugins startup method and applications must control this.

Exceptions

Exception It throws an exception if any plugin can not be loaded.

Note: This method will unload all previously loaded plugins.; If a plugin load fails this method will add it to the list of broken plugins and continues. In this case at the end an exception is thrown.

Definition at line 122 of file PluginManager.cpp.

References te::plugin::DefaultFinder::getPlugins().

void te::plugin::PluginManager::moveDependentsToBrokenList	(	const std::string &	plugin,
		const bool &	unloadPlugin = `false`
	)

protected

Definition at line 685 of file PluginManager.cpp.

References te::plugin::PluginInfo::m_name.

void te::plugin::PluginManager::moveToBrokenList ( const PluginInfo & pInfo )

protected

Definition at line 652 of file PluginManager.cpp.

void te::plugin::PluginManager::remove ( const std::string & plugin )

Definition at line 459 of file PluginManager.cpp.

References te::plugin::AbstractPlugin::shutdown().

void te::plugin::PluginManager::removeFromBrokenList ( const PluginInfo & pInfo )

protected

Definition at line 661 of file PluginManager.cpp.

References te::plugin::PluginInfo::m_name.

void te::plugin::PluginManager::removeFromCategory	(	AbstractPlugin *	plugin,
		const std::string &	category
	)

protected

It removes the given plugin from the category and then updates the internal category index.

Parameters

plugin	The plugin to be removed from the given category.
category	The categpry to be updated.

Definition at line 627 of file PluginManager.cpp.

void te::plugin::PluginManager::removeFromUnloadedList ( const PluginInfo & pInfo )

protected

Definition at line 673 of file PluginManager.cpp.

References te::plugin::PluginInfo::m_name.

void te::plugin::PluginManager::shutdownAll ( )

It try to shutdown all plugins.

This method calls shutdown for all managed plugins.

Exceptions

It	will raise an exception if it is not possible to shutdown a plugin.

Definition at line 409 of file PluginManager.cpp.

void te::plugin::PluginManager::sort ( boost::ptr_vector< PluginInfo > & plugins ) const

protected

It sorts the plugins according to their dependency.

Definition at line 573 of file PluginManager.cpp.

void te::plugin::PluginManager::unload ( const std::string & name )

It tries to unload a given plugin.

This method will call plugin's shutdown method if needed.

Parameters

name	The plugin to be unloaded.

Exceptions

It	will raise an exception if plugin's code is not unloaded, if it fails to shutdown or if the plugin's is not managed by PluginManager.

Definition at line 350 of file PluginManager.cpp.

Referenced by te::plugin::Module::finalize().

void te::plugin::PluginManager::unload ( AbstractPlugin * plugin )

It tries to unload a given plugin.

This method will call plugin's shutdown method if needed.

Parameters

plugin The plugin to be unloaded. The pointer will be invalidated if it acomplishes the task.

Exceptions

It	will raise an exception if plugin's code is not unloaded or if it fails to shutdown.

Note: It doesn't throw exceptions if the plugin is not managed by the manager.

Definition at line 365 of file PluginManager.cpp.

References te::plugin::AbstractPlugin::getInfo(), te::plugin::AbstractPlugin::isStarted(), te::plugin::PluginInfo::m_category, te::plugin::PluginInfo::m_engine, te::plugin::PluginInfo::m_name, te::common::AbstractFactory< AbstractPluginEngine, std::string >::make(), and te::plugin::AbstractPlugin::shutdown().

void te::plugin::PluginManager::unloadAll ( )

It try to unload all plugins.

This method will call shutdown for all managed plugins.

Exceptions

It	will raise an exception if it is not possible to unload a plugin.

Definition at line 155 of file PluginManager.cpp.

Referenced by te::plugin::Module::finalize().

void te::plugin::PluginManager::updateDependents ( const std::string & plugin )

protected

Definition at line 711 of file PluginManager.cpp.

Friends And Related Function Documentation

friend class te::common::Singleton< PluginManager >

friend

Definition at line 63 of file PluginManager.h.

Member Data Documentation

boost::ptr_vector<PluginInfo> te::plugin::PluginManager::m_brokenPlugins

private

The list of plugins that could not be loaded.

Definition at line 355 of file PluginManager.h.

Referenced by getPlugins().

std::vector<AbstractFinder*> te::plugin::PluginManager::m_finders

private

The list of plugin finders.

Definition at line 350 of file PluginManager.h.

std::map<std::string, std::vector<AbstractPlugin*> > te::plugin::PluginManager::m_pluginCategoryMap

private

A map from (plugin category) to (plugins in category)

Definition at line 353 of file PluginManager.h.

std::vector<AbstractPlugin*> te::plugin::PluginManager::m_plugins

private

The list of managed plugins: this will be need to unload accordinly the plugins!

Definition at line 351 of file PluginManager.h.

Referenced by getPlugins().

std::map<std::string, AbstractPlugin*> te::plugin::PluginManager::m_pluginsMap

private

A map from (plugin's name) to (plugin instance).

Definition at line 352 of file PluginManager.h.

boost::ptr_vector<PluginInfo> te::plugin::PluginManager::m_unloadedPlugins

private

The list of plugins that are not loaded.

Definition at line 354 of file PluginManager.h.

Referenced by getPlugins().

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

/home/castejon/castejon_files/develop/terralib5/git/src/terralib/plugin/PluginManager.h
/home/castejon/castejon_files/develop/terralib5/git/src/terralib/plugin/PluginManager.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation