nuclear@73: /*
nuclear@73: Original code by Lee Thomason (www.grinninglizard.com)
nuclear@73: 
nuclear@73: This software is provided 'as-is', without any express or implied
nuclear@73: warranty. In no event will the authors be held liable for any
nuclear@73: damages arising from the use of this software.
nuclear@73: 
nuclear@73: Permission is granted to anyone to use this software for any
nuclear@73: purpose, including commercial applications, and to alter it and
nuclear@73: redistribute it freely, subject to the following restrictions:
nuclear@73: 
nuclear@73: 1. The origin of this software must not be misrepresented; you must
nuclear@73: not claim that you wrote the original software. If you use this
nuclear@73: software in a product, an acknowledgment in the product documentation
nuclear@73: would be appreciated but is not required.
nuclear@73: 
nuclear@73: 
nuclear@73: 2. Altered source versions must be plainly marked as such, and
nuclear@73: must not be misrepresented as being the original software.
nuclear@73: 
nuclear@73: 3. This notice may not be removed or altered from any source
nuclear@73: distribution.
nuclear@73: */
nuclear@73: 
nuclear@73: #ifndef TINYXML2_INCLUDED
nuclear@73: #define TINYXML2_INCLUDED
nuclear@73: 
nuclear@73: #if defined(ANDROID_NDK) || defined(__BORLANDC__)
nuclear@73: #   include <ctype.h>
nuclear@73: #   include <limits.h>
nuclear@73: #   include <stdio.h>
nuclear@73: #   include <stdlib.h>
nuclear@73: #   include <string.h>
nuclear@73: #   include <stdarg.h>
nuclear@73: #else
nuclear@73: #   include <cctype>
nuclear@73: #   include <climits>
nuclear@73: #   include <cstdio>
nuclear@73: #   include <cstdlib>
nuclear@73: #   include <cstring>
nuclear@73: #   include <cstdarg>
nuclear@73: #endif
nuclear@73: 
nuclear@73: /*
nuclear@73:    TODO: intern strings instead of allocation.
nuclear@73: */
nuclear@73: /*
nuclear@73: 	gcc:
nuclear@73:         g++ -Wall -DDEBUG tinyxml2.cpp xmltest.cpp -o gccxmltest.exe
nuclear@73: 
nuclear@73:     Formatting, Artistic Style:
nuclear@73:         AStyle.exe --style=1tbs --indent-switches --break-closing-brackets --indent-preprocessor tinyxml2.cpp tinyxml2.h
nuclear@73: */
nuclear@73: 
nuclear@73: #if defined( _DEBUG ) || defined( DEBUG ) || defined (__DEBUG__)
nuclear@73: #   ifndef DEBUG
nuclear@73: #       define DEBUG
nuclear@73: #   endif
nuclear@73: #endif
nuclear@73: 
nuclear@73: #ifdef _MSC_VER
nuclear@73: #   pragma warning(push)
nuclear@73: #   pragma warning(disable: 4251)
nuclear@73: #endif
nuclear@73: 
nuclear@73: #ifdef _WIN32
nuclear@73: #   ifdef TINYXML2_EXPORT
nuclear@73: #       define TINYXML2_LIB __declspec(dllexport)
nuclear@73: #   elif defined(TINYXML2_IMPORT)
nuclear@73: #       define TINYXML2_LIB __declspec(dllimport)
nuclear@73: #   else
nuclear@73: #       define TINYXML2_LIB
nuclear@73: #   endif
nuclear@73: #else
nuclear@73: #   define TINYXML2_LIB
nuclear@73: #endif
nuclear@73: 
nuclear@73: 
nuclear@73: #if defined(DEBUG)
nuclear@73: #   if defined(_MSC_VER)
nuclear@73: #       define TIXMLASSERT( x )           if ( !(x)) { __debugbreak(); } //if ( !(x)) WinDebugBreak()
nuclear@73: #   elif defined (ANDROID_NDK)
nuclear@73: #       include <android/log.h>
nuclear@73: #       define TIXMLASSERT( x )           if ( !(x)) { __android_log_assert( "assert", "grinliz", "ASSERT in '%s' at %d.", __FILE__, __LINE__ ); }
nuclear@73: #   else
nuclear@73: #       include <assert.h>
nuclear@73: #       define TIXMLASSERT                assert
nuclear@73: #   endif
nuclear@73: #   else
nuclear@73: #       define TIXMLASSERT( x )           {}
nuclear@73: #endif
nuclear@73: 
nuclear@73: 
nuclear@73: #if defined(_MSC_VER) && (_MSC_VER >= 1400 )
nuclear@73: // Microsoft visual studio, version 2005 and higher.
nuclear@73: /*int _snprintf_s(
nuclear@73:    char *buffer,
nuclear@73:    size_t sizeOfBuffer,
nuclear@73:    size_t count,
nuclear@73:    const char *format [,
nuclear@73: 	  argument] ...
nuclear@73: );*/
nuclear@73: inline int TIXML_SNPRINTF( char* buffer, size_t size, const char* format, ... )
nuclear@73: {
nuclear@73:     va_list va;
nuclear@73:     va_start( va, format );
nuclear@73:     int result = vsnprintf_s( buffer, size, _TRUNCATE, format, va );
nuclear@73:     va_end( va );
nuclear@73:     return result;
nuclear@73: }
nuclear@73: #define TIXML_SSCANF   sscanf_s
nuclear@73: #else
nuclear@73: // GCC version 3 and higher
nuclear@73: //#warning( "Using sn* functions." )
nuclear@73: #define TIXML_SNPRINTF snprintf
nuclear@73: #define TIXML_SSCANF   sscanf
nuclear@73: #endif
nuclear@73: 
nuclear@73: static const int TIXML2_MAJOR_VERSION = 1;
nuclear@73: static const int TIXML2_MINOR_VERSION = 0;
nuclear@73: static const int TIXML2_PATCH_VERSION = 11;
nuclear@73: 
nuclear@73: namespace tinyxml2
nuclear@73: {
nuclear@73: class XMLDocument;
nuclear@73: class XMLElement;
nuclear@73: class XMLAttribute;
nuclear@73: class XMLComment;
nuclear@73: class XMLText;
nuclear@73: class XMLDeclaration;
nuclear@73: class XMLUnknown;
nuclear@73: class XMLPrinter;
nuclear@73: 
nuclear@73: /*
nuclear@73: 	A class that wraps strings. Normally stores the start and end
nuclear@73: 	pointers into the XML file itself, and will apply normalization
nuclear@73: 	and entity translation if actually read. Can also store (and memory
nuclear@73: 	manage) a traditional char[]
nuclear@73: */
nuclear@73: class StrPair
nuclear@73: {
nuclear@73: public:
nuclear@73:     enum {
nuclear@73:         NEEDS_ENTITY_PROCESSING			= 0x01,
nuclear@73:         NEEDS_NEWLINE_NORMALIZATION		= 0x02,
nuclear@73:         COLLAPSE_WHITESPACE	                = 0x04,
nuclear@73: 
nuclear@73:         TEXT_ELEMENT		            	= NEEDS_ENTITY_PROCESSING | NEEDS_NEWLINE_NORMALIZATION,
nuclear@73:         TEXT_ELEMENT_LEAVE_ENTITIES		= NEEDS_NEWLINE_NORMALIZATION,
nuclear@73:         ATTRIBUTE_NAME		            	= 0,
nuclear@73:         ATTRIBUTE_VALUE		            	= NEEDS_ENTITY_PROCESSING | NEEDS_NEWLINE_NORMALIZATION,
nuclear@73:         ATTRIBUTE_VALUE_LEAVE_ENTITIES  	= NEEDS_NEWLINE_NORMALIZATION,
nuclear@73:         COMMENT				        = NEEDS_NEWLINE_NORMALIZATION
nuclear@73:     };
nuclear@73: 
nuclear@73:     StrPair() : _flags( 0 ), _start( 0 ), _end( 0 ) {}
nuclear@73:     ~StrPair();
nuclear@73: 
nuclear@73:     void Set( char* start, char* end, int flags ) {
nuclear@73:         Reset();
nuclear@73:         _start  = start;
nuclear@73:         _end    = end;
nuclear@73:         _flags  = flags | NEEDS_FLUSH;
nuclear@73:     }
nuclear@73: 
nuclear@73:     const char* GetStr();
nuclear@73: 
nuclear@73:     bool Empty() const {
nuclear@73:         return _start == _end;
nuclear@73:     }
nuclear@73: 
nuclear@73:     void SetInternedStr( const char* str ) {
nuclear@73:         Reset();
nuclear@73:         _start = const_cast<char*>(str);
nuclear@73:     }
nuclear@73: 
nuclear@73:     void SetStr( const char* str, int flags=0 );
nuclear@73: 
nuclear@73:     char* ParseText( char* in, const char* endTag, int strFlags );
nuclear@73:     char* ParseName( char* in );
nuclear@73: 
nuclear@73: private:
nuclear@73:     void Reset();
nuclear@73:     void CollapseWhitespace();
nuclear@73: 
nuclear@73:     enum {
nuclear@73:         NEEDS_FLUSH = 0x100,
nuclear@73:         NEEDS_DELETE = 0x200
nuclear@73:     };
nuclear@73: 
nuclear@73:     // After parsing, if *_end != 0, it can be set to zero.
nuclear@73:     int     _flags;
nuclear@73:     char*   _start;
nuclear@73:     char*   _end;
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: /*
nuclear@73: 	A dynamic array of Plain Old Data. Doesn't support constructors, etc.
nuclear@73: 	Has a small initial memory pool, so that low or no usage will not
nuclear@73: 	cause a call to new/delete
nuclear@73: */
nuclear@73: template <class T, int INIT>
nuclear@73: class DynArray
nuclear@73: {
nuclear@73: public:
nuclear@73:     DynArray< T, INIT >() {
nuclear@73:         _mem = _pool;
nuclear@73:         _allocated = INIT;
nuclear@73:         _size = 0;
nuclear@73:     }
nuclear@73: 
nuclear@73:     ~DynArray() {
nuclear@73:         if ( _mem != _pool ) {
nuclear@73:             delete [] _mem;
nuclear@73:         }
nuclear@73:     }
nuclear@73: 
nuclear@73:     void Push( T t ) {
nuclear@73:         EnsureCapacity( _size+1 );
nuclear@73:         _mem[_size++] = t;
nuclear@73:     }
nuclear@73: 
nuclear@73:     T* PushArr( int count ) {
nuclear@73:         EnsureCapacity( _size+count );
nuclear@73:         T* ret = &_mem[_size];
nuclear@73:         _size += count;
nuclear@73:         return ret;
nuclear@73:     }
nuclear@73: 
nuclear@73:     T Pop() {
nuclear@73:         return _mem[--_size];
nuclear@73:     }
nuclear@73: 
nuclear@73:     void PopArr( int count ) {
nuclear@73:         TIXMLASSERT( _size >= count );
nuclear@73:         _size -= count;
nuclear@73:     }
nuclear@73: 
nuclear@73:     bool Empty() const					{
nuclear@73:         return _size == 0;
nuclear@73:     }
nuclear@73: 
nuclear@73:     T& operator[](int i)				{
nuclear@73:         TIXMLASSERT( i>= 0 && i < _size );
nuclear@73:         return _mem[i];
nuclear@73:     }
nuclear@73: 
nuclear@73:     const T& operator[](int i) const	{
nuclear@73:         TIXMLASSERT( i>= 0 && i < _size );
nuclear@73:         return _mem[i];
nuclear@73:     }
nuclear@73: 
nuclear@73:     int Size() const					{
nuclear@73:         return _size;
nuclear@73:     }
nuclear@73: 
nuclear@73:     int Capacity() const				{
nuclear@73:         return _allocated;
nuclear@73:     }
nuclear@73: 
nuclear@73:     const T* Mem() const				{
nuclear@73:         return _mem;
nuclear@73:     }
nuclear@73: 
nuclear@73:     T* Mem()							{
nuclear@73:         return _mem;
nuclear@73:     }
nuclear@73: 
nuclear@73: private:
nuclear@73:     void EnsureCapacity( int cap ) {
nuclear@73:         if ( cap > _allocated ) {
nuclear@73:             int newAllocated = cap * 2;
nuclear@73:             T* newMem = new T[newAllocated];
nuclear@73:             memcpy( newMem, _mem, sizeof(T)*_size );	// warning: not using constructors, only works for PODs
nuclear@73:             if ( _mem != _pool ) {
nuclear@73:                 delete [] _mem;
nuclear@73:             }
nuclear@73:             _mem = newMem;
nuclear@73:             _allocated = newAllocated;
nuclear@73:         }
nuclear@73:     }
nuclear@73: 
nuclear@73:     T*  _mem;
nuclear@73:     T   _pool[INIT];
nuclear@73:     int _allocated;		// objects allocated
nuclear@73:     int _size;			// number objects in use
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: /*
nuclear@73: 	Parent virtual class of a pool for fast allocation
nuclear@73: 	and deallocation of objects.
nuclear@73: */
nuclear@73: class MemPool
nuclear@73: {
nuclear@73: public:
nuclear@73:     MemPool() {}
nuclear@73:     virtual ~MemPool() {}
nuclear@73: 
nuclear@73:     virtual int ItemSize() const = 0;
nuclear@73:     virtual void* Alloc() = 0;
nuclear@73:     virtual void Free( void* ) = 0;
nuclear@73:     virtual void SetTracked() = 0;
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: /*
nuclear@73: 	Template child class to create pools of the correct type.
nuclear@73: */
nuclear@73: template< int SIZE >
nuclear@73: class MemPoolT : public MemPool
nuclear@73: {
nuclear@73: public:
nuclear@73:     MemPoolT() : _root(0), _currentAllocs(0), _nAllocs(0), _maxAllocs(0), _nUntracked(0)	{}
nuclear@73:     ~MemPoolT() {
nuclear@73:         // Delete the blocks.
nuclear@73:         for( int i=0; i<_blockPtrs.Size(); ++i ) {
nuclear@73:             delete _blockPtrs[i];
nuclear@73:         }
nuclear@73:     }
nuclear@73: 
nuclear@73:     virtual int ItemSize() const	{
nuclear@73:         return SIZE;
nuclear@73:     }
nuclear@73:     int CurrentAllocs() const		{
nuclear@73:         return _currentAllocs;
nuclear@73:     }
nuclear@73: 
nuclear@73:     virtual void* Alloc() {
nuclear@73:         if ( !_root ) {
nuclear@73:             // Need a new block.
nuclear@73:             Block* block = new Block();
nuclear@73:             _blockPtrs.Push( block );
nuclear@73: 
nuclear@73:             for( int i=0; i<COUNT-1; ++i ) {
nuclear@73:                 block->chunk[i].next = &block->chunk[i+1];
nuclear@73:             }
nuclear@73:             block->chunk[COUNT-1].next = 0;
nuclear@73:             _root = block->chunk;
nuclear@73:         }
nuclear@73:         void* result = _root;
nuclear@73:         _root = _root->next;
nuclear@73: 
nuclear@73:         ++_currentAllocs;
nuclear@73:         if ( _currentAllocs > _maxAllocs ) {
nuclear@73:             _maxAllocs = _currentAllocs;
nuclear@73:         }
nuclear@73:         _nAllocs++;
nuclear@73:         _nUntracked++;
nuclear@73:         return result;
nuclear@73:     }
nuclear@73:     virtual void Free( void* mem ) {
nuclear@73:         if ( !mem ) {
nuclear@73:             return;
nuclear@73:         }
nuclear@73:         --_currentAllocs;
nuclear@73:         Chunk* chunk = (Chunk*)mem;
nuclear@73: #ifdef DEBUG
nuclear@73:         memset( chunk, 0xfe, sizeof(Chunk) );
nuclear@73: #endif
nuclear@73:         chunk->next = _root;
nuclear@73:         _root = chunk;
nuclear@73:     }
nuclear@73:     void Trace( const char* name ) {
nuclear@73:         printf( "Mempool %s watermark=%d [%dk] current=%d size=%d nAlloc=%d blocks=%d\n",
nuclear@73:                 name, _maxAllocs, _maxAllocs*SIZE/1024, _currentAllocs, SIZE, _nAllocs, _blockPtrs.Size() );
nuclear@73:     }
nuclear@73: 
nuclear@73:     void SetTracked() {
nuclear@73:         _nUntracked--;
nuclear@73:     }
nuclear@73: 
nuclear@73:     int Untracked() const {
nuclear@73:         return _nUntracked;
nuclear@73:     }
nuclear@73: 
nuclear@73: 	// This number is perf sensitive. 4k seems like a good tradeoff on my machine.
nuclear@73: 	// The test file is large, 170k.
nuclear@73: 	// Release:		VS2010 gcc(no opt)
nuclear@73: 	//		1k:		4000
nuclear@73: 	//		2k:		4000
nuclear@73: 	//		4k:		3900	21000
nuclear@73: 	//		16k:	5200
nuclear@73: 	//		32k:	4300
nuclear@73: 	//		64k:	4000	21000
nuclear@73:     enum { COUNT = (4*1024)/SIZE }; // Some compilers do not accept to use COUNT in private part if COUNT is private
nuclear@73: 
nuclear@73: private:
nuclear@73:     union Chunk {
nuclear@73:         Chunk*  next;
nuclear@73:         char    mem[SIZE];
nuclear@73:     };
nuclear@73:     struct Block {
nuclear@73:         Chunk chunk[COUNT];
nuclear@73:     };
nuclear@73:     DynArray< Block*, 10 > _blockPtrs;
nuclear@73:     Chunk* _root;
nuclear@73: 
nuclear@73:     int _currentAllocs;
nuclear@73:     int _nAllocs;
nuclear@73:     int _maxAllocs;
nuclear@73:     int _nUntracked;
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: 
nuclear@73: /**
nuclear@73: 	Implements the interface to the "Visitor pattern" (see the Accept() method.)
nuclear@73: 	If you call the Accept() method, it requires being passed a XMLVisitor
nuclear@73: 	class to handle callbacks. For nodes that contain other nodes (Document, Element)
nuclear@73: 	you will get called with a VisitEnter/VisitExit pair. Nodes that are always leafs
nuclear@73: 	are simply called with Visit().
nuclear@73: 
nuclear@73: 	If you return 'true' from a Visit method, recursive parsing will continue. If you return
nuclear@73: 	false, <b>no children of this node or its siblings</b> will be visited.
nuclear@73: 
nuclear@73: 	All flavors of Visit methods have a default implementation that returns 'true' (continue
nuclear@73: 	visiting). You need to only override methods that are interesting to you.
nuclear@73: 
nuclear@73: 	Generally Accept() is called on the XMLDocument, although all nodes support visiting.
nuclear@73: 
nuclear@73: 	You should never change the document from a callback.
nuclear@73: 
nuclear@73: 	@sa XMLNode::Accept()
nuclear@73: */
nuclear@73: class TINYXML2_LIB XMLVisitor
nuclear@73: {
nuclear@73: public:
nuclear@73:     virtual ~XMLVisitor() {}
nuclear@73: 
nuclear@73:     /// Visit a document.
nuclear@73:     virtual bool VisitEnter( const XMLDocument& /*doc*/ )			{
nuclear@73:         return true;
nuclear@73:     }
nuclear@73:     /// Visit a document.
nuclear@73:     virtual bool VisitExit( const XMLDocument& /*doc*/ )			{
nuclear@73:         return true;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /// Visit an element.
nuclear@73:     virtual bool VisitEnter( const XMLElement& /*element*/, const XMLAttribute* /*firstAttribute*/ )	{
nuclear@73:         return true;
nuclear@73:     }
nuclear@73:     /// Visit an element.
nuclear@73:     virtual bool VisitExit( const XMLElement& /*element*/ )			{
nuclear@73:         return true;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /// Visit a declaration.
nuclear@73:     virtual bool Visit( const XMLDeclaration& /*declaration*/ )		{
nuclear@73:         return true;
nuclear@73:     }
nuclear@73:     /// Visit a text node.
nuclear@73:     virtual bool Visit( const XMLText& /*text*/ )					{
nuclear@73:         return true;
nuclear@73:     }
nuclear@73:     /// Visit a comment node.
nuclear@73:     virtual bool Visit( const XMLComment& /*comment*/ )				{
nuclear@73:         return true;
nuclear@73:     }
nuclear@73:     /// Visit an unknown node.
nuclear@73:     virtual bool Visit( const XMLUnknown& /*unknown*/ )				{
nuclear@73:         return true;
nuclear@73:     }
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: /*
nuclear@73: 	Utility functionality.
nuclear@73: */
nuclear@73: class XMLUtil
nuclear@73: {
nuclear@73: public:
nuclear@73:     // Anything in the high order range of UTF-8 is assumed to not be whitespace. This isn't
nuclear@73:     // correct, but simple, and usually works.
nuclear@73:     static const char* SkipWhiteSpace( const char* p )	{
nuclear@73:         while( !IsUTF8Continuation(*p) && isspace( *reinterpret_cast<const unsigned char*>(p) ) ) {
nuclear@73:             ++p;
nuclear@73:         }
nuclear@73:         return p;
nuclear@73:     }
nuclear@73:     static char* SkipWhiteSpace( char* p )				{
nuclear@73:         while( !IsUTF8Continuation(*p) && isspace( *reinterpret_cast<unsigned char*>(p) ) )		{
nuclear@73:             ++p;
nuclear@73:         }
nuclear@73:         return p;
nuclear@73:     }
nuclear@73:     static bool IsWhiteSpace( char p )					{
nuclear@73:         return !IsUTF8Continuation(p) && isspace( static_cast<unsigned char>(p) );
nuclear@73:     }
nuclear@73:     
nuclear@73:     inline static bool IsNameStartChar( unsigned char ch ) {
nuclear@73:         return ( ( ch < 128 ) ? isalpha( ch ) : 1 )
nuclear@73:                || ch == ':'
nuclear@73:                || ch == '_';
nuclear@73:     }
nuclear@73:     
nuclear@73:     inline static bool IsNameChar( unsigned char ch ) {
nuclear@73:         return IsNameStartChar( ch )
nuclear@73:                || isdigit( ch )
nuclear@73:                || ch == '.'
nuclear@73:                || ch == '-';
nuclear@73:     }
nuclear@73: 
nuclear@73:     inline static bool StringEqual( const char* p, const char* q, int nChar=INT_MAX )  {
nuclear@73:         int n = 0;
nuclear@73:         if ( p == q ) {
nuclear@73:             return true;
nuclear@73:         }
nuclear@73:         while( *p && *q && *p == *q && n<nChar ) {
nuclear@73:             ++p;
nuclear@73:             ++q;
nuclear@73:             ++n;
nuclear@73:         }
nuclear@73:         if ( (n == nChar) || ( *p == 0 && *q == 0 ) ) {
nuclear@73:             return true;
nuclear@73:         }
nuclear@73:         return false;
nuclear@73:     }
nuclear@73:     
nuclear@73:     inline static int IsUTF8Continuation( const char p ) {
nuclear@73:         return p & 0x80;
nuclear@73:     }
nuclear@73: 
nuclear@73:     static const char* ReadBOM( const char* p, bool* hasBOM );
nuclear@73:     // p is the starting location,
nuclear@73:     // the UTF-8 value of the entity will be placed in value, and length filled in.
nuclear@73:     static const char* GetCharacterRef( const char* p, char* value, int* length );
nuclear@73:     static void ConvertUTF32ToUTF8( unsigned long input, char* output, int* length );
nuclear@73: 
nuclear@73:     // converts primitive types to strings
nuclear@73:     static void ToStr( int v, char* buffer, int bufferSize );
nuclear@73:     static void ToStr( unsigned v, char* buffer, int bufferSize );
nuclear@73:     static void ToStr( bool v, char* buffer, int bufferSize );
nuclear@73:     static void ToStr( float v, char* buffer, int bufferSize );
nuclear@73:     static void ToStr( double v, char* buffer, int bufferSize );
nuclear@73: 
nuclear@73:     // converts strings to primitive types
nuclear@73:     static bool	ToInt( const char* str, int* value );
nuclear@73:     static bool ToUnsigned( const char* str, unsigned* value );
nuclear@73:     static bool	ToBool( const char* str, bool* value );
nuclear@73:     static bool	ToFloat( const char* str, float* value );
nuclear@73:     static bool ToDouble( const char* str, double* value );
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: /** XMLNode is a base class for every object that is in the
nuclear@73: 	XML Document Object Model (DOM), except XMLAttributes.
nuclear@73: 	Nodes have siblings, a parent, and children which can
nuclear@73: 	be navigated. A node is always in a XMLDocument.
nuclear@73: 	The type of a XMLNode can be queried, and it can
nuclear@73: 	be cast to its more defined type.
nuclear@73: 
nuclear@73: 	A XMLDocument allocates memory for all its Nodes.
nuclear@73: 	When the XMLDocument gets deleted, all its Nodes
nuclear@73: 	will also be deleted.
nuclear@73: 
nuclear@73: 	@verbatim
nuclear@73: 	A Document can contain:	Element	(container or leaf)
nuclear@73: 							Comment (leaf)
nuclear@73: 							Unknown (leaf)
nuclear@73: 							Declaration( leaf )
nuclear@73: 
nuclear@73: 	An Element can contain:	Element (container or leaf)
nuclear@73: 							Text	(leaf)
nuclear@73: 							Attributes (not on tree)
nuclear@73: 							Comment (leaf)
nuclear@73: 							Unknown (leaf)
nuclear@73: 
nuclear@73: 	@endverbatim
nuclear@73: */
nuclear@73: class TINYXML2_LIB XMLNode
nuclear@73: {
nuclear@73:     friend class XMLDocument;
nuclear@73:     friend class XMLElement;
nuclear@73: public:
nuclear@73: 
nuclear@73:     /// Get the XMLDocument that owns this XMLNode.
nuclear@73:     const XMLDocument* GetDocument() const	{
nuclear@73:         return _document;
nuclear@73:     }
nuclear@73:     /// Get the XMLDocument that owns this XMLNode.
nuclear@73:     XMLDocument* GetDocument()				{
nuclear@73:         return _document;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /// Safely cast to an Element, or null.
nuclear@73:     virtual XMLElement*		ToElement()		{
nuclear@73:         return 0;
nuclear@73:     }
nuclear@73:     /// Safely cast to Text, or null.
nuclear@73:     virtual XMLText*		ToText()		{
nuclear@73:         return 0;
nuclear@73:     }
nuclear@73:     /// Safely cast to a Comment, or null.
nuclear@73:     virtual XMLComment*		ToComment()		{
nuclear@73:         return 0;
nuclear@73:     }
nuclear@73:     /// Safely cast to a Document, or null.
nuclear@73:     virtual XMLDocument*	ToDocument()	{
nuclear@73:         return 0;
nuclear@73:     }
nuclear@73:     /// Safely cast to a Declaration, or null.
nuclear@73:     virtual XMLDeclaration*	ToDeclaration()	{
nuclear@73:         return 0;
nuclear@73:     }
nuclear@73:     /// Safely cast to an Unknown, or null.
nuclear@73:     virtual XMLUnknown*		ToUnknown()		{
nuclear@73:         return 0;
nuclear@73:     }
nuclear@73: 
nuclear@73:     virtual const XMLElement*		ToElement() const		{
nuclear@73:         return 0;
nuclear@73:     }
nuclear@73:     virtual const XMLText*			ToText() const			{
nuclear@73:         return 0;
nuclear@73:     }
nuclear@73:     virtual const XMLComment*		ToComment() const		{
nuclear@73:         return 0;
nuclear@73:     }
nuclear@73:     virtual const XMLDocument*		ToDocument() const		{
nuclear@73:         return 0;
nuclear@73:     }
nuclear@73:     virtual const XMLDeclaration*	ToDeclaration() const	{
nuclear@73:         return 0;
nuclear@73:     }
nuclear@73:     virtual const XMLUnknown*		ToUnknown() const		{
nuclear@73:         return 0;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /** The meaning of 'value' changes for the specific type.
nuclear@73:     	@verbatim
nuclear@73:     	Document:	empty
nuclear@73:     	Element:	name of the element
nuclear@73:     	Comment:	the comment text
nuclear@73:     	Unknown:	the tag contents
nuclear@73:     	Text:		the text string
nuclear@73:     	@endverbatim
nuclear@73:     */
nuclear@73:     const char* Value() const			{
nuclear@73:         return _value.GetStr();
nuclear@73:     }
nuclear@73: 
nuclear@73:     /** Set the Value of an XML node.
nuclear@73:     	@sa Value()
nuclear@73:     */
nuclear@73:     void SetValue( const char* val, bool staticMem=false );
nuclear@73: 
nuclear@73:     /// Get the parent of this node on the DOM.
nuclear@73:     const XMLNode*	Parent() const			{
nuclear@73:         return _parent;
nuclear@73:     }
nuclear@73: 
nuclear@73:     XMLNode* Parent()						{
nuclear@73:         return _parent;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /// Returns true if this node has no children.
nuclear@73:     bool NoChildren() const					{
nuclear@73:         return !_firstChild;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /// Get the first child node, or null if none exists.
nuclear@73:     const XMLNode*  FirstChild() const		{
nuclear@73:         return _firstChild;
nuclear@73:     }
nuclear@73: 
nuclear@73:     XMLNode*		FirstChild()			{
nuclear@73:         return _firstChild;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /** Get the first child element, or optionally the first child
nuclear@73:         element with the specified name.
nuclear@73:     */
nuclear@73:     const XMLElement* FirstChildElement( const char* value=0 ) const;
nuclear@73: 
nuclear@73:     XMLElement* FirstChildElement( const char* value=0 )	{
nuclear@73:         return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->FirstChildElement( value ));
nuclear@73:     }
nuclear@73: 
nuclear@73:     /// Get the last child node, or null if none exists.
nuclear@73:     const XMLNode*	LastChild() const						{
nuclear@73:         return _lastChild;
nuclear@73:     }
nuclear@73: 
nuclear@73:     XMLNode*		LastChild()								{
nuclear@73:         return const_cast<XMLNode*>(const_cast<const XMLNode*>(this)->LastChild() );
nuclear@73:     }
nuclear@73: 
nuclear@73:     /** Get the last child element or optionally the last child
nuclear@73:         element with the specified name.
nuclear@73:     */
nuclear@73:     const XMLElement* LastChildElement( const char* value=0 ) const;
nuclear@73: 
nuclear@73:     XMLElement* LastChildElement( const char* value=0 )	{
nuclear@73:         return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->LastChildElement(value) );
nuclear@73:     }
nuclear@73: 
nuclear@73:     /// Get the previous (left) sibling node of this node.
nuclear@73:     const XMLNode*	PreviousSibling() const					{
nuclear@73:         return _prev;
nuclear@73:     }
nuclear@73: 
nuclear@73:     XMLNode*	PreviousSibling()							{
nuclear@73:         return _prev;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /// Get the previous (left) sibling element of this node, with an optionally supplied name.
nuclear@73:     const XMLElement*	PreviousSiblingElement( const char* value=0 ) const ;
nuclear@73: 
nuclear@73:     XMLElement*	PreviousSiblingElement( const char* value=0 ) {
nuclear@73:         return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->PreviousSiblingElement( value ) );
nuclear@73:     }
nuclear@73: 
nuclear@73:     /// Get the next (right) sibling node of this node.
nuclear@73:     const XMLNode*	NextSibling() const						{
nuclear@73:         return _next;
nuclear@73:     }
nuclear@73: 
nuclear@73:     XMLNode*	NextSibling()								{
nuclear@73:         return _next;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /// Get the next (right) sibling element of this node, with an optionally supplied name.
nuclear@73:     const XMLElement*	NextSiblingElement( const char* value=0 ) const;
nuclear@73: 
nuclear@73:     XMLElement*	NextSiblingElement( const char* value=0 )	{
nuclear@73:         return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->NextSiblingElement( value ) );
nuclear@73:     }
nuclear@73: 
nuclear@73:     /**
nuclear@73:     	Add a child node as the last (right) child.
nuclear@73:     */
nuclear@73:     XMLNode* InsertEndChild( XMLNode* addThis );
nuclear@73: 
nuclear@73:     XMLNode* LinkEndChild( XMLNode* addThis )	{
nuclear@73:         return InsertEndChild( addThis );
nuclear@73:     }
nuclear@73:     /**
nuclear@73:     	Add a child node as the first (left) child.
nuclear@73:     */
nuclear@73:     XMLNode* InsertFirstChild( XMLNode* addThis );
nuclear@73:     /**
nuclear@73:     	Add a node after the specified child node.
nuclear@73:     */
nuclear@73:     XMLNode* InsertAfterChild( XMLNode* afterThis, XMLNode* addThis );
nuclear@73: 
nuclear@73:     /**
nuclear@73:     	Delete all the children of this node.
nuclear@73:     */
nuclear@73:     void DeleteChildren();
nuclear@73: 
nuclear@73:     /**
nuclear@73:     	Delete a child of this node.
nuclear@73:     */
nuclear@73:     void DeleteChild( XMLNode* node );
nuclear@73: 
nuclear@73:     /**
nuclear@73:     	Make a copy of this node, but not its children.
nuclear@73:     	You may pass in a Document pointer that will be
nuclear@73:     	the owner of the new Node. If the 'document' is
nuclear@73:     	null, then the node returned will be allocated
nuclear@73:     	from the current Document. (this->GetDocument())
nuclear@73: 
nuclear@73:     	Note: if called on a XMLDocument, this will return null.
nuclear@73:     */
nuclear@73:     virtual XMLNode* ShallowClone( XMLDocument* document ) const = 0;
nuclear@73: 
nuclear@73:     /**
nuclear@73:     	Test if 2 nodes are the same, but don't test children.
nuclear@73:     	The 2 nodes do not need to be in the same Document.
nuclear@73: 
nuclear@73:     	Note: if called on a XMLDocument, this will return false.
nuclear@73:     */
nuclear@73:     virtual bool ShallowEqual( const XMLNode* compare ) const = 0;
nuclear@73: 
nuclear@73:     /** Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the
nuclear@73:     	XML tree will be conditionally visited and the host will be called back
nuclear@73:     	via the XMLVisitor interface.
nuclear@73: 
nuclear@73:     	This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse
nuclear@73:     	the XML for the callbacks, so the performance of TinyXML-2 is unchanged by using this
nuclear@73:     	interface versus any other.)
nuclear@73: 
nuclear@73:     	The interface has been based on ideas from:
nuclear@73: 
nuclear@73:     	- http://www.saxproject.org/
nuclear@73:     	- http://c2.com/cgi/wiki?HierarchicalVisitorPattern
nuclear@73: 
nuclear@73:     	Which are both good references for "visiting".
nuclear@73: 
nuclear@73:     	An example of using Accept():
nuclear@73:     	@verbatim
nuclear@73:     	XMLPrinter printer;
nuclear@73:     	tinyxmlDoc.Accept( &printer );
nuclear@73:     	const char* xmlcstr = printer.CStr();
nuclear@73:     	@endverbatim
nuclear@73:     */
nuclear@73:     virtual bool Accept( XMLVisitor* visitor ) const = 0;
nuclear@73: 
nuclear@73:     // internal
nuclear@73:     virtual char* ParseDeep( char*, StrPair* );
nuclear@73: 
nuclear@73: protected:
nuclear@73:     XMLNode( XMLDocument* );
nuclear@73:     virtual ~XMLNode();
nuclear@73:     XMLNode( const XMLNode& );	// not supported
nuclear@73:     XMLNode& operator=( const XMLNode& );	// not supported
nuclear@73: 
nuclear@73:     XMLDocument*	_document;
nuclear@73:     XMLNode*		_parent;
nuclear@73:     mutable StrPair	_value;
nuclear@73: 
nuclear@73:     XMLNode*		_firstChild;
nuclear@73:     XMLNode*		_lastChild;
nuclear@73: 
nuclear@73:     XMLNode*		_prev;
nuclear@73:     XMLNode*		_next;
nuclear@73: 
nuclear@73: private:
nuclear@73:     MemPool*		_memPool;
nuclear@73:     void Unlink( XMLNode* child );
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: /** XML text.
nuclear@73: 
nuclear@73: 	Note that a text node can have child element nodes, for example:
nuclear@73: 	@verbatim
nuclear@73: 	<root>This is <b>bold</b></root>
nuclear@73: 	@endverbatim
nuclear@73: 
nuclear@73: 	A text node can have 2 ways to output the next. "normal" output
nuclear@73: 	and CDATA. It will default to the mode it was parsed from the XML file and
nuclear@73: 	you generally want to leave it alone, but you can change the output mode with
nuclear@73: 	SetCData() and query it with CData().
nuclear@73: */
nuclear@73: class TINYXML2_LIB XMLText : public XMLNode
nuclear@73: {
nuclear@73:     friend class XMLBase;
nuclear@73:     friend class XMLDocument;
nuclear@73: public:
nuclear@73:     virtual bool Accept( XMLVisitor* visitor ) const;
nuclear@73: 
nuclear@73:     virtual XMLText* ToText()			{
nuclear@73:         return this;
nuclear@73:     }
nuclear@73:     virtual const XMLText* ToText() const	{
nuclear@73:         return this;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /// Declare whether this should be CDATA or standard text.
nuclear@73:     void SetCData( bool isCData )			{
nuclear@73:         _isCData = isCData;
nuclear@73:     }
nuclear@73:     /// Returns true if this is a CDATA text element.
nuclear@73:     bool CData() const						{
nuclear@73:         return _isCData;
nuclear@73:     }
nuclear@73: 
nuclear@73:     char* ParseDeep( char*, StrPair* endTag );
nuclear@73:     virtual XMLNode* ShallowClone( XMLDocument* document ) const;
nuclear@73:     virtual bool ShallowEqual( const XMLNode* compare ) const;
nuclear@73: 
nuclear@73: protected:
nuclear@73:     XMLText( XMLDocument* doc )	: XMLNode( doc ), _isCData( false )	{}
nuclear@73:     virtual ~XMLText()												{}
nuclear@73:     XMLText( const XMLText& );	// not supported
nuclear@73:     XMLText& operator=( const XMLText& );	// not supported
nuclear@73: 
nuclear@73: private:
nuclear@73:     bool _isCData;
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: /** An XML Comment. */
nuclear@73: class TINYXML2_LIB XMLComment : public XMLNode
nuclear@73: {
nuclear@73:     friend class XMLDocument;
nuclear@73: public:
nuclear@73:     virtual XMLComment*	ToComment()					{
nuclear@73:         return this;
nuclear@73:     }
nuclear@73:     virtual const XMLComment* ToComment() const		{
nuclear@73:         return this;
nuclear@73:     }
nuclear@73: 
nuclear@73:     virtual bool Accept( XMLVisitor* visitor ) const;
nuclear@73: 
nuclear@73:     char* ParseDeep( char*, StrPair* endTag );
nuclear@73:     virtual XMLNode* ShallowClone( XMLDocument* document ) const;
nuclear@73:     virtual bool ShallowEqual( const XMLNode* compare ) const;
nuclear@73: 
nuclear@73: protected:
nuclear@73:     XMLComment( XMLDocument* doc );
nuclear@73:     virtual ~XMLComment();
nuclear@73:     XMLComment( const XMLComment& );	// not supported
nuclear@73:     XMLComment& operator=( const XMLComment& );	// not supported
nuclear@73: 
nuclear@73: private:
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: /** In correct XML the declaration is the first entry in the file.
nuclear@73: 	@verbatim
nuclear@73: 		<?xml version="1.0" standalone="yes"?>
nuclear@73: 	@endverbatim
nuclear@73: 
nuclear@73: 	TinyXML-2 will happily read or write files without a declaration,
nuclear@73: 	however.
nuclear@73: 
nuclear@73: 	The text of the declaration isn't interpreted. It is parsed
nuclear@73: 	and written as a string.
nuclear@73: */
nuclear@73: class TINYXML2_LIB XMLDeclaration : public XMLNode
nuclear@73: {
nuclear@73:     friend class XMLDocument;
nuclear@73: public:
nuclear@73:     virtual XMLDeclaration*	ToDeclaration()					{
nuclear@73:         return this;
nuclear@73:     }
nuclear@73:     virtual const XMLDeclaration* ToDeclaration() const		{
nuclear@73:         return this;
nuclear@73:     }
nuclear@73: 
nuclear@73:     virtual bool Accept( XMLVisitor* visitor ) const;
nuclear@73: 
nuclear@73:     char* ParseDeep( char*, StrPair* endTag );
nuclear@73:     virtual XMLNode* ShallowClone( XMLDocument* document ) const;
nuclear@73:     virtual bool ShallowEqual( const XMLNode* compare ) const;
nuclear@73: 
nuclear@73: protected:
nuclear@73:     XMLDeclaration( XMLDocument* doc );
nuclear@73:     virtual ~XMLDeclaration();
nuclear@73:     XMLDeclaration( const XMLDeclaration& );	// not supported
nuclear@73:     XMLDeclaration& operator=( const XMLDeclaration& );	// not supported
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: /** Any tag that TinyXML-2 doesn't recognize is saved as an
nuclear@73: 	unknown. It is a tag of text, but should not be modified.
nuclear@73: 	It will be written back to the XML, unchanged, when the file
nuclear@73: 	is saved.
nuclear@73: 
nuclear@73: 	DTD tags get thrown into XMLUnknowns.
nuclear@73: */
nuclear@73: class TINYXML2_LIB XMLUnknown : public XMLNode
nuclear@73: {
nuclear@73:     friend class XMLDocument;
nuclear@73: public:
nuclear@73:     virtual XMLUnknown*	ToUnknown()					{
nuclear@73:         return this;
nuclear@73:     }
nuclear@73:     virtual const XMLUnknown* ToUnknown() const		{
nuclear@73:         return this;
nuclear@73:     }
nuclear@73: 
nuclear@73:     virtual bool Accept( XMLVisitor* visitor ) const;
nuclear@73: 
nuclear@73:     char* ParseDeep( char*, StrPair* endTag );
nuclear@73:     virtual XMLNode* ShallowClone( XMLDocument* document ) const;
nuclear@73:     virtual bool ShallowEqual( const XMLNode* compare ) const;
nuclear@73: 
nuclear@73: protected:
nuclear@73:     XMLUnknown( XMLDocument* doc );
nuclear@73:     virtual ~XMLUnknown();
nuclear@73:     XMLUnknown( const XMLUnknown& );	// not supported
nuclear@73:     XMLUnknown& operator=( const XMLUnknown& );	// not supported
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: enum XMLError {
nuclear@73:     XML_NO_ERROR = 0,
nuclear@73:     XML_SUCCESS = 0,
nuclear@73: 
nuclear@73:     XML_NO_ATTRIBUTE,
nuclear@73:     XML_WRONG_ATTRIBUTE_TYPE,
nuclear@73: 
nuclear@73:     XML_ERROR_FILE_NOT_FOUND,
nuclear@73:     XML_ERROR_FILE_COULD_NOT_BE_OPENED,
nuclear@73:     XML_ERROR_FILE_READ_ERROR,
nuclear@73:     XML_ERROR_ELEMENT_MISMATCH,
nuclear@73:     XML_ERROR_PARSING_ELEMENT,
nuclear@73:     XML_ERROR_PARSING_ATTRIBUTE,
nuclear@73:     XML_ERROR_IDENTIFYING_TAG,
nuclear@73:     XML_ERROR_PARSING_TEXT,
nuclear@73:     XML_ERROR_PARSING_CDATA,
nuclear@73:     XML_ERROR_PARSING_COMMENT,
nuclear@73:     XML_ERROR_PARSING_DECLARATION,
nuclear@73:     XML_ERROR_PARSING_UNKNOWN,
nuclear@73:     XML_ERROR_EMPTY_DOCUMENT,
nuclear@73:     XML_ERROR_MISMATCHED_ELEMENT,
nuclear@73:     XML_ERROR_PARSING,
nuclear@73: 
nuclear@73:     XML_CAN_NOT_CONVERT_TEXT,
nuclear@73:     XML_NO_TEXT_NODE
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: /** An attribute is a name-value pair. Elements have an arbitrary
nuclear@73: 	number of attributes, each with a unique name.
nuclear@73: 
nuclear@73: 	@note The attributes are not XMLNodes. You may only query the
nuclear@73: 	Next() attribute in a list.
nuclear@73: */
nuclear@73: class TINYXML2_LIB XMLAttribute
nuclear@73: {
nuclear@73:     friend class XMLElement;
nuclear@73: public:
nuclear@73:     /// The name of the attribute.
nuclear@73:     const char* Name() const {
nuclear@73:         return _name.GetStr();
nuclear@73:     }
nuclear@73:     /// The value of the attribute.
nuclear@73:     const char* Value() const {
nuclear@73:         return _value.GetStr();
nuclear@73:     }
nuclear@73:     /// The next attribute in the list.
nuclear@73:     const XMLAttribute* Next() const {
nuclear@73:         return _next;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /** IntValue interprets the attribute as an integer, and returns the value.
nuclear@73:         If the value isn't an integer, 0 will be returned. There is no error checking;
nuclear@73:     	use QueryIntValue() if you need error checking.
nuclear@73:     */
nuclear@73:     int		 IntValue() const				{
nuclear@73:         int i=0;
nuclear@73:         QueryIntValue( &i );
nuclear@73:         return i;
nuclear@73:     }
nuclear@73:     /// Query as an unsigned integer. See IntValue()
nuclear@73:     unsigned UnsignedValue() const			{
nuclear@73:         unsigned i=0;
nuclear@73:         QueryUnsignedValue( &i );
nuclear@73:         return i;
nuclear@73:     }
nuclear@73:     /// Query as a boolean. See IntValue()
nuclear@73:     bool	 BoolValue() const				{
nuclear@73:         bool b=false;
nuclear@73:         QueryBoolValue( &b );
nuclear@73:         return b;
nuclear@73:     }
nuclear@73:     /// Query as a double. See IntValue()
nuclear@73:     double 	 DoubleValue() const			{
nuclear@73:         double d=0;
nuclear@73:         QueryDoubleValue( &d );
nuclear@73:         return d;
nuclear@73:     }
nuclear@73:     /// Query as a float. See IntValue()
nuclear@73:     float	 FloatValue() const				{
nuclear@73:         float f=0;
nuclear@73:         QueryFloatValue( &f );
nuclear@73:         return f;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /** QueryIntValue interprets the attribute as an integer, and returns the value
nuclear@73:     	in the provided parameter. The function will return XML_NO_ERROR on success,
nuclear@73:     	and XML_WRONG_ATTRIBUTE_TYPE if the conversion is not successful.
nuclear@73:     */
nuclear@73:     XMLError QueryIntValue( int* value ) const;
nuclear@73:     /// See QueryIntValue
nuclear@73:     XMLError QueryUnsignedValue( unsigned int* value ) const;
nuclear@73:     /// See QueryIntValue
nuclear@73:     XMLError QueryBoolValue( bool* value ) const;
nuclear@73:     /// See QueryIntValue
nuclear@73:     XMLError QueryDoubleValue( double* value ) const;
nuclear@73:     /// See QueryIntValue
nuclear@73:     XMLError QueryFloatValue( float* value ) const;
nuclear@73: 
nuclear@73:     /// Set the attribute to a string value.
nuclear@73:     void SetAttribute( const char* value );
nuclear@73:     /// Set the attribute to value.
nuclear@73:     void SetAttribute( int value );
nuclear@73:     /// Set the attribute to value.
nuclear@73:     void SetAttribute( unsigned value );
nuclear@73:     /// Set the attribute to value.
nuclear@73:     void SetAttribute( bool value );
nuclear@73:     /// Set the attribute to value.
nuclear@73:     void SetAttribute( double value );
nuclear@73:     /// Set the attribute to value.
nuclear@73:     void SetAttribute( float value );
nuclear@73: 
nuclear@73: private:
nuclear@73:     enum { BUF_SIZE = 200 };
nuclear@73: 
nuclear@73:     XMLAttribute() : _next( 0 ), _memPool( 0 ) {}
nuclear@73:     virtual ~XMLAttribute()	{}
nuclear@73: 
nuclear@73:     XMLAttribute( const XMLAttribute& );	// not supported
nuclear@73:     void operator=( const XMLAttribute& );	// not supported
nuclear@73:     void SetName( const char* name );
nuclear@73: 
nuclear@73:     char* ParseDeep( char* p, bool processEntities );
nuclear@73: 
nuclear@73:     mutable StrPair _name;
nuclear@73:     mutable StrPair _value;
nuclear@73:     XMLAttribute*   _next;
nuclear@73:     MemPool*        _memPool;
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: /** The element is a container class. It has a value, the element name,
nuclear@73: 	and can contain other elements, text, comments, and unknowns.
nuclear@73: 	Elements also contain an arbitrary number of attributes.
nuclear@73: */
nuclear@73: class TINYXML2_LIB XMLElement : public XMLNode
nuclear@73: {
nuclear@73:     friend class XMLBase;
nuclear@73:     friend class XMLDocument;
nuclear@73: public:
nuclear@73:     /// Get the name of an element (which is the Value() of the node.)
nuclear@73:     const char* Name() const		{
nuclear@73:         return Value();
nuclear@73:     }
nuclear@73:     /// Set the name of the element.
nuclear@73:     void SetName( const char* str, bool staticMem=false )	{
nuclear@73:         SetValue( str, staticMem );
nuclear@73:     }
nuclear@73: 
nuclear@73:     virtual XMLElement* ToElement()				{
nuclear@73:         return this;
nuclear@73:     }
nuclear@73:     virtual const XMLElement* ToElement() const {
nuclear@73:         return this;
nuclear@73:     }
nuclear@73:     virtual bool Accept( XMLVisitor* visitor ) const;
nuclear@73: 
nuclear@73:     /** Given an attribute name, Attribute() returns the value
nuclear@73:     	for the attribute of that name, or null if none
nuclear@73:     	exists. For example:
nuclear@73: 
nuclear@73:     	@verbatim
nuclear@73:     	const char* value = ele->Attribute( "foo" );
nuclear@73:     	@endverbatim
nuclear@73: 
nuclear@73:     	The 'value' parameter is normally null. However, if specified,
nuclear@73:     	the attribute will only be returned if the 'name' and 'value'
nuclear@73:     	match. This allow you to write code:
nuclear@73: 
nuclear@73:     	@verbatim
nuclear@73:     	if ( ele->Attribute( "foo", "bar" ) ) callFooIsBar();
nuclear@73:     	@endverbatim
nuclear@73: 
nuclear@73:     	rather than:
nuclear@73:     	@verbatim
nuclear@73:     	if ( ele->Attribute( "foo" ) ) {
nuclear@73:     		if ( strcmp( ele->Attribute( "foo" ), "bar" ) == 0 ) callFooIsBar();
nuclear@73:     	}
nuclear@73:     	@endverbatim
nuclear@73:     */
nuclear@73:     const char* Attribute( const char* name, const char* value=0 ) const;
nuclear@73: 
nuclear@73:     /** Given an attribute name, IntAttribute() returns the value
nuclear@73:     	of the attribute interpreted as an integer. 0 will be
nuclear@73:     	returned if there is an error. For a method with error
nuclear@73:     	checking, see QueryIntAttribute()
nuclear@73:     */
nuclear@73:     int		 IntAttribute( const char* name ) const		{
nuclear@73:         int i=0;
nuclear@73:         QueryIntAttribute( name, &i );
nuclear@73:         return i;
nuclear@73:     }
nuclear@73:     /// See IntAttribute()
nuclear@73:     unsigned UnsignedAttribute( const char* name ) const {
nuclear@73:         unsigned i=0;
nuclear@73:         QueryUnsignedAttribute( name, &i );
nuclear@73:         return i;
nuclear@73:     }
nuclear@73:     /// See IntAttribute()
nuclear@73:     bool	 BoolAttribute( const char* name ) const	{
nuclear@73:         bool b=false;
nuclear@73:         QueryBoolAttribute( name, &b );
nuclear@73:         return b;
nuclear@73:     }
nuclear@73:     /// See IntAttribute()
nuclear@73:     double 	 DoubleAttribute( const char* name ) const	{
nuclear@73:         double d=0;
nuclear@73:         QueryDoubleAttribute( name, &d );
nuclear@73:         return d;
nuclear@73:     }
nuclear@73:     /// See IntAttribute()
nuclear@73:     float	 FloatAttribute( const char* name ) const	{
nuclear@73:         float f=0;
nuclear@73:         QueryFloatAttribute( name, &f );
nuclear@73:         return f;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /** Given an attribute name, QueryIntAttribute() returns
nuclear@73:     	XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion
nuclear@73:     	can't be performed, or XML_NO_ATTRIBUTE if the attribute
nuclear@73:     	doesn't exist. If successful, the result of the conversion
nuclear@73:     	will be written to 'value'. If not successful, nothing will
nuclear@73:     	be written to 'value'. This allows you to provide default
nuclear@73:     	value:
nuclear@73: 
nuclear@73:     	@verbatim
nuclear@73:     	int value = 10;
nuclear@73:     	QueryIntAttribute( "foo", &value );		// if "foo" isn't found, value will still be 10
nuclear@73:     	@endverbatim
nuclear@73:     */
nuclear@73:     XMLError QueryIntAttribute( const char* name, int* value ) const				{
nuclear@73:         const XMLAttribute* a = FindAttribute( name );
nuclear@73:         if ( !a ) {
nuclear@73:             return XML_NO_ATTRIBUTE;
nuclear@73:         }
nuclear@73:         return a->QueryIntValue( value );
nuclear@73:     }
nuclear@73:     /// See QueryIntAttribute()
nuclear@73:     XMLError QueryUnsignedAttribute( const char* name, unsigned int* value ) const	{
nuclear@73:         const XMLAttribute* a = FindAttribute( name );
nuclear@73:         if ( !a ) {
nuclear@73:             return XML_NO_ATTRIBUTE;
nuclear@73:         }
nuclear@73:         return a->QueryUnsignedValue( value );
nuclear@73:     }
nuclear@73:     /// See QueryIntAttribute()
nuclear@73:     XMLError QueryBoolAttribute( const char* name, bool* value ) const				{
nuclear@73:         const XMLAttribute* a = FindAttribute( name );
nuclear@73:         if ( !a ) {
nuclear@73:             return XML_NO_ATTRIBUTE;
nuclear@73:         }
nuclear@73:         return a->QueryBoolValue( value );
nuclear@73:     }
nuclear@73:     /// See QueryIntAttribute()
nuclear@73:     XMLError QueryDoubleAttribute( const char* name, double* value ) const			{
nuclear@73:         const XMLAttribute* a = FindAttribute( name );
nuclear@73:         if ( !a ) {
nuclear@73:             return XML_NO_ATTRIBUTE;
nuclear@73:         }
nuclear@73:         return a->QueryDoubleValue( value );
nuclear@73:     }
nuclear@73:     /// See QueryIntAttribute()
nuclear@73:     XMLError QueryFloatAttribute( const char* name, float* value ) const			{
nuclear@73:         const XMLAttribute* a = FindAttribute( name );
nuclear@73:         if ( !a ) {
nuclear@73:             return XML_NO_ATTRIBUTE;
nuclear@73:         }
nuclear@73:         return a->QueryFloatValue( value );
nuclear@73:     }
nuclear@73: 
nuclear@73: 	
nuclear@73:     /** Given an attribute name, QueryAttribute() returns
nuclear@73:     	XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion
nuclear@73:     	can't be performed, or XML_NO_ATTRIBUTE if the attribute
nuclear@73:     	doesn't exist. It is overloaded for the primitive types,
nuclear@73: 		and is a generally more convenient replacement of
nuclear@73: 		QueryIntAttribute() and related functions.
nuclear@73: 		
nuclear@73: 		If successful, the result of the conversion
nuclear@73:     	will be written to 'value'. If not successful, nothing will
nuclear@73:     	be written to 'value'. This allows you to provide default
nuclear@73:     	value:
nuclear@73: 
nuclear@73:     	@verbatim
nuclear@73:     	int value = 10;
nuclear@73:     	QueryAttribute( "foo", &value );		// if "foo" isn't found, value will still be 10
nuclear@73:     	@endverbatim
nuclear@73:     */
nuclear@73: 	int QueryAttribute( const char* name, int* value ) const {
nuclear@73: 		return QueryIntAttribute( name, value );
nuclear@73: 	}
nuclear@73: 
nuclear@73: 	int QueryAttribute( const char* name, unsigned int* value ) const {
nuclear@73: 		return QueryUnsignedAttribute( name, value );
nuclear@73: 	}
nuclear@73: 
nuclear@73: 	int QueryAttribute( const char* name, bool* value ) const {
nuclear@73: 		return QueryBoolAttribute( name, value );
nuclear@73: 	}
nuclear@73: 
nuclear@73: 	int QueryAttribute( const char* name, double* value ) const {
nuclear@73: 		return QueryDoubleAttribute( name, value );
nuclear@73: 	}
nuclear@73: 
nuclear@73: 	int QueryAttribute( const char* name, float* value ) const {
nuclear@73: 		return QueryFloatAttribute( name, value );
nuclear@73: 	}
nuclear@73: 
nuclear@73: 	/// Sets the named attribute to value.
nuclear@73:     void SetAttribute( const char* name, const char* value )	{
nuclear@73:         XMLAttribute* a = FindOrCreateAttribute( name );
nuclear@73:         a->SetAttribute( value );
nuclear@73:     }
nuclear@73:     /// Sets the named attribute to value.
nuclear@73:     void SetAttribute( const char* name, int value )			{
nuclear@73:         XMLAttribute* a = FindOrCreateAttribute( name );
nuclear@73:         a->SetAttribute( value );
nuclear@73:     }
nuclear@73:     /// Sets the named attribute to value.
nuclear@73:     void SetAttribute( const char* name, unsigned value )		{
nuclear@73:         XMLAttribute* a = FindOrCreateAttribute( name );
nuclear@73:         a->SetAttribute( value );
nuclear@73:     }
nuclear@73:     /// Sets the named attribute to value.
nuclear@73:     void SetAttribute( const char* name, bool value )			{
nuclear@73:         XMLAttribute* a = FindOrCreateAttribute( name );
nuclear@73:         a->SetAttribute( value );
nuclear@73:     }
nuclear@73:     /// Sets the named attribute to value.
nuclear@73:     void SetAttribute( const char* name, double value )		{
nuclear@73:         XMLAttribute* a = FindOrCreateAttribute( name );
nuclear@73:         a->SetAttribute( value );
nuclear@73:     }
nuclear@73: 
nuclear@73:     /**
nuclear@73:     	Delete an attribute.
nuclear@73:     */
nuclear@73:     void DeleteAttribute( const char* name );
nuclear@73: 
nuclear@73:     /// Return the first attribute in the list.
nuclear@73:     const XMLAttribute* FirstAttribute() const {
nuclear@73:         return _rootAttribute;
nuclear@73:     }
nuclear@73:     /// Query a specific attribute in the list.
nuclear@73:     const XMLAttribute* FindAttribute( const char* name ) const;
nuclear@73: 
nuclear@73:     /** Convenience function for easy access to the text inside an element. Although easy
nuclear@73:     	and concise, GetText() is limited compared to getting the XMLText child
nuclear@73:     	and accessing it directly.
nuclear@73: 
nuclear@73:     	If the first child of 'this' is a XMLText, the GetText()
nuclear@73:     	returns the character string of the Text node, else null is returned.
nuclear@73: 
nuclear@73:     	This is a convenient method for getting the text of simple contained text:
nuclear@73:     	@verbatim
nuclear@73:     	<foo>This is text</foo>
nuclear@73:     		const char* str = fooElement->GetText();
nuclear@73:     	@endverbatim
nuclear@73: 
nuclear@73:     	'str' will be a pointer to "This is text".
nuclear@73: 
nuclear@73:     	Note that this function can be misleading. If the element foo was created from
nuclear@73:     	this XML:
nuclear@73:     	@verbatim
nuclear@73:     		<foo><b>This is text</b></foo>
nuclear@73:     	@endverbatim
nuclear@73: 
nuclear@73:     	then the value of str would be null. The first child node isn't a text node, it is
nuclear@73:     	another element. From this XML:
nuclear@73:     	@verbatim
nuclear@73:     		<foo>This is <b>text</b></foo>
nuclear@73:     	@endverbatim
nuclear@73:     	GetText() will return "This is ".
nuclear@73:     */
nuclear@73:     const char* GetText() const;
nuclear@73: 
nuclear@73:     /**
nuclear@73:     	Convenience method to query the value of a child text node. This is probably best
nuclear@73:     	shown by example. Given you have a document is this form:
nuclear@73:     	@verbatim
nuclear@73:     		<point>
nuclear@73:     			<x>1</x>
nuclear@73:     			<y>1.4</y>
nuclear@73:     		</point>
nuclear@73:     	@endverbatim
nuclear@73: 
nuclear@73:     	The QueryIntText() and similar functions provide a safe and easier way to get to the
nuclear@73:     	"value" of x and y.
nuclear@73: 
nuclear@73:     	@verbatim
nuclear@73:     		int x = 0;
nuclear@73:     		float y = 0;	// types of x and y are contrived for example
nuclear@73:     		const XMLElement* xElement = pointElement->FirstChildElement( "x" );
nuclear@73:     		const XMLElement* yElement = pointElement->FirstChildElement( "y" );
nuclear@73:     		xElement->QueryIntText( &x );
nuclear@73:     		yElement->QueryFloatText( &y );
nuclear@73:     	@endverbatim
nuclear@73: 
nuclear@73:     	@returns XML_SUCCESS (0) on success, XML_CAN_NOT_CONVERT_TEXT if the text cannot be converted
nuclear@73:     			 to the requested type, and XML_NO_TEXT_NODE if there is no child text to query.
nuclear@73: 
nuclear@73:     */
nuclear@73:     XMLError QueryIntText( int* ival ) const;
nuclear@73:     /// See QueryIntText()
nuclear@73:     XMLError QueryUnsignedText( unsigned* uval ) const;
nuclear@73:     /// See QueryIntText()
nuclear@73:     XMLError QueryBoolText( bool* bval ) const;
nuclear@73:     /// See QueryIntText()
nuclear@73:     XMLError QueryDoubleText( double* dval ) const;
nuclear@73:     /// See QueryIntText()
nuclear@73:     XMLError QueryFloatText( float* fval ) const;
nuclear@73: 
nuclear@73:     // internal:
nuclear@73:     enum {
nuclear@73:         OPEN,		// <foo>
nuclear@73:         CLOSED,		// <foo/>
nuclear@73:         CLOSING		// </foo>
nuclear@73:     };
nuclear@73:     int ClosingType() const {
nuclear@73:         return _closingType;
nuclear@73:     }
nuclear@73:     char* ParseDeep( char* p, StrPair* endTag );
nuclear@73:     virtual XMLNode* ShallowClone( XMLDocument* document ) const;
nuclear@73:     virtual bool ShallowEqual( const XMLNode* compare ) const;
nuclear@73: 
nuclear@73: private:
nuclear@73:     XMLElement( XMLDocument* doc );
nuclear@73:     virtual ~XMLElement();
nuclear@73:     XMLElement( const XMLElement& );	// not supported
nuclear@73:     void operator=( const XMLElement& );	// not supported
nuclear@73: 
nuclear@73:     XMLAttribute* FindAttribute( const char* name );
nuclear@73:     XMLAttribute* FindOrCreateAttribute( const char* name );
nuclear@73:     //void LinkAttribute( XMLAttribute* attrib );
nuclear@73:     char* ParseAttributes( char* p );
nuclear@73: 
nuclear@73:     int _closingType;
nuclear@73:     // The attribute list is ordered; there is no 'lastAttribute'
nuclear@73:     // because the list needs to be scanned for dupes before adding
nuclear@73:     // a new attribute.
nuclear@73:     XMLAttribute* _rootAttribute;
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: enum Whitespace {
nuclear@73:     PRESERVE_WHITESPACE,
nuclear@73:     COLLAPSE_WHITESPACE
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: /** A Document binds together all the functionality.
nuclear@73: 	It can be saved, loaded, and printed to the screen.
nuclear@73: 	All Nodes are connected and allocated to a Document.
nuclear@73: 	If the Document is deleted, all its Nodes are also deleted.
nuclear@73: */
nuclear@73: class TINYXML2_LIB XMLDocument : public XMLNode
nuclear@73: {
nuclear@73:     friend class XMLElement;
nuclear@73: public:
nuclear@73:     /// constructor
nuclear@73:     XMLDocument( bool processEntities = true, Whitespace = PRESERVE_WHITESPACE );
nuclear@73:     ~XMLDocument();
nuclear@73: 
nuclear@73:     virtual XMLDocument* ToDocument()				{
nuclear@73:         return this;
nuclear@73:     }
nuclear@73:     virtual const XMLDocument* ToDocument() const	{
nuclear@73:         return this;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /**
nuclear@73:     	Parse an XML file from a character string.
nuclear@73:     	Returns XML_NO_ERROR (0) on success, or
nuclear@73:     	an errorID.
nuclear@73: 
nuclear@73:     	You may optionally pass in the 'nBytes', which is
nuclear@73:     	the number of bytes which will be parsed. If not
nuclear@73:     	specified, TinyXML-2 will assume 'xml' points to a
nuclear@73:     	null terminated string.
nuclear@73:     */
nuclear@73:     XMLError Parse( const char* xml, size_t nBytes=(size_t)(-1) );
nuclear@73: 
nuclear@73:     /**
nuclear@73:     	Load an XML file from disk.
nuclear@73:     	Returns XML_NO_ERROR (0) on success, or
nuclear@73:     	an errorID.
nuclear@73:     */
nuclear@73:     XMLError LoadFile( const char* filename );
nuclear@73: 
nuclear@73:     /**
nuclear@73:     	Load an XML file from disk. You are responsible
nuclear@73:     	for providing and closing the FILE*.
nuclear@73: 
nuclear@73:     	Returns XML_NO_ERROR (0) on success, or
nuclear@73:     	an errorID.
nuclear@73:     */
nuclear@73:     XMLError LoadFile( FILE* );
nuclear@73: 
nuclear@73:     /**
nuclear@73:     	Save the XML file to disk.
nuclear@73:     	Returns XML_NO_ERROR (0) on success, or
nuclear@73:     	an errorID.
nuclear@73:     */
nuclear@73:     XMLError SaveFile( const char* filename, bool compact = false );
nuclear@73: 
nuclear@73:     /**
nuclear@73:     	Save the XML file to disk. You are responsible
nuclear@73:     	for providing and closing the FILE*.
nuclear@73: 
nuclear@73:     	Returns XML_NO_ERROR (0) on success, or
nuclear@73:     	an errorID.
nuclear@73:     */
nuclear@73:     XMLError SaveFile( FILE* fp, bool compact = false );
nuclear@73: 
nuclear@73:     bool ProcessEntities() const		{
nuclear@73:         return _processEntities;
nuclear@73:     }
nuclear@73:     Whitespace WhitespaceMode() const	{
nuclear@73:         return _whitespace;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /**
nuclear@73:     	Returns true if this document has a leading Byte Order Mark of UTF8.
nuclear@73:     */
nuclear@73:     bool HasBOM() const {
nuclear@73:         return _writeBOM;
nuclear@73:     }
nuclear@73:     /** Sets whether to write the BOM when writing the file.
nuclear@73:     */
nuclear@73:     void SetBOM( bool useBOM ) {
nuclear@73:         _writeBOM = useBOM;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /** Return the root element of DOM. Equivalent to FirstChildElement().
nuclear@73:         To get the first node, use FirstChild().
nuclear@73:     */
nuclear@73:     XMLElement* RootElement()				{
nuclear@73:         return FirstChildElement();
nuclear@73:     }
nuclear@73:     const XMLElement* RootElement() const	{
nuclear@73:         return FirstChildElement();
nuclear@73:     }
nuclear@73: 
nuclear@73:     /** Print the Document. If the Printer is not provided, it will
nuclear@73:         print to stdout. If you provide Printer, this can print to a file:
nuclear@73:     	@verbatim
nuclear@73:     	XMLPrinter printer( fp );
nuclear@73:     	doc.Print( &printer );
nuclear@73:     	@endverbatim
nuclear@73: 
nuclear@73:     	Or you can use a printer to print to memory:
nuclear@73:     	@verbatim
nuclear@73:     	XMLPrinter printer;
nuclear@73:     	doc.Print( &printer );
nuclear@73:     	// printer.CStr() has a const char* to the XML
nuclear@73:     	@endverbatim
nuclear@73:     */
nuclear@73:     void Print( XMLPrinter* streamer=0 ) const;
nuclear@73:     virtual bool Accept( XMLVisitor* visitor ) const;
nuclear@73: 
nuclear@73:     /**
nuclear@73:     	Create a new Element associated with
nuclear@73:     	this Document. The memory for the Element
nuclear@73:     	is managed by the Document.
nuclear@73:     */
nuclear@73:     XMLElement* NewElement( const char* name );
nuclear@73:     /**
nuclear@73:     	Create a new Comment associated with
nuclear@73:     	this Document. The memory for the Comment
nuclear@73:     	is managed by the Document.
nuclear@73:     */
nuclear@73:     XMLComment* NewComment( const char* comment );
nuclear@73:     /**
nuclear@73:     	Create a new Text associated with
nuclear@73:     	this Document. The memory for the Text
nuclear@73:     	is managed by the Document.
nuclear@73:     */
nuclear@73:     XMLText* NewText( const char* text );
nuclear@73:     /**
nuclear@73:     	Create a new Declaration associated with
nuclear@73:     	this Document. The memory for the object
nuclear@73:     	is managed by the Document.
nuclear@73: 
nuclear@73:     	If the 'text' param is null, the standard
nuclear@73:     	declaration is used.:
nuclear@73:     	@verbatim
nuclear@73:     		<?xml version="1.0" encoding="UTF-8"?>
nuclear@73:     	@endverbatim
nuclear@73:     */
nuclear@73:     XMLDeclaration* NewDeclaration( const char* text=0 );
nuclear@73:     /**
nuclear@73:     	Create a new Unknown associated with
nuclear@73:     	this Document. The memory for the object
nuclear@73:     	is managed by the Document.
nuclear@73:     */
nuclear@73:     XMLUnknown* NewUnknown( const char* text );
nuclear@73: 
nuclear@73:     /**
nuclear@73:     	Delete a node associated with this document.
nuclear@73:     	It will be unlinked from the DOM.
nuclear@73:     */
nuclear@73:     void DeleteNode( XMLNode* node )	{
nuclear@73:         node->_parent->DeleteChild( node );
nuclear@73:     }
nuclear@73: 
nuclear@73:     void SetError( XMLError error, const char* str1, const char* str2 );
nuclear@73: 
nuclear@73:     /// Return true if there was an error parsing the document.
nuclear@73:     bool Error() const {
nuclear@73:         return _errorID != XML_NO_ERROR;
nuclear@73:     }
nuclear@73:     /// Return the errorID.
nuclear@73:     XMLError  ErrorID() const {
nuclear@73:         return _errorID;
nuclear@73:     }
nuclear@73:     /// Return a possibly helpful diagnostic location or string.
nuclear@73:     const char* GetErrorStr1() const {
nuclear@73:         return _errorStr1;
nuclear@73:     }
nuclear@73:     /// Return a possibly helpful secondary diagnostic location or string.
nuclear@73:     const char* GetErrorStr2() const {
nuclear@73:         return _errorStr2;
nuclear@73:     }
nuclear@73:     /// If there is an error, print it to stdout.
nuclear@73:     void PrintError() const;
nuclear@73:     
nuclear@73:     /// Clear the document, resetting it to the initial state.
nuclear@73:     void Clear();
nuclear@73: 
nuclear@73:     // internal
nuclear@73:     char* Identify( char* p, XMLNode** node );
nuclear@73: 
nuclear@73:     virtual XMLNode* ShallowClone( XMLDocument* /*document*/ ) const	{
nuclear@73:         return 0;
nuclear@73:     }
nuclear@73:     virtual bool ShallowEqual( const XMLNode* /*compare*/ ) const	{
nuclear@73:         return false;
nuclear@73:     }
nuclear@73: 
nuclear@73: private:
nuclear@73:     XMLDocument( const XMLDocument& );	// not supported
nuclear@73:     void operator=( const XMLDocument& );	// not supported
nuclear@73: 
nuclear@73:     bool        _writeBOM;
nuclear@73:     bool        _processEntities;
nuclear@73:     XMLError    _errorID;
nuclear@73:     Whitespace  _whitespace;
nuclear@73:     const char* _errorStr1;
nuclear@73:     const char* _errorStr2;
nuclear@73:     char*       _charBuffer;
nuclear@73: 
nuclear@73:     MemPoolT< sizeof(XMLElement) >	 _elementPool;
nuclear@73:     MemPoolT< sizeof(XMLAttribute) > _attributePool;
nuclear@73:     MemPoolT< sizeof(XMLText) >		 _textPool;
nuclear@73:     MemPoolT< sizeof(XMLComment) >	 _commentPool;
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: /**
nuclear@73: 	A XMLHandle is a class that wraps a node pointer with null checks; this is
nuclear@73: 	an incredibly useful thing. Note that XMLHandle is not part of the TinyXML-2
nuclear@73: 	DOM structure. It is a separate utility class.
nuclear@73: 
nuclear@73: 	Take an example:
nuclear@73: 	@verbatim
nuclear@73: 	<Document>
nuclear@73: 		<Element attributeA = "valueA">
nuclear@73: 			<Child attributeB = "value1" />
nuclear@73: 			<Child attributeB = "value2" />
nuclear@73: 		</Element>
nuclear@73: 	</Document>
nuclear@73: 	@endverbatim
nuclear@73: 
nuclear@73: 	Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very
nuclear@73: 	easy to write a *lot* of code that looks like:
nuclear@73: 
nuclear@73: 	@verbatim
nuclear@73: 	XMLElement* root = document.FirstChildElement( "Document" );
nuclear@73: 	if ( root )
nuclear@73: 	{
nuclear@73: 		XMLElement* element = root->FirstChildElement( "Element" );
nuclear@73: 		if ( element )
nuclear@73: 		{
nuclear@73: 			XMLElement* child = element->FirstChildElement( "Child" );
nuclear@73: 			if ( child )
nuclear@73: 			{
nuclear@73: 				XMLElement* child2 = child->NextSiblingElement( "Child" );
nuclear@73: 				if ( child2 )
nuclear@73: 				{
nuclear@73: 					// Finally do something useful.
nuclear@73: 	@endverbatim
nuclear@73: 
nuclear@73: 	And that doesn't even cover "else" cases. XMLHandle addresses the verbosity
nuclear@73: 	of such code. A XMLHandle checks for null pointers so it is perfectly safe
nuclear@73: 	and correct to use:
nuclear@73: 
nuclear@73: 	@verbatim
nuclear@73: 	XMLHandle docHandle( &document );
nuclear@73: 	XMLElement* child2 = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).FirstChild().NextSibling().ToElement();
nuclear@73: 	if ( child2 )
nuclear@73: 	{
nuclear@73: 		// do something useful
nuclear@73: 	@endverbatim
nuclear@73: 
nuclear@73: 	Which is MUCH more concise and useful.
nuclear@73: 
nuclear@73: 	It is also safe to copy handles - internally they are nothing more than node pointers.
nuclear@73: 	@verbatim
nuclear@73: 	XMLHandle handleCopy = handle;
nuclear@73: 	@endverbatim
nuclear@73: 
nuclear@73: 	See also XMLConstHandle, which is the same as XMLHandle, but operates on const objects.
nuclear@73: */
nuclear@73: class TINYXML2_LIB XMLHandle
nuclear@73: {
nuclear@73: public:
nuclear@73:     /// Create a handle from any node (at any depth of the tree.) This can be a null pointer.
nuclear@73:     XMLHandle( XMLNode* node )												{
nuclear@73:         _node = node;
nuclear@73:     }
nuclear@73:     /// Create a handle from a node.
nuclear@73:     XMLHandle( XMLNode& node )												{
nuclear@73:         _node = &node;
nuclear@73:     }
nuclear@73:     /// Copy constructor
nuclear@73:     XMLHandle( const XMLHandle& ref )										{
nuclear@73:         _node = ref._node;
nuclear@73:     }
nuclear@73:     /// Assignment
nuclear@73:     XMLHandle& operator=( const XMLHandle& ref )							{
nuclear@73:         _node = ref._node;
nuclear@73:         return *this;
nuclear@73:     }
nuclear@73: 
nuclear@73:     /// Get the first child of this handle.
nuclear@73:     XMLHandle FirstChild() 													{
nuclear@73:         return XMLHandle( _node ? _node->FirstChild() : 0 );
nuclear@73:     }
nuclear@73:     /// Get the first child element of this handle.
nuclear@73:     XMLHandle FirstChildElement( const char* value=0 )						{
nuclear@73:         return XMLHandle( _node ? _node->FirstChildElement( value ) : 0 );
nuclear@73:     }
nuclear@73:     /// Get the last child of this handle.
nuclear@73:     XMLHandle LastChild()													{
nuclear@73:         return XMLHandle( _node ? _node->LastChild() : 0 );
nuclear@73:     }
nuclear@73:     /// Get the last child element of this handle.
nuclear@73:     XMLHandle LastChildElement( const char* _value=0 )						{
nuclear@73:         return XMLHandle( _node ? _node->LastChildElement( _value ) : 0 );
nuclear@73:     }
nuclear@73:     /// Get the previous sibling of this handle.
nuclear@73:     XMLHandle PreviousSibling()												{
nuclear@73:         return XMLHandle( _node ? _node->PreviousSibling() : 0 );
nuclear@73:     }
nuclear@73:     /// Get the previous sibling element of this handle.
nuclear@73:     XMLHandle PreviousSiblingElement( const char* _value=0 )				{
nuclear@73:         return XMLHandle( _node ? _node->PreviousSiblingElement( _value ) : 0 );
nuclear@73:     }
nuclear@73:     /// Get the next sibling of this handle.
nuclear@73:     XMLHandle NextSibling()													{
nuclear@73:         return XMLHandle( _node ? _node->NextSibling() : 0 );
nuclear@73:     }
nuclear@73:     /// Get the next sibling element of this handle.
nuclear@73:     XMLHandle NextSiblingElement( const char* _value=0 )					{
nuclear@73:         return XMLHandle( _node ? _node->NextSiblingElement( _value ) : 0 );
nuclear@73:     }
nuclear@73: 
nuclear@73:     /// Safe cast to XMLNode. This can return null.
nuclear@73:     XMLNode* ToNode()							{
nuclear@73:         return _node;
nuclear@73:     }
nuclear@73:     /// Safe cast to XMLElement. This can return null.
nuclear@73:     XMLElement* ToElement() 					{
nuclear@73:         return ( ( _node && _node->ToElement() ) ? _node->ToElement() : 0 );
nuclear@73:     }
nuclear@73:     /// Safe cast to XMLText. This can return null.
nuclear@73:     XMLText* ToText() 							{
nuclear@73:         return ( ( _node && _node->ToText() ) ? _node->ToText() : 0 );
nuclear@73:     }
nuclear@73:     /// Safe cast to XMLUnknown. This can return null.
nuclear@73:     XMLUnknown* ToUnknown() 					{
nuclear@73:         return ( ( _node && _node->ToUnknown() ) ? _node->ToUnknown() : 0 );
nuclear@73:     }
nuclear@73:     /// Safe cast to XMLDeclaration. This can return null.
nuclear@73:     XMLDeclaration* ToDeclaration() 			{
nuclear@73:         return ( ( _node && _node->ToDeclaration() ) ? _node->ToDeclaration() : 0 );
nuclear@73:     }
nuclear@73: 
nuclear@73: private:
nuclear@73:     XMLNode* _node;
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: /**
nuclear@73: 	A variant of the XMLHandle class for working with const XMLNodes and Documents. It is the
nuclear@73: 	same in all regards, except for the 'const' qualifiers. See XMLHandle for API.
nuclear@73: */
nuclear@73: class TINYXML2_LIB XMLConstHandle
nuclear@73: {
nuclear@73: public:
nuclear@73:     XMLConstHandle( const XMLNode* node )											{
nuclear@73:         _node = node;
nuclear@73:     }
nuclear@73:     XMLConstHandle( const XMLNode& node )											{
nuclear@73:         _node = &node;
nuclear@73:     }
nuclear@73:     XMLConstHandle( const XMLConstHandle& ref )										{
nuclear@73:         _node = ref._node;
nuclear@73:     }
nuclear@73: 
nuclear@73:     XMLConstHandle& operator=( const XMLConstHandle& ref )							{
nuclear@73:         _node = ref._node;
nuclear@73:         return *this;
nuclear@73:     }
nuclear@73: 
nuclear@73:     const XMLConstHandle FirstChild() const											{
nuclear@73:         return XMLConstHandle( _node ? _node->FirstChild() : 0 );
nuclear@73:     }
nuclear@73:     const XMLConstHandle FirstChildElement( const char* value=0 ) const				{
nuclear@73:         return XMLConstHandle( _node ? _node->FirstChildElement( value ) : 0 );
nuclear@73:     }
nuclear@73:     const XMLConstHandle LastChild()	const										{
nuclear@73:         return XMLConstHandle( _node ? _node->LastChild() : 0 );
nuclear@73:     }
nuclear@73:     const XMLConstHandle LastChildElement( const char* _value=0 ) const				{
nuclear@73:         return XMLConstHandle( _node ? _node->LastChildElement( _value ) : 0 );
nuclear@73:     }
nuclear@73:     const XMLConstHandle PreviousSibling() const									{
nuclear@73:         return XMLConstHandle( _node ? _node->PreviousSibling() : 0 );
nuclear@73:     }
nuclear@73:     const XMLConstHandle PreviousSiblingElement( const char* _value=0 ) const		{
nuclear@73:         return XMLConstHandle( _node ? _node->PreviousSiblingElement( _value ) : 0 );
nuclear@73:     }
nuclear@73:     const XMLConstHandle NextSibling() const										{
nuclear@73:         return XMLConstHandle( _node ? _node->NextSibling() : 0 );
nuclear@73:     }
nuclear@73:     const XMLConstHandle NextSiblingElement( const char* _value=0 ) const			{
nuclear@73:         return XMLConstHandle( _node ? _node->NextSiblingElement( _value ) : 0 );
nuclear@73:     }
nuclear@73: 
nuclear@73: 
nuclear@73:     const XMLNode* ToNode() const				{
nuclear@73:         return _node;
nuclear@73:     }
nuclear@73:     const XMLElement* ToElement() const			{
nuclear@73:         return ( ( _node && _node->ToElement() ) ? _node->ToElement() : 0 );
nuclear@73:     }
nuclear@73:     const XMLText* ToText() const				{
nuclear@73:         return ( ( _node && _node->ToText() ) ? _node->ToText() : 0 );
nuclear@73:     }
nuclear@73:     const XMLUnknown* ToUnknown() const			{
nuclear@73:         return ( ( _node && _node->ToUnknown() ) ? _node->ToUnknown() : 0 );
nuclear@73:     }
nuclear@73:     const XMLDeclaration* ToDeclaration() const	{
nuclear@73:         return ( ( _node && _node->ToDeclaration() ) ? _node->ToDeclaration() : 0 );
nuclear@73:     }
nuclear@73: 
nuclear@73: private:
nuclear@73:     const XMLNode* _node;
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: /**
nuclear@73: 	Printing functionality. The XMLPrinter gives you more
nuclear@73: 	options than the XMLDocument::Print() method.
nuclear@73: 
nuclear@73: 	It can:
nuclear@73: 	-# Print to memory.
nuclear@73: 	-# Print to a file you provide.
nuclear@73: 	-# Print XML without a XMLDocument.
nuclear@73: 
nuclear@73: 	Print to Memory
nuclear@73: 
nuclear@73: 	@verbatim
nuclear@73: 	XMLPrinter printer;
nuclear@73: 	doc.Print( &printer );
nuclear@73: 	SomeFunction( printer.CStr() );
nuclear@73: 	@endverbatim
nuclear@73: 
nuclear@73: 	Print to a File
nuclear@73: 
nuclear@73: 	You provide the file pointer.
nuclear@73: 	@verbatim
nuclear@73: 	XMLPrinter printer( fp );
nuclear@73: 	doc.Print( &printer );
nuclear@73: 	@endverbatim
nuclear@73: 
nuclear@73: 	Print without a XMLDocument
nuclear@73: 
nuclear@73: 	When loading, an XML parser is very useful. However, sometimes
nuclear@73: 	when saving, it just gets in the way. The code is often set up
nuclear@73: 	for streaming, and constructing the DOM is just overhead.
nuclear@73: 
nuclear@73: 	The Printer supports the streaming case. The following code
nuclear@73: 	prints out a trivially simple XML file without ever creating
nuclear@73: 	an XML document.
nuclear@73: 
nuclear@73: 	@verbatim
nuclear@73: 	XMLPrinter printer( fp );
nuclear@73: 	printer.OpenElement( "foo" );
nuclear@73: 	printer.PushAttribute( "foo", "bar" );
nuclear@73: 	printer.CloseElement();
nuclear@73: 	@endverbatim
nuclear@73: */
nuclear@73: class TINYXML2_LIB XMLPrinter : public XMLVisitor
nuclear@73: {
nuclear@73: public:
nuclear@73:     /** Construct the printer. If the FILE* is specified,
nuclear@73:     	this will print to the FILE. Else it will print
nuclear@73:     	to memory, and the result is available in CStr().
nuclear@73:     	If 'compact' is set to true, then output is created
nuclear@73:     	with only required whitespace and newlines.
nuclear@73:     */
nuclear@73:     XMLPrinter( FILE* file=0, bool compact = false, int depth = 0 );
nuclear@73:     ~XMLPrinter()	{}
nuclear@73: 
nuclear@73:     /** If streaming, write the BOM and declaration. */
nuclear@73:     void PushHeader( bool writeBOM, bool writeDeclaration );
nuclear@73:     /** If streaming, start writing an element.
nuclear@73:         The element must be closed with CloseElement()
nuclear@73:     */
nuclear@73:     void OpenElement( const char* name );
nuclear@73:     /// If streaming, add an attribute to an open element.
nuclear@73:     void PushAttribute( const char* name, const char* value );
nuclear@73:     void PushAttribute( const char* name, int value );
nuclear@73:     void PushAttribute( const char* name, unsigned value );
nuclear@73:     void PushAttribute( const char* name, bool value );
nuclear@73:     void PushAttribute( const char* name, double value );
nuclear@73:     /// If streaming, close the Element.
nuclear@73:     void CloseElement();
nuclear@73: 
nuclear@73:     /// Add a text node.
nuclear@73:     void PushText( const char* text, bool cdata=false );
nuclear@73:     /// Add a text node from an integer.
nuclear@73:     void PushText( int value );
nuclear@73:     /// Add a text node from an unsigned.
nuclear@73:     void PushText( unsigned value );
nuclear@73:     /// Add a text node from a bool.
nuclear@73:     void PushText( bool value );
nuclear@73:     /// Add a text node from a float.
nuclear@73:     void PushText( float value );
nuclear@73:     /// Add a text node from a double.
nuclear@73:     void PushText( double value );
nuclear@73: 
nuclear@73:     /// Add a comment
nuclear@73:     void PushComment( const char* comment );
nuclear@73: 
nuclear@73:     void PushDeclaration( const char* value );
nuclear@73:     void PushUnknown( const char* value );
nuclear@73: 
nuclear@73:     virtual bool VisitEnter( const XMLDocument& /*doc*/ );
nuclear@73:     virtual bool VisitExit( const XMLDocument& /*doc*/ )			{
nuclear@73:         return true;
nuclear@73:     }
nuclear@73: 
nuclear@73:     virtual bool VisitEnter( const XMLElement& element, const XMLAttribute* attribute );
nuclear@73:     virtual bool VisitExit( const XMLElement& element );
nuclear@73: 
nuclear@73:     virtual bool Visit( const XMLText& text );
nuclear@73:     virtual bool Visit( const XMLComment& comment );
nuclear@73:     virtual bool Visit( const XMLDeclaration& declaration );
nuclear@73:     virtual bool Visit( const XMLUnknown& unknown );
nuclear@73: 
nuclear@73:     /**
nuclear@73:     	If in print to memory mode, return a pointer to
nuclear@73:     	the XML file in memory.
nuclear@73:     */
nuclear@73:     const char* CStr() const {
nuclear@73:         return _buffer.Mem();
nuclear@73:     }
nuclear@73:     /**
nuclear@73:     	If in print to memory mode, return the size
nuclear@73:     	of the XML file in memory. (Note the size returned
nuclear@73:     	includes the terminating null.)
nuclear@73:     */
nuclear@73:     int CStrSize() const {
nuclear@73:         return _buffer.Size();
nuclear@73:     }
nuclear@73: 
nuclear@73: private:
nuclear@73:     void SealElement();
nuclear@73:     void PrintSpace( int depth );
nuclear@73:     void PrintString( const char*, bool restrictedEntitySet );	// prints out, after detecting entities.
nuclear@73:     void Print( const char* format, ... );
nuclear@73: 
nuclear@73:     bool _elementJustOpened;
nuclear@73:     bool _firstElement;
nuclear@73:     FILE* _fp;
nuclear@73:     int _depth;
nuclear@73:     int _textDepth;
nuclear@73:     bool _processEntities;
nuclear@73:     bool _compactMode;
nuclear@73: 
nuclear@73:     enum {
nuclear@73:         ENTITY_RANGE = 64,
nuclear@73:         BUF_SIZE = 200
nuclear@73:     };
nuclear@73:     bool _entityFlag[ENTITY_RANGE];
nuclear@73:     bool _restrictedEntityFlag[ENTITY_RANGE];
nuclear@73: 
nuclear@73:     DynArray< const char*, 10 > _stack;
nuclear@73:     DynArray< char, 20 > _buffer;
nuclear@73: #ifdef _MSC_VER
nuclear@73:     DynArray< char, 20 > _accumulator;
nuclear@73: #endif
nuclear@73: };
nuclear@73: 
nuclear@73: 
nuclear@73: }	// tinyxml2
nuclear@73: 
nuclear@73: #if defined(_MSC_VER)
nuclear@73: #   pragma warning(pop)
nuclear@73: #endif
nuclear@73: 
nuclear@73: #endif // TINYXML2_INCLUDED