Printing functionality. More...

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLPrinter:

Public Member Functions
	XMLPrinter (FILE *file=0, bool compact=false, int depth=0)
	Construct the printer. More...

virtual	~XMLPrinter ()

void	PushHeader (bool writeBOM, bool writeDeclaration)
	If streaming, write the BOM and declaration. More...

void	OpenElement (const char *name)
	If streaming, start writing an element. More...

void	PushAttribute (const char name, const char value)
	If streaming, add an attribute to an open element. More...

void	PushAttribute (const char *name, int value)

void	PushAttribute (const char *name, unsigned value)

void	PushAttribute (const char *name, bool value)

void	PushAttribute (const char *name, double value)

virtual void	CloseElement ()
	If streaming, close the Element. More...

void	PushText (const char *text, bool cdata=false, bool specrow=false)
	Add a text node. More...

void	PushText (int value)
	Add a text node from an integer. More...

void	PushText (unsigned value)
	Add a text node from an unsigned. More...

void	PushText (bool value)
	Add a text node from a bool. More...

void	PushText (float value)
	Add a text node from a float. More...

void	PushText (double value)
	Add a text node from a double. More...

void	PushComment (const char *comment)
	Add a comment. More...

void	PushDeclaration (const char *value)

void	PushUnknown (const char *value)

virtual bool	VisitEnter (const XMLDocument &)
	Visit a document. More...

virtual bool	VisitExit (const XMLDocument &)
	Visit a document. More...

virtual bool	VisitEnter (const XMLElement &element, const XMLAttribute *attribute)
	Visit an element. More...

virtual bool	VisitExit (const XMLElement &element)
	Visit an element. More...

virtual bool	Visit (const XMLText &text)
	Visit a text node. More...

virtual bool	Visit (const XMLComment &comment)
	Visit a comment node. More...

virtual bool	Visit (const XMLDeclaration &declaration)
	Visit a declaration. More...

virtual bool	Visit (const XMLUnknown &unknown)
	Visit an unknown node. More...

const char *	CStr () const
	If in print to memory mode, return a pointer to the XML file in memory. More...

int	CStrSize () const
	If in print to memory mode, return the size of the XML file in memory. More...

Public Member Functions inherited from tinyxml2::XMLVisitor
virtual	~XMLVisitor ()

Protected Member Functions
void	SealElement ()

Protected Attributes
bool	_elementJustOpened

DynArray< const char *, 10 >	_stack

Private Types
enum	{ ENTITY_RANGE = 64, BUF_SIZE = 200 }

Private Member Functions
void	PrintSpace (int depth)

void	PrintString (const char *, bool restrictedEntitySet)

void	Print (const char *format,...)

Private Attributes
bool	_firstElement

FILE *	_fp

int	_depth

int	_textDepth

bool	_processEntities

bool	_compactMode

bool	_entityFlag [ENTITY_RANGE]

bool	_restrictedEntityFlag [ENTITY_RANGE]

DynArray< char, 20 >	_buffer

Detailed Description

Printing functionality.

The XMLPrinter gives you more options than the XMLDocument::Print() method.

It can:

Print to memory.
Print to a file you provide.
Print XML without a XMLDocument.

Print to Memory

XMLPrinter printer;
doc.Print( &printer );
SomeFunction( printer.CStr() );

Print to a File

You provide the file pointer.

XMLPrinter printer( fp );
doc.Print( &printer );

Print without a XMLDocument

When loading, an XML parser is very useful. However, sometimes when saving, it just gets in the way. The code is often set up for streaming, and constructing the DOM is just overhead.

The Printer supports the streaming case. The following code prints out a trivially simple XML file without ever creating an XML document.

XMLPrinter printer( fp );
printer.OpenElement( "foo" );
printer.PushAttribute( "foo", "bar" );
printer.CloseElement();

Definition at line 1894 of file tinyxml2.h.

Member Enumeration Documentation

anonymous enum

private

Enumerator
ENTITY_RANGE
BUF_SIZE

Definition at line 1986 of file tinyxml2.h.

Constructor & Destructor Documentation

tinyxml2::XMLPrinter::XMLPrinter	(	FILE *	file = `0`,
		bool	compact = `false`,
		int	depth = `0`
	)

Construct the printer.

If the FILE* is specified, this will print to the FILE. Else it will print to memory, and the result is available in CStr(). If 'compact' is set to true, then output is created with only required whitespace and newlines.

Definition at line 1750 of file tinyxml2.cpp.

References _buffer, _entityFlag, _restrictedEntityFlag, tinyxml2::entities, ENTITY_RANGE, tinyxml2::NUM_ENTITIES, tinyxml2::DynArray< T, INIT >::Push(), and TIXMLASSERT.

virtual tinyxml2::XMLPrinter::~XMLPrinter ( )

inlinevirtual

Definition at line 1904 of file tinyxml2.h.

Member Function Documentation

void tinyxml2::XMLPrinter::CloseElement ( )

virtual

If streaming, close the Element.

Definition at line 1932 of file tinyxml2.cpp.

References _compactMode, _depth, _elementJustOpened, _stack, _textDepth, tinyxml2::DynArray< T, INIT >::Pop(), Print(), and PrintSpace().

Referenced by VisitExit().

const char* tinyxml2::XMLPrinter::CStr ( ) const

inline

If in print to memory mode, return a pointer to the XML file in memory.

Definition at line 1957 of file tinyxml2.h.

int tinyxml2::XMLPrinter::CStrSize ( ) const

inline

If in print to memory mode, return the size of the XML file in memory.

(Note the size returned includes the terminating null.)

Definition at line 1965 of file tinyxml2.h.

void tinyxml2::XMLPrinter::OpenElement ( const char * name )

If streaming, start writing an element.

The element must be closed with CloseElement()

Definition at line 1870 of file tinyxml2.cpp.

References _compactMode, _depth, _elementJustOpened, _firstElement, _stack, _textDepth, Print(), PrintSpace(), tinyxml2::DynArray< T, INIT >::Push(), and SealElement().

Referenced by VisitEnter().

void tinyxml2::XMLPrinter::Print	(	const char *	format,
			...
	)

private

Definition at line 1776 of file tinyxml2.cpp.

References _buffer, _fp, and tinyxml2::DynArray< T, INIT >::PushArr().

Referenced by CloseElement(), OpenElement(), PrintSpace(), PrintString(), PushAttribute(), PushComment(), PushDeclaration(), PushHeader(), PushText(), PushUnknown(), and SealElement().

void tinyxml2::XMLPrinter::PrintSpace ( int depth )

private

termitovo zkraceno ze 4 na 2 spaces

Definition at line 1812 of file tinyxml2.cpp.

References Print().

Referenced by CloseElement(), OpenElement(), PushComment(), PushDeclaration(), PushText(), and PushUnknown().

void tinyxml2::XMLPrinter::PrintString	(	const char *	p,
		bool	restrictedEntitySet
	)

private

Definition at line 1820 of file tinyxml2.cpp.

References _entityFlag, _processEntities, _restrictedEntityFlag, tinyxml2::entities, ENTITY_RANGE, tinyxml2::NUM_ENTITIES, and Print().

Referenced by PushAttribute(), and PushText().

void tinyxml2::XMLPrinter::PushAttribute	(	const char *	name,
		const char *	value
	)

If streaming, add an attribute to an open element.

Definition at line 1891 of file tinyxml2.cpp.

References _elementJustOpened, Print(), PrintString(), and TIXMLASSERT.

Referenced by PushAttribute(), and VisitEnter().

void tinyxml2::XMLPrinter::PushAttribute	(	const char *	name,
		int	value
	)

Definition at line 1900 of file tinyxml2.cpp.

References BUF_SIZE, PushAttribute(), and tinyxml2::XMLUtil::ToStr().

void tinyxml2::XMLPrinter::PushAttribute	(	const char *	name,
		unsigned	value
	)

Definition at line 1908 of file tinyxml2.cpp.

References BUF_SIZE, PushAttribute(), and tinyxml2::XMLUtil::ToStr().

void tinyxml2::XMLPrinter::PushAttribute	(	const char *	name,
		bool	value
	)

Definition at line 1916 of file tinyxml2.cpp.

References BUF_SIZE, PushAttribute(), and tinyxml2::XMLUtil::ToStr().

void tinyxml2::XMLPrinter::PushAttribute	(	const char *	name,
		double	value
	)

Definition at line 1924 of file tinyxml2.cpp.

References BUF_SIZE, PushAttribute(), and tinyxml2::XMLUtil::ToStr().

void tinyxml2::XMLPrinter::PushComment ( const char * comment )

Add a comment.

Definition at line 2029 of file tinyxml2.cpp.

References _compactMode, _depth, _elementJustOpened, _firstElement, _textDepth, Print(), PrintSpace(), and SealElement().

Referenced by Visit().

void tinyxml2::XMLPrinter::PushDeclaration ( const char * value )

Definition at line 2043 of file tinyxml2.cpp.

References _compactMode, _depth, _elementJustOpened, _firstElement, _textDepth, Print(), PrintSpace(), and SealElement().

Referenced by PushHeader(), and Visit().

void tinyxml2::XMLPrinter::PushHeader	(	bool	writeBOM,
		bool	writeDeclaration
	)

If streaming, write the BOM and declaration.

Definition at line 1858 of file tinyxml2.cpp.

References Print(), PushDeclaration(), TIXML_UTF_LEAD_0, TIXML_UTF_LEAD_1, and TIXML_UTF_LEAD_2.

Referenced by VisitEnter().

void tinyxml2::XMLPrinter::PushText	(	const char *	text,
		bool	cdata = `false`,
		bool	specrow = `false`
	)

Add a text node.

termitovo tisk textu na vlastni radek

termitovo

Definition at line 1965 of file tinyxml2.cpp.

References _depth, _elementJustOpened, _textDepth, Print(), PrintSpace(), PrintString(), and SealElement().

Referenced by PushText(), and Visit().

void tinyxml2::XMLPrinter::PushText ( int value )

Add a text node from an integer.

Definition at line 1989 of file tinyxml2.cpp.

References BUF_SIZE, PushText(), and tinyxml2::XMLUtil::ToStr().

void tinyxml2::XMLPrinter::PushText ( unsigned value )

Add a text node from an unsigned.

Definition at line 1997 of file tinyxml2.cpp.

References BUF_SIZE, PushText(), and tinyxml2::XMLUtil::ToStr().

void tinyxml2::XMLPrinter::PushText ( bool value )

Add a text node from a bool.

Definition at line 2005 of file tinyxml2.cpp.

References BUF_SIZE, PushText(), and tinyxml2::XMLUtil::ToStr().

void tinyxml2::XMLPrinter::PushText ( float value )

Add a text node from a float.

Definition at line 2013 of file tinyxml2.cpp.

References BUF_SIZE, PushText(), and tinyxml2::XMLUtil::ToStr().

void tinyxml2::XMLPrinter::PushText ( double value )

Add a text node from a double.

Definition at line 2021 of file tinyxml2.cpp.

References BUF_SIZE, PushText(), and tinyxml2::XMLUtil::ToStr().

void tinyxml2::XMLPrinter::PushUnknown ( const char * value )

Definition at line 2057 of file tinyxml2.cpp.

References _compactMode, _depth, _elementJustOpened, _firstElement, _textDepth, Print(), PrintSpace(), and SealElement().

Referenced by Visit().

void tinyxml2::XMLPrinter::SealElement ( )

protected

Definition at line 1958 of file tinyxml2.cpp.

References _elementJustOpened, and Print().

Referenced by OpenElement(), PushComment(), PushDeclaration(), PushText(), and PushUnknown().

bool tinyxml2::XMLPrinter::Visit ( const XMLText & )

virtual

Visit a text node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2099 of file tinyxml2.cpp.

References _compactMode, _elementJustOpened, tinyxml2::XMLText::CData(), tinyxml2::XMLNode::NextSibling(), PushText(), and tinyxml2::XMLNode::Value().

bool tinyxml2::XMLPrinter::Visit ( const XMLComment & )

virtual

Visit a comment node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2113 of file tinyxml2.cpp.

References PushComment(), and tinyxml2::XMLNode::Value().

bool tinyxml2::XMLPrinter::Visit ( const XMLDeclaration & )

virtual

Visit a declaration.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2119 of file tinyxml2.cpp.

References PushDeclaration(), and tinyxml2::XMLNode::Value().

bool tinyxml2::XMLPrinter::Visit ( const XMLUnknown & )

virtual

Visit an unknown node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2126 of file tinyxml2.cpp.

References PushUnknown(), and tinyxml2::XMLNode::Value().

bool tinyxml2::XMLPrinter::VisitEnter ( const XMLDocument & )

virtual

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2071 of file tinyxml2.cpp.

References _processEntities, tinyxml2::XMLDocument::HasBOM(), tinyxml2::XMLDocument::ProcessEntities(), and PushHeader().

bool tinyxml2::XMLPrinter::VisitEnter	(	const XMLElement &	,
		const XMLAttribute *
	)

virtual

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2081 of file tinyxml2.cpp.

References tinyxml2::XMLAttribute::Name(), tinyxml2::XMLElement::Name(), tinyxml2::XMLAttribute::Next(), OpenElement(), PushAttribute(), and tinyxml2::XMLAttribute::Value().

virtual bool tinyxml2::XMLPrinter::VisitExit ( const XMLDocument & )

inlinevirtual

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 1941 of file tinyxml2.h.

bool tinyxml2::XMLPrinter::VisitExit ( const XMLElement & )

virtual

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2092 of file tinyxml2.cpp.

References CloseElement().

Member Data Documentation

DynArray< char, 20 > tinyxml2::XMLPrinter::_buffer

private

Definition at line 1993 of file tinyxml2.h.

Referenced by Print(), and XMLPrinter().

bool tinyxml2::XMLPrinter::_compactMode

private

Definition at line 1984 of file tinyxml2.h.

Referenced by CloseElement(), OpenElement(), PushComment(), PushDeclaration(), PushUnknown(), and Visit().

int tinyxml2::XMLPrinter::_depth

private

Definition at line 1981 of file tinyxml2.h.

Referenced by CloseElement(), OpenElement(), PushComment(), PushDeclaration(), PushText(), and PushUnknown().

bool tinyxml2::XMLPrinter::_elementJustOpened

protected

Definition at line 1971 of file tinyxml2.h.

Referenced by CloseElement(), OpenElement(), PushAttribute(), PushComment(), PushDeclaration(), PushText(), PushUnknown(), SealElement(), and Visit().

bool tinyxml2::XMLPrinter::_entityFlag[ENTITY_RANGE]

private

Definition at line 1990 of file tinyxml2.h.

Referenced by PrintString(), and XMLPrinter().

bool tinyxml2::XMLPrinter::_firstElement

private

Definition at line 1979 of file tinyxml2.h.

Referenced by OpenElement(), PushComment(), PushDeclaration(), and PushUnknown().

FILE* tinyxml2::XMLPrinter::_fp

private

Definition at line 1980 of file tinyxml2.h.

Referenced by Print().

bool tinyxml2::XMLPrinter::_processEntities

private

Definition at line 1983 of file tinyxml2.h.

Referenced by PrintString(), and VisitEnter().

bool tinyxml2::XMLPrinter::_restrictedEntityFlag[ENTITY_RANGE]

private

Definition at line 1991 of file tinyxml2.h.

Referenced by PrintString(), and XMLPrinter().

DynArray< const char*, 10 > tinyxml2::XMLPrinter::_stack

protected

Definition at line 1972 of file tinyxml2.h.

Referenced by CloseElement(), and OpenElement().

int tinyxml2::XMLPrinter::_textDepth

private

Definition at line 1982 of file tinyxml2.h.

Referenced by CloseElement(), OpenElement(), PushComment(), PushDeclaration(), PushText(), and PushUnknown().

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

/home/termit/CVUT/MIDAS.act/libs/gelib/src/tinyxml2.h
/home/termit/CVUT/MIDAS.act/libs/gelib/src/tinyxml2.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation