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>

Inheritance diagram for tinyxml2::XMLPrinter:
Inheritance graph
[legend]

Public Member Functions

void ClearBuffer ()
 
virtual void CloseElement (bool compactMode=false)
 If streaming, close the Element. More...
 
const char * CStr () const
 
int CStrSize () const
 
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)
 
void PushComment (const char *comment)
 Add a comment. More...
 
void PushDeclaration (const char *value)
 
void PushHeader (bool writeBOM, bool writeDeclaration)
 
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 PushUnknown (const char *value)
 
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...
 
virtual bool VisitEnter (const XMLDocument &)
 Visit a document. More...
 
virtual bool VisitEnter (const XMLElement &element, const XMLAttribute *attribute)
 Visit an element. More...
 
virtual bool VisitExit (const XMLDocument &)
 Visit a document. More...
 
virtual bool VisitExit (const XMLElement &element)
 Visit an element. More...
 
 XMLPrinter (FILE *file=0, bool compact=false, int depth=0)
 
virtual ~XMLPrinter ()
 
- Public Member Functions inherited from tinyxml2::XMLVisitor
virtual ~XMLVisitor ()
 

Protected Member Functions

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

Protected Attributes

bool _elementJustOpened
 
DynArray< const char *, 10 > _stack
 

Private Types

enum  { ENTITY_RANGE = 64, BUF_SIZE = 200 }
 

Private Member Functions

XMLPrinteroperator= (const XMLPrinter &)
 
void PrintString (const char *, bool restrictedEntitySet)
 
 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 2172 of file tinyxml2.h.

Member Enumeration Documentation

anonymous enum
private
Enumerator
ENTITY_RANGE 
BUF_SIZE 

Definition at line 2285 of file tinyxml2.h.

Constructor & Destructor Documentation

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.

Definition at line 2401 of file tinyxml2.cpp.

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

Definition at line 2182 of file tinyxml2.h.

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

Member Function Documentation

void tinyxml2::XMLPrinter::ClearBuffer ( )
inline

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

Definition at line 2253 of file tinyxml2.h.

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

If streaming, close the Element.

Definition at line 2622 of file tinyxml2.cpp.

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

Definition at line 2260 of file tinyxml2.h.

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

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

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

Definition at line 2550 of file tinyxml2.cpp.

XMLPrinter& tinyxml2::XMLPrinter::operator= ( const XMLPrinter )
private
void tinyxml2::XMLPrinter::Print ( const char *  format,
  ... 
)
protected

Definition at line 2429 of file tinyxml2.cpp.

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

Definition at line 2477 of file tinyxml2.cpp.

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

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

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

Definition at line 2582 of file tinyxml2.cpp.

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

Definition at line 2590 of file tinyxml2.cpp.

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

Definition at line 2598 of file tinyxml2.cpp.

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

Definition at line 2606 of file tinyxml2.cpp.

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

Definition at line 2614 of file tinyxml2.cpp.

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

Add a comment.

Definition at line 2722 of file tinyxml2.cpp.

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

Definition at line 2737 of file tinyxml2.cpp.

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

If streaming, write the BOM and declaration.

Definition at line 2538 of file tinyxml2.cpp.

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

Add a text node.

Definition at line 2660 of file tinyxml2.cpp.

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

Add a text node from an integer.

Definition at line 2682 of file tinyxml2.cpp.

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

Add a text node from an unsigned.

Definition at line 2690 of file tinyxml2.cpp.

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

Add a text node from an unsigned.

Definition at line 2675 of file tinyxml2.cpp.

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

Add a text node from a bool.

Definition at line 2698 of file tinyxml2.cpp.

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

Add a text node from a float.

Definition at line 2706 of file tinyxml2.cpp.

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

Add a text node from a double.

Definition at line 2714 of file tinyxml2.cpp.

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

Definition at line 2752 of file tinyxml2.cpp.

void tinyxml2::XMLPrinter::Putc ( char  ch)
protected

Definition at line 2464 of file tinyxml2.cpp.

void tinyxml2::XMLPrinter::SealElementIfJustOpened ( )
protected

Definition at line 2650 of file tinyxml2.cpp.

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

Visit a text node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2800 of file tinyxml2.cpp.

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

Visit a comment node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2807 of file tinyxml2.cpp.

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

Visit a declaration.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2813 of file tinyxml2.cpp.

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

Visit an unknown node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2820 of file tinyxml2.cpp.

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

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2767 of file tinyxml2.cpp.

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

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2777 of file tinyxml2.cpp.

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

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2222 of file tinyxml2.h.

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

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2793 of file tinyxml2.cpp.

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

Definition at line 2451 of file tinyxml2.cpp.

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

Definition at line 2268 of file tinyxml2.h.

Member Data Documentation

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

Definition at line 2292 of file tinyxml2.h.

bool tinyxml2::XMLPrinter::_compactMode
private

Definition at line 2283 of file tinyxml2.h.

int tinyxml2::XMLPrinter::_depth
private

Definition at line 2280 of file tinyxml2.h.

bool tinyxml2::XMLPrinter::_elementJustOpened
protected

Definition at line 2272 of file tinyxml2.h.

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

Definition at line 2289 of file tinyxml2.h.

bool tinyxml2::XMLPrinter::_firstElement
private

Definition at line 2278 of file tinyxml2.h.

FILE* tinyxml2::XMLPrinter::_fp
private

Definition at line 2279 of file tinyxml2.h.

bool tinyxml2::XMLPrinter::_processEntities
private

Definition at line 2282 of file tinyxml2.h.

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

Definition at line 2290 of file tinyxml2.h.

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

Definition at line 2273 of file tinyxml2.h.

int tinyxml2::XMLPrinter::_textDepth
private

Definition at line 2281 of file tinyxml2.h.


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


behaviortree_cpp
Author(s): Michele Colledanchise, Davide Faconti
autogenerated on Sun Feb 3 2019 03:14:33