A plugin to provide driver to display graphs. More...

#include <otawa/display/Plugin.h>

Inheritance diagram for otawa::display::Plugin:

Public Member Functions
	Plugin (elm::CString name, const elm::Version &version, const elm::Version &plugger_version)
	Build the plugin. More...

	Plugin (void)

virtual elm::genstruct::Table < AbstractRegistration * > &	processors (void) const
	This method must return the table of all processor available in the plugin. More...

virtual Graph *	newGraph (const PropList &defaultGraphStyle=PropList::EMPTY, const PropList &defaultNodeStyle=PropList::EMPTY, const PropList &defaultEdgeStyle=PropList::EMPTY) const =0
	Creates a new graph with default styles given. More...

Static Public Member Functions
static void	addPath (const elm::system::Path &path)
	Add a path to the list of looked paths. More...

static void	removePath (const elm::system::Path &path)
	Remove the given path from the looked path. More...

static ProcessorPlugin *	get (string name)
	Find a plugin by its name. More...

static Processor *	getProcessor (cstring name)
	Get a processor by its name, possibly loading required plugin. More...

static AbstractFeature *	getFeature (cstring name)
	Find a feature by its name, possibly loading a plugin. More...

static AbstractIdentifier *	getIdentifier (cstring name)
	Find an identifier by its name possibly loading a plugin to get it. More...

static void	setErrorHandler (ErrorHandler *error_handler)
	Set an error handler for the processor resolution plugger. More...

static ErrorHandler *	getErrorHandler (void)
	Get the error handler of the processor resolution plugger. More...

static Driver *	find (string name="")
	Find a driver by its name. More...

static Driver *	find (kind_t kind)

Detailed Description

A plugin to provide driver to display graphs.

Constructor & Destructor Documentation

otawa::display::Plugin::Plugin	(	elm::CString	name,
		const elm::Version &	version,
		const elm::Version &	plugger_version
	)

Build the plugin.

Parameters

name	Name of the plugin.
version	Version of the plugin.
plugger_version	Version of the plugger (must be OTAWA_DISPLAY_VERSION).

otawa::display::Plugin::Plugin ( void )

inline

Member Function Documentation

void otawa::ProcessorPlugin::addPath ( const elm::system::Path & path )

staticinherited

Add a path to the list of looked paths.

Parameters

path	Path to add.

References otawa::ProcessorPlugin::init().

Referenced by otawa::script::Script::work().

Driver * otawa::display::Driver::find ( string name = "" )

staticinherited

Find a driver by its name.

Parameters

name	Name of the driver to look for.

Returns: Driver matching the name or the default driver if an empty string is passed.

References otawa::display::graphviz_driver.

Referenced by otawa::display::AbstractDrawer::AbstractDrawer().

static Driver* otawa::display::Driver::find ( kind_t kind )

staticinherited

ProcessorPlugin * otawa::ProcessorPlugin::get ( string name )

staticinherited

Find a plugin by its name.

The looked directories are, in order, "$PWD/.otawa/proc", "$HOME/.otawa/proc" or "$OTAWA_INSTALL_DIRECTORY/lib/otawa/proc". The full path name of the processor class must be passed in the name, something composed of "comp1::comp2::...::compn". First, a module whose path is by replacing in processor name "::" by "/" is looked. If not found, the last component of the path is removed and the obtained path is looked again for module. This process continue until the module is found or the path becomes empty resulting in a linkage failure.

Parameters

name	Full-qualified name of the processor.

Returns: Built processor or null if the processor cannot be found.

References _, otawa::ProcessorPlugin::init(), elm::String::lastIndexOf(), elm::level_error, elm::level_info, and elm::String::substring().

ErrorHandler * otawa::ProcessorPlugin::getErrorHandler ( void )

staticinherited

Get the error handler of the processor resolution plugger.

Returns: Current error handler.

Referenced by otawa::script::Script::processWorkSpace().

AbstractFeature * otawa::ProcessorPlugin::getFeature ( cstring name )

staticinherited

Find a feature by its name, possibly loading a plugin.

Parameters

name	Name of the looked feature.

Returns: Found feature or null.

References otawa::ProcessorPlugin::getIdentifier(), and otawa::IS_FEATURE.

Referenced by otawa::DynFeature::init().

AbstractIdentifier * otawa::ProcessorPlugin::getIdentifier ( cstring name )

staticinherited

Find an identifier by its name possibly loading a plugin to get it.

Parameters

name	Name of the identifier.

Returns: Found identifier or null.

References otawa::AbstractIdentifier::find().

Referenced by otawa::XSLTScript::fillProps(), otawa::ProcessorPlugin::getFeature(), otawa::DynIdentifier< T >::id(), otawa::script::Script::makeConfig(), and otawa::Application::run().

Processor * otawa::ProcessorPlugin::getProcessor ( cstring name )

staticinherited

Get a processor by its name, possibly loading required plugin.

Parameters

name	Name of the looked processor.

Returns: An instance of the processor or NULL if it cannot be found.

References otawa::Registry::find(), otawa::AbstractRegistration::make(), and name.

Referenced by otawa::DynProcessor::DynProcessor().

otawa::display::Driver::newGraph	(	const PropList &	defaultGraphStyle = `PropList::EMPTY`,
		const PropList &	defaultNodeStyle = `PropList::EMPTY`,
		const PropList &	defaultEdgeStyle = `PropList::EMPTY`
	)		const

pure virtualinherited

Creates a new graph with default styles given.

Parameters

defaultGraphStyle	default properties for the graph Can be changed with the methods inherited from PropList
defaultNodeStyle	default properties for the nodes Can be changed with the methods inherited from PropList
defaultEdgeStyle	default properties for the edges Can be changed with the methods inherited from PropList