#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLPrinter:

Public Member Functions
void	ClearBuffer ()
virtual void	CloseElement (bool compactMode=false)
	If streaming, close the Element.
const char *	CStr () const
int	CStrSize () const
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.
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)
void	PushComment (const char *comment)
	Add a comment.
void	PushDeclaration (const char *value)
void	PushHeader (bool writeBOM, bool writeDeclaration)
void	PushText (const char *text, bool cdata=false)
	Add a text node.
void	PushText (int value)
	Add a text node from an integer.
void	PushText (unsigned value)
	Add a text node from an unsigned.
void	PushText (bool value)
	Add a text node from a bool.
void	PushText (float value)
	Add a text node from a float.
void	PushText (double value)
	Add a text node from a double.
void	PushUnknown (const char *value)
virtual bool	Visit (const XMLText &text)
	Visit a text node.
virtual bool	Visit (const XMLComment &comment)
	Visit a comment node.
virtual bool	Visit (const XMLDeclaration &declaration)
	Visit a declaration.
virtual bool	Visit (const XMLUnknown &unknown)
	Visit an unknown node.
virtual bool	VisitEnter (const XMLDocument &)
	Visit a document.
virtual bool	VisitEnter (const XMLElement &element, const XMLAttribute *attribute)
	Visit an element.
virtual bool	VisitExit (const XMLDocument &)
	Visit a document.
virtual bool	VisitExit (const XMLElement &element)
	Visit an element.
	XMLPrinter (FILE *file=0, bool compact=false, int depth=0)
virtual	~XMLPrinter ()
Protected Member Functions
virtual bool	CompactMode (const XMLElement &)
void	Print (const char *format,...)
virtual void	PrintSpace (int depth)
void	SealElementIfJustOpened ()
Protected Attributes
bool	_elementJustOpened
DynArray< const char *, 10 >	_stack
Private Types
enum	{ ENTITY_RANGE = 64, BUF_SIZE = 200 }
Private Member Functions
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();

Definition at line 1989 of file tinyxml2.h.

Member Enumeration Documentation

anonymous enum [private]

Enumerator:

ENTITY_RANGE
BUF_SIZE

Definition at line 2095 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 2102 of file tinyxml2.cpp.

virtual tinyxml2::XMLPrinter::~XMLPrinter ( ) [inline, virtual]

Definition at line 1999 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 2067 of file tinyxml2.h.

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

If streaming, close the Element.

Definition at line 2279 of file tinyxml2.cpp.

virtual bool tinyxml2::XMLPrinter::CompactMode ( const XMLElement & ) [inline, protected, virtual]

Definition at line 2073 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 2052 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 2060 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 2219 of file tinyxml2.cpp.

void tinyxml2::XMLPrinter::Print	(	const char *	format,
			...
	)		`[protected]`

Definition at line 2127 of file tinyxml2.cpp.

void tinyxml2::XMLPrinter::PrintSpace ( int depth ) [protected, virtual]

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

void tinyxml2::XMLPrinter::PrintString	(	const char *	p,
		bool	restrictedEntitySet
	)		`[private]`

Definition at line 2157 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 2238 of file tinyxml2.cpp.

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

Definition at line 2247 of file tinyxml2.cpp.

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

Definition at line 2255 of file tinyxml2.cpp.

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

Definition at line 2263 of file tinyxml2.cpp.

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

Definition at line 2271 of file tinyxml2.cpp.

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

Add a comment.

Definition at line 2368 of file tinyxml2.cpp.

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

Definition at line 2380 of file tinyxml2.cpp.

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

If streaming, write the BOM and declaration.

Definition at line 2207 of file tinyxml2.cpp.

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

Add a text node.

Definition at line 2315 of file tinyxml2.cpp.

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

Add a text node from an integer.

Definition at line 2328 of file tinyxml2.cpp.

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

Add a text node from an unsigned.

Definition at line 2336 of file tinyxml2.cpp.

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

Add a text node from a bool.

Definition at line 2344 of file tinyxml2.cpp.

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

Add a text node from a float.

Definition at line 2352 of file tinyxml2.cpp.

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

Add a text node from a double.

Definition at line 2360 of file tinyxml2.cpp.

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

Definition at line 2392 of file tinyxml2.cpp.

void tinyxml2::XMLPrinter::SealElementIfJustOpened ( ) [protected]

Definition at line 2305 of file tinyxml2.cpp.

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

Visit a text node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2437 of file tinyxml2.cpp.

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

Visit a comment node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2444 of file tinyxml2.cpp.

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

Visit a declaration.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2450 of file tinyxml2.cpp.

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

Visit an unknown node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2457 of file tinyxml2.cpp.

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

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2404 of file tinyxml2.cpp.

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

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2414 of file tinyxml2.cpp.

virtual bool tinyxml2::XMLPrinter::VisitExit ( const XMLDocument & ) [inline, virtual]

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2036 of file tinyxml2.h.

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

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2430 of file tinyxml2.cpp.

Member Data Documentation

DynArray< char, 20 > tinyxml2::XMLPrinter::_buffer [private]

Definition at line 2102 of file tinyxml2.h.

bool tinyxml2::XMLPrinter::_compactMode [private]

Definition at line 2093 of file tinyxml2.h.

int tinyxml2::XMLPrinter::_depth [private]

Definition at line 2090 of file tinyxml2.h.

bool tinyxml2::XMLPrinter::_elementJustOpened [protected]

Definition at line 2082 of file tinyxml2.h.

bool tinyxml2::XMLPrinter::_entityFlag[ENTITY_RANGE] [private]

Definition at line 2099 of file tinyxml2.h.

bool tinyxml2::XMLPrinter::_firstElement [private]

Definition at line 2088 of file tinyxml2.h.

FILE* tinyxml2::XMLPrinter::_fp [private]

Definition at line 2089 of file tinyxml2.h.

bool tinyxml2::XMLPrinter::_processEntities [private]

Definition at line 2092 of file tinyxml2.h.

bool tinyxml2::XMLPrinter::_restrictedEntityFlag[ENTITY_RANGE] [private]

Definition at line 2100 of file tinyxml2.h.

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

Definition at line 2083 of file tinyxml2.h.

int tinyxml2::XMLPrinter::_textDepth [private]

Definition at line 2091 of file tinyxml2.h.

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

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