blob: 6ef749315e7ca10f4eae79b6638c73d62f533b16 [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
pffang91d34a02014-07-10 10:02:35 +080094#if defined(_MSC_VER) && (_MSC_VER >= 1400 ) && (!defined WINCE)
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
pffang91d34a02014-07-10 10:02:35 +0800112#elif defined WINCE
113#define TIXML_SNPRINTF _snprintf
114#define TIXML_SSCANF sscanf
Lee Thomason (grinliz)b9e791f2012-04-06 21:27:10 -0700115#else
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700116// GCC version 3 and higher
117//#warning( "Using sn* functions." )
118#define TIXML_SNPRINTF snprintf
119#define TIXML_SSCANF sscanf
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800120#endif
Lee Thomason1ff38e02012-02-14 18:18:16 -0800121
Lee Thomasonc18eb232014-02-21 17:31:17 -0800122/* Versioning, past 1.0.14:
Lee Thomason85afe9c2014-02-23 21:42:16 -0800123 http://semver.org/
Lee Thomasonc18eb232014-02-21 17:31:17 -0800124*/
Lee Thomason85afe9c2014-02-23 21:42:16 -0800125static const int TIXML2_MAJOR_VERSION = 2;
Lee Thomason6ee53e72014-04-06 14:43:37 -0700126static const int TIXML2_MINOR_VERSION = 1;
127static const int TIXML2_PATCH_VERSION = 0;
Lee Thomason1ff38e02012-02-14 18:18:16 -0800128
U-Lama\Leee13c3e62011-12-28 14:36:55 -0800129namespace tinyxml2
130{
Lee Thomasonce0763e2012-01-11 15:43:54 -0800131class XMLDocument;
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800132class XMLElement;
133class XMLAttribute;
134class XMLComment;
Lee Thomason5492a1c2012-01-23 15:32:10 -0800135class XMLText;
Lee Thomason50f97b22012-02-11 16:33:40 -0800136class XMLDeclaration;
137class XMLUnknown;
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800138class XMLPrinter;
Lee Thomason5cae8972012-01-24 18:03:07 -0800139
U-Stream\Leeae25a442012-02-17 17:48:16 -0800140/*
141 A class that wraps strings. Normally stores the start and end
142 pointers into the XML file itself, and will apply normalization
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800143 and entity translation if actually read. Can also store (and memory
U-Stream\Leeae25a442012-02-17 17:48:16 -0800144 manage) a traditional char[]
145*/
PKEuS95060352013-07-26 10:42:44 +0200146class StrPair
Lee Thomason39ede242012-01-20 11:27:56 -0800147{
Lee Thomasond34f52c2012-01-20 12:55:24 -0800148public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700149 enum {
150 NEEDS_ENTITY_PROCESSING = 0x01,
151 NEEDS_NEWLINE_NORMALIZATION = 0x02,
selfpoisede77e1952013-03-13 14:08:29 +0800152 COLLAPSE_WHITESPACE = 0x04,
Lee Thomason18d68bd2012-01-26 18:17:26 -0800153
selfpoisede77e1952013-03-13 14:08:29 +0800154 TEXT_ELEMENT = NEEDS_ENTITY_PROCESSING | NEEDS_NEWLINE_NORMALIZATION,
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700155 TEXT_ELEMENT_LEAVE_ENTITIES = NEEDS_NEWLINE_NORMALIZATION,
selfpoisede77e1952013-03-13 14:08:29 +0800156 ATTRIBUTE_NAME = 0,
157 ATTRIBUTE_VALUE = NEEDS_ENTITY_PROCESSING | NEEDS_NEWLINE_NORMALIZATION,
158 ATTRIBUTE_VALUE_LEAVE_ENTITIES = NEEDS_NEWLINE_NORMALIZATION,
159 COMMENT = NEEDS_NEWLINE_NORMALIZATION
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700160 };
Lee Thomason39ede242012-01-20 11:27:56 -0800161
Lee Thomason120b3a62012-10-12 10:06:59 -0700162 StrPair() : _flags( 0 ), _start( 0 ), _end( 0 ) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700163 ~StrPair();
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800164
Lee Thomason120b3a62012-10-12 10:06:59 -0700165 void Set( char* start, char* end, int flags ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700166 Reset();
Lee Thomason120b3a62012-10-12 10:06:59 -0700167 _start = start;
168 _end = end;
169 _flags = flags | NEEDS_FLUSH;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700170 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700171
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700172 const char* GetStr();
Lee Thomason120b3a62012-10-12 10:06:59 -0700173
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700174 bool Empty() const {
Lee Thomason120b3a62012-10-12 10:06:59 -0700175 return _start == _end;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700176 }
Lee Thomason39ede242012-01-20 11:27:56 -0800177
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700178 void SetInternedStr( const char* str ) {
179 Reset();
Lee Thomason120b3a62012-10-12 10:06:59 -0700180 _start = const_cast<char*>(str);
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700181 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700182
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700183 void SetStr( const char* str, int flags=0 );
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800184
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700185 char* ParseText( char* in, const char* endTag, int strFlags );
186 char* ParseName( char* in );
Lee Thomason56bdd022012-02-09 18:16:58 -0800187
Lee Thomason39ede242012-01-20 11:27:56 -0800188private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700189 void Reset();
190 void CollapseWhitespace();
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800191
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700192 enum {
193 NEEDS_FLUSH = 0x100,
194 NEEDS_DELETE = 0x200
195 };
Lee Thomasone4422302012-01-20 17:59:50 -0800196
selfpoised4dd59bc2013-03-13 16:54:15 +0800197 // After parsing, if *_end != 0, it can be set to zero.
Lee Thomason120b3a62012-10-12 10:06:59 -0700198 int _flags;
199 char* _start;
200 char* _end;
Lee Thomason39ede242012-01-20 11:27:56 -0800201};
202
U-Lama\Lee560bd472011-12-28 19:42:49 -0800203
U-Stream\Leeae25a442012-02-17 17:48:16 -0800204/*
205 A dynamic array of Plain Old Data. Doesn't support constructors, etc.
206 Has a small initial memory pool, so that low or no usage will not
207 cause a call to new/delete
208*/
Lee Thomason2c85a712012-01-31 08:24:24 -0800209template <class T, int INIT>
PKEuS95060352013-07-26 10:42:44 +0200210class DynArray
Lee Thomason2c85a712012-01-31 08:24:24 -0800211{
212public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700213 DynArray< T, INIT >() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700214 _mem = _pool;
215 _allocated = INIT;
216 _size = 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700217 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700218
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700219 ~DynArray() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700220 if ( _mem != _pool ) {
Lee Thomasoned5c8792012-10-12 10:09:48 -0700221 delete [] _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700222 }
223 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700224
Lee Thomasonce0510b2013-11-26 21:29:37 -0800225 void Clear() {
Reinhard Klambauer4e74b132013-11-22 14:01:58 +0100226 _size = 0;
227 }
228
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700229 void Push( T t ) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700230 EnsureCapacity( _size+1 );
231 _mem[_size++] = t;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700232 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800233
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700234 T* PushArr( int count ) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700235 EnsureCapacity( _size+count );
236 T* ret = &_mem[_size];
237 _size += count;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700238 return ret;
239 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700240
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700241 T Pop() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700242 return _mem[--_size];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700243 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700244
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700245 void PopArr( int count ) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700246 TIXMLASSERT( _size >= count );
247 _size -= count;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700248 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800249
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700250 bool Empty() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700251 return _size == 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700252 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700253
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700254 T& operator[](int i) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700255 TIXMLASSERT( i>= 0 && i < _size );
Lee Thomasoned5c8792012-10-12 10:09:48 -0700256 return _mem[i];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700257 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700258
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700259 const T& operator[](int i) const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700260 TIXMLASSERT( i>= 0 && i < _size );
Lee Thomasoned5c8792012-10-12 10:09:48 -0700261 return _mem[i];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700262 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700263
Dennis Jenkins59c75d32013-10-08 13:10:07 -0500264 const T& PeekTop() const {
265 TIXMLASSERT( _size > 0 );
266 return _mem[ _size - 1];
267 }
268
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700269 int Size() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700270 return _size;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700271 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700272
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700273 int Capacity() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700274 return _allocated;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700275 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700276
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700277 const T* Mem() const {
Lee Thomasoned5c8792012-10-12 10:09:48 -0700278 return _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700279 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700280
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700281 T* Mem() {
Lee Thomasoned5c8792012-10-12 10:09:48 -0700282 return _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700283 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800284
Lee Thomason2c85a712012-01-31 08:24:24 -0800285private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700286 void EnsureCapacity( int cap ) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700287 if ( cap > _allocated ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700288 int newAllocated = cap * 2;
289 T* newMem = new T[newAllocated];
Lee Thomason624d43f2012-10-12 10:58:48 -0700290 memcpy( newMem, _mem, sizeof(T)*_size ); // warning: not using constructors, only works for PODs
291 if ( _mem != _pool ) {
Lee Thomasoned5c8792012-10-12 10:09:48 -0700292 delete [] _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700293 }
Lee Thomasoned5c8792012-10-12 10:09:48 -0700294 _mem = newMem;
Lee Thomason624d43f2012-10-12 10:58:48 -0700295 _allocated = newAllocated;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700296 }
297 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800298
Lee Thomason624d43f2012-10-12 10:58:48 -0700299 T* _mem;
300 T _pool[INIT];
301 int _allocated; // objects allocated
302 int _size; // number objects in use
Lee Thomason2c85a712012-01-31 08:24:24 -0800303};
304
Lee Thomason50adb4c2012-02-13 15:07:09 -0800305
U-Stream\Leeae25a442012-02-17 17:48:16 -0800306/*
Thomas Roß08bdf502012-05-12 14:21:23 +0200307 Parent virtual class of a pool for fast allocation
U-Stream\Leeae25a442012-02-17 17:48:16 -0800308 and deallocation of objects.
309*/
PKEuS95060352013-07-26 10:42:44 +0200310class MemPool
Lee Thomasond1983222012-02-06 08:41:24 -0800311{
312public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700313 MemPool() {}
314 virtual ~MemPool() {}
Lee Thomasond1983222012-02-06 08:41:24 -0800315
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700316 virtual int ItemSize() const = 0;
317 virtual void* Alloc() = 0;
318 virtual void Free( void* ) = 0;
Lee Thomason5b0a6772012-11-19 13:54:42 -0800319 virtual void SetTracked() = 0;
Lee Thomasond1983222012-02-06 08:41:24 -0800320};
321
Lee Thomason50adb4c2012-02-13 15:07:09 -0800322
U-Stream\Leeae25a442012-02-17 17:48:16 -0800323/*
324 Template child class to create pools of the correct type.
325*/
Lee Thomasond1983222012-02-06 08:41:24 -0800326template< int SIZE >
PKEuS95060352013-07-26 10:42:44 +0200327class MemPoolT : public MemPool
Lee Thomasond1983222012-02-06 08:41:24 -0800328{
329public:
Lee Thomason5b0a6772012-11-19 13:54:42 -0800330 MemPoolT() : _root(0), _currentAllocs(0), _nAllocs(0), _maxAllocs(0), _nUntracked(0) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700331 ~MemPoolT() {
332 // Delete the blocks.
Lee Thomason624d43f2012-10-12 10:58:48 -0700333 for( int i=0; i<_blockPtrs.Size(); ++i ) {
334 delete _blockPtrs[i];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700335 }
336 }
Lee Thomasond1983222012-02-06 08:41:24 -0800337
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700338 virtual int ItemSize() const {
339 return SIZE;
340 }
341 int CurrentAllocs() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700342 return _currentAllocs;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700343 }
Lee Thomasond1983222012-02-06 08:41:24 -0800344
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700345 virtual void* Alloc() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700346 if ( !_root ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700347 // Need a new block.
348 Block* block = new Block();
Lee Thomason624d43f2012-10-12 10:58:48 -0700349 _blockPtrs.Push( block );
Lee Thomasond1983222012-02-06 08:41:24 -0800350
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700351 for( int i=0; i<COUNT-1; ++i ) {
352 block->chunk[i].next = &block->chunk[i+1];
353 }
354 block->chunk[COUNT-1].next = 0;
Lee Thomason624d43f2012-10-12 10:58:48 -0700355 _root = block->chunk;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700356 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700357 void* result = _root;
358 _root = _root->next;
Lee Thomason455c9d42012-02-06 09:14:14 -0800359
Lee Thomason624d43f2012-10-12 10:58:48 -0700360 ++_currentAllocs;
361 if ( _currentAllocs > _maxAllocs ) {
362 _maxAllocs = _currentAllocs;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700363 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700364 _nAllocs++;
Lee Thomason5b0a6772012-11-19 13:54:42 -0800365 _nUntracked++;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700366 return result;
367 }
368 virtual void Free( void* mem ) {
369 if ( !mem ) {
370 return;
371 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700372 --_currentAllocs;
Dmitry-Me56571762014-08-15 11:03:47 +0400373 Chunk* chunk = static_cast<Chunk*>( mem );
Lee Thomason (grinliz)6020a012012-09-08 21:15:09 -0700374#ifdef DEBUG
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700375 memset( chunk, 0xfe, sizeof(Chunk) );
Lee Thomason (grinliz)6020a012012-09-08 21:15:09 -0700376#endif
Lee Thomason624d43f2012-10-12 10:58:48 -0700377 chunk->next = _root;
378 _root = chunk;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700379 }
380 void Trace( const char* name ) {
381 printf( "Mempool %s watermark=%d [%dk] current=%d size=%d nAlloc=%d blocks=%d\n",
Lee Thomason624d43f2012-10-12 10:58:48 -0700382 name, _maxAllocs, _maxAllocs*SIZE/1024, _currentAllocs, SIZE, _nAllocs, _blockPtrs.Size() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700383 }
Lee Thomasond1983222012-02-06 08:41:24 -0800384
Lee Thomason5b0a6772012-11-19 13:54:42 -0800385 void SetTracked() {
386 _nUntracked--;
387 }
388
389 int Untracked() const {
390 return _nUntracked;
391 }
392
Lee Thomason (grinliz)ac83b4e2013-02-01 09:02:34 -0800393 // This number is perf sensitive. 4k seems like a good tradeoff on my machine.
394 // The test file is large, 170k.
395 // Release: VS2010 gcc(no opt)
396 // 1k: 4000
397 // 2k: 4000
398 // 4k: 3900 21000
399 // 16k: 5200
400 // 32k: 4300
401 // 64k: 4000 21000
402 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 +0200403
Lee Thomasond1983222012-02-06 08:41:24 -0800404private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700405 union Chunk {
Lee Thomason624d43f2012-10-12 10:58:48 -0700406 Chunk* next;
407 char mem[SIZE];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700408 };
409 struct Block {
Lee Thomason (grinliz)856da212012-10-19 09:08:15 -0700410 Chunk chunk[COUNT];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700411 };
Lee Thomason624d43f2012-10-12 10:58:48 -0700412 DynArray< Block*, 10 > _blockPtrs;
413 Chunk* _root;
Lee Thomason455c9d42012-02-06 09:14:14 -0800414
Lee Thomason624d43f2012-10-12 10:58:48 -0700415 int _currentAllocs;
416 int _nAllocs;
417 int _maxAllocs;
Lee Thomason5b0a6772012-11-19 13:54:42 -0800418 int _nUntracked;
Lee Thomasond1983222012-02-06 08:41:24 -0800419};
420
Lee Thomason2c85a712012-01-31 08:24:24 -0800421
Lee Thomason56bdd022012-02-09 18:16:58 -0800422
423/**
424 Implements the interface to the "Visitor pattern" (see the Accept() method.)
425 If you call the Accept() method, it requires being passed a XMLVisitor
426 class to handle callbacks. For nodes that contain other nodes (Document, Element)
Thomas Roß08bdf502012-05-12 14:21:23 +0200427 you will get called with a VisitEnter/VisitExit pair. Nodes that are always leafs
Lee Thomason56bdd022012-02-09 18:16:58 -0800428 are simply called with Visit().
429
430 If you return 'true' from a Visit method, recursive parsing will continue. If you return
Andrew C. Martin0fd87462013-03-09 20:09:45 -0700431 false, <b>no children of this node or its siblings</b> will be visited.
Lee Thomason56bdd022012-02-09 18:16:58 -0800432
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700433 All flavors of Visit methods have a default implementation that returns 'true' (continue
Lee Thomason56bdd022012-02-09 18:16:58 -0800434 visiting). You need to only override methods that are interesting to you.
435
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600436 Generally Accept() is called on the XMLDocument, although all nodes support visiting.
Lee Thomason56bdd022012-02-09 18:16:58 -0800437
438 You should never change the document from a callback.
439
440 @sa XMLNode::Accept()
441*/
PKEuS16ed47d2013-07-06 12:02:43 +0200442class TINYXML2_LIB XMLVisitor
U-Lama\Leee13c3e62011-12-28 14:36:55 -0800443{
444public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700445 virtual ~XMLVisitor() {}
Lee Thomasond1983222012-02-06 08:41:24 -0800446
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700447 /// Visit a document.
448 virtual bool VisitEnter( const XMLDocument& /*doc*/ ) {
449 return true;
450 }
451 /// Visit a document.
452 virtual bool VisitExit( const XMLDocument& /*doc*/ ) {
453 return true;
454 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800455
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700456 /// Visit an element.
457 virtual bool VisitEnter( const XMLElement& /*element*/, const XMLAttribute* /*firstAttribute*/ ) {
458 return true;
459 }
460 /// Visit an element.
461 virtual bool VisitExit( const XMLElement& /*element*/ ) {
462 return true;
463 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800464
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700465 /// Visit a declaration.
466 virtual bool Visit( const XMLDeclaration& /*declaration*/ ) {
467 return true;
468 }
469 /// Visit a text node.
470 virtual bool Visit( const XMLText& /*text*/ ) {
471 return true;
472 }
473 /// Visit a comment node.
474 virtual bool Visit( const XMLComment& /*comment*/ ) {
475 return true;
476 }
477 /// Visit an unknown node.
478 virtual bool Visit( const XMLUnknown& /*unknown*/ ) {
479 return true;
480 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800481};
482
numatrumpetbb5ffac2014-09-06 22:56:46 +0900483#define FOR_EACH(F) \
484 F(XML_SUCCESS) \
485 F(XML_NO_ATTRIBUTE) \
486 F(XML_WRONG_ATTRIBUTE_TYPE) \
487 F(XML_ERROR_FILE_NOT_FOUND) \
488 F(XML_ERROR_FILE_COULD_NOT_BE_OPENED) \
489 F(XML_ERROR_FILE_READ_ERROR) \
490 F(XML_ERROR_ELEMENT_MISMATCH) \
491 F(XML_ERROR_PARSING_ELEMENT) \
492 F(XML_ERROR_PARSING_ATTRIBUTE) \
493 F(XML_ERROR_IDENTIFYING_TAG) \
494 F(XML_ERROR_PARSING_TEXT) \
495 F(XML_ERROR_PARSING_CDATA) \
496 F(XML_ERROR_PARSING_COMMENT) \
497 F(XML_ERROR_PARSING_DECLARATION) \
498 F(XML_ERROR_PARSING_UNKNOWN) \
499 F(XML_ERROR_EMPTY_DOCUMENT) \
500 F(XML_ERROR_MISMATCHED_ELEMENT) \
501 F(XML_ERROR_PARSING) \
502 F(XML_CAN_NOT_CONVERT_TEXT) \
503 F(XML_NO_TEXT_NODE)
504
505#define FF(X) X,
506enum XMLError {
507 FOR_EACH(FF)
508 XML_ERROR_ID_NUM,
509 XML_NO_ERROR = 0
510};
511#undef FF
512
numatrumpetbb5ffac2014-09-06 22:56:46 +0900513#define FF(X) #X,
numatrumpet00336842014-09-08 16:36:28 +0900514static const char *ErrorNames[] = {
numatrumpetbb5ffac2014-09-06 22:56:46 +0900515 FOR_EACH(FF)
516 "OUT_OF_RANGE"
517};
518#undef FF
numatrumpetbb5ffac2014-09-06 22:56:46 +0900519#undef FOR_EACH
520
Lee Thomason56bdd022012-02-09 18:16:58 -0800521
U-Stream\Leeae25a442012-02-17 17:48:16 -0800522/*
523 Utility functionality.
524*/
Lee Thomason56bdd022012-02-09 18:16:58 -0800525class XMLUtil
526{
Lee Thomasond1983222012-02-06 08:41:24 -0800527public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700528 // Anything in the high order range of UTF-8 is assumed to not be whitespace. This isn't
529 // correct, but simple, and usually works.
530 static const char* SkipWhiteSpace( const char* p ) {
Jerome Martinez242c3ea2013-01-06 12:20:04 +0100531 while( !IsUTF8Continuation(*p) && isspace( *reinterpret_cast<const unsigned char*>(p) ) ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700532 ++p;
533 }
534 return p;
535 }
536 static char* SkipWhiteSpace( char* p ) {
Jerome Martinez242c3ea2013-01-06 12:20:04 +0100537 while( !IsUTF8Continuation(*p) && isspace( *reinterpret_cast<unsigned char*>(p) ) ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700538 ++p;
539 }
540 return p;
541 }
542 static bool IsWhiteSpace( char p ) {
Jerome Martinez242c3ea2013-01-06 12:20:04 +0100543 return !IsUTF8Continuation(p) && isspace( static_cast<unsigned char>(p) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700544 }
Martinsh Shaitersc6d02f42013-01-26 21:22:57 +0200545
546 inline static bool IsNameStartChar( unsigned char ch ) {
547 return ( ( ch < 128 ) ? isalpha( ch ) : 1 )
548 || ch == ':'
549 || ch == '_';
550 }
551
552 inline static bool IsNameChar( unsigned char ch ) {
553 return IsNameStartChar( ch )
554 || isdigit( ch )
555 || ch == '.'
556 || ch == '-';
557 }
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800558
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700559 inline static bool StringEqual( const char* p, const char* q, int nChar=INT_MAX ) {
560 int n = 0;
561 if ( p == q ) {
562 return true;
563 }
564 while( *p && *q && *p == *q && n<nChar ) {
565 ++p;
566 ++q;
567 ++n;
568 }
569 if ( (n == nChar) || ( *p == 0 && *q == 0 ) ) {
570 return true;
571 }
572 return false;
573 }
Martinsh Shaitersc6d02f42013-01-26 21:22:57 +0200574
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700575 inline static int IsUTF8Continuation( const char p ) {
576 return p & 0x80;
577 }
Lee Thomason (grinliz)68db57e2012-02-21 09:08:12 -0800578
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700579 static const char* ReadBOM( const char* p, bool* hasBOM );
580 // p is the starting location,
581 // the UTF-8 value of the entity will be placed in value, and length filled in.
582 static const char* GetCharacterRef( const char* p, char* value, int* length );
583 static void ConvertUTF32ToUTF8( unsigned long input, char* output, int* length );
Lee Thomason21be8822012-07-15 17:27:22 -0700584
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700585 // converts primitive types to strings
586 static void ToStr( int v, char* buffer, int bufferSize );
587 static void ToStr( unsigned v, char* buffer, int bufferSize );
588 static void ToStr( bool v, char* buffer, int bufferSize );
589 static void ToStr( float v, char* buffer, int bufferSize );
590 static void ToStr( double v, char* buffer, int bufferSize );
Lee Thomason21be8822012-07-15 17:27:22 -0700591
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700592 // converts strings to primitive types
593 static bool ToInt( const char* str, int* value );
594 static bool ToUnsigned( const char* str, unsigned* value );
595 static bool ToBool( const char* str, bool* value );
596 static bool ToFloat( const char* str, float* value );
597 static bool ToDouble( const char* str, double* value );
numatrumpetbb5ffac2014-09-06 22:56:46 +0900598
599 // converts XMLError to strings
numatrumpet00336842014-09-08 16:36:28 +0900600 static const char* ToErrorName( const XMLError errorID );
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800601};
602
Lee Thomason5cae8972012-01-24 18:03:07 -0800603
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800604/** XMLNode is a base class for every object that is in the
605 XML Document Object Model (DOM), except XMLAttributes.
606 Nodes have siblings, a parent, and children which can
607 be navigated. A node is always in a XMLDocument.
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700608 The type of a XMLNode can be queried, and it can
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800609 be cast to its more defined type.
610
Thomas Roß08bdf502012-05-12 14:21:23 +0200611 A XMLDocument allocates memory for all its Nodes.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800612 When the XMLDocument gets deleted, all its Nodes
613 will also be deleted.
614
615 @verbatim
616 A Document can contain: Element (container or leaf)
617 Comment (leaf)
618 Unknown (leaf)
619 Declaration( leaf )
620
621 An Element can contain: Element (container or leaf)
622 Text (leaf)
623 Attributes (not on tree)
624 Comment (leaf)
625 Unknown (leaf)
626
627 @endverbatim
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800628*/
PKEuS16ed47d2013-07-06 12:02:43 +0200629class TINYXML2_LIB XMLNode
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800630{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700631 friend class XMLDocument;
632 friend class XMLElement;
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800633public:
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800634
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700635 /// Get the XMLDocument that owns this XMLNode.
636 const XMLDocument* GetDocument() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700637 return _document;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700638 }
639 /// Get the XMLDocument that owns this XMLNode.
640 XMLDocument* GetDocument() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700641 return _document;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700642 }
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800643
Lee Thomason2fa81722012-11-09 12:37:46 -0800644 /// Safely cast to an Element, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700645 virtual XMLElement* ToElement() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100646 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700647 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800648 /// Safely cast to Text, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700649 virtual XMLText* ToText() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100650 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700651 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800652 /// Safely cast to a Comment, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700653 virtual XMLComment* ToComment() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100654 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700655 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800656 /// Safely cast to a Document, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700657 virtual XMLDocument* ToDocument() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100658 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700659 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800660 /// Safely cast to a Declaration, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700661 virtual XMLDeclaration* ToDeclaration() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100662 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700663 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800664 /// Safely cast to an Unknown, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700665 virtual XMLUnknown* ToUnknown() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100666 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700667 }
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800668
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700669 virtual const XMLElement* ToElement() const {
670 return 0;
671 }
672 virtual const XMLText* ToText() const {
673 return 0;
674 }
675 virtual const XMLComment* ToComment() const {
676 return 0;
677 }
678 virtual const XMLDocument* ToDocument() const {
679 return 0;
680 }
681 virtual const XMLDeclaration* ToDeclaration() const {
682 return 0;
683 }
684 virtual const XMLUnknown* ToUnknown() const {
685 return 0;
686 }
Lee Thomason751da522012-02-10 08:50:51 -0800687
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700688 /** The meaning of 'value' changes for the specific type.
689 @verbatim
690 Document: empty
691 Element: name of the element
692 Comment: the comment text
693 Unknown: the tag contents
694 Text: the text string
695 @endverbatim
696 */
Michael Daumling21626882013-10-22 17:03:37 +0200697 const char* Value() const;
MortenMacFly4ee49f12013-01-14 20:03:14 +0100698
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700699 /** Set the Value of an XML node.
700 @sa Value()
701 */
702 void SetValue( const char* val, bool staticMem=false );
Lee Thomason2c85a712012-01-31 08:24:24 -0800703
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700704 /// Get the parent of this node on the DOM.
705 const XMLNode* Parent() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700706 return _parent;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700707 }
MortenMacFly4ee49f12013-01-14 20:03:14 +0100708
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700709 XMLNode* Parent() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700710 return _parent;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700711 }
Lee Thomason751da522012-02-10 08:50:51 -0800712
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700713 /// Returns true if this node has no children.
714 bool NoChildren() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700715 return !_firstChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700716 }
Lee Thomason751da522012-02-10 08:50:51 -0800717
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700718 /// Get the first child node, or null if none exists.
719 const XMLNode* FirstChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700720 return _firstChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700721 }
MortenMacFly4ee49f12013-01-14 20:03:14 +0100722
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700723 XMLNode* FirstChild() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700724 return _firstChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700725 }
MortenMacFly4ee49f12013-01-14 20:03:14 +0100726
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700727 /** Get the first child element, or optionally the first child
728 element with the specified name.
729 */
730 const XMLElement* FirstChildElement( const char* value=0 ) const;
Lee Thomason624d43f2012-10-12 10:58:48 -0700731
732 XMLElement* FirstChildElement( const char* value=0 ) {
733 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->FirstChildElement( value ));
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700734 }
Lee Thomason3f57d272012-01-11 15:30:03 -0800735
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700736 /// Get the last child node, or null if none exists.
737 const XMLNode* LastChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700738 return _lastChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700739 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700740
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700741 XMLNode* LastChild() {
742 return const_cast<XMLNode*>(const_cast<const XMLNode*>(this)->LastChild() );
743 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800744
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700745 /** Get the last child element or optionally the last child
746 element with the specified name.
747 */
748 const XMLElement* LastChildElement( const char* value=0 ) const;
Lee Thomason624d43f2012-10-12 10:58:48 -0700749
750 XMLElement* LastChildElement( const char* value=0 ) {
751 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->LastChildElement(value) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700752 }
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700753
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700754 /// Get the previous (left) sibling node of this node.
755 const XMLNode* PreviousSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700756 return _prev;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700757 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700758
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700759 XMLNode* PreviousSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700760 return _prev;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700761 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800762
Andrew C. Martin0fd87462013-03-09 20:09:45 -0700763 /// Get the previous (left) sibling element of this node, with an optionally supplied name.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700764 const XMLElement* PreviousSiblingElement( const char* value=0 ) const ;
Lee Thomason624d43f2012-10-12 10:58:48 -0700765
766 XMLElement* PreviousSiblingElement( const char* value=0 ) {
767 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->PreviousSiblingElement( value ) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700768 }
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700769
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700770 /// Get the next (right) sibling node of this node.
771 const XMLNode* NextSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700772 return _next;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700773 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700774
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700775 XMLNode* NextSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700776 return _next;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700777 }
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700778
Andrew C. Martin0fd87462013-03-09 20:09:45 -0700779 /// Get the next (right) sibling element of this node, with an optionally supplied name.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700780 const XMLElement* NextSiblingElement( const char* value=0 ) const;
Lee Thomason624d43f2012-10-12 10:58:48 -0700781
782 XMLElement* NextSiblingElement( const char* value=0 ) {
783 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->NextSiblingElement( value ) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700784 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800785
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700786 /**
787 Add a child node as the last (right) child.
Michael Daumlinged523282013-10-23 07:47:29 +0200788 If the child node is already part of the document,
789 it is moved from its old location to the new location.
790 Returns the addThis argument or 0 if the node does not
791 belong to the same document.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700792 */
793 XMLNode* InsertEndChild( XMLNode* addThis );
Lee Thomason618dbf82012-02-28 12:34:27 -0800794
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700795 XMLNode* LinkEndChild( XMLNode* addThis ) {
796 return InsertEndChild( addThis );
797 }
798 /**
799 Add a child node as the first (left) child.
Michael Daumlinged523282013-10-23 07:47:29 +0200800 If the child node is already part of the document,
801 it is moved from its old location to the new location.
802 Returns the addThis argument or 0 if the node does not
803 belong to the same document.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700804 */
805 XMLNode* InsertFirstChild( XMLNode* addThis );
806 /**
807 Add a node after the specified child node.
Michael Daumlinged523282013-10-23 07:47:29 +0200808 If the child node is already part of the document,
809 it is moved from its old location to the new location.
810 Returns the addThis argument or 0 if the afterThis node
811 is not a child of this node, or if the node does not
812 belong to the same document.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700813 */
814 XMLNode* InsertAfterChild( XMLNode* afterThis, XMLNode* addThis );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700815
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700816 /**
817 Delete all the children of this node.
818 */
819 void DeleteChildren();
U-Stream\Leeae25a442012-02-17 17:48:16 -0800820
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700821 /**
822 Delete a child of this node.
823 */
824 void DeleteChild( XMLNode* node );
Lee Thomason56bdd022012-02-09 18:16:58 -0800825
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700826 /**
827 Make a copy of this node, but not its children.
828 You may pass in a Document pointer that will be
829 the owner of the new Node. If the 'document' is
830 null, then the node returned will be allocated
831 from the current Document. (this->GetDocument())
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800832
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700833 Note: if called on a XMLDocument, this will return null.
834 */
835 virtual XMLNode* ShallowClone( XMLDocument* document ) const = 0;
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800836
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700837 /**
838 Test if 2 nodes are the same, but don't test children.
839 The 2 nodes do not need to be in the same Document.
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800840
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700841 Note: if called on a XMLDocument, this will return false.
842 */
843 virtual bool ShallowEqual( const XMLNode* compare ) const = 0;
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800844
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600845 /** Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700846 XML tree will be conditionally visited and the host will be called back
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600847 via the XMLVisitor interface.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800848
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600849 This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse
850 the XML for the callbacks, so the performance of TinyXML-2 is unchanged by using this
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700851 interface versus any other.)
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800852
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700853 The interface has been based on ideas from:
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800854
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700855 - http://www.saxproject.org/
856 - http://c2.com/cgi/wiki?HierarchicalVisitorPattern
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800857
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700858 Which are both good references for "visiting".
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800859
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700860 An example of using Accept():
861 @verbatim
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600862 XMLPrinter printer;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700863 tinyxmlDoc.Accept( &printer );
864 const char* xmlcstr = printer.CStr();
865 @endverbatim
866 */
867 virtual bool Accept( XMLVisitor* visitor ) const = 0;
Lee Thomason56bdd022012-02-09 18:16:58 -0800868
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700869 // internal
870 virtual char* ParseDeep( char*, StrPair* );
Lee Thomason3f57d272012-01-11 15:30:03 -0800871
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800872protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700873 XMLNode( XMLDocument* );
874 virtual ~XMLNode();
875 XMLNode( const XMLNode& ); // not supported
876 XMLNode& operator=( const XMLNode& ); // not supported
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700877
Lee Thomason624d43f2012-10-12 10:58:48 -0700878 XMLDocument* _document;
879 XMLNode* _parent;
880 mutable StrPair _value;
Lee Thomason3f57d272012-01-11 15:30:03 -0800881
Lee Thomason624d43f2012-10-12 10:58:48 -0700882 XMLNode* _firstChild;
883 XMLNode* _lastChild;
Lee Thomason3f57d272012-01-11 15:30:03 -0800884
Lee Thomason624d43f2012-10-12 10:58:48 -0700885 XMLNode* _prev;
886 XMLNode* _next;
Lee Thomason3f57d272012-01-11 15:30:03 -0800887
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800888private:
Lee Thomason624d43f2012-10-12 10:58:48 -0700889 MemPool* _memPool;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700890 void Unlink( XMLNode* child );
Dmitry-Mee3225b12014-09-03 11:03:11 +0400891 static void DeleteNode( XMLNode* node );
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800892};
893
894
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800895/** XML text.
896
897 Note that a text node can have child element nodes, for example:
898 @verbatim
899 <root>This is <b>bold</b></root>
900 @endverbatim
901
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700902 A text node can have 2 ways to output the next. "normal" output
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800903 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 -0700904 you generally want to leave it alone, but you can change the output mode with
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600905 SetCData() and query it with CData().
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800906*/
PKEuS16ed47d2013-07-06 12:02:43 +0200907class TINYXML2_LIB XMLText : public XMLNode
Lee Thomason5492a1c2012-01-23 15:32:10 -0800908{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700909 friend class XMLBase;
910 friend class XMLDocument;
Lee Thomason5492a1c2012-01-23 15:32:10 -0800911public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700912 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason50adb4c2012-02-13 15:07:09 -0800913
Lee Thomason624d43f2012-10-12 10:58:48 -0700914 virtual XMLText* ToText() {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700915 return this;
916 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700917 virtual const XMLText* ToText() const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700918 return this;
919 }
Lee Thomason5492a1c2012-01-23 15:32:10 -0800920
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700921 /// Declare whether this should be CDATA or standard text.
Lee Thomason624d43f2012-10-12 10:58:48 -0700922 void SetCData( bool isCData ) {
923 _isCData = isCData;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700924 }
925 /// Returns true if this is a CDATA text element.
926 bool CData() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700927 return _isCData;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700928 }
Lee Thomason50f97b22012-02-11 16:33:40 -0800929
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700930 char* ParseDeep( char*, StrPair* endTag );
931 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
932 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800933
Lee Thomason5492a1c2012-01-23 15:32:10 -0800934protected:
Lee Thomason624d43f2012-10-12 10:58:48 -0700935 XMLText( XMLDocument* doc ) : XMLNode( doc ), _isCData( false ) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700936 virtual ~XMLText() {}
937 XMLText( const XMLText& ); // not supported
938 XMLText& operator=( const XMLText& ); // not supported
Lee Thomason5492a1c2012-01-23 15:32:10 -0800939
940private:
Lee Thomason624d43f2012-10-12 10:58:48 -0700941 bool _isCData;
Lee Thomason5492a1c2012-01-23 15:32:10 -0800942};
943
944
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800945/** An XML Comment. */
PKEuS16ed47d2013-07-06 12:02:43 +0200946class TINYXML2_LIB XMLComment : public XMLNode
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800947{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700948 friend class XMLDocument;
Lee Thomason3f57d272012-01-11 15:30:03 -0800949public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700950 virtual XMLComment* ToComment() {
951 return this;
952 }
953 virtual const XMLComment* ToComment() const {
954 return this;
955 }
Lee Thomasonce0763e2012-01-11 15:43:54 -0800956
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700957 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800958
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700959 char* ParseDeep( char*, StrPair* endTag );
960 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
961 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomasonce0763e2012-01-11 15:43:54 -0800962
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800963protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700964 XMLComment( XMLDocument* doc );
965 virtual ~XMLComment();
966 XMLComment( const XMLComment& ); // not supported
967 XMLComment& operator=( const XMLComment& ); // not supported
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800968
Lee Thomason3f57d272012-01-11 15:30:03 -0800969private:
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800970};
U-Lama\Leee13c3e62011-12-28 14:36:55 -0800971
972
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800973/** In correct XML the declaration is the first entry in the file.
974 @verbatim
975 <?xml version="1.0" standalone="yes"?>
976 @endverbatim
977
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600978 TinyXML-2 will happily read or write files without a declaration,
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800979 however.
980
981 The text of the declaration isn't interpreted. It is parsed
982 and written as a string.
983*/
PKEuS16ed47d2013-07-06 12:02:43 +0200984class TINYXML2_LIB XMLDeclaration : public XMLNode
Lee Thomason50f97b22012-02-11 16:33:40 -0800985{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700986 friend class XMLDocument;
Lee Thomason50f97b22012-02-11 16:33:40 -0800987public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700988 virtual XMLDeclaration* ToDeclaration() {
989 return this;
990 }
991 virtual const XMLDeclaration* ToDeclaration() const {
992 return this;
993 }
Lee Thomason50f97b22012-02-11 16:33:40 -0800994
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700995 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -0800996
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700997 char* ParseDeep( char*, StrPair* endTag );
998 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
999 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -08001000
1001protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001002 XMLDeclaration( XMLDocument* doc );
1003 virtual ~XMLDeclaration();
1004 XMLDeclaration( const XMLDeclaration& ); // not supported
1005 XMLDeclaration& operator=( const XMLDeclaration& ); // not supported
Lee Thomason50f97b22012-02-11 16:33:40 -08001006};
1007
1008
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001009/** Any tag that TinyXML-2 doesn't recognize is saved as an
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001010 unknown. It is a tag of text, but should not be modified.
1011 It will be written back to the XML, unchanged, when the file
1012 is saved.
1013
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001014 DTD tags get thrown into XMLUnknowns.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001015*/
PKEuS16ed47d2013-07-06 12:02:43 +02001016class TINYXML2_LIB XMLUnknown : public XMLNode
Lee Thomason50f97b22012-02-11 16:33:40 -08001017{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001018 friend class XMLDocument;
Lee Thomason50f97b22012-02-11 16:33:40 -08001019public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001020 virtual XMLUnknown* ToUnknown() {
1021 return this;
1022 }
1023 virtual const XMLUnknown* ToUnknown() const {
1024 return this;
1025 }
Lee Thomason50f97b22012-02-11 16:33:40 -08001026
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001027 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -08001028
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001029 char* ParseDeep( char*, StrPair* endTag );
1030 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
1031 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -08001032
1033protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001034 XMLUnknown( XMLDocument* doc );
1035 virtual ~XMLUnknown();
1036 XMLUnknown( const XMLUnknown& ); // not supported
1037 XMLUnknown& operator=( const XMLUnknown& ); // not supported
Lee Thomason50f97b22012-02-11 16:33:40 -08001038};
1039
1040
Lee Thomason1ff38e02012-02-14 18:18:16 -08001041
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001042/** An attribute is a name-value pair. Elements have an arbitrary
1043 number of attributes, each with a unique name.
1044
1045 @note The attributes are not XMLNodes. You may only query the
1046 Next() attribute in a list.
1047*/
PKEuS16ed47d2013-07-06 12:02:43 +02001048class TINYXML2_LIB XMLAttribute
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001049{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001050 friend class XMLElement;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001051public:
Lee Thomason2fa81722012-11-09 12:37:46 -08001052 /// The name of the attribute.
Michael Daumling21626882013-10-22 17:03:37 +02001053 const char* Name() const;
1054
Lee Thomason2fa81722012-11-09 12:37:46 -08001055 /// The value of the attribute.
Michael Daumling21626882013-10-22 17:03:37 +02001056 const char* Value() const;
1057
Lee Thomason2fa81722012-11-09 12:37:46 -08001058 /// The next attribute in the list.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001059 const XMLAttribute* Next() const {
MortenMacFly4ee49f12013-01-14 20:03:14 +01001060 return _next;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001061 }
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001062
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001063 /** IntValue interprets the attribute as an integer, and returns the value.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001064 If the value isn't an integer, 0 will be returned. There is no error checking;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001065 use QueryIntValue() if you need error checking.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001066 */
1067 int IntValue() const {
1068 int i=0;
1069 QueryIntValue( &i );
1070 return i;
1071 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001072 /// Query as an unsigned integer. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001073 unsigned UnsignedValue() const {
1074 unsigned i=0;
1075 QueryUnsignedValue( &i );
1076 return i;
1077 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001078 /// Query as a boolean. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001079 bool BoolValue() const {
1080 bool b=false;
1081 QueryBoolValue( &b );
1082 return b;
1083 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001084 /// Query as a double. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001085 double DoubleValue() const {
1086 double d=0;
1087 QueryDoubleValue( &d );
1088 return d;
1089 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001090 /// Query as a float. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001091 float FloatValue() const {
1092 float f=0;
1093 QueryFloatValue( &f );
1094 return f;
1095 }
U-Stream\Leeae25a442012-02-17 17:48:16 -08001096
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001097 /** QueryIntValue interprets the attribute as an integer, and returns the value
Andrew C. Martin0fd87462013-03-09 20:09:45 -07001098 in the provided parameter. The function will return XML_NO_ERROR on success,
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001099 and XML_WRONG_ATTRIBUTE_TYPE if the conversion is not successful.
1100 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001101 XMLError QueryIntValue( int* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001102 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001103 XMLError QueryUnsignedValue( unsigned int* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001104 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001105 XMLError QueryBoolValue( bool* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001106 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001107 XMLError QueryDoubleValue( double* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001108 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001109 XMLError QueryFloatValue( float* value ) const;
Lee Thomason50adb4c2012-02-13 15:07:09 -08001110
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001111 /// Set the attribute to a string value.
1112 void SetAttribute( const char* value );
1113 /// Set the attribute to value.
1114 void SetAttribute( int value );
1115 /// Set the attribute to value.
1116 void SetAttribute( unsigned value );
1117 /// Set the attribute to value.
1118 void SetAttribute( bool value );
1119 /// Set the attribute to value.
1120 void SetAttribute( double value );
1121 /// Set the attribute to value.
1122 void SetAttribute( float value );
Lee Thomason50adb4c2012-02-13 15:07:09 -08001123
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001124private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001125 enum { BUF_SIZE = 200 };
U-Stream\Lee09a11c52012-02-17 08:31:16 -08001126
Thomas Roß61892312013-05-12 14:07:38 +02001127 XMLAttribute() : _next( 0 ), _memPool( 0 ) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001128 virtual ~XMLAttribute() {}
Lee Thomason624d43f2012-10-12 10:58:48 -07001129
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001130 XMLAttribute( const XMLAttribute& ); // not supported
1131 void operator=( const XMLAttribute& ); // not supported
1132 void SetName( const char* name );
Lee Thomason50adb4c2012-02-13 15:07:09 -08001133
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001134 char* ParseDeep( char* p, bool processEntities );
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001135
Lee Thomason624d43f2012-10-12 10:58:48 -07001136 mutable StrPair _name;
1137 mutable StrPair _value;
1138 XMLAttribute* _next;
1139 MemPool* _memPool;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001140};
1141
1142
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001143/** The element is a container class. It has a value, the element name,
1144 and can contain other elements, text, comments, and unknowns.
1145 Elements also contain an arbitrary number of attributes.
1146*/
PKEuS16ed47d2013-07-06 12:02:43 +02001147class TINYXML2_LIB XMLElement : public XMLNode
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001148{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001149 friend class XMLBase;
1150 friend class XMLDocument;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001151public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001152 /// Get the name of an element (which is the Value() of the node.)
1153 const char* Name() const {
1154 return Value();
1155 }
1156 /// Set the name of the element.
1157 void SetName( const char* str, bool staticMem=false ) {
1158 SetValue( str, staticMem );
1159 }
Lee Thomason2c85a712012-01-31 08:24:24 -08001160
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001161 virtual XMLElement* ToElement() {
1162 return this;
1163 }
1164 virtual const XMLElement* ToElement() const {
1165 return this;
1166 }
1167 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001168
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001169 /** Given an attribute name, Attribute() returns the value
1170 for the attribute of that name, or null if none
1171 exists. For example:
Lee Thomason92258152012-03-24 13:05:39 -07001172
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001173 @verbatim
1174 const char* value = ele->Attribute( "foo" );
1175 @endverbatim
Lee Thomason92258152012-03-24 13:05:39 -07001176
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001177 The 'value' parameter is normally null. However, if specified,
1178 the attribute will only be returned if the 'name' and 'value'
1179 match. This allow you to write code:
Lee Thomason8ba7f7d2012-03-24 13:04:04 -07001180
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001181 @verbatim
1182 if ( ele->Attribute( "foo", "bar" ) ) callFooIsBar();
1183 @endverbatim
Lee Thomason8ba7f7d2012-03-24 13:04:04 -07001184
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001185 rather than:
1186 @verbatim
1187 if ( ele->Attribute( "foo" ) ) {
1188 if ( strcmp( ele->Attribute( "foo" ), "bar" ) == 0 ) callFooIsBar();
1189 }
1190 @endverbatim
1191 */
1192 const char* Attribute( const char* name, const char* value=0 ) const;
Lee Thomason751da522012-02-10 08:50:51 -08001193
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001194 /** Given an attribute name, IntAttribute() returns the value
1195 of the attribute interpreted as an integer. 0 will be
1196 returned if there is an error. For a method with error
1197 checking, see QueryIntAttribute()
1198 */
1199 int IntAttribute( const char* name ) const {
1200 int i=0;
1201 QueryIntAttribute( name, &i );
1202 return i;
1203 }
1204 /// See IntAttribute()
1205 unsigned UnsignedAttribute( const char* name ) const {
1206 unsigned i=0;
1207 QueryUnsignedAttribute( name, &i );
1208 return i;
1209 }
1210 /// See IntAttribute()
1211 bool BoolAttribute( const char* name ) const {
1212 bool b=false;
1213 QueryBoolAttribute( name, &b );
1214 return b;
1215 }
1216 /// See IntAttribute()
1217 double DoubleAttribute( const char* name ) const {
1218 double d=0;
1219 QueryDoubleAttribute( name, &d );
1220 return d;
1221 }
1222 /// See IntAttribute()
1223 float FloatAttribute( const char* name ) const {
1224 float f=0;
1225 QueryFloatAttribute( name, &f );
1226 return f;
1227 }
U-Stream\Lee09a11c52012-02-17 08:31:16 -08001228
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001229 /** Given an attribute name, QueryIntAttribute() returns
1230 XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion
1231 can't be performed, or XML_NO_ATTRIBUTE if the attribute
1232 doesn't exist. If successful, the result of the conversion
1233 will be written to 'value'. If not successful, nothing will
1234 be written to 'value'. This allows you to provide default
1235 value:
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001236
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001237 @verbatim
1238 int value = 10;
1239 QueryIntAttribute( "foo", &value ); // if "foo" isn't found, value will still be 10
1240 @endverbatim
1241 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001242 XMLError QueryIntAttribute( const char* name, int* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001243 const XMLAttribute* a = FindAttribute( name );
1244 if ( !a ) {
1245 return XML_NO_ATTRIBUTE;
1246 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001247 return a->QueryIntValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001248 }
1249 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001250 XMLError QueryUnsignedAttribute( const char* name, unsigned int* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001251 const XMLAttribute* a = FindAttribute( name );
1252 if ( !a ) {
1253 return XML_NO_ATTRIBUTE;
1254 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001255 return a->QueryUnsignedValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001256 }
1257 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001258 XMLError QueryBoolAttribute( const char* name, bool* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001259 const XMLAttribute* a = FindAttribute( name );
1260 if ( !a ) {
1261 return XML_NO_ATTRIBUTE;
1262 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001263 return a->QueryBoolValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001264 }
1265 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001266 XMLError QueryDoubleAttribute( const char* name, double* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001267 const XMLAttribute* a = FindAttribute( name );
1268 if ( !a ) {
1269 return XML_NO_ATTRIBUTE;
1270 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001271 return a->QueryDoubleValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001272 }
1273 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001274 XMLError QueryFloatAttribute( const char* name, float* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001275 const XMLAttribute* a = FindAttribute( name );
1276 if ( !a ) {
1277 return XML_NO_ATTRIBUTE;
1278 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001279 return a->QueryFloatValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001280 }
Lee Thomason50f97b22012-02-11 16:33:40 -08001281
Lee Thomason (grinliz)5efaa5f2013-02-01 19:26:30 -08001282
1283 /** Given an attribute name, QueryAttribute() returns
1284 XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion
1285 can't be performed, or XML_NO_ATTRIBUTE if the attribute
1286 doesn't exist. It is overloaded for the primitive types,
1287 and is a generally more convenient replacement of
1288 QueryIntAttribute() and related functions.
1289
1290 If successful, the result of the conversion
1291 will be written to 'value'. If not successful, nothing will
1292 be written to 'value'. This allows you to provide default
1293 value:
1294
1295 @verbatim
1296 int value = 10;
1297 QueryAttribute( "foo", &value ); // if "foo" isn't found, value will still be 10
1298 @endverbatim
1299 */
1300 int QueryAttribute( const char* name, int* value ) const {
1301 return QueryIntAttribute( name, value );
1302 }
1303
1304 int QueryAttribute( const char* name, unsigned int* value ) const {
1305 return QueryUnsignedAttribute( name, value );
1306 }
1307
1308 int QueryAttribute( const char* name, bool* value ) const {
1309 return QueryBoolAttribute( name, value );
1310 }
1311
1312 int QueryAttribute( const char* name, double* value ) const {
1313 return QueryDoubleAttribute( name, value );
1314 }
1315
1316 int QueryAttribute( const char* name, float* value ) const {
1317 return QueryFloatAttribute( name, value );
1318 }
1319
1320 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001321 void SetAttribute( const char* name, const char* 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, int 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 }
1330 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001331 void SetAttribute( const char* name, unsigned value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001332 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001333 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001334 }
1335 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001336 void SetAttribute( const char* name, bool value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001337 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001338 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001339 }
1340 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001341 void SetAttribute( const char* name, double value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001342 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001343 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001344 }
Lee Thomasonc3708cc2014-01-14 12:30:03 -08001345 /// Sets the named attribute to value.
1346 void SetAttribute( const char* name, float value ) {
1347 XMLAttribute* a = FindOrCreateAttribute( name );
1348 a->SetAttribute( value );
1349 }
Lee Thomason50f97b22012-02-11 16:33:40 -08001350
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001351 /**
1352 Delete an attribute.
1353 */
1354 void DeleteAttribute( const char* name );
Lee Thomason751da522012-02-10 08:50:51 -08001355
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001356 /// Return the first attribute in the list.
1357 const XMLAttribute* FirstAttribute() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001358 return _rootAttribute;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001359 }
1360 /// Query a specific attribute in the list.
1361 const XMLAttribute* FindAttribute( const char* name ) const;
Lee Thomason751da522012-02-10 08:50:51 -08001362
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001363 /** Convenience function for easy access to the text inside an element. Although easy
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001364 and concise, GetText() is limited compared to getting the XMLText child
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001365 and accessing it directly.
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001366
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001367 If the first child of 'this' is a XMLText, the GetText()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001368 returns the character string of the Text node, else null is returned.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001369
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001370 This is a convenient method for getting the text of simple contained text:
1371 @verbatim
1372 <foo>This is text</foo>
1373 const char* str = fooElement->GetText();
1374 @endverbatim
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001375
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001376 'str' will be a pointer to "This is text".
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001377
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001378 Note that this function can be misleading. If the element foo was created from
1379 this XML:
1380 @verbatim
1381 <foo><b>This is text</b></foo>
1382 @endverbatim
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001383
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001384 then the value of str would be null. The first child node isn't a text node, it is
1385 another element. From this XML:
1386 @verbatim
1387 <foo>This is <b>text</b></foo>
1388 @endverbatim
1389 GetText() will return "This is ".
1390 */
1391 const char* GetText() const;
Lee Thomason751da522012-02-10 08:50:51 -08001392
Uli Kusterer85fff5e2014-01-21 01:35:30 +01001393 /** Convenience function for easy access to the text inside an element. Although easy
1394 and concise, SetText() is limited compared to creating an XMLText child
1395 and mutating it directly.
1396
1397 If the first child of 'this' is a XMLText, SetText() sets its value to
1398 the given string, otherwise it will create a first child that is an XMLText.
1399
1400 This is a convenient method for setting the text of simple contained text:
1401 @verbatim
1402 <foo>This is text</foo>
1403 fooElement->SetText( "Hullaballoo!" );
1404 <foo>Hullaballoo!</foo>
1405 @endverbatim
1406
1407 Note that this function can be misleading. If the element foo was created from
1408 this XML:
1409 @verbatim
1410 <foo><b>This is text</b></foo>
1411 @endverbatim
1412
1413 then it will not change "This is text", but rather prefix it with a text element:
1414 @verbatim
1415 <foo>Hullaballoo!<b>This is text</b></foo>
1416 @endverbatim
1417
1418 For this XML:
1419 @verbatim
1420 <foo />
1421 @endverbatim
1422 SetText() will generate
1423 @verbatim
1424 <foo>Hullaballoo!</foo>
1425 @endverbatim
1426 */
Lee Thomason5bb2d802014-01-24 10:42:57 -08001427 void SetText( const char* inText );
Lee Thomasonc18eb232014-02-21 17:31:17 -08001428 /// Convenience method for setting text inside and element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001429 void SetText( int value );
Lee Thomasonc18eb232014-02-21 17:31:17 -08001430 /// Convenience method for setting text inside and element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001431 void SetText( unsigned value );
Lee Thomasonc18eb232014-02-21 17:31:17 -08001432 /// Convenience method for setting text inside and element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001433 void SetText( bool value );
Lee Thomasonc18eb232014-02-21 17:31:17 -08001434 /// Convenience method for setting text inside and element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001435 void SetText( double value );
Lee Thomasonc18eb232014-02-21 17:31:17 -08001436 /// Convenience method for setting text inside and element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001437 void SetText( float value );
Uli Kusterer8fe342a2014-01-21 01:12:47 +01001438
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001439 /**
1440 Convenience method to query the value of a child text node. This is probably best
1441 shown by example. Given you have a document is this form:
1442 @verbatim
1443 <point>
1444 <x>1</x>
1445 <y>1.4</y>
1446 </point>
1447 @endverbatim
Lee Thomason21be8822012-07-15 17:27:22 -07001448
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001449 The QueryIntText() and similar functions provide a safe and easier way to get to the
1450 "value" of x and y.
Lee Thomason21be8822012-07-15 17:27:22 -07001451
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001452 @verbatim
1453 int x = 0;
1454 float y = 0; // types of x and y are contrived for example
1455 const XMLElement* xElement = pointElement->FirstChildElement( "x" );
1456 const XMLElement* yElement = pointElement->FirstChildElement( "y" );
1457 xElement->QueryIntText( &x );
1458 yElement->QueryFloatText( &y );
1459 @endverbatim
Lee Thomason21be8822012-07-15 17:27:22 -07001460
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001461 @returns XML_SUCCESS (0) on success, XML_CAN_NOT_CONVERT_TEXT if the text cannot be converted
1462 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 -07001463
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001464 */
MortenMacFly4ee49f12013-01-14 20:03:14 +01001465 XMLError QueryIntText( int* ival ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001466 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001467 XMLError QueryUnsignedText( unsigned* uval ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001468 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001469 XMLError QueryBoolText( bool* bval ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001470 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001471 XMLError QueryDoubleText( double* dval ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001472 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001473 XMLError QueryFloatText( float* fval ) const;
Lee Thomason21be8822012-07-15 17:27:22 -07001474
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001475 // internal:
1476 enum {
1477 OPEN, // <foo>
1478 CLOSED, // <foo/>
1479 CLOSING // </foo>
1480 };
1481 int ClosingType() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001482 return _closingType;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001483 }
1484 char* ParseDeep( char* p, StrPair* endTag );
1485 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
1486 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001487
Lee Thomason50adb4c2012-02-13 15:07:09 -08001488private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001489 XMLElement( XMLDocument* doc );
1490 virtual ~XMLElement();
1491 XMLElement( const XMLElement& ); // not supported
1492 void operator=( const XMLElement& ); // not supported
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001493
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001494 XMLAttribute* FindAttribute( const char* name );
1495 XMLAttribute* FindOrCreateAttribute( const char* name );
1496 //void LinkAttribute( XMLAttribute* attrib );
1497 char* ParseAttributes( char* p );
Dmitry-Mee3225b12014-09-03 11:03:11 +04001498 static void DeleteAttribute( XMLAttribute* attribute );
Lee Thomason67d61312012-01-24 16:01:51 -08001499
Lee Thomason5bb2d802014-01-24 10:42:57 -08001500 enum { BUF_SIZE = 200 };
Lee Thomason624d43f2012-10-12 10:58:48 -07001501 int _closingType;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001502 // The attribute list is ordered; there is no 'lastAttribute'
1503 // because the list needs to be scanned for dupes before adding
1504 // a new attribute.
Lee Thomason624d43f2012-10-12 10:58:48 -07001505 XMLAttribute* _rootAttribute;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001506};
1507
1508
Lee Thomason (grinliz)bc1bfb72012-08-20 22:00:38 -07001509enum Whitespace {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001510 PRESERVE_WHITESPACE,
1511 COLLAPSE_WHITESPACE
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001512};
Lee Thomason (grinliz)bc1bfb72012-08-20 22:00:38 -07001513
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001514
1515/** A Document binds together all the functionality.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001516 It can be saved, loaded, and printed to the screen.
1517 All Nodes are connected and allocated to a Document.
1518 If the Document is deleted, all its Nodes are also deleted.
1519*/
PKEuS16ed47d2013-07-06 12:02:43 +02001520class TINYXML2_LIB XMLDocument : public XMLNode
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001521{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001522 friend class XMLElement;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001523public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001524 /// constructor
1525 XMLDocument( bool processEntities = true, Whitespace = PRESERVE_WHITESPACE );
1526 ~XMLDocument();
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001527
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001528 virtual XMLDocument* ToDocument() {
1529 return this;
1530 }
1531 virtual const XMLDocument* ToDocument() const {
1532 return this;
1533 }
Lee Thomason56bdd022012-02-09 18:16:58 -08001534
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001535 /**
1536 Parse an XML file from a character string.
1537 Returns XML_NO_ERROR (0) on success, or
1538 an errorID.
Lee Thomason (grinliz)e2bcb322012-09-17 17:58:25 -07001539
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001540 You may optionally pass in the 'nBytes', which is
1541 the number of bytes which will be parsed. If not
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001542 specified, TinyXML-2 will assume 'xml' points to a
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001543 null terminated string.
1544 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001545 XMLError Parse( const char* xml, size_t nBytes=(size_t)(-1) );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001546
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001547 /**
1548 Load an XML file from disk.
1549 Returns XML_NO_ERROR (0) on success, or
1550 an errorID.
1551 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001552 XMLError LoadFile( const char* filename );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001553
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001554 /**
1555 Load an XML file from disk. You are responsible
1556 for providing and closing the FILE*.
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001557
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001558 Returns XML_NO_ERROR (0) on success, or
1559 an errorID.
1560 */
Jerome Martinez242c3ea2013-01-06 12:20:04 +01001561 XMLError LoadFile( FILE* );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001562
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001563 /**
1564 Save the XML file to disk.
1565 Returns XML_NO_ERROR (0) on success, or
1566 an errorID.
1567 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001568 XMLError SaveFile( const char* filename, bool compact = false );
Lee Thomasond11cd162012-04-12 08:35:36 -07001569
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001570 /**
1571 Save the XML file to disk. You are responsible
1572 for providing and closing the FILE*.
Ken Miller81da1fb2012-04-09 23:32:26 -05001573
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001574 Returns XML_NO_ERROR (0) on success, or
1575 an errorID.
1576 */
Jerome Martinez242c3ea2013-01-06 12:20:04 +01001577 XMLError SaveFile( FILE* fp, bool compact = false );
Lee Thomason (grinliz)68db57e2012-02-21 09:08:12 -08001578
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001579 bool ProcessEntities() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001580 return _processEntities;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001581 }
1582 Whitespace WhitespaceMode() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001583 return _whitespace;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001584 }
Lee Thomason6f381b72012-03-02 12:59:39 -08001585
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001586 /**
1587 Returns true if this document has a leading Byte Order Mark of UTF8.
1588 */
1589 bool HasBOM() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001590 return _writeBOM;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001591 }
1592 /** Sets whether to write the BOM when writing the file.
1593 */
1594 void SetBOM( bool useBOM ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001595 _writeBOM = useBOM;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001596 }
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001597
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001598 /** Return the root element of DOM. Equivalent to FirstChildElement().
1599 To get the first node, use FirstChild().
1600 */
1601 XMLElement* RootElement() {
1602 return FirstChildElement();
1603 }
1604 const XMLElement* RootElement() const {
1605 return FirstChildElement();
1606 }
Lee Thomason18d68bd2012-01-26 18:17:26 -08001607
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001608 /** Print the Document. If the Printer is not provided, it will
1609 print to stdout. If you provide Printer, this can print to a file:
1610 @verbatim
1611 XMLPrinter printer( fp );
1612 doc.Print( &printer );
1613 @endverbatim
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001614
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001615 Or you can use a printer to print to memory:
1616 @verbatim
1617 XMLPrinter printer;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001618 doc.Print( &printer );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001619 // printer.CStr() has a const char* to the XML
1620 @endverbatim
1621 */
PKEuS1c5f99e2013-07-06 11:28:39 +02001622 void Print( XMLPrinter* streamer=0 ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001623 virtual bool Accept( XMLVisitor* visitor ) const;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001624
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001625 /**
1626 Create a new Element associated with
1627 this Document. The memory for the Element
1628 is managed by the Document.
1629 */
1630 XMLElement* NewElement( const char* name );
1631 /**
1632 Create a new Comment associated with
1633 this Document. The memory for the Comment
1634 is managed by the Document.
1635 */
1636 XMLComment* NewComment( const char* comment );
1637 /**
1638 Create a new Text associated with
1639 this Document. The memory for the Text
1640 is managed by the Document.
1641 */
1642 XMLText* NewText( const char* text );
1643 /**
1644 Create a new Declaration associated with
1645 this Document. The memory for the object
1646 is managed by the Document.
Lee Thomasonf68c4382012-04-28 14:37:11 -07001647
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001648 If the 'text' param is null, the standard
1649 declaration is used.:
1650 @verbatim
1651 <?xml version="1.0" encoding="UTF-8"?>
1652 @endverbatim
1653 */
1654 XMLDeclaration* NewDeclaration( const char* text=0 );
1655 /**
1656 Create a new Unknown associated with
Andrew C. Martin0fd87462013-03-09 20:09:45 -07001657 this Document. The memory for the object
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001658 is managed by the Document.
1659 */
1660 XMLUnknown* NewUnknown( const char* text );
Lee Thomason2c85a712012-01-31 08:24:24 -08001661
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001662 /**
1663 Delete a node associated with this document.
1664 It will be unlinked from the DOM.
1665 */
1666 void DeleteNode( XMLNode* node ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001667 node->_parent->DeleteChild( node );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001668 }
U-Stream\Leeae25a442012-02-17 17:48:16 -08001669
Lee Thomason2fa81722012-11-09 12:37:46 -08001670 void SetError( XMLError error, const char* str1, const char* str2 );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001671
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001672 /// Return true if there was an error parsing the document.
1673 bool Error() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001674 return _errorID != XML_NO_ERROR;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001675 }
1676 /// Return the errorID.
Lee Thomason2fa81722012-11-09 12:37:46 -08001677 XMLError ErrorID() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001678 return _errorID;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001679 }
1680 /// Return a possibly helpful diagnostic location or string.
1681 const char* GetErrorStr1() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001682 return _errorStr1;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001683 }
1684 /// Return a possibly helpful secondary diagnostic location or string.
1685 const char* GetErrorStr2() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001686 return _errorStr2;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001687 }
1688 /// If there is an error, print it to stdout.
1689 void PrintError() const;
Martinsh Shaitersa9d42b02013-01-30 11:14:27 +02001690
1691 /// Clear the document, resetting it to the initial state.
1692 void Clear();
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001693
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001694 // internal
1695 char* Identify( char* p, XMLNode** node );
Lee Thomason2c85a712012-01-31 08:24:24 -08001696
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001697 virtual XMLNode* ShallowClone( XMLDocument* /*document*/ ) const {
1698 return 0;
1699 }
1700 virtual bool ShallowEqual( const XMLNode* /*compare*/ ) const {
1701 return false;
1702 }
Lee Thomason7d00b9a2012-02-27 17:54:22 -08001703
Lee Thomason3f57d272012-01-11 15:30:03 -08001704private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001705 XMLDocument( const XMLDocument& ); // not supported
1706 void operator=( const XMLDocument& ); // not supported
Lee Thomason18d68bd2012-01-26 18:17:26 -08001707
Lee Thomason2fa81722012-11-09 12:37:46 -08001708 bool _writeBOM;
1709 bool _processEntities;
1710 XMLError _errorID;
1711 Whitespace _whitespace;
Lee Thomason624d43f2012-10-12 10:58:48 -07001712 const char* _errorStr1;
1713 const char* _errorStr2;
Lee Thomason2fa81722012-11-09 12:37:46 -08001714 char* _charBuffer;
Lee Thomasond1983222012-02-06 08:41:24 -08001715
Lee Thomason624d43f2012-10-12 10:58:48 -07001716 MemPoolT< sizeof(XMLElement) > _elementPool;
1717 MemPoolT< sizeof(XMLAttribute) > _attributePool;
1718 MemPoolT< sizeof(XMLText) > _textPool;
1719 MemPoolT< sizeof(XMLComment) > _commentPool;
Lee Thomason5cae8972012-01-24 18:03:07 -08001720};
1721
Lee Thomason7c913cd2012-01-26 18:32:34 -08001722
Lee Thomason3ffdd392012-03-28 17:27:55 -07001723/**
1724 A XMLHandle is a class that wraps a node pointer with null checks; this is
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001725 an incredibly useful thing. Note that XMLHandle is not part of the TinyXML-2
Lee Thomason3ffdd392012-03-28 17:27:55 -07001726 DOM structure. It is a separate utility class.
1727
1728 Take an example:
1729 @verbatim
1730 <Document>
1731 <Element attributeA = "valueA">
1732 <Child attributeB = "value1" />
1733 <Child attributeB = "value2" />
1734 </Element>
Thomas Roß08bdf502012-05-12 14:21:23 +02001735 </Document>
Lee Thomason3ffdd392012-03-28 17:27:55 -07001736 @endverbatim
1737
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001738 Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very
Lee Thomason3ffdd392012-03-28 17:27:55 -07001739 easy to write a *lot* of code that looks like:
1740
1741 @verbatim
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001742 XMLElement* root = document.FirstChildElement( "Document" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001743 if ( root )
1744 {
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001745 XMLElement* element = root->FirstChildElement( "Element" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001746 if ( element )
1747 {
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001748 XMLElement* child = element->FirstChildElement( "Child" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001749 if ( child )
1750 {
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001751 XMLElement* child2 = child->NextSiblingElement( "Child" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001752 if ( child2 )
1753 {
1754 // Finally do something useful.
1755 @endverbatim
1756
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001757 And that doesn't even cover "else" cases. XMLHandle addresses the verbosity
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001758 of such code. A XMLHandle checks for null pointers so it is perfectly safe
Lee Thomason3ffdd392012-03-28 17:27:55 -07001759 and correct to use:
1760
1761 @verbatim
Lee Thomasondb0bbb62012-04-04 15:47:04 -07001762 XMLHandle docHandle( &document );
1763 XMLElement* child2 = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).FirstChild().NextSibling().ToElement();
Lee Thomason3ffdd392012-03-28 17:27:55 -07001764 if ( child2 )
1765 {
1766 // do something useful
1767 @endverbatim
1768
1769 Which is MUCH more concise and useful.
1770
1771 It is also safe to copy handles - internally they are nothing more than node pointers.
1772 @verbatim
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001773 XMLHandle handleCopy = handle;
Lee Thomason3ffdd392012-03-28 17:27:55 -07001774 @endverbatim
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001775
1776 See also XMLConstHandle, which is the same as XMLHandle, but operates on const objects.
Lee Thomason3ffdd392012-03-28 17:27:55 -07001777*/
PKEuS16ed47d2013-07-06 12:02:43 +02001778class TINYXML2_LIB XMLHandle
Lee Thomason3ffdd392012-03-28 17:27:55 -07001779{
1780public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001781 /// 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 -07001782 XMLHandle( XMLNode* node ) {
1783 _node = node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001784 }
1785 /// Create a handle from a node.
Lee Thomason624d43f2012-10-12 10:58:48 -07001786 XMLHandle( XMLNode& node ) {
1787 _node = &node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001788 }
1789 /// Copy constructor
1790 XMLHandle( const XMLHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001791 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001792 }
1793 /// Assignment
1794 XMLHandle& operator=( const XMLHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001795 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001796 return *this;
1797 }
Lee Thomason3ffdd392012-03-28 17:27:55 -07001798
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001799 /// Get the first child of this handle.
1800 XMLHandle FirstChild() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001801 return XMLHandle( _node ? _node->FirstChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001802 }
1803 /// Get the first child element of this handle.
1804 XMLHandle FirstChildElement( const char* value=0 ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001805 return XMLHandle( _node ? _node->FirstChildElement( value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001806 }
1807 /// Get the last child of this handle.
1808 XMLHandle LastChild() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001809 return XMLHandle( _node ? _node->LastChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001810 }
1811 /// Get the last child element of this handle.
1812 XMLHandle LastChildElement( const char* _value=0 ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001813 return XMLHandle( _node ? _node->LastChildElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001814 }
1815 /// Get the previous sibling of this handle.
1816 XMLHandle PreviousSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001817 return XMLHandle( _node ? _node->PreviousSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001818 }
1819 /// Get the previous sibling element of this handle.
1820 XMLHandle PreviousSiblingElement( const char* _value=0 ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001821 return XMLHandle( _node ? _node->PreviousSiblingElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001822 }
1823 /// Get the next sibling of this handle.
1824 XMLHandle NextSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001825 return XMLHandle( _node ? _node->NextSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001826 }
1827 /// Get the next sibling element of this handle.
1828 XMLHandle NextSiblingElement( const char* _value=0 ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001829 return XMLHandle( _node ? _node->NextSiblingElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001830 }
Lee Thomason3ffdd392012-03-28 17:27:55 -07001831
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001832 /// Safe cast to XMLNode. This can return null.
1833 XMLNode* ToNode() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001834 return _node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001835 }
1836 /// Safe cast to XMLElement. This can return null.
1837 XMLElement* ToElement() {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001838 return ( ( _node == 0 ) ? 0 : _node->ToElement() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001839 }
1840 /// Safe cast to XMLText. This can return null.
1841 XMLText* ToText() {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001842 return ( ( _node == 0 ) ? 0 : _node->ToText() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001843 }
1844 /// Safe cast to XMLUnknown. This can return null.
1845 XMLUnknown* ToUnknown() {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001846 return ( ( _node == 0 ) ? 0 : _node->ToUnknown() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001847 }
1848 /// Safe cast to XMLDeclaration. This can return null.
1849 XMLDeclaration* ToDeclaration() {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001850 return ( ( _node == 0 ) ? 0 : _node->ToDeclaration() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001851 }
Lee Thomason3ffdd392012-03-28 17:27:55 -07001852
1853private:
Lee Thomason624d43f2012-10-12 10:58:48 -07001854 XMLNode* _node;
Lee Thomason3ffdd392012-03-28 17:27:55 -07001855};
1856
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001857
1858/**
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001859 A variant of the XMLHandle class for working with const XMLNodes and Documents. It is the
1860 same in all regards, except for the 'const' qualifiers. See XMLHandle for API.
Lee Thomason8b899812012-04-04 15:58:16 -07001861*/
PKEuS16ed47d2013-07-06 12:02:43 +02001862class TINYXML2_LIB XMLConstHandle
Lee Thomason8b899812012-04-04 15:58:16 -07001863{
1864public:
Lee Thomason624d43f2012-10-12 10:58:48 -07001865 XMLConstHandle( const XMLNode* node ) {
1866 _node = node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001867 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001868 XMLConstHandle( const XMLNode& node ) {
1869 _node = &node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001870 }
1871 XMLConstHandle( const XMLConstHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001872 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001873 }
Lee Thomason8b899812012-04-04 15:58:16 -07001874
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001875 XMLConstHandle& operator=( const XMLConstHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001876 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001877 return *this;
1878 }
Lee Thomason8b899812012-04-04 15:58:16 -07001879
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001880 const XMLConstHandle FirstChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001881 return XMLConstHandle( _node ? _node->FirstChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001882 }
1883 const XMLConstHandle FirstChildElement( const char* value=0 ) const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001884 return XMLConstHandle( _node ? _node->FirstChildElement( value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001885 }
1886 const XMLConstHandle LastChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001887 return XMLConstHandle( _node ? _node->LastChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001888 }
1889 const XMLConstHandle LastChildElement( const char* _value=0 ) const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001890 return XMLConstHandle( _node ? _node->LastChildElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001891 }
1892 const XMLConstHandle PreviousSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001893 return XMLConstHandle( _node ? _node->PreviousSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001894 }
1895 const XMLConstHandle PreviousSiblingElement( const char* _value=0 ) const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001896 return XMLConstHandle( _node ? _node->PreviousSiblingElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001897 }
1898 const XMLConstHandle NextSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001899 return XMLConstHandle( _node ? _node->NextSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001900 }
1901 const XMLConstHandle NextSiblingElement( const char* _value=0 ) const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001902 return XMLConstHandle( _node ? _node->NextSiblingElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001903 }
Lee Thomason8b899812012-04-04 15:58:16 -07001904
1905
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001906 const XMLNode* ToNode() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001907 return _node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001908 }
1909 const XMLElement* ToElement() const {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001910 return ( ( _node == 0 ) ? 0 : _node->ToElement() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001911 }
1912 const XMLText* ToText() const {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001913 return ( ( _node == 0 ) ? 0 : _node->ToText() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001914 }
1915 const XMLUnknown* ToUnknown() const {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001916 return ( ( _node == 0 ) ? 0 : _node->ToUnknown() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001917 }
1918 const XMLDeclaration* ToDeclaration() const {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001919 return ( ( _node == 0 ) ? 0 : _node->ToDeclaration() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001920 }
Lee Thomason (grinliz)bd0a8ac2012-02-20 20:14:33 -08001921
Lee Thomason5cae8972012-01-24 18:03:07 -08001922private:
Lee Thomason624d43f2012-10-12 10:58:48 -07001923 const XMLNode* _node;
Lee Thomason56bdd022012-02-09 18:16:58 -08001924};
Lee Thomason6f381b72012-03-02 12:59:39 -08001925
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001926
1927/**
1928 Printing functionality. The XMLPrinter gives you more
1929 options than the XMLDocument::Print() method.
1930
1931 It can:
1932 -# Print to memory.
Thomas Roß08bdf502012-05-12 14:21:23 +02001933 -# Print to a file you provide.
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001934 -# Print XML without a XMLDocument.
1935
1936 Print to Memory
1937
1938 @verbatim
1939 XMLPrinter printer;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001940 doc.Print( &printer );
Thomas Roß08bdf502012-05-12 14:21:23 +02001941 SomeFunction( printer.CStr() );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001942 @endverbatim
1943
1944 Print to a File
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001945
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001946 You provide the file pointer.
1947 @verbatim
1948 XMLPrinter printer( fp );
1949 doc.Print( &printer );
1950 @endverbatim
1951
1952 Print without a XMLDocument
1953
1954 When loading, an XML parser is very useful. However, sometimes
1955 when saving, it just gets in the way. The code is often set up
1956 for streaming, and constructing the DOM is just overhead.
1957
1958 The Printer supports the streaming case. The following code
1959 prints out a trivially simple XML file without ever creating
1960 an XML document.
1961
1962 @verbatim
1963 XMLPrinter printer( fp );
1964 printer.OpenElement( "foo" );
1965 printer.PushAttribute( "foo", "bar" );
1966 printer.CloseElement();
1967 @endverbatim
1968*/
PKEuS16ed47d2013-07-06 12:02:43 +02001969class TINYXML2_LIB XMLPrinter : public XMLVisitor
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001970{
1971public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001972 /** Construct the printer. If the FILE* is specified,
1973 this will print to the FILE. Else it will print
1974 to memory, and the result is available in CStr().
1975 If 'compact' is set to true, then output is created
1976 with only required whitespace and newlines.
1977 */
PKEuS1bfb9542013-08-04 13:51:17 +02001978 XMLPrinter( FILE* file=0, bool compact = false, int depth = 0 );
Dennis Jenkins59c75d32013-10-08 13:10:07 -05001979 virtual ~XMLPrinter() {}
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001980
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001981 /** If streaming, write the BOM and declaration. */
1982 void PushHeader( bool writeBOM, bool writeDeclaration );
1983 /** If streaming, start writing an element.
1984 The element must be closed with CloseElement()
1985 */
Lee Thomason256adb62014-04-06 14:41:46 -07001986 void OpenElement( const char* name, bool compactMode=false );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001987 /// If streaming, add an attribute to an open element.
1988 void PushAttribute( const char* name, const char* value );
1989 void PushAttribute( const char* name, int value );
1990 void PushAttribute( const char* name, unsigned value );
1991 void PushAttribute( const char* name, bool value );
1992 void PushAttribute( const char* name, double value );
1993 /// If streaming, close the Element.
Lee Thomason256adb62014-04-06 14:41:46 -07001994 virtual void CloseElement( bool compactMode=false );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001995
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001996 /// Add a text node.
1997 void PushText( const char* text, bool cdata=false );
1998 /// Add a text node from an integer.
1999 void PushText( int value );
2000 /// Add a text node from an unsigned.
2001 void PushText( unsigned value );
2002 /// Add a text node from a bool.
2003 void PushText( bool value );
2004 /// Add a text node from a float.
2005 void PushText( float value );
2006 /// Add a text node from a double.
2007 void PushText( double value );
Lee Thomason21be8822012-07-15 17:27:22 -07002008
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002009 /// Add a comment
2010 void PushComment( const char* comment );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002011
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002012 void PushDeclaration( const char* value );
2013 void PushUnknown( const char* value );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002014
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002015 virtual bool VisitEnter( const XMLDocument& /*doc*/ );
2016 virtual bool VisitExit( const XMLDocument& /*doc*/ ) {
2017 return true;
2018 }
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002019
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002020 virtual bool VisitEnter( const XMLElement& element, const XMLAttribute* attribute );
2021 virtual bool VisitExit( const XMLElement& element );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002022
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002023 virtual bool Visit( const XMLText& text );
2024 virtual bool Visit( const XMLComment& comment );
2025 virtual bool Visit( const XMLDeclaration& declaration );
2026 virtual bool Visit( const XMLUnknown& unknown );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002027
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002028 /**
2029 If in print to memory mode, return a pointer to
2030 the XML file in memory.
2031 */
2032 const char* CStr() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07002033 return _buffer.Mem();
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002034 }
2035 /**
2036 If in print to memory mode, return the size
2037 of the XML file in memory. (Note the size returned
2038 includes the terminating null.)
2039 */
2040 int CStrSize() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07002041 return _buffer.Size();
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002042 }
Reinhard Klambauer3bc3d4e2013-11-22 14:05:21 +01002043 /**
2044 If in print to memory mode, reset the buffer to the
2045 beginning.
2046 */
Lee Thomasonce0510b2013-11-26 21:29:37 -08002047 void ClearBuffer() {
2048 _buffer.Clear();
Reinhard Klambauer3bc3d4e2013-11-22 14:05:21 +01002049 _buffer.Push(0);
2050 }
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002051
Dennis Jenkins59c75d32013-10-08 13:10:07 -05002052protected:
Alexander Maid740b642014-05-20 22:04:42 +02002053 virtual bool CompactMode( const XMLElement& ) { return _compactMode; }
Uli Kusterer5d1d27e2014-02-20 11:50:22 +01002054
Lee Thomasonc18eb232014-02-21 17:31:17 -08002055 /** Prints out the space before an element. You may override to change
2056 the space and tabs used. A PrintSpace() override should call Print().
2057 */
2058 virtual void PrintSpace( int depth );
2059 void Print( const char* format, ... );
2060
2061 void SealElement();
Dennis Jenkins59c75d32013-10-08 13:10:07 -05002062 bool _elementJustOpened;
2063 DynArray< const char*, 10 > _stack;
2064
2065private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002066 void PrintString( const char*, bool restrictedEntitySet ); // prints out, after detecting entities.
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002067
Lee Thomason624d43f2012-10-12 10:58:48 -07002068 bool _firstElement;
Jerome Martinez242c3ea2013-01-06 12:20:04 +01002069 FILE* _fp;
Lee Thomason624d43f2012-10-12 10:58:48 -07002070 int _depth;
2071 int _textDepth;
2072 bool _processEntities;
Lee Thomasonc18eb232014-02-21 17:31:17 -08002073 bool _compactMode;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002074
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002075 enum {
2076 ENTITY_RANGE = 64,
2077 BUF_SIZE = 200
2078 };
Lee Thomason624d43f2012-10-12 10:58:48 -07002079 bool _entityFlag[ENTITY_RANGE];
2080 bool _restrictedEntityFlag[ENTITY_RANGE];
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002081
Lee Thomason624d43f2012-10-12 10:58:48 -07002082 DynArray< char, 20 > _buffer;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002083};
2084
2085
Guillermo A. Amaralb42ba362012-03-20 00:15:30 -07002086} // tinyxml2
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002087
PKEuS95060352013-07-26 10:42:44 +02002088#if defined(_MSC_VER)
2089# pragma warning(pop)
2090#endif
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002091
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002092#endif // TINYXML2_INCLUDED