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	ClearBuffer (bool resetToFirstElement=true)
	If in print to memory mode, reset the buffer to the beginning. More...

virtual void	CloseElement (bool compactMode=false)
	If streaming, close the Element. 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...

void	OpenElement (const char *name, bool compactMode=false)
	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, int64_t value)

void	PushAttribute (const char *name, uint64_t value)

void	PushAttribute (const char *name, bool value)

void	PushAttribute (const char *name, double value)

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

void	PushDeclaration (const char *value)

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

void	PushText (const char *text, bool cdata=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 (int64_t value)
	Add a text node from a signed 64bit integer. More...

void	PushText (uint64_t value)
	Add a text node from an unsigned 64bit integer. 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	PushUnknown (const char *value)

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...

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

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

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

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

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

Protected Member Functions
virtual bool	CompactMode (const XMLElement &)

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

virtual void	PrintSpace (int depth)
	Prints out the space before an element. More...

void	Putc (char ch)

void	SealElementIfJustOpened ()

void	Write (const char *data, size_t size)

void	Write (const char *data)

Protected Attributes
bool	_elementJustOpened

DynArray< const char *, 10 >	_stack

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

Private Member Functions
	XMLPrinter (const XMLPrinter &)

XMLPrinter &	operator= (const XMLPrinter &)

void	PrintString (const char *, bool restrictedEntitySet)

Private Attributes
DynArray< char, 20 >	_buffer

bool	_compactMode

int	_depth

bool	_entityFlag [ENTITY_RANGE]

bool	_firstElement

FILE *	_fp

bool	_processEntities

bool	_restrictedEntityFlag [ENTITY_RANGE]

int	_textDepth

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();

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
ENTITY_RANGE
BUF_SIZE

Constructor & Destructor Documentation

◆ XMLPrinter() [1/2]

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.

◆ ~XMLPrinter()

virtual tinyxml2::XMLPrinter::~XMLPrinter ( )

inlinevirtual

◆ XMLPrinter() [2/2]

tinyxml2::XMLPrinter::XMLPrinter ( const XMLPrinter & )

private

Member Function Documentation

◆ ClearBuffer()

void tinyxml2::XMLPrinter::ClearBuffer ( bool resetToFirstElement = true )

inline

If in print to memory mode, reset the buffer to the beginning.

◆ CloseElement()

virtual void tinyxml2::XMLPrinter::CloseElement ( bool compactMode = false )

virtual

If streaming, close the Element.

◆ CompactMode()

virtual bool tinyxml2::XMLPrinter::CompactMode ( const XMLElement & )

inlineprotectedvirtual

◆ CStr()

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

inline

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

◆ CStrSize()

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.)

◆ OpenElement()

void tinyxml2::XMLPrinter::OpenElement	(	const char *	name,
		bool	compactMode = `false`
	)

If streaming, start writing an element.

The element must be closed with CloseElement()

◆ operator=()

XMLPrinter& tinyxml2::XMLPrinter::operator= ( const XMLPrinter & )

private

◆ Print()

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

protected

◆ PrintSpace()

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

protectedvirtual

Prints out the space before an element.

You may override to change the space and tabs used. A PrintSpace() override should call Print().

◆ PrintString()

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

private

◆ PushAttribute() [1/7]

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

If streaming, add an attribute to an open element.

◆ PushAttribute() [2/7]

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

◆ PushAttribute() [3/7]

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

◆ PushAttribute() [4/7]

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

◆ PushAttribute() [5/7]

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

◆ PushAttribute() [6/7]

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

◆ PushAttribute() [7/7]

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

◆ PushComment()

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

Add a comment.

◆ PushDeclaration()

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

◆ PushHeader()

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

If streaming, write the BOM and declaration.

◆ PushText() [1/8]

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

Add a text node.

◆ PushText() [2/8]

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

Add a text node from an integer.

◆ PushText() [3/8]

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

Add a text node from an unsigned.

◆ PushText() [4/8]

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

Add a text node from a signed 64bit integer.

◆ PushText() [5/8]

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

Add a text node from an unsigned 64bit integer.

◆ PushText() [6/8]

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

Add a text node from a bool.

◆ PushText() [7/8]

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

Add a text node from a float.

◆ PushText() [8/8]

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

Add a text node from a double.

◆ PushUnknown()

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

◆ Putc()

void tinyxml2::XMLPrinter::Putc ( char ch )

protected

◆ SealElementIfJustOpened()

void tinyxml2::XMLPrinter::SealElementIfJustOpened ( )

protected

◆ Visit() [1/4]

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

virtual

Visit a text node.

Reimplemented from tinyxml2::XMLVisitor.

◆ Visit() [2/4]

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

virtual

Visit a comment node.

Reimplemented from tinyxml2::XMLVisitor.

◆ Visit() [3/4]

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

virtual

Visit a declaration.

Reimplemented from tinyxml2::XMLVisitor.

◆ Visit() [4/4]

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

virtual

Visit an unknown node.

Reimplemented from tinyxml2::XMLVisitor.

◆ VisitEnter() [1/2]

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

virtual

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

◆ VisitEnter() [2/2]

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

virtual

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

◆ VisitExit() [1/2]

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

inlinevirtual

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

◆ VisitExit() [2/2]

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

virtual

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

◆ Write() [1/2]

void tinyxml2::XMLPrinter::Write	(	const char *	data,
		size_t	size
	)

protected

◆ Write() [2/2]

void tinyxml2::XMLPrinter::Write ( const char * data )

inlineprotected

Member Data Documentation

◆ _buffer

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

private

◆ _compactMode

bool tinyxml2::XMLPrinter::_compactMode

private

◆ _depth

int tinyxml2::XMLPrinter::_depth

private

◆ _elementJustOpened

bool tinyxml2::XMLPrinter::_elementJustOpened

protected

◆ _entityFlag

bool tinyxml2::XMLPrinter::_entityFlag[ENTITY_RANGE]

private

◆ _firstElement

bool tinyxml2::XMLPrinter::_firstElement

private

◆ _fp

FILE* tinyxml2::XMLPrinter::_fp

private

◆ _processEntities

bool tinyxml2::XMLPrinter::_processEntities

private

◆ _restrictedEntityFlag

bool tinyxml2::XMLPrinter::_restrictedEntityFlag[ENTITY_RANGE]

private

◆ _stack

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

protected

◆ _textDepth

int tinyxml2::XMLPrinter::_textDepth

private

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

include/tinyxml2.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ XMLPrinter() [1/2]

◆ ~XMLPrinter()

◆ XMLPrinter() [2/2]

Member Function Documentation

◆ ClearBuffer()

◆ CloseElement()

◆ CompactMode()

◆ CStr()

◆ CStrSize()

◆ OpenElement()

◆ operator=()

◆ Print()

◆ PrintSpace()

◆ PrintString()

◆ PushAttribute() [1/7]

◆ PushAttribute() [2/7]

◆ PushAttribute() [3/7]

◆ PushAttribute() [4/7]

◆ PushAttribute() [5/7]

◆ PushAttribute() [6/7]

◆ PushAttribute() [7/7]

◆ PushComment()

◆ PushDeclaration()

◆ PushHeader()

◆ PushText() [1/8]

◆ PushText() [2/8]

◆ PushText() [3/8]

◆ PushText() [4/8]

◆ PushText() [5/8]

◆ PushText() [6/8]

◆ PushText() [7/8]

◆ PushText() [8/8]

◆ PushUnknown()

◆ Putc()

◆ SealElementIfJustOpened()

◆ Visit() [1/4]

◆ Visit() [2/4]

◆ Visit() [3/4]

◆ Visit() [4/4]

◆ VisitEnter() [1/2]

◆ VisitEnter() [2/2]

◆ VisitExit() [1/2]

◆ VisitExit() [2/2]

◆ Write() [1/2]

◆ Write() [2/2]

Member Data Documentation

◆ _buffer

◆ _compactMode

◆ _depth

◆ _elementJustOpened

◆ _entityFlag

◆ _firstElement

◆ _fp

◆ _processEntities

◆ _restrictedEntityFlag

◆ _stack

◆ _textDepth