#include <tinyxml2.h>

Inheritance diagram for Aws::External::tinyxml2::XMLPrinter:

[legend]

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.

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.

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 (int64_t 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 PushComment (const char *comment)

Add a comment.

void PushDeclaration (const char *value)

void PushUnknown (const char *value)

virtual bool VisitEnter (const XMLDocument &)

Visit a document.

virtual bool VisitExit (const XMLDocument &)

Visit a document.

virtual bool VisitEnter (const XMLElement &element, const XMLAttribute *attribute)

Visit an element.

virtual bool VisitExit (const XMLElement &element)

Visit an element.

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.

const char * CStr () const

int CStrSize () const

void ClearBuffer ()

Public Member Functions inherited from Aws::External::tinyxml2::XMLVisitor

virtual ~XMLVisitor ()

Protected Member Functions

virtual bool CompactMode (const XMLElement &)

virtual void PrintSpace (int depth)

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

void Write (const char *data, size_t size)

void Write (const char *data)

void Putc (char ch)

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

Constructor & Destructor Documentation

◆ XMLPrinter()

Aws::External::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 Aws::External::tinyxml2::XMLPrinter::~XMLPrinter ( )

inlinevirtual

Definition at line 2166 of file tinyxml2.h.

Member Function Documentation

◆ ClearBuffer()

void Aws::External::tinyxml2::XMLPrinter::ClearBuffer ( )

inline

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

Definition at line 2237 of file tinyxml2.h.

◆ CloseElement()

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

virtual

If streaming, close the Element.

◆ CompactMode()

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

inlineprotectedvirtual

Definition at line 2244 of file tinyxml2.h.

◆ CStr()

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

inline

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

Definition at line 2222 of file tinyxml2.h.

◆ CStrSize()

int Aws::External::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 2230 of file tinyxml2.h.

◆ OpenElement()

void Aws::External::tinyxml2::XMLPrinter::OpenElement ( const char * name,

bool compactMode = false

)

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

◆ Print()

void Aws::External::tinyxml2::XMLPrinter::Print ( const char * format,

...

)

protected

◆ PrintSpace()

virtual void Aws::External::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().