tinyxml2::XMLPrinter Class Reference

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLPrinter:

Collaboration diagram for tinyxml2::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.
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 ()
virtual bool	VisitEnter (const XMLDocument &)
	Visit a document.
virtual bool	VisitExit (const XMLDocument &)
	Visit a document.
virtual bool	VisitEnter (const XMLElement &, const XMLAttribute *)
	Visit an element.
virtual bool	VisitExit (const XMLElement &)
	Visit an element.
virtual bool	Visit (const XMLDeclaration &)
	Visit a declaration.
virtual bool	Visit (const XMLText &)
	Visit a text node.
virtual bool	Visit (const XMLComment &)
	Visit a comment node.
virtual bool	Visit (const XMLUnknown &)
	Visit an unknown node.

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

Definition at line 1979 of file tinyxml2.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
ENTITY_RANGE
BUF_SIZE

Definition at line 2085 of file tinyxml2.h.

         {
        ENTITY_RANGE = 64,
        BUF_SIZE = 200
    };

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.

Definition at line 2105 of file tinyxml2.cpp.

                                                            :
    _elementJustOpened( false ),
    _firstElement( true ),
    _fp( file ),
    _depth( depth ),
    _textDepth( -1 ),
    _processEntities( true ),
    _compactMode( compact )
{
    for( int i=0; i<ENTITY_RANGE; ++i ) {
        _entityFlag[i] = false;
        _restrictedEntityFlag[i] = false;
    }
    for( int i=0; i<NUM_ENTITIES; ++i ) {
        const char entityValue = entities[i].value;
        TIXMLASSERT( 0 <= entityValue && entityValue < ENTITY_RANGE );
        _entityFlag[ (unsigned char)entityValue ] = true;
    }
    _restrictedEntityFlag[(unsigned char)'&'] = true;
    _restrictedEntityFlag[(unsigned char)'<'] = true;
    _restrictedEntityFlag[(unsigned char)'>'] = true;   // not required, but consistency is nice
    _buffer.Push( 0 );
}

~XMLPrinter()

virtual tinyxml2::XMLPrinter::~XMLPrinter ( )

inlinevirtual

Definition at line 1989 of file tinyxml2.h.

{}

Member Function Documentation

ClearBuffer()

void tinyxml2::XMLPrinter::ClearBuffer ( )

inline

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

Definition at line 2057 of file tinyxml2.h.

                       {
        _buffer.Clear();
        _buffer.Push(0);
    }

CloseElement()

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

virtual

If streaming, close the Element.

Definition at line 2282 of file tinyxml2.cpp.

{
    --_depth;
    const char* name = _stack.Pop();
 
    if ( _elementJustOpened ) {
        Print( "/>" );
    }
    else {
        if ( _textDepth < 0 && !compactMode) {
            Print( "\n" );
            PrintSpace( _depth );
        }
        Print( "</%s>", name );
    }
 
    if ( _textDepth == _depth ) {
        _textDepth = -1;
    }
    if ( _depth == 0 && !compactMode) {
        Print( "\n" );
    }
    _elementJustOpened = false;
}

Referenced by VisitExit().

CompactMode()

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

inlineprotectedvirtual

Definition at line 2063 of file tinyxml2.h.

{ return _compactMode; }

Referenced by VisitEnter(), and VisitExit().

CStr()

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

                             {
        return _buffer.Mem();
    }

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

Definition at line 2050 of file tinyxml2.h.

                         {
        return _buffer.Size();
    }

OpenElement()

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 2222 of file tinyxml2.cpp.

{
    SealElementIfJustOpened();
    _stack.Push( name );
 
    if ( _textDepth < 0 && !_firstElement && !compactMode ) {
        Print( "\n" );
    }
    if ( !compactMode ) {
        PrintSpace( _depth );
    }
 
    Print( "<%s", name );
    _elementJustOpened = true;
    _firstElement = false;
    ++_depth;
}

Referenced by VisitEnter().

Print()

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

protected

Definition at line 2130 of file tinyxml2.cpp.

{
    va_list     va;
    va_start( va, format );
 
    if ( _fp ) {
        vfprintf( _fp, format, va );
    }
    else {
        const int len = TIXML_VSCPRINTF( format, va );
        // Close out and re-start the va-args
        va_end( va );
        TIXMLASSERT( len >= 0 );
        va_start( va, format );
        TIXMLASSERT( _buffer.Size() > 0 && _buffer[_buffer.Size() - 1] == 0 );
        char* p = _buffer.PushArr( len ) - 1;   // back up over the null terminator.
        TIXML_VSNPRINTF( p, len+1, format, va );
    }
    va_end( va );
}

Referenced by CloseElement(), OpenElement(), PrintSpace(), PrintString(), PushAttribute(), PushComment(), PushDeclaration(), PushHeader(), PushText(), PushUnknown(), and SealElementIfJustOpened().

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

Definition at line 2152 of file tinyxml2.cpp.

{
    for( int i=0; i<depth; ++i ) {
        Print( "    " );
    }
}

Referenced by CloseElement(), OpenElement(), PushComment(), PushDeclaration(), and PushUnknown().

PrintString()

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

private

Definition at line 2160 of file tinyxml2.cpp.

{
    // Look for runs of bytes between entities to print.
    const char* q = p;
 
    if ( _processEntities ) {
        const bool* flag = restricted ? _restrictedEntityFlag : _entityFlag;
        while ( *q ) {
            TIXMLASSERT( p <= q );
            // Remember, char is sometimes signed. (How many times has that bitten me?)
            if ( *q > 0 && *q < ENTITY_RANGE ) {
                // Check for entities. If one is found, flush
                // the stream up until the entity, write the
                // entity, and keep looking.
                if ( flag[(unsigned char)(*q)] ) {
                    while ( p < q ) {
                        const size_t delta = q - p;
                        // %.*s accepts type int as "precision"
                        const int toPrint = ( INT_MAX < delta ) ? INT_MAX : (int)delta;
                        Print( "%.*s", toPrint, p );
                        p += toPrint;
                    }
                    bool entityPatternPrinted = false;
                    for( int i=0; i<NUM_ENTITIES; ++i ) {
                        if ( entities[i].value == *q ) {
                            Print( "&%s;", entities[i].pattern );
                            entityPatternPrinted = true;
                            break;
                        }
                    }
                    if ( !entityPatternPrinted ) {
                        // TIXMLASSERT( entityPatternPrinted ) causes gcc -Wunused-but-set-variable in release
                        TIXMLASSERT( false );
                    }
                    ++p;
                }
            }
            ++q;
            TIXMLASSERT( p <= q );
        }
    }
    // Flush the remaining string. This will be the entire
    // string if an entity wasn't found.
    TIXMLASSERT( p <= q );
    if ( !_processEntities || ( p < q ) ) {
        Print( "%s", p );
    }
}

Referenced by PushAttribute(), and PushText().

PushAttribute() [1/5]

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

Definition at line 2266 of file tinyxml2.cpp.

{
    char buf[BUF_SIZE];
    XMLUtil::ToStr( v, buf, BUF_SIZE );
    PushAttribute( name, buf );
}

PushAttribute() [2/5]

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

If streaming, add an attribute to an open element.

Definition at line 2241 of file tinyxml2.cpp.

{
    TIXMLASSERT( _elementJustOpened );
    Print( " %s=\"", name );
    PrintString( value, false );
    Print( "\"" );
}

Referenced by PushAttribute(), and VisitEnter().

PushAttribute() [3/5]

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

Definition at line 2274 of file tinyxml2.cpp.

{
    char buf[BUF_SIZE];
    XMLUtil::ToStr( v, buf, BUF_SIZE );
    PushAttribute( name, buf );
}

PushAttribute() [4/5]

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

Definition at line 2250 of file tinyxml2.cpp.

{
    char buf[BUF_SIZE];
    XMLUtil::ToStr( v, buf, BUF_SIZE );
    PushAttribute( name, buf );
}

PushAttribute() [5/5]

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

Definition at line 2258 of file tinyxml2.cpp.

{
    char buf[BUF_SIZE];
    XMLUtil::ToStr( v, buf, BUF_SIZE );
    PushAttribute( name, buf );
}

PushComment()

void tinyxml2::XMLPrinter::PushComment

(

const char *

comment

)

Add a comment.

Definition at line 2371 of file tinyxml2.cpp.

{
    SealElementIfJustOpened();
    if ( _textDepth < 0 && !_firstElement && !_compactMode) {
        Print( "\n" );
        PrintSpace( _depth );
    }
    _firstElement = false;
    Print( "<!--%s-->", comment );
}

Referenced by Visit().

PushDeclaration()

void tinyxml2::XMLPrinter::PushDeclaration

(

const char *

value

)

Definition at line 2383 of file tinyxml2.cpp.

{
    SealElementIfJustOpened();
    if ( _textDepth < 0 && !_firstElement && !_compactMode) {
        Print( "\n" );
        PrintSpace( _depth );
    }
    _firstElement = false;
    Print( "<?%s?>", value );
}

Referenced by PushHeader(), and Visit().

PushHeader()

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

If streaming, write the BOM and declaration.

Definition at line 2210 of file tinyxml2.cpp.

{
    if ( writeBOM ) {
        static const unsigned char bom[] = { TIXML_UTF_LEAD_0, TIXML_UTF_LEAD_1, TIXML_UTF_LEAD_2, 0 };
        Print( "%s", bom );
    }
    if ( writeDec ) {
        PushDeclaration( "xml version=\"1.0\"" );
    }
}

Referenced by VisitEnter().

PushText() [1/6]

void tinyxml2::XMLPrinter::PushText

(

bool

value

)

Add a text node from a bool.

Definition at line 2347 of file tinyxml2.cpp.

{
    char buf[BUF_SIZE];
    XMLUtil::ToStr( value, buf, BUF_SIZE );
    PushText( buf, false );
}

PushText() [2/6]

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

Add a text node.

Definition at line 2318 of file tinyxml2.cpp.

{
    _textDepth = _depth-1;
 
    SealElementIfJustOpened();
    if ( cdata ) {
        Print( "<![CDATA[%s]]>", text );
    }
    else {
        PrintString( text, true );
    }
}

Referenced by PushText(), and Visit().

PushText() [3/6]

void tinyxml2::XMLPrinter::PushText

(

double

value

)

Add a text node from a double.

Definition at line 2363 of file tinyxml2.cpp.

{
    char buf[BUF_SIZE];
    XMLUtil::ToStr( value, buf, BUF_SIZE );
    PushText( buf, false );
}

PushText() [4/6]

void tinyxml2::XMLPrinter::PushText

(

float

value

)

Add a text node from a float.

Definition at line 2355 of file tinyxml2.cpp.

{
    char buf[BUF_SIZE];
    XMLUtil::ToStr( value, buf, BUF_SIZE );
    PushText( buf, false );
}

PushText() [5/6]

void tinyxml2::XMLPrinter::PushText

(

int

value

)

Add a text node from an integer.

Definition at line 2331 of file tinyxml2.cpp.

{
    char buf[BUF_SIZE];
    XMLUtil::ToStr( value, buf, BUF_SIZE );
    PushText( buf, false );
}

PushText() [6/6]

void tinyxml2::XMLPrinter::PushText

(

unsigned

value

)

Add a text node from an unsigned.

Definition at line 2339 of file tinyxml2.cpp.

{
    char buf[BUF_SIZE];
    XMLUtil::ToStr( value, buf, BUF_SIZE );
    PushText( buf, false );
}

PushUnknown()

void tinyxml2::XMLPrinter::PushUnknown

(

const char *

value

)

Definition at line 2395 of file tinyxml2.cpp.

{
    SealElementIfJustOpened();
    if ( _textDepth < 0 && !_firstElement && !_compactMode) {
        Print( "\n" );
        PrintSpace( _depth );
    }
    _firstElement = false;
    Print( "<!%s>", value );
}

Referenced by Visit().

SealElementIfJustOpened()

void tinyxml2::XMLPrinter::SealElementIfJustOpened ( )

protected

Definition at line 2308 of file tinyxml2.cpp.

{
    if ( !_elementJustOpened ) {
        return;
    }
    _elementJustOpened = false;
    Print( ">" );
}

Referenced by OpenElement(), PushComment(), PushDeclaration(), PushText(), and PushUnknown().

Visit() [1/4]

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

virtual

Visit a comment node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2447 of file tinyxml2.cpp.

{
    PushComment( comment.Value() );
    return true;
}

Visit() [2/4]

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

virtual

Visit a declaration.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2453 of file tinyxml2.cpp.

{
    PushDeclaration( declaration.Value() );
    return true;
}

Visit() [3/4]

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

virtual

Visit a text node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2440 of file tinyxml2.cpp.

{
    PushText( text.Value(), text.CData() );
    return true;
}

Visit() [4/4]

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

virtual

Visit an unknown node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2460 of file tinyxml2.cpp.

{
    PushUnknown( unknown.Value() );
    return true;
}

VisitEnter() [1/2]

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

virtual

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2407 of file tinyxml2.cpp.

{
    _processEntities = doc.ProcessEntities();
    if ( doc.HasBOM() ) {
        PushHeader( true, false );
    }
    return true;
}

VisitEnter() [2/2]

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

virtual

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2417 of file tinyxml2.cpp.

{
    const XMLElement* parentElem = 0;
    if ( element.Parent() ) {
        parentElem = element.Parent()->ToElement();
    }
    const bool compactMode = parentElem ? CompactMode( *parentElem ) : _compactMode;
    OpenElement( element.Name(), compactMode );
    while ( attribute ) {
        PushAttribute( attribute->Name(), attribute->Value() );
        attribute = attribute->Next();
    }
    return true;
}

VisitExit() [1/2]

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

inlinevirtual

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2026 of file tinyxml2.h.

                                                            {
        return true;
    }

VisitExit() [2/2]

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

virtual

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2433 of file tinyxml2.cpp.

{
    CloseElement( CompactMode(element) );
    return true;
}

Member Data Documentation

_buffer

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

private

Definition at line 2092 of file tinyxml2.h.

Referenced by Print(), and XMLPrinter().

_compactMode

bool tinyxml2::XMLPrinter::_compactMode

private

Definition at line 2083 of file tinyxml2.h.

Referenced by PushComment(), PushDeclaration(), PushUnknown(), and VisitEnter().

_depth

int tinyxml2::XMLPrinter::_depth

private

Definition at line 2080 of file tinyxml2.h.

Referenced by CloseElement(), OpenElement(), PushComment(), PushDeclaration(), PushText(), and PushUnknown().

_elementJustOpened

bool tinyxml2::XMLPrinter::_elementJustOpened

protected

Definition at line 2072 of file tinyxml2.h.

Referenced by CloseElement(), OpenElement(), PushAttribute(), and SealElementIfJustOpened().

_entityFlag

bool tinyxml2::XMLPrinter::_entityFlag[ENTITY_RANGE]

private

Definition at line 2089 of file tinyxml2.h.

Referenced by PrintString(), and XMLPrinter().

_firstElement

bool tinyxml2::XMLPrinter::_firstElement

private

Definition at line 2078 of file tinyxml2.h.

Referenced by OpenElement(), PushComment(), PushDeclaration(), and PushUnknown().

_fp

FILE* tinyxml2::XMLPrinter::_fp

private

Definition at line 2079 of file tinyxml2.h.

Referenced by Print().

_processEntities

bool tinyxml2::XMLPrinter::_processEntities

private

Definition at line 2082 of file tinyxml2.h.

Referenced by PrintString(), and VisitEnter().

_restrictedEntityFlag

bool tinyxml2::XMLPrinter::_restrictedEntityFlag[ENTITY_RANGE]

private

Definition at line 2090 of file tinyxml2.h.

Referenced by PrintString(), and XMLPrinter().

_stack

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

protected

Definition at line 2073 of file tinyxml2.h.

Referenced by CloseElement(), and OpenElement().

_textDepth

int tinyxml2::XMLPrinter::_textDepth

private

Definition at line 2081 of file tinyxml2.h.

Referenced by CloseElement(), OpenElement(), PushComment(), PushDeclaration(), PushText(), and PushUnknown().

---

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

• sdk/tools/xml2sdb/tinyxml2.h
• sdk/tools/xml2sdb/tinyxml2.cpp