blob: 3b57935dba886bb552a0d56a2b6713830d374810 [file] [log] [blame]
Lee Thomason (grinliz)28129862012-02-25 21:11:20 -08001/*
2Original code by Lee Thomason (www.grinninglizard.com)
3
4This software is provided 'as-is', without any express or implied
5warranty. In no event will the authors be held liable for any
6damages arising from the use of this software.
7
8Permission is granted to anyone to use this software for any
9purpose, including commercial applications, and to alter it and
10redistribute it freely, subject to the following restrictions:
11
121. The origin of this software must not be misrepresented; you must
13not claim that you wrote the original software. If you use this
14software in a product, an acknowledgment in the product documentation
15would be appreciated but is not required.
16
Lee Thomason (grinliz)db304252013-07-31 12:24:52 -070017
Lee Thomason (grinliz)28129862012-02-25 21:11:20 -0800182. Altered source versions must be plainly marked as such, and
19must not be misrepresented as being the original software.
20
213. This notice may not be removed or altered from any source
22distribution.
23*/
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -080024
Lee Thomason7d00b9a2012-02-27 17:54:22 -080025#ifndef TINYXML2_INCLUDED
U-Lama\Leee13c3e62011-12-28 14:36:55 -080026#define TINYXML2_INCLUDED
27
Jerome Martinez242c3ea2013-01-06 12:20:04 +010028#if defined(ANDROID_NDK) || defined(__BORLANDC__)
Lee Thomasona9cf3f92012-10-11 16:56:51 -070029# include <ctype.h>
30# include <limits.h>
31# include <stdio.h>
32# include <stdlib.h>
33# include <string.h>
34# include <stdarg.h>
Lee Thomason (grinliz)bc1bfb72012-08-20 22:00:38 -070035#else
Lee Thomasona9cf3f92012-10-11 16:56:51 -070036# include <cctype>
37# include <climits>
38# include <cstdio>
39# include <cstdlib>
40# include <cstring>
41# include <cstdarg>
Lee Thomason (grinliz)bc1bfb72012-08-20 22:00:38 -070042#endif
Lee Thomason (grinliz)6a22be22012-04-04 12:39:05 -070043
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -070044/*
Lee Thomason7d00b9a2012-02-27 17:54:22 -080045 TODO: intern strings instead of allocation.
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -080046*/
Lee Thomason (grinliz)9b093cc2012-02-25 21:30:18 -080047/*
Lee Thomasona9cf3f92012-10-11 16:56:51 -070048 gcc:
Lee Thomason5b0a6772012-11-19 13:54:42 -080049 g++ -Wall -DDEBUG tinyxml2.cpp xmltest.cpp -o gccxmltest.exe
MortenMacFly4ee49f12013-01-14 20:03:14 +010050
Lee Thomasona9cf3f92012-10-11 16:56:51 -070051 Formatting, Artistic Style:
52 AStyle.exe --style=1tbs --indent-switches --break-closing-brackets --indent-preprocessor tinyxml2.cpp tinyxml2.h
Lee Thomason (grinliz)9b093cc2012-02-25 21:30:18 -080053*/
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -080054
U-Lama\Lee4cee6112011-12-31 14:58:18 -080055#if defined( _DEBUG ) || defined( DEBUG ) || defined (__DEBUG__)
Lee Thomasona9cf3f92012-10-11 16:56:51 -070056# ifndef DEBUG
57# define DEBUG
58# endif
U-Lama\Lee4cee6112011-12-31 14:58:18 -080059#endif
60
PKEuS95060352013-07-26 10:42:44 +020061#ifdef _MSC_VER
62# pragma warning(push)
63# pragma warning(disable: 4251)
64#endif
U-Lama\Lee4cee6112011-12-31 14:58:18 -080065
PKEuS16ed47d2013-07-06 12:02:43 +020066#ifdef _WIN32
67# ifdef TINYXML2_EXPORT
68# define TINYXML2_LIB __declspec(dllexport)
69# elif defined(TINYXML2_IMPORT)
70# define TINYXML2_LIB __declspec(dllimport)
71# else
72# define TINYXML2_LIB
73# endif
74#else
75# define TINYXML2_LIB
76#endif
77
78
U-Lama\Lee4cee6112011-12-31 14:58:18 -080079#if defined(DEBUG)
Lee Thomasona9cf3f92012-10-11 16:56:51 -070080# if defined(_MSC_VER)
81# define TIXMLASSERT( x ) if ( !(x)) { __debugbreak(); } //if ( !(x)) WinDebugBreak()
82# elif defined (ANDROID_NDK)
83# include <android/log.h>
84# define TIXMLASSERT( x ) if ( !(x)) { __android_log_assert( "assert", "grinliz", "ASSERT in '%s' at %d.", __FILE__, __LINE__ ); }
85# else
86# include <assert.h>
87# define TIXMLASSERT assert
88# endif
89# else
90# define TIXMLASSERT( x ) {}
U-Lama\Lee4cee6112011-12-31 14:58:18 -080091#endif
92
U-Lama\Leee13c3e62011-12-28 14:36:55 -080093
Lee Thomason1a1d4a72012-02-15 09:09:25 -080094#if defined(_MSC_VER) && (_MSC_VER >= 1400 )
Lee Thomasona9cf3f92012-10-11 16:56:51 -070095// Microsoft visual studio, version 2005 and higher.
96/*int _snprintf_s(
97 char *buffer,
98 size_t sizeOfBuffer,
99 size_t count,
100 const char *format [,
101 argument] ...
102);*/
103inline int TIXML_SNPRINTF( char* buffer, size_t size, const char* format, ... )
104{
105 va_list va;
106 va_start( va, format );
107 int result = vsnprintf_s( buffer, size, _TRUNCATE, format, va );
108 va_end( va );
109 return result;
110}
111#define TIXML_SSCANF sscanf_s
Lee Thomason (grinliz)b9e791f2012-04-06 21:27:10 -0700112#else
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700113// GCC version 3 and higher
114//#warning( "Using sn* functions." )
115#define TIXML_SNPRINTF snprintf
116#define TIXML_SSCANF sscanf
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800117#endif
Lee Thomason1ff38e02012-02-14 18:18:16 -0800118
Uli Kusterer8fe342a2014-01-21 01:12:47 +0100119static const int TIXML2_MAJOR_VERSION = 1;
120static const int TIXML2_MINOR_VERSION = 0;
Lee Thomason5bb2d802014-01-24 10:42:57 -0800121static const int TIXML2_PATCH_VERSION = 14;
Lee Thomason1ff38e02012-02-14 18:18:16 -0800122
U-Lama\Leee13c3e62011-12-28 14:36:55 -0800123namespace tinyxml2
124{
Lee Thomasonce0763e2012-01-11 15:43:54 -0800125class XMLDocument;
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800126class XMLElement;
127class XMLAttribute;
128class XMLComment;
Lee Thomason5492a1c2012-01-23 15:32:10 -0800129class XMLText;
Lee Thomason50f97b22012-02-11 16:33:40 -0800130class XMLDeclaration;
131class XMLUnknown;
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800132class XMLPrinter;
Lee Thomason5cae8972012-01-24 18:03:07 -0800133
U-Stream\Leeae25a442012-02-17 17:48:16 -0800134/*
135 A class that wraps strings. Normally stores the start and end
136 pointers into the XML file itself, and will apply normalization
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800137 and entity translation if actually read. Can also store (and memory
U-Stream\Leeae25a442012-02-17 17:48:16 -0800138 manage) a traditional char[]
139*/
PKEuS95060352013-07-26 10:42:44 +0200140class StrPair
Lee Thomason39ede242012-01-20 11:27:56 -0800141{
Lee Thomasond34f52c2012-01-20 12:55:24 -0800142public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700143 enum {
144 NEEDS_ENTITY_PROCESSING = 0x01,
145 NEEDS_NEWLINE_NORMALIZATION = 0x02,
selfpoisede77e1952013-03-13 14:08:29 +0800146 COLLAPSE_WHITESPACE = 0x04,
Lee Thomason18d68bd2012-01-26 18:17:26 -0800147
selfpoisede77e1952013-03-13 14:08:29 +0800148 TEXT_ELEMENT = NEEDS_ENTITY_PROCESSING | NEEDS_NEWLINE_NORMALIZATION,
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700149 TEXT_ELEMENT_LEAVE_ENTITIES = NEEDS_NEWLINE_NORMALIZATION,
selfpoisede77e1952013-03-13 14:08:29 +0800150 ATTRIBUTE_NAME = 0,
151 ATTRIBUTE_VALUE = NEEDS_ENTITY_PROCESSING | NEEDS_NEWLINE_NORMALIZATION,
152 ATTRIBUTE_VALUE_LEAVE_ENTITIES = NEEDS_NEWLINE_NORMALIZATION,
153 COMMENT = NEEDS_NEWLINE_NORMALIZATION
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700154 };
Lee Thomason39ede242012-01-20 11:27:56 -0800155
Lee Thomason120b3a62012-10-12 10:06:59 -0700156 StrPair() : _flags( 0 ), _start( 0 ), _end( 0 ) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700157 ~StrPair();
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800158
Lee Thomason120b3a62012-10-12 10:06:59 -0700159 void Set( char* start, char* end, int flags ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700160 Reset();
Lee Thomason120b3a62012-10-12 10:06:59 -0700161 _start = start;
162 _end = end;
163 _flags = flags | NEEDS_FLUSH;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700164 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700165
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700166 const char* GetStr();
Lee Thomason120b3a62012-10-12 10:06:59 -0700167
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700168 bool Empty() const {
Lee Thomason120b3a62012-10-12 10:06:59 -0700169 return _start == _end;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700170 }
Lee Thomason39ede242012-01-20 11:27:56 -0800171
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700172 void SetInternedStr( const char* str ) {
173 Reset();
Lee Thomason120b3a62012-10-12 10:06:59 -0700174 _start = const_cast<char*>(str);
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700175 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700176
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700177 void SetStr( const char* str, int flags=0 );
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800178
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700179 char* ParseText( char* in, const char* endTag, int strFlags );
180 char* ParseName( char* in );
Lee Thomason56bdd022012-02-09 18:16:58 -0800181
Lee Thomason39ede242012-01-20 11:27:56 -0800182private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700183 void Reset();
184 void CollapseWhitespace();
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800185
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700186 enum {
187 NEEDS_FLUSH = 0x100,
188 NEEDS_DELETE = 0x200
189 };
Lee Thomasone4422302012-01-20 17:59:50 -0800190
selfpoised4dd59bc2013-03-13 16:54:15 +0800191 // After parsing, if *_end != 0, it can be set to zero.
Lee Thomason120b3a62012-10-12 10:06:59 -0700192 int _flags;
193 char* _start;
194 char* _end;
Lee Thomason39ede242012-01-20 11:27:56 -0800195};
196
U-Lama\Lee560bd472011-12-28 19:42:49 -0800197
U-Stream\Leeae25a442012-02-17 17:48:16 -0800198/*
199 A dynamic array of Plain Old Data. Doesn't support constructors, etc.
200 Has a small initial memory pool, so that low or no usage will not
201 cause a call to new/delete
202*/
Lee Thomason2c85a712012-01-31 08:24:24 -0800203template <class T, int INIT>
PKEuS95060352013-07-26 10:42:44 +0200204class DynArray
Lee Thomason2c85a712012-01-31 08:24:24 -0800205{
206public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700207 DynArray< T, INIT >() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700208 _mem = _pool;
209 _allocated = INIT;
210 _size = 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700211 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700212
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700213 ~DynArray() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700214 if ( _mem != _pool ) {
Lee Thomasoned5c8792012-10-12 10:09:48 -0700215 delete [] _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700216 }
217 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700218
Lee Thomasonce0510b2013-11-26 21:29:37 -0800219 void Clear() {
Reinhard Klambauer4e74b132013-11-22 14:01:58 +0100220 _size = 0;
221 }
222
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700223 void Push( T t ) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700224 EnsureCapacity( _size+1 );
225 _mem[_size++] = t;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700226 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800227
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700228 T* PushArr( int count ) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700229 EnsureCapacity( _size+count );
230 T* ret = &_mem[_size];
231 _size += count;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700232 return ret;
233 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700234
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700235 T Pop() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700236 return _mem[--_size];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700237 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700238
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700239 void PopArr( int count ) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700240 TIXMLASSERT( _size >= count );
241 _size -= count;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700242 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800243
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700244 bool Empty() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700245 return _size == 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700246 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700247
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700248 T& operator[](int i) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700249 TIXMLASSERT( i>= 0 && i < _size );
Lee Thomasoned5c8792012-10-12 10:09:48 -0700250 return _mem[i];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700251 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700252
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700253 const T& operator[](int i) const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700254 TIXMLASSERT( i>= 0 && i < _size );
Lee Thomasoned5c8792012-10-12 10:09:48 -0700255 return _mem[i];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700256 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700257
Dennis Jenkins59c75d32013-10-08 13:10:07 -0500258 const T& PeekTop() const {
259 TIXMLASSERT( _size > 0 );
260 return _mem[ _size - 1];
261 }
262
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700263 int Size() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700264 return _size;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700265 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700266
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700267 int Capacity() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700268 return _allocated;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700269 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700270
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700271 const T* Mem() const {
Lee Thomasoned5c8792012-10-12 10:09:48 -0700272 return _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700273 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700274
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700275 T* Mem() {
Lee Thomasoned5c8792012-10-12 10:09:48 -0700276 return _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700277 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800278
Lee Thomason2c85a712012-01-31 08:24:24 -0800279private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700280 void EnsureCapacity( int cap ) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700281 if ( cap > _allocated ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700282 int newAllocated = cap * 2;
283 T* newMem = new T[newAllocated];
Lee Thomason624d43f2012-10-12 10:58:48 -0700284 memcpy( newMem, _mem, sizeof(T)*_size ); // warning: not using constructors, only works for PODs
285 if ( _mem != _pool ) {
Lee Thomasoned5c8792012-10-12 10:09:48 -0700286 delete [] _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700287 }
Lee Thomasoned5c8792012-10-12 10:09:48 -0700288 _mem = newMem;
Lee Thomason624d43f2012-10-12 10:58:48 -0700289 _allocated = newAllocated;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700290 }
291 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800292
Lee Thomason624d43f2012-10-12 10:58:48 -0700293 T* _mem;
294 T _pool[INIT];
295 int _allocated; // objects allocated
296 int _size; // number objects in use
Lee Thomason2c85a712012-01-31 08:24:24 -0800297};
298
Lee Thomason50adb4c2012-02-13 15:07:09 -0800299
U-Stream\Leeae25a442012-02-17 17:48:16 -0800300/*
Thomas Roß08bdf502012-05-12 14:21:23 +0200301 Parent virtual class of a pool for fast allocation
U-Stream\Leeae25a442012-02-17 17:48:16 -0800302 and deallocation of objects.
303*/
PKEuS95060352013-07-26 10:42:44 +0200304class MemPool
Lee Thomasond1983222012-02-06 08:41:24 -0800305{
306public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700307 MemPool() {}
308 virtual ~MemPool() {}
Lee Thomasond1983222012-02-06 08:41:24 -0800309
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700310 virtual int ItemSize() const = 0;
311 virtual void* Alloc() = 0;
312 virtual void Free( void* ) = 0;
Lee Thomason5b0a6772012-11-19 13:54:42 -0800313 virtual void SetTracked() = 0;
Lee Thomasond1983222012-02-06 08:41:24 -0800314};
315
Lee Thomason50adb4c2012-02-13 15:07:09 -0800316
U-Stream\Leeae25a442012-02-17 17:48:16 -0800317/*
318 Template child class to create pools of the correct type.
319*/
Lee Thomasond1983222012-02-06 08:41:24 -0800320template< int SIZE >
PKEuS95060352013-07-26 10:42:44 +0200321class MemPoolT : public MemPool
Lee Thomasond1983222012-02-06 08:41:24 -0800322{
323public:
Lee Thomason5b0a6772012-11-19 13:54:42 -0800324 MemPoolT() : _root(0), _currentAllocs(0), _nAllocs(0), _maxAllocs(0), _nUntracked(0) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700325 ~MemPoolT() {
326 // Delete the blocks.
Lee Thomason624d43f2012-10-12 10:58:48 -0700327 for( int i=0; i<_blockPtrs.Size(); ++i ) {
328 delete _blockPtrs[i];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700329 }
330 }
Lee Thomasond1983222012-02-06 08:41:24 -0800331
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700332 virtual int ItemSize() const {
333 return SIZE;
334 }
335 int CurrentAllocs() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700336 return _currentAllocs;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700337 }
Lee Thomasond1983222012-02-06 08:41:24 -0800338
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700339 virtual void* Alloc() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700340 if ( !_root ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700341 // Need a new block.
342 Block* block = new Block();
Lee Thomason624d43f2012-10-12 10:58:48 -0700343 _blockPtrs.Push( block );
Lee Thomasond1983222012-02-06 08:41:24 -0800344
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700345 for( int i=0; i<COUNT-1; ++i ) {
346 block->chunk[i].next = &block->chunk[i+1];
347 }
348 block->chunk[COUNT-1].next = 0;
Lee Thomason624d43f2012-10-12 10:58:48 -0700349 _root = block->chunk;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700350 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700351 void* result = _root;
352 _root = _root->next;
Lee Thomason455c9d42012-02-06 09:14:14 -0800353
Lee Thomason624d43f2012-10-12 10:58:48 -0700354 ++_currentAllocs;
355 if ( _currentAllocs > _maxAllocs ) {
356 _maxAllocs = _currentAllocs;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700357 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700358 _nAllocs++;
Lee Thomason5b0a6772012-11-19 13:54:42 -0800359 _nUntracked++;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700360 return result;
361 }
362 virtual void Free( void* mem ) {
363 if ( !mem ) {
364 return;
365 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700366 --_currentAllocs;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700367 Chunk* chunk = (Chunk*)mem;
Lee Thomason (grinliz)6020a012012-09-08 21:15:09 -0700368#ifdef DEBUG
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700369 memset( chunk, 0xfe, sizeof(Chunk) );
Lee Thomason (grinliz)6020a012012-09-08 21:15:09 -0700370#endif
Lee Thomason624d43f2012-10-12 10:58:48 -0700371 chunk->next = _root;
372 _root = chunk;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700373 }
374 void Trace( const char* name ) {
375 printf( "Mempool %s watermark=%d [%dk] current=%d size=%d nAlloc=%d blocks=%d\n",
Lee Thomason624d43f2012-10-12 10:58:48 -0700376 name, _maxAllocs, _maxAllocs*SIZE/1024, _currentAllocs, SIZE, _nAllocs, _blockPtrs.Size() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700377 }
Lee Thomasond1983222012-02-06 08:41:24 -0800378
Lee Thomason5b0a6772012-11-19 13:54:42 -0800379 void SetTracked() {
380 _nUntracked--;
381 }
382
383 int Untracked() const {
384 return _nUntracked;
385 }
386
Lee Thomason (grinliz)ac83b4e2013-02-01 09:02:34 -0800387 // This number is perf sensitive. 4k seems like a good tradeoff on my machine.
388 // The test file is large, 170k.
389 // Release: VS2010 gcc(no opt)
390 // 1k: 4000
391 // 2k: 4000
392 // 4k: 3900 21000
393 // 16k: 5200
394 // 32k: 4300
395 // 64k: 4000 21000
396 enum { COUNT = (4*1024)/SIZE }; // Some compilers do not accept to use COUNT in private part if COUNT is private
Jerome Martinez7921df12012-10-24 11:45:44 +0200397
Lee Thomasond1983222012-02-06 08:41:24 -0800398private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700399 union Chunk {
Lee Thomason624d43f2012-10-12 10:58:48 -0700400 Chunk* next;
401 char mem[SIZE];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700402 };
403 struct Block {
Lee Thomason (grinliz)856da212012-10-19 09:08:15 -0700404 Chunk chunk[COUNT];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700405 };
Lee Thomason624d43f2012-10-12 10:58:48 -0700406 DynArray< Block*, 10 > _blockPtrs;
407 Chunk* _root;
Lee Thomason455c9d42012-02-06 09:14:14 -0800408
Lee Thomason624d43f2012-10-12 10:58:48 -0700409 int _currentAllocs;
410 int _nAllocs;
411 int _maxAllocs;
Lee Thomason5b0a6772012-11-19 13:54:42 -0800412 int _nUntracked;
Lee Thomasond1983222012-02-06 08:41:24 -0800413};
414
Lee Thomason2c85a712012-01-31 08:24:24 -0800415
Lee Thomason56bdd022012-02-09 18:16:58 -0800416
417/**
418 Implements the interface to the "Visitor pattern" (see the Accept() method.)
419 If you call the Accept() method, it requires being passed a XMLVisitor
420 class to handle callbacks. For nodes that contain other nodes (Document, Element)
Thomas Roß08bdf502012-05-12 14:21:23 +0200421 you will get called with a VisitEnter/VisitExit pair. Nodes that are always leafs
Lee Thomason56bdd022012-02-09 18:16:58 -0800422 are simply called with Visit().
423
424 If you return 'true' from a Visit method, recursive parsing will continue. If you return
Andrew C. Martin0fd87462013-03-09 20:09:45 -0700425 false, <b>no children of this node or its siblings</b> will be visited.
Lee Thomason56bdd022012-02-09 18:16:58 -0800426
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700427 All flavors of Visit methods have a default implementation that returns 'true' (continue
Lee Thomason56bdd022012-02-09 18:16:58 -0800428 visiting). You need to only override methods that are interesting to you.
429
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600430 Generally Accept() is called on the XMLDocument, although all nodes support visiting.
Lee Thomason56bdd022012-02-09 18:16:58 -0800431
432 You should never change the document from a callback.
433
434 @sa XMLNode::Accept()
435*/
PKEuS16ed47d2013-07-06 12:02:43 +0200436class TINYXML2_LIB XMLVisitor
U-Lama\Leee13c3e62011-12-28 14:36:55 -0800437{
438public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700439 virtual ~XMLVisitor() {}
Lee Thomasond1983222012-02-06 08:41:24 -0800440
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700441 /// Visit a document.
442 virtual bool VisitEnter( const XMLDocument& /*doc*/ ) {
443 return true;
444 }
445 /// Visit a document.
446 virtual bool VisitExit( const XMLDocument& /*doc*/ ) {
447 return true;
448 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800449
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700450 /// Visit an element.
451 virtual bool VisitEnter( const XMLElement& /*element*/, const XMLAttribute* /*firstAttribute*/ ) {
452 return true;
453 }
454 /// Visit an element.
455 virtual bool VisitExit( const XMLElement& /*element*/ ) {
456 return true;
457 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800458
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700459 /// Visit a declaration.
460 virtual bool Visit( const XMLDeclaration& /*declaration*/ ) {
461 return true;
462 }
463 /// Visit a text node.
464 virtual bool Visit( const XMLText& /*text*/ ) {
465 return true;
466 }
467 /// Visit a comment node.
468 virtual bool Visit( const XMLComment& /*comment*/ ) {
469 return true;
470 }
471 /// Visit an unknown node.
472 virtual bool Visit( const XMLUnknown& /*unknown*/ ) {
473 return true;
474 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800475};
476
477
U-Stream\Leeae25a442012-02-17 17:48:16 -0800478/*
479 Utility functionality.
480*/
Lee Thomason56bdd022012-02-09 18:16:58 -0800481class XMLUtil
482{
Lee Thomasond1983222012-02-06 08:41:24 -0800483public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700484 // Anything in the high order range of UTF-8 is assumed to not be whitespace. This isn't
485 // correct, but simple, and usually works.
486 static const char* SkipWhiteSpace( const char* p ) {
Jerome Martinez242c3ea2013-01-06 12:20:04 +0100487 while( !IsUTF8Continuation(*p) && isspace( *reinterpret_cast<const unsigned char*>(p) ) ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700488 ++p;
489 }
490 return p;
491 }
492 static char* SkipWhiteSpace( char* p ) {
Jerome Martinez242c3ea2013-01-06 12:20:04 +0100493 while( !IsUTF8Continuation(*p) && isspace( *reinterpret_cast<unsigned char*>(p) ) ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700494 ++p;
495 }
496 return p;
497 }
498 static bool IsWhiteSpace( char p ) {
Jerome Martinez242c3ea2013-01-06 12:20:04 +0100499 return !IsUTF8Continuation(p) && isspace( static_cast<unsigned char>(p) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700500 }
Martinsh Shaitersc6d02f42013-01-26 21:22:57 +0200501
502 inline static bool IsNameStartChar( unsigned char ch ) {
503 return ( ( ch < 128 ) ? isalpha( ch ) : 1 )
504 || ch == ':'
505 || ch == '_';
506 }
507
508 inline static bool IsNameChar( unsigned char ch ) {
509 return IsNameStartChar( ch )
510 || isdigit( ch )
511 || ch == '.'
512 || ch == '-';
513 }
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800514
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700515 inline static bool StringEqual( const char* p, const char* q, int nChar=INT_MAX ) {
516 int n = 0;
517 if ( p == q ) {
518 return true;
519 }
520 while( *p && *q && *p == *q && n<nChar ) {
521 ++p;
522 ++q;
523 ++n;
524 }
525 if ( (n == nChar) || ( *p == 0 && *q == 0 ) ) {
526 return true;
527 }
528 return false;
529 }
Martinsh Shaitersc6d02f42013-01-26 21:22:57 +0200530
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700531 inline static int IsUTF8Continuation( const char p ) {
532 return p & 0x80;
533 }
Lee Thomason (grinliz)68db57e2012-02-21 09:08:12 -0800534
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700535 static const char* ReadBOM( const char* p, bool* hasBOM );
536 // p is the starting location,
537 // the UTF-8 value of the entity will be placed in value, and length filled in.
538 static const char* GetCharacterRef( const char* p, char* value, int* length );
539 static void ConvertUTF32ToUTF8( unsigned long input, char* output, int* length );
Lee Thomason21be8822012-07-15 17:27:22 -0700540
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700541 // converts primitive types to strings
542 static void ToStr( int v, char* buffer, int bufferSize );
543 static void ToStr( unsigned v, char* buffer, int bufferSize );
544 static void ToStr( bool v, char* buffer, int bufferSize );
545 static void ToStr( float v, char* buffer, int bufferSize );
546 static void ToStr( double v, char* buffer, int bufferSize );
Lee Thomason21be8822012-07-15 17:27:22 -0700547
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700548 // converts strings to primitive types
549 static bool ToInt( const char* str, int* value );
550 static bool ToUnsigned( const char* str, unsigned* value );
551 static bool ToBool( const char* str, bool* value );
552 static bool ToFloat( const char* str, float* value );
553 static bool ToDouble( const char* str, double* value );
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800554};
555
Lee Thomason5cae8972012-01-24 18:03:07 -0800556
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800557/** XMLNode is a base class for every object that is in the
558 XML Document Object Model (DOM), except XMLAttributes.
559 Nodes have siblings, a parent, and children which can
560 be navigated. A node is always in a XMLDocument.
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700561 The type of a XMLNode can be queried, and it can
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800562 be cast to its more defined type.
563
Thomas Roß08bdf502012-05-12 14:21:23 +0200564 A XMLDocument allocates memory for all its Nodes.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800565 When the XMLDocument gets deleted, all its Nodes
566 will also be deleted.
567
568 @verbatim
569 A Document can contain: Element (container or leaf)
570 Comment (leaf)
571 Unknown (leaf)
572 Declaration( leaf )
573
574 An Element can contain: Element (container or leaf)
575 Text (leaf)
576 Attributes (not on tree)
577 Comment (leaf)
578 Unknown (leaf)
579
580 @endverbatim
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800581*/
PKEuS16ed47d2013-07-06 12:02:43 +0200582class TINYXML2_LIB XMLNode
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800583{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700584 friend class XMLDocument;
585 friend class XMLElement;
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800586public:
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800587
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700588 /// Get the XMLDocument that owns this XMLNode.
589 const XMLDocument* GetDocument() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700590 return _document;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700591 }
592 /// Get the XMLDocument that owns this XMLNode.
593 XMLDocument* GetDocument() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700594 return _document;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700595 }
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800596
Lee Thomason2fa81722012-11-09 12:37:46 -0800597 /// Safely cast to an Element, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700598 virtual XMLElement* ToElement() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100599 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700600 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800601 /// Safely cast to Text, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700602 virtual XMLText* ToText() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100603 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700604 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800605 /// Safely cast to a Comment, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700606 virtual XMLComment* ToComment() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100607 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700608 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800609 /// Safely cast to a Document, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700610 virtual XMLDocument* ToDocument() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100611 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700612 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800613 /// Safely cast to a Declaration, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700614 virtual XMLDeclaration* ToDeclaration() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100615 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700616 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800617 /// Safely cast to an Unknown, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700618 virtual XMLUnknown* ToUnknown() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100619 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700620 }
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800621
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700622 virtual const XMLElement* ToElement() const {
623 return 0;
624 }
625 virtual const XMLText* ToText() const {
626 return 0;
627 }
628 virtual const XMLComment* ToComment() const {
629 return 0;
630 }
631 virtual const XMLDocument* ToDocument() const {
632 return 0;
633 }
634 virtual const XMLDeclaration* ToDeclaration() const {
635 return 0;
636 }
637 virtual const XMLUnknown* ToUnknown() const {
638 return 0;
639 }
Lee Thomason751da522012-02-10 08:50:51 -0800640
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700641 /** The meaning of 'value' changes for the specific type.
642 @verbatim
643 Document: empty
644 Element: name of the element
645 Comment: the comment text
646 Unknown: the tag contents
647 Text: the text string
648 @endverbatim
649 */
Michael Daumling21626882013-10-22 17:03:37 +0200650 const char* Value() const;
MortenMacFly4ee49f12013-01-14 20:03:14 +0100651
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700652 /** Set the Value of an XML node.
653 @sa Value()
654 */
655 void SetValue( const char* val, bool staticMem=false );
Lee Thomason2c85a712012-01-31 08:24:24 -0800656
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700657 /// Get the parent of this node on the DOM.
658 const XMLNode* Parent() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700659 return _parent;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700660 }
MortenMacFly4ee49f12013-01-14 20:03:14 +0100661
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700662 XMLNode* Parent() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700663 return _parent;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700664 }
Lee Thomason751da522012-02-10 08:50:51 -0800665
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700666 /// Returns true if this node has no children.
667 bool NoChildren() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700668 return !_firstChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700669 }
Lee Thomason751da522012-02-10 08:50:51 -0800670
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700671 /// Get the first child node, or null if none exists.
672 const XMLNode* FirstChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700673 return _firstChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700674 }
MortenMacFly4ee49f12013-01-14 20:03:14 +0100675
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700676 XMLNode* FirstChild() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700677 return _firstChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700678 }
MortenMacFly4ee49f12013-01-14 20:03:14 +0100679
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700680 /** Get the first child element, or optionally the first child
681 element with the specified name.
682 */
683 const XMLElement* FirstChildElement( const char* value=0 ) const;
Lee Thomason624d43f2012-10-12 10:58:48 -0700684
685 XMLElement* FirstChildElement( const char* value=0 ) {
686 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->FirstChildElement( value ));
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700687 }
Lee Thomason3f57d272012-01-11 15:30:03 -0800688
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700689 /// Get the last child node, or null if none exists.
690 const XMLNode* LastChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700691 return _lastChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700692 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700693
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700694 XMLNode* LastChild() {
695 return const_cast<XMLNode*>(const_cast<const XMLNode*>(this)->LastChild() );
696 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800697
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700698 /** Get the last child element or optionally the last child
699 element with the specified name.
700 */
701 const XMLElement* LastChildElement( const char* value=0 ) const;
Lee Thomason624d43f2012-10-12 10:58:48 -0700702
703 XMLElement* LastChildElement( const char* value=0 ) {
704 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->LastChildElement(value) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700705 }
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700706
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700707 /// Get the previous (left) sibling node of this node.
708 const XMLNode* PreviousSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700709 return _prev;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700710 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700711
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700712 XMLNode* PreviousSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700713 return _prev;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700714 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800715
Andrew C. Martin0fd87462013-03-09 20:09:45 -0700716 /// Get the previous (left) sibling element of this node, with an optionally supplied name.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700717 const XMLElement* PreviousSiblingElement( const char* value=0 ) const ;
Lee Thomason624d43f2012-10-12 10:58:48 -0700718
719 XMLElement* PreviousSiblingElement( const char* value=0 ) {
720 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->PreviousSiblingElement( value ) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700721 }
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700722
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700723 /// Get the next (right) sibling node of this node.
724 const XMLNode* NextSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700725 return _next;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700726 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700727
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700728 XMLNode* NextSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700729 return _next;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700730 }
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700731
Andrew C. Martin0fd87462013-03-09 20:09:45 -0700732 /// Get the next (right) sibling element of this node, with an optionally supplied name.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700733 const XMLElement* NextSiblingElement( const char* value=0 ) const;
Lee Thomason624d43f2012-10-12 10:58:48 -0700734
735 XMLElement* NextSiblingElement( const char* value=0 ) {
736 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->NextSiblingElement( value ) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700737 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800738
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700739 /**
740 Add a child node as the last (right) child.
Michael Daumlinged523282013-10-23 07:47:29 +0200741 If the child node is already part of the document,
742 it is moved from its old location to the new location.
743 Returns the addThis argument or 0 if the node does not
744 belong to the same document.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700745 */
746 XMLNode* InsertEndChild( XMLNode* addThis );
Lee Thomason618dbf82012-02-28 12:34:27 -0800747
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700748 XMLNode* LinkEndChild( XMLNode* addThis ) {
749 return InsertEndChild( addThis );
750 }
751 /**
752 Add a child node as the first (left) child.
Michael Daumlinged523282013-10-23 07:47:29 +0200753 If the child node is already part of the document,
754 it is moved from its old location to the new location.
755 Returns the addThis argument or 0 if the node does not
756 belong to the same document.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700757 */
758 XMLNode* InsertFirstChild( XMLNode* addThis );
759 /**
760 Add a node after the specified child node.
Michael Daumlinged523282013-10-23 07:47:29 +0200761 If the child node is already part of the document,
762 it is moved from its old location to the new location.
763 Returns the addThis argument or 0 if the afterThis node
764 is not a child of this node, or if the node does not
765 belong to the same document.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700766 */
767 XMLNode* InsertAfterChild( XMLNode* afterThis, XMLNode* addThis );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700768
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700769 /**
770 Delete all the children of this node.
771 */
772 void DeleteChildren();
U-Stream\Leeae25a442012-02-17 17:48:16 -0800773
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700774 /**
775 Delete a child of this node.
776 */
777 void DeleteChild( XMLNode* node );
Lee Thomason56bdd022012-02-09 18:16:58 -0800778
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700779 /**
780 Make a copy of this node, but not its children.
781 You may pass in a Document pointer that will be
782 the owner of the new Node. If the 'document' is
783 null, then the node returned will be allocated
784 from the current Document. (this->GetDocument())
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800785
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700786 Note: if called on a XMLDocument, this will return null.
787 */
788 virtual XMLNode* ShallowClone( XMLDocument* document ) const = 0;
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800789
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700790 /**
791 Test if 2 nodes are the same, but don't test children.
792 The 2 nodes do not need to be in the same Document.
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800793
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700794 Note: if called on a XMLDocument, this will return false.
795 */
796 virtual bool ShallowEqual( const XMLNode* compare ) const = 0;
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800797
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600798 /** Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700799 XML tree will be conditionally visited and the host will be called back
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600800 via the XMLVisitor interface.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800801
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600802 This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse
803 the XML for the callbacks, so the performance of TinyXML-2 is unchanged by using this
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700804 interface versus any other.)
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800805
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700806 The interface has been based on ideas from:
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800807
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700808 - http://www.saxproject.org/
809 - http://c2.com/cgi/wiki?HierarchicalVisitorPattern
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800810
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700811 Which are both good references for "visiting".
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800812
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700813 An example of using Accept():
814 @verbatim
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600815 XMLPrinter printer;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700816 tinyxmlDoc.Accept( &printer );
817 const char* xmlcstr = printer.CStr();
818 @endverbatim
819 */
820 virtual bool Accept( XMLVisitor* visitor ) const = 0;
Lee Thomason56bdd022012-02-09 18:16:58 -0800821
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700822 // internal
823 virtual char* ParseDeep( char*, StrPair* );
Uli Kusterer593a33d2014-02-01 12:48:51 +0100824
825 bool GetForceCompactMode() const { if( _forceCompactMode || !Parent() ) return _forceCompactMode; return Parent()->GetForceCompactMode(); };
826 void SetForceCompactMode( bool b ) { _forceCompactMode = b; };
Lee Thomason3f57d272012-01-11 15:30:03 -0800827
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800828protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700829 XMLNode( XMLDocument* );
830 virtual ~XMLNode();
831 XMLNode( const XMLNode& ); // not supported
832 XMLNode& operator=( const XMLNode& ); // not supported
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700833
Lee Thomason624d43f2012-10-12 10:58:48 -0700834 XMLDocument* _document;
835 XMLNode* _parent;
836 mutable StrPair _value;
Lee Thomason3f57d272012-01-11 15:30:03 -0800837
Lee Thomason624d43f2012-10-12 10:58:48 -0700838 XMLNode* _firstChild;
839 XMLNode* _lastChild;
Lee Thomason3f57d272012-01-11 15:30:03 -0800840
Lee Thomason624d43f2012-10-12 10:58:48 -0700841 XMLNode* _prev;
842 XMLNode* _next;
Uli Kusterer593a33d2014-02-01 12:48:51 +0100843
844 bool _forceCompactMode;
Lee Thomason3f57d272012-01-11 15:30:03 -0800845
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800846private:
Lee Thomason624d43f2012-10-12 10:58:48 -0700847 MemPool* _memPool;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700848 void Unlink( XMLNode* child );
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800849};
850
851
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800852/** XML text.
853
854 Note that a text node can have child element nodes, for example:
855 @verbatim
856 <root>This is <b>bold</b></root>
857 @endverbatim
858
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700859 A text node can have 2 ways to output the next. "normal" output
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800860 and CDATA. It will default to the mode it was parsed from the XML file and
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700861 you generally want to leave it alone, but you can change the output mode with
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600862 SetCData() and query it with CData().
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800863*/
PKEuS16ed47d2013-07-06 12:02:43 +0200864class TINYXML2_LIB XMLText : public XMLNode
Lee Thomason5492a1c2012-01-23 15:32:10 -0800865{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700866 friend class XMLBase;
867 friend class XMLDocument;
Lee Thomason5492a1c2012-01-23 15:32:10 -0800868public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700869 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason50adb4c2012-02-13 15:07:09 -0800870
Lee Thomason624d43f2012-10-12 10:58:48 -0700871 virtual XMLText* ToText() {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700872 return this;
873 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700874 virtual const XMLText* ToText() const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700875 return this;
876 }
Lee Thomason5492a1c2012-01-23 15:32:10 -0800877
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700878 /// Declare whether this should be CDATA or standard text.
Lee Thomason624d43f2012-10-12 10:58:48 -0700879 void SetCData( bool isCData ) {
880 _isCData = isCData;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700881 }
882 /// Returns true if this is a CDATA text element.
883 bool CData() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700884 return _isCData;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700885 }
Lee Thomason50f97b22012-02-11 16:33:40 -0800886
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700887 char* ParseDeep( char*, StrPair* endTag );
888 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
889 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800890
Lee Thomason5492a1c2012-01-23 15:32:10 -0800891protected:
Lee Thomason624d43f2012-10-12 10:58:48 -0700892 XMLText( XMLDocument* doc ) : XMLNode( doc ), _isCData( false ) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700893 virtual ~XMLText() {}
894 XMLText( const XMLText& ); // not supported
895 XMLText& operator=( const XMLText& ); // not supported
Lee Thomason5492a1c2012-01-23 15:32:10 -0800896
897private:
Lee Thomason624d43f2012-10-12 10:58:48 -0700898 bool _isCData;
Lee Thomason5492a1c2012-01-23 15:32:10 -0800899};
900
901
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800902/** An XML Comment. */
PKEuS16ed47d2013-07-06 12:02:43 +0200903class TINYXML2_LIB XMLComment : public XMLNode
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800904{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700905 friend class XMLDocument;
Lee Thomason3f57d272012-01-11 15:30:03 -0800906public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700907 virtual XMLComment* ToComment() {
908 return this;
909 }
910 virtual const XMLComment* ToComment() const {
911 return this;
912 }
Lee Thomasonce0763e2012-01-11 15:43:54 -0800913
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700914 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800915
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700916 char* ParseDeep( char*, StrPair* endTag );
917 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
918 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomasonce0763e2012-01-11 15:43:54 -0800919
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800920protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700921 XMLComment( XMLDocument* doc );
922 virtual ~XMLComment();
923 XMLComment( const XMLComment& ); // not supported
924 XMLComment& operator=( const XMLComment& ); // not supported
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800925
Lee Thomason3f57d272012-01-11 15:30:03 -0800926private:
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800927};
U-Lama\Leee13c3e62011-12-28 14:36:55 -0800928
929
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800930/** In correct XML the declaration is the first entry in the file.
931 @verbatim
932 <?xml version="1.0" standalone="yes"?>
933 @endverbatim
934
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600935 TinyXML-2 will happily read or write files without a declaration,
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800936 however.
937
938 The text of the declaration isn't interpreted. It is parsed
939 and written as a string.
940*/
PKEuS16ed47d2013-07-06 12:02:43 +0200941class TINYXML2_LIB XMLDeclaration : public XMLNode
Lee Thomason50f97b22012-02-11 16:33:40 -0800942{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700943 friend class XMLDocument;
Lee Thomason50f97b22012-02-11 16:33:40 -0800944public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700945 virtual XMLDeclaration* ToDeclaration() {
946 return this;
947 }
948 virtual const XMLDeclaration* ToDeclaration() const {
949 return this;
950 }
Lee Thomason50f97b22012-02-11 16:33:40 -0800951
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700952 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -0800953
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700954 char* ParseDeep( char*, StrPair* endTag );
955 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
956 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -0800957
958protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700959 XMLDeclaration( XMLDocument* doc );
960 virtual ~XMLDeclaration();
961 XMLDeclaration( const XMLDeclaration& ); // not supported
962 XMLDeclaration& operator=( const XMLDeclaration& ); // not supported
Lee Thomason50f97b22012-02-11 16:33:40 -0800963};
964
965
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600966/** Any tag that TinyXML-2 doesn't recognize is saved as an
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800967 unknown. It is a tag of text, but should not be modified.
968 It will be written back to the XML, unchanged, when the file
969 is saved.
970
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600971 DTD tags get thrown into XMLUnknowns.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800972*/
PKEuS16ed47d2013-07-06 12:02:43 +0200973class TINYXML2_LIB XMLUnknown : public XMLNode
Lee Thomason50f97b22012-02-11 16:33:40 -0800974{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700975 friend class XMLDocument;
Lee Thomason50f97b22012-02-11 16:33:40 -0800976public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700977 virtual XMLUnknown* ToUnknown() {
978 return this;
979 }
980 virtual const XMLUnknown* ToUnknown() const {
981 return this;
982 }
Lee Thomason50f97b22012-02-11 16:33:40 -0800983
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700984 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -0800985
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700986 char* ParseDeep( char*, StrPair* endTag );
987 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
988 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -0800989
990protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700991 XMLUnknown( XMLDocument* doc );
992 virtual ~XMLUnknown();
993 XMLUnknown( const XMLUnknown& ); // not supported
994 XMLUnknown& operator=( const XMLUnknown& ); // not supported
Lee Thomason50f97b22012-02-11 16:33:40 -0800995};
996
997
Lee Thomason2fa81722012-11-09 12:37:46 -0800998enum XMLError {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700999 XML_NO_ERROR = 0,
1000 XML_SUCCESS = 0,
Lee Thomason (grinliz)68db57e2012-02-21 09:08:12 -08001001
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001002 XML_NO_ATTRIBUTE,
1003 XML_WRONG_ATTRIBUTE_TYPE,
Lee Thomason (grinliz)68db57e2012-02-21 09:08:12 -08001004
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001005 XML_ERROR_FILE_NOT_FOUND,
1006 XML_ERROR_FILE_COULD_NOT_BE_OPENED,
1007 XML_ERROR_FILE_READ_ERROR,
1008 XML_ERROR_ELEMENT_MISMATCH,
1009 XML_ERROR_PARSING_ELEMENT,
1010 XML_ERROR_PARSING_ATTRIBUTE,
1011 XML_ERROR_IDENTIFYING_TAG,
1012 XML_ERROR_PARSING_TEXT,
1013 XML_ERROR_PARSING_CDATA,
1014 XML_ERROR_PARSING_COMMENT,
1015 XML_ERROR_PARSING_DECLARATION,
1016 XML_ERROR_PARSING_UNKNOWN,
1017 XML_ERROR_EMPTY_DOCUMENT,
1018 XML_ERROR_MISMATCHED_ELEMENT,
1019 XML_ERROR_PARSING,
Lee Thomason21be8822012-07-15 17:27:22 -07001020
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001021 XML_CAN_NOT_CONVERT_TEXT,
Uli Kustererff8e2042014-01-21 02:53:47 +01001022 XML_NO_TEXT_NODE,
1023 XML_NO_ELEMENT_NODE
Lee Thomason1ff38e02012-02-14 18:18:16 -08001024};
1025
1026
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001027/** An attribute is a name-value pair. Elements have an arbitrary
1028 number of attributes, each with a unique name.
1029
1030 @note The attributes are not XMLNodes. You may only query the
1031 Next() attribute in a list.
1032*/
PKEuS16ed47d2013-07-06 12:02:43 +02001033class TINYXML2_LIB XMLAttribute
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001034{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001035 friend class XMLElement;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001036public:
Lee Thomason2fa81722012-11-09 12:37:46 -08001037 /// The name of the attribute.
Michael Daumling21626882013-10-22 17:03:37 +02001038 const char* Name() const;
1039
Lee Thomason2fa81722012-11-09 12:37:46 -08001040 /// The value of the attribute.
Michael Daumling21626882013-10-22 17:03:37 +02001041 const char* Value() const;
1042
Lee Thomason2fa81722012-11-09 12:37:46 -08001043 /// The next attribute in the list.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001044 const XMLAttribute* Next() const {
MortenMacFly4ee49f12013-01-14 20:03:14 +01001045 return _next;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001046 }
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001047
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001048 /** IntValue interprets the attribute as an integer, and returns the value.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001049 If the value isn't an integer, 0 will be returned. There is no error checking;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001050 use QueryIntValue() if you need error checking.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001051 */
1052 int IntValue() const {
1053 int i=0;
1054 QueryIntValue( &i );
1055 return i;
1056 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001057 /// Query as an unsigned integer. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001058 unsigned UnsignedValue() const {
1059 unsigned i=0;
1060 QueryUnsignedValue( &i );
1061 return i;
1062 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001063 /// Query as a boolean. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001064 bool BoolValue() const {
1065 bool b=false;
1066 QueryBoolValue( &b );
1067 return b;
1068 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001069 /// Query as a double. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001070 double DoubleValue() const {
1071 double d=0;
1072 QueryDoubleValue( &d );
1073 return d;
1074 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001075 /// Query as a float. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001076 float FloatValue() const {
1077 float f=0;
1078 QueryFloatValue( &f );
1079 return f;
1080 }
U-Stream\Leeae25a442012-02-17 17:48:16 -08001081
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001082 /** QueryIntValue interprets the attribute as an integer, and returns the value
Andrew C. Martin0fd87462013-03-09 20:09:45 -07001083 in the provided parameter. The function will return XML_NO_ERROR on success,
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001084 and XML_WRONG_ATTRIBUTE_TYPE if the conversion is not successful.
1085 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001086 XMLError QueryIntValue( int* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001087 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001088 XMLError QueryUnsignedValue( unsigned int* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001089 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001090 XMLError QueryBoolValue( bool* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001091 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001092 XMLError QueryDoubleValue( double* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001093 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001094 XMLError QueryFloatValue( float* value ) const;
Lee Thomason50adb4c2012-02-13 15:07:09 -08001095
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001096 /// Set the attribute to a string value.
1097 void SetAttribute( const char* value );
1098 /// Set the attribute to value.
1099 void SetAttribute( int value );
1100 /// Set the attribute to value.
1101 void SetAttribute( unsigned value );
1102 /// Set the attribute to value.
1103 void SetAttribute( bool value );
1104 /// Set the attribute to value.
1105 void SetAttribute( double value );
1106 /// Set the attribute to value.
1107 void SetAttribute( float value );
Lee Thomason50adb4c2012-02-13 15:07:09 -08001108
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001109private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001110 enum { BUF_SIZE = 200 };
U-Stream\Lee09a11c52012-02-17 08:31:16 -08001111
Thomas Roß61892312013-05-12 14:07:38 +02001112 XMLAttribute() : _next( 0 ), _memPool( 0 ) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001113 virtual ~XMLAttribute() {}
Lee Thomason624d43f2012-10-12 10:58:48 -07001114
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001115 XMLAttribute( const XMLAttribute& ); // not supported
1116 void operator=( const XMLAttribute& ); // not supported
1117 void SetName( const char* name );
Lee Thomason50adb4c2012-02-13 15:07:09 -08001118
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001119 char* ParseDeep( char* p, bool processEntities );
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001120
Lee Thomason624d43f2012-10-12 10:58:48 -07001121 mutable StrPair _name;
1122 mutable StrPair _value;
1123 XMLAttribute* _next;
1124 MemPool* _memPool;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001125};
1126
1127
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001128/** The element is a container class. It has a value, the element name,
1129 and can contain other elements, text, comments, and unknowns.
1130 Elements also contain an arbitrary number of attributes.
1131*/
PKEuS16ed47d2013-07-06 12:02:43 +02001132class TINYXML2_LIB XMLElement : public XMLNode
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001133{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001134 friend class XMLBase;
1135 friend class XMLDocument;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001136public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001137 /// Get the name of an element (which is the Value() of the node.)
1138 const char* Name() const {
1139 return Value();
1140 }
1141 /// Set the name of the element.
1142 void SetName( const char* str, bool staticMem=false ) {
1143 SetValue( str, staticMem );
1144 }
Lee Thomason2c85a712012-01-31 08:24:24 -08001145
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001146 virtual XMLElement* ToElement() {
1147 return this;
1148 }
1149 virtual const XMLElement* ToElement() const {
1150 return this;
1151 }
1152 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001153
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001154 /** Given an attribute name, Attribute() returns the value
1155 for the attribute of that name, or null if none
1156 exists. For example:
Lee Thomason92258152012-03-24 13:05:39 -07001157
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001158 @verbatim
1159 const char* value = ele->Attribute( "foo" );
1160 @endverbatim
Lee Thomason92258152012-03-24 13:05:39 -07001161
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001162 The 'value' parameter is normally null. However, if specified,
1163 the attribute will only be returned if the 'name' and 'value'
1164 match. This allow you to write code:
Lee Thomason8ba7f7d2012-03-24 13:04:04 -07001165
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001166 @verbatim
1167 if ( ele->Attribute( "foo", "bar" ) ) callFooIsBar();
1168 @endverbatim
Lee Thomason8ba7f7d2012-03-24 13:04:04 -07001169
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001170 rather than:
1171 @verbatim
1172 if ( ele->Attribute( "foo" ) ) {
1173 if ( strcmp( ele->Attribute( "foo" ), "bar" ) == 0 ) callFooIsBar();
1174 }
1175 @endverbatim
1176 */
1177 const char* Attribute( const char* name, const char* value=0 ) const;
Lee Thomason751da522012-02-10 08:50:51 -08001178
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001179 /** Given an attribute name, IntAttribute() returns the value
1180 of the attribute interpreted as an integer. 0 will be
1181 returned if there is an error. For a method with error
1182 checking, see QueryIntAttribute()
1183 */
1184 int IntAttribute( const char* name ) const {
1185 int i=0;
1186 QueryIntAttribute( name, &i );
1187 return i;
1188 }
1189 /// See IntAttribute()
1190 unsigned UnsignedAttribute( const char* name ) const {
1191 unsigned i=0;
1192 QueryUnsignedAttribute( name, &i );
1193 return i;
1194 }
1195 /// See IntAttribute()
1196 bool BoolAttribute( const char* name ) const {
1197 bool b=false;
1198 QueryBoolAttribute( name, &b );
1199 return b;
1200 }
1201 /// See IntAttribute()
1202 double DoubleAttribute( const char* name ) const {
1203 double d=0;
1204 QueryDoubleAttribute( name, &d );
1205 return d;
1206 }
1207 /// See IntAttribute()
1208 float FloatAttribute( const char* name ) const {
1209 float f=0;
1210 QueryFloatAttribute( name, &f );
1211 return f;
1212 }
U-Stream\Lee09a11c52012-02-17 08:31:16 -08001213
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001214 /** Given an attribute name, QueryIntAttribute() returns
1215 XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion
1216 can't be performed, or XML_NO_ATTRIBUTE if the attribute
1217 doesn't exist. If successful, the result of the conversion
1218 will be written to 'value'. If not successful, nothing will
1219 be written to 'value'. This allows you to provide default
1220 value:
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001221
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001222 @verbatim
1223 int value = 10;
1224 QueryIntAttribute( "foo", &value ); // if "foo" isn't found, value will still be 10
1225 @endverbatim
1226 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001227 XMLError QueryIntAttribute( const char* name, int* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001228 const XMLAttribute* a = FindAttribute( name );
1229 if ( !a ) {
1230 return XML_NO_ATTRIBUTE;
1231 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001232 return a->QueryIntValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001233 }
1234 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001235 XMLError QueryUnsignedAttribute( const char* name, unsigned int* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001236 const XMLAttribute* a = FindAttribute( name );
1237 if ( !a ) {
1238 return XML_NO_ATTRIBUTE;
1239 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001240 return a->QueryUnsignedValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001241 }
1242 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001243 XMLError QueryBoolAttribute( const char* name, bool* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001244 const XMLAttribute* a = FindAttribute( name );
1245 if ( !a ) {
1246 return XML_NO_ATTRIBUTE;
1247 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001248 return a->QueryBoolValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001249 }
1250 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001251 XMLError QueryDoubleAttribute( const char* name, double* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001252 const XMLAttribute* a = FindAttribute( name );
1253 if ( !a ) {
1254 return XML_NO_ATTRIBUTE;
1255 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001256 return a->QueryDoubleValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001257 }
1258 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001259 XMLError QueryFloatAttribute( const char* name, float* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001260 const XMLAttribute* a = FindAttribute( name );
1261 if ( !a ) {
1262 return XML_NO_ATTRIBUTE;
1263 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001264 return a->QueryFloatValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001265 }
Lee Thomason50f97b22012-02-11 16:33:40 -08001266
Lee Thomason (grinliz)5efaa5f2013-02-01 19:26:30 -08001267
1268 /** Given an attribute name, QueryAttribute() returns
1269 XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion
1270 can't be performed, or XML_NO_ATTRIBUTE if the attribute
1271 doesn't exist. It is overloaded for the primitive types,
1272 and is a generally more convenient replacement of
1273 QueryIntAttribute() and related functions.
1274
1275 If successful, the result of the conversion
1276 will be written to 'value'. If not successful, nothing will
1277 be written to 'value'. This allows you to provide default
1278 value:
1279
1280 @verbatim
1281 int value = 10;
1282 QueryAttribute( "foo", &value ); // if "foo" isn't found, value will still be 10
1283 @endverbatim
1284 */
1285 int QueryAttribute( const char* name, int* value ) const {
1286 return QueryIntAttribute( name, value );
1287 }
1288
1289 int QueryAttribute( const char* name, unsigned int* value ) const {
1290 return QueryUnsignedAttribute( name, value );
1291 }
1292
1293 int QueryAttribute( const char* name, bool* value ) const {
1294 return QueryBoolAttribute( name, value );
1295 }
1296
1297 int QueryAttribute( const char* name, double* value ) const {
1298 return QueryDoubleAttribute( name, value );
1299 }
1300
1301 int QueryAttribute( const char* name, float* value ) const {
1302 return QueryFloatAttribute( name, value );
1303 }
1304
1305 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001306 void SetAttribute( const char* name, const char* value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001307 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001308 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001309 }
1310 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001311 void SetAttribute( const char* name, int value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001312 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001313 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001314 }
1315 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001316 void SetAttribute( const char* name, unsigned value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001317 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001318 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001319 }
1320 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001321 void SetAttribute( const char* name, bool value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001322 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001323 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001324 }
1325 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001326 void SetAttribute( const char* name, double value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001327 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001328 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001329 }
Lee Thomasonc3708cc2014-01-14 12:30:03 -08001330 /// Sets the named attribute to value.
1331 void SetAttribute( const char* name, float value ) {
1332 XMLAttribute* a = FindOrCreateAttribute( name );
1333 a->SetAttribute( value );
1334 }
Lee Thomason50f97b22012-02-11 16:33:40 -08001335
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001336 /**
1337 Delete an attribute.
1338 */
1339 void DeleteAttribute( const char* name );
Lee Thomason751da522012-02-10 08:50:51 -08001340
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001341 /// Return the first attribute in the list.
1342 const XMLAttribute* FirstAttribute() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001343 return _rootAttribute;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001344 }
1345 /// Query a specific attribute in the list.
1346 const XMLAttribute* FindAttribute( const char* name ) const;
Lee Thomason751da522012-02-10 08:50:51 -08001347
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001348 /** Convenience function for easy access to the text inside an element. Although easy
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001349 and concise, GetText() is limited compared to getting the XMLText child
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001350 and accessing it directly.
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001351
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001352 If the first child of 'this' is a XMLText, the GetText()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001353 returns the character string of the Text node, else null is returned.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001354
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001355 This is a convenient method for getting the text of simple contained text:
1356 @verbatim
1357 <foo>This is text</foo>
1358 const char* str = fooElement->GetText();
1359 @endverbatim
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001360
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001361 'str' will be a pointer to "This is text".
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001362
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001363 Note that this function can be misleading. If the element foo was created from
1364 this XML:
1365 @verbatim
1366 <foo><b>This is text</b></foo>
1367 @endverbatim
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001368
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001369 then the value of str would be null. The first child node isn't a text node, it is
1370 another element. From this XML:
1371 @verbatim
1372 <foo>This is <b>text</b></foo>
1373 @endverbatim
1374 GetText() will return "This is ".
1375 */
1376 const char* GetText() const;
Lee Thomason751da522012-02-10 08:50:51 -08001377
Uli Kusterer85fff5e2014-01-21 01:35:30 +01001378 /** Convenience function for easy access to the text inside an element. Although easy
1379 and concise, SetText() is limited compared to creating an XMLText child
1380 and mutating it directly.
1381
1382 If the first child of 'this' is a XMLText, SetText() sets its value to
1383 the given string, otherwise it will create a first child that is an XMLText.
1384
1385 This is a convenient method for setting the text of simple contained text:
1386 @verbatim
1387 <foo>This is text</foo>
1388 fooElement->SetText( "Hullaballoo!" );
1389 <foo>Hullaballoo!</foo>
1390 @endverbatim
1391
1392 Note that this function can be misleading. If the element foo was created from
1393 this XML:
1394 @verbatim
1395 <foo><b>This is text</b></foo>
1396 @endverbatim
1397
1398 then it will not change "This is text", but rather prefix it with a text element:
1399 @verbatim
1400 <foo>Hullaballoo!<b>This is text</b></foo>
1401 @endverbatim
1402
1403 For this XML:
1404 @verbatim
1405 <foo />
1406 @endverbatim
1407 SetText() will generate
1408 @verbatim
1409 <foo>Hullaballoo!</foo>
1410 @endverbatim
1411 */
Lee Thomason5bb2d802014-01-24 10:42:57 -08001412 void SetText( const char* inText );
Uli Kusterer35ce3092014-01-25 03:37:16 +01001413 /// Convenience method for setting text inside and element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001414 void SetText( int value );
Uli Kusterer35ce3092014-01-25 03:37:16 +01001415 /// Convenience method for setting text inside and element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001416 void SetText( unsigned value );
Uli Kusterer35ce3092014-01-25 03:37:16 +01001417 /// Convenience method for setting text inside and element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001418 void SetText( bool value );
Uli Kusterer35ce3092014-01-25 03:37:16 +01001419 /// Convenience method for setting text inside and element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001420 void SetText( double value );
Uli Kusterer35ce3092014-01-25 03:37:16 +01001421 /// Convenience method for setting text inside and element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001422 void SetText( float value );
Uli Kusterer4cd1f262014-01-21 02:54:36 +01001423
Uli Kusterer4cd1f262014-01-21 02:54:36 +01001424 /// Convenience for QueryIntText when you don't care if the text won't convert.
1425 int IntText()
1426 {
1427 int i = 0;
1428 QueryIntText( &i );
1429 return i;
1430 }
Uli Kustererdcefa0e2014-01-21 01:36:41 +01001431
Uli Kusterer4cd1f262014-01-21 02:54:36 +01001432 /// Convenience for QueryUnsignedText when you don't care if the text won't convert.
1433 unsigned UnsignedText()
1434 {
1435 unsigned i = 0;
1436 QueryUnsignedText( &i );
1437 return i;
1438 }
1439
1440 /// Convenience for QueryDoubleText when you don't care if the text won't convert.
1441 double DoubleText()
1442 {
1443 double i = 0;
1444 QueryDoubleText( &i );
1445 return i;
1446 }
1447
1448 /// Convenience for QueryFloatText when you don't care if the text won't convert.
1449 float FloatText()
1450 {
1451 float i = 0;
1452 QueryFloatText( &i );
1453 return i;
1454 }
Uli Kustererdcefa0e2014-01-21 01:36:41 +01001455
Uli Kustererc1c20bb2014-01-21 02:23:20 +01001456 /// Adds a sub-element equivalent to the given boolean.
Uli Kustererff8e2042014-01-21 02:53:47 +01001457 void SetBoolFirstChild( bool inBool );
Uli Kustererc1c20bb2014-01-21 02:23:20 +01001458
Uli Kustererff8e2042014-01-21 02:53:47 +01001459 /// Looks for a &lt;true /&gt; or &lt;false /&gt; as the first child and returns the corresponding bool.
1460 bool BoolFirstChild()
1461 {
1462 bool b = false;
1463 QueryBoolFirstChild(&b);
1464 return b;
1465 }
1466
1467 XMLError QueryBoolFirstChild( bool *outBool );
Uli Kustererc1c20bb2014-01-21 02:23:20 +01001468
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001469 /**
1470 Convenience method to query the value of a child text node. This is probably best
1471 shown by example. Given you have a document is this form:
1472 @verbatim
1473 <point>
1474 <x>1</x>
1475 <y>1.4</y>
1476 </point>
1477 @endverbatim
Lee Thomason21be8822012-07-15 17:27:22 -07001478
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001479 The QueryIntText() and similar functions provide a safe and easier way to get to the
1480 "value" of x and y.
Lee Thomason21be8822012-07-15 17:27:22 -07001481
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001482 @verbatim
1483 int x = 0;
1484 float y = 0; // types of x and y are contrived for example
1485 const XMLElement* xElement = pointElement->FirstChildElement( "x" );
1486 const XMLElement* yElement = pointElement->FirstChildElement( "y" );
1487 xElement->QueryIntText( &x );
1488 yElement->QueryFloatText( &y );
1489 @endverbatim
Lee Thomason21be8822012-07-15 17:27:22 -07001490
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001491 @returns XML_SUCCESS (0) on success, XML_CAN_NOT_CONVERT_TEXT if the text cannot be converted
1492 to the requested type, and XML_NO_TEXT_NODE if there is no child text to query.
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001493
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001494 */
MortenMacFly4ee49f12013-01-14 20:03:14 +01001495 XMLError QueryIntText( int* ival ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001496 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001497 XMLError QueryUnsignedText( unsigned* uval ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001498 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001499 XMLError QueryBoolText( bool* bval ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001500 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001501 XMLError QueryDoubleText( double* dval ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001502 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001503 XMLError QueryFloatText( float* fval ) const;
Lee Thomason21be8822012-07-15 17:27:22 -07001504
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001505 // internal:
1506 enum {
1507 OPEN, // <foo>
1508 CLOSED, // <foo/>
1509 CLOSING // </foo>
1510 };
1511 int ClosingType() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001512 return _closingType;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001513 }
1514 char* ParseDeep( char* p, StrPair* endTag );
1515 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
1516 virtual bool ShallowEqual( const XMLNode* compare ) const;
Uli Kusterer593a33d2014-02-01 12:48:51 +01001517
Lee Thomason50adb4c2012-02-13 15:07:09 -08001518private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001519 XMLElement( XMLDocument* doc );
1520 virtual ~XMLElement();
1521 XMLElement( const XMLElement& ); // not supported
1522 void operator=( const XMLElement& ); // not supported
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001523
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001524 XMLAttribute* FindAttribute( const char* name );
1525 XMLAttribute* FindOrCreateAttribute( const char* name );
1526 //void LinkAttribute( XMLAttribute* attrib );
1527 char* ParseAttributes( char* p );
Lee Thomason67d61312012-01-24 16:01:51 -08001528
Lee Thomason5bb2d802014-01-24 10:42:57 -08001529 enum { BUF_SIZE = 200 };
Lee Thomason624d43f2012-10-12 10:58:48 -07001530 int _closingType;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001531 // The attribute list is ordered; there is no 'lastAttribute'
1532 // because the list needs to be scanned for dupes before adding
1533 // a new attribute.
Lee Thomason624d43f2012-10-12 10:58:48 -07001534 XMLAttribute* _rootAttribute;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001535};
1536
1537
Lee Thomason (grinliz)bc1bfb72012-08-20 22:00:38 -07001538enum Whitespace {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001539 PRESERVE_WHITESPACE,
1540 COLLAPSE_WHITESPACE
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001541};
Lee Thomason (grinliz)bc1bfb72012-08-20 22:00:38 -07001542
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001543
1544/** A Document binds together all the functionality.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001545 It can be saved, loaded, and printed to the screen.
1546 All Nodes are connected and allocated to a Document.
1547 If the Document is deleted, all its Nodes are also deleted.
1548*/
PKEuS16ed47d2013-07-06 12:02:43 +02001549class TINYXML2_LIB XMLDocument : public XMLNode
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001550{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001551 friend class XMLElement;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001552public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001553 /// constructor
1554 XMLDocument( bool processEntities = true, Whitespace = PRESERVE_WHITESPACE );
1555 ~XMLDocument();
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001556
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001557 virtual XMLDocument* ToDocument() {
1558 return this;
1559 }
1560 virtual const XMLDocument* ToDocument() const {
1561 return this;
1562 }
Lee Thomason56bdd022012-02-09 18:16:58 -08001563
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001564 /**
1565 Parse an XML file from a character string.
1566 Returns XML_NO_ERROR (0) on success, or
1567 an errorID.
Lee Thomason (grinliz)e2bcb322012-09-17 17:58:25 -07001568
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001569 You may optionally pass in the 'nBytes', which is
1570 the number of bytes which will be parsed. If not
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001571 specified, TinyXML-2 will assume 'xml' points to a
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001572 null terminated string.
1573 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001574 XMLError Parse( const char* xml, size_t nBytes=(size_t)(-1) );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001575
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001576 /**
1577 Load an XML file from disk.
1578 Returns XML_NO_ERROR (0) on success, or
1579 an errorID.
1580 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001581 XMLError LoadFile( const char* filename );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001582
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001583 /**
1584 Load an XML file from disk. You are responsible
1585 for providing and closing the FILE*.
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001586
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001587 Returns XML_NO_ERROR (0) on success, or
1588 an errorID.
1589 */
Jerome Martinez242c3ea2013-01-06 12:20:04 +01001590 XMLError LoadFile( FILE* );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001591
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001592 /**
1593 Save the XML file to disk.
1594 Returns XML_NO_ERROR (0) on success, or
1595 an errorID.
1596 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001597 XMLError SaveFile( const char* filename, bool compact = false );
Lee Thomasond11cd162012-04-12 08:35:36 -07001598
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001599 /**
1600 Save the XML file to disk. You are responsible
1601 for providing and closing the FILE*.
Ken Miller81da1fb2012-04-09 23:32:26 -05001602
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001603 Returns XML_NO_ERROR (0) on success, or
1604 an errorID.
1605 */
Jerome Martinez242c3ea2013-01-06 12:20:04 +01001606 XMLError SaveFile( FILE* fp, bool compact = false );
Lee Thomason (grinliz)68db57e2012-02-21 09:08:12 -08001607
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001608 bool ProcessEntities() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001609 return _processEntities;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001610 }
1611 Whitespace WhitespaceMode() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001612 return _whitespace;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001613 }
Lee Thomason6f381b72012-03-02 12:59:39 -08001614
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001615 /**
1616 Returns true if this document has a leading Byte Order Mark of UTF8.
1617 */
1618 bool HasBOM() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001619 return _writeBOM;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001620 }
1621 /** Sets whether to write the BOM when writing the file.
1622 */
1623 void SetBOM( bool useBOM ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001624 _writeBOM = useBOM;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001625 }
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001626
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001627 /** Return the root element of DOM. Equivalent to FirstChildElement().
1628 To get the first node, use FirstChild().
1629 */
1630 XMLElement* RootElement() {
1631 return FirstChildElement();
1632 }
1633 const XMLElement* RootElement() const {
1634 return FirstChildElement();
1635 }
Lee Thomason18d68bd2012-01-26 18:17:26 -08001636
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001637 /** Print the Document. If the Printer is not provided, it will
1638 print to stdout. If you provide Printer, this can print to a file:
1639 @verbatim
1640 XMLPrinter printer( fp );
1641 doc.Print( &printer );
1642 @endverbatim
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001643
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001644 Or you can use a printer to print to memory:
1645 @verbatim
1646 XMLPrinter printer;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001647 doc.Print( &printer );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001648 // printer.CStr() has a const char* to the XML
1649 @endverbatim
1650 */
PKEuS1c5f99e2013-07-06 11:28:39 +02001651 void Print( XMLPrinter* streamer=0 ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001652 virtual bool Accept( XMLVisitor* visitor ) const;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001653
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001654 /**
1655 Create a new Element associated with
1656 this Document. The memory for the Element
1657 is managed by the Document.
1658 */
1659 XMLElement* NewElement( const char* name );
1660 /**
1661 Create a new Comment associated with
1662 this Document. The memory for the Comment
1663 is managed by the Document.
1664 */
1665 XMLComment* NewComment( const char* comment );
1666 /**
1667 Create a new Text associated with
1668 this Document. The memory for the Text
1669 is managed by the Document.
1670 */
1671 XMLText* NewText( const char* text );
1672 /**
1673 Create a new Declaration associated with
1674 this Document. The memory for the object
1675 is managed by the Document.
Lee Thomasonf68c4382012-04-28 14:37:11 -07001676
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001677 If the 'text' param is null, the standard
1678 declaration is used.:
1679 @verbatim
1680 <?xml version="1.0" encoding="UTF-8"?>
1681 @endverbatim
1682 */
1683 XMLDeclaration* NewDeclaration( const char* text=0 );
1684 /**
1685 Create a new Unknown associated with
Andrew C. Martin0fd87462013-03-09 20:09:45 -07001686 this Document. The memory for the object
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001687 is managed by the Document.
1688 */
1689 XMLUnknown* NewUnknown( const char* text );
Lee Thomason2c85a712012-01-31 08:24:24 -08001690
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001691 /**
1692 Delete a node associated with this document.
1693 It will be unlinked from the DOM.
1694 */
1695 void DeleteNode( XMLNode* node ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001696 node->_parent->DeleteChild( node );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001697 }
U-Stream\Leeae25a442012-02-17 17:48:16 -08001698
Lee Thomason2fa81722012-11-09 12:37:46 -08001699 void SetError( XMLError error, const char* str1, const char* str2 );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001700
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001701 /// Return true if there was an error parsing the document.
1702 bool Error() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001703 return _errorID != XML_NO_ERROR;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001704 }
1705 /// Return the errorID.
Lee Thomason2fa81722012-11-09 12:37:46 -08001706 XMLError ErrorID() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001707 return _errorID;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001708 }
1709 /// Return a possibly helpful diagnostic location or string.
1710 const char* GetErrorStr1() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001711 return _errorStr1;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001712 }
1713 /// Return a possibly helpful secondary diagnostic location or string.
1714 const char* GetErrorStr2() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001715 return _errorStr2;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001716 }
1717 /// If there is an error, print it to stdout.
1718 void PrintError() const;
Martinsh Shaitersa9d42b02013-01-30 11:14:27 +02001719
1720 /// Clear the document, resetting it to the initial state.
1721 void Clear();
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001722
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001723 // internal
1724 char* Identify( char* p, XMLNode** node );
Lee Thomason2c85a712012-01-31 08:24:24 -08001725
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001726 virtual XMLNode* ShallowClone( XMLDocument* /*document*/ ) const {
1727 return 0;
1728 }
1729 virtual bool ShallowEqual( const XMLNode* /*compare*/ ) const {
1730 return false;
1731 }
Lee Thomason7d00b9a2012-02-27 17:54:22 -08001732
Lee Thomason3f57d272012-01-11 15:30:03 -08001733private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001734 XMLDocument( const XMLDocument& ); // not supported
1735 void operator=( const XMLDocument& ); // not supported
Lee Thomason18d68bd2012-01-26 18:17:26 -08001736
Lee Thomason2fa81722012-11-09 12:37:46 -08001737 bool _writeBOM;
1738 bool _processEntities;
1739 XMLError _errorID;
1740 Whitespace _whitespace;
Lee Thomason624d43f2012-10-12 10:58:48 -07001741 const char* _errorStr1;
1742 const char* _errorStr2;
Lee Thomason2fa81722012-11-09 12:37:46 -08001743 char* _charBuffer;
Lee Thomasond1983222012-02-06 08:41:24 -08001744
Lee Thomason624d43f2012-10-12 10:58:48 -07001745 MemPoolT< sizeof(XMLElement) > _elementPool;
1746 MemPoolT< sizeof(XMLAttribute) > _attributePool;
1747 MemPoolT< sizeof(XMLText) > _textPool;
1748 MemPoolT< sizeof(XMLComment) > _commentPool;
Lee Thomason5cae8972012-01-24 18:03:07 -08001749};
1750
Lee Thomason7c913cd2012-01-26 18:32:34 -08001751
Lee Thomason3ffdd392012-03-28 17:27:55 -07001752/**
1753 A XMLHandle is a class that wraps a node pointer with null checks; this is
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001754 an incredibly useful thing. Note that XMLHandle is not part of the TinyXML-2
Lee Thomason3ffdd392012-03-28 17:27:55 -07001755 DOM structure. It is a separate utility class.
1756
1757 Take an example:
1758 @verbatim
1759 <Document>
1760 <Element attributeA = "valueA">
1761 <Child attributeB = "value1" />
1762 <Child attributeB = "value2" />
1763 </Element>
Thomas Roß08bdf502012-05-12 14:21:23 +02001764 </Document>
Lee Thomason3ffdd392012-03-28 17:27:55 -07001765 @endverbatim
1766
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001767 Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very
Lee Thomason3ffdd392012-03-28 17:27:55 -07001768 easy to write a *lot* of code that looks like:
1769
1770 @verbatim
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001771 XMLElement* root = document.FirstChildElement( "Document" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001772 if ( root )
1773 {
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001774 XMLElement* element = root->FirstChildElement( "Element" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001775 if ( element )
1776 {
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001777 XMLElement* child = element->FirstChildElement( "Child" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001778 if ( child )
1779 {
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001780 XMLElement* child2 = child->NextSiblingElement( "Child" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001781 if ( child2 )
1782 {
1783 // Finally do something useful.
1784 @endverbatim
1785
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001786 And that doesn't even cover "else" cases. XMLHandle addresses the verbosity
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001787 of such code. A XMLHandle checks for null pointers so it is perfectly safe
Lee Thomason3ffdd392012-03-28 17:27:55 -07001788 and correct to use:
1789
1790 @verbatim
Lee Thomasondb0bbb62012-04-04 15:47:04 -07001791 XMLHandle docHandle( &document );
1792 XMLElement* child2 = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).FirstChild().NextSibling().ToElement();
Lee Thomason3ffdd392012-03-28 17:27:55 -07001793 if ( child2 )
1794 {
1795 // do something useful
1796 @endverbatim
1797
1798 Which is MUCH more concise and useful.
1799
1800 It is also safe to copy handles - internally they are nothing more than node pointers.
1801 @verbatim
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001802 XMLHandle handleCopy = handle;
Lee Thomason3ffdd392012-03-28 17:27:55 -07001803 @endverbatim
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001804
1805 See also XMLConstHandle, which is the same as XMLHandle, but operates on const objects.
Lee Thomason3ffdd392012-03-28 17:27:55 -07001806*/
PKEuS16ed47d2013-07-06 12:02:43 +02001807class TINYXML2_LIB XMLHandle
Lee Thomason3ffdd392012-03-28 17:27:55 -07001808{
1809public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001810 /// Create a handle from any node (at any depth of the tree.) This can be a null pointer.
Lee Thomason624d43f2012-10-12 10:58:48 -07001811 XMLHandle( XMLNode* node ) {
1812 _node = node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001813 }
1814 /// Create a handle from a node.
Lee Thomason624d43f2012-10-12 10:58:48 -07001815 XMLHandle( XMLNode& node ) {
1816 _node = &node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001817 }
1818 /// Copy constructor
1819 XMLHandle( const XMLHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001820 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001821 }
1822 /// Assignment
1823 XMLHandle& operator=( const XMLHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001824 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001825 return *this;
1826 }
Lee Thomason3ffdd392012-03-28 17:27:55 -07001827
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001828 /// Get the first child of this handle.
1829 XMLHandle FirstChild() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001830 return XMLHandle( _node ? _node->FirstChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001831 }
1832 /// Get the first child element of this handle.
1833 XMLHandle FirstChildElement( const char* value=0 ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001834 return XMLHandle( _node ? _node->FirstChildElement( value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001835 }
1836 /// Get the last child of this handle.
1837 XMLHandle LastChild() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001838 return XMLHandle( _node ? _node->LastChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001839 }
1840 /// Get the last child element of this handle.
1841 XMLHandle LastChildElement( const char* _value=0 ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001842 return XMLHandle( _node ? _node->LastChildElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001843 }
1844 /// Get the previous sibling of this handle.
1845 XMLHandle PreviousSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001846 return XMLHandle( _node ? _node->PreviousSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001847 }
1848 /// Get the previous sibling element of this handle.
1849 XMLHandle PreviousSiblingElement( const char* _value=0 ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001850 return XMLHandle( _node ? _node->PreviousSiblingElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001851 }
1852 /// Get the next sibling of this handle.
1853 XMLHandle NextSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001854 return XMLHandle( _node ? _node->NextSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001855 }
1856 /// Get the next sibling element of this handle.
1857 XMLHandle NextSiblingElement( const char* _value=0 ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001858 return XMLHandle( _node ? _node->NextSiblingElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001859 }
Lee Thomason3ffdd392012-03-28 17:27:55 -07001860
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001861 /// Safe cast to XMLNode. This can return null.
1862 XMLNode* ToNode() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001863 return _node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001864 }
1865 /// Safe cast to XMLElement. This can return null.
1866 XMLElement* ToElement() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001867 return ( ( _node && _node->ToElement() ) ? _node->ToElement() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001868 }
1869 /// Safe cast to XMLText. This can return null.
1870 XMLText* ToText() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001871 return ( ( _node && _node->ToText() ) ? _node->ToText() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001872 }
1873 /// Safe cast to XMLUnknown. This can return null.
1874 XMLUnknown* ToUnknown() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001875 return ( ( _node && _node->ToUnknown() ) ? _node->ToUnknown() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001876 }
1877 /// Safe cast to XMLDeclaration. This can return null.
1878 XMLDeclaration* ToDeclaration() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001879 return ( ( _node && _node->ToDeclaration() ) ? _node->ToDeclaration() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001880 }
Lee Thomason3ffdd392012-03-28 17:27:55 -07001881
1882private:
Lee Thomason624d43f2012-10-12 10:58:48 -07001883 XMLNode* _node;
Lee Thomason3ffdd392012-03-28 17:27:55 -07001884};
1885
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001886
1887/**
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001888 A variant of the XMLHandle class for working with const XMLNodes and Documents. It is the
1889 same in all regards, except for the 'const' qualifiers. See XMLHandle for API.
Lee Thomason8b899812012-04-04 15:58:16 -07001890*/
PKEuS16ed47d2013-07-06 12:02:43 +02001891class TINYXML2_LIB XMLConstHandle
Lee Thomason8b899812012-04-04 15:58:16 -07001892{
1893public:
Lee Thomason624d43f2012-10-12 10:58:48 -07001894 XMLConstHandle( const XMLNode* node ) {
1895 _node = node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001896 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001897 XMLConstHandle( const XMLNode& node ) {
1898 _node = &node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001899 }
1900 XMLConstHandle( const XMLConstHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001901 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001902 }
Lee Thomason8b899812012-04-04 15:58:16 -07001903
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001904 XMLConstHandle& operator=( const XMLConstHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001905 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001906 return *this;
1907 }
Lee Thomason8b899812012-04-04 15:58:16 -07001908
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001909 const XMLConstHandle FirstChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001910 return XMLConstHandle( _node ? _node->FirstChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001911 }
1912 const XMLConstHandle FirstChildElement( const char* value=0 ) const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001913 return XMLConstHandle( _node ? _node->FirstChildElement( value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001914 }
1915 const XMLConstHandle LastChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001916 return XMLConstHandle( _node ? _node->LastChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001917 }
1918 const XMLConstHandle LastChildElement( const char* _value=0 ) const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001919 return XMLConstHandle( _node ? _node->LastChildElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001920 }
1921 const XMLConstHandle PreviousSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001922 return XMLConstHandle( _node ? _node->PreviousSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001923 }
1924 const XMLConstHandle PreviousSiblingElement( const char* _value=0 ) const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001925 return XMLConstHandle( _node ? _node->PreviousSiblingElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001926 }
1927 const XMLConstHandle NextSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001928 return XMLConstHandle( _node ? _node->NextSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001929 }
1930 const XMLConstHandle NextSiblingElement( const char* _value=0 ) const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001931 return XMLConstHandle( _node ? _node->NextSiblingElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001932 }
Lee Thomason8b899812012-04-04 15:58:16 -07001933
1934
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001935 const XMLNode* ToNode() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001936 return _node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001937 }
1938 const XMLElement* ToElement() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001939 return ( ( _node && _node->ToElement() ) ? _node->ToElement() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001940 }
1941 const XMLText* ToText() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001942 return ( ( _node && _node->ToText() ) ? _node->ToText() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001943 }
1944 const XMLUnknown* ToUnknown() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001945 return ( ( _node && _node->ToUnknown() ) ? _node->ToUnknown() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001946 }
1947 const XMLDeclaration* ToDeclaration() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001948 return ( ( _node && _node->ToDeclaration() ) ? _node->ToDeclaration() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001949 }
Lee Thomason (grinliz)bd0a8ac2012-02-20 20:14:33 -08001950
Lee Thomason5cae8972012-01-24 18:03:07 -08001951private:
Lee Thomason624d43f2012-10-12 10:58:48 -07001952 const XMLNode* _node;
Lee Thomason56bdd022012-02-09 18:16:58 -08001953};
Lee Thomason6f381b72012-03-02 12:59:39 -08001954
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001955
1956/**
1957 Printing functionality. The XMLPrinter gives you more
1958 options than the XMLDocument::Print() method.
1959
1960 It can:
1961 -# Print to memory.
Thomas Roß08bdf502012-05-12 14:21:23 +02001962 -# Print to a file you provide.
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001963 -# Print XML without a XMLDocument.
1964
1965 Print to Memory
1966
1967 @verbatim
1968 XMLPrinter printer;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001969 doc.Print( &printer );
Thomas Roß08bdf502012-05-12 14:21:23 +02001970 SomeFunction( printer.CStr() );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001971 @endverbatim
1972
1973 Print to a File
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001974
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001975 You provide the file pointer.
1976 @verbatim
1977 XMLPrinter printer( fp );
1978 doc.Print( &printer );
1979 @endverbatim
1980
1981 Print without a XMLDocument
1982
1983 When loading, an XML parser is very useful. However, sometimes
1984 when saving, it just gets in the way. The code is often set up
1985 for streaming, and constructing the DOM is just overhead.
1986
1987 The Printer supports the streaming case. The following code
1988 prints out a trivially simple XML file without ever creating
1989 an XML document.
1990
1991 @verbatim
1992 XMLPrinter printer( fp );
1993 printer.OpenElement( "foo" );
1994 printer.PushAttribute( "foo", "bar" );
1995 printer.CloseElement();
1996 @endverbatim
1997*/
PKEuS16ed47d2013-07-06 12:02:43 +02001998class TINYXML2_LIB XMLPrinter : public XMLVisitor
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001999{
2000public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002001 /** Construct the printer. If the FILE* is specified,
2002 this will print to the FILE. Else it will print
2003 to memory, and the result is available in CStr().
2004 If 'compact' is set to true, then output is created
2005 with only required whitespace and newlines.
2006 */
PKEuS1bfb9542013-08-04 13:51:17 +02002007 XMLPrinter( FILE* file=0, bool compact = false, int depth = 0 );
Dennis Jenkins59c75d32013-10-08 13:10:07 -05002008 virtual ~XMLPrinter() {}
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002009
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002010 /** If streaming, write the BOM and declaration. */
2011 void PushHeader( bool writeBOM, bool writeDeclaration );
2012 /** If streaming, start writing an element.
2013 The element must be closed with CloseElement()
2014 */
Uli Kusterer593a33d2014-02-01 12:48:51 +01002015 void OpenElement( const char* name, bool compactMode );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002016 /// If streaming, add an attribute to an open element.
2017 void PushAttribute( const char* name, const char* value );
2018 void PushAttribute( const char* name, int value );
2019 void PushAttribute( const char* name, unsigned value );
2020 void PushAttribute( const char* name, bool value );
2021 void PushAttribute( const char* name, double value );
2022 /// If streaming, close the Element.
Dennis Jenkins59c75d32013-10-08 13:10:07 -05002023 virtual void CloseElement();
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002024
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002025 /// Add a text node.
2026 void PushText( const char* text, bool cdata=false );
2027 /// Add a text node from an integer.
2028 void PushText( int value );
2029 /// Add a text node from an unsigned.
2030 void PushText( unsigned value );
2031 /// Add a text node from a bool.
2032 void PushText( bool value );
2033 /// Add a text node from a float.
2034 void PushText( float value );
2035 /// Add a text node from a double.
2036 void PushText( double value );
Lee Thomason21be8822012-07-15 17:27:22 -07002037
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002038 /// Add a comment
2039 void PushComment( const char* comment );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002040
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002041 void PushDeclaration( const char* value );
2042 void PushUnknown( const char* value );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002043
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002044 virtual bool VisitEnter( const XMLDocument& /*doc*/ );
2045 virtual bool VisitExit( const XMLDocument& /*doc*/ ) {
2046 return true;
2047 }
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002048
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002049 virtual bool VisitEnter( const XMLElement& element, const XMLAttribute* attribute );
2050 virtual bool VisitExit( const XMLElement& element );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002051
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002052 virtual bool Visit( const XMLText& text );
2053 virtual bool Visit( const XMLComment& comment );
2054 virtual bool Visit( const XMLDeclaration& declaration );
2055 virtual bool Visit( const XMLUnknown& unknown );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002056
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002057 /**
2058 If in print to memory mode, return a pointer to
2059 the XML file in memory.
2060 */
2061 const char* CStr() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07002062 return _buffer.Mem();
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002063 }
2064 /**
2065 If in print to memory mode, return the size
2066 of the XML file in memory. (Note the size returned
2067 includes the terminating null.)
2068 */
2069 int CStrSize() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07002070 return _buffer.Size();
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002071 }
Reinhard Klambauer3bc3d4e2013-11-22 14:05:21 +01002072 /**
2073 If in print to memory mode, reset the buffer to the
2074 beginning.
2075 */
Lee Thomasonce0510b2013-11-26 21:29:37 -08002076 void ClearBuffer() {
2077 _buffer.Clear();
Reinhard Klambauer3bc3d4e2013-11-22 14:05:21 +01002078 _buffer.Push(0);
2079 }
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002080
Dennis Jenkins59c75d32013-10-08 13:10:07 -05002081protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002082 void SealElement();
Dennis Jenkins59c75d32013-10-08 13:10:07 -05002083 bool _elementJustOpened;
2084 DynArray< const char*, 10 > _stack;
2085
2086private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002087 void PrintSpace( int depth );
2088 void PrintString( const char*, bool restrictedEntitySet ); // prints out, after detecting entities.
2089 void Print( const char* format, ... );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002090
Lee Thomason624d43f2012-10-12 10:58:48 -07002091 bool _firstElement;
Jerome Martinez242c3ea2013-01-06 12:20:04 +01002092 FILE* _fp;
Lee Thomason624d43f2012-10-12 10:58:48 -07002093 int _depth;
2094 int _textDepth;
2095 bool _processEntities;
2096 bool _compactMode;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002097
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002098 enum {
2099 ENTITY_RANGE = 64,
2100 BUF_SIZE = 200
2101 };
Lee Thomason624d43f2012-10-12 10:58:48 -07002102 bool _entityFlag[ENTITY_RANGE];
2103 bool _restrictedEntityFlag[ENTITY_RANGE];
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002104
Lee Thomason624d43f2012-10-12 10:58:48 -07002105 DynArray< char, 20 > _buffer;
PKEuSe736f292012-07-16 03:27:55 -07002106#ifdef _MSC_VER
Lee Thomason624d43f2012-10-12 10:58:48 -07002107 DynArray< char, 20 > _accumulator;
PKEuSe736f292012-07-16 03:27:55 -07002108#endif
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002109};
2110
2111
Guillermo A. Amaralb42ba362012-03-20 00:15:30 -07002112} // tinyxml2
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002113
PKEuS95060352013-07-26 10:42:44 +02002114#if defined(_MSC_VER)
2115# pragma warning(pop)
2116#endif
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002117
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002118#endif // TINYXML2_INCLUDED