elm::sys::Plugin Class Reference

#include <>>

Classes
class	make

Public Types
typedef genstruct::Table< string >	aliases_t

Public Member Functions
	Plugin (string name, const Version &plugger_version, CString hook="", const aliases_t &aliases=aliases_t::EMPTY)
	Plugin (const make &maker)
virtual	~Plugin (void)
string	name (void) const
CString	description (void) const
CString	licence (void) const
const Version &	pluginVersion (void) const
const Version &	pluggerVersion (void) const
CString	hook (void) const
const aliases_t &	aliases (void) const
bool	matches (const string &name) const
void	unplug (void)
const Path &	path (void) const

Static Public Attributes
static const t::uint32	MAGIC = 0xCAFEBABE

Protected Member Functions
virtual void	startup (void)
virtual void	cleanup (void)

Protected Attributes
CString	_description
CString	_licence
Version	_plugin_version

Detailed Description

The class Plugin allows implementing plug-ins in OS-independent way. See Plugins for more details.

Member Typedef Documentation

typedef genstruct::Table<string> elm::sys::Plugin::aliases_t

Constructor & Destructor Documentation

elm::sys::Plugin::Plugin	(	string	name,
		const Version &	plugger_version,
		CString	hook = "",
		const aliases_t &	aliases = aliases_t::EMPTY
	)

Build a new plugin.

Parameters

name	Plugin name.
plugger_version	Plugger version (used for checking compatibility between plugin and user application API).
hook	Hook of a matching plugger
aliases	Name aliases for the plugin.

elm::sys::Plugin::Plugin

(

const make &

maker

)

New-style builder for plugin using Plugin::Maker.

Parameters

maker

Maker for plugin.

References elm::genstruct::Vector< T >::addAll(), and elm::genstruct::Vector< T >::detach().

elm::sys::Plugin::~Plugin ( void  )

virtual

Member Function Documentation

const aliases_t & elm::sys::Plugin::aliases

(

void

)

const

Get the table of aliases of the plugin.

Returns

Table of aliases.

void elm::sys::Plugin::cleanup ( void  )

protectedvirtual

This method is called just before the plugin removal from the user application. It may be overriden for performing specific clean up.

Referenced by unplug().

String elm::sys::Plugin::description

(

void

)

const

Get the plugin description.

Returns

Plugin description.

References _description.

String elm::sys::Plugin::hook

(

void

)

const

Get the hook of the current plugin.

Returns

Plugin hook.

String elm::sys::Plugin::licence

(

void

)

const

Get the plugin licence.

Returns

Plugin licence.

References _licence.

bool elm::sys::Plugin::matches

(

const string &

name

)

const

Test if the current plugin matches the given name, that is, if the name or one of the aliases matches the name.

Parameters

name	Name to test.

Returns

True if the name is matched, false else.

string elm::sys::Plugin::name

(

void

)

const

Get the plugin name.

Returns

Plugin name.

const Path& elm::sys::Plugin::path

(

void

)

const

Version & elm::sys::Plugin::pluggerVersion

(

void

)

const

Get the plugger version.

Returns

Plugger version.

Referenced by elm::sys::Plugger::plugFile().

Version & elm::sys::Plugin::pluginVersion

(

void

)

const

Get the plugin version.

Returns

Plugin version.

References _plugin_version.

void elm::sys::Plugin::startup ( void  )

protectedvirtual

This method is called just after the plugin has been plugged into the user application. It may be overriden for performing specific initializations.

void elm::sys::Plugin::unplug

(

void

)

Call it when the plugin is no more used.

References cleanup().

Member Data Documentation

CString elm::sys::Plugin::_description

protected

Referenced by description().

CString elm::sys::Plugin::_licence

protected

Referenced by licence().

Version elm::sys::Plugin::_plugin_version

protected

Referenced by pluginVersion().

const t::uint32 elm::sys::Plugin::MAGIC = 0xCAFEBABE

static

Referenced by elm::sys::Plugger::plugFile().

---

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

• include/elm/sys/Plugin.h
• src/system_Plugin.cpp