#include <tinyxml2.h>

Inheritance diagram for ttv::xml::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 ()

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

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

Private Member Functions
void	PrintString (const char *, bool restrictedEntitySet)

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

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
ENTITY_RANGE
BUF_SIZE

Constructor & Destructor Documentation

◆ XMLPrinter()

ttv::xml::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 ttv::xml::XMLPrinter::~XMLPrinter ( )

inlinevirtual

Member Function Documentation

◆ ClearBuffer()

void ttv::xml::XMLPrinter::ClearBuffer ( )

inline

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

◆ CloseElement()

virtual void ttv::xml::XMLPrinter::CloseElement ( bool compactMode = false )

virtual

If streaming, close the Element.

◆ CompactMode()

virtual bool ttv::xml::XMLPrinter::CompactMode ( const XMLElement & )

inlineprotectedvirtual

◆ CStr()

const char* ttv::xml::XMLPrinter::CStr ( ) const

inline

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

◆ CStrSize()

int ttv::xml::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 ttv::xml::XMLPrinter::OpenElement	(	const char *	name,
		bool	compactMode = `false`
	)

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

◆ Print()

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

protected

◆ PrintSpace()

virtual void ttv::xml::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 ttv::xml::XMLPrinter::PrintString	(	const char *	,
		bool	restrictedEntitySet
	)

private

◆ PushAttribute() [1/6]

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

If streaming, add an attribute to an open element.

◆ PushAttribute() [2/6]

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

◆ PushAttribute() [3/6]

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

◆ PushAttribute() [4/6]

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

◆ PushAttribute() [5/6]

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

◆ PushAttribute() [6/6]

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

◆ PushComment()

void ttv::xml::XMLPrinter::PushComment ( const char * comment )

Add a comment.

◆ PushDeclaration()

void ttv::xml::XMLPrinter::PushDeclaration ( const char * value )

◆ PushHeader()

void ttv::xml::XMLPrinter::PushHeader	(	bool	writeBOM,
		bool	writeDeclaration
	)

If streaming, write the BOM and declaration.

◆ PushText() [1/7]

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

Add a text node.

◆ PushText() [2/7]

void ttv::xml::XMLPrinter::PushText ( int value )

Add a text node from an integer.

◆ PushText() [3/7]

void ttv::xml::XMLPrinter::PushText ( unsigned value )

Add a text node from an unsigned.

◆ PushText() [4/7]

void ttv::xml::XMLPrinter::PushText ( int64_t value )

Add a text node from an unsigned.

◆ PushText() [5/7]

void ttv::xml::XMLPrinter::PushText ( bool value )

Add a text node from a bool.

◆ PushText() [6/7]

void ttv::xml::XMLPrinter::PushText ( float value )

Add a text node from a float.

◆ PushText() [7/7]

void ttv::xml::XMLPrinter::PushText ( double value )

Add a text node from a double.

◆ PushUnknown()

void ttv::xml::XMLPrinter::PushUnknown ( const char * value )

◆ SealElementIfJustOpened()

void ttv::xml::XMLPrinter::SealElementIfJustOpened ( )

protected

◆ Visit() [1/4]

virtual bool ttv::xml::XMLPrinter::Visit ( const XMLText & )

virtual

Visit a text node.

Reimplemented from ttv::xml::XMLVisitor.

◆ Visit() [2/4]

virtual bool ttv::xml::XMLPrinter::Visit ( const XMLComment & )

virtual

Visit a comment node.

Reimplemented from ttv::xml::XMLVisitor.

◆ Visit() [3/4]

virtual bool ttv::xml::XMLPrinter::Visit ( const XMLDeclaration & )

virtual

Visit a declaration.

Reimplemented from ttv::xml::XMLVisitor.

◆ Visit() [4/4]

virtual bool ttv::xml::XMLPrinter::Visit ( const XMLUnknown & )

virtual

Visit an unknown node.

Reimplemented from ttv::xml::XMLVisitor.

◆ VisitEnter() [1/2]

virtual bool ttv::xml::XMLPrinter::VisitEnter ( const XMLDocument & )

virtual

Visit a document.

Reimplemented from ttv::xml::XMLVisitor.

◆ VisitEnter() [2/2]

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

virtual

Visit an element.

Reimplemented from ttv::xml::XMLVisitor.

◆ VisitExit() [1/2]

virtual bool ttv::xml::XMLPrinter::VisitExit ( const XMLDocument & )

inlinevirtual

Visit a document.

Reimplemented from ttv::xml::XMLVisitor.

◆ VisitExit() [2/2]

virtual bool ttv::xml::XMLPrinter::VisitExit ( const XMLElement & )

virtual

Visit an element.

Reimplemented from ttv::xml::XMLVisitor.

Member Data Documentation

◆ _buffer

DynArray< char, 20 > ttv::xml::XMLPrinter::_buffer

private

◆ _compactMode

bool ttv::xml::XMLPrinter::_compactMode

private

◆ _depth

int ttv::xml::XMLPrinter::_depth

private

◆ _elementJustOpened

bool ttv::xml::XMLPrinter::_elementJustOpened

protected

◆ _entityFlag

bool ttv::xml::XMLPrinter::_entityFlag[ENTITY_RANGE]

private

◆ _firstElement

bool ttv::xml::XMLPrinter::_firstElement

private

◆ _fp

FILE* ttv::xml::XMLPrinter::_fp

private

◆ _processEntities

bool ttv::xml::XMLPrinter::_processEntities

private

◆ _restrictedEntityFlag

bool ttv::xml::XMLPrinter::_restrictedEntityFlag[ENTITY_RANGE]

private

◆ _stack

DynArray< const char*, 10 > ttv::xml::XMLPrinter::_stack

protected

◆ _textDepth

int ttv::xml::XMLPrinter::_textDepth

private

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

modules/core/core_common/include/twitchsdk/core/xml/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()

◆ ~XMLPrinter()

Member Function Documentation

◆ ClearBuffer()

◆ CloseElement()

◆ CompactMode()

◆ CStr()

◆ CStrSize()

◆ OpenElement()

◆ Print()

◆ PrintSpace()

◆ PrintString()

◆ PushAttribute() [1/6]

◆ PushAttribute() [2/6]

◆ PushAttribute() [3/6]

◆ PushAttribute() [4/6]

◆ PushAttribute() [5/6]

◆ PushAttribute() [6/6]

◆ PushComment()

◆ PushDeclaration()

◆ PushHeader()

◆ PushText() [1/7]

◆ PushText() [2/7]

◆ PushText() [3/7]

◆ PushText() [4/7]

◆ PushText() [5/7]

◆ PushText() [6/7]

◆ PushText() [7/7]

◆ PushUnknown()

◆ 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]

Member Data Documentation

◆ _buffer

◆ _compactMode

◆ _depth

◆ _elementJustOpened

◆ _entityFlag

◆ _firstElement

◆ _fp

◆ _processEntities

◆ _restrictedEntityFlag

◆ _stack

◆ _textDepth