ECOGEN 4.0
Evolutive, Compressible, Open, Genuine, Easy, N-phase
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
tinyxml2::XMLPrinter Class Reference

#include <tinyxml2.h>

Inherits tinyxml2::XMLVisitor.

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, 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 (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 tinyxml2::XMLVisitor
virtual ~XMLVisitor ()
 

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:

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

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private
Enumerator
ENTITY_RANGE 
BUF_SIZE 

Constructor & Destructor Documentation

◆ XMLPrinter()

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

Member Function Documentation

◆ ClearBuffer()

void tinyxml2::XMLPrinter::ClearBuffer ( )
inline

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

◆ CloseElement()

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

If streaming, close the Element.

◆ CompactMode()

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

◆ CStr()

const char * tinyxml2::XMLPrinter::CStr ( ) const
inline

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

◆ CStrSize()

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

◆ OpenElement()

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

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

◆ Print()

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

◆ PrintSpace()

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

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

◆ PushAttribute() [1/5]

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

◆ PushAttribute() [2/5]

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

If streaming, add an attribute to an open element.

◆ PushAttribute() [3/5]

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

◆ PushAttribute() [4/5]

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

◆ PushAttribute() [5/5]

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

◆ PushComment()

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

Add a comment.

◆ PushDeclaration()

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

◆ PushHeader()

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

If streaming, write the BOM and declaration.

◆ PushText() [1/6]

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

Add a text node from a bool.

◆ PushText() [2/6]

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

Add a text node.

◆ PushText() [3/6]

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

Add a text node from a double.

◆ PushText() [4/6]

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

Add a text node from a float.

◆ PushText() [5/6]

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

Add a text node from an integer.

◆ PushText() [6/6]

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

Add a text node from an unsigned.

◆ PushUnknown()

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

◆ SealElementIfJustOpened()

void tinyxml2::XMLPrinter::SealElementIfJustOpened ( )
protected

◆ Visit() [1/4]

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

Visit a comment node.

Reimplemented from tinyxml2::XMLVisitor.

◆ Visit() [2/4]

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

Visit a declaration.

Reimplemented from tinyxml2::XMLVisitor.

◆ Visit() [3/4]

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

Visit a text node.

Reimplemented from tinyxml2::XMLVisitor.

◆ Visit() [4/4]

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

Visit an unknown node.

Reimplemented from tinyxml2::XMLVisitor.

◆ VisitEnter() [1/2]

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

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

◆ VisitEnter() [2/2]

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

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

◆ VisitExit() [1/2]

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

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

◆ VisitExit() [2/2]

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

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

Member Data Documentation

◆ _buffer

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

◆ _compactMode

bool tinyxml2::XMLPrinter::_compactMode
private

◆ _depth

int tinyxml2::XMLPrinter::_depth
private

◆ _elementJustOpened

bool tinyxml2::XMLPrinter::_elementJustOpened
protected

◆ _entityFlag

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

◆ _firstElement

bool tinyxml2::XMLPrinter::_firstElement
private

◆ _fp

FILE* tinyxml2::XMLPrinter::_fp
private

◆ _processEntities

bool tinyxml2::XMLPrinter::_processEntities
private

◆ _restrictedEntityFlag

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

◆ _stack

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

◆ _textDepth

int tinyxml2::XMLPrinter::_textDepth
private
The documentation for this class was generated from the following files: