blob: 227550a08e61ecedbc0fd8739976d4455031b470 [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 Thomason1889c3e2016-06-04 20:22:57 -070043#include <stdint.h>
Lee Thomason (grinliz)6a22be22012-04-04 12:39:05 -070044
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -070045/*
Lee Thomason7d00b9a2012-02-27 17:54:22 -080046 TODO: intern strings instead of allocation.
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -080047*/
Lee Thomason (grinliz)9b093cc2012-02-25 21:30:18 -080048/*
Lee Thomasona9cf3f92012-10-11 16:56:51 -070049 gcc:
Lee Thomason5b0a6772012-11-19 13:54:42 -080050 g++ -Wall -DDEBUG tinyxml2.cpp xmltest.cpp -o gccxmltest.exe
MortenMacFly4ee49f12013-01-14 20:03:14 +010051
Lee Thomasona9cf3f92012-10-11 16:56:51 -070052 Formatting, Artistic Style:
53 AStyle.exe --style=1tbs --indent-switches --break-closing-brackets --indent-preprocessor tinyxml2.cpp tinyxml2.h
Lee Thomason (grinliz)9b093cc2012-02-25 21:30:18 -080054*/
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -080055
U-Lama\Lee4cee6112011-12-31 14:58:18 -080056#if defined( _DEBUG ) || defined( DEBUG ) || defined (__DEBUG__)
Lee Thomasona9cf3f92012-10-11 16:56:51 -070057# ifndef DEBUG
58# define DEBUG
59# endif
U-Lama\Lee4cee6112011-12-31 14:58:18 -080060#endif
61
PKEuS95060352013-07-26 10:42:44 +020062#ifdef _MSC_VER
63# pragma warning(push)
64# pragma warning(disable: 4251)
65#endif
U-Lama\Lee4cee6112011-12-31 14:58:18 -080066
PKEuS16ed47d2013-07-06 12:02:43 +020067#ifdef _WIN32
68# ifdef TINYXML2_EXPORT
69# define TINYXML2_LIB __declspec(dllexport)
70# elif defined(TINYXML2_IMPORT)
71# define TINYXML2_LIB __declspec(dllimport)
72# else
73# define TINYXML2_LIB
74# endif
75#else
76# define TINYXML2_LIB
77#endif
78
79
U-Lama\Lee4cee6112011-12-31 14:58:18 -080080#if defined(DEBUG)
Lee Thomasona9cf3f92012-10-11 16:56:51 -070081# if defined(_MSC_VER)
Dmitry-Me4bcbf142014-12-25 19:05:18 +030082# // "(void)0," is for suppressing C4127 warning in "assert(false)", "assert(true)" and the like
Lee Thomason598a88d2015-10-09 14:42:12 -070083# define TIXMLASSERT( x ) if ( !((void)0,(x))) { __debugbreak(); }
Lee Thomasona9cf3f92012-10-11 16:56:51 -070084# elif defined (ANDROID_NDK)
85# include <android/log.h>
86# define TIXMLASSERT( x ) if ( !(x)) { __android_log_assert( "assert", "grinliz", "ASSERT in '%s' at %d.", __FILE__, __LINE__ ); }
87# else
88# include <assert.h>
89# define TIXMLASSERT assert
90# endif
Lee Thomason598a88d2015-10-09 14:42:12 -070091#else
92# define TIXMLASSERT( x ) {}
U-Lama\Lee4cee6112011-12-31 14:58:18 -080093#endif
94
U-Lama\Leee13c3e62011-12-28 14:36:55 -080095
Lee Thomasonc18eb232014-02-21 17:31:17 -080096/* Versioning, past 1.0.14:
Lee Thomason85afe9c2014-02-23 21:42:16 -080097 http://semver.org/
Lee Thomasonc18eb232014-02-21 17:31:17 -080098*/
Sarat Addepalli9afd1d02015-05-19 12:56:27 +053099static const int TIXML2_MAJOR_VERSION = 3;
100static const int TIXML2_MINOR_VERSION = 0;
101static const int TIXML2_PATCH_VERSION = 0;
Lee Thomason1ff38e02012-02-14 18:18:16 -0800102
U-Lama\Leee13c3e62011-12-28 14:36:55 -0800103namespace tinyxml2
104{
Lee Thomasonce0763e2012-01-11 15:43:54 -0800105class XMLDocument;
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800106class XMLElement;
107class XMLAttribute;
108class XMLComment;
Lee Thomason5492a1c2012-01-23 15:32:10 -0800109class XMLText;
Lee Thomason50f97b22012-02-11 16:33:40 -0800110class XMLDeclaration;
111class XMLUnknown;
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800112class XMLPrinter;
Lee Thomason5cae8972012-01-24 18:03:07 -0800113
U-Stream\Leeae25a442012-02-17 17:48:16 -0800114/*
115 A class that wraps strings. Normally stores the start and end
116 pointers into the XML file itself, and will apply normalization
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800117 and entity translation if actually read. Can also store (and memory
U-Stream\Leeae25a442012-02-17 17:48:16 -0800118 manage) a traditional char[]
119*/
PKEuS95060352013-07-26 10:42:44 +0200120class StrPair
Lee Thomason39ede242012-01-20 11:27:56 -0800121{
Lee Thomasond34f52c2012-01-20 12:55:24 -0800122public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700123 enum {
124 NEEDS_ENTITY_PROCESSING = 0x01,
125 NEEDS_NEWLINE_NORMALIZATION = 0x02,
Dmitry-Me5420e542015-05-20 10:51:26 +0300126 NEEDS_WHITESPACE_COLLAPSING = 0x04,
Lee Thomason18d68bd2012-01-26 18:17:26 -0800127
selfpoisede77e1952013-03-13 14:08:29 +0800128 TEXT_ELEMENT = NEEDS_ENTITY_PROCESSING | NEEDS_NEWLINE_NORMALIZATION,
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700129 TEXT_ELEMENT_LEAVE_ENTITIES = NEEDS_NEWLINE_NORMALIZATION,
selfpoisede77e1952013-03-13 14:08:29 +0800130 ATTRIBUTE_NAME = 0,
131 ATTRIBUTE_VALUE = NEEDS_ENTITY_PROCESSING | NEEDS_NEWLINE_NORMALIZATION,
132 ATTRIBUTE_VALUE_LEAVE_ENTITIES = NEEDS_NEWLINE_NORMALIZATION,
133 COMMENT = NEEDS_NEWLINE_NORMALIZATION
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700134 };
Lee Thomason39ede242012-01-20 11:27:56 -0800135
Lee Thomason120b3a62012-10-12 10:06:59 -0700136 StrPair() : _flags( 0 ), _start( 0 ), _end( 0 ) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700137 ~StrPair();
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800138
Lee Thomason120b3a62012-10-12 10:06:59 -0700139 void Set( char* start, char* end, int flags ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700140 Reset();
Lee Thomason120b3a62012-10-12 10:06:59 -0700141 _start = start;
142 _end = end;
143 _flags = flags | NEEDS_FLUSH;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700144 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700145
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700146 const char* GetStr();
Lee Thomason120b3a62012-10-12 10:06:59 -0700147
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700148 bool Empty() const {
Lee Thomason120b3a62012-10-12 10:06:59 -0700149 return _start == _end;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700150 }
Lee Thomason39ede242012-01-20 11:27:56 -0800151
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700152 void SetInternedStr( const char* str ) {
153 Reset();
Lee Thomason120b3a62012-10-12 10:06:59 -0700154 _start = const_cast<char*>(str);
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700155 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700156
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700157 void SetStr( const char* str, int flags=0 );
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800158
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700159 char* ParseText( char* in, const char* endTag, int strFlags );
160 char* ParseName( char* in );
Lee Thomason56bdd022012-02-09 18:16:58 -0800161
Lee Thomason29658802014-11-27 22:31:11 -0800162 void TransferTo( StrPair* other );
Dmitry-Me08b40dd2014-11-10 11:17:21 +0300163
Lee Thomason39ede242012-01-20 11:27:56 -0800164private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700165 void Reset();
166 void CollapseWhitespace();
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800167
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700168 enum {
169 NEEDS_FLUSH = 0x100,
170 NEEDS_DELETE = 0x200
171 };
Lee Thomasone4422302012-01-20 17:59:50 -0800172
Lee Thomason120b3a62012-10-12 10:06:59 -0700173 int _flags;
174 char* _start;
175 char* _end;
Dmitry-Me08b40dd2014-11-10 11:17:21 +0300176
177 StrPair( const StrPair& other ); // not supported
178 void operator=( StrPair& other ); // not supported, use TransferTo()
Lee Thomason39ede242012-01-20 11:27:56 -0800179};
180
U-Lama\Lee560bd472011-12-28 19:42:49 -0800181
U-Stream\Leeae25a442012-02-17 17:48:16 -0800182/*
183 A dynamic array of Plain Old Data. Doesn't support constructors, etc.
184 Has a small initial memory pool, so that low or no usage will not
185 cause a call to new/delete
186*/
Dmitry-Me04009222015-04-06 18:07:18 +0300187template <class T, int INITIAL_SIZE>
PKEuS95060352013-07-26 10:42:44 +0200188class DynArray
Lee Thomason2c85a712012-01-31 08:24:24 -0800189{
190public:
Dmitry-Me9a5a48d2015-01-14 08:27:32 +0300191 DynArray() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700192 _mem = _pool;
Dmitry-Me04009222015-04-06 18:07:18 +0300193 _allocated = INITIAL_SIZE;
Lee Thomason624d43f2012-10-12 10:58:48 -0700194 _size = 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700195 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700196
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700197 ~DynArray() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700198 if ( _mem != _pool ) {
Lee Thomasoned5c8792012-10-12 10:09:48 -0700199 delete [] _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700200 }
201 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700202
Lee Thomasonce0510b2013-11-26 21:29:37 -0800203 void Clear() {
Reinhard Klambauer4e74b132013-11-22 14:01:58 +0100204 _size = 0;
205 }
206
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700207 void Push( T t ) {
Dmitry-Meed7a7dc2015-01-14 08:36:12 +0300208 TIXMLASSERT( _size < INT_MAX );
Lee Thomason624d43f2012-10-12 10:58:48 -0700209 EnsureCapacity( _size+1 );
210 _mem[_size++] = t;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700211 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800212
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700213 T* PushArr( int count ) {
Dmitry-Me74fb8702015-01-13 10:27:36 +0300214 TIXMLASSERT( count >= 0 );
Dmitry-Meed7a7dc2015-01-14 08:36:12 +0300215 TIXMLASSERT( _size <= INT_MAX - count );
Lee Thomason624d43f2012-10-12 10:58:48 -0700216 EnsureCapacity( _size+count );
217 T* ret = &_mem[_size];
218 _size += count;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700219 return ret;
220 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700221
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700222 T Pop() {
Dmitry-Me74fb8702015-01-13 10:27:36 +0300223 TIXMLASSERT( _size > 0 );
Lee Thomason624d43f2012-10-12 10:58:48 -0700224 return _mem[--_size];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700225 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700226
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700227 void PopArr( int count ) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700228 TIXMLASSERT( _size >= count );
229 _size -= count;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700230 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800231
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700232 bool Empty() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700233 return _size == 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700234 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700235
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700236 T& operator[](int i) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700237 TIXMLASSERT( i>= 0 && i < _size );
Lee Thomasoned5c8792012-10-12 10:09:48 -0700238 return _mem[i];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700239 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700240
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700241 const T& operator[](int i) const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700242 TIXMLASSERT( i>= 0 && i < _size );
Lee Thomasoned5c8792012-10-12 10:09:48 -0700243 return _mem[i];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700244 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700245
Lee Thomasonf07b9522014-10-30 13:25:12 -0700246 const T& PeekTop() const {
Dennis Jenkins59c75d32013-10-08 13:10:07 -0500247 TIXMLASSERT( _size > 0 );
248 return _mem[ _size - 1];
249 }
250
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700251 int Size() const {
Dmitry-Me30bdc972015-01-14 08:32:23 +0300252 TIXMLASSERT( _size >= 0 );
Lee Thomason624d43f2012-10-12 10:58:48 -0700253 return _size;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700254 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700255
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700256 int Capacity() const {
Dmitry-Me2f5a1032015-06-18 16:40:09 +0300257 TIXMLASSERT( _allocated >= INITIAL_SIZE );
Lee Thomason624d43f2012-10-12 10:58:48 -0700258 return _allocated;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700259 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700260
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700261 const T* Mem() const {
Dmitry-Me2f5a1032015-06-18 16:40:09 +0300262 TIXMLASSERT( _mem );
Lee Thomasoned5c8792012-10-12 10:09:48 -0700263 return _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700264 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700265
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700266 T* Mem() {
Dmitry-Me2f5a1032015-06-18 16:40:09 +0300267 TIXMLASSERT( _mem );
Lee Thomasoned5c8792012-10-12 10:09:48 -0700268 return _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700269 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800270
Lee Thomason2c85a712012-01-31 08:24:24 -0800271private:
Dmitry-Me3e0af372015-01-09 15:30:00 +0300272 DynArray( const DynArray& ); // not supported
273 void operator=( const DynArray& ); // not supported
274
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700275 void EnsureCapacity( int cap ) {
Dmitry-Me9fae8692014-12-22 17:59:59 +0300276 TIXMLASSERT( cap > 0 );
Lee Thomason624d43f2012-10-12 10:58:48 -0700277 if ( cap > _allocated ) {
Dmitry-Me9fae8692014-12-22 17:59:59 +0300278 TIXMLASSERT( cap <= INT_MAX / 2 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700279 int newAllocated = cap * 2;
280 T* newMem = new T[newAllocated];
Lee Thomason624d43f2012-10-12 10:58:48 -0700281 memcpy( newMem, _mem, sizeof(T)*_size ); // warning: not using constructors, only works for PODs
282 if ( _mem != _pool ) {
Lee Thomasoned5c8792012-10-12 10:09:48 -0700283 delete [] _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700284 }
Lee Thomasoned5c8792012-10-12 10:09:48 -0700285 _mem = newMem;
Lee Thomason624d43f2012-10-12 10:58:48 -0700286 _allocated = newAllocated;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700287 }
288 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800289
Lee Thomason624d43f2012-10-12 10:58:48 -0700290 T* _mem;
Dmitry-Me04009222015-04-06 18:07:18 +0300291 T _pool[INITIAL_SIZE];
Lee Thomason624d43f2012-10-12 10:58:48 -0700292 int _allocated; // objects allocated
293 int _size; // number objects in use
Lee Thomason2c85a712012-01-31 08:24:24 -0800294};
295
Lee Thomason50adb4c2012-02-13 15:07:09 -0800296
U-Stream\Leeae25a442012-02-17 17:48:16 -0800297/*
Thomas Roß08bdf502012-05-12 14:21:23 +0200298 Parent virtual class of a pool for fast allocation
U-Stream\Leeae25a442012-02-17 17:48:16 -0800299 and deallocation of objects.
300*/
PKEuS95060352013-07-26 10:42:44 +0200301class MemPool
Lee Thomasond1983222012-02-06 08:41:24 -0800302{
303public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700304 MemPool() {}
305 virtual ~MemPool() {}
Lee Thomasond1983222012-02-06 08:41:24 -0800306
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700307 virtual int ItemSize() const = 0;
308 virtual void* Alloc() = 0;
309 virtual void Free( void* ) = 0;
Lee Thomason5b0a6772012-11-19 13:54:42 -0800310 virtual void SetTracked() = 0;
Lee Thomasonf07b9522014-10-30 13:25:12 -0700311 virtual void Clear() = 0;
Lee Thomasond1983222012-02-06 08:41:24 -0800312};
313
Lee Thomason50adb4c2012-02-13 15:07:09 -0800314
U-Stream\Leeae25a442012-02-17 17:48:16 -0800315/*
316 Template child class to create pools of the correct type.
317*/
Lee Thomasond1983222012-02-06 08:41:24 -0800318template< int SIZE >
PKEuS95060352013-07-26 10:42:44 +0200319class MemPoolT : public MemPool
Lee Thomasond1983222012-02-06 08:41:24 -0800320{
321public:
Lee Thomason5b0a6772012-11-19 13:54:42 -0800322 MemPoolT() : _root(0), _currentAllocs(0), _nAllocs(0), _maxAllocs(0), _nUntracked(0) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700323 ~MemPoolT() {
Lee Thomasonf07b9522014-10-30 13:25:12 -0700324 Clear();
325 }
326
327 void Clear() {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700328 // Delete the blocks.
Lee Thomasonf07b9522014-10-30 13:25:12 -0700329 while( !_blockPtrs.Empty()) {
330 Block* b = _blockPtrs.Pop();
331 delete b;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700332 }
Lee Thomasonf07b9522014-10-30 13:25:12 -0700333 _root = 0;
334 _currentAllocs = 0;
335 _nAllocs = 0;
336 _maxAllocs = 0;
337 _nUntracked = 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700338 }
Lee Thomasond1983222012-02-06 08:41:24 -0800339
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700340 virtual int ItemSize() const {
341 return SIZE;
342 }
343 int CurrentAllocs() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700344 return _currentAllocs;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700345 }
Lee Thomasond1983222012-02-06 08:41:24 -0800346
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700347 virtual void* Alloc() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700348 if ( !_root ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700349 // Need a new block.
350 Block* block = new Block();
Lee Thomason624d43f2012-10-12 10:58:48 -0700351 _blockPtrs.Push( block );
Lee Thomasond1983222012-02-06 08:41:24 -0800352
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700353 for( int i=0; i<COUNT-1; ++i ) {
354 block->chunk[i].next = &block->chunk[i+1];
355 }
356 block->chunk[COUNT-1].next = 0;
Lee Thomason624d43f2012-10-12 10:58:48 -0700357 _root = block->chunk;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700358 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700359 void* result = _root;
360 _root = _root->next;
Lee Thomason455c9d42012-02-06 09:14:14 -0800361
Lee Thomason624d43f2012-10-12 10:58:48 -0700362 ++_currentAllocs;
363 if ( _currentAllocs > _maxAllocs ) {
364 _maxAllocs = _currentAllocs;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700365 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700366 _nAllocs++;
Lee Thomason5b0a6772012-11-19 13:54:42 -0800367 _nUntracked++;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700368 return result;
369 }
Lee Thomasonf07b9522014-10-30 13:25:12 -0700370
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700371 virtual void Free( void* mem ) {
372 if ( !mem ) {
373 return;
374 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700375 --_currentAllocs;
Dmitry-Me56571762014-08-15 11:03:47 +0400376 Chunk* chunk = static_cast<Chunk*>( mem );
Lee Thomason (grinliz)6020a012012-09-08 21:15:09 -0700377#ifdef DEBUG
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700378 memset( chunk, 0xfe, sizeof(Chunk) );
Lee Thomason (grinliz)6020a012012-09-08 21:15:09 -0700379#endif
Lee Thomason624d43f2012-10-12 10:58:48 -0700380 chunk->next = _root;
381 _root = chunk;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700382 }
383 void Trace( const char* name ) {
384 printf( "Mempool %s watermark=%d [%dk] current=%d size=%d nAlloc=%d blocks=%d\n",
Lee Thomason624d43f2012-10-12 10:58:48 -0700385 name, _maxAllocs, _maxAllocs*SIZE/1024, _currentAllocs, SIZE, _nAllocs, _blockPtrs.Size() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700386 }
Lee Thomasond1983222012-02-06 08:41:24 -0800387
Lee Thomason5b0a6772012-11-19 13:54:42 -0800388 void SetTracked() {
389 _nUntracked--;
390 }
391
392 int Untracked() const {
393 return _nUntracked;
394 }
395
Lee Thomason (grinliz)ac83b4e2013-02-01 09:02:34 -0800396 // This number is perf sensitive. 4k seems like a good tradeoff on my machine.
397 // The test file is large, 170k.
398 // Release: VS2010 gcc(no opt)
399 // 1k: 4000
400 // 2k: 4000
401 // 4k: 3900 21000
402 // 16k: 5200
403 // 32k: 4300
404 // 64k: 4000 21000
405 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 +0200406
Lee Thomasond1983222012-02-06 08:41:24 -0800407private:
Dmitry-Me3e0af372015-01-09 15:30:00 +0300408 MemPoolT( const MemPoolT& ); // not supported
409 void operator=( const MemPoolT& ); // not supported
410
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700411 union Chunk {
Lee Thomason624d43f2012-10-12 10:58:48 -0700412 Chunk* next;
413 char mem[SIZE];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700414 };
415 struct Block {
Lee Thomason (grinliz)856da212012-10-19 09:08:15 -0700416 Chunk chunk[COUNT];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700417 };
Lee Thomason624d43f2012-10-12 10:58:48 -0700418 DynArray< Block*, 10 > _blockPtrs;
419 Chunk* _root;
Lee Thomason455c9d42012-02-06 09:14:14 -0800420
Lee Thomason624d43f2012-10-12 10:58:48 -0700421 int _currentAllocs;
422 int _nAllocs;
423 int _maxAllocs;
Lee Thomason5b0a6772012-11-19 13:54:42 -0800424 int _nUntracked;
Lee Thomasond1983222012-02-06 08:41:24 -0800425};
426
Lee Thomason2c85a712012-01-31 08:24:24 -0800427
Lee Thomason56bdd022012-02-09 18:16:58 -0800428
429/**
430 Implements the interface to the "Visitor pattern" (see the Accept() method.)
431 If you call the Accept() method, it requires being passed a XMLVisitor
432 class to handle callbacks. For nodes that contain other nodes (Document, Element)
Thomas Roß08bdf502012-05-12 14:21:23 +0200433 you will get called with a VisitEnter/VisitExit pair. Nodes that are always leafs
Lee Thomason56bdd022012-02-09 18:16:58 -0800434 are simply called with Visit().
435
436 If you return 'true' from a Visit method, recursive parsing will continue. If you return
Andrew C. Martin0fd87462013-03-09 20:09:45 -0700437 false, <b>no children of this node or its siblings</b> will be visited.
Lee Thomason56bdd022012-02-09 18:16:58 -0800438
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700439 All flavors of Visit methods have a default implementation that returns 'true' (continue
Lee Thomason56bdd022012-02-09 18:16:58 -0800440 visiting). You need to only override methods that are interesting to you.
441
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600442 Generally Accept() is called on the XMLDocument, although all nodes support visiting.
Lee Thomason56bdd022012-02-09 18:16:58 -0800443
444 You should never change the document from a callback.
445
446 @sa XMLNode::Accept()
447*/
PKEuS16ed47d2013-07-06 12:02:43 +0200448class TINYXML2_LIB XMLVisitor
U-Lama\Leee13c3e62011-12-28 14:36:55 -0800449{
450public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700451 virtual ~XMLVisitor() {}
Lee Thomasond1983222012-02-06 08:41:24 -0800452
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700453 /// Visit a document.
454 virtual bool VisitEnter( const XMLDocument& /*doc*/ ) {
455 return true;
456 }
457 /// Visit a document.
458 virtual bool VisitExit( const XMLDocument& /*doc*/ ) {
459 return true;
460 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800461
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700462 /// Visit an element.
463 virtual bool VisitEnter( const XMLElement& /*element*/, const XMLAttribute* /*firstAttribute*/ ) {
464 return true;
465 }
466 /// Visit an element.
467 virtual bool VisitExit( const XMLElement& /*element*/ ) {
468 return true;
469 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800470
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700471 /// Visit a declaration.
472 virtual bool Visit( const XMLDeclaration& /*declaration*/ ) {
473 return true;
474 }
475 /// Visit a text node.
476 virtual bool Visit( const XMLText& /*text*/ ) {
477 return true;
478 }
479 /// Visit a comment node.
480 virtual bool Visit( const XMLComment& /*comment*/ ) {
481 return true;
482 }
483 /// Visit an unknown node.
484 virtual bool Visit( const XMLUnknown& /*unknown*/ ) {
485 return true;
486 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800487};
488
Dmitry-Me66d2a842014-11-08 15:24:52 +0300489// WARNING: must match XMLDocument::_errorNames[]
numatrumpetbb5ffac2014-09-06 22:56:46 +0900490enum XMLError {
numatrumpetcd8550c2014-09-08 16:59:39 +0900491 XML_SUCCESS = 0,
numatrumpetcd8550c2014-09-08 16:59:39 +0900492 XML_NO_ATTRIBUTE,
493 XML_WRONG_ATTRIBUTE_TYPE,
494 XML_ERROR_FILE_NOT_FOUND,
495 XML_ERROR_FILE_COULD_NOT_BE_OPENED,
496 XML_ERROR_FILE_READ_ERROR,
497 XML_ERROR_ELEMENT_MISMATCH,
498 XML_ERROR_PARSING_ELEMENT,
499 XML_ERROR_PARSING_ATTRIBUTE,
500 XML_ERROR_IDENTIFYING_TAG,
501 XML_ERROR_PARSING_TEXT,
502 XML_ERROR_PARSING_CDATA,
503 XML_ERROR_PARSING_COMMENT,
504 XML_ERROR_PARSING_DECLARATION,
505 XML_ERROR_PARSING_UNKNOWN,
506 XML_ERROR_EMPTY_DOCUMENT,
507 XML_ERROR_MISMATCHED_ELEMENT,
508 XML_ERROR_PARSING,
509 XML_CAN_NOT_CONVERT_TEXT,
Lee Thomason331596e2014-09-11 14:56:43 -0700510 XML_NO_TEXT_NODE,
511
512 XML_ERROR_COUNT
numatrumpetbb5ffac2014-09-06 22:56:46 +0900513};
numatrumpetbb5ffac2014-09-06 22:56:46 +0900514
numatrumpetcd8550c2014-09-08 16:59:39 +0900515
U-Stream\Leeae25a442012-02-17 17:48:16 -0800516/*
517 Utility functionality.
518*/
Lee Thomason56bdd022012-02-09 18:16:58 -0800519class XMLUtil
520{
Lee Thomasond1983222012-02-06 08:41:24 -0800521public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700522 static const char* SkipWhiteSpace( const char* p ) {
Dmitry-Mebb836dc2014-12-24 11:54:05 +0300523 TIXMLASSERT( p );
Dmitry-Mefa20b222014-10-31 12:53:04 +0300524 while( IsWhiteSpace(*p) ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700525 ++p;
526 }
Dmitry-Mebb836dc2014-12-24 11:54:05 +0300527 TIXMLASSERT( p );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700528 return p;
529 }
530 static char* SkipWhiteSpace( char* p ) {
Dmitry-Me9de541f2014-09-24 14:21:36 +0400531 return const_cast<char*>( SkipWhiteSpace( const_cast<const char*>(p) ) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700532 }
Dmitry-Mefa20b222014-10-31 12:53:04 +0300533
534 // Anything in the high order range of UTF-8 is assumed to not be whitespace. This isn't
535 // correct, but simple, and usually works.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700536 static bool IsWhiteSpace( char p ) {
Jerome Martinez242c3ea2013-01-06 12:20:04 +0100537 return !IsUTF8Continuation(p) && isspace( static_cast<unsigned char>(p) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700538 }
Martinsh Shaitersc6d02f42013-01-26 21:22:57 +0200539
540 inline static bool IsNameStartChar( unsigned char ch ) {
Dmitry-Meea617f92015-01-01 16:32:01 +0300541 if ( ch >= 128 ) {
542 // This is a heuristic guess in attempt to not implement Unicode-aware isalpha()
543 return true;
544 }
545 if ( isalpha( ch ) ) {
546 return true;
547 }
548 return ch == ':' || ch == '_';
Martinsh Shaitersc6d02f42013-01-26 21:22:57 +0200549 }
550
551 inline static bool IsNameChar( unsigned char ch ) {
552 return IsNameStartChar( ch )
553 || isdigit( ch )
554 || ch == '.'
555 || ch == '-';
556 }
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800557
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700558 inline static bool StringEqual( const char* p, const char* q, int nChar=INT_MAX ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700559 if ( p == q ) {
560 return true;
561 }
Lee Thomason598a88d2015-10-09 14:42:12 -0700562 return strncmp( p, q, nChar ) == 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700563 }
Martinsh Shaitersc6d02f42013-01-26 21:22:57 +0200564
Dmitry-Me7865aad2015-06-19 16:23:35 +0300565 inline static bool IsUTF8Continuation( char p ) {
Dmitry-Me72bb0ec2014-09-24 16:14:24 +0400566 return ( p & 0x80 ) != 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700567 }
Lee Thomason (grinliz)68db57e2012-02-21 09:08:12 -0800568
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700569 static const char* ReadBOM( const char* p, bool* hasBOM );
570 // p is the starting location,
571 // the UTF-8 value of the entity will be placed in value, and length filled in.
572 static const char* GetCharacterRef( const char* p, char* value, int* length );
573 static void ConvertUTF32ToUTF8( unsigned long input, char* output, int* length );
Lee Thomason21be8822012-07-15 17:27:22 -0700574
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700575 // converts primitive types to strings
576 static void ToStr( int v, char* buffer, int bufferSize );
577 static void ToStr( unsigned v, char* buffer, int bufferSize );
578 static void ToStr( bool v, char* buffer, int bufferSize );
579 static void ToStr( float v, char* buffer, int bufferSize );
580 static void ToStr( double v, char* buffer, int bufferSize );
Lee Thomason51c12712016-06-04 20:18:49 -0700581 static void ToStr(int64_t v, char* buffer, int bufferSize);
Lee Thomason21be8822012-07-15 17:27:22 -0700582
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700583 // converts strings to primitive types
584 static bool ToInt( const char* str, int* value );
585 static bool ToUnsigned( const char* str, unsigned* value );
586 static bool ToBool( const char* str, bool* value );
587 static bool ToFloat( const char* str, float* value );
588 static bool ToDouble( const char* str, double* value );
Lee Thomason51c12712016-06-04 20:18:49 -0700589 static bool ToInt64(const char* str, int64_t* value);
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800590};
591
Lee Thomason5cae8972012-01-24 18:03:07 -0800592
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800593/** XMLNode is a base class for every object that is in the
594 XML Document Object Model (DOM), except XMLAttributes.
595 Nodes have siblings, a parent, and children which can
596 be navigated. A node is always in a XMLDocument.
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700597 The type of a XMLNode can be queried, and it can
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800598 be cast to its more defined type.
599
Thomas Roß08bdf502012-05-12 14:21:23 +0200600 A XMLDocument allocates memory for all its Nodes.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800601 When the XMLDocument gets deleted, all its Nodes
602 will also be deleted.
603
604 @verbatim
605 A Document can contain: Element (container or leaf)
606 Comment (leaf)
607 Unknown (leaf)
608 Declaration( leaf )
609
610 An Element can contain: Element (container or leaf)
611 Text (leaf)
612 Attributes (not on tree)
613 Comment (leaf)
614 Unknown (leaf)
615
616 @endverbatim
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800617*/
PKEuS16ed47d2013-07-06 12:02:43 +0200618class TINYXML2_LIB XMLNode
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800619{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700620 friend class XMLDocument;
621 friend class XMLElement;
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800622public:
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800623
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700624 /// Get the XMLDocument that owns this XMLNode.
625 const XMLDocument* GetDocument() const {
Dmitry-Me66487eb2015-07-20 18:21:04 +0300626 TIXMLASSERT( _document );
Lee Thomason624d43f2012-10-12 10:58:48 -0700627 return _document;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700628 }
629 /// Get the XMLDocument that owns this XMLNode.
630 XMLDocument* GetDocument() {
Dmitry-Me66487eb2015-07-20 18:21:04 +0300631 TIXMLASSERT( _document );
Lee Thomason624d43f2012-10-12 10:58:48 -0700632 return _document;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700633 }
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800634
Lee Thomason2fa81722012-11-09 12:37:46 -0800635 /// Safely cast to an Element, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700636 virtual XMLElement* ToElement() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100637 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700638 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800639 /// Safely cast to Text, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700640 virtual XMLText* ToText() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100641 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700642 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800643 /// Safely cast to a Comment, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700644 virtual XMLComment* ToComment() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100645 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700646 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800647 /// Safely cast to a Document, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700648 virtual XMLDocument* ToDocument() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100649 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700650 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800651 /// Safely cast to a Declaration, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700652 virtual XMLDeclaration* ToDeclaration() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100653 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700654 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800655 /// Safely cast to an Unknown, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700656 virtual XMLUnknown* ToUnknown() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100657 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700658 }
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800659
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700660 virtual const XMLElement* ToElement() const {
661 return 0;
662 }
663 virtual const XMLText* ToText() const {
664 return 0;
665 }
666 virtual const XMLComment* ToComment() const {
667 return 0;
668 }
669 virtual const XMLDocument* ToDocument() const {
670 return 0;
671 }
672 virtual const XMLDeclaration* ToDeclaration() const {
673 return 0;
674 }
675 virtual const XMLUnknown* ToUnknown() const {
676 return 0;
677 }
Lee Thomason751da522012-02-10 08:50:51 -0800678
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700679 /** The meaning of 'value' changes for the specific type.
680 @verbatim
Sarat Addepalli9afd1d02015-05-19 12:56:27 +0530681 Document: empty (NULL is returned, not an empty string)
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700682 Element: name of the element
683 Comment: the comment text
684 Unknown: the tag contents
685 Text: the text string
686 @endverbatim
687 */
Michael Daumling21626882013-10-22 17:03:37 +0200688 const char* Value() const;
MortenMacFly4ee49f12013-01-14 20:03:14 +0100689
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700690 /** Set the Value of an XML node.
691 @sa Value()
692 */
693 void SetValue( const char* val, bool staticMem=false );
Lee Thomason2c85a712012-01-31 08:24:24 -0800694
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700695 /// Get the parent of this node on the DOM.
696 const XMLNode* Parent() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700697 return _parent;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700698 }
MortenMacFly4ee49f12013-01-14 20:03:14 +0100699
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700700 XMLNode* Parent() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700701 return _parent;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700702 }
Lee Thomason751da522012-02-10 08:50:51 -0800703
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700704 /// Returns true if this node has no children.
705 bool NoChildren() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700706 return !_firstChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700707 }
Lee Thomason751da522012-02-10 08:50:51 -0800708
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700709 /// Get the first child node, or null if none exists.
710 const XMLNode* FirstChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700711 return _firstChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700712 }
MortenMacFly4ee49f12013-01-14 20:03:14 +0100713
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700714 XMLNode* FirstChild() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700715 return _firstChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700716 }
MortenMacFly4ee49f12013-01-14 20:03:14 +0100717
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700718 /** Get the first child element, or optionally the first child
719 element with the specified name.
720 */
Dmitry-Me886ad972015-07-22 11:00:51 +0300721 const XMLElement* FirstChildElement( const char* name = 0 ) const;
Lee Thomason624d43f2012-10-12 10:58:48 -0700722
Dmitry-Me886ad972015-07-22 11:00:51 +0300723 XMLElement* FirstChildElement( const char* name = 0 ) {
724 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->FirstChildElement( name ));
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700725 }
Lee Thomason3f57d272012-01-11 15:30:03 -0800726
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700727 /// Get the last child node, or null if none exists.
728 const XMLNode* LastChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700729 return _lastChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700730 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700731
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700732 XMLNode* LastChild() {
Dmitry-Me8d4e0ec2015-03-30 12:58:28 +0300733 return _lastChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700734 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800735
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700736 /** Get the last child element or optionally the last child
737 element with the specified name.
738 */
Dmitry-Me886ad972015-07-22 11:00:51 +0300739 const XMLElement* LastChildElement( const char* name = 0 ) const;
Lee Thomason624d43f2012-10-12 10:58:48 -0700740
Dmitry-Me886ad972015-07-22 11:00:51 +0300741 XMLElement* LastChildElement( const char* name = 0 ) {
742 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->LastChildElement(name) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700743 }
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700744
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700745 /// Get the previous (left) sibling node of this node.
746 const XMLNode* PreviousSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700747 return _prev;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700748 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700749
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700750 XMLNode* PreviousSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700751 return _prev;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700752 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800753
Andrew C. Martin0fd87462013-03-09 20:09:45 -0700754 /// Get the previous (left) sibling element of this node, with an optionally supplied name.
Dmitry-Me886ad972015-07-22 11:00:51 +0300755 const XMLElement* PreviousSiblingElement( const char* name = 0 ) const ;
Lee Thomason624d43f2012-10-12 10:58:48 -0700756
Dmitry-Me886ad972015-07-22 11:00:51 +0300757 XMLElement* PreviousSiblingElement( const char* name = 0 ) {
758 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->PreviousSiblingElement( name ) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700759 }
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700760
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700761 /// Get the next (right) sibling node of this node.
762 const XMLNode* NextSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700763 return _next;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700764 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700765
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700766 XMLNode* NextSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700767 return _next;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700768 }
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700769
Andrew C. Martin0fd87462013-03-09 20:09:45 -0700770 /// Get the next (right) sibling element of this node, with an optionally supplied name.
Dmitry-Me886ad972015-07-22 11:00:51 +0300771 const XMLElement* NextSiblingElement( const char* name = 0 ) const;
Lee Thomason624d43f2012-10-12 10:58:48 -0700772
Dmitry-Me886ad972015-07-22 11:00:51 +0300773 XMLElement* NextSiblingElement( const char* name = 0 ) {
774 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->NextSiblingElement( name ) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700775 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800776
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700777 /**
778 Add a child node as the last (right) child.
Michael Daumlinged523282013-10-23 07:47:29 +0200779 If the child node is already part of the document,
780 it is moved from its old location to the new location.
781 Returns the addThis argument or 0 if the node does not
782 belong to the same document.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700783 */
784 XMLNode* InsertEndChild( XMLNode* addThis );
Lee Thomason618dbf82012-02-28 12:34:27 -0800785
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700786 XMLNode* LinkEndChild( XMLNode* addThis ) {
787 return InsertEndChild( addThis );
788 }
789 /**
790 Add a child node as the first (left) child.
Michael Daumlinged523282013-10-23 07:47:29 +0200791 If the child node is already part of the document,
792 it is moved from its old location to the new location.
793 Returns the addThis argument or 0 if the node does not
794 belong to the same document.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700795 */
796 XMLNode* InsertFirstChild( XMLNode* addThis );
797 /**
798 Add a node after the specified child node.
Michael Daumlinged523282013-10-23 07:47:29 +0200799 If the child node is already part of the document,
800 it is moved from its old location to the new location.
801 Returns the addThis argument or 0 if the afterThis node
802 is not a child of this node, or if the node does not
803 belong to the same document.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700804 */
805 XMLNode* InsertAfterChild( XMLNode* afterThis, XMLNode* addThis );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700806
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700807 /**
808 Delete all the children of this node.
809 */
810 void DeleteChildren();
U-Stream\Leeae25a442012-02-17 17:48:16 -0800811
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700812 /**
813 Delete a child of this node.
814 */
815 void DeleteChild( XMLNode* node );
Lee Thomason56bdd022012-02-09 18:16:58 -0800816
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700817 /**
818 Make a copy of this node, but not its children.
819 You may pass in a Document pointer that will be
820 the owner of the new Node. If the 'document' is
821 null, then the node returned will be allocated
822 from the current Document. (this->GetDocument())
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800823
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700824 Note: if called on a XMLDocument, this will return null.
825 */
826 virtual XMLNode* ShallowClone( XMLDocument* document ) const = 0;
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800827
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700828 /**
829 Test if 2 nodes are the same, but don't test children.
830 The 2 nodes do not need to be in the same Document.
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800831
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700832 Note: if called on a XMLDocument, this will return false.
833 */
834 virtual bool ShallowEqual( const XMLNode* compare ) const = 0;
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800835
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600836 /** Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700837 XML tree will be conditionally visited and the host will be called back
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600838 via the XMLVisitor interface.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800839
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600840 This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse
841 the XML for the callbacks, so the performance of TinyXML-2 is unchanged by using this
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700842 interface versus any other.)
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800843
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700844 The interface has been based on ideas from:
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800845
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700846 - http://www.saxproject.org/
847 - http://c2.com/cgi/wiki?HierarchicalVisitorPattern
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800848
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700849 Which are both good references for "visiting".
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800850
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700851 An example of using Accept():
852 @verbatim
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600853 XMLPrinter printer;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700854 tinyxmlDoc.Accept( &printer );
855 const char* xmlcstr = printer.CStr();
856 @endverbatim
857 */
858 virtual bool Accept( XMLVisitor* visitor ) const = 0;
Lee Thomason56bdd022012-02-09 18:16:58 -0800859
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800860protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700861 XMLNode( XMLDocument* );
862 virtual ~XMLNode();
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700863
Dmitry-Me9b0f1772015-04-03 10:37:31 +0300864 virtual char* ParseDeep( char*, StrPair* );
865
Lee Thomason624d43f2012-10-12 10:58:48 -0700866 XMLDocument* _document;
867 XMLNode* _parent;
868 mutable StrPair _value;
Lee Thomason3f57d272012-01-11 15:30:03 -0800869
Lee Thomason624d43f2012-10-12 10:58:48 -0700870 XMLNode* _firstChild;
871 XMLNode* _lastChild;
Lee Thomason3f57d272012-01-11 15:30:03 -0800872
Lee Thomason624d43f2012-10-12 10:58:48 -0700873 XMLNode* _prev;
874 XMLNode* _next;
Lee Thomason3f57d272012-01-11 15:30:03 -0800875
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800876private:
Lee Thomason624d43f2012-10-12 10:58:48 -0700877 MemPool* _memPool;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700878 void Unlink( XMLNode* child );
Dmitry-Mee3225b12014-09-03 11:03:11 +0400879 static void DeleteNode( XMLNode* node );
Lee Thomason3cebdc42015-01-05 17:16:28 -0800880 void InsertChildPreamble( XMLNode* insertThis ) const;
Dmitry-Mef547a992015-01-09 15:17:09 +0300881
882 XMLNode( const XMLNode& ); // not supported
883 XMLNode& operator=( const XMLNode& ); // not supported
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800884};
885
886
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800887/** XML text.
888
889 Note that a text node can have child element nodes, for example:
890 @verbatim
891 <root>This is <b>bold</b></root>
892 @endverbatim
893
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700894 A text node can have 2 ways to output the next. "normal" output
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800895 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 -0700896 you generally want to leave it alone, but you can change the output mode with
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600897 SetCData() and query it with CData().
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800898*/
PKEuS16ed47d2013-07-06 12:02:43 +0200899class TINYXML2_LIB XMLText : public XMLNode
Lee Thomason5492a1c2012-01-23 15:32:10 -0800900{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700901 friend class XMLDocument;
Lee Thomason5492a1c2012-01-23 15:32:10 -0800902public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700903 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason50adb4c2012-02-13 15:07:09 -0800904
Lee Thomason624d43f2012-10-12 10:58:48 -0700905 virtual XMLText* ToText() {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700906 return this;
907 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700908 virtual const XMLText* ToText() const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700909 return this;
910 }
Lee Thomason5492a1c2012-01-23 15:32:10 -0800911
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700912 /// Declare whether this should be CDATA or standard text.
Lee Thomason624d43f2012-10-12 10:58:48 -0700913 void SetCData( bool isCData ) {
914 _isCData = isCData;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700915 }
916 /// Returns true if this is a CDATA text element.
917 bool CData() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700918 return _isCData;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700919 }
Lee Thomason50f97b22012-02-11 16:33:40 -0800920
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700921 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
922 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800923
Lee Thomason5492a1c2012-01-23 15:32:10 -0800924protected:
Lee Thomason624d43f2012-10-12 10:58:48 -0700925 XMLText( XMLDocument* doc ) : XMLNode( doc ), _isCData( false ) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700926 virtual ~XMLText() {}
Lee Thomason5492a1c2012-01-23 15:32:10 -0800927
Dmitry-Me9b0f1772015-04-03 10:37:31 +0300928 char* ParseDeep( char*, StrPair* endTag );
929
Lee Thomason5492a1c2012-01-23 15:32:10 -0800930private:
Lee Thomason624d43f2012-10-12 10:58:48 -0700931 bool _isCData;
Dmitry-Mef547a992015-01-09 15:17:09 +0300932
933 XMLText( const XMLText& ); // not supported
934 XMLText& operator=( const XMLText& ); // not supported
Lee Thomason5492a1c2012-01-23 15:32:10 -0800935};
936
937
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800938/** An XML Comment. */
PKEuS16ed47d2013-07-06 12:02:43 +0200939class TINYXML2_LIB XMLComment : public XMLNode
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800940{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700941 friend class XMLDocument;
Lee Thomason3f57d272012-01-11 15:30:03 -0800942public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700943 virtual XMLComment* ToComment() {
944 return this;
945 }
946 virtual const XMLComment* ToComment() const {
947 return this;
948 }
Lee Thomasonce0763e2012-01-11 15:43:54 -0800949
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700950 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800951
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700952 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
953 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomasonce0763e2012-01-11 15:43:54 -0800954
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800955protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700956 XMLComment( XMLDocument* doc );
957 virtual ~XMLComment();
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800958
Dmitry-Me9b0f1772015-04-03 10:37:31 +0300959 char* ParseDeep( char*, StrPair* endTag );
960
Lee Thomason3f57d272012-01-11 15:30:03 -0800961private:
Dmitry-Mef547a992015-01-09 15:17:09 +0300962 XMLComment( const XMLComment& ); // not supported
963 XMLComment& operator=( const XMLComment& ); // not supported
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800964};
U-Lama\Leee13c3e62011-12-28 14:36:55 -0800965
966
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800967/** In correct XML the declaration is the first entry in the file.
968 @verbatim
969 <?xml version="1.0" standalone="yes"?>
970 @endverbatim
971
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600972 TinyXML-2 will happily read or write files without a declaration,
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800973 however.
974
975 The text of the declaration isn't interpreted. It is parsed
976 and written as a string.
977*/
PKEuS16ed47d2013-07-06 12:02:43 +0200978class TINYXML2_LIB XMLDeclaration : public XMLNode
Lee Thomason50f97b22012-02-11 16:33:40 -0800979{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700980 friend class XMLDocument;
Lee Thomason50f97b22012-02-11 16:33:40 -0800981public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700982 virtual XMLDeclaration* ToDeclaration() {
983 return this;
984 }
985 virtual const XMLDeclaration* ToDeclaration() const {
986 return this;
987 }
Lee Thomason50f97b22012-02-11 16:33:40 -0800988
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700989 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -0800990
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700991 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
992 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -0800993
994protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700995 XMLDeclaration( XMLDocument* doc );
996 virtual ~XMLDeclaration();
Dmitry-Mef547a992015-01-09 15:17:09 +0300997
Dmitry-Me9b0f1772015-04-03 10:37:31 +0300998 char* ParseDeep( char*, StrPair* endTag );
999
Dmitry-Mef547a992015-01-09 15:17:09 +03001000private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001001 XMLDeclaration( const XMLDeclaration& ); // not supported
1002 XMLDeclaration& operator=( const XMLDeclaration& ); // not supported
Lee Thomason50f97b22012-02-11 16:33:40 -08001003};
1004
1005
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001006/** Any tag that TinyXML-2 doesn't recognize is saved as an
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001007 unknown. It is a tag of text, but should not be modified.
1008 It will be written back to the XML, unchanged, when the file
1009 is saved.
1010
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001011 DTD tags get thrown into XMLUnknowns.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001012*/
PKEuS16ed47d2013-07-06 12:02:43 +02001013class TINYXML2_LIB XMLUnknown : public XMLNode
Lee Thomason50f97b22012-02-11 16:33:40 -08001014{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001015 friend class XMLDocument;
Lee Thomason50f97b22012-02-11 16:33:40 -08001016public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001017 virtual XMLUnknown* ToUnknown() {
1018 return this;
1019 }
1020 virtual const XMLUnknown* ToUnknown() const {
1021 return this;
1022 }
Lee Thomason50f97b22012-02-11 16:33:40 -08001023
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001024 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -08001025
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001026 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
1027 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -08001028
1029protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001030 XMLUnknown( XMLDocument* doc );
1031 virtual ~XMLUnknown();
Dmitry-Mef547a992015-01-09 15:17:09 +03001032
Dmitry-Me9b0f1772015-04-03 10:37:31 +03001033 char* ParseDeep( char*, StrPair* endTag );
1034
Dmitry-Mef547a992015-01-09 15:17:09 +03001035private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001036 XMLUnknown( const XMLUnknown& ); // not supported
1037 XMLUnknown& operator=( const XMLUnknown& ); // not supported
Lee Thomason50f97b22012-02-11 16:33:40 -08001038};
1039
1040
Lee Thomason1ff38e02012-02-14 18:18:16 -08001041
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001042/** An attribute is a name-value pair. Elements have an arbitrary
1043 number of attributes, each with a unique name.
1044
1045 @note The attributes are not XMLNodes. You may only query the
1046 Next() attribute in a list.
1047*/
PKEuS16ed47d2013-07-06 12:02:43 +02001048class TINYXML2_LIB XMLAttribute
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001049{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001050 friend class XMLElement;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001051public:
Lee Thomason2fa81722012-11-09 12:37:46 -08001052 /// The name of the attribute.
Michael Daumling21626882013-10-22 17:03:37 +02001053 const char* Name() const;
1054
Lee Thomason2fa81722012-11-09 12:37:46 -08001055 /// The value of the attribute.
Michael Daumling21626882013-10-22 17:03:37 +02001056 const char* Value() const;
1057
Lee Thomason2fa81722012-11-09 12:37:46 -08001058 /// The next attribute in the list.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001059 const XMLAttribute* Next() const {
MortenMacFly4ee49f12013-01-14 20:03:14 +01001060 return _next;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001061 }
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001062
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001063 /** IntValue interprets the attribute as an integer, and returns the value.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001064 If the value isn't an integer, 0 will be returned. There is no error checking;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001065 use QueryIntValue() if you need error checking.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001066 */
Lee Thomason51c12712016-06-04 20:18:49 -07001067 int IntValue() const {
1068 int i = 0;
1069 QueryIntValue(&i);
1070 return i;
1071 }
1072
1073 int64_t Int64Value() const {
1074 int64_t i = 0;
1075 QueryInt64Value(&i);
1076 return i;
1077 }
1078
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001079 /// Query as an unsigned integer. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001080 unsigned UnsignedValue() const {
1081 unsigned i=0;
1082 QueryUnsignedValue( &i );
1083 return i;
1084 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001085 /// Query as a boolean. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001086 bool BoolValue() const {
1087 bool b=false;
1088 QueryBoolValue( &b );
1089 return b;
1090 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001091 /// Query as a double. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001092 double DoubleValue() const {
1093 double d=0;
1094 QueryDoubleValue( &d );
1095 return d;
1096 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001097 /// Query as a float. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001098 float FloatValue() const {
1099 float f=0;
1100 QueryFloatValue( &f );
1101 return f;
1102 }
U-Stream\Leeae25a442012-02-17 17:48:16 -08001103
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001104 /** QueryIntValue interprets the attribute as an integer, and returns the value
Andrew C. Martin0fd87462013-03-09 20:09:45 -07001105 in the provided parameter. The function will return XML_NO_ERROR on success,
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001106 and XML_WRONG_ATTRIBUTE_TYPE if the conversion is not successful.
1107 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001108 XMLError QueryIntValue( int* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001109 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001110 XMLError QueryUnsignedValue( unsigned int* value ) const;
Lee Thomason51c12712016-06-04 20:18:49 -07001111 /// See QueryIntValue
1112 XMLError QueryInt64Value(int64_t* value) const;
1113 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001114 XMLError QueryBoolValue( bool* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001115 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001116 XMLError QueryDoubleValue( double* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001117 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001118 XMLError QueryFloatValue( float* value ) const;
Lee Thomason50adb4c2012-02-13 15:07:09 -08001119
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001120 /// Set the attribute to a string value.
1121 void SetAttribute( const char* value );
1122 /// Set the attribute to value.
1123 void SetAttribute( int value );
1124 /// Set the attribute to value.
1125 void SetAttribute( unsigned value );
Lee Thomason51c12712016-06-04 20:18:49 -07001126 /// Set the attribute to value.
1127 void SetAttribute(int64_t value);
1128 /// Set the attribute to value.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001129 void SetAttribute( bool value );
1130 /// Set the attribute to value.
1131 void SetAttribute( double value );
1132 /// Set the attribute to value.
1133 void SetAttribute( float value );
Lee Thomason50adb4c2012-02-13 15:07:09 -08001134
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001135private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001136 enum { BUF_SIZE = 200 };
U-Stream\Lee09a11c52012-02-17 08:31:16 -08001137
Thomas Roß61892312013-05-12 14:07:38 +02001138 XMLAttribute() : _next( 0 ), _memPool( 0 ) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001139 virtual ~XMLAttribute() {}
Lee Thomason624d43f2012-10-12 10:58:48 -07001140
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001141 XMLAttribute( const XMLAttribute& ); // not supported
1142 void operator=( const XMLAttribute& ); // not supported
1143 void SetName( const char* name );
Lee Thomason50adb4c2012-02-13 15:07:09 -08001144
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001145 char* ParseDeep( char* p, bool processEntities );
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001146
Lee Thomason624d43f2012-10-12 10:58:48 -07001147 mutable StrPair _name;
1148 mutable StrPair _value;
1149 XMLAttribute* _next;
1150 MemPool* _memPool;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001151};
1152
1153
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001154/** The element is a container class. It has a value, the element name,
1155 and can contain other elements, text, comments, and unknowns.
1156 Elements also contain an arbitrary number of attributes.
1157*/
PKEuS16ed47d2013-07-06 12:02:43 +02001158class TINYXML2_LIB XMLElement : public XMLNode
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001159{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001160 friend class XMLDocument;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001161public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001162 /// Get the name of an element (which is the Value() of the node.)
1163 const char* Name() const {
1164 return Value();
1165 }
1166 /// Set the name of the element.
1167 void SetName( const char* str, bool staticMem=false ) {
1168 SetValue( str, staticMem );
1169 }
Lee Thomason2c85a712012-01-31 08:24:24 -08001170
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001171 virtual XMLElement* ToElement() {
1172 return this;
1173 }
1174 virtual const XMLElement* ToElement() const {
1175 return this;
1176 }
1177 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001178
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001179 /** Given an attribute name, Attribute() returns the value
1180 for the attribute of that name, or null if none
1181 exists. For example:
Lee Thomason92258152012-03-24 13:05:39 -07001182
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001183 @verbatim
1184 const char* value = ele->Attribute( "foo" );
1185 @endverbatim
Lee Thomason92258152012-03-24 13:05:39 -07001186
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001187 The 'value' parameter is normally null. However, if specified,
1188 the attribute will only be returned if the 'name' and 'value'
1189 match. This allow you to write code:
Lee Thomason8ba7f7d2012-03-24 13:04:04 -07001190
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001191 @verbatim
1192 if ( ele->Attribute( "foo", "bar" ) ) callFooIsBar();
1193 @endverbatim
Lee Thomason8ba7f7d2012-03-24 13:04:04 -07001194
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001195 rather than:
1196 @verbatim
1197 if ( ele->Attribute( "foo" ) ) {
1198 if ( strcmp( ele->Attribute( "foo" ), "bar" ) == 0 ) callFooIsBar();
1199 }
1200 @endverbatim
1201 */
1202 const char* Attribute( const char* name, const char* value=0 ) const;
Lee Thomason751da522012-02-10 08:50:51 -08001203
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001204 /** Given an attribute name, IntAttribute() returns the value
1205 of the attribute interpreted as an integer. 0 will be
1206 returned if there is an error. For a method with error
1207 checking, see QueryIntAttribute()
1208 */
1209 int IntAttribute( const char* name ) const {
1210 int i=0;
1211 QueryIntAttribute( name, &i );
1212 return i;
1213 }
Lee Thomason51c12712016-06-04 20:18:49 -07001214
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001215 /// See IntAttribute()
1216 unsigned UnsignedAttribute( const char* name ) const {
1217 unsigned i=0;
1218 QueryUnsignedAttribute( name, &i );
1219 return i;
1220 }
Lee Thomason51c12712016-06-04 20:18:49 -07001221
1222 /// See IntAttribute()
1223 int64_t Int64Attribute(const char* name) const {
1224 int64_t i = 0;
1225 QueryInt64Attribute(name, &i);
1226 return i;
1227 }
1228
1229 /// See IntAttribute()
1230 bool BoolAttribute( const char* name ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001231 bool b=false;
1232 QueryBoolAttribute( name, &b );
1233 return b;
1234 }
1235 /// See IntAttribute()
Lee Thomason51c12712016-06-04 20:18:49 -07001236 double DoubleAttribute( const char* name ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001237 double d=0;
1238 QueryDoubleAttribute( name, &d );
1239 return d;
1240 }
1241 /// See IntAttribute()
Lee Thomason51c12712016-06-04 20:18:49 -07001242 float FloatAttribute( const char* name ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001243 float f=0;
1244 QueryFloatAttribute( name, &f );
1245 return f;
1246 }
U-Stream\Lee09a11c52012-02-17 08:31:16 -08001247
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001248 /** Given an attribute name, QueryIntAttribute() returns
1249 XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion
1250 can't be performed, or XML_NO_ATTRIBUTE if the attribute
1251 doesn't exist. If successful, the result of the conversion
1252 will be written to 'value'. If not successful, nothing will
1253 be written to 'value'. This allows you to provide default
1254 value:
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001255
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001256 @verbatim
1257 int value = 10;
1258 QueryIntAttribute( "foo", &value ); // if "foo" isn't found, value will still be 10
1259 @endverbatim
1260 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001261 XMLError QueryIntAttribute( const char* name, int* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001262 const XMLAttribute* a = FindAttribute( name );
1263 if ( !a ) {
1264 return XML_NO_ATTRIBUTE;
1265 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001266 return a->QueryIntValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001267 }
Lee Thomason51c12712016-06-04 20:18:49 -07001268
1269 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001270 XMLError QueryUnsignedAttribute( const char* name, unsigned int* 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->QueryUnsignedValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001276 }
Lee Thomason51c12712016-06-04 20:18:49 -07001277
1278 /// See QueryIntAttribute()
1279 XMLError QueryInt64Attribute(const char* name, int64_t* value) const {
1280 const XMLAttribute* a = FindAttribute(name);
1281 if (!a) {
1282 return XML_NO_ATTRIBUTE;
1283 }
1284 return a->QueryInt64Value(value);
1285 }
1286
1287 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001288 XMLError QueryBoolAttribute( const char* name, bool* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001289 const XMLAttribute* a = FindAttribute( name );
1290 if ( !a ) {
1291 return XML_NO_ATTRIBUTE;
1292 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001293 return a->QueryBoolValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001294 }
1295 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001296 XMLError QueryDoubleAttribute( const char* name, double* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001297 const XMLAttribute* a = FindAttribute( name );
1298 if ( !a ) {
1299 return XML_NO_ATTRIBUTE;
1300 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001301 return a->QueryDoubleValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001302 }
1303 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001304 XMLError QueryFloatAttribute( const char* name, float* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001305 const XMLAttribute* a = FindAttribute( name );
1306 if ( !a ) {
1307 return XML_NO_ATTRIBUTE;
1308 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001309 return a->QueryFloatValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001310 }
Lee Thomason50f97b22012-02-11 16:33:40 -08001311
Lee Thomason (grinliz)5efaa5f2013-02-01 19:26:30 -08001312
1313 /** Given an attribute name, QueryAttribute() returns
1314 XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion
1315 can't be performed, or XML_NO_ATTRIBUTE if the attribute
1316 doesn't exist. It is overloaded for the primitive types,
1317 and is a generally more convenient replacement of
1318 QueryIntAttribute() and related functions.
1319
1320 If successful, the result of the conversion
1321 will be written to 'value'. If not successful, nothing will
1322 be written to 'value'. This allows you to provide default
1323 value:
1324
1325 @verbatim
1326 int value = 10;
1327 QueryAttribute( "foo", &value ); // if "foo" isn't found, value will still be 10
1328 @endverbatim
1329 */
1330 int QueryAttribute( const char* name, int* value ) const {
1331 return QueryIntAttribute( name, value );
1332 }
1333
1334 int QueryAttribute( const char* name, unsigned int* value ) const {
1335 return QueryUnsignedAttribute( name, value );
1336 }
1337
Lee Thomason51c12712016-06-04 20:18:49 -07001338 int QueryAttribute(const char* name, int64_t* value) const {
1339 return QueryInt64Attribute(name, value);
1340 }
1341
Lee Thomason (grinliz)5efaa5f2013-02-01 19:26:30 -08001342 int QueryAttribute( const char* name, bool* value ) const {
1343 return QueryBoolAttribute( name, value );
1344 }
1345
1346 int QueryAttribute( const char* name, double* value ) const {
1347 return QueryDoubleAttribute( name, value );
1348 }
1349
1350 int QueryAttribute( const char* name, float* value ) const {
1351 return QueryFloatAttribute( name, value );
1352 }
1353
1354 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001355 void SetAttribute( const char* name, const char* value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001356 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001357 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001358 }
1359 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001360 void SetAttribute( const char* name, int value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001361 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001362 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001363 }
1364 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001365 void SetAttribute( const char* name, unsigned value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001366 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001367 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001368 }
Lee Thomason51c12712016-06-04 20:18:49 -07001369
1370 /// Sets the named attribute to value.
1371 void SetAttribute(const char* name, int64_t value) {
1372 XMLAttribute* a = FindOrCreateAttribute(name);
1373 a->SetAttribute(value);
1374 }
1375
1376 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001377 void SetAttribute( const char* name, bool value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001378 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001379 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001380 }
1381 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001382 void SetAttribute( const char* name, double value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001383 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001384 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001385 }
Lee Thomasonc3708cc2014-01-14 12:30:03 -08001386 /// Sets the named attribute to value.
1387 void SetAttribute( const char* name, float value ) {
1388 XMLAttribute* a = FindOrCreateAttribute( name );
1389 a->SetAttribute( value );
1390 }
Lee Thomason50f97b22012-02-11 16:33:40 -08001391
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001392 /**
1393 Delete an attribute.
1394 */
1395 void DeleteAttribute( const char* name );
Lee Thomason751da522012-02-10 08:50:51 -08001396
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001397 /// Return the first attribute in the list.
1398 const XMLAttribute* FirstAttribute() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001399 return _rootAttribute;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001400 }
1401 /// Query a specific attribute in the list.
1402 const XMLAttribute* FindAttribute( const char* name ) const;
Lee Thomason751da522012-02-10 08:50:51 -08001403
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001404 /** Convenience function for easy access to the text inside an element. Although easy
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001405 and concise, GetText() is limited compared to getting the XMLText child
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001406 and accessing it directly.
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001407
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001408 If the first child of 'this' is a XMLText, the GetText()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001409 returns the character string of the Text node, else null is returned.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001410
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001411 This is a convenient method for getting the text of simple contained text:
1412 @verbatim
1413 <foo>This is text</foo>
1414 const char* str = fooElement->GetText();
1415 @endverbatim
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001416
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001417 'str' will be a pointer to "This is text".
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001418
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001419 Note that this function can be misleading. If the element foo was created from
1420 this XML:
1421 @verbatim
1422 <foo><b>This is text</b></foo>
1423 @endverbatim
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001424
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001425 then the value of str would be null. The first child node isn't a text node, it is
1426 another element. From this XML:
1427 @verbatim
1428 <foo>This is <b>text</b></foo>
1429 @endverbatim
1430 GetText() will return "This is ".
1431 */
1432 const char* GetText() const;
Lee Thomason751da522012-02-10 08:50:51 -08001433
Uli Kusterer85fff5e2014-01-21 01:35:30 +01001434 /** Convenience function for easy access to the text inside an element. Although easy
1435 and concise, SetText() is limited compared to creating an XMLText child
1436 and mutating it directly.
1437
1438 If the first child of 'this' is a XMLText, SetText() sets its value to
1439 the given string, otherwise it will create a first child that is an XMLText.
1440
1441 This is a convenient method for setting the text of simple contained text:
1442 @verbatim
1443 <foo>This is text</foo>
1444 fooElement->SetText( "Hullaballoo!" );
1445 <foo>Hullaballoo!</foo>
1446 @endverbatim
1447
1448 Note that this function can be misleading. If the element foo was created from
1449 this XML:
1450 @verbatim
1451 <foo><b>This is text</b></foo>
1452 @endverbatim
1453
1454 then it will not change "This is text", but rather prefix it with a text element:
1455 @verbatim
1456 <foo>Hullaballoo!<b>This is text</b></foo>
1457 @endverbatim
1458
1459 For this XML:
1460 @verbatim
1461 <foo />
1462 @endverbatim
1463 SetText() will generate
1464 @verbatim
1465 <foo>Hullaballoo!</foo>
1466 @endverbatim
1467 */
Lee Thomason5bb2d802014-01-24 10:42:57 -08001468 void SetText( const char* inText );
Dmitry-Me9e9c85b2015-10-19 18:04:46 +03001469 /// Convenience method for setting text inside an element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001470 void SetText( int value );
Dmitry-Me9e9c85b2015-10-19 18:04:46 +03001471 /// Convenience method for setting text inside an element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001472 void SetText( unsigned value );
Lee Thomason51c12712016-06-04 20:18:49 -07001473 /// Convenience method for setting text inside an element. See SetText() for important limitations.
1474 void SetText(int64_t value);
1475 /// Convenience method for setting text inside an element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001476 void SetText( bool value );
Dmitry-Me9e9c85b2015-10-19 18:04:46 +03001477 /// Convenience method for setting text inside an element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001478 void SetText( double value );
Dmitry-Me9e9c85b2015-10-19 18:04:46 +03001479 /// Convenience method for setting text inside an element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001480 void SetText( float value );
Uli Kusterer8fe342a2014-01-21 01:12:47 +01001481
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001482 /**
1483 Convenience method to query the value of a child text node. This is probably best
1484 shown by example. Given you have a document is this form:
1485 @verbatim
1486 <point>
1487 <x>1</x>
1488 <y>1.4</y>
1489 </point>
1490 @endverbatim
Lee Thomason21be8822012-07-15 17:27:22 -07001491
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001492 The QueryIntText() and similar functions provide a safe and easier way to get to the
1493 "value" of x and y.
Lee Thomason21be8822012-07-15 17:27:22 -07001494
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001495 @verbatim
1496 int x = 0;
1497 float y = 0; // types of x and y are contrived for example
1498 const XMLElement* xElement = pointElement->FirstChildElement( "x" );
1499 const XMLElement* yElement = pointElement->FirstChildElement( "y" );
1500 xElement->QueryIntText( &x );
1501 yElement->QueryFloatText( &y );
1502 @endverbatim
Lee Thomason21be8822012-07-15 17:27:22 -07001503
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001504 @returns XML_SUCCESS (0) on success, XML_CAN_NOT_CONVERT_TEXT if the text cannot be converted
1505 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 -07001506
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001507 */
MortenMacFly4ee49f12013-01-14 20:03:14 +01001508 XMLError QueryIntText( int* ival ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001509 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001510 XMLError QueryUnsignedText( unsigned* uval ) const;
Lee Thomason51c12712016-06-04 20:18:49 -07001511 /// See QueryIntText()
1512 XMLError QueryInt64Text(int64_t* uval) const;
1513 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001514 XMLError QueryBoolText( bool* bval ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001515 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001516 XMLError QueryDoubleText( double* dval ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001517 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001518 XMLError QueryFloatText( float* fval ) const;
Lee Thomason21be8822012-07-15 17:27:22 -07001519
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001520 // internal:
1521 enum {
1522 OPEN, // <foo>
1523 CLOSED, // <foo/>
1524 CLOSING // </foo>
1525 };
1526 int ClosingType() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001527 return _closingType;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001528 }
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001529 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
1530 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001531
Dmitry-Me9b0f1772015-04-03 10:37:31 +03001532protected:
1533 char* ParseDeep( char* p, StrPair* endTag );
1534
Lee Thomason50adb4c2012-02-13 15:07:09 -08001535private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001536 XMLElement( XMLDocument* doc );
1537 virtual ~XMLElement();
1538 XMLElement( const XMLElement& ); // not supported
1539 void operator=( const XMLElement& ); // not supported
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001540
Dmitry-Me1227d512014-12-05 13:41:45 +03001541 XMLAttribute* FindAttribute( const char* name ) {
1542 return const_cast<XMLAttribute*>(const_cast<const XMLElement*>(this)->FindAttribute( name ));
1543 }
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001544 XMLAttribute* FindOrCreateAttribute( const char* name );
1545 //void LinkAttribute( XMLAttribute* attrib );
1546 char* ParseAttributes( char* p );
Dmitry-Mee3225b12014-09-03 11:03:11 +04001547 static void DeleteAttribute( XMLAttribute* attribute );
Lee Thomason67d61312012-01-24 16:01:51 -08001548
Lee Thomason5bb2d802014-01-24 10:42:57 -08001549 enum { BUF_SIZE = 200 };
Lee Thomason624d43f2012-10-12 10:58:48 -07001550 int _closingType;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001551 // The attribute list is ordered; there is no 'lastAttribute'
1552 // because the list needs to be scanned for dupes before adding
1553 // a new attribute.
Lee Thomason624d43f2012-10-12 10:58:48 -07001554 XMLAttribute* _rootAttribute;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001555};
1556
1557
Lee Thomason (grinliz)bc1bfb72012-08-20 22:00:38 -07001558enum Whitespace {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001559 PRESERVE_WHITESPACE,
1560 COLLAPSE_WHITESPACE
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001561};
Lee Thomason (grinliz)bc1bfb72012-08-20 22:00:38 -07001562
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001563
1564/** A Document binds together all the functionality.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001565 It can be saved, loaded, and printed to the screen.
1566 All Nodes are connected and allocated to a Document.
1567 If the Document is deleted, all its Nodes are also deleted.
1568*/
PKEuS16ed47d2013-07-06 12:02:43 +02001569class TINYXML2_LIB XMLDocument : public XMLNode
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001570{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001571 friend class XMLElement;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001572public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001573 /// constructor
1574 XMLDocument( bool processEntities = true, Whitespace = PRESERVE_WHITESPACE );
1575 ~XMLDocument();
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001576
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001577 virtual XMLDocument* ToDocument() {
Dmitry-Me66487eb2015-07-20 18:21:04 +03001578 TIXMLASSERT( this == _document );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001579 return this;
1580 }
1581 virtual const XMLDocument* ToDocument() const {
Dmitry-Me66487eb2015-07-20 18:21:04 +03001582 TIXMLASSERT( this == _document );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001583 return this;
1584 }
Lee Thomason56bdd022012-02-09 18:16:58 -08001585
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001586 /**
1587 Parse an XML file from a character string.
1588 Returns XML_NO_ERROR (0) on success, or
1589 an errorID.
Lee Thomason (grinliz)e2bcb322012-09-17 17:58:25 -07001590
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001591 You may optionally pass in the 'nBytes', which is
1592 the number of bytes which will be parsed. If not
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001593 specified, TinyXML-2 will assume 'xml' points to a
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001594 null terminated string.
1595 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001596 XMLError Parse( const char* xml, size_t nBytes=(size_t)(-1) );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001597
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001598 /**
1599 Load an XML file from disk.
1600 Returns XML_NO_ERROR (0) on success, or
1601 an errorID.
1602 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001603 XMLError LoadFile( const char* filename );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001604
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001605 /**
1606 Load an XML file from disk. You are responsible
Lee Thomasoncd011bc2014-12-17 10:41:34 -08001607 for providing and closing the FILE*.
1608
1609 NOTE: The file should be opened as binary ("rb")
1610 not text in order for TinyXML-2 to correctly
1611 do newline normalization.
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001612
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001613 Returns XML_NO_ERROR (0) on success, or
1614 an errorID.
1615 */
Jerome Martinez242c3ea2013-01-06 12:20:04 +01001616 XMLError LoadFile( FILE* );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001617
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001618 /**
1619 Save the XML file to disk.
1620 Returns XML_NO_ERROR (0) on success, or
1621 an errorID.
1622 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001623 XMLError SaveFile( const char* filename, bool compact = false );
Lee Thomasond11cd162012-04-12 08:35:36 -07001624
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001625 /**
1626 Save the XML file to disk. You are responsible
1627 for providing and closing the FILE*.
Ken Miller81da1fb2012-04-09 23:32:26 -05001628
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001629 Returns XML_NO_ERROR (0) on success, or
1630 an errorID.
1631 */
Jerome Martinez242c3ea2013-01-06 12:20:04 +01001632 XMLError SaveFile( FILE* fp, bool compact = false );
Lee Thomason (grinliz)68db57e2012-02-21 09:08:12 -08001633
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001634 bool ProcessEntities() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001635 return _processEntities;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001636 }
1637 Whitespace WhitespaceMode() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001638 return _whitespace;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001639 }
Lee Thomason6f381b72012-03-02 12:59:39 -08001640
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001641 /**
1642 Returns true if this document has a leading Byte Order Mark of UTF8.
1643 */
1644 bool HasBOM() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001645 return _writeBOM;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001646 }
1647 /** Sets whether to write the BOM when writing the file.
1648 */
1649 void SetBOM( bool useBOM ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001650 _writeBOM = useBOM;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001651 }
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001652
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001653 /** Return the root element of DOM. Equivalent to FirstChildElement().
1654 To get the first node, use FirstChild().
1655 */
1656 XMLElement* RootElement() {
1657 return FirstChildElement();
1658 }
1659 const XMLElement* RootElement() const {
1660 return FirstChildElement();
1661 }
Lee Thomason18d68bd2012-01-26 18:17:26 -08001662
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001663 /** Print the Document. If the Printer is not provided, it will
1664 print to stdout. If you provide Printer, this can print to a file:
1665 @verbatim
1666 XMLPrinter printer( fp );
1667 doc.Print( &printer );
1668 @endverbatim
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001669
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001670 Or you can use a printer to print to memory:
1671 @verbatim
1672 XMLPrinter printer;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001673 doc.Print( &printer );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001674 // printer.CStr() has a const char* to the XML
1675 @endverbatim
1676 */
PKEuS1c5f99e2013-07-06 11:28:39 +02001677 void Print( XMLPrinter* streamer=0 ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001678 virtual bool Accept( XMLVisitor* visitor ) const;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001679
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001680 /**
1681 Create a new Element associated with
1682 this Document. The memory for the Element
1683 is managed by the Document.
1684 */
1685 XMLElement* NewElement( const char* name );
1686 /**
1687 Create a new Comment associated with
1688 this Document. The memory for the Comment
1689 is managed by the Document.
1690 */
1691 XMLComment* NewComment( const char* comment );
1692 /**
1693 Create a new Text associated with
1694 this Document. The memory for the Text
1695 is managed by the Document.
1696 */
1697 XMLText* NewText( const char* text );
1698 /**
1699 Create a new Declaration associated with
1700 this Document. The memory for the object
1701 is managed by the Document.
Lee Thomasonf68c4382012-04-28 14:37:11 -07001702
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001703 If the 'text' param is null, the standard
1704 declaration is used.:
1705 @verbatim
1706 <?xml version="1.0" encoding="UTF-8"?>
1707 @endverbatim
1708 */
1709 XMLDeclaration* NewDeclaration( const char* text=0 );
1710 /**
1711 Create a new Unknown associated with
Andrew C. Martin0fd87462013-03-09 20:09:45 -07001712 this Document. The memory for the object
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001713 is managed by the Document.
1714 */
1715 XMLUnknown* NewUnknown( const char* text );
Lee Thomason2c85a712012-01-31 08:24:24 -08001716
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001717 /**
1718 Delete a node associated with this document.
1719 It will be unlinked from the DOM.
1720 */
Lee Thomasoncd011bc2014-12-17 10:41:34 -08001721 void DeleteNode( XMLNode* node );
U-Stream\Leeae25a442012-02-17 17:48:16 -08001722
Lee Thomason2fa81722012-11-09 12:37:46 -08001723 void SetError( XMLError error, const char* str1, const char* str2 );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001724
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001725 /// Return true if there was an error parsing the document.
1726 bool Error() const {
Lee Thomason85536252016-06-04 19:10:53 -07001727 return _errorID != XML_SUCCESS;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001728 }
1729 /// Return the errorID.
Lee Thomason2fa81722012-11-09 12:37:46 -08001730 XMLError ErrorID() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001731 return _errorID;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001732 }
Lee Thomason331596e2014-09-11 14:56:43 -07001733 const char* ErrorName() const;
1734
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001735 /// Return a possibly helpful diagnostic location or string.
1736 const char* GetErrorStr1() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001737 return _errorStr1;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001738 }
1739 /// Return a possibly helpful secondary diagnostic location or string.
1740 const char* GetErrorStr2() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001741 return _errorStr2;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001742 }
1743 /// If there is an error, print it to stdout.
1744 void PrintError() const;
Martinsh Shaitersa9d42b02013-01-30 11:14:27 +02001745
1746 /// Clear the document, resetting it to the initial state.
1747 void Clear();
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001748
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001749 // internal
1750 char* Identify( char* p, XMLNode** node );
Lee Thomason2c85a712012-01-31 08:24:24 -08001751
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001752 virtual XMLNode* ShallowClone( XMLDocument* /*document*/ ) const {
1753 return 0;
1754 }
1755 virtual bool ShallowEqual( const XMLNode* /*compare*/ ) const {
1756 return false;
1757 }
Lee Thomason7d00b9a2012-02-27 17:54:22 -08001758
Lee Thomason3f57d272012-01-11 15:30:03 -08001759private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001760 XMLDocument( const XMLDocument& ); // not supported
1761 void operator=( const XMLDocument& ); // not supported
Lee Thomason18d68bd2012-01-26 18:17:26 -08001762
Lee Thomason2fa81722012-11-09 12:37:46 -08001763 bool _writeBOM;
1764 bool _processEntities;
1765 XMLError _errorID;
1766 Whitespace _whitespace;
Lee Thomason624d43f2012-10-12 10:58:48 -07001767 const char* _errorStr1;
1768 const char* _errorStr2;
Lee Thomason2fa81722012-11-09 12:37:46 -08001769 char* _charBuffer;
Lee Thomasond1983222012-02-06 08:41:24 -08001770
Lee Thomason624d43f2012-10-12 10:58:48 -07001771 MemPoolT< sizeof(XMLElement) > _elementPool;
1772 MemPoolT< sizeof(XMLAttribute) > _attributePool;
1773 MemPoolT< sizeof(XMLText) > _textPool;
1774 MemPoolT< sizeof(XMLComment) > _commentPool;
Lee Thomason331596e2014-09-11 14:56:43 -07001775
1776 static const char* _errorNames[XML_ERROR_COUNT];
Dmitry-Me97476b72015-01-01 16:15:57 +03001777
1778 void Parse();
Lee Thomason5cae8972012-01-24 18:03:07 -08001779};
1780
Lee Thomason7c913cd2012-01-26 18:32:34 -08001781
Lee Thomason3ffdd392012-03-28 17:27:55 -07001782/**
1783 A XMLHandle is a class that wraps a node pointer with null checks; this is
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001784 an incredibly useful thing. Note that XMLHandle is not part of the TinyXML-2
Lee Thomason3ffdd392012-03-28 17:27:55 -07001785 DOM structure. It is a separate utility class.
1786
1787 Take an example:
1788 @verbatim
1789 <Document>
1790 <Element attributeA = "valueA">
1791 <Child attributeB = "value1" />
1792 <Child attributeB = "value2" />
1793 </Element>
Thomas Roß08bdf502012-05-12 14:21:23 +02001794 </Document>
Lee Thomason3ffdd392012-03-28 17:27:55 -07001795 @endverbatim
1796
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001797 Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very
Lee Thomason3ffdd392012-03-28 17:27:55 -07001798 easy to write a *lot* of code that looks like:
1799
1800 @verbatim
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001801 XMLElement* root = document.FirstChildElement( "Document" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001802 if ( root )
1803 {
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001804 XMLElement* element = root->FirstChildElement( "Element" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001805 if ( element )
1806 {
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001807 XMLElement* child = element->FirstChildElement( "Child" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001808 if ( child )
1809 {
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001810 XMLElement* child2 = child->NextSiblingElement( "Child" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001811 if ( child2 )
1812 {
1813 // Finally do something useful.
1814 @endverbatim
1815
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001816 And that doesn't even cover "else" cases. XMLHandle addresses the verbosity
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001817 of such code. A XMLHandle checks for null pointers so it is perfectly safe
Lee Thomason3ffdd392012-03-28 17:27:55 -07001818 and correct to use:
1819
1820 @verbatim
Lee Thomasondb0bbb62012-04-04 15:47:04 -07001821 XMLHandle docHandle( &document );
Dmitry-Mea317bd62014-12-08 10:35:37 +03001822 XMLElement* child2 = docHandle.FirstChildElement( "Document" ).FirstChildElement( "Element" ).FirstChildElement().NextSiblingElement();
Lee Thomason3ffdd392012-03-28 17:27:55 -07001823 if ( child2 )
1824 {
1825 // do something useful
1826 @endverbatim
1827
1828 Which is MUCH more concise and useful.
1829
1830 It is also safe to copy handles - internally they are nothing more than node pointers.
1831 @verbatim
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001832 XMLHandle handleCopy = handle;
Lee Thomason3ffdd392012-03-28 17:27:55 -07001833 @endverbatim
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001834
1835 See also XMLConstHandle, which is the same as XMLHandle, but operates on const objects.
Lee Thomason3ffdd392012-03-28 17:27:55 -07001836*/
PKEuS16ed47d2013-07-06 12:02:43 +02001837class TINYXML2_LIB XMLHandle
Lee Thomason3ffdd392012-03-28 17:27:55 -07001838{
1839public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001840 /// 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 -07001841 XMLHandle( XMLNode* node ) {
1842 _node = node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001843 }
1844 /// Create a handle from a node.
Lee Thomason624d43f2012-10-12 10:58:48 -07001845 XMLHandle( XMLNode& node ) {
1846 _node = &node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001847 }
1848 /// Copy constructor
1849 XMLHandle( const XMLHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001850 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001851 }
1852 /// Assignment
1853 XMLHandle& operator=( const XMLHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001854 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001855 return *this;
1856 }
Lee Thomason3ffdd392012-03-28 17:27:55 -07001857
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001858 /// Get the first child of this handle.
1859 XMLHandle FirstChild() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001860 return XMLHandle( _node ? _node->FirstChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001861 }
1862 /// Get the first child element of this handle.
Dmitry-Me886ad972015-07-22 11:00:51 +03001863 XMLHandle FirstChildElement( const char* name = 0 ) {
1864 return XMLHandle( _node ? _node->FirstChildElement( name ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001865 }
1866 /// Get the last child of this handle.
1867 XMLHandle LastChild() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001868 return XMLHandle( _node ? _node->LastChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001869 }
1870 /// Get the last child element of this handle.
Dmitry-Me886ad972015-07-22 11:00:51 +03001871 XMLHandle LastChildElement( const char* name = 0 ) {
1872 return XMLHandle( _node ? _node->LastChildElement( name ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001873 }
1874 /// Get the previous sibling of this handle.
1875 XMLHandle PreviousSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001876 return XMLHandle( _node ? _node->PreviousSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001877 }
1878 /// Get the previous sibling element of this handle.
Dmitry-Me886ad972015-07-22 11:00:51 +03001879 XMLHandle PreviousSiblingElement( const char* name = 0 ) {
1880 return XMLHandle( _node ? _node->PreviousSiblingElement( name ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001881 }
1882 /// Get the next sibling of this handle.
1883 XMLHandle NextSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001884 return XMLHandle( _node ? _node->NextSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001885 }
1886 /// Get the next sibling element of this handle.
Dmitry-Me886ad972015-07-22 11:00:51 +03001887 XMLHandle NextSiblingElement( const char* name = 0 ) {
1888 return XMLHandle( _node ? _node->NextSiblingElement( name ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001889 }
Lee Thomason3ffdd392012-03-28 17:27:55 -07001890
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001891 /// Safe cast to XMLNode. This can return null.
1892 XMLNode* ToNode() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001893 return _node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001894 }
1895 /// Safe cast to XMLElement. This can return null.
1896 XMLElement* ToElement() {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001897 return ( ( _node == 0 ) ? 0 : _node->ToElement() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001898 }
1899 /// Safe cast to XMLText. This can return null.
1900 XMLText* ToText() {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001901 return ( ( _node == 0 ) ? 0 : _node->ToText() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001902 }
1903 /// Safe cast to XMLUnknown. This can return null.
1904 XMLUnknown* ToUnknown() {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001905 return ( ( _node == 0 ) ? 0 : _node->ToUnknown() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001906 }
1907 /// Safe cast to XMLDeclaration. This can return null.
1908 XMLDeclaration* ToDeclaration() {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001909 return ( ( _node == 0 ) ? 0 : _node->ToDeclaration() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001910 }
Lee Thomason3ffdd392012-03-28 17:27:55 -07001911
1912private:
Lee Thomason624d43f2012-10-12 10:58:48 -07001913 XMLNode* _node;
Lee Thomason3ffdd392012-03-28 17:27:55 -07001914};
1915
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001916
1917/**
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001918 A variant of the XMLHandle class for working with const XMLNodes and Documents. It is the
1919 same in all regards, except for the 'const' qualifiers. See XMLHandle for API.
Lee Thomason8b899812012-04-04 15:58:16 -07001920*/
PKEuS16ed47d2013-07-06 12:02:43 +02001921class TINYXML2_LIB XMLConstHandle
Lee Thomason8b899812012-04-04 15:58:16 -07001922{
1923public:
Lee Thomason624d43f2012-10-12 10:58:48 -07001924 XMLConstHandle( const XMLNode* node ) {
1925 _node = node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001926 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001927 XMLConstHandle( const XMLNode& node ) {
1928 _node = &node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001929 }
1930 XMLConstHandle( const XMLConstHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001931 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001932 }
Lee Thomason8b899812012-04-04 15:58:16 -07001933
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001934 XMLConstHandle& operator=( const XMLConstHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001935 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001936 return *this;
1937 }
Lee Thomason8b899812012-04-04 15:58:16 -07001938
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001939 const XMLConstHandle FirstChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001940 return XMLConstHandle( _node ? _node->FirstChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001941 }
Dmitry-Me886ad972015-07-22 11:00:51 +03001942 const XMLConstHandle FirstChildElement( const char* name = 0 ) const {
1943 return XMLConstHandle( _node ? _node->FirstChildElement( name ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001944 }
1945 const XMLConstHandle LastChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001946 return XMLConstHandle( _node ? _node->LastChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001947 }
Dmitry-Me886ad972015-07-22 11:00:51 +03001948 const XMLConstHandle LastChildElement( const char* name = 0 ) const {
1949 return XMLConstHandle( _node ? _node->LastChildElement( name ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001950 }
1951 const XMLConstHandle PreviousSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001952 return XMLConstHandle( _node ? _node->PreviousSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001953 }
Dmitry-Me886ad972015-07-22 11:00:51 +03001954 const XMLConstHandle PreviousSiblingElement( const char* name = 0 ) const {
1955 return XMLConstHandle( _node ? _node->PreviousSiblingElement( name ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001956 }
1957 const XMLConstHandle NextSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001958 return XMLConstHandle( _node ? _node->NextSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001959 }
Dmitry-Me886ad972015-07-22 11:00:51 +03001960 const XMLConstHandle NextSiblingElement( const char* name = 0 ) const {
1961 return XMLConstHandle( _node ? _node->NextSiblingElement( name ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001962 }
Lee Thomason8b899812012-04-04 15:58:16 -07001963
1964
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001965 const XMLNode* ToNode() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001966 return _node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001967 }
1968 const XMLElement* ToElement() const {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001969 return ( ( _node == 0 ) ? 0 : _node->ToElement() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001970 }
1971 const XMLText* ToText() const {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001972 return ( ( _node == 0 ) ? 0 : _node->ToText() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001973 }
1974 const XMLUnknown* ToUnknown() const {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001975 return ( ( _node == 0 ) ? 0 : _node->ToUnknown() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001976 }
1977 const XMLDeclaration* ToDeclaration() const {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001978 return ( ( _node == 0 ) ? 0 : _node->ToDeclaration() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001979 }
Lee Thomason (grinliz)bd0a8ac2012-02-20 20:14:33 -08001980
Lee Thomason5cae8972012-01-24 18:03:07 -08001981private:
Lee Thomason624d43f2012-10-12 10:58:48 -07001982 const XMLNode* _node;
Lee Thomason56bdd022012-02-09 18:16:58 -08001983};
Lee Thomason6f381b72012-03-02 12:59:39 -08001984
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001985
1986/**
1987 Printing functionality. The XMLPrinter gives you more
1988 options than the XMLDocument::Print() method.
1989
1990 It can:
1991 -# Print to memory.
Thomas Roß08bdf502012-05-12 14:21:23 +02001992 -# Print to a file you provide.
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001993 -# Print XML without a XMLDocument.
1994
1995 Print to Memory
1996
1997 @verbatim
1998 XMLPrinter printer;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001999 doc.Print( &printer );
Thomas Roß08bdf502012-05-12 14:21:23 +02002000 SomeFunction( printer.CStr() );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002001 @endverbatim
2002
2003 Print to a File
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07002004
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002005 You provide the file pointer.
2006 @verbatim
2007 XMLPrinter printer( fp );
2008 doc.Print( &printer );
2009 @endverbatim
2010
2011 Print without a XMLDocument
2012
2013 When loading, an XML parser is very useful. However, sometimes
2014 when saving, it just gets in the way. The code is often set up
2015 for streaming, and constructing the DOM is just overhead.
2016
2017 The Printer supports the streaming case. The following code
2018 prints out a trivially simple XML file without ever creating
2019 an XML document.
2020
2021 @verbatim
2022 XMLPrinter printer( fp );
2023 printer.OpenElement( "foo" );
2024 printer.PushAttribute( "foo", "bar" );
2025 printer.CloseElement();
2026 @endverbatim
2027*/
PKEuS16ed47d2013-07-06 12:02:43 +02002028class TINYXML2_LIB XMLPrinter : public XMLVisitor
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002029{
2030public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002031 /** Construct the printer. If the FILE* is specified,
2032 this will print to the FILE. Else it will print
2033 to memory, and the result is available in CStr().
2034 If 'compact' is set to true, then output is created
2035 with only required whitespace and newlines.
2036 */
PKEuS1bfb9542013-08-04 13:51:17 +02002037 XMLPrinter( FILE* file=0, bool compact = false, int depth = 0 );
Dennis Jenkins59c75d32013-10-08 13:10:07 -05002038 virtual ~XMLPrinter() {}
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002039
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002040 /** If streaming, write the BOM and declaration. */
2041 void PushHeader( bool writeBOM, bool writeDeclaration );
2042 /** If streaming, start writing an element.
2043 The element must be closed with CloseElement()
2044 */
Lee Thomason256adb62014-04-06 14:41:46 -07002045 void OpenElement( const char* name, bool compactMode=false );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002046 /// If streaming, add an attribute to an open element.
2047 void PushAttribute( const char* name, const char* value );
2048 void PushAttribute( const char* name, int value );
2049 void PushAttribute( const char* name, unsigned value );
Lee Thomason51c12712016-06-04 20:18:49 -07002050 void PushAttribute(const char* name, int64_t value);
2051 void PushAttribute( const char* name, bool value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002052 void PushAttribute( const char* name, double value );
2053 /// If streaming, close the Element.
Lee Thomason256adb62014-04-06 14:41:46 -07002054 virtual void CloseElement( bool compactMode=false );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002055
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002056 /// Add a text node.
2057 void PushText( const char* text, bool cdata=false );
2058 /// Add a text node from an integer.
2059 void PushText( int value );
2060 /// Add a text node from an unsigned.
2061 void PushText( unsigned value );
Lee Thomason51c12712016-06-04 20:18:49 -07002062 /// Add a text node from an unsigned.
2063 void PushText(int64_t value);
2064 /// Add a text node from a bool.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002065 void PushText( bool value );
2066 /// Add a text node from a float.
2067 void PushText( float value );
2068 /// Add a text node from a double.
2069 void PushText( double value );
Lee Thomason21be8822012-07-15 17:27:22 -07002070
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002071 /// Add a comment
2072 void PushComment( const char* comment );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002073
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002074 void PushDeclaration( const char* value );
2075 void PushUnknown( const char* value );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002076
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002077 virtual bool VisitEnter( const XMLDocument& /*doc*/ );
2078 virtual bool VisitExit( const XMLDocument& /*doc*/ ) {
2079 return true;
2080 }
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002081
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002082 virtual bool VisitEnter( const XMLElement& element, const XMLAttribute* attribute );
2083 virtual bool VisitExit( const XMLElement& element );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002084
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002085 virtual bool Visit( const XMLText& text );
2086 virtual bool Visit( const XMLComment& comment );
2087 virtual bool Visit( const XMLDeclaration& declaration );
2088 virtual bool Visit( const XMLUnknown& unknown );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002089
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002090 /**
2091 If in print to memory mode, return a pointer to
2092 the XML file in memory.
2093 */
2094 const char* CStr() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07002095 return _buffer.Mem();
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002096 }
2097 /**
2098 If in print to memory mode, return the size
2099 of the XML file in memory. (Note the size returned
2100 includes the terminating null.)
2101 */
2102 int CStrSize() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07002103 return _buffer.Size();
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002104 }
Reinhard Klambauer3bc3d4e2013-11-22 14:05:21 +01002105 /**
2106 If in print to memory mode, reset the buffer to the
2107 beginning.
2108 */
Lee Thomasonce0510b2013-11-26 21:29:37 -08002109 void ClearBuffer() {
2110 _buffer.Clear();
Reinhard Klambauer3bc3d4e2013-11-22 14:05:21 +01002111 _buffer.Push(0);
2112 }
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002113
Dennis Jenkins59c75d32013-10-08 13:10:07 -05002114protected:
Alexander Maid740b642014-05-20 22:04:42 +02002115 virtual bool CompactMode( const XMLElement& ) { return _compactMode; }
Uli Kusterer5d1d27e2014-02-20 11:50:22 +01002116
Lee Thomasonc18eb232014-02-21 17:31:17 -08002117 /** Prints out the space before an element. You may override to change
2118 the space and tabs used. A PrintSpace() override should call Print().
2119 */
2120 virtual void PrintSpace( int depth );
2121 void Print( const char* format, ... );
2122
Dmitry-Mea092bc12014-12-23 17:57:05 +03002123 void SealElementIfJustOpened();
Dennis Jenkins59c75d32013-10-08 13:10:07 -05002124 bool _elementJustOpened;
2125 DynArray< const char*, 10 > _stack;
2126
2127private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002128 void PrintString( const char*, bool restrictedEntitySet ); // prints out, after detecting entities.
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002129
Lee Thomason624d43f2012-10-12 10:58:48 -07002130 bool _firstElement;
Jerome Martinez242c3ea2013-01-06 12:20:04 +01002131 FILE* _fp;
Lee Thomason624d43f2012-10-12 10:58:48 -07002132 int _depth;
2133 int _textDepth;
2134 bool _processEntities;
Lee Thomasonc18eb232014-02-21 17:31:17 -08002135 bool _compactMode;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002136
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002137 enum {
2138 ENTITY_RANGE = 64,
2139 BUF_SIZE = 200
2140 };
Lee Thomason624d43f2012-10-12 10:58:48 -07002141 bool _entityFlag[ENTITY_RANGE];
2142 bool _restrictedEntityFlag[ENTITY_RANGE];
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002143
Lee Thomason624d43f2012-10-12 10:58:48 -07002144 DynArray< char, 20 > _buffer;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002145};
2146
2147
Guillermo A. Amaralb42ba362012-03-20 00:15:30 -07002148} // tinyxml2
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002149
PKEuS95060352013-07-26 10:42:44 +02002150#if defined(_MSC_VER)
2151# pragma warning(pop)
2152#endif
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002153
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002154#endif // TINYXML2_INCLUDED