blob: 0fe2cdd8a0a7ee4a12880d0ad960907239b4689a [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
172. Altered source versions must be plainly marked as such, and
18must not be misrepresented as being the original software.
19
203. This notice may not be removed or altered from any source
21distribution.
22*/
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -080023
Lee Thomason7d00b9a2012-02-27 17:54:22 -080024#ifndef TINYXML2_INCLUDED
U-Lama\Leee13c3e62011-12-28 14:36:55 -080025#define TINYXML2_INCLUDED
26
Anton Indrawanf59e2d62014-11-18 20:50:42 +010027#if defined(ANDROID_NDK) || defined(__BORLANDC__) || defined(__QNXNTO__)
Lee Thomasona9cf3f92012-10-11 16:56:51 -070028# include <ctype.h>
29# include <limits.h>
30# include <stdio.h>
31# include <stdlib.h>
32# include <string.h>
Lee Thomasona572db12016-06-04 19:16:24 -070033# if defined(__PS3__)
34# include <stddef.h>
35# endif
Lee Thomason (grinliz)bc1bfb72012-08-20 22:00:38 -070036#else
Lee Thomasona9cf3f92012-10-11 16:56:51 -070037# include <cctype>
38# include <climits>
39# include <cstdio>
40# include <cstdlib>
41# include <cstring>
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)
Dmitry-Me4bcbf142014-12-25 19:05:18 +030081# // "(void)0," is for suppressing C4127 warning in "assert(false)", "assert(true)" and the like
Lee Thomason598a88d2015-10-09 14:42:12 -070082# define TIXMLASSERT( x ) if ( !((void)0,(x))) { __debugbreak(); }
Lee Thomasona9cf3f92012-10-11 16:56:51 -070083# elif defined (ANDROID_NDK)
84# include <android/log.h>
85# define TIXMLASSERT( x ) if ( !(x)) { __android_log_assert( "assert", "grinliz", "ASSERT in '%s' at %d.", __FILE__, __LINE__ ); }
86# else
87# include <assert.h>
88# define TIXMLASSERT assert
89# endif
Lee Thomason598a88d2015-10-09 14:42:12 -070090#else
91# define TIXMLASSERT( x ) {}
U-Lama\Lee4cee6112011-12-31 14:58:18 -080092#endif
93
U-Lama\Leee13c3e62011-12-28 14:36:55 -080094
Lee Thomasonc18eb232014-02-21 17:31:17 -080095/* Versioning, past 1.0.14:
Lee Thomason85afe9c2014-02-23 21:42:16 -080096 http://semver.org/
Lee Thomasonc18eb232014-02-21 17:31:17 -080097*/
Sarat Addepalli9afd1d02015-05-19 12:56:27 +053098static const int TIXML2_MAJOR_VERSION = 3;
99static const int TIXML2_MINOR_VERSION = 0;
100static const int TIXML2_PATCH_VERSION = 0;
Lee Thomason1ff38e02012-02-14 18:18:16 -0800101
U-Lama\Leee13c3e62011-12-28 14:36:55 -0800102namespace tinyxml2
103{
Lee Thomasonce0763e2012-01-11 15:43:54 -0800104class XMLDocument;
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800105class XMLElement;
106class XMLAttribute;
107class XMLComment;
Lee Thomason5492a1c2012-01-23 15:32:10 -0800108class XMLText;
Lee Thomason50f97b22012-02-11 16:33:40 -0800109class XMLDeclaration;
110class XMLUnknown;
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800111class XMLPrinter;
Lee Thomason5cae8972012-01-24 18:03:07 -0800112
U-Stream\Leeae25a442012-02-17 17:48:16 -0800113/*
114 A class that wraps strings. Normally stores the start and end
115 pointers into the XML file itself, and will apply normalization
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800116 and entity translation if actually read. Can also store (and memory
U-Stream\Leeae25a442012-02-17 17:48:16 -0800117 manage) a traditional char[]
118*/
PKEuS95060352013-07-26 10:42:44 +0200119class StrPair
Lee Thomason39ede242012-01-20 11:27:56 -0800120{
Lee Thomasond34f52c2012-01-20 12:55:24 -0800121public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700122 enum {
123 NEEDS_ENTITY_PROCESSING = 0x01,
124 NEEDS_NEWLINE_NORMALIZATION = 0x02,
Dmitry-Me5420e542015-05-20 10:51:26 +0300125 NEEDS_WHITESPACE_COLLAPSING = 0x04,
Lee Thomason18d68bd2012-01-26 18:17:26 -0800126
selfpoisede77e1952013-03-13 14:08:29 +0800127 TEXT_ELEMENT = NEEDS_ENTITY_PROCESSING | NEEDS_NEWLINE_NORMALIZATION,
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700128 TEXT_ELEMENT_LEAVE_ENTITIES = NEEDS_NEWLINE_NORMALIZATION,
selfpoisede77e1952013-03-13 14:08:29 +0800129 ATTRIBUTE_NAME = 0,
130 ATTRIBUTE_VALUE = NEEDS_ENTITY_PROCESSING | NEEDS_NEWLINE_NORMALIZATION,
131 ATTRIBUTE_VALUE_LEAVE_ENTITIES = NEEDS_NEWLINE_NORMALIZATION,
132 COMMENT = NEEDS_NEWLINE_NORMALIZATION
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700133 };
Lee Thomason39ede242012-01-20 11:27:56 -0800134
Lee Thomason120b3a62012-10-12 10:06:59 -0700135 StrPair() : _flags( 0 ), _start( 0 ), _end( 0 ) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700136 ~StrPair();
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800137
Lee Thomason120b3a62012-10-12 10:06:59 -0700138 void Set( char* start, char* end, int flags ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700139 Reset();
Lee Thomason120b3a62012-10-12 10:06:59 -0700140 _start = start;
141 _end = end;
142 _flags = flags | NEEDS_FLUSH;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700143 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700144
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700145 const char* GetStr();
Lee Thomason120b3a62012-10-12 10:06:59 -0700146
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700147 bool Empty() const {
Lee Thomason120b3a62012-10-12 10:06:59 -0700148 return _start == _end;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700149 }
Lee Thomason39ede242012-01-20 11:27:56 -0800150
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700151 void SetInternedStr( const char* str ) {
152 Reset();
Lee Thomason120b3a62012-10-12 10:06:59 -0700153 _start = const_cast<char*>(str);
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700154 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700155
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700156 void SetStr( const char* str, int flags=0 );
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800157
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700158 char* ParseText( char* in, const char* endTag, int strFlags );
159 char* ParseName( char* in );
Lee Thomason56bdd022012-02-09 18:16:58 -0800160
Lee Thomason29658802014-11-27 22:31:11 -0800161 void TransferTo( StrPair* other );
Dmitry-Me08b40dd2014-11-10 11:17:21 +0300162
Lee Thomason39ede242012-01-20 11:27:56 -0800163private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700164 void Reset();
165 void CollapseWhitespace();
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800166
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700167 enum {
168 NEEDS_FLUSH = 0x100,
169 NEEDS_DELETE = 0x200
170 };
Lee Thomasone4422302012-01-20 17:59:50 -0800171
Lee Thomason120b3a62012-10-12 10:06:59 -0700172 int _flags;
173 char* _start;
174 char* _end;
Dmitry-Me08b40dd2014-11-10 11:17:21 +0300175
176 StrPair( const StrPair& other ); // not supported
177 void operator=( StrPair& other ); // not supported, use TransferTo()
Lee Thomason39ede242012-01-20 11:27:56 -0800178};
179
U-Lama\Lee560bd472011-12-28 19:42:49 -0800180
U-Stream\Leeae25a442012-02-17 17:48:16 -0800181/*
182 A dynamic array of Plain Old Data. Doesn't support constructors, etc.
183 Has a small initial memory pool, so that low or no usage will not
184 cause a call to new/delete
185*/
Dmitry-Me04009222015-04-06 18:07:18 +0300186template <class T, int INITIAL_SIZE>
PKEuS95060352013-07-26 10:42:44 +0200187class DynArray
Lee Thomason2c85a712012-01-31 08:24:24 -0800188{
189public:
Dmitry-Me9a5a48d2015-01-14 08:27:32 +0300190 DynArray() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700191 _mem = _pool;
Dmitry-Me04009222015-04-06 18:07:18 +0300192 _allocated = INITIAL_SIZE;
Lee Thomason624d43f2012-10-12 10:58:48 -0700193 _size = 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700194 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700195
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700196 ~DynArray() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700197 if ( _mem != _pool ) {
Lee Thomasoned5c8792012-10-12 10:09:48 -0700198 delete [] _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700199 }
200 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700201
Lee Thomasonce0510b2013-11-26 21:29:37 -0800202 void Clear() {
Reinhard Klambauer4e74b132013-11-22 14:01:58 +0100203 _size = 0;
204 }
205
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700206 void Push( T t ) {
Dmitry-Meed7a7dc2015-01-14 08:36:12 +0300207 TIXMLASSERT( _size < INT_MAX );
Lee Thomason624d43f2012-10-12 10:58:48 -0700208 EnsureCapacity( _size+1 );
209 _mem[_size++] = t;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700210 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800211
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700212 T* PushArr( int count ) {
Dmitry-Me74fb8702015-01-13 10:27:36 +0300213 TIXMLASSERT( count >= 0 );
Dmitry-Meed7a7dc2015-01-14 08:36:12 +0300214 TIXMLASSERT( _size <= INT_MAX - count );
Lee Thomason624d43f2012-10-12 10:58:48 -0700215 EnsureCapacity( _size+count );
216 T* ret = &_mem[_size];
217 _size += count;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700218 return ret;
219 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700220
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700221 T Pop() {
Dmitry-Me74fb8702015-01-13 10:27:36 +0300222 TIXMLASSERT( _size > 0 );
Lee Thomason624d43f2012-10-12 10:58:48 -0700223 return _mem[--_size];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700224 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700225
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700226 void PopArr( int count ) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700227 TIXMLASSERT( _size >= count );
228 _size -= count;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700229 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800230
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700231 bool Empty() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700232 return _size == 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700233 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700234
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700235 T& operator[](int i) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700236 TIXMLASSERT( i>= 0 && i < _size );
Lee Thomasoned5c8792012-10-12 10:09:48 -0700237 return _mem[i];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700238 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700239
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700240 const T& operator[](int i) const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700241 TIXMLASSERT( i>= 0 && i < _size );
Lee Thomasoned5c8792012-10-12 10:09:48 -0700242 return _mem[i];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700243 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700244
Lee Thomasonf07b9522014-10-30 13:25:12 -0700245 const T& PeekTop() const {
Dennis Jenkins59c75d32013-10-08 13:10:07 -0500246 TIXMLASSERT( _size > 0 );
247 return _mem[ _size - 1];
248 }
249
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700250 int Size() const {
Dmitry-Me30bdc972015-01-14 08:32:23 +0300251 TIXMLASSERT( _size >= 0 );
Lee Thomason624d43f2012-10-12 10:58:48 -0700252 return _size;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700253 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700254
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700255 int Capacity() const {
Dmitry-Me2f5a1032015-06-18 16:40:09 +0300256 TIXMLASSERT( _allocated >= INITIAL_SIZE );
Lee Thomason624d43f2012-10-12 10:58:48 -0700257 return _allocated;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700258 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700259
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700260 const T* Mem() const {
Dmitry-Me2f5a1032015-06-18 16:40:09 +0300261 TIXMLASSERT( _mem );
Lee Thomasoned5c8792012-10-12 10:09:48 -0700262 return _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700263 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700264
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700265 T* Mem() {
Dmitry-Me2f5a1032015-06-18 16:40:09 +0300266 TIXMLASSERT( _mem );
Lee Thomasoned5c8792012-10-12 10:09:48 -0700267 return _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700268 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800269
Lee Thomason2c85a712012-01-31 08:24:24 -0800270private:
Dmitry-Me3e0af372015-01-09 15:30:00 +0300271 DynArray( const DynArray& ); // not supported
272 void operator=( const DynArray& ); // not supported
273
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700274 void EnsureCapacity( int cap ) {
Dmitry-Me9fae8692014-12-22 17:59:59 +0300275 TIXMLASSERT( cap > 0 );
Lee Thomason624d43f2012-10-12 10:58:48 -0700276 if ( cap > _allocated ) {
Dmitry-Me9fae8692014-12-22 17:59:59 +0300277 TIXMLASSERT( cap <= INT_MAX / 2 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700278 int newAllocated = cap * 2;
279 T* newMem = new T[newAllocated];
Lee Thomason624d43f2012-10-12 10:58:48 -0700280 memcpy( newMem, _mem, sizeof(T)*_size ); // warning: not using constructors, only works for PODs
281 if ( _mem != _pool ) {
Lee Thomasoned5c8792012-10-12 10:09:48 -0700282 delete [] _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700283 }
Lee Thomasoned5c8792012-10-12 10:09:48 -0700284 _mem = newMem;
Lee Thomason624d43f2012-10-12 10:58:48 -0700285 _allocated = newAllocated;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700286 }
287 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800288
Lee Thomason624d43f2012-10-12 10:58:48 -0700289 T* _mem;
Dmitry-Me04009222015-04-06 18:07:18 +0300290 T _pool[INITIAL_SIZE];
Lee Thomason624d43f2012-10-12 10:58:48 -0700291 int _allocated; // objects allocated
292 int _size; // number objects in use
Lee Thomason2c85a712012-01-31 08:24:24 -0800293};
294
Lee Thomason50adb4c2012-02-13 15:07:09 -0800295
U-Stream\Leeae25a442012-02-17 17:48:16 -0800296/*
Thomas Roß08bdf502012-05-12 14:21:23 +0200297 Parent virtual class of a pool for fast allocation
U-Stream\Leeae25a442012-02-17 17:48:16 -0800298 and deallocation of objects.
299*/
PKEuS95060352013-07-26 10:42:44 +0200300class MemPool
Lee Thomasond1983222012-02-06 08:41:24 -0800301{
302public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700303 MemPool() {}
304 virtual ~MemPool() {}
Lee Thomasond1983222012-02-06 08:41:24 -0800305
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700306 virtual int ItemSize() const = 0;
307 virtual void* Alloc() = 0;
308 virtual void Free( void* ) = 0;
Lee Thomason5b0a6772012-11-19 13:54:42 -0800309 virtual void SetTracked() = 0;
Lee Thomasonf07b9522014-10-30 13:25:12 -0700310 virtual void Clear() = 0;
Lee Thomasond1983222012-02-06 08:41:24 -0800311};
312
Lee Thomason50adb4c2012-02-13 15:07:09 -0800313
U-Stream\Leeae25a442012-02-17 17:48:16 -0800314/*
315 Template child class to create pools of the correct type.
316*/
Lee Thomasond1983222012-02-06 08:41:24 -0800317template< int SIZE >
PKEuS95060352013-07-26 10:42:44 +0200318class MemPoolT : public MemPool
Lee Thomasond1983222012-02-06 08:41:24 -0800319{
320public:
Lee Thomason5b0a6772012-11-19 13:54:42 -0800321 MemPoolT() : _root(0), _currentAllocs(0), _nAllocs(0), _maxAllocs(0), _nUntracked(0) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700322 ~MemPoolT() {
Lee Thomasonf07b9522014-10-30 13:25:12 -0700323 Clear();
324 }
325
326 void Clear() {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700327 // Delete the blocks.
Lee Thomasonf07b9522014-10-30 13:25:12 -0700328 while( !_blockPtrs.Empty()) {
329 Block* b = _blockPtrs.Pop();
330 delete b;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700331 }
Lee Thomasonf07b9522014-10-30 13:25:12 -0700332 _root = 0;
333 _currentAllocs = 0;
334 _nAllocs = 0;
335 _maxAllocs = 0;
336 _nUntracked = 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700337 }
Lee Thomasond1983222012-02-06 08:41:24 -0800338
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700339 virtual int ItemSize() const {
340 return SIZE;
341 }
342 int CurrentAllocs() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700343 return _currentAllocs;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700344 }
Lee Thomasond1983222012-02-06 08:41:24 -0800345
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700346 virtual void* Alloc() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700347 if ( !_root ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700348 // Need a new block.
349 Block* block = new Block();
Lee Thomason624d43f2012-10-12 10:58:48 -0700350 _blockPtrs.Push( block );
Lee Thomasond1983222012-02-06 08:41:24 -0800351
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700352 for( int i=0; i<COUNT-1; ++i ) {
353 block->chunk[i].next = &block->chunk[i+1];
354 }
355 block->chunk[COUNT-1].next = 0;
Lee Thomason624d43f2012-10-12 10:58:48 -0700356 _root = block->chunk;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700357 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700358 void* result = _root;
359 _root = _root->next;
Lee Thomason455c9d42012-02-06 09:14:14 -0800360
Lee Thomason624d43f2012-10-12 10:58:48 -0700361 ++_currentAllocs;
362 if ( _currentAllocs > _maxAllocs ) {
363 _maxAllocs = _currentAllocs;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700364 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700365 _nAllocs++;
Lee Thomason5b0a6772012-11-19 13:54:42 -0800366 _nUntracked++;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700367 return result;
368 }
Lee Thomasonf07b9522014-10-30 13:25:12 -0700369
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700370 virtual void Free( void* mem ) {
371 if ( !mem ) {
372 return;
373 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700374 --_currentAllocs;
Dmitry-Me56571762014-08-15 11:03:47 +0400375 Chunk* chunk = static_cast<Chunk*>( mem );
Lee Thomason (grinliz)6020a012012-09-08 21:15:09 -0700376#ifdef DEBUG
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700377 memset( chunk, 0xfe, sizeof(Chunk) );
Lee Thomason (grinliz)6020a012012-09-08 21:15:09 -0700378#endif
Lee Thomason624d43f2012-10-12 10:58:48 -0700379 chunk->next = _root;
380 _root = chunk;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700381 }
382 void Trace( const char* name ) {
383 printf( "Mempool %s watermark=%d [%dk] current=%d size=%d nAlloc=%d blocks=%d\n",
Lee Thomason624d43f2012-10-12 10:58:48 -0700384 name, _maxAllocs, _maxAllocs*SIZE/1024, _currentAllocs, SIZE, _nAllocs, _blockPtrs.Size() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700385 }
Lee Thomasond1983222012-02-06 08:41:24 -0800386
Lee Thomason5b0a6772012-11-19 13:54:42 -0800387 void SetTracked() {
388 _nUntracked--;
389 }
390
391 int Untracked() const {
392 return _nUntracked;
393 }
394
Lee Thomason (grinliz)ac83b4e2013-02-01 09:02:34 -0800395 // This number is perf sensitive. 4k seems like a good tradeoff on my machine.
396 // The test file is large, 170k.
397 // Release: VS2010 gcc(no opt)
398 // 1k: 4000
399 // 2k: 4000
400 // 4k: 3900 21000
401 // 16k: 5200
402 // 32k: 4300
403 // 64k: 4000 21000
404 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 +0200405
Lee Thomasond1983222012-02-06 08:41:24 -0800406private:
Dmitry-Me3e0af372015-01-09 15:30:00 +0300407 MemPoolT( const MemPoolT& ); // not supported
408 void operator=( const MemPoolT& ); // not supported
409
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700410 union Chunk {
Lee Thomason624d43f2012-10-12 10:58:48 -0700411 Chunk* next;
412 char mem[SIZE];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700413 };
414 struct Block {
Lee Thomason (grinliz)856da212012-10-19 09:08:15 -0700415 Chunk chunk[COUNT];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700416 };
Lee Thomason624d43f2012-10-12 10:58:48 -0700417 DynArray< Block*, 10 > _blockPtrs;
418 Chunk* _root;
Lee Thomason455c9d42012-02-06 09:14:14 -0800419
Lee Thomason624d43f2012-10-12 10:58:48 -0700420 int _currentAllocs;
421 int _nAllocs;
422 int _maxAllocs;
Lee Thomason5b0a6772012-11-19 13:54:42 -0800423 int _nUntracked;
Lee Thomasond1983222012-02-06 08:41:24 -0800424};
425
Lee Thomason2c85a712012-01-31 08:24:24 -0800426
Lee Thomason56bdd022012-02-09 18:16:58 -0800427
428/**
429 Implements the interface to the "Visitor pattern" (see the Accept() method.)
430 If you call the Accept() method, it requires being passed a XMLVisitor
431 class to handle callbacks. For nodes that contain other nodes (Document, Element)
Thomas Roß08bdf502012-05-12 14:21:23 +0200432 you will get called with a VisitEnter/VisitExit pair. Nodes that are always leafs
Lee Thomason56bdd022012-02-09 18:16:58 -0800433 are simply called with Visit().
434
435 If you return 'true' from a Visit method, recursive parsing will continue. If you return
Andrew C. Martin0fd87462013-03-09 20:09:45 -0700436 false, <b>no children of this node or its siblings</b> will be visited.
Lee Thomason56bdd022012-02-09 18:16:58 -0800437
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700438 All flavors of Visit methods have a default implementation that returns 'true' (continue
Lee Thomason56bdd022012-02-09 18:16:58 -0800439 visiting). You need to only override methods that are interesting to you.
440
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600441 Generally Accept() is called on the XMLDocument, although all nodes support visiting.
Lee Thomason56bdd022012-02-09 18:16:58 -0800442
443 You should never change the document from a callback.
444
445 @sa XMLNode::Accept()
446*/
PKEuS16ed47d2013-07-06 12:02:43 +0200447class TINYXML2_LIB XMLVisitor
U-Lama\Leee13c3e62011-12-28 14:36:55 -0800448{
449public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700450 virtual ~XMLVisitor() {}
Lee Thomasond1983222012-02-06 08:41:24 -0800451
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700452 /// Visit a document.
453 virtual bool VisitEnter( const XMLDocument& /*doc*/ ) {
454 return true;
455 }
456 /// Visit a document.
457 virtual bool VisitExit( const XMLDocument& /*doc*/ ) {
458 return true;
459 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800460
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700461 /// Visit an element.
462 virtual bool VisitEnter( const XMLElement& /*element*/, const XMLAttribute* /*firstAttribute*/ ) {
463 return true;
464 }
465 /// Visit an element.
466 virtual bool VisitExit( const XMLElement& /*element*/ ) {
467 return true;
468 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800469
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700470 /// Visit a declaration.
471 virtual bool Visit( const XMLDeclaration& /*declaration*/ ) {
472 return true;
473 }
474 /// Visit a text node.
475 virtual bool Visit( const XMLText& /*text*/ ) {
476 return true;
477 }
478 /// Visit a comment node.
479 virtual bool Visit( const XMLComment& /*comment*/ ) {
480 return true;
481 }
482 /// Visit an unknown node.
483 virtual bool Visit( const XMLUnknown& /*unknown*/ ) {
484 return true;
485 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800486};
487
Dmitry-Me66d2a842014-11-08 15:24:52 +0300488// WARNING: must match XMLDocument::_errorNames[]
numatrumpetbb5ffac2014-09-06 22:56:46 +0900489enum XMLError {
numatrumpetcd8550c2014-09-08 16:59:39 +0900490 XML_SUCCESS = 0,
numatrumpetcd8550c2014-09-08 16:59:39 +0900491 XML_NO_ATTRIBUTE,
492 XML_WRONG_ATTRIBUTE_TYPE,
493 XML_ERROR_FILE_NOT_FOUND,
494 XML_ERROR_FILE_COULD_NOT_BE_OPENED,
495 XML_ERROR_FILE_READ_ERROR,
496 XML_ERROR_ELEMENT_MISMATCH,
497 XML_ERROR_PARSING_ELEMENT,
498 XML_ERROR_PARSING_ATTRIBUTE,
499 XML_ERROR_IDENTIFYING_TAG,
500 XML_ERROR_PARSING_TEXT,
501 XML_ERROR_PARSING_CDATA,
502 XML_ERROR_PARSING_COMMENT,
503 XML_ERROR_PARSING_DECLARATION,
504 XML_ERROR_PARSING_UNKNOWN,
505 XML_ERROR_EMPTY_DOCUMENT,
506 XML_ERROR_MISMATCHED_ELEMENT,
507 XML_ERROR_PARSING,
508 XML_CAN_NOT_CONVERT_TEXT,
Lee Thomason331596e2014-09-11 14:56:43 -0700509 XML_NO_TEXT_NODE,
510
511 XML_ERROR_COUNT
numatrumpetbb5ffac2014-09-06 22:56:46 +0900512};
numatrumpetbb5ffac2014-09-06 22:56:46 +0900513
numatrumpetcd8550c2014-09-08 16:59:39 +0900514
U-Stream\Leeae25a442012-02-17 17:48:16 -0800515/*
516 Utility functionality.
517*/
Lee Thomason56bdd022012-02-09 18:16:58 -0800518class XMLUtil
519{
Lee Thomasond1983222012-02-06 08:41:24 -0800520public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700521 static const char* SkipWhiteSpace( const char* p ) {
Dmitry-Mebb836dc2014-12-24 11:54:05 +0300522 TIXMLASSERT( p );
Dmitry-Mefa20b222014-10-31 12:53:04 +0300523 while( IsWhiteSpace(*p) ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700524 ++p;
525 }
Dmitry-Mebb836dc2014-12-24 11:54:05 +0300526 TIXMLASSERT( p );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700527 return p;
528 }
529 static char* SkipWhiteSpace( char* p ) {
Dmitry-Me9de541f2014-09-24 14:21:36 +0400530 return const_cast<char*>( SkipWhiteSpace( const_cast<const char*>(p) ) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700531 }
Dmitry-Mefa20b222014-10-31 12:53:04 +0300532
533 // Anything in the high order range of UTF-8 is assumed to not be whitespace. This isn't
534 // correct, but simple, and usually works.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700535 static bool IsWhiteSpace( char p ) {
Jerome Martinez242c3ea2013-01-06 12:20:04 +0100536 return !IsUTF8Continuation(p) && isspace( static_cast<unsigned char>(p) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700537 }
Martinsh Shaitersc6d02f42013-01-26 21:22:57 +0200538
539 inline static bool IsNameStartChar( unsigned char ch ) {
Dmitry-Meea617f92015-01-01 16:32:01 +0300540 if ( ch >= 128 ) {
541 // This is a heuristic guess in attempt to not implement Unicode-aware isalpha()
542 return true;
543 }
544 if ( isalpha( ch ) ) {
545 return true;
546 }
547 return ch == ':' || ch == '_';
Martinsh Shaitersc6d02f42013-01-26 21:22:57 +0200548 }
549
550 inline static bool IsNameChar( unsigned char ch ) {
551 return IsNameStartChar( ch )
552 || isdigit( ch )
553 || ch == '.'
554 || ch == '-';
555 }
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800556
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700557 inline static bool StringEqual( const char* p, const char* q, int nChar=INT_MAX ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700558 if ( p == q ) {
559 return true;
560 }
Lee Thomason598a88d2015-10-09 14:42:12 -0700561 return strncmp( p, q, nChar ) == 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700562 }
Martinsh Shaitersc6d02f42013-01-26 21:22:57 +0200563
Dmitry-Me7865aad2015-06-19 16:23:35 +0300564 inline static bool IsUTF8Continuation( char p ) {
Dmitry-Me72bb0ec2014-09-24 16:14:24 +0400565 return ( p & 0x80 ) != 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700566 }
Lee Thomason (grinliz)68db57e2012-02-21 09:08:12 -0800567
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700568 static const char* ReadBOM( const char* p, bool* hasBOM );
569 // p is the starting location,
570 // the UTF-8 value of the entity will be placed in value, and length filled in.
571 static const char* GetCharacterRef( const char* p, char* value, int* length );
572 static void ConvertUTF32ToUTF8( unsigned long input, char* output, int* length );
Lee Thomason21be8822012-07-15 17:27:22 -0700573
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700574 // converts primitive types to strings
575 static void ToStr( int v, char* buffer, int bufferSize );
576 static void ToStr( unsigned v, char* buffer, int bufferSize );
577 static void ToStr( bool v, char* buffer, int bufferSize );
578 static void ToStr( float v, char* buffer, int bufferSize );
579 static void ToStr( double v, char* buffer, int bufferSize );
Lee Thomason21be8822012-07-15 17:27:22 -0700580
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700581 // converts strings to primitive types
582 static bool ToInt( const char* str, int* value );
583 static bool ToUnsigned( const char* str, unsigned* value );
584 static bool ToBool( const char* str, bool* value );
585 static bool ToFloat( const char* str, float* value );
586 static bool ToDouble( const char* str, double* value );
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800587};
588
Lee Thomason5cae8972012-01-24 18:03:07 -0800589
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800590/** XMLNode is a base class for every object that is in the
591 XML Document Object Model (DOM), except XMLAttributes.
592 Nodes have siblings, a parent, and children which can
593 be navigated. A node is always in a XMLDocument.
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700594 The type of a XMLNode can be queried, and it can
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800595 be cast to its more defined type.
596
Thomas Roß08bdf502012-05-12 14:21:23 +0200597 A XMLDocument allocates memory for all its Nodes.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800598 When the XMLDocument gets deleted, all its Nodes
599 will also be deleted.
600
601 @verbatim
602 A Document can contain: Element (container or leaf)
603 Comment (leaf)
604 Unknown (leaf)
605 Declaration( leaf )
606
607 An Element can contain: Element (container or leaf)
608 Text (leaf)
609 Attributes (not on tree)
610 Comment (leaf)
611 Unknown (leaf)
612
613 @endverbatim
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800614*/
PKEuS16ed47d2013-07-06 12:02:43 +0200615class TINYXML2_LIB XMLNode
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800616{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700617 friend class XMLDocument;
618 friend class XMLElement;
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800619public:
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800620
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700621 /// Get the XMLDocument that owns this XMLNode.
622 const XMLDocument* GetDocument() const {
Dmitry-Me66487eb2015-07-20 18:21:04 +0300623 TIXMLASSERT( _document );
Lee Thomason624d43f2012-10-12 10:58:48 -0700624 return _document;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700625 }
626 /// Get the XMLDocument that owns this XMLNode.
627 XMLDocument* GetDocument() {
Dmitry-Me66487eb2015-07-20 18:21:04 +0300628 TIXMLASSERT( _document );
Lee Thomason624d43f2012-10-12 10:58:48 -0700629 return _document;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700630 }
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800631
Lee Thomason2fa81722012-11-09 12:37:46 -0800632 /// Safely cast to an Element, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700633 virtual XMLElement* ToElement() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100634 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700635 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800636 /// Safely cast to Text, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700637 virtual XMLText* ToText() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100638 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700639 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800640 /// Safely cast to a Comment, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700641 virtual XMLComment* ToComment() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100642 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700643 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800644 /// Safely cast to a Document, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700645 virtual XMLDocument* ToDocument() {
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 a Declaration, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700649 virtual XMLDeclaration* ToDeclaration() {
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 an Unknown, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700653 virtual XMLUnknown* ToUnknown() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100654 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700655 }
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800656
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700657 virtual const XMLElement* ToElement() const {
658 return 0;
659 }
660 virtual const XMLText* ToText() const {
661 return 0;
662 }
663 virtual const XMLComment* ToComment() const {
664 return 0;
665 }
666 virtual const XMLDocument* ToDocument() const {
667 return 0;
668 }
669 virtual const XMLDeclaration* ToDeclaration() const {
670 return 0;
671 }
672 virtual const XMLUnknown* ToUnknown() const {
673 return 0;
674 }
Lee Thomason751da522012-02-10 08:50:51 -0800675
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700676 /** The meaning of 'value' changes for the specific type.
677 @verbatim
Sarat Addepalli9afd1d02015-05-19 12:56:27 +0530678 Document: empty (NULL is returned, not an empty string)
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700679 Element: name of the element
680 Comment: the comment text
681 Unknown: the tag contents
682 Text: the text string
683 @endverbatim
684 */
Michael Daumling21626882013-10-22 17:03:37 +0200685 const char* Value() const;
MortenMacFly4ee49f12013-01-14 20:03:14 +0100686
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700687 /** Set the Value of an XML node.
688 @sa Value()
689 */
690 void SetValue( const char* val, bool staticMem=false );
Lee Thomason2c85a712012-01-31 08:24:24 -0800691
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700692 /// Get the parent of this node on the DOM.
693 const XMLNode* Parent() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700694 return _parent;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700695 }
MortenMacFly4ee49f12013-01-14 20:03:14 +0100696
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700697 XMLNode* Parent() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700698 return _parent;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700699 }
Lee Thomason751da522012-02-10 08:50:51 -0800700
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700701 /// Returns true if this node has no children.
702 bool NoChildren() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700703 return !_firstChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700704 }
Lee Thomason751da522012-02-10 08:50:51 -0800705
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700706 /// Get the first child node, or null if none exists.
707 const XMLNode* FirstChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700708 return _firstChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700709 }
MortenMacFly4ee49f12013-01-14 20:03:14 +0100710
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700711 XMLNode* FirstChild() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700712 return _firstChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700713 }
MortenMacFly4ee49f12013-01-14 20:03:14 +0100714
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700715 /** Get the first child element, or optionally the first child
716 element with the specified name.
717 */
Dmitry-Me886ad972015-07-22 11:00:51 +0300718 const XMLElement* FirstChildElement( const char* name = 0 ) const;
Lee Thomason624d43f2012-10-12 10:58:48 -0700719
Dmitry-Me886ad972015-07-22 11:00:51 +0300720 XMLElement* FirstChildElement( const char* name = 0 ) {
721 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->FirstChildElement( name ));
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700722 }
Lee Thomason3f57d272012-01-11 15:30:03 -0800723
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700724 /// Get the last child node, or null if none exists.
725 const XMLNode* LastChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700726 return _lastChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700727 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700728
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700729 XMLNode* LastChild() {
Dmitry-Me8d4e0ec2015-03-30 12:58:28 +0300730 return _lastChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700731 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800732
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700733 /** Get the last child element or optionally the last child
734 element with the specified name.
735 */
Dmitry-Me886ad972015-07-22 11:00:51 +0300736 const XMLElement* LastChildElement( const char* name = 0 ) const;
Lee Thomason624d43f2012-10-12 10:58:48 -0700737
Dmitry-Me886ad972015-07-22 11:00:51 +0300738 XMLElement* LastChildElement( const char* name = 0 ) {
739 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->LastChildElement(name) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700740 }
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700741
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700742 /// Get the previous (left) sibling node of this node.
743 const XMLNode* PreviousSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700744 return _prev;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700745 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700746
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700747 XMLNode* PreviousSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700748 return _prev;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700749 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800750
Andrew C. Martin0fd87462013-03-09 20:09:45 -0700751 /// Get the previous (left) sibling element of this node, with an optionally supplied name.
Dmitry-Me886ad972015-07-22 11:00:51 +0300752 const XMLElement* PreviousSiblingElement( const char* name = 0 ) const ;
Lee Thomason624d43f2012-10-12 10:58:48 -0700753
Dmitry-Me886ad972015-07-22 11:00:51 +0300754 XMLElement* PreviousSiblingElement( const char* name = 0 ) {
755 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->PreviousSiblingElement( name ) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700756 }
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700757
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700758 /// Get the next (right) sibling node of this node.
759 const XMLNode* NextSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700760 return _next;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700761 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700762
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700763 XMLNode* NextSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700764 return _next;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700765 }
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700766
Andrew C. Martin0fd87462013-03-09 20:09:45 -0700767 /// Get the next (right) sibling element of this node, with an optionally supplied name.
Dmitry-Me886ad972015-07-22 11:00:51 +0300768 const XMLElement* NextSiblingElement( const char* name = 0 ) const;
Lee Thomason624d43f2012-10-12 10:58:48 -0700769
Dmitry-Me886ad972015-07-22 11:00:51 +0300770 XMLElement* NextSiblingElement( const char* name = 0 ) {
771 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->NextSiblingElement( name ) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700772 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800773
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700774 /**
775 Add a child node as the last (right) child.
Michael Daumlinged523282013-10-23 07:47:29 +0200776 If the child node is already part of the document,
777 it is moved from its old location to the new location.
778 Returns the addThis argument or 0 if the node does not
779 belong to the same document.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700780 */
781 XMLNode* InsertEndChild( XMLNode* addThis );
Lee Thomason618dbf82012-02-28 12:34:27 -0800782
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700783 XMLNode* LinkEndChild( XMLNode* addThis ) {
784 return InsertEndChild( addThis );
785 }
786 /**
787 Add a child node as the first (left) 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* InsertFirstChild( XMLNode* addThis );
794 /**
795 Add a node after the specified child node.
Michael Daumlinged523282013-10-23 07:47:29 +0200796 If the child node is already part of the document,
797 it is moved from its old location to the new location.
798 Returns the addThis argument or 0 if the afterThis node
799 is not a child of this node, or if the node does not
800 belong to the same document.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700801 */
802 XMLNode* InsertAfterChild( XMLNode* afterThis, XMLNode* addThis );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700803
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700804 /**
805 Delete all the children of this node.
806 */
807 void DeleteChildren();
U-Stream\Leeae25a442012-02-17 17:48:16 -0800808
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700809 /**
810 Delete a child of this node.
811 */
812 void DeleteChild( XMLNode* node );
Lee Thomason56bdd022012-02-09 18:16:58 -0800813
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700814 /**
815 Make a copy of this node, but not its children.
816 You may pass in a Document pointer that will be
817 the owner of the new Node. If the 'document' is
818 null, then the node returned will be allocated
819 from the current Document. (this->GetDocument())
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800820
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700821 Note: if called on a XMLDocument, this will return null.
822 */
823 virtual XMLNode* ShallowClone( XMLDocument* document ) const = 0;
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800824
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700825 /**
826 Test if 2 nodes are the same, but don't test children.
827 The 2 nodes do not need to be in the same Document.
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800828
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700829 Note: if called on a XMLDocument, this will return false.
830 */
831 virtual bool ShallowEqual( const XMLNode* compare ) const = 0;
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800832
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600833 /** Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700834 XML tree will be conditionally visited and the host will be called back
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600835 via the XMLVisitor interface.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800836
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600837 This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse
838 the XML for the callbacks, so the performance of TinyXML-2 is unchanged by using this
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700839 interface versus any other.)
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800840
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700841 The interface has been based on ideas from:
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800842
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700843 - http://www.saxproject.org/
844 - http://c2.com/cgi/wiki?HierarchicalVisitorPattern
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800845
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700846 Which are both good references for "visiting".
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800847
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700848 An example of using Accept():
849 @verbatim
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600850 XMLPrinter printer;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700851 tinyxmlDoc.Accept( &printer );
852 const char* xmlcstr = printer.CStr();
853 @endverbatim
854 */
855 virtual bool Accept( XMLVisitor* visitor ) const = 0;
Lee Thomason56bdd022012-02-09 18:16:58 -0800856
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800857protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700858 XMLNode( XMLDocument* );
859 virtual ~XMLNode();
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700860
Dmitry-Me9b0f1772015-04-03 10:37:31 +0300861 virtual char* ParseDeep( char*, StrPair* );
862
Lee Thomason624d43f2012-10-12 10:58:48 -0700863 XMLDocument* _document;
864 XMLNode* _parent;
865 mutable StrPair _value;
Lee Thomason3f57d272012-01-11 15:30:03 -0800866
Lee Thomason624d43f2012-10-12 10:58:48 -0700867 XMLNode* _firstChild;
868 XMLNode* _lastChild;
Lee Thomason3f57d272012-01-11 15:30:03 -0800869
Lee Thomason624d43f2012-10-12 10:58:48 -0700870 XMLNode* _prev;
871 XMLNode* _next;
Lee Thomason3f57d272012-01-11 15:30:03 -0800872
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800873private:
Lee Thomason624d43f2012-10-12 10:58:48 -0700874 MemPool* _memPool;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700875 void Unlink( XMLNode* child );
Dmitry-Mee3225b12014-09-03 11:03:11 +0400876 static void DeleteNode( XMLNode* node );
Lee Thomason3cebdc42015-01-05 17:16:28 -0800877 void InsertChildPreamble( XMLNode* insertThis ) const;
Dmitry-Mef547a992015-01-09 15:17:09 +0300878
879 XMLNode( const XMLNode& ); // not supported
880 XMLNode& operator=( const XMLNode& ); // not supported
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800881};
882
883
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800884/** XML text.
885
886 Note that a text node can have child element nodes, for example:
887 @verbatim
888 <root>This is <b>bold</b></root>
889 @endverbatim
890
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700891 A text node can have 2 ways to output the next. "normal" output
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800892 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 -0700893 you generally want to leave it alone, but you can change the output mode with
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600894 SetCData() and query it with CData().
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800895*/
PKEuS16ed47d2013-07-06 12:02:43 +0200896class TINYXML2_LIB XMLText : public XMLNode
Lee Thomason5492a1c2012-01-23 15:32:10 -0800897{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700898 friend class XMLDocument;
Lee Thomason5492a1c2012-01-23 15:32:10 -0800899public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700900 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason50adb4c2012-02-13 15:07:09 -0800901
Lee Thomason624d43f2012-10-12 10:58:48 -0700902 virtual XMLText* ToText() {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700903 return this;
904 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700905 virtual const XMLText* ToText() const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700906 return this;
907 }
Lee Thomason5492a1c2012-01-23 15:32:10 -0800908
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700909 /// Declare whether this should be CDATA or standard text.
Lee Thomason624d43f2012-10-12 10:58:48 -0700910 void SetCData( bool isCData ) {
911 _isCData = isCData;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700912 }
913 /// Returns true if this is a CDATA text element.
914 bool CData() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700915 return _isCData;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700916 }
Lee Thomason50f97b22012-02-11 16:33:40 -0800917
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700918 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
919 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800920
Lee Thomason5492a1c2012-01-23 15:32:10 -0800921protected:
Lee Thomason624d43f2012-10-12 10:58:48 -0700922 XMLText( XMLDocument* doc ) : XMLNode( doc ), _isCData( false ) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700923 virtual ~XMLText() {}
Lee Thomason5492a1c2012-01-23 15:32:10 -0800924
Dmitry-Me9b0f1772015-04-03 10:37:31 +0300925 char* ParseDeep( char*, StrPair* endTag );
926
Lee Thomason5492a1c2012-01-23 15:32:10 -0800927private:
Lee Thomason624d43f2012-10-12 10:58:48 -0700928 bool _isCData;
Dmitry-Mef547a992015-01-09 15:17:09 +0300929
930 XMLText( const XMLText& ); // not supported
931 XMLText& operator=( const XMLText& ); // not supported
Lee Thomason5492a1c2012-01-23 15:32:10 -0800932};
933
934
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800935/** An XML Comment. */
PKEuS16ed47d2013-07-06 12:02:43 +0200936class TINYXML2_LIB XMLComment : public XMLNode
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800937{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700938 friend class XMLDocument;
Lee Thomason3f57d272012-01-11 15:30:03 -0800939public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700940 virtual XMLComment* ToComment() {
941 return this;
942 }
943 virtual const XMLComment* ToComment() const {
944 return this;
945 }
Lee Thomasonce0763e2012-01-11 15:43:54 -0800946
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700947 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800948
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700949 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
950 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomasonce0763e2012-01-11 15:43:54 -0800951
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800952protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700953 XMLComment( XMLDocument* doc );
954 virtual ~XMLComment();
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800955
Dmitry-Me9b0f1772015-04-03 10:37:31 +0300956 char* ParseDeep( char*, StrPair* endTag );
957
Lee Thomason3f57d272012-01-11 15:30:03 -0800958private:
Dmitry-Mef547a992015-01-09 15:17:09 +0300959 XMLComment( const XMLComment& ); // not supported
960 XMLComment& operator=( const XMLComment& ); // not supported
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800961};
U-Lama\Leee13c3e62011-12-28 14:36:55 -0800962
963
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800964/** In correct XML the declaration is the first entry in the file.
965 @verbatim
966 <?xml version="1.0" standalone="yes"?>
967 @endverbatim
968
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600969 TinyXML-2 will happily read or write files without a declaration,
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800970 however.
971
972 The text of the declaration isn't interpreted. It is parsed
973 and written as a string.
974*/
PKEuS16ed47d2013-07-06 12:02:43 +0200975class TINYXML2_LIB XMLDeclaration : public XMLNode
Lee Thomason50f97b22012-02-11 16:33:40 -0800976{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700977 friend class XMLDocument;
Lee Thomason50f97b22012-02-11 16:33:40 -0800978public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700979 virtual XMLDeclaration* ToDeclaration() {
980 return this;
981 }
982 virtual const XMLDeclaration* ToDeclaration() const {
983 return this;
984 }
Lee Thomason50f97b22012-02-11 16:33:40 -0800985
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700986 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -0800987
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700988 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
989 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -0800990
991protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700992 XMLDeclaration( XMLDocument* doc );
993 virtual ~XMLDeclaration();
Dmitry-Mef547a992015-01-09 15:17:09 +0300994
Dmitry-Me9b0f1772015-04-03 10:37:31 +0300995 char* ParseDeep( char*, StrPair* endTag );
996
Dmitry-Mef547a992015-01-09 15:17:09 +0300997private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700998 XMLDeclaration( const XMLDeclaration& ); // not supported
999 XMLDeclaration& operator=( const XMLDeclaration& ); // not supported
Lee Thomason50f97b22012-02-11 16:33:40 -08001000};
1001
1002
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001003/** Any tag that TinyXML-2 doesn't recognize is saved as an
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001004 unknown. It is a tag of text, but should not be modified.
1005 It will be written back to the XML, unchanged, when the file
1006 is saved.
1007
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001008 DTD tags get thrown into XMLUnknowns.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001009*/
PKEuS16ed47d2013-07-06 12:02:43 +02001010class TINYXML2_LIB XMLUnknown : public XMLNode
Lee Thomason50f97b22012-02-11 16:33:40 -08001011{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001012 friend class XMLDocument;
Lee Thomason50f97b22012-02-11 16:33:40 -08001013public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001014 virtual XMLUnknown* ToUnknown() {
1015 return this;
1016 }
1017 virtual const XMLUnknown* ToUnknown() const {
1018 return this;
1019 }
Lee Thomason50f97b22012-02-11 16:33:40 -08001020
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001021 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -08001022
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001023 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
1024 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -08001025
1026protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001027 XMLUnknown( XMLDocument* doc );
1028 virtual ~XMLUnknown();
Dmitry-Mef547a992015-01-09 15:17:09 +03001029
Dmitry-Me9b0f1772015-04-03 10:37:31 +03001030 char* ParseDeep( char*, StrPair* endTag );
1031
Dmitry-Mef547a992015-01-09 15:17:09 +03001032private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001033 XMLUnknown( const XMLUnknown& ); // not supported
1034 XMLUnknown& operator=( const XMLUnknown& ); // not supported
Lee Thomason50f97b22012-02-11 16:33:40 -08001035};
1036
1037
Lee Thomason1ff38e02012-02-14 18:18:16 -08001038
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001039/** An attribute is a name-value pair. Elements have an arbitrary
1040 number of attributes, each with a unique name.
1041
1042 @note The attributes are not XMLNodes. You may only query the
1043 Next() attribute in a list.
1044*/
PKEuS16ed47d2013-07-06 12:02:43 +02001045class TINYXML2_LIB XMLAttribute
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001046{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001047 friend class XMLElement;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001048public:
Lee Thomason2fa81722012-11-09 12:37:46 -08001049 /// The name of the attribute.
Michael Daumling21626882013-10-22 17:03:37 +02001050 const char* Name() const;
1051
Lee Thomason2fa81722012-11-09 12:37:46 -08001052 /// The value of the attribute.
Michael Daumling21626882013-10-22 17:03:37 +02001053 const char* Value() const;
1054
Lee Thomason2fa81722012-11-09 12:37:46 -08001055 /// The next attribute in the list.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001056 const XMLAttribute* Next() const {
MortenMacFly4ee49f12013-01-14 20:03:14 +01001057 return _next;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001058 }
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001059
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001060 /** IntValue interprets the attribute as an integer, and returns the value.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001061 If the value isn't an integer, 0 will be returned. There is no error checking;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001062 use QueryIntValue() if you need error checking.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001063 */
1064 int IntValue() const {
1065 int i=0;
1066 QueryIntValue( &i );
1067 return i;
1068 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001069 /// Query as an unsigned integer. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001070 unsigned UnsignedValue() const {
1071 unsigned i=0;
1072 QueryUnsignedValue( &i );
1073 return i;
1074 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001075 /// Query as a boolean. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001076 bool BoolValue() const {
1077 bool b=false;
1078 QueryBoolValue( &b );
1079 return b;
1080 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001081 /// Query as a double. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001082 double DoubleValue() const {
1083 double d=0;
1084 QueryDoubleValue( &d );
1085 return d;
1086 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001087 /// Query as a float. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001088 float FloatValue() const {
1089 float f=0;
1090 QueryFloatValue( &f );
1091 return f;
1092 }
U-Stream\Leeae25a442012-02-17 17:48:16 -08001093
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001094 /** QueryIntValue interprets the attribute as an integer, and returns the value
Andrew C. Martin0fd87462013-03-09 20:09:45 -07001095 in the provided parameter. The function will return XML_NO_ERROR on success,
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001096 and XML_WRONG_ATTRIBUTE_TYPE if the conversion is not successful.
1097 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001098 XMLError QueryIntValue( int* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001099 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001100 XMLError QueryUnsignedValue( unsigned int* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001101 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001102 XMLError QueryBoolValue( bool* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001103 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001104 XMLError QueryDoubleValue( double* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001105 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001106 XMLError QueryFloatValue( float* value ) const;
Lee Thomason50adb4c2012-02-13 15:07:09 -08001107
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001108 /// Set the attribute to a string value.
1109 void SetAttribute( const char* value );
1110 /// Set the attribute to value.
1111 void SetAttribute( int value );
1112 /// Set the attribute to value.
1113 void SetAttribute( unsigned value );
1114 /// Set the attribute to value.
1115 void SetAttribute( bool value );
1116 /// Set the attribute to value.
1117 void SetAttribute( double value );
1118 /// Set the attribute to value.
1119 void SetAttribute( float value );
Lee Thomason50adb4c2012-02-13 15:07:09 -08001120
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001121private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001122 enum { BUF_SIZE = 200 };
U-Stream\Lee09a11c52012-02-17 08:31:16 -08001123
Thomas Roß61892312013-05-12 14:07:38 +02001124 XMLAttribute() : _next( 0 ), _memPool( 0 ) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001125 virtual ~XMLAttribute() {}
Lee Thomason624d43f2012-10-12 10:58:48 -07001126
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001127 XMLAttribute( const XMLAttribute& ); // not supported
1128 void operator=( const XMLAttribute& ); // not supported
1129 void SetName( const char* name );
Lee Thomason50adb4c2012-02-13 15:07:09 -08001130
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001131 char* ParseDeep( char* p, bool processEntities );
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001132
Lee Thomason624d43f2012-10-12 10:58:48 -07001133 mutable StrPair _name;
1134 mutable StrPair _value;
1135 XMLAttribute* _next;
1136 MemPool* _memPool;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001137};
1138
1139
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001140/** The element is a container class. It has a value, the element name,
1141 and can contain other elements, text, comments, and unknowns.
1142 Elements also contain an arbitrary number of attributes.
1143*/
PKEuS16ed47d2013-07-06 12:02:43 +02001144class TINYXML2_LIB XMLElement : public XMLNode
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001145{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001146 friend class XMLDocument;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001147public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001148 /// Get the name of an element (which is the Value() of the node.)
1149 const char* Name() const {
1150 return Value();
1151 }
1152 /// Set the name of the element.
1153 void SetName( const char* str, bool staticMem=false ) {
1154 SetValue( str, staticMem );
1155 }
Lee Thomason2c85a712012-01-31 08:24:24 -08001156
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001157 virtual XMLElement* ToElement() {
1158 return this;
1159 }
1160 virtual const XMLElement* ToElement() const {
1161 return this;
1162 }
1163 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001164
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001165 /** Given an attribute name, Attribute() returns the value
1166 for the attribute of that name, or null if none
1167 exists. For example:
Lee Thomason92258152012-03-24 13:05:39 -07001168
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001169 @verbatim
1170 const char* value = ele->Attribute( "foo" );
1171 @endverbatim
Lee Thomason92258152012-03-24 13:05:39 -07001172
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001173 The 'value' parameter is normally null. However, if specified,
1174 the attribute will only be returned if the 'name' and 'value'
1175 match. This allow you to write code:
Lee Thomason8ba7f7d2012-03-24 13:04:04 -07001176
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001177 @verbatim
1178 if ( ele->Attribute( "foo", "bar" ) ) callFooIsBar();
1179 @endverbatim
Lee Thomason8ba7f7d2012-03-24 13:04:04 -07001180
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001181 rather than:
1182 @verbatim
1183 if ( ele->Attribute( "foo" ) ) {
1184 if ( strcmp( ele->Attribute( "foo" ), "bar" ) == 0 ) callFooIsBar();
1185 }
1186 @endverbatim
1187 */
1188 const char* Attribute( const char* name, const char* value=0 ) const;
Lee Thomason751da522012-02-10 08:50:51 -08001189
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001190 /** Given an attribute name, IntAttribute() returns the value
1191 of the attribute interpreted as an integer. 0 will be
1192 returned if there is an error. For a method with error
1193 checking, see QueryIntAttribute()
1194 */
1195 int IntAttribute( const char* name ) const {
1196 int i=0;
1197 QueryIntAttribute( name, &i );
1198 return i;
1199 }
1200 /// See IntAttribute()
1201 unsigned UnsignedAttribute( const char* name ) const {
1202 unsigned i=0;
1203 QueryUnsignedAttribute( name, &i );
1204 return i;
1205 }
1206 /// See IntAttribute()
1207 bool BoolAttribute( const char* name ) const {
1208 bool b=false;
1209 QueryBoolAttribute( name, &b );
1210 return b;
1211 }
1212 /// See IntAttribute()
1213 double DoubleAttribute( const char* name ) const {
1214 double d=0;
1215 QueryDoubleAttribute( name, &d );
1216 return d;
1217 }
1218 /// See IntAttribute()
1219 float FloatAttribute( const char* name ) const {
1220 float f=0;
1221 QueryFloatAttribute( name, &f );
1222 return f;
1223 }
U-Stream\Lee09a11c52012-02-17 08:31:16 -08001224
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001225 /** Given an attribute name, QueryIntAttribute() returns
1226 XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion
1227 can't be performed, or XML_NO_ATTRIBUTE if the attribute
1228 doesn't exist. If successful, the result of the conversion
1229 will be written to 'value'. If not successful, nothing will
1230 be written to 'value'. This allows you to provide default
1231 value:
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001232
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001233 @verbatim
1234 int value = 10;
1235 QueryIntAttribute( "foo", &value ); // if "foo" isn't found, value will still be 10
1236 @endverbatim
1237 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001238 XMLError QueryIntAttribute( const char* name, int* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001239 const XMLAttribute* a = FindAttribute( name );
1240 if ( !a ) {
1241 return XML_NO_ATTRIBUTE;
1242 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001243 return a->QueryIntValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001244 }
1245 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001246 XMLError QueryUnsignedAttribute( const char* name, unsigned int* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001247 const XMLAttribute* a = FindAttribute( name );
1248 if ( !a ) {
1249 return XML_NO_ATTRIBUTE;
1250 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001251 return a->QueryUnsignedValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001252 }
1253 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001254 XMLError QueryBoolAttribute( const char* name, bool* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001255 const XMLAttribute* a = FindAttribute( name );
1256 if ( !a ) {
1257 return XML_NO_ATTRIBUTE;
1258 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001259 return a->QueryBoolValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001260 }
1261 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001262 XMLError QueryDoubleAttribute( const char* name, double* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001263 const XMLAttribute* a = FindAttribute( name );
1264 if ( !a ) {
1265 return XML_NO_ATTRIBUTE;
1266 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001267 return a->QueryDoubleValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001268 }
1269 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001270 XMLError QueryFloatAttribute( const char* name, float* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001271 const XMLAttribute* a = FindAttribute( name );
1272 if ( !a ) {
1273 return XML_NO_ATTRIBUTE;
1274 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001275 return a->QueryFloatValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001276 }
Lee Thomason50f97b22012-02-11 16:33:40 -08001277
Lee Thomason (grinliz)5efaa5f2013-02-01 19:26:30 -08001278
1279 /** Given an attribute name, QueryAttribute() returns
1280 XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion
1281 can't be performed, or XML_NO_ATTRIBUTE if the attribute
1282 doesn't exist. It is overloaded for the primitive types,
1283 and is a generally more convenient replacement of
1284 QueryIntAttribute() and related functions.
1285
1286 If successful, the result of the conversion
1287 will be written to 'value'. If not successful, nothing will
1288 be written to 'value'. This allows you to provide default
1289 value:
1290
1291 @verbatim
1292 int value = 10;
1293 QueryAttribute( "foo", &value ); // if "foo" isn't found, value will still be 10
1294 @endverbatim
1295 */
1296 int QueryAttribute( const char* name, int* value ) const {
1297 return QueryIntAttribute( name, value );
1298 }
1299
1300 int QueryAttribute( const char* name, unsigned int* value ) const {
1301 return QueryUnsignedAttribute( name, value );
1302 }
1303
1304 int QueryAttribute( const char* name, bool* value ) const {
1305 return QueryBoolAttribute( name, value );
1306 }
1307
1308 int QueryAttribute( const char* name, double* value ) const {
1309 return QueryDoubleAttribute( name, value );
1310 }
1311
1312 int QueryAttribute( const char* name, float* value ) const {
1313 return QueryFloatAttribute( name, value );
1314 }
1315
1316 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001317 void SetAttribute( const char* name, const char* value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001318 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001319 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001320 }
1321 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001322 void SetAttribute( const char* name, int value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001323 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001324 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001325 }
1326 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001327 void SetAttribute( const char* name, unsigned value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001328 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001329 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001330 }
1331 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001332 void SetAttribute( const char* name, bool value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001333 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001334 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001335 }
1336 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001337 void SetAttribute( const char* name, double value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001338 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001339 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001340 }
Lee Thomasonc3708cc2014-01-14 12:30:03 -08001341 /// Sets the named attribute to value.
1342 void SetAttribute( const char* name, float value ) {
1343 XMLAttribute* a = FindOrCreateAttribute( name );
1344 a->SetAttribute( value );
1345 }
Lee Thomason50f97b22012-02-11 16:33:40 -08001346
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001347 /**
1348 Delete an attribute.
1349 */
1350 void DeleteAttribute( const char* name );
Lee Thomason751da522012-02-10 08:50:51 -08001351
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001352 /// Return the first attribute in the list.
1353 const XMLAttribute* FirstAttribute() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001354 return _rootAttribute;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001355 }
1356 /// Query a specific attribute in the list.
1357 const XMLAttribute* FindAttribute( const char* name ) const;
Lee Thomason751da522012-02-10 08:50:51 -08001358
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001359 /** Convenience function for easy access to the text inside an element. Although easy
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001360 and concise, GetText() is limited compared to getting the XMLText child
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001361 and accessing it directly.
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001362
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001363 If the first child of 'this' is a XMLText, the GetText()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001364 returns the character string of the Text node, else null is returned.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001365
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001366 This is a convenient method for getting the text of simple contained text:
1367 @verbatim
1368 <foo>This is text</foo>
1369 const char* str = fooElement->GetText();
1370 @endverbatim
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001371
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001372 'str' will be a pointer to "This is text".
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001373
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001374 Note that this function can be misleading. If the element foo was created from
1375 this XML:
1376 @verbatim
1377 <foo><b>This is text</b></foo>
1378 @endverbatim
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001379
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001380 then the value of str would be null. The first child node isn't a text node, it is
1381 another element. From this XML:
1382 @verbatim
1383 <foo>This is <b>text</b></foo>
1384 @endverbatim
1385 GetText() will return "This is ".
1386 */
1387 const char* GetText() const;
Lee Thomason751da522012-02-10 08:50:51 -08001388
Uli Kusterer85fff5e2014-01-21 01:35:30 +01001389 /** Convenience function for easy access to the text inside an element. Although easy
1390 and concise, SetText() is limited compared to creating an XMLText child
1391 and mutating it directly.
1392
1393 If the first child of 'this' is a XMLText, SetText() sets its value to
1394 the given string, otherwise it will create a first child that is an XMLText.
1395
1396 This is a convenient method for setting the text of simple contained text:
1397 @verbatim
1398 <foo>This is text</foo>
1399 fooElement->SetText( "Hullaballoo!" );
1400 <foo>Hullaballoo!</foo>
1401 @endverbatim
1402
1403 Note that this function can be misleading. If the element foo was created from
1404 this XML:
1405 @verbatim
1406 <foo><b>This is text</b></foo>
1407 @endverbatim
1408
1409 then it will not change "This is text", but rather prefix it with a text element:
1410 @verbatim
1411 <foo>Hullaballoo!<b>This is text</b></foo>
1412 @endverbatim
1413
1414 For this XML:
1415 @verbatim
1416 <foo />
1417 @endverbatim
1418 SetText() will generate
1419 @verbatim
1420 <foo>Hullaballoo!</foo>
1421 @endverbatim
1422 */
Lee Thomason5bb2d802014-01-24 10:42:57 -08001423 void SetText( const char* inText );
Dmitry-Me9e9c85b2015-10-19 18:04:46 +03001424 /// Convenience method for setting text inside an element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001425 void SetText( int value );
Dmitry-Me9e9c85b2015-10-19 18:04:46 +03001426 /// Convenience method for setting text inside an element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001427 void SetText( unsigned value );
Dmitry-Me9e9c85b2015-10-19 18:04:46 +03001428 /// Convenience method for setting text inside an element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001429 void SetText( bool value );
Dmitry-Me9e9c85b2015-10-19 18:04:46 +03001430 /// Convenience method for setting text inside an element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001431 void SetText( double value );
Dmitry-Me9e9c85b2015-10-19 18:04:46 +03001432 /// Convenience method for setting text inside an element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001433 void SetText( float value );
Uli Kusterer8fe342a2014-01-21 01:12:47 +01001434
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001435 /**
1436 Convenience method to query the value of a child text node. This is probably best
1437 shown by example. Given you have a document is this form:
1438 @verbatim
1439 <point>
1440 <x>1</x>
1441 <y>1.4</y>
1442 </point>
1443 @endverbatim
Lee Thomason21be8822012-07-15 17:27:22 -07001444
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001445 The QueryIntText() and similar functions provide a safe and easier way to get to the
1446 "value" of x and y.
Lee Thomason21be8822012-07-15 17:27:22 -07001447
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001448 @verbatim
1449 int x = 0;
1450 float y = 0; // types of x and y are contrived for example
1451 const XMLElement* xElement = pointElement->FirstChildElement( "x" );
1452 const XMLElement* yElement = pointElement->FirstChildElement( "y" );
1453 xElement->QueryIntText( &x );
1454 yElement->QueryFloatText( &y );
1455 @endverbatim
Lee Thomason21be8822012-07-15 17:27:22 -07001456
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001457 @returns XML_SUCCESS (0) on success, XML_CAN_NOT_CONVERT_TEXT if the text cannot be converted
1458 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 -07001459
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001460 */
MortenMacFly4ee49f12013-01-14 20:03:14 +01001461 XMLError QueryIntText( int* ival ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001462 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001463 XMLError QueryUnsignedText( unsigned* uval ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001464 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001465 XMLError QueryBoolText( bool* bval ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001466 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001467 XMLError QueryDoubleText( double* dval ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001468 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001469 XMLError QueryFloatText( float* fval ) const;
Lee Thomason21be8822012-07-15 17:27:22 -07001470
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001471 // internal:
1472 enum {
1473 OPEN, // <foo>
1474 CLOSED, // <foo/>
1475 CLOSING // </foo>
1476 };
1477 int ClosingType() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001478 return _closingType;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001479 }
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001480 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
1481 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001482
Dmitry-Me9b0f1772015-04-03 10:37:31 +03001483protected:
1484 char* ParseDeep( char* p, StrPair* endTag );
1485
Lee Thomason50adb4c2012-02-13 15:07:09 -08001486private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001487 XMLElement( XMLDocument* doc );
1488 virtual ~XMLElement();
1489 XMLElement( const XMLElement& ); // not supported
1490 void operator=( const XMLElement& ); // not supported
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001491
Dmitry-Me1227d512014-12-05 13:41:45 +03001492 XMLAttribute* FindAttribute( const char* name ) {
1493 return const_cast<XMLAttribute*>(const_cast<const XMLElement*>(this)->FindAttribute( name ));
1494 }
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001495 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() {
Dmitry-Me66487eb2015-07-20 18:21:04 +03001529 TIXMLASSERT( this == _document );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001530 return this;
1531 }
1532 virtual const XMLDocument* ToDocument() const {
Dmitry-Me66487eb2015-07-20 18:21:04 +03001533 TIXMLASSERT( this == _document );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001534 return this;
1535 }
Lee Thomason56bdd022012-02-09 18:16:58 -08001536
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001537 /**
1538 Parse an XML file from a character string.
1539 Returns XML_NO_ERROR (0) on success, or
1540 an errorID.
Lee Thomason (grinliz)e2bcb322012-09-17 17:58:25 -07001541
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001542 You may optionally pass in the 'nBytes', which is
1543 the number of bytes which will be parsed. If not
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001544 specified, TinyXML-2 will assume 'xml' points to a
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001545 null terminated string.
1546 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001547 XMLError Parse( const char* xml, size_t nBytes=(size_t)(-1) );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001548
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001549 /**
1550 Load an XML file from disk.
1551 Returns XML_NO_ERROR (0) on success, or
1552 an errorID.
1553 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001554 XMLError LoadFile( const char* filename );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001555
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001556 /**
1557 Load an XML file from disk. You are responsible
Lee Thomasoncd011bc2014-12-17 10:41:34 -08001558 for providing and closing the FILE*.
1559
1560 NOTE: The file should be opened as binary ("rb")
1561 not text in order for TinyXML-2 to correctly
1562 do newline normalization.
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001563
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001564 Returns XML_NO_ERROR (0) on success, or
1565 an errorID.
1566 */
Jerome Martinez242c3ea2013-01-06 12:20:04 +01001567 XMLError LoadFile( FILE* );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001568
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001569 /**
1570 Save the XML file to disk.
1571 Returns XML_NO_ERROR (0) on success, or
1572 an errorID.
1573 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001574 XMLError SaveFile( const char* filename, bool compact = false );
Lee Thomasond11cd162012-04-12 08:35:36 -07001575
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001576 /**
1577 Save the XML file to disk. You are responsible
1578 for providing and closing the FILE*.
Ken Miller81da1fb2012-04-09 23:32:26 -05001579
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001580 Returns XML_NO_ERROR (0) on success, or
1581 an errorID.
1582 */
Jerome Martinez242c3ea2013-01-06 12:20:04 +01001583 XMLError SaveFile( FILE* fp, bool compact = false );
Lee Thomason (grinliz)68db57e2012-02-21 09:08:12 -08001584
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001585 bool ProcessEntities() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001586 return _processEntities;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001587 }
1588 Whitespace WhitespaceMode() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001589 return _whitespace;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001590 }
Lee Thomason6f381b72012-03-02 12:59:39 -08001591
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001592 /**
1593 Returns true if this document has a leading Byte Order Mark of UTF8.
1594 */
1595 bool HasBOM() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001596 return _writeBOM;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001597 }
1598 /** Sets whether to write the BOM when writing the file.
1599 */
1600 void SetBOM( bool useBOM ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001601 _writeBOM = useBOM;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001602 }
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001603
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001604 /** Return the root element of DOM. Equivalent to FirstChildElement().
1605 To get the first node, use FirstChild().
1606 */
1607 XMLElement* RootElement() {
1608 return FirstChildElement();
1609 }
1610 const XMLElement* RootElement() const {
1611 return FirstChildElement();
1612 }
Lee Thomason18d68bd2012-01-26 18:17:26 -08001613
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001614 /** Print the Document. If the Printer is not provided, it will
1615 print to stdout. If you provide Printer, this can print to a file:
1616 @verbatim
1617 XMLPrinter printer( fp );
1618 doc.Print( &printer );
1619 @endverbatim
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001620
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001621 Or you can use a printer to print to memory:
1622 @verbatim
1623 XMLPrinter printer;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001624 doc.Print( &printer );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001625 // printer.CStr() has a const char* to the XML
1626 @endverbatim
1627 */
PKEuS1c5f99e2013-07-06 11:28:39 +02001628 void Print( XMLPrinter* streamer=0 ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001629 virtual bool Accept( XMLVisitor* visitor ) const;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001630
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001631 /**
1632 Create a new Element associated with
1633 this Document. The memory for the Element
1634 is managed by the Document.
1635 */
1636 XMLElement* NewElement( const char* name );
1637 /**
1638 Create a new Comment associated with
1639 this Document. The memory for the Comment
1640 is managed by the Document.
1641 */
1642 XMLComment* NewComment( const char* comment );
1643 /**
1644 Create a new Text associated with
1645 this Document. The memory for the Text
1646 is managed by the Document.
1647 */
1648 XMLText* NewText( const char* text );
1649 /**
1650 Create a new Declaration associated with
1651 this Document. The memory for the object
1652 is managed by the Document.
Lee Thomasonf68c4382012-04-28 14:37:11 -07001653
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001654 If the 'text' param is null, the standard
1655 declaration is used.:
1656 @verbatim
1657 <?xml version="1.0" encoding="UTF-8"?>
1658 @endverbatim
1659 */
1660 XMLDeclaration* NewDeclaration( const char* text=0 );
1661 /**
1662 Create a new Unknown associated with
Andrew C. Martin0fd87462013-03-09 20:09:45 -07001663 this Document. The memory for the object
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001664 is managed by the Document.
1665 */
1666 XMLUnknown* NewUnknown( const char* text );
Lee Thomason2c85a712012-01-31 08:24:24 -08001667
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001668 /**
1669 Delete a node associated with this document.
1670 It will be unlinked from the DOM.
1671 */
Lee Thomasoncd011bc2014-12-17 10:41:34 -08001672 void DeleteNode( XMLNode* node );
U-Stream\Leeae25a442012-02-17 17:48:16 -08001673
Lee Thomason2fa81722012-11-09 12:37:46 -08001674 void SetError( XMLError error, const char* str1, const char* str2 );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001675
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001676 /// Return true if there was an error parsing the document.
1677 bool Error() const {
Lee Thomason85536252016-06-04 19:10:53 -07001678 return _errorID != XML_SUCCESS;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001679 }
1680 /// Return the errorID.
Lee Thomason2fa81722012-11-09 12:37:46 -08001681 XMLError ErrorID() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001682 return _errorID;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001683 }
Lee Thomason331596e2014-09-11 14:56:43 -07001684 const char* ErrorName() const;
1685
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001686 /// Return a possibly helpful diagnostic location or string.
1687 const char* GetErrorStr1() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001688 return _errorStr1;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001689 }
1690 /// Return a possibly helpful secondary diagnostic location or string.
1691 const char* GetErrorStr2() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001692 return _errorStr2;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001693 }
1694 /// If there is an error, print it to stdout.
1695 void PrintError() const;
Martinsh Shaitersa9d42b02013-01-30 11:14:27 +02001696
1697 /// Clear the document, resetting it to the initial state.
1698 void Clear();
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001699
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001700 // internal
1701 char* Identify( char* p, XMLNode** node );
Lee Thomason2c85a712012-01-31 08:24:24 -08001702
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001703 virtual XMLNode* ShallowClone( XMLDocument* /*document*/ ) const {
1704 return 0;
1705 }
1706 virtual bool ShallowEqual( const XMLNode* /*compare*/ ) const {
1707 return false;
1708 }
Lee Thomason7d00b9a2012-02-27 17:54:22 -08001709
Lee Thomason3f57d272012-01-11 15:30:03 -08001710private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001711 XMLDocument( const XMLDocument& ); // not supported
1712 void operator=( const XMLDocument& ); // not supported
Lee Thomason18d68bd2012-01-26 18:17:26 -08001713
Lee Thomason2fa81722012-11-09 12:37:46 -08001714 bool _writeBOM;
1715 bool _processEntities;
1716 XMLError _errorID;
1717 Whitespace _whitespace;
Lee Thomason624d43f2012-10-12 10:58:48 -07001718 const char* _errorStr1;
1719 const char* _errorStr2;
Lee Thomason2fa81722012-11-09 12:37:46 -08001720 char* _charBuffer;
Lee Thomasond1983222012-02-06 08:41:24 -08001721
Lee Thomason624d43f2012-10-12 10:58:48 -07001722 MemPoolT< sizeof(XMLElement) > _elementPool;
1723 MemPoolT< sizeof(XMLAttribute) > _attributePool;
1724 MemPoolT< sizeof(XMLText) > _textPool;
1725 MemPoolT< sizeof(XMLComment) > _commentPool;
Lee Thomason331596e2014-09-11 14:56:43 -07001726
1727 static const char* _errorNames[XML_ERROR_COUNT];
Dmitry-Me97476b72015-01-01 16:15:57 +03001728
1729 void Parse();
Lee Thomason5cae8972012-01-24 18:03:07 -08001730};
1731
Lee Thomason7c913cd2012-01-26 18:32:34 -08001732
Lee Thomason3ffdd392012-03-28 17:27:55 -07001733/**
1734 A XMLHandle is a class that wraps a node pointer with null checks; this is
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001735 an incredibly useful thing. Note that XMLHandle is not part of the TinyXML-2
Lee Thomason3ffdd392012-03-28 17:27:55 -07001736 DOM structure. It is a separate utility class.
1737
1738 Take an example:
1739 @verbatim
1740 <Document>
1741 <Element attributeA = "valueA">
1742 <Child attributeB = "value1" />
1743 <Child attributeB = "value2" />
1744 </Element>
Thomas Roß08bdf502012-05-12 14:21:23 +02001745 </Document>
Lee Thomason3ffdd392012-03-28 17:27:55 -07001746 @endverbatim
1747
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001748 Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very
Lee Thomason3ffdd392012-03-28 17:27:55 -07001749 easy to write a *lot* of code that looks like:
1750
1751 @verbatim
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001752 XMLElement* root = document.FirstChildElement( "Document" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001753 if ( root )
1754 {
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001755 XMLElement* element = root->FirstChildElement( "Element" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001756 if ( element )
1757 {
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001758 XMLElement* child = element->FirstChildElement( "Child" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001759 if ( child )
1760 {
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001761 XMLElement* child2 = child->NextSiblingElement( "Child" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001762 if ( child2 )
1763 {
1764 // Finally do something useful.
1765 @endverbatim
1766
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001767 And that doesn't even cover "else" cases. XMLHandle addresses the verbosity
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001768 of such code. A XMLHandle checks for null pointers so it is perfectly safe
Lee Thomason3ffdd392012-03-28 17:27:55 -07001769 and correct to use:
1770
1771 @verbatim
Lee Thomasondb0bbb62012-04-04 15:47:04 -07001772 XMLHandle docHandle( &document );
Dmitry-Mea317bd62014-12-08 10:35:37 +03001773 XMLElement* child2 = docHandle.FirstChildElement( "Document" ).FirstChildElement( "Element" ).FirstChildElement().NextSiblingElement();
Lee Thomason3ffdd392012-03-28 17:27:55 -07001774 if ( child2 )
1775 {
1776 // do something useful
1777 @endverbatim
1778
1779 Which is MUCH more concise and useful.
1780
1781 It is also safe to copy handles - internally they are nothing more than node pointers.
1782 @verbatim
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001783 XMLHandle handleCopy = handle;
Lee Thomason3ffdd392012-03-28 17:27:55 -07001784 @endverbatim
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001785
1786 See also XMLConstHandle, which is the same as XMLHandle, but operates on const objects.
Lee Thomason3ffdd392012-03-28 17:27:55 -07001787*/
PKEuS16ed47d2013-07-06 12:02:43 +02001788class TINYXML2_LIB XMLHandle
Lee Thomason3ffdd392012-03-28 17:27:55 -07001789{
1790public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001791 /// 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 -07001792 XMLHandle( XMLNode* node ) {
1793 _node = node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001794 }
1795 /// Create a handle from a node.
Lee Thomason624d43f2012-10-12 10:58:48 -07001796 XMLHandle( XMLNode& node ) {
1797 _node = &node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001798 }
1799 /// Copy constructor
1800 XMLHandle( const XMLHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001801 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001802 }
1803 /// Assignment
1804 XMLHandle& operator=( const XMLHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001805 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001806 return *this;
1807 }
Lee Thomason3ffdd392012-03-28 17:27:55 -07001808
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001809 /// Get the first child of this handle.
1810 XMLHandle FirstChild() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001811 return XMLHandle( _node ? _node->FirstChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001812 }
1813 /// Get the first child element of this handle.
Dmitry-Me886ad972015-07-22 11:00:51 +03001814 XMLHandle FirstChildElement( const char* name = 0 ) {
1815 return XMLHandle( _node ? _node->FirstChildElement( name ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001816 }
1817 /// Get the last child of this handle.
1818 XMLHandle LastChild() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001819 return XMLHandle( _node ? _node->LastChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001820 }
1821 /// Get the last child element of this handle.
Dmitry-Me886ad972015-07-22 11:00:51 +03001822 XMLHandle LastChildElement( const char* name = 0 ) {
1823 return XMLHandle( _node ? _node->LastChildElement( name ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001824 }
1825 /// Get the previous sibling of this handle.
1826 XMLHandle PreviousSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001827 return XMLHandle( _node ? _node->PreviousSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001828 }
1829 /// Get the previous sibling element of this handle.
Dmitry-Me886ad972015-07-22 11:00:51 +03001830 XMLHandle PreviousSiblingElement( const char* name = 0 ) {
1831 return XMLHandle( _node ? _node->PreviousSiblingElement( name ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001832 }
1833 /// Get the next sibling of this handle.
1834 XMLHandle NextSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001835 return XMLHandle( _node ? _node->NextSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001836 }
1837 /// Get the next sibling element of this handle.
Dmitry-Me886ad972015-07-22 11:00:51 +03001838 XMLHandle NextSiblingElement( const char* name = 0 ) {
1839 return XMLHandle( _node ? _node->NextSiblingElement( name ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001840 }
Lee Thomason3ffdd392012-03-28 17:27:55 -07001841
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001842 /// Safe cast to XMLNode. This can return null.
1843 XMLNode* ToNode() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001844 return _node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001845 }
1846 /// Safe cast to XMLElement. This can return null.
1847 XMLElement* ToElement() {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001848 return ( ( _node == 0 ) ? 0 : _node->ToElement() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001849 }
1850 /// Safe cast to XMLText. This can return null.
1851 XMLText* ToText() {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001852 return ( ( _node == 0 ) ? 0 : _node->ToText() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001853 }
1854 /// Safe cast to XMLUnknown. This can return null.
1855 XMLUnknown* ToUnknown() {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001856 return ( ( _node == 0 ) ? 0 : _node->ToUnknown() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001857 }
1858 /// Safe cast to XMLDeclaration. This can return null.
1859 XMLDeclaration* ToDeclaration() {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001860 return ( ( _node == 0 ) ? 0 : _node->ToDeclaration() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001861 }
Lee Thomason3ffdd392012-03-28 17:27:55 -07001862
1863private:
Lee Thomason624d43f2012-10-12 10:58:48 -07001864 XMLNode* _node;
Lee Thomason3ffdd392012-03-28 17:27:55 -07001865};
1866
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001867
1868/**
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001869 A variant of the XMLHandle class for working with const XMLNodes and Documents. It is the
1870 same in all regards, except for the 'const' qualifiers. See XMLHandle for API.
Lee Thomason8b899812012-04-04 15:58:16 -07001871*/
PKEuS16ed47d2013-07-06 12:02:43 +02001872class TINYXML2_LIB XMLConstHandle
Lee Thomason8b899812012-04-04 15:58:16 -07001873{
1874public:
Lee Thomason624d43f2012-10-12 10:58:48 -07001875 XMLConstHandle( const XMLNode* node ) {
1876 _node = node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001877 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001878 XMLConstHandle( const XMLNode& node ) {
1879 _node = &node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001880 }
1881 XMLConstHandle( const XMLConstHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001882 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001883 }
Lee Thomason8b899812012-04-04 15:58:16 -07001884
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001885 XMLConstHandle& operator=( const XMLConstHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001886 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001887 return *this;
1888 }
Lee Thomason8b899812012-04-04 15:58:16 -07001889
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001890 const XMLConstHandle FirstChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001891 return XMLConstHandle( _node ? _node->FirstChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001892 }
Dmitry-Me886ad972015-07-22 11:00:51 +03001893 const XMLConstHandle FirstChildElement( const char* name = 0 ) const {
1894 return XMLConstHandle( _node ? _node->FirstChildElement( name ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001895 }
1896 const XMLConstHandle LastChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001897 return XMLConstHandle( _node ? _node->LastChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001898 }
Dmitry-Me886ad972015-07-22 11:00:51 +03001899 const XMLConstHandle LastChildElement( const char* name = 0 ) const {
1900 return XMLConstHandle( _node ? _node->LastChildElement( name ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001901 }
1902 const XMLConstHandle PreviousSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001903 return XMLConstHandle( _node ? _node->PreviousSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001904 }
Dmitry-Me886ad972015-07-22 11:00:51 +03001905 const XMLConstHandle PreviousSiblingElement( const char* name = 0 ) const {
1906 return XMLConstHandle( _node ? _node->PreviousSiblingElement( name ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001907 }
1908 const XMLConstHandle NextSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001909 return XMLConstHandle( _node ? _node->NextSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001910 }
Dmitry-Me886ad972015-07-22 11:00:51 +03001911 const XMLConstHandle NextSiblingElement( const char* name = 0 ) const {
1912 return XMLConstHandle( _node ? _node->NextSiblingElement( name ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001913 }
Lee Thomason8b899812012-04-04 15:58:16 -07001914
1915
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001916 const XMLNode* ToNode() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001917 return _node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001918 }
1919 const XMLElement* ToElement() const {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001920 return ( ( _node == 0 ) ? 0 : _node->ToElement() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001921 }
1922 const XMLText* ToText() const {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001923 return ( ( _node == 0 ) ? 0 : _node->ToText() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001924 }
1925 const XMLUnknown* ToUnknown() const {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001926 return ( ( _node == 0 ) ? 0 : _node->ToUnknown() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001927 }
1928 const XMLDeclaration* ToDeclaration() const {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001929 return ( ( _node == 0 ) ? 0 : _node->ToDeclaration() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001930 }
Lee Thomason (grinliz)bd0a8ac2012-02-20 20:14:33 -08001931
Lee Thomason5cae8972012-01-24 18:03:07 -08001932private:
Lee Thomason624d43f2012-10-12 10:58:48 -07001933 const XMLNode* _node;
Lee Thomason56bdd022012-02-09 18:16:58 -08001934};
Lee Thomason6f381b72012-03-02 12:59:39 -08001935
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001936
1937/**
1938 Printing functionality. The XMLPrinter gives you more
1939 options than the XMLDocument::Print() method.
1940
1941 It can:
1942 -# Print to memory.
Thomas Roß08bdf502012-05-12 14:21:23 +02001943 -# Print to a file you provide.
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001944 -# Print XML without a XMLDocument.
1945
1946 Print to Memory
1947
1948 @verbatim
1949 XMLPrinter printer;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001950 doc.Print( &printer );
Thomas Roß08bdf502012-05-12 14:21:23 +02001951 SomeFunction( printer.CStr() );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001952 @endverbatim
1953
1954 Print to a File
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001955
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001956 You provide the file pointer.
1957 @verbatim
1958 XMLPrinter printer( fp );
1959 doc.Print( &printer );
1960 @endverbatim
1961
1962 Print without a XMLDocument
1963
1964 When loading, an XML parser is very useful. However, sometimes
1965 when saving, it just gets in the way. The code is often set up
1966 for streaming, and constructing the DOM is just overhead.
1967
1968 The Printer supports the streaming case. The following code
1969 prints out a trivially simple XML file without ever creating
1970 an XML document.
1971
1972 @verbatim
1973 XMLPrinter printer( fp );
1974 printer.OpenElement( "foo" );
1975 printer.PushAttribute( "foo", "bar" );
1976 printer.CloseElement();
1977 @endverbatim
1978*/
PKEuS16ed47d2013-07-06 12:02:43 +02001979class TINYXML2_LIB XMLPrinter : public XMLVisitor
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001980{
1981public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001982 /** Construct the printer. If the FILE* is specified,
1983 this will print to the FILE. Else it will print
1984 to memory, and the result is available in CStr().
1985 If 'compact' is set to true, then output is created
1986 with only required whitespace and newlines.
1987 */
PKEuS1bfb9542013-08-04 13:51:17 +02001988 XMLPrinter( FILE* file=0, bool compact = false, int depth = 0 );
Dennis Jenkins59c75d32013-10-08 13:10:07 -05001989 virtual ~XMLPrinter() {}
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001990
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001991 /** If streaming, write the BOM and declaration. */
1992 void PushHeader( bool writeBOM, bool writeDeclaration );
1993 /** If streaming, start writing an element.
1994 The element must be closed with CloseElement()
1995 */
Lee Thomason256adb62014-04-06 14:41:46 -07001996 void OpenElement( const char* name, bool compactMode=false );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001997 /// If streaming, add an attribute to an open element.
1998 void PushAttribute( const char* name, const char* value );
1999 void PushAttribute( const char* name, int value );
2000 void PushAttribute( const char* name, unsigned value );
2001 void PushAttribute( const char* name, bool value );
2002 void PushAttribute( const char* name, double value );
2003 /// If streaming, close the Element.
Lee Thomason256adb62014-04-06 14:41:46 -07002004 virtual void CloseElement( bool compactMode=false );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002005
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002006 /// Add a text node.
2007 void PushText( const char* text, bool cdata=false );
2008 /// Add a text node from an integer.
2009 void PushText( int value );
2010 /// Add a text node from an unsigned.
2011 void PushText( unsigned value );
2012 /// Add a text node from a bool.
2013 void PushText( bool value );
2014 /// Add a text node from a float.
2015 void PushText( float value );
2016 /// Add a text node from a double.
2017 void PushText( double value );
Lee Thomason21be8822012-07-15 17:27:22 -07002018
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002019 /// Add a comment
2020 void PushComment( const char* comment );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002021
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002022 void PushDeclaration( const char* value );
2023 void PushUnknown( const char* value );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002024
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002025 virtual bool VisitEnter( const XMLDocument& /*doc*/ );
2026 virtual bool VisitExit( const XMLDocument& /*doc*/ ) {
2027 return true;
2028 }
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002029
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002030 virtual bool VisitEnter( const XMLElement& element, const XMLAttribute* attribute );
2031 virtual bool VisitExit( const XMLElement& element );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002032
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002033 virtual bool Visit( const XMLText& text );
2034 virtual bool Visit( const XMLComment& comment );
2035 virtual bool Visit( const XMLDeclaration& declaration );
2036 virtual bool Visit( const XMLUnknown& unknown );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002037
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002038 /**
2039 If in print to memory mode, return a pointer to
2040 the XML file in memory.
2041 */
2042 const char* CStr() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07002043 return _buffer.Mem();
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002044 }
2045 /**
2046 If in print to memory mode, return the size
2047 of the XML file in memory. (Note the size returned
2048 includes the terminating null.)
2049 */
2050 int CStrSize() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07002051 return _buffer.Size();
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002052 }
Reinhard Klambauer3bc3d4e2013-11-22 14:05:21 +01002053 /**
2054 If in print to memory mode, reset the buffer to the
2055 beginning.
2056 */
Lee Thomasonce0510b2013-11-26 21:29:37 -08002057 void ClearBuffer() {
2058 _buffer.Clear();
Reinhard Klambauer3bc3d4e2013-11-22 14:05:21 +01002059 _buffer.Push(0);
2060 }
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002061
Dennis Jenkins59c75d32013-10-08 13:10:07 -05002062protected:
Alexander Maid740b642014-05-20 22:04:42 +02002063 virtual bool CompactMode( const XMLElement& ) { return _compactMode; }
Uli Kusterer5d1d27e2014-02-20 11:50:22 +01002064
Lee Thomasonc18eb232014-02-21 17:31:17 -08002065 /** Prints out the space before an element. You may override to change
2066 the space and tabs used. A PrintSpace() override should call Print().
2067 */
2068 virtual void PrintSpace( int depth );
2069 void Print( const char* format, ... );
2070
Dmitry-Mea092bc12014-12-23 17:57:05 +03002071 void SealElementIfJustOpened();
Dennis Jenkins59c75d32013-10-08 13:10:07 -05002072 bool _elementJustOpened;
2073 DynArray< const char*, 10 > _stack;
2074
2075private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002076 void PrintString( const char*, bool restrictedEntitySet ); // prints out, after detecting entities.
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002077
Lee Thomason624d43f2012-10-12 10:58:48 -07002078 bool _firstElement;
Jerome Martinez242c3ea2013-01-06 12:20:04 +01002079 FILE* _fp;
Lee Thomason624d43f2012-10-12 10:58:48 -07002080 int _depth;
2081 int _textDepth;
2082 bool _processEntities;
Lee Thomasonc18eb232014-02-21 17:31:17 -08002083 bool _compactMode;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002084
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002085 enum {
2086 ENTITY_RANGE = 64,
2087 BUF_SIZE = 200
2088 };
Lee Thomason624d43f2012-10-12 10:58:48 -07002089 bool _entityFlag[ENTITY_RANGE];
2090 bool _restrictedEntityFlag[ENTITY_RANGE];
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002091
Lee Thomason624d43f2012-10-12 10:58:48 -07002092 DynArray< char, 20 > _buffer;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002093};
2094
2095
Guillermo A. Amaralb42ba362012-03-20 00:15:30 -07002096} // tinyxml2
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002097
PKEuS95060352013-07-26 10:42:44 +02002098#if defined(_MSC_VER)
2099# pragma warning(pop)
2100#endif
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002101
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002102#endif // TINYXML2_INCLUDED