#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLPrinter:

Public Member Functions
void	CloseElement ()
	If streaming, close the Element.
const char *	CStr () const
int	CStrSize () const
void	OpenElement (const char *name)
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)
	~XMLPrinter ()
Private Types
enum	{ ENTITY_RANGE = 64, BUF_SIZE = 200 }
Private Member Functions
void	Print (const char *format,...)
void	PrintSpace (int depth)
void	PrintString (const char *, bool restrictedEntitySet)
void	SealElement ()
Private Attributes
DynArray< char, 20 >	_buffer
bool	_compactMode
int	_depth
bool	_elementJustOpened
bool	_entityFlag [ENTITY_RANGE]
bool	_firstElement
FILE *	_fp
bool	_processEntities
bool	_restrictedEntityFlag [ENTITY_RANGE]
DynArray< const char *, 10 >	_stack
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 1804 of file tinyxml2.h.

Member Enumeration Documentation

anonymous enum [private]

Enumerator:

ENTITY_RANGE
BUF_SIZE

Definition at line 1893 of file tinyxml2.h.

Constructor & Destructor Documentation

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

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

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

Definition at line 1814 of file tinyxml2.h.

Member Function Documentation

void tinyxml2::XMLPrinter::CloseElement ( )

If streaming, close the Element.

Definition at line 1914 of file tinyxml2.cpp.

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 1867 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 1875 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 1854 of file tinyxml2.cpp.

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

Definition at line 1760 of file tinyxml2.cpp.

void tinyxml2::XMLPrinter::PrintSpace ( int depth ) [private]

Definition at line 1796 of file tinyxml2.cpp.

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

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

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

Definition at line 1882 of file tinyxml2.cpp.

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

Definition at line 1890 of file tinyxml2.cpp.

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

Definition at line 1898 of file tinyxml2.cpp.

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

Definition at line 1906 of file tinyxml2.cpp.

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

Add a comment.

Definition at line 2004 of file tinyxml2.cpp.

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

Definition at line 2018 of file tinyxml2.cpp.

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

If streaming, write the BOM and declaration.

Definition at line 1842 of file tinyxml2.cpp.

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

Add a text node.

Definition at line 1947 of file tinyxml2.cpp.

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

Add a text node from an integer.

Definition at line 1964 of file tinyxml2.cpp.

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

Add a text node from an unsigned.

Definition at line 1972 of file tinyxml2.cpp.

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

Add a text node from a bool.

Definition at line 1980 of file tinyxml2.cpp.

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

Add a text node from a float.

Definition at line 1988 of file tinyxml2.cpp.

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

Add a text node from a double.

Definition at line 1996 of file tinyxml2.cpp.

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

Definition at line 2032 of file tinyxml2.cpp.

void tinyxml2::XMLPrinter::SealElement ( ) [private]

Definition at line 1940 of file tinyxml2.cpp.

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

Visit a text node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2074 of file tinyxml2.cpp.

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

Visit a comment node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2081 of file tinyxml2.cpp.

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

Visit a declaration.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2087 of file tinyxml2.cpp.

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

Visit an unknown node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2094 of file tinyxml2.cpp.

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

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2046 of file tinyxml2.cpp.

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

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2056 of file tinyxml2.cpp.

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

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 1851 of file tinyxml2.h.

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

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2067 of file tinyxml2.cpp.

Member Data Documentation

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

Definition at line 1901 of file tinyxml2.h.

bool tinyxml2::XMLPrinter::_compactMode [private]

Definition at line 1891 of file tinyxml2.h.

int tinyxml2::XMLPrinter::_depth [private]

Definition at line 1888 of file tinyxml2.h.

bool tinyxml2::XMLPrinter::_elementJustOpened [private]

Definition at line 1885 of file tinyxml2.h.

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

Definition at line 1897 of file tinyxml2.h.

bool tinyxml2::XMLPrinter::_firstElement [private]

Definition at line 1886 of file tinyxml2.h.

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

Definition at line 1887 of file tinyxml2.h.

bool tinyxml2::XMLPrinter::_processEntities [private]

Definition at line 1890 of file tinyxml2.h.

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

Definition at line 1898 of file tinyxml2.h.

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

Definition at line 1900 of file tinyxml2.h.

int tinyxml2::XMLPrinter::_textDepth [private]

Definition at line 1889 of file tinyxml2.h.

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation