Typelib::PluginManager Class Reference

#include <typelib/pluginmanager.hh>

List of all members.

Public Types
typedef utilmm::singleton::use < PluginManager >	self
Public Member Functions
bool	add (ExportPlugin *plugin)
Importer *	importer (std::string const &name) const
bool	add (ImportPlugin *plugin)
Exporter *	exporter (std::string const &name) const
Static Public Member Functions
static std::string	save (std::string const &kind, Registry const &registry)
static std::string	save (std::string const &kind, utilmm::config_set const &config, Registry const &registry)
static void	save (std::string const &kind, Registry const &registry, std::ostream &into)
static void	save (std::string const &kind, utilmm::config_set const &config, Registry const &registry, std::ostream &into)
static Registry *	load (std::string const &kind, std::istream &stream)
static void	load (std::string const &kind, std::istream &stream, Registry &into)
static Registry *	load (std::string const &kind, std::string const &file)
static void	load (std::string const &kind, std::string const &file, Registry &into)
static Registry *	load (std::string const &kind, std::istream &stream, utilmm::config_set const &config)
static void	load (std::string const &kind, std::istream &stream, utilmm::config_set const &config, Registry &into)
static Registry *	load (std::string const &kind, std::string const &file, utilmm::config_set const &config)
static void	load (std::string const &kind, std::string const &file, utilmm::config_set const &config, Registry &into)
Friends
class	utilmm::singleton::wrapper< PluginManager >

---

Detailed Description

The plugin manager

It is a singleton, using utilmm::singleton You have to access it using PluginManager::self manager;

manager->importer()

The object is destroyed when the last of the use<> objects is, and created back when a new use<> object is built.

---

Member Typedef Documentation

typedef utilmm::singleton::use<PluginManager> Typelib::PluginManager::self

The one PluginManager object. See main PluginManager documentation for its use.

---

Member Function Documentation

bool PluginManager::add

(

ExportPlugin *

plugin

)

Registers a new exporter

References add_plugin().

Referenced by Typelib::registerIOPlugins().

Importer * PluginManager::importer

(

std::string const &

name

)

const

Build a new import plugin from its plugin name

Exceptions:

PluginNotFound

References get_plugin().

Referenced by load().

bool PluginManager::add

(

ImportPlugin *

plugin

)

Registers a new importer

References add_plugin().

Exporter * PluginManager::exporter

(

std::string const &

name

)

const

Build a new export plugin from its plugin name

Exceptions:

PluginNotFound

References get_plugin().

Referenced by save().

std::string PluginManager::save	(	std::string const &	kind,
		Registry const &	registry
	)			[static]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This is provided for backward compatibility only

Referenced by save().

std::string PluginManager::save	(	std::string const &	kind,
		utilmm::config_set const &	config,
		Registry const &	registry
	)			[static]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References save().

void PluginManager::save	(	std::string const &	kind,
		Registry const &	registry,
		std::ostream &	into
	)			[static]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This is provided for backward compatibility only

References save().

void PluginManager::save	(	std::string const &	kind,
		utilmm::config_set const &	config,
		Registry const &	registry,
		std::ostream &	into
	)			[static]

Exports a registry to an ostream object

• kind the output format. It has to be a valid exporter name
• config format-specific configuration. See each exporter documentation for details.
• registry the registry to export
• into the ostream object to export to

  Exceptions:

  	PluginNotFound	if kind is invalid
  	UnsupportedType	if a specific type cannot be exported into this format
  	ExportError	if another error occured during the export

References exporter(), and Typelib::Exporter::save().

Registry * PluginManager::load	(	std::string const &	kind,
		std::istream &	stream
	)			[static]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Referenced by load().

void PluginManager::load	(	std::string const &	kind,
		std::istream &	stream,
		Registry &	into
	)			[static]

Imports types from a istream object to an already existing registry

References load().

Registry * PluginManager::load	(	std::string const &	kind,
		std::string const &	file
	)			[static]

Creates a registry from a file

See also:

Importer::load

References load().

void PluginManager::load	(	std::string const &	kind,
		std::string const &	file,
		Registry &	into
	)			[static]

Imports types from a file into an already existing registry

See also:

Importer::load

References load().

Registry * PluginManager::load	(	std::string const &	kind,
		std::istream &	stream,
		utilmm::config_set const &	config
	)			[static]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References load().

void PluginManager::load	(	std::string const &	kind,
		std::istream &	stream,
		utilmm::config_set const &	config,
		Registry &	into
	)			[static]

Imports types from a istream object to an already existing registry

References importer(), and Typelib::Importer::load().

Registry * PluginManager::load	(	std::string const &	kind,
		std::string const &	file,
		utilmm::config_set const &	config
	)			[static]

Creates a registry from a file

See also:

Importer::load

References load().

void PluginManager::load	(	std::string const &	kind,
		std::string const &	file,
		utilmm::config_set const &	config,
		Registry &	into
	)			[static]

Imports types from a file into an already existing registry

See also:

Importer::load

References importer(), and Typelib::Importer::load().

---

Friends And Related Function Documentation

friend class utilmm::singleton::wrapper< PluginManager > [friend]

---

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

• typelib/pluginmanager.hh
• typelib/pluginmanager.cc