#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLPrinter:

Public Member Functions
	XMLPrinter (FILE *file=0, bool compact=false, int depth=0)

virtual	~XMLPrinter ()

void	PushHeader (bool writeBOM, bool writeDeclaration)

void	OpenElement (const char *name, bool compactMode=false)

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, bool value)

void	PushAttribute (const char *name, double value)

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

int	CStrSize () const

void	ClearBuffer ()

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

Protected Member Functions
virtual bool	CompactMode (const XMLElement &)

virtual void	PrintSpace (int depth)

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

void	SealElementIfJustOpened ()

Protected Attributes
bool	_elementJustOpened

DynArray< const char *, 10 >	_stack

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 2055 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 2282 of file tinyxml2.cpp.

virtual tinyxml2::XMLPrinter::~XMLPrinter ( )

inlinevirtual

Definition at line 2065 of file tinyxml2.h.

Member Function Documentation

void tinyxml2::XMLPrinter::ClearBuffer ( )

inline

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

Definition at line 2136 of file tinyxml2.h.

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

virtual

If streaming, close the Element.

Definition at line 2467 of file tinyxml2.cpp.

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

inlineprotectedvirtual

Definition at line 2142 of file tinyxml2.h.

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 2121 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 2129 of file tinyxml2.h.

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

If streaming, start writing an element. The element must be closed with CloseElement()

Definition at line 2399 of file tinyxml2.cpp.

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

protected

Definition at line 2307 of file tinyxml2.cpp.

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

Definition at line 2329 of file tinyxml2.cpp.

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

If streaming, add an attribute to an open element.

Definition at line 2418 of file tinyxml2.cpp.

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

Definition at line 2427 of file tinyxml2.cpp.

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

Definition at line 2435 of file tinyxml2.cpp.

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

Definition at line 2443 of file tinyxml2.cpp.

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

Definition at line 2451 of file tinyxml2.cpp.

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

Definition at line 2459 of file tinyxml2.cpp.

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

Add a comment.

Definition at line 2563 of file tinyxml2.cpp.

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

Definition at line 2575 of file tinyxml2.cpp.

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

If streaming, write the BOM and declaration.

Definition at line 2387 of file tinyxml2.cpp.

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

Add a text node.

Definition at line 2503 of file tinyxml2.cpp.

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

Add a text node from an integer.

Definition at line 2523 of file tinyxml2.cpp.

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

Add a text node from an unsigned.

Definition at line 2531 of file tinyxml2.cpp.

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

Add a text node from an unsigned.

Definition at line 2516 of file tinyxml2.cpp.

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

Add a text node from a bool.

Definition at line 2539 of file tinyxml2.cpp.

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

Add a text node from a float.

Definition at line 2547 of file tinyxml2.cpp.

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

Add a text node from a double.

Definition at line 2555 of file tinyxml2.cpp.

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

Definition at line 2587 of file tinyxml2.cpp.

void tinyxml2::XMLPrinter::SealElementIfJustOpened ( )

protected

Definition at line 2493 of file tinyxml2.cpp.

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

virtual

Visit a text node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2632 of file tinyxml2.cpp.

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

virtual

Visit a comment node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2639 of file tinyxml2.cpp.

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

virtual

Visit a declaration.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2645 of file tinyxml2.cpp.

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

virtual

Visit an unknown node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2652 of file tinyxml2.cpp.

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

virtual

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2599 of file tinyxml2.cpp.

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

virtual

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2609 of file tinyxml2.cpp.

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

inlinevirtual

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2105 of file tinyxml2.h.

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

virtual

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2625 of file tinyxml2.cpp.

Member Data Documentation

bool tinyxml2::XMLPrinter::_elementJustOpened

protected

Definition at line 2151 of file tinyxml2.h.

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

protected

Definition at line 2152 of file tinyxml2.h.

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

src/tinyxml2/tinyxml2.h
src/tinyxml2/tinyxml2.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation