Ceylan::XML::XMLVisitor Class Reference

Generic XML visitor. More...

#include <CeylanXMLVisitor.h>

Inheritance diagram for Ceylan::XML::XMLVisitor:

Collaboration diagram for Ceylan::XML::XMLVisitor:

List of all members.

Public Types

enum TextOutputFormat { rawText, html }

Defines what text output formats for TextDisplayable instances are available. More...

Public Member Functions

XMLVisitor ()

Creates an empty XML visitor.

virtual ~XMLVisitor () throw ()

Virtual destructor.

virtual void visit (XMLMarkup &xmlMarkup)=0

Visits specified XML markup and processes it.

virtual void visit (XMLText &xmlText)=0

Visits specified XML text and processes it.

virtual const std::string toString (Ceylan::VerbosityLevels level=Ceylan::high) const

Returns a user-friendly description of the state of this object.

virtual Height getHeight () const

Returns current height.

virtual void incrementHeight ()

Increments current height.

virtual void decrementHeight ()

Decrements current height.

Static Public Member Functions

static const std::string ToString (std::list< TextDisplayable * > displayables, Ceylan::VerbosityLevels level=Ceylan::high)

Returns a user-friendly description of this list of pointers to text displayable instances.

static TextOutputFormat GetOutputFormat ()

Returns the current overall text format to be used by TextDisplayable instances.

static void SetOutputFormat (TextOutputFormat newOutputFormat)

Sets the current overall text format to be used by TextDisplayable instances.

Static Protected Attributes

static TextOutputFormat _OutputFormat = rawText

The text format to be used currently by TextDisplayable instances.

Private Member Functions

XMLVisitor (const XMLVisitor &source)

Copy constructor made private to ensure that it will never be called.

XMLVisitor & operator= (const XMLVisitor &source)

Assignment operator made private to ensure that it will never be called.

Detailed Description

Generic XML visitor.

Its role is to visit a XML tree and process its nodes.

Definition at line 106 of file CeylanXMLVisitor.h.

Member Enumeration Documentation

enum Ceylan::TextDisplayable::TextOutputFormat [inherited]

Defines what text output formats for TextDisplayable instances are available.

Enumerator:

rawText
html

Definition at line 124 of file CeylanTextDisplayable.h.

Constructor & Destructor Documentation

XMLVisitor::XMLVisitor ( )

Creates an empty XML visitor.

Definition at line 71 of file CeylanXMLVisitor.cc.

XMLVisitor::~XMLVisitor ( ) throw () [virtual]

Virtual destructor.

Definition at line 77 of file CeylanXMLVisitor.cc.

Ceylan::XML::XMLVisitor::XMLVisitor ( const XMLVisitor & source ) [private]

Copy constructor made private to ensure that it will never be called.

The compiler should complain whenever this undefined constructor is called, implicitly or not.

Note:: Made to avoid unwanted hidden clone of the Singleton.

Member Function Documentation

virtual void Ceylan::TreeHeightAwareVisitor< XMLElement >::decrementHeight ( ) [virtual, inherited]

Decrements current height.

Note:: A default do-nothing implementation is provided here, it is made to be overriden by the actual algorithm, which may use a single variable, or a stack, etc.

Reimplemented in Ceylan::XML::XMLSavingVisitor.

virtual Height Ceylan::TreeHeightAwareVisitor< XMLElement >::getHeight ( ) const [virtual, inherited]

Returns current height.

Note:: A default do-nothing implementation is provided here, it is made to be overriden by the actual algorithm, which may use a single variable, or a stack, etc.

Reimplemented in Ceylan::XML::XMLSavingVisitor.

TextDisplayable::TextOutputFormat TextDisplayable::GetOutputFormat ( ) [static, inherited]

Returns the current overall text format to be used by TextDisplayable instances.

Definition at line 63 of file CeylanTextDisplayable.cc.

References Ceylan::TextDisplayable::_OutputFormat.

Referenced by Ceylan::formatStringList(), Ceylan::formatStringMap(), Ceylan::XML::XMLMarkup::toString(), Ceylan::Maths::Linear::Vector3::toString(), Ceylan::Maths::Linear::Vector2::toString(), Ceylan::Maths::Linear::Tripoint::toString(), Ceylan::Module::toString(), Ceylan::Maths::Linear::Matrix3::toString(), Ceylan::Maths::Linear::Matrix2::toString(), Ceylan::Maths::Linear::HomogeneousMatrix3::toString(), and Ceylan::Maths::Linear::Bipoint::toString().

virtual void Ceylan::TreeHeightAwareVisitor< XMLElement >::incrementHeight ( ) [virtual, inherited]

Increments current height.

Note:: A default do-nothing implementation is provided here, it is made to be overriden by the actual algorithm, which may use a single variable, or a stack, etc.

Reimplemented in Ceylan::XML::XMLSavingVisitor.

XMLVisitor& Ceylan::XML::XMLVisitor::operator= ( const XMLVisitor & source ) [private]

Assignment operator made private to ensure that it will never be called.

The compiler should complain whenever this undefined operator is called, implicitly or not.

void TextDisplayable::SetOutputFormat ( TextOutputFormat newOutputFormat ) [static, inherited]

Sets the current overall text format to be used by TextDisplayable instances.

Parameters:

newOutputFormat

the new output format.

Definition at line 72 of file CeylanTextDisplayable.cc.

References Ceylan::TextDisplayable::_OutputFormat.

Referenced by Ceylan::Log::LogHolder::LogHolder().

const std::string TextDisplayable::ToString	(	std::list< TextDisplayable * >	displayables,
		Ceylan::VerbosityLevels	level = `Ceylan::high`
	)			`[static, inherited]`

Returns a user-friendly description of this list of pointers to text displayable instances.

Parameters:

	displayables	a list of pointers to TextDisplayable instances/
	level	the requested verbosity level.

Note:: Text output format is determined from overall settings.

See also:: toString, Ceylan::VerbosityLevels

Definition at line 45 of file CeylanTextDisplayable.cc.

References Ceylan::formatStringList().

const string XMLVisitor::toString ( Ceylan::VerbosityLevels level = Ceylan::high ) const [virtual]

Returns a user-friendly description of the state of this object.

Parameters:

level

the requested verbosity level.

Note:: Text output format is determined from overall settings.

See also:: TextDisplayable

Reimplemented from Ceylan::Visitor.

Reimplemented in Ceylan::XML::XMLSavingVisitor, and Ceylan::XML::XMLSearchingVisitor.

Definition at line 83 of file CeylanXMLVisitor.cc.

virtual void Ceylan::XML::XMLVisitor::visit ( XMLText & xmlText ) [pure virtual]

Visits specified XML text and processes it.

Parameters:

xmlText

the XML text to visit.

Exceptions:

VisitException

if this visit failed.

Note:: The text is not 'const' to allow for visitors able to change the visited elements, ex: a searching visitor may need to return a list of non-const texts.

Implemented in Ceylan::XML::XMLSavingVisitor, and Ceylan::XML::XMLSearchingVisitor.

virtual void Ceylan::XML::XMLVisitor::visit ( XMLMarkup & xmlMarkup ) [pure virtual]

Visits specified XML markup and processes it.

Parameters:

xmlMarkup

the XML markup to visit.

Exceptions:

VisitException

if this visit failed.

Note:: The markup is not 'const' to allow for visitors able to change the visited elements, ex: a searching visitor may need to return a list of non-const markups.

Implemented in Ceylan::XML::XMLSavingVisitor, and Ceylan::XML::XMLSearchingVisitor.

Referenced by Ceylan::XML::XMLText::accept(), and Ceylan::XML::XMLMarkup::accept().

Member Data Documentation

TextDisplayable::TextOutputFormat TextDisplayable::_OutputFormat = rawText [static, protected, inherited]

The text format to be used currently by TextDisplayable instances.

Note:: Defaults to raw text.

Definition at line 158 of file CeylanTextDisplayable.h.

Referenced by Ceylan::TextDisplayable::GetOutputFormat(), and Ceylan::TextDisplayable::SetOutputFormat().

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


Public Types
enum	TextOutputFormat { rawText, html }
	Defines what text output formats for TextDisplayable instances are available. More...
Public Member Functions
	XMLVisitor ()
	Creates an empty XML visitor.
virtual	~XMLVisitor () throw ()
	Virtual destructor.
virtual void	visit (XMLMarkup &xmlMarkup)=0
	Visits specified XML markup and processes it.
virtual void	visit (XMLText &xmlText)=0
	Visits specified XML text and processes it.
virtual const std::string	toString (Ceylan::VerbosityLevels level=Ceylan::high) const
	Returns a user-friendly description of the state of this object.
virtual Height	getHeight () const
	Returns current height.
virtual void	incrementHeight ()
	Increments current height.
virtual void	decrementHeight ()
	Decrements current height.
Static Public Member Functions
static const std::string	ToString (std::list< TextDisplayable * > displayables, Ceylan::VerbosityLevels level=Ceylan::high)
	Returns a user-friendly description of this list of pointers to text displayable instances.
static TextOutputFormat	GetOutputFormat ()
	Returns the current overall text format to be used by TextDisplayable instances.
static void	SetOutputFormat (TextOutputFormat newOutputFormat)
	Sets the current overall text format to be used by TextDisplayable instances.
Static Protected Attributes
static TextOutputFormat	_OutputFormat = rawText
	The text format to be used currently by TextDisplayable instances.
Private Member Functions
	XMLVisitor (const XMLVisitor &source)
	Copy constructor made private to ensure that it will never be called.
XMLVisitor &	operator= (const XMLVisitor &source)
	Assignment operator made private to ensure that it will never be called.