GOAT (Geometrical optics application tool) 0.1
Loading...
Searching...
No Matches
tinyxml2::XMLPrinter Class Reference

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLPrinter:
tinyxml2::XMLVisitor tinyxml2::XMLVisitor

Public Member Functions

void ClearBuffer (bool resetToFirstElement=true)
void ClearBuffer (bool resetToFirstElement=true)
virtual void CloseElement (bool compactMode=false)
 If streaming, close the Element.
virtual void CloseElement (bool compactMode=false)
 If streaming, close the Element.
const char * CStr () const
const char * CStr () const
int CStrSize () const
int CStrSize () const
void OpenElement (const char *name, bool compactMode=false)
void OpenElement (const char *name, bool compactMode=false)
void PushAttribute (const char *name, bool value)
void PushAttribute (const char *name, bool value)
void PushAttribute (const char *name, const char *value)
 If streaming, add an attribute to an open element.
void PushAttribute (const char *name, const char *value)
 If streaming, add an attribute to an open element.
void PushAttribute (const char *name, double value)
void PushAttribute (const char *name, double value)
void PushAttribute (const char *name, int value)
void PushAttribute (const char *name, int value)
void PushAttribute (const char *name, int64_t value)
void PushAttribute (const char *name, int64_t value)
void PushAttribute (const char *name, uint64_t value)
void PushAttribute (const char *name, uint64_t value)
void PushAttribute (const char *name, unsigned value)
void PushAttribute (const char *name, unsigned value)
void PushComment (const char *comment)
 Add a comment.
void PushComment (const char *comment)
 Add a comment.
void PushDeclaration (const char *value)
void PushDeclaration (const char *value)
void PushHeader (bool writeBOM, bool writeDeclaration)
void PushHeader (bool writeBOM, bool writeDeclaration)
void PushText (bool value)
 Add a text node from a bool.
void PushText (bool value)
 Add a text node from a bool.
void PushText (const char *text, bool cdata=false)
 Add a text node.
void PushText (const char *text, bool cdata=false)
 Add a text node.
void PushText (double value)
 Add a text node from a double.
void PushText (double value)
 Add a text node from a double.
void PushText (float value)
 Add a text node from a float.
void PushText (float value)
 Add a text node from a float.
void PushText (int value)
 Add a text node from an integer.
void PushText (int value)
 Add a text node from an integer.
void PushText (int64_t value)
 Add a text node from a signed 64bit integer.
void PushText (int64_t value)
 Add a text node from a signed 64bit integer.
void PushText (uint64_t value)
 Add a text node from an unsigned 64bit integer.
void PushText (uint64_t value)
 Add a text node from an unsigned 64bit integer.
void PushText (unsigned value)
 Add a text node from an unsigned.
void PushText (unsigned value)
 Add a text node from an unsigned.
void PushUnknown (const char *value)
void PushUnknown (const char *value)
virtual bool Visit (const XMLComment &comment)
 Visit a comment node.
virtual bool Visit (const XMLComment &comment)
 Visit a comment node.
virtual bool Visit (const XMLDeclaration &declaration)
 Visit a declaration.
virtual bool Visit (const XMLDeclaration &declaration)
 Visit a declaration.
virtual bool Visit (const XMLText &text)
 Visit a text node.
virtual bool Visit (const XMLText &text)
 Visit a text node.
virtual bool Visit (const XMLUnknown &unknown)
 Visit an unknown node.
virtual bool Visit (const XMLUnknown &unknown)
 Visit an unknown node.
virtual bool VisitEnter (const XMLDocument &)
 Visit a document.
virtual bool VisitEnter (const XMLDocument &)
 Visit a document.
virtual bool VisitEnter (const XMLElement &element, const XMLAttribute *attribute)
 Visit an element.
virtual bool VisitEnter (const XMLElement &element, const XMLAttribute *attribute)
 Visit an element.
virtual bool VisitExit (const XMLDocument &)
 Visit a document.
virtual bool VisitExit (const XMLDocument &)
 Visit a document.
virtual bool VisitExit (const XMLElement &element)
 Visit an element.
virtual bool VisitExit (const XMLElement &element)
 Visit an element.
 XMLPrinter (FILE *file=0, bool compact=false, int depth=0)
 XMLPrinter (FILE *file=0, bool compact=false, int depth=0)
virtual ~XMLPrinter ()
virtual ~XMLPrinter ()
Public Member Functions inherited from tinyxml2::XMLVisitor
virtual ~XMLVisitor ()
virtual ~XMLVisitor ()

Protected Member Functions

virtual bool CompactMode (const XMLElement &)
virtual bool CompactMode (const XMLElement &)
virtual void Print (const char *format,...)
virtual void Print (const char *format,...)
virtual void PrintSpace (int depth)
virtual void PrintSpace (int depth)
virtual void Putc (char ch)
virtual void Putc (char ch)
void SealElementIfJustOpened ()
void SealElementIfJustOpened ()
void Write (const char *data)
void Write (const char *data)
virtual void Write (const char *data, size_t size)
virtual void Write (const char *data, size_t size)

Protected Attributes

bool _elementJustOpened
DynArray< const char *, 10 > _stack

Private Types

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

Private Member Functions

XMLPrinteroperator= (const XMLPrinter &)
XMLPrinteroperator= (const XMLPrinter &)
void PrepareForNewNode (bool compactMode)
void PrepareForNewNode (bool compactMode)
void PrintString (const char *, bool restrictedEntitySet)
void PrintString (const char *, bool restrictedEntitySet)
 XMLPrinter (const XMLPrinter &)
 XMLPrinter (const XMLPrinter &)

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:

  1. Print to memory.
  2. Print to a file you provide.
  3. 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 2237 of file tinyxml2.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private
Enumerator
ENTITY_RANGE 
BUF_SIZE 

Definition at line 2359 of file tinyxml2.h.

◆ anonymous enum

anonymous enum
private
Enumerator
ENTITY_RANGE 
BUF_SIZE 

Definition at line 2359 of file tinyxml2.h.

Constructor & Destructor Documentation

◆ XMLPrinter() [1/4]

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() [1/2]

virtual tinyxml2::XMLPrinter::~XMLPrinter ( )
inlinevirtual

Definition at line 2247 of file tinyxml2.h.

◆ XMLPrinter() [2/4]

tinyxml2::XMLPrinter::XMLPrinter ( const XMLPrinter & )
private

◆ XMLPrinter() [3/4]

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() [2/2]

virtual tinyxml2::XMLPrinter::~XMLPrinter ( )
inlinevirtual

Definition at line 2247 of file tinyxml2.h.

◆ XMLPrinter() [4/4]

tinyxml2::XMLPrinter::XMLPrinter ( const XMLPrinter & )
private

Member Function Documentation

◆ ClearBuffer() [1/2]

void tinyxml2::XMLPrinter::ClearBuffer ( bool resetToFirstElement = true)
inline

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

Definition at line 2321 of file tinyxml2.h.

◆ ClearBuffer() [2/2]

void tinyxml2::XMLPrinter::ClearBuffer ( bool resetToFirstElement = true)
inline

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

Definition at line 2321 of file tinyxml2.h.

◆ CloseElement() [1/2]

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

If streaming, close the Element.

◆ CloseElement() [2/2]

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

If streaming, close the Element.

◆ CompactMode() [1/2]

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

Definition at line 2328 of file tinyxml2.h.

◆ CompactMode() [2/2]

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

Definition at line 2328 of file tinyxml2.h.

◆ CStr() [1/2]

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

◆ CStr() [2/2]

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

◆ CStrSize() [1/2]

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

◆ CStrSize() [2/2]

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

◆ OpenElement() [1/2]

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

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

◆ OpenElement() [2/2]

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

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

◆ operator=() [1/2]

XMLPrinter & tinyxml2::XMLPrinter::operator= ( const XMLPrinter & )
private

◆ operator=() [2/2]

XMLPrinter & tinyxml2::XMLPrinter::operator= ( const XMLPrinter & )
private

◆ PrepareForNewNode() [1/2]

void tinyxml2::XMLPrinter::PrepareForNewNode ( bool compactMode)
private

Prepares to write a new node. This includes sealing an element that was just opened, and writing any whitespace necessary if not in compact mode.

◆ PrepareForNewNode() [2/2]

void tinyxml2::XMLPrinter::PrepareForNewNode ( bool compactMode)
private

Prepares to write a new node. This includes sealing an element that was just opened, and writing any whitespace necessary if not in compact mode.

◆ Print() [1/2]

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

◆ Print() [2/2]

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

◆ PrintSpace() [1/2]

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

◆ PrintSpace() [2/2]

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

◆ PrintString() [1/2]

void tinyxml2::XMLPrinter::PrintString ( const char * ,
bool restrictedEntitySet )
private

◆ PrintString() [2/2]

void tinyxml2::XMLPrinter::PrintString ( const char * ,
bool restrictedEntitySet )
private

◆ PushAttribute() [1/14]

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

◆ PushAttribute() [2/14]

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

◆ PushAttribute() [3/14]

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

If streaming, add an attribute to an open element.

◆ PushAttribute() [4/14]

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

If streaming, add an attribute to an open element.

◆ PushAttribute() [5/14]

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

◆ PushAttribute() [6/14]

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

◆ PushAttribute() [7/14]

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

◆ PushAttribute() [8/14]

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

◆ PushAttribute() [9/14]

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

◆ PushAttribute() [10/14]

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

◆ PushAttribute() [11/14]

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

◆ PushAttribute() [12/14]

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

◆ PushAttribute() [13/14]

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

◆ PushAttribute() [14/14]

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

◆ PushComment() [1/2]

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

Add a comment.

◆ PushComment() [2/2]

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

Add a comment.

◆ PushDeclaration() [1/2]

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

◆ PushDeclaration() [2/2]

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

◆ PushHeader() [1/2]

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

If streaming, write the BOM and declaration.

◆ PushHeader() [2/2]

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

If streaming, write the BOM and declaration.

◆ PushText() [1/16]

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

Add a text node from a bool.

◆ PushText() [2/16]

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

Add a text node from a bool.

◆ PushText() [3/16]

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

Add a text node.

◆ PushText() [4/16]

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

Add a text node.

◆ PushText() [5/16]

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

Add a text node from a double.

◆ PushText() [6/16]

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

Add a text node from a double.

◆ PushText() [7/16]

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

Add a text node from a float.

◆ PushText() [8/16]

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

Add a text node from a float.

◆ PushText() [9/16]

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

Add a text node from an integer.

◆ PushText() [10/16]

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

Add a text node from an integer.

◆ PushText() [11/16]

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

Add a text node from a signed 64bit integer.

◆ PushText() [12/16]

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

Add a text node from a signed 64bit integer.

◆ PushText() [13/16]

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

Add a text node from an unsigned 64bit integer.

◆ PushText() [14/16]

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

Add a text node from an unsigned 64bit integer.

◆ PushText() [15/16]

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

Add a text node from an unsigned.

◆ PushText() [16/16]

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

Add a text node from an unsigned.

◆ PushUnknown() [1/2]

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

◆ PushUnknown() [2/2]

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

◆ Putc() [1/2]

virtual void tinyxml2::XMLPrinter::Putc ( char ch)
protectedvirtual

◆ Putc() [2/2]

virtual void tinyxml2::XMLPrinter::Putc ( char ch)
protectedvirtual

◆ SealElementIfJustOpened() [1/2]

void tinyxml2::XMLPrinter::SealElementIfJustOpened ( )
protected

◆ SealElementIfJustOpened() [2/2]

void tinyxml2::XMLPrinter::SealElementIfJustOpened ( )
protected

◆ Visit() [1/8]

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

Visit a comment node.

Reimplemented from tinyxml2::XMLVisitor.

◆ Visit() [2/8]

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

Visit a comment node.

Reimplemented from tinyxml2::XMLVisitor.

◆ Visit() [3/8]

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

Visit a declaration.

Reimplemented from tinyxml2::XMLVisitor.

◆ Visit() [4/8]

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

Visit a declaration.

Reimplemented from tinyxml2::XMLVisitor.

◆ Visit() [5/8]

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

Visit a text node.

Reimplemented from tinyxml2::XMLVisitor.

◆ Visit() [6/8]

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

Visit a text node.

Reimplemented from tinyxml2::XMLVisitor.

◆ Visit() [7/8]

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

Visit an unknown node.

Reimplemented from tinyxml2::XMLVisitor.

◆ Visit() [8/8]

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

Visit an unknown node.

Reimplemented from tinyxml2::XMLVisitor.

◆ VisitEnter() [1/4]

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

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

◆ VisitEnter() [2/4]

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

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

◆ VisitEnter() [3/4]

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

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

◆ VisitEnter() [4/4]

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

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

◆ VisitExit() [1/4]

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

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2290 of file tinyxml2.h.

◆ VisitExit() [2/4]

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

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2290 of file tinyxml2.h.

◆ VisitExit() [3/4]

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

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

◆ VisitExit() [4/4]

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

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

◆ Write() [1/4]

void tinyxml2::XMLPrinter::Write ( const char * data)
inlineprotected

Definition at line 2338 of file tinyxml2.h.

◆ Write() [2/4]

void tinyxml2::XMLPrinter::Write ( const char * data)
inlineprotected

Definition at line 2338 of file tinyxml2.h.

◆ Write() [3/4]

virtual void tinyxml2::XMLPrinter::Write ( const char * data,
size_t size )
protectedvirtual

◆ Write() [4/4]

virtual void tinyxml2::XMLPrinter::Write ( const char * data,
size_t size )
protectedvirtual

Member Data Documentation

◆ _buffer

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

Definition at line 2366 of file tinyxml2.h.

◆ _compactMode

bool tinyxml2::XMLPrinter::_compactMode
private

Definition at line 2357 of file tinyxml2.h.

◆ _depth

int tinyxml2::XMLPrinter::_depth
private

Definition at line 2354 of file tinyxml2.h.

◆ _elementJustOpened

bool tinyxml2::XMLPrinter::_elementJustOpened
protected

Definition at line 2341 of file tinyxml2.h.

◆ _entityFlag

bool tinyxml2::XMLPrinter::_entityFlag
private

Definition at line 2363 of file tinyxml2.h.

◆ _firstElement

bool tinyxml2::XMLPrinter::_firstElement
private

Definition at line 2352 of file tinyxml2.h.

◆ _fp

FILE * tinyxml2::XMLPrinter::_fp
private

Definition at line 2353 of file tinyxml2.h.

◆ _processEntities

bool tinyxml2::XMLPrinter::_processEntities
private

Definition at line 2356 of file tinyxml2.h.

◆ _restrictedEntityFlag

bool tinyxml2::XMLPrinter::_restrictedEntityFlag
private

Definition at line 2364 of file tinyxml2.h.

◆ _stack

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

Definition at line 2342 of file tinyxml2.h.

◆ _textDepth

int tinyxml2::XMLPrinter::_textDepth
private

Definition at line 2355 of file tinyxml2.h.


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