blob: 35da4d92b3da125edd4d4dd425c62896c8203976 [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>
33# include <stdarg.h>
Lee Thomason (grinliz)bc1bfb72012-08-20 22:00:38 -070034#else
Lee Thomasona9cf3f92012-10-11 16:56:51 -070035# include <cctype>
36# include <climits>
37# include <cstdio>
38# include <cstdlib>
39# include <cstring>
40# include <cstdarg>
Lee Thomason (grinliz)bc1bfb72012-08-20 22:00:38 -070041#endif
Lee Thomason (grinliz)6a22be22012-04-04 12:39:05 -070042
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -070043/*
Lee Thomason7d00b9a2012-02-27 17:54:22 -080044 TODO: intern strings instead of allocation.
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -080045*/
Lee Thomason (grinliz)9b093cc2012-02-25 21:30:18 -080046/*
Lee Thomasona9cf3f92012-10-11 16:56:51 -070047 gcc:
Lee Thomason5b0a6772012-11-19 13:54:42 -080048 g++ -Wall -DDEBUG tinyxml2.cpp xmltest.cpp -o gccxmltest.exe
MortenMacFly4ee49f12013-01-14 20:03:14 +010049
Lee Thomasona9cf3f92012-10-11 16:56:51 -070050 Formatting, Artistic Style:
51 AStyle.exe --style=1tbs --indent-switches --break-closing-brackets --indent-preprocessor tinyxml2.cpp tinyxml2.h
Lee Thomason (grinliz)9b093cc2012-02-25 21:30:18 -080052*/
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -080053
U-Lama\Lee4cee6112011-12-31 14:58:18 -080054#if defined( _DEBUG ) || defined( DEBUG ) || defined (__DEBUG__)
Lee Thomasona9cf3f92012-10-11 16:56:51 -070055# ifndef DEBUG
56# define DEBUG
57# endif
U-Lama\Lee4cee6112011-12-31 14:58:18 -080058#endif
59
PKEuS95060352013-07-26 10:42:44 +020060#ifdef _MSC_VER
61# pragma warning(push)
62# pragma warning(disable: 4251)
63#endif
U-Lama\Lee4cee6112011-12-31 14:58:18 -080064
PKEuS16ed47d2013-07-06 12:02:43 +020065#ifdef _WIN32
66# ifdef TINYXML2_EXPORT
67# define TINYXML2_LIB __declspec(dllexport)
68# elif defined(TINYXML2_IMPORT)
69# define TINYXML2_LIB __declspec(dllimport)
70# else
71# define TINYXML2_LIB
72# endif
73#else
74# define TINYXML2_LIB
75#endif
76
77
U-Lama\Lee4cee6112011-12-31 14:58:18 -080078#if defined(DEBUG)
Lee Thomasona9cf3f92012-10-11 16:56:51 -070079# if defined(_MSC_VER)
80# define TIXMLASSERT( x ) if ( !(x)) { __debugbreak(); } //if ( !(x)) WinDebugBreak()
81# elif defined (ANDROID_NDK)
82# include <android/log.h>
83# define TIXMLASSERT( x ) if ( !(x)) { __android_log_assert( "assert", "grinliz", "ASSERT in '%s' at %d.", __FILE__, __LINE__ ); }
84# else
85# include <assert.h>
86# define TIXMLASSERT assert
87# endif
88# else
89# define TIXMLASSERT( x ) {}
U-Lama\Lee4cee6112011-12-31 14:58:18 -080090#endif
91
U-Lama\Leee13c3e62011-12-28 14:36:55 -080092
pffang91d34a02014-07-10 10:02:35 +080093#if defined(_MSC_VER) && (_MSC_VER >= 1400 ) && (!defined WINCE)
Lee Thomasona9cf3f92012-10-11 16:56:51 -070094// Microsoft visual studio, version 2005 and higher.
95/*int _snprintf_s(
96 char *buffer,
97 size_t sizeOfBuffer,
98 size_t count,
99 const char *format [,
100 argument] ...
101);*/
102inline int TIXML_SNPRINTF( char* buffer, size_t size, const char* format, ... )
103{
104 va_list va;
105 va_start( va, format );
106 int result = vsnprintf_s( buffer, size, _TRUNCATE, format, va );
107 va_end( va );
108 return result;
109}
110#define TIXML_SSCANF sscanf_s
pffang91d34a02014-07-10 10:02:35 +0800111#elif defined WINCE
112#define TIXML_SNPRINTF _snprintf
113#define TIXML_SSCANF sscanf
Lee Thomason (grinliz)b9e791f2012-04-06 21:27:10 -0700114#else
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700115// GCC version 3 and higher
116//#warning( "Using sn* functions." )
117#define TIXML_SNPRINTF snprintf
118#define TIXML_SSCANF sscanf
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800119#endif
Lee Thomason1ff38e02012-02-14 18:18:16 -0800120
Lee Thomasonc18eb232014-02-21 17:31:17 -0800121/* Versioning, past 1.0.14:
Lee Thomason85afe9c2014-02-23 21:42:16 -0800122 http://semver.org/
Lee Thomasonc18eb232014-02-21 17:31:17 -0800123*/
Lee Thomasonf07b9522014-10-30 13:25:12 -0700124static const int TIXML2_MAJOR_VERSION = 2;
125static const int TIXML2_MINOR_VERSION = 2;
126static const int TIXML2_PATCH_VERSION = 0;
Lee Thomason1ff38e02012-02-14 18:18:16 -0800127
U-Lama\Leee13c3e62011-12-28 14:36:55 -0800128namespace tinyxml2
129{
Lee Thomasonce0763e2012-01-11 15:43:54 -0800130class XMLDocument;
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800131class XMLElement;
132class XMLAttribute;
133class XMLComment;
Lee Thomason5492a1c2012-01-23 15:32:10 -0800134class XMLText;
Lee Thomason50f97b22012-02-11 16:33:40 -0800135class XMLDeclaration;
136class XMLUnknown;
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800137class XMLPrinter;
Lee Thomason5cae8972012-01-24 18:03:07 -0800138
U-Stream\Leeae25a442012-02-17 17:48:16 -0800139/*
140 A class that wraps strings. Normally stores the start and end
141 pointers into the XML file itself, and will apply normalization
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800142 and entity translation if actually read. Can also store (and memory
U-Stream\Leeae25a442012-02-17 17:48:16 -0800143 manage) a traditional char[]
144*/
PKEuS95060352013-07-26 10:42:44 +0200145class StrPair
Lee Thomason39ede242012-01-20 11:27:56 -0800146{
Lee Thomasond34f52c2012-01-20 12:55:24 -0800147public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700148 enum {
149 NEEDS_ENTITY_PROCESSING = 0x01,
150 NEEDS_NEWLINE_NORMALIZATION = 0x02,
selfpoisede77e1952013-03-13 14:08:29 +0800151 COLLAPSE_WHITESPACE = 0x04,
Lee Thomason18d68bd2012-01-26 18:17:26 -0800152
selfpoisede77e1952013-03-13 14:08:29 +0800153 TEXT_ELEMENT = NEEDS_ENTITY_PROCESSING | NEEDS_NEWLINE_NORMALIZATION,
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700154 TEXT_ELEMENT_LEAVE_ENTITIES = NEEDS_NEWLINE_NORMALIZATION,
selfpoisede77e1952013-03-13 14:08:29 +0800155 ATTRIBUTE_NAME = 0,
156 ATTRIBUTE_VALUE = NEEDS_ENTITY_PROCESSING | NEEDS_NEWLINE_NORMALIZATION,
157 ATTRIBUTE_VALUE_LEAVE_ENTITIES = NEEDS_NEWLINE_NORMALIZATION,
158 COMMENT = NEEDS_NEWLINE_NORMALIZATION
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700159 };
Lee Thomason39ede242012-01-20 11:27:56 -0800160
Lee Thomason120b3a62012-10-12 10:06:59 -0700161 StrPair() : _flags( 0 ), _start( 0 ), _end( 0 ) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700162 ~StrPair();
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800163
Lee Thomason120b3a62012-10-12 10:06:59 -0700164 void Set( char* start, char* end, int flags ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700165 Reset();
Lee Thomason120b3a62012-10-12 10:06:59 -0700166 _start = start;
167 _end = end;
168 _flags = flags | NEEDS_FLUSH;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700169 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700170
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700171 const char* GetStr();
Lee Thomason120b3a62012-10-12 10:06:59 -0700172
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700173 bool Empty() const {
Lee Thomason120b3a62012-10-12 10:06:59 -0700174 return _start == _end;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700175 }
Lee Thomason39ede242012-01-20 11:27:56 -0800176
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700177 void SetInternedStr( const char* str ) {
178 Reset();
Lee Thomason120b3a62012-10-12 10:06:59 -0700179 _start = const_cast<char*>(str);
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700180 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700181
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700182 void SetStr( const char* str, int flags=0 );
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800183
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700184 char* ParseText( char* in, const char* endTag, int strFlags );
185 char* ParseName( char* in );
Lee Thomason56bdd022012-02-09 18:16:58 -0800186
Lee Thomason29658802014-11-27 22:31:11 -0800187 void TransferTo( StrPair* other );
Dmitry-Me08b40dd2014-11-10 11:17:21 +0300188
Lee Thomason39ede242012-01-20 11:27:56 -0800189private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700190 void Reset();
191 void CollapseWhitespace();
Lee Thomason1a1d4a72012-02-15 09:09:25 -0800192
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700193 enum {
194 NEEDS_FLUSH = 0x100,
195 NEEDS_DELETE = 0x200
196 };
Lee Thomasone4422302012-01-20 17:59:50 -0800197
selfpoised4dd59bc2013-03-13 16:54:15 +0800198 // After parsing, if *_end != 0, it can be set to zero.
Lee Thomason120b3a62012-10-12 10:06:59 -0700199 int _flags;
200 char* _start;
201 char* _end;
Dmitry-Me08b40dd2014-11-10 11:17:21 +0300202
203 StrPair( const StrPair& other ); // not supported
204 void operator=( StrPair& other ); // not supported, use TransferTo()
Lee Thomason39ede242012-01-20 11:27:56 -0800205};
206
U-Lama\Lee560bd472011-12-28 19:42:49 -0800207
U-Stream\Leeae25a442012-02-17 17:48:16 -0800208/*
209 A dynamic array of Plain Old Data. Doesn't support constructors, etc.
210 Has a small initial memory pool, so that low or no usage will not
211 cause a call to new/delete
212*/
Lee Thomason2c85a712012-01-31 08:24:24 -0800213template <class T, int INIT>
PKEuS95060352013-07-26 10:42:44 +0200214class DynArray
Lee Thomason2c85a712012-01-31 08:24:24 -0800215{
216public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700217 DynArray< T, INIT >() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700218 _mem = _pool;
219 _allocated = INIT;
220 _size = 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700221 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700222
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700223 ~DynArray() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700224 if ( _mem != _pool ) {
Lee Thomasoned5c8792012-10-12 10:09:48 -0700225 delete [] _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700226 }
227 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700228
Lee Thomasonce0510b2013-11-26 21:29:37 -0800229 void Clear() {
Reinhard Klambauer4e74b132013-11-22 14:01:58 +0100230 _size = 0;
231 }
232
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700233 void Push( T t ) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700234 EnsureCapacity( _size+1 );
235 _mem[_size++] = t;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700236 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800237
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700238 T* PushArr( int count ) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700239 EnsureCapacity( _size+count );
240 T* ret = &_mem[_size];
241 _size += count;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700242 return ret;
243 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700244
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700245 T Pop() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700246 return _mem[--_size];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700247 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700248
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700249 void PopArr( int count ) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700250 TIXMLASSERT( _size >= count );
251 _size -= count;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700252 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800253
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700254 bool Empty() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700255 return _size == 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700256 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700257
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700258 T& operator[](int i) {
Lee Thomason624d43f2012-10-12 10:58:48 -0700259 TIXMLASSERT( i>= 0 && i < _size );
Lee Thomasoned5c8792012-10-12 10:09:48 -0700260 return _mem[i];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700261 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700262
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700263 const T& operator[](int i) const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700264 TIXMLASSERT( i>= 0 && i < _size );
Lee Thomasoned5c8792012-10-12 10:09:48 -0700265 return _mem[i];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700266 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700267
Lee Thomasonf07b9522014-10-30 13:25:12 -0700268 const T& PeekTop() const {
Dennis Jenkins59c75d32013-10-08 13:10:07 -0500269 TIXMLASSERT( _size > 0 );
270 return _mem[ _size - 1];
271 }
272
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700273 int Size() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700274 return _size;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700275 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700276
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700277 int Capacity() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700278 return _allocated;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700279 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700280
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700281 const T* Mem() const {
Lee Thomasoned5c8792012-10-12 10:09:48 -0700282 return _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700283 }
Lee Thomason120b3a62012-10-12 10:06:59 -0700284
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700285 T* Mem() {
Lee Thomasoned5c8792012-10-12 10:09:48 -0700286 return _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700287 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800288
Lee Thomason2c85a712012-01-31 08:24:24 -0800289private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700290 void EnsureCapacity( int cap ) {
Dmitry-Me9fae8692014-12-22 17:59:59 +0300291 TIXMLASSERT( cap > 0 );
Lee Thomason624d43f2012-10-12 10:58:48 -0700292 if ( cap > _allocated ) {
Dmitry-Me9fae8692014-12-22 17:59:59 +0300293 TIXMLASSERT( cap <= INT_MAX / 2 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700294 int newAllocated = cap * 2;
295 T* newMem = new T[newAllocated];
Lee Thomason624d43f2012-10-12 10:58:48 -0700296 memcpy( newMem, _mem, sizeof(T)*_size ); // warning: not using constructors, only works for PODs
297 if ( _mem != _pool ) {
Lee Thomasoned5c8792012-10-12 10:09:48 -0700298 delete [] _mem;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700299 }
Lee Thomasoned5c8792012-10-12 10:09:48 -0700300 _mem = newMem;
Lee Thomason624d43f2012-10-12 10:58:48 -0700301 _allocated = newAllocated;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700302 }
303 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800304
Lee Thomason624d43f2012-10-12 10:58:48 -0700305 T* _mem;
306 T _pool[INIT];
307 int _allocated; // objects allocated
308 int _size; // number objects in use
Lee Thomason2c85a712012-01-31 08:24:24 -0800309};
310
Lee Thomason50adb4c2012-02-13 15:07:09 -0800311
U-Stream\Leeae25a442012-02-17 17:48:16 -0800312/*
Thomas Roß08bdf502012-05-12 14:21:23 +0200313 Parent virtual class of a pool for fast allocation
U-Stream\Leeae25a442012-02-17 17:48:16 -0800314 and deallocation of objects.
315*/
PKEuS95060352013-07-26 10:42:44 +0200316class MemPool
Lee Thomasond1983222012-02-06 08:41:24 -0800317{
318public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700319 MemPool() {}
320 virtual ~MemPool() {}
Lee Thomasond1983222012-02-06 08:41:24 -0800321
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700322 virtual int ItemSize() const = 0;
323 virtual void* Alloc() = 0;
324 virtual void Free( void* ) = 0;
Lee Thomason5b0a6772012-11-19 13:54:42 -0800325 virtual void SetTracked() = 0;
Lee Thomasonf07b9522014-10-30 13:25:12 -0700326 virtual void Clear() = 0;
Lee Thomasond1983222012-02-06 08:41:24 -0800327};
328
Lee Thomason50adb4c2012-02-13 15:07:09 -0800329
U-Stream\Leeae25a442012-02-17 17:48:16 -0800330/*
331 Template child class to create pools of the correct type.
332*/
Lee Thomasond1983222012-02-06 08:41:24 -0800333template< int SIZE >
PKEuS95060352013-07-26 10:42:44 +0200334class MemPoolT : public MemPool
Lee Thomasond1983222012-02-06 08:41:24 -0800335{
336public:
Lee Thomason5b0a6772012-11-19 13:54:42 -0800337 MemPoolT() : _root(0), _currentAllocs(0), _nAllocs(0), _maxAllocs(0), _nUntracked(0) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700338 ~MemPoolT() {
Lee Thomasonf07b9522014-10-30 13:25:12 -0700339 Clear();
340 }
341
342 void Clear() {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700343 // Delete the blocks.
Lee Thomasonf07b9522014-10-30 13:25:12 -0700344 while( !_blockPtrs.Empty()) {
345 Block* b = _blockPtrs.Pop();
346 delete b;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700347 }
Lee Thomasonf07b9522014-10-30 13:25:12 -0700348 _root = 0;
349 _currentAllocs = 0;
350 _nAllocs = 0;
351 _maxAllocs = 0;
352 _nUntracked = 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700353 }
Lee Thomasond1983222012-02-06 08:41:24 -0800354
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700355 virtual int ItemSize() const {
356 return SIZE;
357 }
358 int CurrentAllocs() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700359 return _currentAllocs;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700360 }
Lee Thomasond1983222012-02-06 08:41:24 -0800361
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700362 virtual void* Alloc() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700363 if ( !_root ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700364 // Need a new block.
365 Block* block = new Block();
Lee Thomason624d43f2012-10-12 10:58:48 -0700366 _blockPtrs.Push( block );
Lee Thomasond1983222012-02-06 08:41:24 -0800367
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700368 for( int i=0; i<COUNT-1; ++i ) {
369 block->chunk[i].next = &block->chunk[i+1];
370 }
371 block->chunk[COUNT-1].next = 0;
Lee Thomason624d43f2012-10-12 10:58:48 -0700372 _root = block->chunk;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700373 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700374 void* result = _root;
375 _root = _root->next;
Lee Thomason455c9d42012-02-06 09:14:14 -0800376
Lee Thomason624d43f2012-10-12 10:58:48 -0700377 ++_currentAllocs;
378 if ( _currentAllocs > _maxAllocs ) {
379 _maxAllocs = _currentAllocs;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700380 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700381 _nAllocs++;
Lee Thomason5b0a6772012-11-19 13:54:42 -0800382 _nUntracked++;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700383 return result;
384 }
Lee Thomasonf07b9522014-10-30 13:25:12 -0700385
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700386 virtual void Free( void* mem ) {
387 if ( !mem ) {
388 return;
389 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700390 --_currentAllocs;
Dmitry-Me56571762014-08-15 11:03:47 +0400391 Chunk* chunk = static_cast<Chunk*>( mem );
Lee Thomason (grinliz)6020a012012-09-08 21:15:09 -0700392#ifdef DEBUG
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700393 memset( chunk, 0xfe, sizeof(Chunk) );
Lee Thomason (grinliz)6020a012012-09-08 21:15:09 -0700394#endif
Lee Thomason624d43f2012-10-12 10:58:48 -0700395 chunk->next = _root;
396 _root = chunk;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700397 }
398 void Trace( const char* name ) {
399 printf( "Mempool %s watermark=%d [%dk] current=%d size=%d nAlloc=%d blocks=%d\n",
Lee Thomason624d43f2012-10-12 10:58:48 -0700400 name, _maxAllocs, _maxAllocs*SIZE/1024, _currentAllocs, SIZE, _nAllocs, _blockPtrs.Size() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700401 }
Lee Thomasond1983222012-02-06 08:41:24 -0800402
Lee Thomason5b0a6772012-11-19 13:54:42 -0800403 void SetTracked() {
404 _nUntracked--;
405 }
406
407 int Untracked() const {
408 return _nUntracked;
409 }
410
Lee Thomason (grinliz)ac83b4e2013-02-01 09:02:34 -0800411 // This number is perf sensitive. 4k seems like a good tradeoff on my machine.
412 // The test file is large, 170k.
413 // Release: VS2010 gcc(no opt)
414 // 1k: 4000
415 // 2k: 4000
416 // 4k: 3900 21000
417 // 16k: 5200
418 // 32k: 4300
419 // 64k: 4000 21000
420 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 +0200421
Lee Thomasond1983222012-02-06 08:41:24 -0800422private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700423 union Chunk {
Lee Thomason624d43f2012-10-12 10:58:48 -0700424 Chunk* next;
425 char mem[SIZE];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700426 };
427 struct Block {
Lee Thomason (grinliz)856da212012-10-19 09:08:15 -0700428 Chunk chunk[COUNT];
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700429 };
Lee Thomason624d43f2012-10-12 10:58:48 -0700430 DynArray< Block*, 10 > _blockPtrs;
431 Chunk* _root;
Lee Thomason455c9d42012-02-06 09:14:14 -0800432
Lee Thomason624d43f2012-10-12 10:58:48 -0700433 int _currentAllocs;
434 int _nAllocs;
435 int _maxAllocs;
Lee Thomason5b0a6772012-11-19 13:54:42 -0800436 int _nUntracked;
Lee Thomasond1983222012-02-06 08:41:24 -0800437};
438
Lee Thomason2c85a712012-01-31 08:24:24 -0800439
Lee Thomason56bdd022012-02-09 18:16:58 -0800440
441/**
442 Implements the interface to the "Visitor pattern" (see the Accept() method.)
443 If you call the Accept() method, it requires being passed a XMLVisitor
444 class to handle callbacks. For nodes that contain other nodes (Document, Element)
Thomas Roß08bdf502012-05-12 14:21:23 +0200445 you will get called with a VisitEnter/VisitExit pair. Nodes that are always leafs
Lee Thomason56bdd022012-02-09 18:16:58 -0800446 are simply called with Visit().
447
448 If you return 'true' from a Visit method, recursive parsing will continue. If you return
Andrew C. Martin0fd87462013-03-09 20:09:45 -0700449 false, <b>no children of this node or its siblings</b> will be visited.
Lee Thomason56bdd022012-02-09 18:16:58 -0800450
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700451 All flavors of Visit methods have a default implementation that returns 'true' (continue
Lee Thomason56bdd022012-02-09 18:16:58 -0800452 visiting). You need to only override methods that are interesting to you.
453
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600454 Generally Accept() is called on the XMLDocument, although all nodes support visiting.
Lee Thomason56bdd022012-02-09 18:16:58 -0800455
456 You should never change the document from a callback.
457
458 @sa XMLNode::Accept()
459*/
PKEuS16ed47d2013-07-06 12:02:43 +0200460class TINYXML2_LIB XMLVisitor
U-Lama\Leee13c3e62011-12-28 14:36:55 -0800461{
462public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700463 virtual ~XMLVisitor() {}
Lee Thomasond1983222012-02-06 08:41:24 -0800464
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700465 /// Visit a document.
466 virtual bool VisitEnter( const XMLDocument& /*doc*/ ) {
467 return true;
468 }
469 /// Visit a document.
470 virtual bool VisitExit( const XMLDocument& /*doc*/ ) {
471 return true;
472 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800473
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700474 /// Visit an element.
475 virtual bool VisitEnter( const XMLElement& /*element*/, const XMLAttribute* /*firstAttribute*/ ) {
476 return true;
477 }
478 /// Visit an element.
479 virtual bool VisitExit( const XMLElement& /*element*/ ) {
480 return true;
481 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800482
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700483 /// Visit a declaration.
484 virtual bool Visit( const XMLDeclaration& /*declaration*/ ) {
485 return true;
486 }
487 /// Visit a text node.
488 virtual bool Visit( const XMLText& /*text*/ ) {
489 return true;
490 }
491 /// Visit a comment node.
492 virtual bool Visit( const XMLComment& /*comment*/ ) {
493 return true;
494 }
495 /// Visit an unknown node.
496 virtual bool Visit( const XMLUnknown& /*unknown*/ ) {
497 return true;
498 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800499};
500
Dmitry-Me66d2a842014-11-08 15:24:52 +0300501// WARNING: must match XMLDocument::_errorNames[]
numatrumpetbb5ffac2014-09-06 22:56:46 +0900502enum XMLError {
numatrumpetcd8550c2014-09-08 16:59:39 +0900503 XML_SUCCESS = 0,
504 XML_NO_ERROR = 0,
505 XML_NO_ATTRIBUTE,
506 XML_WRONG_ATTRIBUTE_TYPE,
507 XML_ERROR_FILE_NOT_FOUND,
508 XML_ERROR_FILE_COULD_NOT_BE_OPENED,
509 XML_ERROR_FILE_READ_ERROR,
510 XML_ERROR_ELEMENT_MISMATCH,
511 XML_ERROR_PARSING_ELEMENT,
512 XML_ERROR_PARSING_ATTRIBUTE,
513 XML_ERROR_IDENTIFYING_TAG,
514 XML_ERROR_PARSING_TEXT,
515 XML_ERROR_PARSING_CDATA,
516 XML_ERROR_PARSING_COMMENT,
517 XML_ERROR_PARSING_DECLARATION,
518 XML_ERROR_PARSING_UNKNOWN,
519 XML_ERROR_EMPTY_DOCUMENT,
520 XML_ERROR_MISMATCHED_ELEMENT,
521 XML_ERROR_PARSING,
522 XML_CAN_NOT_CONVERT_TEXT,
Lee Thomason331596e2014-09-11 14:56:43 -0700523 XML_NO_TEXT_NODE,
524
525 XML_ERROR_COUNT
numatrumpetbb5ffac2014-09-06 22:56:46 +0900526};
numatrumpetbb5ffac2014-09-06 22:56:46 +0900527
numatrumpetcd8550c2014-09-08 16:59:39 +0900528
U-Stream\Leeae25a442012-02-17 17:48:16 -0800529/*
530 Utility functionality.
531*/
Lee Thomason56bdd022012-02-09 18:16:58 -0800532class XMLUtil
533{
Lee Thomasond1983222012-02-06 08:41:24 -0800534public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700535 static const char* SkipWhiteSpace( const char* p ) {
Dmitry-Mefa20b222014-10-31 12:53:04 +0300536 while( IsWhiteSpace(*p) ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700537 ++p;
538 }
539 return p;
540 }
541 static char* SkipWhiteSpace( char* p ) {
Dmitry-Me9de541f2014-09-24 14:21:36 +0400542 return const_cast<char*>( SkipWhiteSpace( const_cast<const char*>(p) ) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700543 }
Dmitry-Mefa20b222014-10-31 12:53:04 +0300544
545 // Anything in the high order range of UTF-8 is assumed to not be whitespace. This isn't
546 // correct, but simple, and usually works.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700547 static bool IsWhiteSpace( char p ) {
Jerome Martinez242c3ea2013-01-06 12:20:04 +0100548 return !IsUTF8Continuation(p) && isspace( static_cast<unsigned char>(p) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700549 }
Martinsh Shaitersc6d02f42013-01-26 21:22:57 +0200550
551 inline static bool IsNameStartChar( unsigned char ch ) {
552 return ( ( ch < 128 ) ? isalpha( ch ) : 1 )
553 || ch == ':'
554 || ch == '_';
555 }
556
557 inline static bool IsNameChar( unsigned char ch ) {
558 return IsNameStartChar( ch )
559 || isdigit( ch )
560 || ch == '.'
561 || ch == '-';
562 }
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800563
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700564 inline static bool StringEqual( const char* p, const char* q, int nChar=INT_MAX ) {
565 int n = 0;
566 if ( p == q ) {
567 return true;
568 }
569 while( *p && *q && *p == *q && n<nChar ) {
570 ++p;
571 ++q;
572 ++n;
573 }
574 if ( (n == nChar) || ( *p == 0 && *q == 0 ) ) {
575 return true;
576 }
577 return false;
578 }
Martinsh Shaitersc6d02f42013-01-26 21:22:57 +0200579
Dmitry-Me72bb0ec2014-09-24 16:14:24 +0400580 inline static bool IsUTF8Continuation( const char p ) {
581 return ( p & 0x80 ) != 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700582 }
Lee Thomason (grinliz)68db57e2012-02-21 09:08:12 -0800583
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700584 static const char* ReadBOM( const char* p, bool* hasBOM );
585 // p is the starting location,
586 // the UTF-8 value of the entity will be placed in value, and length filled in.
587 static const char* GetCharacterRef( const char* p, char* value, int* length );
588 static void ConvertUTF32ToUTF8( unsigned long input, char* output, int* length );
Lee Thomason21be8822012-07-15 17:27:22 -0700589
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700590 // converts primitive types to strings
591 static void ToStr( int v, char* buffer, int bufferSize );
592 static void ToStr( unsigned v, char* buffer, int bufferSize );
593 static void ToStr( bool v, char* buffer, int bufferSize );
594 static void ToStr( float v, char* buffer, int bufferSize );
595 static void ToStr( double v, char* buffer, int bufferSize );
Lee Thomason21be8822012-07-15 17:27:22 -0700596
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700597 // converts strings to primitive types
598 static bool ToInt( const char* str, int* value );
599 static bool ToUnsigned( const char* str, unsigned* value );
600 static bool ToBool( const char* str, bool* value );
601 static bool ToFloat( const char* str, float* value );
602 static bool ToDouble( const char* str, double* value );
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800603};
604
Lee Thomason5cae8972012-01-24 18:03:07 -0800605
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800606/** XMLNode is a base class for every object that is in the
607 XML Document Object Model (DOM), except XMLAttributes.
608 Nodes have siblings, a parent, and children which can
609 be navigated. A node is always in a XMLDocument.
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700610 The type of a XMLNode can be queried, and it can
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800611 be cast to its more defined type.
612
Thomas Roß08bdf502012-05-12 14:21:23 +0200613 A XMLDocument allocates memory for all its Nodes.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800614 When the XMLDocument gets deleted, all its Nodes
615 will also be deleted.
616
617 @verbatim
618 A Document can contain: Element (container or leaf)
619 Comment (leaf)
620 Unknown (leaf)
621 Declaration( leaf )
622
623 An Element can contain: Element (container or leaf)
624 Text (leaf)
625 Attributes (not on tree)
626 Comment (leaf)
627 Unknown (leaf)
628
629 @endverbatim
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800630*/
PKEuS16ed47d2013-07-06 12:02:43 +0200631class TINYXML2_LIB XMLNode
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800632{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700633 friend class XMLDocument;
634 friend class XMLElement;
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800635public:
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800636
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700637 /// Get the XMLDocument that owns this XMLNode.
638 const XMLDocument* GetDocument() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700639 return _document;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700640 }
641 /// Get the XMLDocument that owns this XMLNode.
642 XMLDocument* GetDocument() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700643 return _document;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700644 }
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800645
Lee Thomason2fa81722012-11-09 12:37:46 -0800646 /// Safely cast to an Element, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700647 virtual XMLElement* ToElement() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100648 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700649 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800650 /// Safely cast to Text, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700651 virtual XMLText* ToText() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100652 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700653 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800654 /// Safely cast to a Comment, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700655 virtual XMLComment* ToComment() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100656 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700657 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800658 /// Safely cast to a Document, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700659 virtual XMLDocument* ToDocument() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100660 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700661 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800662 /// Safely cast to a Declaration, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700663 virtual XMLDeclaration* ToDeclaration() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100664 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700665 }
Lee Thomason2fa81722012-11-09 12:37:46 -0800666 /// Safely cast to an Unknown, or null.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700667 virtual XMLUnknown* ToUnknown() {
MortenMacFly4ee49f12013-01-14 20:03:14 +0100668 return 0;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700669 }
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800670
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700671 virtual const XMLElement* ToElement() const {
672 return 0;
673 }
674 virtual const XMLText* ToText() const {
675 return 0;
676 }
677 virtual const XMLComment* ToComment() const {
678 return 0;
679 }
680 virtual const XMLDocument* ToDocument() const {
681 return 0;
682 }
683 virtual const XMLDeclaration* ToDeclaration() const {
684 return 0;
685 }
686 virtual const XMLUnknown* ToUnknown() const {
687 return 0;
688 }
Lee Thomason751da522012-02-10 08:50:51 -0800689
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700690 /** The meaning of 'value' changes for the specific type.
691 @verbatim
692 Document: empty
693 Element: name of the element
694 Comment: the comment text
695 Unknown: the tag contents
696 Text: the text string
697 @endverbatim
698 */
Michael Daumling21626882013-10-22 17:03:37 +0200699 const char* Value() const;
MortenMacFly4ee49f12013-01-14 20:03:14 +0100700
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700701 /** Set the Value of an XML node.
702 @sa Value()
703 */
704 void SetValue( const char* val, bool staticMem=false );
Lee Thomason2c85a712012-01-31 08:24:24 -0800705
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700706 /// Get the parent of this node on the DOM.
707 const XMLNode* Parent() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700708 return _parent;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700709 }
MortenMacFly4ee49f12013-01-14 20:03:14 +0100710
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700711 XMLNode* Parent() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700712 return _parent;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700713 }
Lee Thomason751da522012-02-10 08:50:51 -0800714
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700715 /// Returns true if this node has no children.
716 bool NoChildren() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700717 return !_firstChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700718 }
Lee Thomason751da522012-02-10 08:50:51 -0800719
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700720 /// Get the first child node, or null if none exists.
721 const XMLNode* FirstChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700722 return _firstChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700723 }
MortenMacFly4ee49f12013-01-14 20:03:14 +0100724
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700725 XMLNode* FirstChild() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700726 return _firstChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700727 }
MortenMacFly4ee49f12013-01-14 20:03:14 +0100728
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700729 /** Get the first child element, or optionally the first child
730 element with the specified name.
731 */
732 const XMLElement* FirstChildElement( const char* value=0 ) const;
Lee Thomason624d43f2012-10-12 10:58:48 -0700733
734 XMLElement* FirstChildElement( const char* value=0 ) {
735 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->FirstChildElement( value ));
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700736 }
Lee Thomason3f57d272012-01-11 15:30:03 -0800737
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700738 /// Get the last child node, or null if none exists.
739 const XMLNode* LastChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700740 return _lastChild;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700741 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700742
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700743 XMLNode* LastChild() {
744 return const_cast<XMLNode*>(const_cast<const XMLNode*>(this)->LastChild() );
745 }
Lee Thomason2c85a712012-01-31 08:24:24 -0800746
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700747 /** Get the last child element or optionally the last child
748 element with the specified name.
749 */
750 const XMLElement* LastChildElement( const char* value=0 ) const;
Lee Thomason624d43f2012-10-12 10:58:48 -0700751
752 XMLElement* LastChildElement( const char* value=0 ) {
753 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->LastChildElement(value) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700754 }
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700755
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700756 /// Get the previous (left) sibling node of this node.
757 const XMLNode* PreviousSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700758 return _prev;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700759 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700760
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700761 XMLNode* PreviousSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700762 return _prev;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700763 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800764
Andrew C. Martin0fd87462013-03-09 20:09:45 -0700765 /// Get the previous (left) sibling element of this node, with an optionally supplied name.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700766 const XMLElement* PreviousSiblingElement( const char* value=0 ) const ;
Lee Thomason624d43f2012-10-12 10:58:48 -0700767
768 XMLElement* PreviousSiblingElement( const char* value=0 ) {
769 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->PreviousSiblingElement( value ) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700770 }
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700771
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700772 /// Get the next (right) sibling node of this node.
773 const XMLNode* NextSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700774 return _next;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700775 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700776
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700777 XMLNode* NextSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -0700778 return _next;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700779 }
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700780
Andrew C. Martin0fd87462013-03-09 20:09:45 -0700781 /// Get the next (right) sibling element of this node, with an optionally supplied name.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700782 const XMLElement* NextSiblingElement( const char* value=0 ) const;
Lee Thomason624d43f2012-10-12 10:58:48 -0700783
784 XMLElement* NextSiblingElement( const char* value=0 ) {
785 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->NextSiblingElement( value ) );
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700786 }
Lee Thomason56bdd022012-02-09 18:16:58 -0800787
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700788 /**
789 Add a child node as the last (right) child.
Michael Daumlinged523282013-10-23 07:47:29 +0200790 If the child node is already part of the document,
791 it is moved from its old location to the new location.
792 Returns the addThis argument or 0 if the node does not
793 belong to the same document.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700794 */
795 XMLNode* InsertEndChild( XMLNode* addThis );
Lee Thomason618dbf82012-02-28 12:34:27 -0800796
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700797 XMLNode* LinkEndChild( XMLNode* addThis ) {
798 return InsertEndChild( addThis );
799 }
800 /**
801 Add a child node as the first (left) child.
Michael Daumlinged523282013-10-23 07:47:29 +0200802 If the child node is already part of the document,
803 it is moved from its old location to the new location.
804 Returns the addThis argument or 0 if the node does not
805 belong to the same document.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700806 */
807 XMLNode* InsertFirstChild( XMLNode* addThis );
808 /**
809 Add a node after the specified child node.
Michael Daumlinged523282013-10-23 07:47:29 +0200810 If the child node is already part of the document,
811 it is moved from its old location to the new location.
812 Returns the addThis argument or 0 if the afterThis node
813 is not a child of this node, or if the node does not
814 belong to the same document.
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700815 */
816 XMLNode* InsertAfterChild( XMLNode* afterThis, XMLNode* addThis );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700817
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700818 /**
819 Delete all the children of this node.
820 */
821 void DeleteChildren();
U-Stream\Leeae25a442012-02-17 17:48:16 -0800822
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700823 /**
824 Delete a child of this node.
825 */
826 void DeleteChild( XMLNode* node );
Lee Thomason56bdd022012-02-09 18:16:58 -0800827
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700828 /**
829 Make a copy of this node, but not its children.
830 You may pass in a Document pointer that will be
831 the owner of the new Node. If the 'document' is
832 null, then the node returned will be allocated
833 from the current Document. (this->GetDocument())
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800834
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700835 Note: if called on a XMLDocument, this will return null.
836 */
837 virtual XMLNode* ShallowClone( XMLDocument* document ) const = 0;
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800838
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700839 /**
840 Test if 2 nodes are the same, but don't test children.
841 The 2 nodes do not need to be in the same Document.
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800842
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700843 Note: if called on a XMLDocument, this will return false.
844 */
845 virtual bool ShallowEqual( const XMLNode* compare ) const = 0;
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800846
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600847 /** Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700848 XML tree will be conditionally visited and the host will be called back
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600849 via the XMLVisitor interface.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800850
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600851 This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse
852 the XML for the callbacks, so the performance of TinyXML-2 is unchanged by using this
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700853 interface versus any other.)
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800854
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700855 The interface has been based on ideas from:
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800856
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700857 - http://www.saxproject.org/
858 - http://c2.com/cgi/wiki?HierarchicalVisitorPattern
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800859
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700860 Which are both good references for "visiting".
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800861
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700862 An example of using Accept():
863 @verbatim
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600864 XMLPrinter printer;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700865 tinyxmlDoc.Accept( &printer );
866 const char* xmlcstr = printer.CStr();
867 @endverbatim
868 */
869 virtual bool Accept( XMLVisitor* visitor ) const = 0;
Lee Thomason56bdd022012-02-09 18:16:58 -0800870
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700871 // internal
872 virtual char* ParseDeep( char*, StrPair* );
Lee Thomason3f57d272012-01-11 15:30:03 -0800873
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800874protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700875 XMLNode( XMLDocument* );
876 virtual ~XMLNode();
877 XMLNode( const XMLNode& ); // not supported
878 XMLNode& operator=( const XMLNode& ); // not supported
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700879
Lee Thomason624d43f2012-10-12 10:58:48 -0700880 XMLDocument* _document;
881 XMLNode* _parent;
882 mutable StrPair _value;
Lee Thomason3f57d272012-01-11 15:30:03 -0800883
Lee Thomason624d43f2012-10-12 10:58:48 -0700884 XMLNode* _firstChild;
885 XMLNode* _lastChild;
Lee Thomason3f57d272012-01-11 15:30:03 -0800886
Lee Thomason624d43f2012-10-12 10:58:48 -0700887 XMLNode* _prev;
888 XMLNode* _next;
Lee Thomason3f57d272012-01-11 15:30:03 -0800889
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800890private:
Lee Thomason624d43f2012-10-12 10:58:48 -0700891 MemPool* _memPool;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700892 void Unlink( XMLNode* child );
Dmitry-Mee3225b12014-09-03 11:03:11 +0400893 static void DeleteNode( XMLNode* node );
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800894};
895
896
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800897/** XML text.
898
899 Note that a text node can have child element nodes, for example:
900 @verbatim
901 <root>This is <b>bold</b></root>
902 @endverbatim
903
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -0700904 A text node can have 2 ways to output the next. "normal" output
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800905 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 -0700906 you generally want to leave it alone, but you can change the output mode with
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600907 SetCData() and query it with CData().
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800908*/
PKEuS16ed47d2013-07-06 12:02:43 +0200909class TINYXML2_LIB XMLText : public XMLNode
Lee Thomason5492a1c2012-01-23 15:32:10 -0800910{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700911 friend class XMLBase;
912 friend class XMLDocument;
Lee Thomason5492a1c2012-01-23 15:32:10 -0800913public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700914 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason50adb4c2012-02-13 15:07:09 -0800915
Lee Thomason624d43f2012-10-12 10:58:48 -0700916 virtual XMLText* ToText() {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700917 return this;
918 }
Lee Thomason624d43f2012-10-12 10:58:48 -0700919 virtual const XMLText* ToText() const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700920 return this;
921 }
Lee Thomason5492a1c2012-01-23 15:32:10 -0800922
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700923 /// Declare whether this should be CDATA or standard text.
Lee Thomason624d43f2012-10-12 10:58:48 -0700924 void SetCData( bool isCData ) {
925 _isCData = isCData;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700926 }
927 /// Returns true if this is a CDATA text element.
928 bool CData() const {
Lee Thomason624d43f2012-10-12 10:58:48 -0700929 return _isCData;
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700930 }
Lee Thomason50f97b22012-02-11 16:33:40 -0800931
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700932 char* ParseDeep( char*, StrPair* endTag );
933 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
934 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason7d00b9a2012-02-27 17:54:22 -0800935
Lee Thomason5492a1c2012-01-23 15:32:10 -0800936protected:
Lee Thomason624d43f2012-10-12 10:58:48 -0700937 XMLText( XMLDocument* doc ) : XMLNode( doc ), _isCData( false ) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700938 virtual ~XMLText() {}
939 XMLText( const XMLText& ); // not supported
940 XMLText& operator=( const XMLText& ); // not supported
Lee Thomason5492a1c2012-01-23 15:32:10 -0800941
942private:
Lee Thomason624d43f2012-10-12 10:58:48 -0700943 bool _isCData;
Lee Thomason5492a1c2012-01-23 15:32:10 -0800944};
945
946
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -0800947/** An XML Comment. */
PKEuS16ed47d2013-07-06 12:02:43 +0200948class TINYXML2_LIB XMLComment : public XMLNode
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800949{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700950 friend class XMLDocument;
Lee Thomason3f57d272012-01-11 15:30:03 -0800951public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700952 virtual XMLComment* ToComment() {
953 return this;
954 }
955 virtual const XMLComment* ToComment() const {
956 return this;
957 }
Lee Thomasonce0763e2012-01-11 15:43:54 -0800958
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700959 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800960
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700961 char* ParseDeep( char*, StrPair* endTag );
962 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
963 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomasonce0763e2012-01-11 15:43:54 -0800964
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800965protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700966 XMLComment( XMLDocument* doc );
967 virtual ~XMLComment();
968 XMLComment( const XMLComment& ); // not supported
969 XMLComment& operator=( const XMLComment& ); // not supported
Lee Thomason8a5dfee2012-01-18 17:43:40 -0800970
Lee Thomason3f57d272012-01-11 15:30:03 -0800971private:
U-Lama\Lee4cee6112011-12-31 14:58:18 -0800972};
U-Lama\Leee13c3e62011-12-28 14:36:55 -0800973
974
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800975/** In correct XML the declaration is the first entry in the file.
976 @verbatim
977 <?xml version="1.0" standalone="yes"?>
978 @endverbatim
979
Vasily Biryukov9a975b72013-05-11 21:41:42 +0600980 TinyXML-2 will happily read or write files without a declaration,
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -0800981 however.
982
983 The text of the declaration isn't interpreted. It is parsed
984 and written as a string.
985*/
PKEuS16ed47d2013-07-06 12:02:43 +0200986class TINYXML2_LIB XMLDeclaration : public XMLNode
Lee Thomason50f97b22012-02-11 16:33:40 -0800987{
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700988 friend class XMLDocument;
Lee Thomason50f97b22012-02-11 16:33:40 -0800989public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700990 virtual XMLDeclaration* ToDeclaration() {
991 return this;
992 }
993 virtual const XMLDeclaration* ToDeclaration() const {
994 return this;
995 }
Lee Thomason50f97b22012-02-11 16:33:40 -0800996
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700997 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -0800998
Lee Thomasona9cf3f92012-10-11 16:56:51 -0700999 char* ParseDeep( char*, StrPair* endTag );
1000 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
1001 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -08001002
1003protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001004 XMLDeclaration( XMLDocument* doc );
1005 virtual ~XMLDeclaration();
1006 XMLDeclaration( const XMLDeclaration& ); // not supported
1007 XMLDeclaration& operator=( const XMLDeclaration& ); // not supported
Lee Thomason50f97b22012-02-11 16:33:40 -08001008};
1009
1010
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001011/** Any tag that TinyXML-2 doesn't recognize is saved as an
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001012 unknown. It is a tag of text, but should not be modified.
1013 It will be written back to the XML, unchanged, when the file
1014 is saved.
1015
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001016 DTD tags get thrown into XMLUnknowns.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001017*/
PKEuS16ed47d2013-07-06 12:02:43 +02001018class TINYXML2_LIB XMLUnknown : public XMLNode
Lee Thomason50f97b22012-02-11 16:33:40 -08001019{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001020 friend class XMLDocument;
Lee Thomason50f97b22012-02-11 16:33:40 -08001021public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001022 virtual XMLUnknown* ToUnknown() {
1023 return this;
1024 }
1025 virtual const XMLUnknown* ToUnknown() const {
1026 return this;
1027 }
Lee Thomason50f97b22012-02-11 16:33:40 -08001028
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001029 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -08001030
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001031 char* ParseDeep( char*, StrPair* endTag );
1032 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
1033 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason50f97b22012-02-11 16:33:40 -08001034
1035protected:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001036 XMLUnknown( XMLDocument* doc );
1037 virtual ~XMLUnknown();
1038 XMLUnknown( const XMLUnknown& ); // not supported
1039 XMLUnknown& operator=( const XMLUnknown& ); // not supported
Lee Thomason50f97b22012-02-11 16:33:40 -08001040};
1041
1042
Lee Thomason1ff38e02012-02-14 18:18:16 -08001043
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001044/** An attribute is a name-value pair. Elements have an arbitrary
1045 number of attributes, each with a unique name.
1046
1047 @note The attributes are not XMLNodes. You may only query the
1048 Next() attribute in a list.
1049*/
PKEuS16ed47d2013-07-06 12:02:43 +02001050class TINYXML2_LIB XMLAttribute
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001051{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001052 friend class XMLElement;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001053public:
Lee Thomason2fa81722012-11-09 12:37:46 -08001054 /// The name of the attribute.
Michael Daumling21626882013-10-22 17:03:37 +02001055 const char* Name() const;
1056
Lee Thomason2fa81722012-11-09 12:37:46 -08001057 /// The value of the attribute.
Michael Daumling21626882013-10-22 17:03:37 +02001058 const char* Value() const;
1059
Lee Thomason2fa81722012-11-09 12:37:46 -08001060 /// The next attribute in the list.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001061 const XMLAttribute* Next() const {
MortenMacFly4ee49f12013-01-14 20:03:14 +01001062 return _next;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001063 }
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001064
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001065 /** IntValue interprets the attribute as an integer, and returns the value.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001066 If the value isn't an integer, 0 will be returned. There is no error checking;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001067 use QueryIntValue() if you need error checking.
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001068 */
1069 int IntValue() const {
1070 int i=0;
1071 QueryIntValue( &i );
1072 return i;
1073 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001074 /// Query as an unsigned integer. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001075 unsigned UnsignedValue() const {
1076 unsigned i=0;
1077 QueryUnsignedValue( &i );
1078 return i;
1079 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001080 /// Query as a boolean. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001081 bool BoolValue() const {
1082 bool b=false;
1083 QueryBoolValue( &b );
1084 return b;
1085 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001086 /// Query as a double. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001087 double DoubleValue() const {
1088 double d=0;
1089 QueryDoubleValue( &d );
1090 return d;
1091 }
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001092 /// Query as a float. See IntValue()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001093 float FloatValue() const {
1094 float f=0;
1095 QueryFloatValue( &f );
1096 return f;
1097 }
U-Stream\Leeae25a442012-02-17 17:48:16 -08001098
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001099 /** QueryIntValue interprets the attribute as an integer, and returns the value
Andrew C. Martin0fd87462013-03-09 20:09:45 -07001100 in the provided parameter. The function will return XML_NO_ERROR on success,
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001101 and XML_WRONG_ATTRIBUTE_TYPE if the conversion is not successful.
1102 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001103 XMLError QueryIntValue( int* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001104 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001105 XMLError QueryUnsignedValue( unsigned int* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001106 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001107 XMLError QueryBoolValue( bool* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001108 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001109 XMLError QueryDoubleValue( double* value ) const;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001110 /// See QueryIntValue
Lee Thomason2fa81722012-11-09 12:37:46 -08001111 XMLError QueryFloatValue( float* value ) const;
Lee Thomason50adb4c2012-02-13 15:07:09 -08001112
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001113 /// Set the attribute to a string value.
1114 void SetAttribute( const char* value );
1115 /// Set the attribute to value.
1116 void SetAttribute( int value );
1117 /// Set the attribute to value.
1118 void SetAttribute( unsigned value );
1119 /// Set the attribute to value.
1120 void SetAttribute( bool value );
1121 /// Set the attribute to value.
1122 void SetAttribute( double value );
1123 /// Set the attribute to value.
1124 void SetAttribute( float value );
Lee Thomason50adb4c2012-02-13 15:07:09 -08001125
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001126private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001127 enum { BUF_SIZE = 200 };
U-Stream\Lee09a11c52012-02-17 08:31:16 -08001128
Thomas Roß61892312013-05-12 14:07:38 +02001129 XMLAttribute() : _next( 0 ), _memPool( 0 ) {}
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001130 virtual ~XMLAttribute() {}
Lee Thomason624d43f2012-10-12 10:58:48 -07001131
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001132 XMLAttribute( const XMLAttribute& ); // not supported
1133 void operator=( const XMLAttribute& ); // not supported
1134 void SetName( const char* name );
Lee Thomason50adb4c2012-02-13 15:07:09 -08001135
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001136 char* ParseDeep( char* p, bool processEntities );
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001137
Lee Thomason624d43f2012-10-12 10:58:48 -07001138 mutable StrPair _name;
1139 mutable StrPair _value;
1140 XMLAttribute* _next;
1141 MemPool* _memPool;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001142};
1143
1144
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001145/** The element is a container class. It has a value, the element name,
1146 and can contain other elements, text, comments, and unknowns.
1147 Elements also contain an arbitrary number of attributes.
1148*/
PKEuS16ed47d2013-07-06 12:02:43 +02001149class TINYXML2_LIB XMLElement : public XMLNode
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001150{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001151 friend class XMLBase;
1152 friend class XMLDocument;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001153public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001154 /// Get the name of an element (which is the Value() of the node.)
1155 const char* Name() const {
1156 return Value();
1157 }
1158 /// Set the name of the element.
1159 void SetName( const char* str, bool staticMem=false ) {
1160 SetValue( str, staticMem );
1161 }
Lee Thomason2c85a712012-01-31 08:24:24 -08001162
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001163 virtual XMLElement* ToElement() {
1164 return this;
1165 }
1166 virtual const XMLElement* ToElement() const {
1167 return this;
1168 }
1169 virtual bool Accept( XMLVisitor* visitor ) const;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001170
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001171 /** Given an attribute name, Attribute() returns the value
1172 for the attribute of that name, or null if none
1173 exists. For example:
Lee Thomason92258152012-03-24 13:05:39 -07001174
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001175 @verbatim
1176 const char* value = ele->Attribute( "foo" );
1177 @endverbatim
Lee Thomason92258152012-03-24 13:05:39 -07001178
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001179 The 'value' parameter is normally null. However, if specified,
1180 the attribute will only be returned if the 'name' and 'value'
1181 match. This allow you to write code:
Lee Thomason8ba7f7d2012-03-24 13:04:04 -07001182
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001183 @verbatim
1184 if ( ele->Attribute( "foo", "bar" ) ) callFooIsBar();
1185 @endverbatim
Lee Thomason8ba7f7d2012-03-24 13:04:04 -07001186
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001187 rather than:
1188 @verbatim
1189 if ( ele->Attribute( "foo" ) ) {
1190 if ( strcmp( ele->Attribute( "foo" ), "bar" ) == 0 ) callFooIsBar();
1191 }
1192 @endverbatim
1193 */
1194 const char* Attribute( const char* name, const char* value=0 ) const;
Lee Thomason751da522012-02-10 08:50:51 -08001195
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001196 /** Given an attribute name, IntAttribute() returns the value
1197 of the attribute interpreted as an integer. 0 will be
1198 returned if there is an error. For a method with error
1199 checking, see QueryIntAttribute()
1200 */
1201 int IntAttribute( const char* name ) const {
1202 int i=0;
1203 QueryIntAttribute( name, &i );
1204 return i;
1205 }
1206 /// See IntAttribute()
1207 unsigned UnsignedAttribute( const char* name ) const {
1208 unsigned i=0;
1209 QueryUnsignedAttribute( name, &i );
1210 return i;
1211 }
1212 /// See IntAttribute()
1213 bool BoolAttribute( const char* name ) const {
1214 bool b=false;
1215 QueryBoolAttribute( name, &b );
1216 return b;
1217 }
1218 /// See IntAttribute()
1219 double DoubleAttribute( const char* name ) const {
1220 double d=0;
1221 QueryDoubleAttribute( name, &d );
1222 return d;
1223 }
1224 /// See IntAttribute()
1225 float FloatAttribute( const char* name ) const {
1226 float f=0;
1227 QueryFloatAttribute( name, &f );
1228 return f;
1229 }
U-Stream\Lee09a11c52012-02-17 08:31:16 -08001230
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001231 /** Given an attribute name, QueryIntAttribute() returns
1232 XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion
1233 can't be performed, or XML_NO_ATTRIBUTE if the attribute
1234 doesn't exist. If successful, the result of the conversion
1235 will be written to 'value'. If not successful, nothing will
1236 be written to 'value'. This allows you to provide default
1237 value:
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001238
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001239 @verbatim
1240 int value = 10;
1241 QueryIntAttribute( "foo", &value ); // if "foo" isn't found, value will still be 10
1242 @endverbatim
1243 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001244 XMLError QueryIntAttribute( const char* name, int* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001245 const XMLAttribute* a = FindAttribute( name );
1246 if ( !a ) {
1247 return XML_NO_ATTRIBUTE;
1248 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001249 return a->QueryIntValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001250 }
1251 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001252 XMLError QueryUnsignedAttribute( const char* name, unsigned int* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001253 const XMLAttribute* a = FindAttribute( name );
1254 if ( !a ) {
1255 return XML_NO_ATTRIBUTE;
1256 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001257 return a->QueryUnsignedValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001258 }
1259 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001260 XMLError QueryBoolAttribute( const char* name, bool* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001261 const XMLAttribute* a = FindAttribute( name );
1262 if ( !a ) {
1263 return XML_NO_ATTRIBUTE;
1264 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001265 return a->QueryBoolValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001266 }
1267 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001268 XMLError QueryDoubleAttribute( const char* name, double* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001269 const XMLAttribute* a = FindAttribute( name );
1270 if ( !a ) {
1271 return XML_NO_ATTRIBUTE;
1272 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001273 return a->QueryDoubleValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001274 }
1275 /// See QueryIntAttribute()
Lee Thomason2fa81722012-11-09 12:37:46 -08001276 XMLError QueryFloatAttribute( const char* name, float* value ) const {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001277 const XMLAttribute* a = FindAttribute( name );
1278 if ( !a ) {
1279 return XML_NO_ATTRIBUTE;
1280 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001281 return a->QueryFloatValue( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001282 }
Lee Thomason50f97b22012-02-11 16:33:40 -08001283
Lee Thomason (grinliz)5efaa5f2013-02-01 19:26:30 -08001284
1285 /** Given an attribute name, QueryAttribute() returns
1286 XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion
1287 can't be performed, or XML_NO_ATTRIBUTE if the attribute
1288 doesn't exist. It is overloaded for the primitive types,
1289 and is a generally more convenient replacement of
1290 QueryIntAttribute() and related functions.
1291
1292 If successful, the result of the conversion
1293 will be written to 'value'. If not successful, nothing will
1294 be written to 'value'. This allows you to provide default
1295 value:
1296
1297 @verbatim
1298 int value = 10;
1299 QueryAttribute( "foo", &value ); // if "foo" isn't found, value will still be 10
1300 @endverbatim
1301 */
1302 int QueryAttribute( const char* name, int* value ) const {
1303 return QueryIntAttribute( name, value );
1304 }
1305
1306 int QueryAttribute( const char* name, unsigned int* value ) const {
1307 return QueryUnsignedAttribute( name, value );
1308 }
1309
1310 int QueryAttribute( const char* name, bool* value ) const {
1311 return QueryBoolAttribute( name, value );
1312 }
1313
1314 int QueryAttribute( const char* name, double* value ) const {
1315 return QueryDoubleAttribute( name, value );
1316 }
1317
1318 int QueryAttribute( const char* name, float* value ) const {
1319 return QueryFloatAttribute( name, value );
1320 }
1321
1322 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001323 void SetAttribute( const char* name, const char* value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001324 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001325 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001326 }
1327 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001328 void SetAttribute( const char* name, int value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001329 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001330 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001331 }
1332 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001333 void SetAttribute( const char* name, unsigned value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001334 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001335 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001336 }
1337 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001338 void SetAttribute( const char* name, bool value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001339 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001340 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001341 }
1342 /// Sets the named attribute to value.
Lee Thomason624d43f2012-10-12 10:58:48 -07001343 void SetAttribute( const char* name, double value ) {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001344 XMLAttribute* a = FindOrCreateAttribute( name );
Lee Thomason624d43f2012-10-12 10:58:48 -07001345 a->SetAttribute( value );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001346 }
Lee Thomasonc3708cc2014-01-14 12:30:03 -08001347 /// Sets the named attribute to value.
1348 void SetAttribute( const char* name, float value ) {
1349 XMLAttribute* a = FindOrCreateAttribute( name );
1350 a->SetAttribute( value );
1351 }
Lee Thomason50f97b22012-02-11 16:33:40 -08001352
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001353 /**
1354 Delete an attribute.
1355 */
1356 void DeleteAttribute( const char* name );
Lee Thomason751da522012-02-10 08:50:51 -08001357
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001358 /// Return the first attribute in the list.
1359 const XMLAttribute* FirstAttribute() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001360 return _rootAttribute;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001361 }
1362 /// Query a specific attribute in the list.
1363 const XMLAttribute* FindAttribute( const char* name ) const;
Lee Thomason751da522012-02-10 08:50:51 -08001364
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001365 /** Convenience function for easy access to the text inside an element. Although easy
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001366 and concise, GetText() is limited compared to getting the XMLText child
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001367 and accessing it directly.
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001368
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001369 If the first child of 'this' is a XMLText, the GetText()
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001370 returns the character string of the Text node, else null is returned.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001371
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001372 This is a convenient method for getting the text of simple contained text:
1373 @verbatim
1374 <foo>This is text</foo>
1375 const char* str = fooElement->GetText();
1376 @endverbatim
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001377
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001378 'str' will be a pointer to "This is text".
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001379
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001380 Note that this function can be misleading. If the element foo was created from
1381 this XML:
1382 @verbatim
1383 <foo><b>This is text</b></foo>
1384 @endverbatim
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001385
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001386 then the value of str would be null. The first child node isn't a text node, it is
1387 another element. From this XML:
1388 @verbatim
1389 <foo>This is <b>text</b></foo>
1390 @endverbatim
1391 GetText() will return "This is ".
1392 */
1393 const char* GetText() const;
Lee Thomason751da522012-02-10 08:50:51 -08001394
Uli Kusterer85fff5e2014-01-21 01:35:30 +01001395 /** Convenience function for easy access to the text inside an element. Although easy
1396 and concise, SetText() is limited compared to creating an XMLText child
1397 and mutating it directly.
1398
1399 If the first child of 'this' is a XMLText, SetText() sets its value to
1400 the given string, otherwise it will create a first child that is an XMLText.
1401
1402 This is a convenient method for setting the text of simple contained text:
1403 @verbatim
1404 <foo>This is text</foo>
1405 fooElement->SetText( "Hullaballoo!" );
1406 <foo>Hullaballoo!</foo>
1407 @endverbatim
1408
1409 Note that this function can be misleading. If the element foo was created from
1410 this XML:
1411 @verbatim
1412 <foo><b>This is text</b></foo>
1413 @endverbatim
1414
1415 then it will not change "This is text", but rather prefix it with a text element:
1416 @verbatim
1417 <foo>Hullaballoo!<b>This is text</b></foo>
1418 @endverbatim
1419
1420 For this XML:
1421 @verbatim
1422 <foo />
1423 @endverbatim
1424 SetText() will generate
1425 @verbatim
1426 <foo>Hullaballoo!</foo>
1427 @endverbatim
1428 */
Lee Thomason5bb2d802014-01-24 10:42:57 -08001429 void SetText( const char* inText );
Lee Thomasonc18eb232014-02-21 17:31:17 -08001430 /// Convenience method for setting text inside and element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001431 void SetText( int value );
Lee Thomasonc18eb232014-02-21 17:31:17 -08001432 /// Convenience method for setting text inside and element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001433 void SetText( unsigned value );
Lee Thomasonc18eb232014-02-21 17:31:17 -08001434 /// Convenience method for setting text inside and element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001435 void SetText( bool value );
Lee Thomasonc18eb232014-02-21 17:31:17 -08001436 /// Convenience method for setting text inside and element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001437 void SetText( double value );
Lee Thomasonc18eb232014-02-21 17:31:17 -08001438 /// Convenience method for setting text inside and element. See SetText() for important limitations.
Lee Thomason5bb2d802014-01-24 10:42:57 -08001439 void SetText( float value );
Uli Kusterer8fe342a2014-01-21 01:12:47 +01001440
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001441 /**
1442 Convenience method to query the value of a child text node. This is probably best
1443 shown by example. Given you have a document is this form:
1444 @verbatim
1445 <point>
1446 <x>1</x>
1447 <y>1.4</y>
1448 </point>
1449 @endverbatim
Lee Thomason21be8822012-07-15 17:27:22 -07001450
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001451 The QueryIntText() and similar functions provide a safe and easier way to get to the
1452 "value" of x and y.
Lee Thomason21be8822012-07-15 17:27:22 -07001453
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001454 @verbatim
1455 int x = 0;
1456 float y = 0; // types of x and y are contrived for example
1457 const XMLElement* xElement = pointElement->FirstChildElement( "x" );
1458 const XMLElement* yElement = pointElement->FirstChildElement( "y" );
1459 xElement->QueryIntText( &x );
1460 yElement->QueryFloatText( &y );
1461 @endverbatim
Lee Thomason21be8822012-07-15 17:27:22 -07001462
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001463 @returns XML_SUCCESS (0) on success, XML_CAN_NOT_CONVERT_TEXT if the text cannot be converted
1464 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 -07001465
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001466 */
MortenMacFly4ee49f12013-01-14 20:03:14 +01001467 XMLError QueryIntText( int* ival ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001468 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001469 XMLError QueryUnsignedText( unsigned* uval ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001470 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001471 XMLError QueryBoolText( bool* bval ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001472 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001473 XMLError QueryDoubleText( double* dval ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001474 /// See QueryIntText()
MortenMacFly4ee49f12013-01-14 20:03:14 +01001475 XMLError QueryFloatText( float* fval ) const;
Lee Thomason21be8822012-07-15 17:27:22 -07001476
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001477 // internal:
1478 enum {
1479 OPEN, // <foo>
1480 CLOSED, // <foo/>
1481 CLOSING // </foo>
1482 };
1483 int ClosingType() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001484 return _closingType;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001485 }
1486 char* ParseDeep( char* p, StrPair* endTag );
1487 virtual XMLNode* ShallowClone( XMLDocument* document ) const;
1488 virtual bool ShallowEqual( const XMLNode* compare ) const;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001489
Lee Thomason50adb4c2012-02-13 15:07:09 -08001490private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001491 XMLElement( XMLDocument* doc );
1492 virtual ~XMLElement();
1493 XMLElement( const XMLElement& ); // not supported
1494 void operator=( const XMLElement& ); // not supported
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001495
Dmitry-Me1227d512014-12-05 13:41:45 +03001496 XMLAttribute* FindAttribute( const char* name ) {
1497 return const_cast<XMLAttribute*>(const_cast<const XMLElement*>(this)->FindAttribute( name ));
1498 }
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001499 XMLAttribute* FindOrCreateAttribute( const char* name );
1500 //void LinkAttribute( XMLAttribute* attrib );
1501 char* ParseAttributes( char* p );
Dmitry-Mee3225b12014-09-03 11:03:11 +04001502 static void DeleteAttribute( XMLAttribute* attribute );
Lee Thomason67d61312012-01-24 16:01:51 -08001503
Lee Thomason5bb2d802014-01-24 10:42:57 -08001504 enum { BUF_SIZE = 200 };
Lee Thomason624d43f2012-10-12 10:58:48 -07001505 int _closingType;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001506 // The attribute list is ordered; there is no 'lastAttribute'
1507 // because the list needs to be scanned for dupes before adding
1508 // a new attribute.
Lee Thomason624d43f2012-10-12 10:58:48 -07001509 XMLAttribute* _rootAttribute;
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001510};
1511
1512
Lee Thomason (grinliz)bc1bfb72012-08-20 22:00:38 -07001513enum Whitespace {
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001514 PRESERVE_WHITESPACE,
1515 COLLAPSE_WHITESPACE
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001516};
Lee Thomason (grinliz)bc1bfb72012-08-20 22:00:38 -07001517
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001518
1519/** A Document binds together all the functionality.
Lee Thomason (grinliz)9c38d132012-02-24 21:50:50 -08001520 It can be saved, loaded, and printed to the screen.
1521 All Nodes are connected and allocated to a Document.
1522 If the Document is deleted, all its Nodes are also deleted.
1523*/
PKEuS16ed47d2013-07-06 12:02:43 +02001524class TINYXML2_LIB XMLDocument : public XMLNode
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001525{
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001526 friend class XMLElement;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001527public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001528 /// constructor
1529 XMLDocument( bool processEntities = true, Whitespace = PRESERVE_WHITESPACE );
1530 ~XMLDocument();
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001531
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001532 virtual XMLDocument* ToDocument() {
1533 return this;
1534 }
1535 virtual const XMLDocument* ToDocument() const {
1536 return this;
1537 }
Lee Thomason56bdd022012-02-09 18:16:58 -08001538
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001539 /**
1540 Parse an XML file from a character string.
1541 Returns XML_NO_ERROR (0) on success, or
1542 an errorID.
Lee Thomason (grinliz)e2bcb322012-09-17 17:58:25 -07001543
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001544 You may optionally pass in the 'nBytes', which is
1545 the number of bytes which will be parsed. If not
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001546 specified, TinyXML-2 will assume 'xml' points to a
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001547 null terminated string.
1548 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001549 XMLError Parse( const char* xml, size_t nBytes=(size_t)(-1) );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001550
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001551 /**
1552 Load an XML file from disk.
1553 Returns XML_NO_ERROR (0) on success, or
1554 an errorID.
1555 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001556 XMLError LoadFile( const char* filename );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001557
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001558 /**
1559 Load an XML file from disk. You are responsible
Lee Thomasoncd011bc2014-12-17 10:41:34 -08001560 for providing and closing the FILE*.
1561
1562 NOTE: The file should be opened as binary ("rb")
1563 not text in order for TinyXML-2 to correctly
1564 do newline normalization.
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001565
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001566 Returns XML_NO_ERROR (0) on success, or
1567 an errorID.
1568 */
Jerome Martinez242c3ea2013-01-06 12:20:04 +01001569 XMLError LoadFile( FILE* );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001570
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001571 /**
1572 Save the XML file to disk.
1573 Returns XML_NO_ERROR (0) on success, or
1574 an errorID.
1575 */
Lee Thomason2fa81722012-11-09 12:37:46 -08001576 XMLError SaveFile( const char* filename, bool compact = false );
Lee Thomasond11cd162012-04-12 08:35:36 -07001577
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001578 /**
1579 Save the XML file to disk. You are responsible
1580 for providing and closing the FILE*.
Ken Miller81da1fb2012-04-09 23:32:26 -05001581
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001582 Returns XML_NO_ERROR (0) on success, or
1583 an errorID.
1584 */
Jerome Martinez242c3ea2013-01-06 12:20:04 +01001585 XMLError SaveFile( FILE* fp, bool compact = false );
Lee Thomason (grinliz)68db57e2012-02-21 09:08:12 -08001586
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001587 bool ProcessEntities() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001588 return _processEntities;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001589 }
1590 Whitespace WhitespaceMode() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001591 return _whitespace;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001592 }
Lee Thomason6f381b72012-03-02 12:59:39 -08001593
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001594 /**
1595 Returns true if this document has a leading Byte Order Mark of UTF8.
1596 */
1597 bool HasBOM() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001598 return _writeBOM;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001599 }
1600 /** Sets whether to write the BOM when writing the file.
1601 */
1602 void SetBOM( bool useBOM ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001603 _writeBOM = useBOM;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001604 }
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001605
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001606 /** Return the root element of DOM. Equivalent to FirstChildElement().
1607 To get the first node, use FirstChild().
1608 */
1609 XMLElement* RootElement() {
1610 return FirstChildElement();
1611 }
1612 const XMLElement* RootElement() const {
1613 return FirstChildElement();
1614 }
Lee Thomason18d68bd2012-01-26 18:17:26 -08001615
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001616 /** Print the Document. If the Printer is not provided, it will
1617 print to stdout. If you provide Printer, this can print to a file:
1618 @verbatim
1619 XMLPrinter printer( fp );
1620 doc.Print( &printer );
1621 @endverbatim
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001622
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001623 Or you can use a printer to print to memory:
1624 @verbatim
1625 XMLPrinter printer;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001626 doc.Print( &printer );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001627 // printer.CStr() has a const char* to the XML
1628 @endverbatim
1629 */
PKEuS1c5f99e2013-07-06 11:28:39 +02001630 void Print( XMLPrinter* streamer=0 ) const;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001631 virtual bool Accept( XMLVisitor* visitor ) const;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001632
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001633 /**
1634 Create a new Element associated with
1635 this Document. The memory for the Element
1636 is managed by the Document.
1637 */
1638 XMLElement* NewElement( const char* name );
1639 /**
1640 Create a new Comment associated with
1641 this Document. The memory for the Comment
1642 is managed by the Document.
1643 */
1644 XMLComment* NewComment( const char* comment );
1645 /**
1646 Create a new Text associated with
1647 this Document. The memory for the Text
1648 is managed by the Document.
1649 */
1650 XMLText* NewText( const char* text );
1651 /**
1652 Create a new Declaration associated with
1653 this Document. The memory for the object
1654 is managed by the Document.
Lee Thomasonf68c4382012-04-28 14:37:11 -07001655
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001656 If the 'text' param is null, the standard
1657 declaration is used.:
1658 @verbatim
1659 <?xml version="1.0" encoding="UTF-8"?>
1660 @endverbatim
1661 */
1662 XMLDeclaration* NewDeclaration( const char* text=0 );
1663 /**
1664 Create a new Unknown associated with
Andrew C. Martin0fd87462013-03-09 20:09:45 -07001665 this Document. The memory for the object
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001666 is managed by the Document.
1667 */
1668 XMLUnknown* NewUnknown( const char* text );
Lee Thomason2c85a712012-01-31 08:24:24 -08001669
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001670 /**
1671 Delete a node associated with this document.
1672 It will be unlinked from the DOM.
1673 */
Lee Thomasoncd011bc2014-12-17 10:41:34 -08001674 void DeleteNode( XMLNode* node );
U-Stream\Leeae25a442012-02-17 17:48:16 -08001675
Lee Thomason2fa81722012-11-09 12:37:46 -08001676 void SetError( XMLError error, const char* str1, const char* str2 );
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001677
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001678 /// Return true if there was an error parsing the document.
1679 bool Error() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001680 return _errorID != XML_NO_ERROR;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001681 }
1682 /// Return the errorID.
Lee Thomason2fa81722012-11-09 12:37:46 -08001683 XMLError ErrorID() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001684 return _errorID;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001685 }
Lee Thomason331596e2014-09-11 14:56:43 -07001686 const char* ErrorName() const;
1687
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001688 /// Return a possibly helpful diagnostic location or string.
1689 const char* GetErrorStr1() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001690 return _errorStr1;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001691 }
1692 /// Return a possibly helpful secondary diagnostic location or string.
1693 const char* GetErrorStr2() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001694 return _errorStr2;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001695 }
1696 /// If there is an error, print it to stdout.
1697 void PrintError() const;
Martinsh Shaitersa9d42b02013-01-30 11:14:27 +02001698
1699 /// Clear the document, resetting it to the initial state.
1700 void Clear();
Lee Thomason8a5dfee2012-01-18 17:43:40 -08001701
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001702 // internal
1703 char* Identify( char* p, XMLNode** node );
Lee Thomason2c85a712012-01-31 08:24:24 -08001704
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001705 virtual XMLNode* ShallowClone( XMLDocument* /*document*/ ) const {
1706 return 0;
1707 }
1708 virtual bool ShallowEqual( const XMLNode* /*compare*/ ) const {
1709 return false;
1710 }
Lee Thomason7d00b9a2012-02-27 17:54:22 -08001711
Lee Thomason3f57d272012-01-11 15:30:03 -08001712private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001713 XMLDocument( const XMLDocument& ); // not supported
1714 void operator=( const XMLDocument& ); // not supported
Lee Thomason18d68bd2012-01-26 18:17:26 -08001715
Lee Thomason2fa81722012-11-09 12:37:46 -08001716 bool _writeBOM;
1717 bool _processEntities;
1718 XMLError _errorID;
1719 Whitespace _whitespace;
Lee Thomason624d43f2012-10-12 10:58:48 -07001720 const char* _errorStr1;
1721 const char* _errorStr2;
Lee Thomason2fa81722012-11-09 12:37:46 -08001722 char* _charBuffer;
Lee Thomasond1983222012-02-06 08:41:24 -08001723
Lee Thomason624d43f2012-10-12 10:58:48 -07001724 MemPoolT< sizeof(XMLElement) > _elementPool;
1725 MemPoolT< sizeof(XMLAttribute) > _attributePool;
1726 MemPoolT< sizeof(XMLText) > _textPool;
1727 MemPoolT< sizeof(XMLComment) > _commentPool;
Lee Thomason331596e2014-09-11 14:56:43 -07001728
1729 static const char* _errorNames[XML_ERROR_COUNT];
Lee Thomason5cae8972012-01-24 18:03:07 -08001730};
1731
Lee Thomason7c913cd2012-01-26 18:32:34 -08001732
Lee Thomason3ffdd392012-03-28 17:27:55 -07001733/**
1734 A XMLHandle is a class that wraps a node pointer with null checks; this is
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001735 an incredibly useful thing. Note that XMLHandle is not part of the TinyXML-2
Lee Thomason3ffdd392012-03-28 17:27:55 -07001736 DOM structure. It is a separate utility class.
1737
1738 Take an example:
1739 @verbatim
1740 <Document>
1741 <Element attributeA = "valueA">
1742 <Child attributeB = "value1" />
1743 <Child attributeB = "value2" />
1744 </Element>
Thomas Roß08bdf502012-05-12 14:21:23 +02001745 </Document>
Lee Thomason3ffdd392012-03-28 17:27:55 -07001746 @endverbatim
1747
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001748 Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very
Lee Thomason3ffdd392012-03-28 17:27:55 -07001749 easy to write a *lot* of code that looks like:
1750
1751 @verbatim
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001752 XMLElement* root = document.FirstChildElement( "Document" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001753 if ( root )
1754 {
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001755 XMLElement* element = root->FirstChildElement( "Element" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001756 if ( element )
1757 {
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001758 XMLElement* child = element->FirstChildElement( "Child" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001759 if ( child )
1760 {
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001761 XMLElement* child2 = child->NextSiblingElement( "Child" );
Lee Thomason3ffdd392012-03-28 17:27:55 -07001762 if ( child2 )
1763 {
1764 // Finally do something useful.
1765 @endverbatim
1766
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001767 And that doesn't even cover "else" cases. XMLHandle addresses the verbosity
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001768 of such code. A XMLHandle checks for null pointers so it is perfectly safe
Lee Thomason3ffdd392012-03-28 17:27:55 -07001769 and correct to use:
1770
1771 @verbatim
Lee Thomasondb0bbb62012-04-04 15:47:04 -07001772 XMLHandle docHandle( &document );
Dmitry-Mea317bd62014-12-08 10:35:37 +03001773 XMLElement* child2 = docHandle.FirstChildElement( "Document" ).FirstChildElement( "Element" ).FirstChildElement().NextSiblingElement();
Lee Thomason3ffdd392012-03-28 17:27:55 -07001774 if ( child2 )
1775 {
1776 // do something useful
1777 @endverbatim
1778
1779 Which is MUCH more concise and useful.
1780
1781 It is also safe to copy handles - internally they are nothing more than node pointers.
1782 @verbatim
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001783 XMLHandle handleCopy = handle;
Lee Thomason3ffdd392012-03-28 17:27:55 -07001784 @endverbatim
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001785
1786 See also XMLConstHandle, which is the same as XMLHandle, but operates on const objects.
Lee Thomason3ffdd392012-03-28 17:27:55 -07001787*/
PKEuS16ed47d2013-07-06 12:02:43 +02001788class TINYXML2_LIB XMLHandle
Lee Thomason3ffdd392012-03-28 17:27:55 -07001789{
1790public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001791 /// Create a handle from any node (at any depth of the tree.) This can be a null pointer.
Lee Thomason624d43f2012-10-12 10:58:48 -07001792 XMLHandle( XMLNode* node ) {
1793 _node = node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001794 }
1795 /// Create a handle from a node.
Lee Thomason624d43f2012-10-12 10:58:48 -07001796 XMLHandle( XMLNode& node ) {
1797 _node = &node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001798 }
1799 /// Copy constructor
1800 XMLHandle( const XMLHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001801 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001802 }
1803 /// Assignment
1804 XMLHandle& operator=( const XMLHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001805 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001806 return *this;
1807 }
Lee Thomason3ffdd392012-03-28 17:27:55 -07001808
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001809 /// Get the first child of this handle.
1810 XMLHandle FirstChild() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001811 return XMLHandle( _node ? _node->FirstChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001812 }
1813 /// Get the first child element of this handle.
1814 XMLHandle FirstChildElement( const char* value=0 ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001815 return XMLHandle( _node ? _node->FirstChildElement( value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001816 }
1817 /// Get the last child of this handle.
1818 XMLHandle LastChild() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001819 return XMLHandle( _node ? _node->LastChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001820 }
1821 /// Get the last child element of this handle.
1822 XMLHandle LastChildElement( const char* _value=0 ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001823 return XMLHandle( _node ? _node->LastChildElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001824 }
1825 /// Get the previous sibling of this handle.
1826 XMLHandle PreviousSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001827 return XMLHandle( _node ? _node->PreviousSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001828 }
1829 /// Get the previous sibling element of this handle.
1830 XMLHandle PreviousSiblingElement( const char* _value=0 ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001831 return XMLHandle( _node ? _node->PreviousSiblingElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001832 }
1833 /// Get the next sibling of this handle.
1834 XMLHandle NextSibling() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001835 return XMLHandle( _node ? _node->NextSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001836 }
1837 /// Get the next sibling element of this handle.
1838 XMLHandle NextSiblingElement( const char* _value=0 ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001839 return XMLHandle( _node ? _node->NextSiblingElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001840 }
Lee Thomason3ffdd392012-03-28 17:27:55 -07001841
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001842 /// Safe cast to XMLNode. This can return null.
1843 XMLNode* ToNode() {
Lee Thomason624d43f2012-10-12 10:58:48 -07001844 return _node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001845 }
1846 /// Safe cast to XMLElement. This can return null.
1847 XMLElement* ToElement() {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001848 return ( ( _node == 0 ) ? 0 : _node->ToElement() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001849 }
1850 /// Safe cast to XMLText. This can return null.
1851 XMLText* ToText() {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001852 return ( ( _node == 0 ) ? 0 : _node->ToText() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001853 }
1854 /// Safe cast to XMLUnknown. This can return null.
1855 XMLUnknown* ToUnknown() {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001856 return ( ( _node == 0 ) ? 0 : _node->ToUnknown() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001857 }
1858 /// Safe cast to XMLDeclaration. This can return null.
1859 XMLDeclaration* ToDeclaration() {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001860 return ( ( _node == 0 ) ? 0 : _node->ToDeclaration() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001861 }
Lee Thomason3ffdd392012-03-28 17:27:55 -07001862
1863private:
Lee Thomason624d43f2012-10-12 10:58:48 -07001864 XMLNode* _node;
Lee Thomason3ffdd392012-03-28 17:27:55 -07001865};
1866
Lee Thomason (grinliz)2a1cd272012-02-24 17:37:53 -08001867
1868/**
Lee Thomason (grinliz)ae209f62012-04-04 22:00:07 -07001869 A variant of the XMLHandle class for working with const XMLNodes and Documents. It is the
1870 same in all regards, except for the 'const' qualifiers. See XMLHandle for API.
Lee Thomason8b899812012-04-04 15:58:16 -07001871*/
PKEuS16ed47d2013-07-06 12:02:43 +02001872class TINYXML2_LIB XMLConstHandle
Lee Thomason8b899812012-04-04 15:58:16 -07001873{
1874public:
Lee Thomason624d43f2012-10-12 10:58:48 -07001875 XMLConstHandle( const XMLNode* node ) {
1876 _node = node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001877 }
Lee Thomason624d43f2012-10-12 10:58:48 -07001878 XMLConstHandle( const XMLNode& node ) {
1879 _node = &node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001880 }
1881 XMLConstHandle( const XMLConstHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001882 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001883 }
Lee Thomason8b899812012-04-04 15:58:16 -07001884
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001885 XMLConstHandle& operator=( const XMLConstHandle& ref ) {
Lee Thomason624d43f2012-10-12 10:58:48 -07001886 _node = ref._node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001887 return *this;
1888 }
Lee Thomason8b899812012-04-04 15:58:16 -07001889
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001890 const XMLConstHandle FirstChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001891 return XMLConstHandle( _node ? _node->FirstChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001892 }
1893 const XMLConstHandle FirstChildElement( const char* value=0 ) const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001894 return XMLConstHandle( _node ? _node->FirstChildElement( value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001895 }
1896 const XMLConstHandle LastChild() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001897 return XMLConstHandle( _node ? _node->LastChild() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001898 }
1899 const XMLConstHandle LastChildElement( const char* _value=0 ) const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001900 return XMLConstHandle( _node ? _node->LastChildElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001901 }
1902 const XMLConstHandle PreviousSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001903 return XMLConstHandle( _node ? _node->PreviousSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001904 }
1905 const XMLConstHandle PreviousSiblingElement( const char* _value=0 ) const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001906 return XMLConstHandle( _node ? _node->PreviousSiblingElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001907 }
1908 const XMLConstHandle NextSibling() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001909 return XMLConstHandle( _node ? _node->NextSibling() : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001910 }
1911 const XMLConstHandle NextSiblingElement( const char* _value=0 ) const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001912 return XMLConstHandle( _node ? _node->NextSiblingElement( _value ) : 0 );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001913 }
Lee Thomason8b899812012-04-04 15:58:16 -07001914
1915
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001916 const XMLNode* ToNode() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07001917 return _node;
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001918 }
1919 const XMLElement* ToElement() const {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001920 return ( ( _node == 0 ) ? 0 : _node->ToElement() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001921 }
1922 const XMLText* ToText() const {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001923 return ( ( _node == 0 ) ? 0 : _node->ToText() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001924 }
1925 const XMLUnknown* ToUnknown() const {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001926 return ( ( _node == 0 ) ? 0 : _node->ToUnknown() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001927 }
1928 const XMLDeclaration* ToDeclaration() const {
Dmitry-Meb6b4e822014-08-27 17:17:47 +04001929 return ( ( _node == 0 ) ? 0 : _node->ToDeclaration() );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001930 }
Lee Thomason (grinliz)bd0a8ac2012-02-20 20:14:33 -08001931
Lee Thomason5cae8972012-01-24 18:03:07 -08001932private:
Lee Thomason624d43f2012-10-12 10:58:48 -07001933 const XMLNode* _node;
Lee Thomason56bdd022012-02-09 18:16:58 -08001934};
Lee Thomason6f381b72012-03-02 12:59:39 -08001935
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001936
1937/**
1938 Printing functionality. The XMLPrinter gives you more
1939 options than the XMLDocument::Print() method.
1940
1941 It can:
1942 -# Print to memory.
Thomas Roß08bdf502012-05-12 14:21:23 +02001943 -# Print to a file you provide.
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001944 -# Print XML without a XMLDocument.
1945
1946 Print to Memory
1947
1948 @verbatim
1949 XMLPrinter printer;
Vasily Biryukov9a975b72013-05-11 21:41:42 +06001950 doc.Print( &printer );
Thomas Roß08bdf502012-05-12 14:21:23 +02001951 SomeFunction( printer.CStr() );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001952 @endverbatim
1953
1954 Print to a File
Lee Thomason (grinliz)2f1f6242012-09-16 11:32:34 -07001955
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001956 You provide the file pointer.
1957 @verbatim
1958 XMLPrinter printer( fp );
1959 doc.Print( &printer );
1960 @endverbatim
1961
1962 Print without a XMLDocument
1963
1964 When loading, an XML parser is very useful. However, sometimes
1965 when saving, it just gets in the way. The code is often set up
1966 for streaming, and constructing the DOM is just overhead.
1967
1968 The Printer supports the streaming case. The following code
1969 prints out a trivially simple XML file without ever creating
1970 an XML document.
1971
1972 @verbatim
1973 XMLPrinter printer( fp );
1974 printer.OpenElement( "foo" );
1975 printer.PushAttribute( "foo", "bar" );
1976 printer.CloseElement();
1977 @endverbatim
1978*/
PKEuS16ed47d2013-07-06 12:02:43 +02001979class TINYXML2_LIB XMLPrinter : public XMLVisitor
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001980{
1981public:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001982 /** Construct the printer. If the FILE* is specified,
1983 this will print to the FILE. Else it will print
1984 to memory, and the result is available in CStr().
1985 If 'compact' is set to true, then output is created
1986 with only required whitespace and newlines.
1987 */
PKEuS1bfb9542013-08-04 13:51:17 +02001988 XMLPrinter( FILE* file=0, bool compact = false, int depth = 0 );
Dennis Jenkins59c75d32013-10-08 13:10:07 -05001989 virtual ~XMLPrinter() {}
U-Lama\Leee13c3e62011-12-28 14:36:55 -08001990
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001991 /** If streaming, write the BOM and declaration. */
1992 void PushHeader( bool writeBOM, bool writeDeclaration );
1993 /** If streaming, start writing an element.
1994 The element must be closed with CloseElement()
1995 */
Lee Thomason256adb62014-04-06 14:41:46 -07001996 void OpenElement( const char* name, bool compactMode=false );
Lee Thomasona9cf3f92012-10-11 16:56:51 -07001997 /// If streaming, add an attribute to an open element.
1998 void PushAttribute( const char* name, const char* value );
1999 void PushAttribute( const char* name, int value );
2000 void PushAttribute( const char* name, unsigned value );
2001 void PushAttribute( const char* name, bool value );
2002 void PushAttribute( const char* name, double value );
2003 /// If streaming, close the Element.
Lee Thomason256adb62014-04-06 14:41:46 -07002004 virtual void CloseElement( bool compactMode=false );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002005
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002006 /// Add a text node.
2007 void PushText( const char* text, bool cdata=false );
2008 /// Add a text node from an integer.
2009 void PushText( int value );
2010 /// Add a text node from an unsigned.
2011 void PushText( unsigned value );
2012 /// Add a text node from a bool.
2013 void PushText( bool value );
2014 /// Add a text node from a float.
2015 void PushText( float value );
2016 /// Add a text node from a double.
2017 void PushText( double value );
Lee Thomason21be8822012-07-15 17:27:22 -07002018
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002019 /// Add a comment
2020 void PushComment( const char* comment );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002021
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002022 void PushDeclaration( const char* value );
2023 void PushUnknown( const char* value );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002024
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002025 virtual bool VisitEnter( const XMLDocument& /*doc*/ );
2026 virtual bool VisitExit( const XMLDocument& /*doc*/ ) {
2027 return true;
2028 }
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002029
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002030 virtual bool VisitEnter( const XMLElement& element, const XMLAttribute* attribute );
2031 virtual bool VisitExit( const XMLElement& element );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002032
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002033 virtual bool Visit( const XMLText& text );
2034 virtual bool Visit( const XMLComment& comment );
2035 virtual bool Visit( const XMLDeclaration& declaration );
2036 virtual bool Visit( const XMLUnknown& unknown );
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002037
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002038 /**
2039 If in print to memory mode, return a pointer to
2040 the XML file in memory.
2041 */
2042 const char* CStr() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07002043 return _buffer.Mem();
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002044 }
2045 /**
2046 If in print to memory mode, return the size
2047 of the XML file in memory. (Note the size returned
2048 includes the terminating null.)
2049 */
2050 int CStrSize() const {
Lee Thomason624d43f2012-10-12 10:58:48 -07002051 return _buffer.Size();
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002052 }
Reinhard Klambauer3bc3d4e2013-11-22 14:05:21 +01002053 /**
2054 If in print to memory mode, reset the buffer to the
2055 beginning.
2056 */
Lee Thomasonce0510b2013-11-26 21:29:37 -08002057 void ClearBuffer() {
2058 _buffer.Clear();
Reinhard Klambauer3bc3d4e2013-11-22 14:05:21 +01002059 _buffer.Push(0);
2060 }
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002061
Dennis Jenkins59c75d32013-10-08 13:10:07 -05002062protected:
Alexander Maid740b642014-05-20 22:04:42 +02002063 virtual bool CompactMode( const XMLElement& ) { return _compactMode; }
Uli Kusterer5d1d27e2014-02-20 11:50:22 +01002064
Lee Thomasonc18eb232014-02-21 17:31:17 -08002065 /** Prints out the space before an element. You may override to change
2066 the space and tabs used. A PrintSpace() override should call Print().
2067 */
2068 virtual void PrintSpace( int depth );
2069 void Print( const char* format, ... );
2070
2071 void SealElement();
Dennis Jenkins59c75d32013-10-08 13:10:07 -05002072 bool _elementJustOpened;
2073 DynArray< const char*, 10 > _stack;
2074
2075private:
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002076 void PrintString( const char*, bool restrictedEntitySet ); // prints out, after detecting entities.
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002077
Lee Thomason624d43f2012-10-12 10:58:48 -07002078 bool _firstElement;
Jerome Martinez242c3ea2013-01-06 12:20:04 +01002079 FILE* _fp;
Lee Thomason624d43f2012-10-12 10:58:48 -07002080 int _depth;
2081 int _textDepth;
2082 bool _processEntities;
Lee Thomasonc18eb232014-02-21 17:31:17 -08002083 bool _compactMode;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002084
Lee Thomasona9cf3f92012-10-11 16:56:51 -07002085 enum {
2086 ENTITY_RANGE = 64,
2087 BUF_SIZE = 200
2088 };
Lee Thomason624d43f2012-10-12 10:58:48 -07002089 bool _entityFlag[ENTITY_RANGE];
2090 bool _restrictedEntityFlag[ENTITY_RANGE];
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002091
Lee Thomason624d43f2012-10-12 10:58:48 -07002092 DynArray< char, 20 > _buffer;
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002093};
2094
2095
Guillermo A. Amaralb42ba362012-03-20 00:15:30 -07002096} // tinyxml2
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002097
PKEuS95060352013-07-26 10:42:44 +02002098#if defined(_MSC_VER)
2099# pragma warning(pop)
2100#endif
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002101
U-Lama\Leee13c3e62011-12-28 14:36:55 -08002102#endif // TINYXML2_INCLUDED