tinyxml2.hpp

Go to the documentation of this file.

/*
Original code by Lee Thomason (www.grinninglizard.com)
 - modified by Johan Barthelemy.

 The modification allows the library to handle additional
 data types such as double and long.
*/

#ifndef TINYXML2_INCLUDED
#define TINYXML2_INCLUDED

#include <cctype>
#include <climits>
#include <cstdio>
#include <cstring>
#include <cstdarg>
#include <string>

/*
        gcc: g++ -Wall tinyxml2.cpp xmltest.cpp -o gccxmltest.exe
*/

#if defined( _DEBUG ) || defined( DEBUG ) || defined (__DEBUG__)
        #ifndef DEBUG
                #define DEBUG
        #endif
#endif


#if defined(DEBUG)
        #if defined(_MSC_VER)
                #define TIXMLASSERT( x )           if ( !(x)) { __debugbreak(); } //if ( !(x)) WinDebugBreak()
        #elif defined (ANDROID_NDK)
                #include <android/log.h>
                #define TIXMLASSERT( x )           if ( !(x)) { __android_log_assert( "assert", "grinliz", "ASSERT in '%s' at %d.", __FILE__, __LINE__ ); }
        #else
                #include <assert.h>
                #define TIXMLASSERT                assert
        #endif
#else
        #define TIXMLASSERT( x )           {}
#endif


#if defined(_MSC_VER) && (_MSC_VER >= 1400 )
        // Microsoft visual studio, version 2005 and higher.
        /*int _snprintf_s(
           char *buffer,
           size_t sizeOfBuffer,
           size_t count,        
           const char *format [,
                  argument] ... 
        );*/
        inline int TIXML_SNPRINTF( char* buffer, size_t size, const char* format, ... ) {
            va_list va;
                va_start( va, format );
                int result = vsnprintf_s( buffer, size, _TRUNCATE, format, va );
            va_end( va );
                return result;
        }
        #define TIXML_SSCANF   sscanf_s
#else
        // GCC version 3 and higher
        //#warning( "Using sn* functions." )
        #define TIXML_SNPRINTF snprintf
        #define TIXML_SSCANF   sscanf
#endif

static const int TIXML2_MAJOR_VERSION = 1;
static const int TIXML2_MINOR_VERSION = 0;
static const int TIXML2_PATCH_VERSION = 6;

namespace tinyxml2
{
class XMLDocument;
class XMLElement;
class XMLAttribute;
class XMLComment;
class XMLNode;
class XMLText;
class XMLDeclaration;
class XMLUnknown;

class XMLPrinter;

/*
        A class that wraps strings. Normally stores the start and end
        pointers into the XML file itself, and will apply normalization
        and entity translation if actually read. Can also store (and memory
        manage) a traditional char[]
*/
class StrPair
{
public:
        enum {
                NEEDS_ENTITY_PROCESSING                 = 0x01,
                NEEDS_NEWLINE_NORMALIZATION             = 0x02,

                TEXT_ELEMENT            = NEEDS_ENTITY_PROCESSING | NEEDS_NEWLINE_NORMALIZATION,
                TEXT_ELEMENT_LEAVE_ENTITIES             = NEEDS_NEWLINE_NORMALIZATION,
                ATTRIBUTE_NAME          = 0,
                ATTRIBUTE_VALUE         = NEEDS_ENTITY_PROCESSING | NEEDS_NEWLINE_NORMALIZATION,
                ATTRIBUTE_VALUE_LEAVE_ENTITIES          = NEEDS_NEWLINE_NORMALIZATION,
                COMMENT                         = NEEDS_NEWLINE_NORMALIZATION
        };

        StrPair() : flags( 0 ), start( 0 ), end( 0 ) {}
        ~StrPair();

        void Set( char* _start, char* _end, int _flags ) {
                reset();
                this->start = _start; this->end = _end; this->flags = _flags | NEEDS_FLUSH;
        }
        const char* getStr();
        bool Empty() const { return start == end; }

        void SetInternedStr( const char* str ) { reset(); this->start = const_cast<char*>(str); }
        void setStr( const char* str, int flags=0 );

        char* parseText( char* in, const char* endTag, int strFlags );  
        char* parseName( char* in );


private:
        void reset();

        enum {
                NEEDS_FLUSH = 0x100,
                NEEDS_DELETE = 0x200
        };

        // After parsing, if *end != 0, it can be set to zero.
        int flags;
        char* start;    
        char* end;
};


/*
        A dynamic array of Plain Old Data. Doesn't support constructors, etc.
        Has a small initial memory pool, so that low or no usage will not
        cause a call to new/delete
*/
template <class T, int INIT>
class DynArray
{
public:
        DynArray< T, INIT >() 
        {
                mem = pool;
                allocated = INIT;
                size = 0;
        }
        ~DynArray()
        {
                if ( mem != pool ) {
                        delete [] mem;
                }
        }
        void Push( T t )
        {
                EnsureCapacity( size+1 );
                mem[size++] = t;
        }

        T* PushArr( int count )
        {
                EnsureCapacity( size+count );
                T* ret = &mem[size];
                size += count;
                return ret;
        }
        T Pop() {
                return mem[--size];
        }
        void PopArr( int count ) 
        {
                TIXMLASSERT( size >= count );
                size -= count;
        }

        bool Empty() const                                      { return size == 0; }
        T& operator[](int i)                            { TIXMLASSERT( i>= 0 && i < size ); return mem[i]; }
        const T& operator[](int i) const        { TIXMLASSERT( i>= 0 && i < size ); return mem[i]; }
        int Size() const                                        { return size; }
        int Capacity() const                            { return allocated; }
        const T* Mem() const                            { return mem; }
        T* Mem()                                                        { return mem; }


private:
        void EnsureCapacity( int cap ) {
                if ( cap > allocated ) {
                        int newAllocated = cap * 2;
                        T* newMem = new T[newAllocated];
                        memcpy( newMem, mem, sizeof(T)*size );  // warning: not using constructors, only works for PODs
                        if ( mem != pool ) delete [] mem;
                        mem = newMem;
                        allocated = newAllocated;
                }
        }

        T* mem;
        T pool[INIT];
        int allocated;          // objects allocated
        int size;                       // number objects in use
};


/*
        Parent virtual class of a pool for fast allocation
        and deallocation of objects.
*/
class MemPool
{
public:
        MemPool() {}
        virtual ~MemPool() {}

        virtual int ItemSize() const = 0;
        virtual void* Alloc() = 0;
        virtual void Free( void* ) = 0; 
};


/*
        Template child class to create pools of the correct type.
*/
template< int SIZE >
class MemPoolT : public MemPool
{
public:
        MemPoolT() : root(0), currentAllocs(0), nAllocs(0), maxAllocs(0)        {}
        ~MemPoolT() {
                // Delete the blocks.
                for( int i=0; i<blockPtrs.Size(); ++i ) {
                        delete blockPtrs[i];
                }
        }

        virtual int ItemSize() const    { return SIZE; }
        int CurrentAllocs() const               { return currentAllocs; }

        virtual void* Alloc() {
                if ( !root ) {
                        // Need a new block.
                        Block* block = new Block();
                        blockPtrs.Push( block );

                        for( int i=0; i<COUNT-1; ++i ) {
                                block->chunk[i].next = &block->chunk[i+1];
                        }
                        block->chunk[COUNT-1].next = 0;
                        root = block->chunk;
                }
                void* result = root;
                root = root->next;

                ++currentAllocs;
                if ( currentAllocs > maxAllocs ) maxAllocs = currentAllocs;
                nAllocs++;
                return result;
        }
        virtual void Free( void* mem ) {
                if ( !mem ) return;
                --currentAllocs;
                Chunk* chunk = (Chunk*)mem;
                memset( chunk, 0xfe, sizeof(Chunk) );
                chunk->next = root;
                root = chunk;
        }
        void Trace( const char* name ) {
                printf( "Mempool %s watermark=%d [%dk] current=%d size=%d nAlloc=%d blocks=%d\n",
                                 name, maxAllocs, maxAllocs*SIZE/1024, currentAllocs, SIZE, nAllocs, blockPtrs.Size() );
        }

private:
        enum { COUNT = 1024/SIZE };
        union Chunk {
                Chunk* next;
                char mem[SIZE];
        };
        struct Block {
                Chunk chunk[COUNT];
        };
        DynArray< Block*, 10 > blockPtrs;
        Chunk* root;

        int currentAllocs;
        int nAllocs;
        int maxAllocs;
};



class XMLVisitor
{
public:
        virtual ~XMLVisitor() {}

        virtual bool visitEnter( const XMLDocument& /*doc*/ )                   { return true; }
        virtual bool VisitExit( const XMLDocument& /*doc*/ )                    { return true; }

        virtual bool visitEnter( const XMLElement& /*element*/, const XMLAttribute* /*firstAttribute*/ )        { return true; }
        virtual bool visitExit( const XMLElement& /*element*/ )                 { return true; }

        virtual bool visit( const XMLDeclaration& /*declaration*/ )             { return true; }
        virtual bool visit( const XMLText& /*text*/ )                                   { return true; }
        virtual bool visit( const XMLComment& /*comment*/ )                             { return true; }
        virtual bool visit( const XMLUnknown& /*unknown*/ )                             { return true; }
};


/*
        Utility functionality.
*/
class XMLUtil
{
public:
        // Anything in the high order range of UTF-8 is assumed to not be whitespace. This isn't 
        // correct, but simple, and usually works.
        static const char* SkipWhiteSpace( const char* p )      { while( !IsUTF8Continuation(*p) && isspace( *reinterpret_cast<const unsigned char*>(p) ) ) { ++p; } return p; }
        static char* SkipWhiteSpace( char* p )                          { while( !IsUTF8Continuation(*p) && isspace( *reinterpret_cast<unsigned char*>(p) ) )           { ++p; } return p; }

        inline static bool StringEqual( const char* p, const char* q, int nChar=INT_MAX )  {
                int n = 0;
                if ( p == q ) {
                        return true;
                }
                while( *p && *q && *p == *q && n<nChar ) {
                        ++p; ++q; ++n;
                }
                if ( (n == nChar) || ( *p == 0 && *q == 0 ) ) {
                        return true;
                }
                return false;
        }
        inline static int IsUTF8Continuation( const char p ) { return p & 0x80; }
        inline static int IsAlphaNum( unsigned char anyByte )   { return ( anyByte < 128 ) ? isalnum( anyByte ) : 1; }
        inline static int IsAlpha( unsigned char anyByte )              { return ( anyByte < 128 ) ? isalpha( anyByte ) : 1; }

        static const char* readBOM( const char* p, bool* hasBOM );
        // p is the starting location,
        // the UTF-8 value of the entity will be placed in value, and length filled in.
        static const char* getCharacterRef( const char* p, char* value, int* length );
        static void convertUTF32ToUTF8( unsigned long input, char* output, int* length );

        // converts primitive types to strings
        static void toStr( int v, char* buffer, int bufferSize );
        static void toStr( long v, char* buffer, int bufferSize );
        static void toStr( unsigned v, char* buffer, int bufferSize );
        static void toStr( bool v, char* buffer, int bufferSize );
        static void toStr( float v, char* buffer, int bufferSize );
        static void toStr( double v, char* buffer, int bufferSize );
        static void toStr( char v, char* buffer, int bufferSize );

        // converts strings to primitive types
        static bool     toInt( const char* str, int* value );
        static bool toUnsigned( const char* str, unsigned* value );
        static bool     toBool( const char* str, bool* value );
        static bool     toFloat( const char* str, float* value );
        static bool toDouble( const char* str, double* value );
};


class XMLNode
{
        friend class XMLDocument;
        friend class XMLElement;
public:

        const XMLDocument* GetDocument() const  { return document; }
        XMLDocument* GetDocument()                              { return document; }

        virtual XMLElement*             ToElement()             { return 0; }   
        virtual XMLText*                ToText()                { return 0; }   
        virtual XMLComment*             ToComment()             { return 0; }   
        virtual XMLDocument*    ToDocument()    { return 0; }   
        virtual XMLDeclaration* ToDeclaration() { return 0; }   
        virtual XMLUnknown*             ToUnknown()             { return 0; }   

        virtual const XMLElement*               ToElement() const               { return 0; }
        virtual const XMLText*                  ToText() const                  { return 0; }
        virtual const XMLComment*               ToComment() const               { return 0; }
        virtual const XMLDocument*              ToDocument() const              { return 0; }
        virtual const XMLDeclaration*   ToDeclaration() const   { return 0; }
        virtual const XMLUnknown*               ToUnknown() const               { return 0; }

        const char* Value() const                       { return value.getStr(); }
        void setValue( const char* val, bool staticMem=false );

        const XMLNode*  Parent() const                  { return parent; }
        XMLNode* Parent()                                               { return parent; }

        bool NoChildren() const                                 { return !firstChild; }

        const XMLNode*  FirstChild() const              { return firstChild; }
        XMLNode*                FirstChild()                    { return firstChild; }
        const XMLElement* firstChildElement( const char* value=0 ) const;
        XMLElement* FirstChildElement( const char* _value=0 )   { return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->firstChildElement( _value )); }

        const XMLNode*  LastChild() const                                               { return lastChild; }
        XMLNode*                LastChild()                                                             { return const_cast<XMLNode*>(const_cast<const XMLNode*>(this)->LastChild() ); }

        const XMLElement* lastChildElement( const char* value=0 ) const;
        XMLElement* LastChildElement( const char* _value=0 )    { return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->lastChildElement(_value) ); }
        
        const XMLNode*  PreviousSibling() const                                 { return prev; }
        XMLNode*        PreviousSibling()                                                       { return prev; }

        const XMLElement*       previousSiblingElement( const char* value=0 ) const ;
        XMLElement*     PreviousSiblingElement( const char* _value=0 ) { return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->previousSiblingElement( _value ) ); }
        
        const XMLNode*  NextSibling() const                                             { return next; }
        XMLNode*        NextSibling()                                                           { return next; }
                
        const XMLElement*       nextSiblingElement( const char* value=0 ) const;
        XMLElement*     NextSiblingElement( const char* _value=0 )      { return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->nextSiblingElement( _value ) ); }

        XMLNode* insertEndChild( XMLNode* addThis );

        XMLNode* LinkEndChild( XMLNode* addThis )       { return insertEndChild( addThis ); }
        XMLNode* insertFirstChild( XMLNode* addThis );
        XMLNode* insertAfterChild( XMLNode* afterThis, XMLNode* addThis );
        
        void deleteChildren();

        void deleteChild( XMLNode* node );

        virtual XMLNode* shallowClone( XMLDocument* document ) const = 0;

        virtual bool shallowEqual( const XMLNode* compare ) const = 0;

        virtual bool accept( XMLVisitor* visitor ) const = 0;

        // internal
        virtual char* parseDeep( char*, StrPair* );

protected:
        XMLNode( XMLDocument* );
        virtual ~XMLNode();
        XMLNode( const XMLNode& );      // not supported
        XMLNode& operator=( const XMLNode& );   // not supported
        
        XMLDocument*    document;
        XMLNode*                parent;
        mutable StrPair value;

        XMLNode*                firstChild;
        XMLNode*                lastChild;

        XMLNode*                prev;
        XMLNode*                next;

private:
        MemPool*                memPool;
        void unlink( XMLNode* child );
};


class XMLText : public XMLNode
{
        friend class XMLBase;
        friend class XMLDocument;
public:
        virtual bool accept( XMLVisitor* visitor ) const;

        virtual XMLText*        ToText()                        { return this; }
        virtual const XMLText*  ToText() const  { return this; }

        void SetCData( bool _isCData )                  { this->isCData = _isCData; }
        bool CData() const                                              { return isCData; }

        char* parseDeep( char*, StrPair* endTag );
        virtual XMLNode* shallowClone( XMLDocument* document ) const;
        virtual bool shallowEqual( const XMLNode* compare ) const;


protected:
        XMLText( XMLDocument* doc )     : XMLNode( doc ), isCData( false )      {}
        virtual ~XMLText()                                                                                              {}
        XMLText( const XMLText& );      // not supported
        XMLText& operator=( const XMLText& );   // not supported

private:
        bool isCData;
};


class XMLComment : public XMLNode
{
        friend class XMLDocument;
public:
        virtual XMLComment*     ToComment()                                     { return this; }
        virtual const XMLComment* ToComment() const             { return this; }

        virtual bool accept( XMLVisitor* visitor ) const;

        char* parseDeep( char*, StrPair* endTag );
        virtual XMLNode* shallowClone( XMLDocument* document ) const;
        virtual bool shallowEqual( const XMLNode* compare ) const;

protected:
        XMLComment( XMLDocument* doc );
        virtual ~XMLComment();
        XMLComment( const XMLComment& );        // not supported
        XMLComment& operator=( const XMLComment& );     // not supported

private:
};


class XMLDeclaration : public XMLNode
{
        friend class XMLDocument;
public:
        virtual XMLDeclaration* ToDeclaration()                                 { return this; }
        virtual const XMLDeclaration* ToDeclaration() const             { return this; }

        virtual bool accept( XMLVisitor* visitor ) const;

        char* parseDeep( char*, StrPair* endTag );
        virtual XMLNode* shallowClone( XMLDocument* document ) const;
        virtual bool shallowEqual( const XMLNode* compare ) const;

protected:
        XMLDeclaration( XMLDocument* doc );
        virtual ~XMLDeclaration();
        XMLDeclaration( const XMLDeclaration& );        // not supported
        XMLDeclaration& operator=( const XMLDeclaration& );     // not supported
};


class XMLUnknown : public XMLNode
{
        friend class XMLDocument;
public:
        virtual XMLUnknown*     ToUnknown()                                     { return this; }
        virtual const XMLUnknown* ToUnknown() const             { return this; }

        virtual bool accept( XMLVisitor* visitor ) const;

        char* parseDeep( char*, StrPair* endTag );
        virtual XMLNode* shallowClone( XMLDocument* document ) const;
        virtual bool shallowEqual( const XMLNode* compare ) const;

protected:
        XMLUnknown( XMLDocument* doc );
        virtual ~XMLUnknown();
        XMLUnknown( const XMLUnknown& );        // not supported
        XMLUnknown& operator=( const XMLUnknown& );     // not supported
};


enum {
        XML_NO_ERROR = 0,
        XML_SUCCESS = 0,

        XML_NO_ATTRIBUTE,
        XML_WRONG_ATTRIBUTE_TYPE,

        XML_ERROR_FILE_NOT_FOUND,
        XML_ERROR_FILE_COULD_NOT_BE_OPENED,
        XML_ERROR_FILE_READ_ERROR,
        XML_ERROR_ELEMENT_MISMATCH,
        XML_ERROR_PARSING_ELEMENT,
        XML_ERROR_PARSING_ATTRIBUTE,
        XML_ERROR_IDENTIFYING_TAG,
        XML_ERROR_PARSING_TEXT,
        XML_ERROR_PARSING_CDATA,
        XML_ERROR_PARSING_COMMENT,
        XML_ERROR_PARSING_DECLARATION,
        XML_ERROR_PARSING_UNKNOWN,
        XML_ERROR_EMPTY_DOCUMENT,
        XML_ERROR_MISMATCHED_ELEMENT,
        XML_ERROR_PARSING,

        XML_CAN_NOT_CONVERT_TEXT,
        XML_NO_TEXT_NODE
};


class XMLAttribute
{
        friend class XMLElement;
public:
        const char* Name() const { return name.getStr(); }                      
        const char* Value() const { return value.getStr(); }            
        const XMLAttribute* Next() const { return next; }                       

        int              IntValue() const                               { int i=0;              queryIntValue( &i );            return i; }
        unsigned UnsignedValue() const                  { unsigned i=0; queryUnsignedValue( &i );       return i; }
        bool     BoolValue() const                              { bool b=false; queryBoolValue( &b );           return b; }
        double   DoubleValue() const                    { double d=0.0; queryDoubleValue( &d );         return d; }
        float    FloatValue() const                             { float f=0.0;  queryFloatValue( &f );          return f; }

        int queryIntValue( int* value ) const;
        int queryUnsignedValue( unsigned int* value ) const;
        int queryBoolValue( bool* value ) const;
        int queryDoubleValue( double* value ) const;
        int queryFloatValue( float* value ) const;

        void setAttribute( const char* value );
        void setAttribute( char value );
        void setAttribute( int value );
        void setAttribute( long value );
        void setAttribute( unsigned value );
        void setAttribute( bool value );
        void setAttribute( double value );
        void setAttribute( float value );

private:
        enum { BUF_SIZE = 200 };

        XMLAttribute() : next( 0 ), memPool( NULL ) {}
        virtual ~XMLAttribute() {}
        XMLAttribute( const XMLAttribute& );    // not supported
        void operator=( const XMLAttribute& );  // not supported
        void setName( const char* name );

        char* parseDeep( char* p, bool processEntities );

        mutable StrPair name;
        mutable StrPair value;
        XMLAttribute* next;
        MemPool* memPool;
};


class XMLElement : public XMLNode
{
        friend class XMLBase;
        friend class XMLDocument;
public:
        const char* Name() const                { return Value(); }
        void SetName( const char* str, bool staticMem=false )   { setValue( str, staticMem ); }

        virtual XMLElement* ToElement()                         { return this; }
        virtual const XMLElement* ToElement() const { return this; }
        virtual bool accept( XMLVisitor* visitor ) const;

        const char* attribute( const char* name, const char* value=0 ) const;

        int              IntAttribute( const char* name ) const         { int i=0;              QueryIntAttribute( name, &i );          return i; }
        unsigned UnsignedAttribute( const char* name ) const{ unsigned i=0; QueryUnsignedAttribute( name, &i ); return i; }
        bool     BoolAttribute( const char* name ) const        { bool b=false; QueryBoolAttribute( name, &b );         return b; }
        double   DoubleAttribute( const char* name ) const      { double d=0;   QueryDoubleAttribute( name, &d );       return d; }
        float    FloatAttribute( const char* name ) const       { float f=0;    QueryFloatAttribute( name, &f );        return f; }

        int QueryIntAttribute( const char* name, int* _value ) const                            { const XMLAttribute* a = findAttribute( name ); if ( !a ) return XML_NO_ATTRIBUTE; return a->queryIntValue( _value ); } 
        int QueryUnsignedAttribute( const char* name, unsigned int* _value ) const      { const XMLAttribute* a = findAttribute( name ); if ( !a ) return XML_NO_ATTRIBUTE; return a->queryUnsignedValue( _value ); }
        int QueryBoolAttribute( const char* name, bool* _value ) const                          { const XMLAttribute* a = findAttribute( name ); if ( !a ) return XML_NO_ATTRIBUTE; return a->queryBoolValue( _value ); }
        int QueryDoubleAttribute( const char* name, double* _value ) const                      { const XMLAttribute* a = findAttribute( name ); if ( !a ) return XML_NO_ATTRIBUTE; return a->queryDoubleValue( _value ); }
        int QueryFloatAttribute( const char* name, float* _value ) const                        { const XMLAttribute* a = findAttribute( name ); if ( !a ) return XML_NO_ATTRIBUTE; return a->queryFloatValue( _value ); }

        void SetAttribute( const char* name, const char* _value )       { XMLAttribute* a = findOrCreateAttribute( name ); a->setAttribute( _value ); }
        void SetAttribute( const char* name, char _value )    { XMLAttribute* a = findOrCreateAttribute( name ); a->setAttribute( _value ); }
        void SetAttribute( const char* name, int _value )                       { XMLAttribute* a = findOrCreateAttribute( name ); a->setAttribute( _value ); }
        void SetAttribute( const char* name, unsigned _value )          { XMLAttribute* a = findOrCreateAttribute( name ); a->setAttribute( _value ); }
        void SetAttribute( const char* name, bool _value )                      { XMLAttribute* a = findOrCreateAttribute( name ); a->setAttribute( _value ); }
        void SetAttribute( const char* name, double _value )            { XMLAttribute* a = findOrCreateAttribute( name ); a->setAttribute( _value ); }
        void SetAttribute( const char* name, long _value )    { XMLAttribute* a = findOrCreateAttribute( name ); a->setAttribute( _value ); }


        void deleteAttribute( const char* name );

        const XMLAttribute* FirstAttribute() const { return rootAttribute; }
        const XMLAttribute* findAttribute( const char* name ) const;

        const char* getText() const;

        int queryIntText( int* _value ) const;
        int queryUnsignedText( unsigned* _value ) const;
        int queryBoolText( bool* _value ) const;
        int queryDoubleText( double* _value ) const;
        int queryFloatText( float* _value ) const;

        // internal:
        enum {
                OPEN,           // <foo>
                CLOSED,         // <foo/>
                CLOSING         // </foo>
        };
        int ClosingType() const { return closingType; }
        char* parseDeep( char* p, StrPair* endTag );
        virtual XMLNode* shallowClone( XMLDocument* document ) const;
        virtual bool shallowEqual( const XMLNode* compare ) const;

private:
        XMLElement( XMLDocument* doc );
        virtual ~XMLElement();
        XMLElement( const XMLElement& );        // not supported
        void operator=( const XMLElement& );    // not supported

        XMLAttribute* findAttribute( const char* name );
        XMLAttribute* findOrCreateAttribute( const char* name );
        //void LinkAttribute( XMLAttribute* attrib );
        char* parseAttributes( char* p );

        int closingType;
        // The attribute list is ordered; there is no 'lastAttribute'
        // because the list needs to be scanned for dupes before adding
        // a new attribute.
        XMLAttribute* rootAttribute;
};


class XMLDocument : public XMLNode
{
        friend class XMLElement;
public:
        XMLDocument( bool processEntities = true ); 
        ~XMLDocument();

        virtual XMLDocument* ToDocument()                               { return this; }
        virtual const XMLDocument* ToDocument() const   { return this; }

        int parse( const char* xml );
        
        int loadFile( const char* filename );
        
        int loadFile( FILE* );
        
        int saveFile( const char* filename );

        int saveFile( FILE* );

        bool ProcessEntities() const                                            { return processEntities; }

        bool HasBOM() const { return writeBOM; }
        void SetBOM( bool useBOM ) { writeBOM = useBOM; }

        XMLElement* RootElement()                               { return FirstChildElement(); }
        const XMLElement* RootElement() const   { return firstChildElement(); }

        void print( XMLPrinter* streamer=0 );
        virtual bool accept( XMLVisitor* visitor ) const;

        XMLElement* newElement( const char* name );
        XMLComment* newComment( const char* comment );
        XMLText* newText( const char* text );
        XMLDeclaration* newDeclaration( const char* text=0 );
        XMLUnknown* newUnknown( const char* text );

        void DeleteNode( XMLNode* node )        { node->parent->deleteChild( node ); }

        void setError( int error, const char* str1, const char* str2 );
        
        bool Error() const { return errorID != XML_NO_ERROR; }
        int  ErrorID() const { return errorID; }
        const char* GetErrorStr1() const { return errorStr1; }
        const char* GetErrorStr2() const { return errorStr2; }
        void printError() const;

        // internal
        char* identify( char* p, XMLNode** node );

        virtual XMLNode* shallowClone( XMLDocument* /*document*/ ) const        { return 0; }
        virtual bool shallowEqual( const XMLNode* /*compare*/ ) const   { return false; }

private:
        XMLDocument( const XMLDocument& );      // not supported
        void operator=( const XMLDocument& );   // not supported
        void initDocument();

        bool writeBOM;
        bool processEntities;
        int errorID;
        const char* errorStr1;
        const char* errorStr2;
        char* charBuffer;

        MemPoolT< sizeof(XMLElement) >  elementPool;
        MemPoolT< sizeof(XMLAttribute) > attributePool;
        MemPoolT< sizeof(XMLText) >             textPool;
        MemPoolT< sizeof(XMLComment) >  commentPool;
};


class XMLHandle
{
public:
        XMLHandle( XMLNode* _node )                                                                                             { node = _node; }
        XMLHandle( XMLNode& _node )                                                                                             { node = &_node; }
        XMLHandle( const XMLHandle& ref )                                                                               { node = ref.node; }
        XMLHandle& operator=( const XMLHandle& ref )                                                    { node = ref.node; return *this; }

        XMLHandle FirstChild()                                                                                                  { return XMLHandle( node ? node->FirstChild() : 0 ); }
        XMLHandle FirstChildElement( const char* value=0 )                                              { return XMLHandle( node ? node->FirstChildElement( value ) : 0 ); }
        XMLHandle LastChild()                                                                                                   { return XMLHandle( node ? node->LastChild() : 0 ); }
        XMLHandle LastChildElement( const char* _value=0 )                                              { return XMLHandle( node ? node->LastChildElement( _value ) : 0 ); }
        XMLHandle PreviousSibling()                                                                                             { return XMLHandle( node ? node->PreviousSibling() : 0 ); }
        XMLHandle PreviousSiblingElement( const char* _value=0 )                                { return XMLHandle( node ? node->PreviousSiblingElement( _value ) : 0 ); }
        XMLHandle NextSibling()                                                                                                 { return XMLHandle( node ? node->NextSibling() : 0 ); }         
        XMLHandle NextSiblingElement( const char* _value=0 )                                    { return XMLHandle( node ? node->NextSiblingElement( _value ) : 0 ); }

        XMLNode* ToNode()                                                       { return node; } 
        XMLElement* ToElement()                                         { return ( ( node && node->ToElement() ) ? node->ToElement() : 0 ); }
        XMLText* ToText()                                                       { return ( ( node && node->ToText() ) ? node->ToText() : 0 ); }
        XMLUnknown* ToUnknown()                                         { return ( ( node && node->ToUnknown() ) ? node->ToUnknown() : 0 ); }
        XMLDeclaration* ToDeclaration()                         { return ( ( node && node->ToDeclaration() ) ? node->ToDeclaration() : 0 ); }

private:
        XMLNode* node;
};


class XMLConstHandle
{
public:
        XMLConstHandle( const XMLNode* _node )                                                                                  { node = _node; }
        XMLConstHandle( const XMLNode& _node )                                                                                  { node = &_node; }
        XMLConstHandle( const XMLConstHandle& ref )                                                                             { node = ref.node; }

        XMLConstHandle& operator=( const XMLConstHandle& ref )                                                  { node = ref.node; return *this; }

        const XMLConstHandle FirstChild() const                                                                                 { return XMLConstHandle( node ? node->FirstChild() : 0 ); }
        const XMLConstHandle FirstChildElement( const char* value=0 ) const                             { return XMLConstHandle( node ? node->firstChildElement( value ) : 0 ); }
        const XMLConstHandle LastChild()        const                                                                           { return XMLConstHandle( node ? node->LastChild() : 0 ); }
        const XMLConstHandle LastChildElement( const char* _value=0 ) const                             { return XMLConstHandle( node ? node->lastChildElement( _value ) : 0 ); }
        const XMLConstHandle PreviousSibling() const                                                                    { return XMLConstHandle( node ? node->PreviousSibling() : 0 ); }
        const XMLConstHandle PreviousSiblingElement( const char* _value=0 ) const               { return XMLConstHandle( node ? node->previousSiblingElement( _value ) : 0 ); }
        const XMLConstHandle NextSibling() const                                                                                { return XMLConstHandle( node ? node->NextSibling() : 0 ); }
        const XMLConstHandle NextSiblingElement( const char* _value=0 ) const                   { return XMLConstHandle( node ? node->nextSiblingElement( _value ) : 0 ); }


        const XMLNode* ToNode() const                           { return node; } 
        const XMLElement* ToElement() const                     { return ( ( node && node->ToElement() ) ? node->ToElement() : 0 ); }
        const XMLText* ToText() const                           { return ( ( node && node->ToText() ) ? node->ToText() : 0 ); }
        const XMLUnknown* ToUnknown() const                     { return ( ( node && node->ToUnknown() ) ? node->ToUnknown() : 0 ); }
        const XMLDeclaration* ToDeclaration() const     { return ( ( node && node->ToDeclaration() ) ? node->ToDeclaration() : 0 ); }

private:
        const XMLNode* node;
};


class XMLPrinter : public XMLVisitor
{
public:
        XMLPrinter( FILE* file=0, bool compact = false );
        ~XMLPrinter()   {}

        void pushHeader( bool writeBOM, bool writeDeclaration );
        void openElement( const char* name );
        void pushAttribute( const char* name, const char* value );
        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 );
        void closeElement();

        void pushText( const char* text, bool cdata=false );
        void pushText( int value );
        void pushText( unsigned value );
        void pushText( bool value );
        void pushText( float value );
        void pushText( double value );

        void pushComment( const char* comment );

        void pushDeclaration( const char* value );
        void pushUnknown( const char* value );

        virtual bool visitEnter( const XMLDocument& /*doc*/ );
        virtual bool VisitExit( const XMLDocument& /*doc*/ )                    { return true; }

        virtual bool visitEnter( const XMLElement& element, const XMLAttribute* attribute );
        virtual bool visitExit( const XMLElement& element );

        virtual bool visit( const XMLText& text );
        virtual bool visit( const XMLComment& comment );
        virtual bool visit( const XMLDeclaration& declaration );
        virtual bool visit( const XMLUnknown& unknown );

        const char* CStr() const { return buffer.Mem(); }
        int CStrSize() const { return buffer.Size(); }

private:
        void sealElement();
        void printSpace( int depth );
        void printString( const char*, bool restrictedEntitySet );      // prints out, after detecting entities.
        void print( const char* format, ... );

        bool elementJustOpened;
        bool firstElement;
        FILE* fp;
        int depth;
        int textDepth;
        bool processEntities;
        bool compactMode;

        enum {
                ENTITY_RANGE = 64,
                BUF_SIZE = 200
        };
        bool entityFlag[ENTITY_RANGE];
        bool restrictedEntityFlag[ENTITY_RANGE];

        DynArray< const char*, 10 > stack;
        DynArray< char, 20 > buffer;
#ifdef _MSC_VER
        DynArray< char, 20 > accumulator;
#endif
};


}       // tinyxml2


#endif // TINYXML2_INCLUDED