TinyXML-2 10.0.0
Loading...
Searching...
No Matches
tinyxml2.h
1/*
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*/
23
24#ifndef TINYXML2_INCLUDED
25#define TINYXML2_INCLUDED
26
27#if defined(ANDROID_NDK) || defined(__BORLANDC__) || defined(__QNXNTO__)
28# include <ctype.h>
29# include <limits.h>
30# include <stdio.h>
31# include <stdlib.h>
32# include <string.h>
33# if defined(__PS3__)
34# include <stddef.h>
35# endif
36#else
37# include <cctype>
38# include <climits>
39# include <cstdio>
40# include <cstdlib>
41# include <cstring>
42#endif
43#include <stdint.h>
44
45/*
46 gcc:
47 g++ -Wall -DTINYXML2_DEBUG tinyxml2.cpp xmltest.cpp -o gccxmltest.exe
48
49 Formatting, Artistic Style:
50 AStyle.exe --style=1tbs --indent-switches --break-closing-brackets --indent-preprocessor tinyxml2.cpp tinyxml2.h
51*/
52
53#if defined( _DEBUG ) || defined (__DEBUG__)
54# ifndef TINYXML2_DEBUG
55# define TINYXML2_DEBUG
56# endif
57#endif
58
59#ifdef _MSC_VER
60# pragma warning(push)
61# pragma warning(disable: 4251)
62#endif
63
64#ifdef _MSC_VER
65# ifdef TINYXML2_EXPORT
66# define TINYXML2_LIB __declspec(dllexport)
67# elif defined(TINYXML2_IMPORT)
68# define TINYXML2_LIB __declspec(dllimport)
69# else
70# define TINYXML2_LIB
71# endif
72#elif __GNUC__ >= 4
73# define TINYXML2_LIB __attribute__((visibility("default")))
74#else
75# define TINYXML2_LIB
76#endif
77
78
79#if !defined(TIXMLASSERT)
80#if defined(TINYXML2_DEBUG)
81# if defined(_MSC_VER)
82# // "(void)0," is for suppressing C4127 warning in "assert(false)", "assert(true)" and the like
83# define TIXMLASSERT( x ) do { if ( !((void)0,(x))) { __debugbreak(); } } while(false)
84# elif defined (ANDROID_NDK)
85# include <android/log.h>
86# define TIXMLASSERT( x ) do { if ( !(x)) { __android_log_assert( "assert", "grinliz", "ASSERT in '%s' at %d.", __FILE__, __LINE__ ); } } while(false)
87# else
88# include <assert.h>
89# define TIXMLASSERT assert
90# endif
91#else
92# define TIXMLASSERT( x ) do {} while(false)
93#endif
94#endif
95
96/* Versioning, past 1.0.14:
97 http://semver.org/
98*/
99static const int TIXML2_MAJOR_VERSION = 10;
100static const int TIXML2_MINOR_VERSION = 0;
101static const int TIXML2_PATCH_VERSION = 0;
102
103#define TINYXML2_MAJOR_VERSION 10
104#define TINYXML2_MINOR_VERSION 0
105#define TINYXML2_PATCH_VERSION 0
106
107// A fixed element depth limit is problematic. There needs to be a
108// limit to avoid a stack overflow. However, that limit varies per
109// system, and the capacity of the stack. On the other hand, it's a trivial
110// attack that can result from ill, malicious, or even correctly formed XML,
111// so there needs to be a limit in place.
112static const int TINYXML2_MAX_ELEMENT_DEPTH = 500;
113
114namespace tinyxml2
115{
116class XMLDocument;
117class XMLElement;
118class XMLAttribute;
119class XMLComment;
120class XMLText;
121class XMLDeclaration;
122class XMLUnknown;
123class XMLPrinter;
124
125/*
126 A class that wraps strings. Normally stores the start and end
127 pointers into the XML file itself, and will apply normalization
128 and entity translation if actually read. Can also store (and memory
129 manage) a traditional char[]
130
131 Isn't clear why TINYXML2_LIB is needed; but seems to fix #719
132*/
133class TINYXML2_LIB StrPair
134{
135public:
136 enum Mode {
137 NEEDS_ENTITY_PROCESSING = 0x01,
138 NEEDS_NEWLINE_NORMALIZATION = 0x02,
139 NEEDS_WHITESPACE_COLLAPSING = 0x04,
140
141 TEXT_ELEMENT = NEEDS_ENTITY_PROCESSING | NEEDS_NEWLINE_NORMALIZATION,
142 TEXT_ELEMENT_LEAVE_ENTITIES = NEEDS_NEWLINE_NORMALIZATION,
143 ATTRIBUTE_NAME = 0,
144 ATTRIBUTE_VALUE = NEEDS_ENTITY_PROCESSING | NEEDS_NEWLINE_NORMALIZATION,
145 ATTRIBUTE_VALUE_LEAVE_ENTITIES = NEEDS_NEWLINE_NORMALIZATION,
146 COMMENT = NEEDS_NEWLINE_NORMALIZATION
147 };
148
149 StrPair() : _flags( 0 ), _start( 0 ), _end( 0 ) {}
150 ~StrPair();
151
152 void Set( char* start, char* end, int flags ) {
153 TIXMLASSERT( start );
154 TIXMLASSERT( end );
155 Reset();
156 _start = start;
157 _end = end;
158 _flags = flags | NEEDS_FLUSH;
159 }
160
161 const char* GetStr();
162
163 bool Empty() const {
164 return _start == _end;
165 }
166
167 void SetInternedStr( const char* str ) {
168 Reset();
169 _start = const_cast<char*>(str);
170 }
171
172 void SetStr( const char* str, int flags=0 );
173
174 char* ParseText( char* in, const char* endTag, int strFlags, int* curLineNumPtr );
175 char* ParseName( char* in );
176
177 void TransferTo( StrPair* other );
178 void Reset();
179
180private:
181 void CollapseWhitespace();
182
183 enum {
184 NEEDS_FLUSH = 0x100,
185 NEEDS_DELETE = 0x200
186 };
187
188 int _flags;
189 char* _start;
190 char* _end;
191
192 StrPair( const StrPair& other ); // not supported
193 void operator=( const StrPair& other ); // not supported, use TransferTo()
194};
195
196
197/*
198 A dynamic array of Plain Old Data. Doesn't support constructors, etc.
199 Has a small initial memory pool, so that low or no usage will not
200 cause a call to new/delete
201*/
202template <class T, int INITIAL_SIZE>
203class DynArray
204{
205public:
206 DynArray() :
207 _mem( _pool ),
208 _allocated( INITIAL_SIZE ),
209 _size( 0 )
210 {
211 }
212
213 ~DynArray() {
214 if ( _mem != _pool ) {
215 delete [] _mem;
216 }
217 }
218
219 void Clear() {
220 _size = 0;
221 }
222
223 void Push( T t ) {
224 TIXMLASSERT( _size < INT_MAX );
225 EnsureCapacity( _size+1 );
226 _mem[_size] = t;
227 ++_size;
228 }
229
230 T* PushArr( int count ) {
231 TIXMLASSERT( count >= 0 );
232 TIXMLASSERT( _size <= INT_MAX - count );
233 EnsureCapacity( _size+count );
234 T* ret = &_mem[_size];
235 _size += count;
236 return ret;
237 }
238
239 T Pop() {
240 TIXMLASSERT( _size > 0 );
241 --_size;
242 return _mem[_size];
243 }
244
245 void PopArr( int count ) {
246 TIXMLASSERT( _size >= count );
247 _size -= count;
248 }
249
250 bool Empty() const {
251 return _size == 0;
252 }
253
254 T& operator[](int i) {
255 TIXMLASSERT( i>= 0 && i < _size );
256 return _mem[i];
257 }
258
259 const T& operator[](int i) const {
260 TIXMLASSERT( i>= 0 && i < _size );
261 return _mem[i];
262 }
263
264 const T& PeekTop() const {
265 TIXMLASSERT( _size > 0 );
266 return _mem[ _size - 1];
267 }
268
269 int Size() const {
270 TIXMLASSERT( _size >= 0 );
271 return _size;
272 }
273
274 int Capacity() const {
275 TIXMLASSERT( _allocated >= INITIAL_SIZE );
276 return _allocated;
277 }
278
279 void SwapRemove(int i) {
280 TIXMLASSERT(i >= 0 && i < _size);
281 TIXMLASSERT(_size > 0);
282 _mem[i] = _mem[_size - 1];
283 --_size;
284 }
285
286 const T* Mem() const {
287 TIXMLASSERT( _mem );
288 return _mem;
289 }
290
291 T* Mem() {
292 TIXMLASSERT( _mem );
293 return _mem;
294 }
295
296private:
297 DynArray( const DynArray& ); // not supported
298 void operator=( const DynArray& ); // not supported
299
300 void EnsureCapacity( int cap ) {
301 TIXMLASSERT( cap > 0 );
302 if ( cap > _allocated ) {
303 TIXMLASSERT( cap <= INT_MAX / 2 );
304 const int newAllocated = cap * 2;
305 T* newMem = new T[static_cast<unsigned int>(newAllocated)];
306 TIXMLASSERT( newAllocated >= _size );
307 memcpy( newMem, _mem, sizeof(T)*static_cast<size_t>(_size) ); // warning: not using constructors, only works for PODs
308 if ( _mem != _pool ) {
309 delete [] _mem;
310 }
311 _mem = newMem;
312 _allocated = newAllocated;
313 }
314 }
315
316 T* _mem;
317 T _pool[static_cast<size_t>(INITIAL_SIZE)];
318 int _allocated; // objects allocated
319 int _size; // number objects in use
320};
321
322
323/*
324 Parent virtual class of a pool for fast allocation
325 and deallocation of objects.
326*/
327class MemPool
328{
329public:
330 MemPool() {}
331 virtual ~MemPool() {}
332
333 virtual int ItemSize() const = 0;
334 virtual void* Alloc() = 0;
335 virtual void Free( void* ) = 0;
336 virtual void SetTracked() = 0;
337};
338
339
340/*
341 Template child class to create pools of the correct type.
342*/
343template< int ITEM_SIZE >
344class MemPoolT : public MemPool
345{
346public:
347 MemPoolT() : _blockPtrs(), _root(0), _currentAllocs(0), _nAllocs(0), _maxAllocs(0), _nUntracked(0) {}
348 ~MemPoolT() {
349 MemPoolT< ITEM_SIZE >::Clear();
350 }
351
352 void Clear() {
353 // Delete the blocks.
354 while( !_blockPtrs.Empty()) {
355 Block* lastBlock = _blockPtrs.Pop();
356 delete lastBlock;
357 }
358 _root = 0;
359 _currentAllocs = 0;
360 _nAllocs = 0;
361 _maxAllocs = 0;
362 _nUntracked = 0;
363 }
364
365 virtual int ItemSize() const override{
366 return ITEM_SIZE;
367 }
368 int CurrentAllocs() const {
369 return _currentAllocs;
370 }
371
372 virtual void* Alloc() override{
373 if ( !_root ) {
374 // Need a new block.
375 Block* block = new Block;
376 _blockPtrs.Push( block );
377
378 Item* blockItems = block->items;
379 for( int i = 0; i < ITEMS_PER_BLOCK - 1; ++i ) {
380 blockItems[i].next = &(blockItems[i + 1]);
381 }
382 blockItems[ITEMS_PER_BLOCK - 1].next = 0;
383 _root = blockItems;
384 }
385 Item* const result = _root;
386 TIXMLASSERT( result != 0 );
387 _root = _root->next;
388
389 ++_currentAllocs;
390 if ( _currentAllocs > _maxAllocs ) {
391 _maxAllocs = _currentAllocs;
392 }
393 ++_nAllocs;
394 ++_nUntracked;
395 return result;
396 }
397
398 virtual void Free( void* mem ) override {
399 if ( !mem ) {
400 return;
401 }
402 --_currentAllocs;
403 Item* item = static_cast<Item*>( mem );
404#ifdef TINYXML2_DEBUG
405 memset( item, 0xfe, sizeof( *item ) );
406#endif
407 item->next = _root;
408 _root = item;
409 }
410 void Trace( const char* name ) {
411 printf( "Mempool %s watermark=%d [%dk] current=%d size=%d nAlloc=%d blocks=%d\n",
412 name, _maxAllocs, _maxAllocs * ITEM_SIZE / 1024, _currentAllocs,
413 ITEM_SIZE, _nAllocs, _blockPtrs.Size() );
414 }
415
416 void SetTracked() override {
417 --_nUntracked;
418 }
419
420 int Untracked() const {
421 return _nUntracked;
422 }
423
424 // This number is perf sensitive. 4k seems like a good tradeoff on my machine.
425 // The test file is large, 170k.
426 // Release: VS2010 gcc(no opt)
427 // 1k: 4000
428 // 2k: 4000
429 // 4k: 3900 21000
430 // 16k: 5200
431 // 32k: 4300
432 // 64k: 4000 21000
433 // Declared public because some compilers do not accept to use ITEMS_PER_BLOCK
434 // in private part if ITEMS_PER_BLOCK is private
435 enum { ITEMS_PER_BLOCK = (4 * 1024) / ITEM_SIZE };
436
437private:
438 MemPoolT( const MemPoolT& ); // not supported
439 void operator=( const MemPoolT& ); // not supported
440
441 union Item {
442 Item* next;
443 char itemData[static_cast<size_t>(ITEM_SIZE)];
444 };
445 struct Block {
446 Item items[ITEMS_PER_BLOCK];
447 };
448 DynArray< Block*, 10 > _blockPtrs;
449 Item* _root;
450
451 int _currentAllocs;
452 int _nAllocs;
453 int _maxAllocs;
454 int _nUntracked;
455};
456
457
458
478class TINYXML2_LIB XMLVisitor
479{
480public:
481 virtual ~XMLVisitor() {}
482
484 virtual bool VisitEnter( const XMLDocument& /*doc*/ ) {
485 return true;
486 }
488 virtual bool VisitExit( const XMLDocument& /*doc*/ ) {
489 return true;
490 }
491
493 virtual bool VisitEnter( const XMLElement& /*element*/, const XMLAttribute* /*firstAttribute*/ ) {
494 return true;
495 }
497 virtual bool VisitExit( const XMLElement& /*element*/ ) {
498 return true;
499 }
500
502 virtual bool Visit( const XMLDeclaration& /*declaration*/ ) {
503 return true;
504 }
506 virtual bool Visit( const XMLText& /*text*/ ) {
507 return true;
508 }
510 virtual bool Visit( const XMLComment& /*comment*/ ) {
511 return true;
512 }
514 virtual bool Visit( const XMLUnknown& /*unknown*/ ) {
515 return true;
516 }
517};
518
519// WARNING: must match XMLDocument::_errorNames[]
520enum XMLError {
521 XML_SUCCESS = 0,
522 XML_NO_ATTRIBUTE,
523 XML_WRONG_ATTRIBUTE_TYPE,
524 XML_ERROR_FILE_NOT_FOUND,
525 XML_ERROR_FILE_COULD_NOT_BE_OPENED,
526 XML_ERROR_FILE_READ_ERROR,
527 XML_ERROR_PARSING_ELEMENT,
528 XML_ERROR_PARSING_ATTRIBUTE,
529 XML_ERROR_PARSING_TEXT,
530 XML_ERROR_PARSING_CDATA,
531 XML_ERROR_PARSING_COMMENT,
532 XML_ERROR_PARSING_DECLARATION,
533 XML_ERROR_PARSING_UNKNOWN,
534 XML_ERROR_EMPTY_DOCUMENT,
535 XML_ERROR_MISMATCHED_ELEMENT,
536 XML_ERROR_PARSING,
537 XML_CAN_NOT_CONVERT_TEXT,
538 XML_NO_TEXT_NODE,
539 XML_ELEMENT_DEPTH_EXCEEDED,
540
541 XML_ERROR_COUNT
542};
543
544
545/*
546 Utility functionality.
547*/
548class TINYXML2_LIB XMLUtil
549{
550public:
551 static const char* SkipWhiteSpace( const char* p, int* curLineNumPtr ) {
552 TIXMLASSERT( p );
553
554 while( IsWhiteSpace(*p) ) {
555 if (curLineNumPtr && *p == '\n') {
556 ++(*curLineNumPtr);
557 }
558 ++p;
559 }
560 TIXMLASSERT( p );
561 return p;
562 }
563 static char* SkipWhiteSpace( char* const p, int* curLineNumPtr ) {
564 return const_cast<char*>( SkipWhiteSpace( const_cast<const char*>(p), curLineNumPtr ) );
565 }
566
567 // Anything in the high order range of UTF-8 is assumed to not be whitespace. This isn't
568 // correct, but simple, and usually works.
569 static bool IsWhiteSpace( char p ) {
570 return !IsUTF8Continuation(p) && isspace( static_cast<unsigned char>(p) );
571 }
572
573 inline static bool IsNameStartChar( unsigned char ch ) {
574 if ( ch >= 128 ) {
575 // This is a heuristic guess in attempt to not implement Unicode-aware isalpha()
576 return true;
577 }
578 if ( isalpha( ch ) ) {
579 return true;
580 }
581 return ch == ':' || ch == '_';
582 }
583
584 inline static bool IsNameChar( unsigned char ch ) {
585 return IsNameStartChar( ch )
586 || isdigit( ch )
587 || ch == '.'
588 || ch == '-';
589 }
590
591 inline static bool IsPrefixHex( const char* p) {
592 p = SkipWhiteSpace(p, 0);
593 return p && *p == '0' && ( *(p + 1) == 'x' || *(p + 1) == 'X');
594 }
595
596 inline static bool StringEqual( const char* p, const char* q, int nChar=INT_MAX ) {
597 if ( p == q ) {
598 return true;
599 }
600 TIXMLASSERT( p );
601 TIXMLASSERT( q );
602 TIXMLASSERT( nChar >= 0 );
603 return strncmp( p, q, static_cast<size_t>(nChar) ) == 0;
604 }
605
606 inline static bool IsUTF8Continuation( const char p ) {
607 return ( p & 0x80 ) != 0;
608 }
609
610 static const char* ReadBOM( const char* p, bool* hasBOM );
611 // p is the starting location,
612 // the UTF-8 value of the entity will be placed in value, and length filled in.
613 static const char* GetCharacterRef( const char* p, char* value, int* length );
614 static void ConvertUTF32ToUTF8( unsigned long input, char* output, int* length );
615
616 // converts primitive types to strings
617 static void ToStr( int v, char* buffer, int bufferSize );
618 static void ToStr( unsigned v, char* buffer, int bufferSize );
619 static void ToStr( bool v, char* buffer, int bufferSize );
620 static void ToStr( float v, char* buffer, int bufferSize );
621 static void ToStr( double v, char* buffer, int bufferSize );
622 static void ToStr(int64_t v, char* buffer, int bufferSize);
623 static void ToStr(uint64_t v, char* buffer, int bufferSize);
624
625 // converts strings to primitive types
626 static bool ToInt( const char* str, int* value );
627 static bool ToUnsigned( const char* str, unsigned* value );
628 static bool ToBool( const char* str, bool* value );
629 static bool ToFloat( const char* str, float* value );
630 static bool ToDouble( const char* str, double* value );
631 static bool ToInt64(const char* str, int64_t* value);
632 static bool ToUnsigned64(const char* str, uint64_t* value);
633 // Changes what is serialized for a boolean value.
634 // Default to "true" and "false". Shouldn't be changed
635 // unless you have a special testing or compatibility need.
636 // Be careful: static, global, & not thread safe.
637 // Be sure to set static const memory as parameters.
638 static void SetBoolSerialization(const char* writeTrue, const char* writeFalse);
639
640private:
641 static const char* writeBoolTrue;
642 static const char* writeBoolFalse;
643};
644
645
671class TINYXML2_LIB XMLNode
672{
673 friend class XMLDocument;
674 friend class XMLElement;
675public:
676
678 const XMLDocument* GetDocument() const {
679 TIXMLASSERT( _document );
680 return _document;
681 }
684 TIXMLASSERT( _document );
685 return _document;
686 }
687
690 return 0;
691 }
693 virtual XMLText* ToText() {
694 return 0;
695 }
698 return 0;
699 }
702 return 0;
703 }
706 return 0;
707 }
710 return 0;
711 }
712
713 virtual const XMLElement* ToElement() const {
714 return 0;
715 }
716 virtual const XMLText* ToText() const {
717 return 0;
718 }
719 virtual const XMLComment* ToComment() const {
720 return 0;
721 }
722 virtual const XMLDocument* ToDocument() const {
723 return 0;
724 }
725 virtual const XMLDeclaration* ToDeclaration() const {
726 return 0;
727 }
728 virtual const XMLUnknown* ToUnknown() const {
729 return 0;
730 }
731
732 // ChildElementCount was originally suggested by msteiger on the sourceforge page for TinyXML and modified by KB1SPH for TinyXML-2.
733
734 int ChildElementCount(const char *value) const;
735
736 int ChildElementCount() const;
737
747 const char* Value() const;
748
752 void SetValue( const char* val, bool staticMem=false );
753
755 int GetLineNum() const { return _parseLineNum; }
756
758 const XMLNode* Parent() const {
759 return _parent;
760 }
761
762 XMLNode* Parent() {
763 return _parent;
764 }
765
767 bool NoChildren() const {
768 return !_firstChild;
769 }
770
772 const XMLNode* FirstChild() const {
773 return _firstChild;
774 }
775
776 XMLNode* FirstChild() {
777 return _firstChild;
778 }
779
783 const XMLElement* FirstChildElement( const char* name = 0 ) const;
784
785 XMLElement* FirstChildElement( const char* name = 0 ) {
786 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->FirstChildElement( name ));
787 }
788
790 const XMLNode* LastChild() const {
791 return _lastChild;
792 }
793
794 XMLNode* LastChild() {
795 return _lastChild;
796 }
797
801 const XMLElement* LastChildElement( const char* name = 0 ) const;
802
803 XMLElement* LastChildElement( const char* name = 0 ) {
804 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->LastChildElement(name) );
805 }
806
808 const XMLNode* PreviousSibling() const {
809 return _prev;
810 }
811
812 XMLNode* PreviousSibling() {
813 return _prev;
814 }
815
817 const XMLElement* PreviousSiblingElement( const char* name = 0 ) const ;
818
819 XMLElement* PreviousSiblingElement( const char* name = 0 ) {
820 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->PreviousSiblingElement( name ) );
821 }
822
824 const XMLNode* NextSibling() const {
825 return _next;
826 }
827
828 XMLNode* NextSibling() {
829 return _next;
830 }
831
833 const XMLElement* NextSiblingElement( const char* name = 0 ) const;
834
835 XMLElement* NextSiblingElement( const char* name = 0 ) {
836 return const_cast<XMLElement*>(const_cast<const XMLNode*>(this)->NextSiblingElement( name ) );
837 }
838
847
848 XMLNode* LinkEndChild( XMLNode* addThis ) {
849 return InsertEndChild( addThis );
850 }
867 XMLNode* InsertAfterChild( XMLNode* afterThis, XMLNode* addThis );
868
873
877 void DeleteChild( XMLNode* node );
878
888 virtual XMLNode* ShallowClone( XMLDocument* document ) const = 0;
889
903 XMLNode* DeepClone( XMLDocument* target ) const;
904
911 virtual bool ShallowEqual( const XMLNode* compare ) const = 0;
912
935 virtual bool Accept( XMLVisitor* visitor ) const = 0;
936
942 void SetUserData(void* userData) { _userData = userData; }
943
949 void* GetUserData() const { return _userData; }
950
951protected:
952 explicit XMLNode( XMLDocument* );
953 virtual ~XMLNode();
954
955 virtual char* ParseDeep( char* p, StrPair* parentEndTag, int* curLineNumPtr);
956
957 XMLDocument* _document;
958 XMLNode* _parent;
959 mutable StrPair _value;
960 int _parseLineNum;
961
962 XMLNode* _firstChild;
963 XMLNode* _lastChild;
964
965 XMLNode* _prev;
966 XMLNode* _next;
967
968 void* _userData;
969
970private:
971 MemPool* _memPool;
972 void Unlink( XMLNode* child );
973 static void DeleteNode( XMLNode* node );
974 void InsertChildPreamble( XMLNode* insertThis ) const;
975 const XMLElement* ToElementWithName( const char* name ) const;
976
977 XMLNode( const XMLNode& ); // not supported
978 XMLNode& operator=( const XMLNode& ); // not supported
979};
980
981
994class TINYXML2_LIB XMLText : public XMLNode
995{
996 friend class XMLDocument;
997public:
998 virtual bool Accept( XMLVisitor* visitor ) const override;
999
1000 virtual XMLText* ToText() override {
1001 return this;
1002 }
1003 virtual const XMLText* ToText() const override {
1004 return this;
1005 }
1006
1008 void SetCData( bool isCData ) {
1009 _isCData = isCData;
1010 }
1012 bool CData() const {
1013 return _isCData;
1014 }
1015
1016 virtual XMLNode* ShallowClone( XMLDocument* document ) const override;
1017 virtual bool ShallowEqual( const XMLNode* compare ) const override;
1018
1019protected:
1020 explicit XMLText( XMLDocument* doc ) : XMLNode( doc ), _isCData( false ) {}
1021 virtual ~XMLText() {}
1022
1023 char* ParseDeep( char* p, StrPair* parentEndTag, int* curLineNumPtr ) override;
1024
1025private:
1026 bool _isCData;
1027
1028 XMLText( const XMLText& ); // not supported
1029 XMLText& operator=( const XMLText& ); // not supported
1030};
1031
1032
1034class TINYXML2_LIB XMLComment : public XMLNode
1035{
1036 friend class XMLDocument;
1037public:
1038 virtual XMLComment* ToComment() override {
1039 return this;
1040 }
1041 virtual const XMLComment* ToComment() const override {
1042 return this;
1043 }
1044
1045 virtual bool Accept( XMLVisitor* visitor ) const override;
1046
1047 virtual XMLNode* ShallowClone( XMLDocument* document ) const override;
1048 virtual bool ShallowEqual( const XMLNode* compare ) const override;
1049
1050protected:
1051 explicit XMLComment( XMLDocument* doc );
1052 virtual ~XMLComment();
1053
1054 char* ParseDeep( char* p, StrPair* parentEndTag, int* curLineNumPtr) override;
1055
1056private:
1057 XMLComment( const XMLComment& ); // not supported
1058 XMLComment& operator=( const XMLComment& ); // not supported
1059};
1060
1061
1073class TINYXML2_LIB XMLDeclaration : public XMLNode
1074{
1075 friend class XMLDocument;
1076public:
1077 virtual XMLDeclaration* ToDeclaration() override {
1078 return this;
1079 }
1080 virtual const XMLDeclaration* ToDeclaration() const override {
1081 return this;
1082 }
1083
1084 virtual bool Accept( XMLVisitor* visitor ) const override;
1085
1086 virtual XMLNode* ShallowClone( XMLDocument* document ) const override;
1087 virtual bool ShallowEqual( const XMLNode* compare ) const override;
1088
1089protected:
1090 explicit XMLDeclaration( XMLDocument* doc );
1091 virtual ~XMLDeclaration();
1092
1093 char* ParseDeep( char* p, StrPair* parentEndTag, int* curLineNumPtr ) override;
1094
1095private:
1096 XMLDeclaration( const XMLDeclaration& ); // not supported
1097 XMLDeclaration& operator=( const XMLDeclaration& ); // not supported
1098};
1099
1100
1108class TINYXML2_LIB XMLUnknown : public XMLNode
1109{
1110 friend class XMLDocument;
1111public:
1112 virtual XMLUnknown* ToUnknown() override {
1113 return this;
1114 }
1115 virtual const XMLUnknown* ToUnknown() const override {
1116 return this;
1117 }
1118
1119 virtual bool Accept( XMLVisitor* visitor ) const override;
1120
1121 virtual XMLNode* ShallowClone( XMLDocument* document ) const override;
1122 virtual bool ShallowEqual( const XMLNode* compare ) const override;
1123
1124protected:
1125 explicit XMLUnknown( XMLDocument* doc );
1126 virtual ~XMLUnknown();
1127
1128 char* ParseDeep( char* p, StrPair* parentEndTag, int* curLineNumPtr ) override;
1129
1130private:
1131 XMLUnknown( const XMLUnknown& ); // not supported
1132 XMLUnknown& operator=( const XMLUnknown& ); // not supported
1133};
1134
1135
1136
1143class TINYXML2_LIB XMLAttribute
1144{
1145 friend class XMLElement;
1146public:
1148 const char* Name() const;
1149
1151 const char* Value() const;
1152
1154 int GetLineNum() const { return _parseLineNum; }
1155
1157 const XMLAttribute* Next() const {
1158 return _next;
1159 }
1160
1165 int IntValue() const {
1166 int i = 0;
1167 QueryIntValue(&i);
1168 return i;
1169 }
1170
1171 int64_t Int64Value() const {
1172 int64_t i = 0;
1173 QueryInt64Value(&i);
1174 return i;
1175 }
1176
1177 uint64_t Unsigned64Value() const {
1178 uint64_t i = 0;
1179 QueryUnsigned64Value(&i);
1180 return i;
1181 }
1182
1184 unsigned UnsignedValue() const {
1185 unsigned i=0;
1186 QueryUnsignedValue( &i );
1187 return i;
1188 }
1190 bool BoolValue() const {
1191 bool b=false;
1192 QueryBoolValue( &b );
1193 return b;
1194 }
1196 double DoubleValue() const {
1197 double d=0;
1198 QueryDoubleValue( &d );
1199 return d;
1200 }
1202 float FloatValue() const {
1203 float f=0;
1204 QueryFloatValue( &f );
1205 return f;
1206 }
1207
1212 XMLError QueryIntValue( int* value ) const;
1214 XMLError QueryUnsignedValue( unsigned int* value ) const;
1216 XMLError QueryInt64Value(int64_t* value) const;
1218 XMLError QueryUnsigned64Value(uint64_t* value) const;
1220 XMLError QueryBoolValue( bool* value ) const;
1222 XMLError QueryDoubleValue( double* value ) const;
1224 XMLError QueryFloatValue( float* value ) const;
1225
1227 void SetAttribute( const char* value );
1229 void SetAttribute( int value );
1231 void SetAttribute( unsigned value );
1233 void SetAttribute(int64_t value);
1235 void SetAttribute(uint64_t value);
1237 void SetAttribute( bool value );
1239 void SetAttribute( double value );
1241 void SetAttribute( float value );
1242
1243private:
1244 enum { BUF_SIZE = 200 };
1245
1246 XMLAttribute() : _name(), _value(),_parseLineNum( 0 ), _next( 0 ), _memPool( 0 ) {}
1247 virtual ~XMLAttribute() {}
1248
1249 XMLAttribute( const XMLAttribute& ); // not supported
1250 void operator=( const XMLAttribute& ); // not supported
1251 void SetName( const char* name );
1252
1253 char* ParseDeep( char* p, bool processEntities, int* curLineNumPtr );
1254
1255 mutable StrPair _name;
1256 mutable StrPair _value;
1257 int _parseLineNum;
1258 XMLAttribute* _next;
1259 MemPool* _memPool;
1260};
1261
1262
1267class TINYXML2_LIB XMLElement : public XMLNode
1268{
1269 friend class XMLDocument;
1270public:
1272 const char* Name() const {
1273 return Value();
1274 }
1276 void SetName( const char* str, bool staticMem=false ) {
1277 SetValue( str, staticMem );
1278 }
1279
1280 virtual XMLElement* ToElement() override {
1281 return this;
1282 }
1283 virtual const XMLElement* ToElement() const override {
1284 return this;
1285 }
1286 virtual bool Accept( XMLVisitor* visitor ) const override;
1287
1311 const char* Attribute( const char* name, const char* value=0 ) const;
1312
1319 int IntAttribute(const char* name, int defaultValue = 0) const;
1321 unsigned UnsignedAttribute(const char* name, unsigned defaultValue = 0) const;
1323 int64_t Int64Attribute(const char* name, int64_t defaultValue = 0) const;
1325 uint64_t Unsigned64Attribute(const char* name, uint64_t defaultValue = 0) const;
1327 bool BoolAttribute(const char* name, bool defaultValue = false) const;
1329 double DoubleAttribute(const char* name, double defaultValue = 0) const;
1331 float FloatAttribute(const char* name, float defaultValue = 0) const;
1332
1346 XMLError QueryIntAttribute( const char* name, int* value ) const {
1347 const XMLAttribute* a = FindAttribute( name );
1348 if ( !a ) {
1349 return XML_NO_ATTRIBUTE;
1350 }
1351 return a->QueryIntValue( value );
1352 }
1353
1355 XMLError QueryUnsignedAttribute( const char* name, unsigned int* value ) const {
1356 const XMLAttribute* a = FindAttribute( name );
1357 if ( !a ) {
1358 return XML_NO_ATTRIBUTE;
1359 }
1360 return a->QueryUnsignedValue( value );
1361 }
1362
1364 XMLError QueryInt64Attribute(const char* name, int64_t* value) const {
1365 const XMLAttribute* a = FindAttribute(name);
1366 if (!a) {
1367 return XML_NO_ATTRIBUTE;
1368 }
1369 return a->QueryInt64Value(value);
1370 }
1371
1373 XMLError QueryUnsigned64Attribute(const char* name, uint64_t* value) const {
1374 const XMLAttribute* a = FindAttribute(name);
1375 if(!a) {
1376 return XML_NO_ATTRIBUTE;
1377 }
1378 return a->QueryUnsigned64Value(value);
1379 }
1380
1382 XMLError QueryBoolAttribute( const char* name, bool* value ) const {
1383 const XMLAttribute* a = FindAttribute( name );
1384 if ( !a ) {
1385 return XML_NO_ATTRIBUTE;
1386 }
1387 return a->QueryBoolValue( value );
1388 }
1390 XMLError QueryDoubleAttribute( const char* name, double* value ) const {
1391 const XMLAttribute* a = FindAttribute( name );
1392 if ( !a ) {
1393 return XML_NO_ATTRIBUTE;
1394 }
1395 return a->QueryDoubleValue( value );
1396 }
1398 XMLError QueryFloatAttribute( const char* name, float* value ) const {
1399 const XMLAttribute* a = FindAttribute( name );
1400 if ( !a ) {
1401 return XML_NO_ATTRIBUTE;
1402 }
1403 return a->QueryFloatValue( value );
1404 }
1405
1407 XMLError QueryStringAttribute(const char* name, const char** value) const {
1408 const XMLAttribute* a = FindAttribute(name);
1409 if (!a) {
1410 return XML_NO_ATTRIBUTE;
1411 }
1412 *value = a->Value();
1413 return XML_SUCCESS;
1414 }
1415
1416
1417
1435 XMLError QueryAttribute( const char* name, int* value ) const {
1436 return QueryIntAttribute( name, value );
1437 }
1438
1439 XMLError QueryAttribute( const char* name, unsigned int* value ) const {
1440 return QueryUnsignedAttribute( name, value );
1441 }
1442
1443 XMLError QueryAttribute(const char* name, int64_t* value) const {
1444 return QueryInt64Attribute(name, value);
1445 }
1446
1447 XMLError QueryAttribute(const char* name, uint64_t* value) const {
1448 return QueryUnsigned64Attribute(name, value);
1449 }
1450
1451 XMLError QueryAttribute( const char* name, bool* value ) const {
1452 return QueryBoolAttribute( name, value );
1453 }
1454
1455 XMLError QueryAttribute( const char* name, double* value ) const {
1456 return QueryDoubleAttribute( name, value );
1457 }
1458
1459 XMLError QueryAttribute( const char* name, float* value ) const {
1460 return QueryFloatAttribute( name, value );
1461 }
1462
1463 XMLError QueryAttribute(const char* name, const char** value) const {
1464 return QueryStringAttribute(name, value);
1465 }
1466
1468 void SetAttribute( const char* name, const char* value ) {
1469 XMLAttribute* a = FindOrCreateAttribute( name );
1470 a->SetAttribute( value );
1471 }
1473 void SetAttribute( const char* name, int value ) {
1474 XMLAttribute* a = FindOrCreateAttribute( name );
1475 a->SetAttribute( value );
1476 }
1478 void SetAttribute( const char* name, unsigned value ) {
1479 XMLAttribute* a = FindOrCreateAttribute( name );
1480 a->SetAttribute( value );
1481 }
1482
1484 void SetAttribute(const char* name, int64_t value) {
1485 XMLAttribute* a = FindOrCreateAttribute(name);
1486 a->SetAttribute(value);
1487 }
1488
1490 void SetAttribute(const char* name, uint64_t value) {
1491 XMLAttribute* a = FindOrCreateAttribute(name);
1492 a->SetAttribute(value);
1493 }
1494
1496 void SetAttribute( const char* name, bool value ) {
1497 XMLAttribute* a = FindOrCreateAttribute( name );
1498 a->SetAttribute( value );
1499 }
1501 void SetAttribute( const char* name, double value ) {
1502 XMLAttribute* a = FindOrCreateAttribute( name );
1503 a->SetAttribute( value );
1504 }
1506 void SetAttribute( const char* name, float value ) {
1507 XMLAttribute* a = FindOrCreateAttribute( name );
1508 a->SetAttribute( value );
1509 }
1510
1514 void DeleteAttribute( const char* name );
1515
1518 return _rootAttribute;
1519 }
1521 const XMLAttribute* FindAttribute( const char* name ) const;
1522
1551 const char* GetText() const;
1552
1587 void SetText( const char* inText );
1589 void SetText( int value );
1591 void SetText( unsigned value );
1593 void SetText(int64_t value);
1595 void SetText(uint64_t value);
1597 void SetText( bool value );
1599 void SetText( double value );
1601 void SetText( float value );
1602
1629 XMLError QueryIntText( int* ival ) const;
1631 XMLError QueryUnsignedText( unsigned* uval ) const;
1633 XMLError QueryInt64Text(int64_t* uval) const;
1635 XMLError QueryUnsigned64Text(uint64_t* uval) const;
1637 XMLError QueryBoolText( bool* bval ) const;
1639 XMLError QueryDoubleText( double* dval ) const;
1641 XMLError QueryFloatText( float* fval ) const;
1642
1643 int IntText(int defaultValue = 0) const;
1644
1646 unsigned UnsignedText(unsigned defaultValue = 0) const;
1648 int64_t Int64Text(int64_t defaultValue = 0) const;
1650 uint64_t Unsigned64Text(uint64_t defaultValue = 0) const;
1652 bool BoolText(bool defaultValue = false) const;
1654 double DoubleText(double defaultValue = 0) const;
1656 float FloatText(float defaultValue = 0) const;
1657
1664 XMLComment* InsertNewComment(const char* comment);
1666 XMLText* InsertNewText(const char* text);
1670 XMLUnknown* InsertNewUnknown(const char* text);
1671
1672
1673 // internal:
1674 enum ElementClosingType {
1675 OPEN, // <foo>
1676 CLOSED, // <foo/>
1677 CLOSING // </foo>
1678 };
1679 ElementClosingType ClosingType() const {
1680 return _closingType;
1681 }
1682 virtual XMLNode* ShallowClone( XMLDocument* document ) const override;
1683 virtual bool ShallowEqual( const XMLNode* compare ) const override;
1684
1685protected:
1686 char* ParseDeep( char* p, StrPair* parentEndTag, int* curLineNumPtr ) override;
1687
1688private:
1689 XMLElement( XMLDocument* doc );
1690 virtual ~XMLElement();
1691 XMLElement( const XMLElement& ); // not supported
1692 void operator=( const XMLElement& ); // not supported
1693
1694 XMLAttribute* FindOrCreateAttribute( const char* name );
1695 char* ParseAttributes( char* p, int* curLineNumPtr );
1696 static void DeleteAttribute( XMLAttribute* attribute );
1697 XMLAttribute* CreateAttribute();
1698
1699 enum { BUF_SIZE = 200 };
1700 ElementClosingType _closingType;
1701 // The attribute list is ordered; there is no 'lastAttribute'
1702 // because the list needs to be scanned for dupes before adding
1703 // a new attribute.
1704 XMLAttribute* _rootAttribute;
1705};
1706
1707
1708enum Whitespace {
1709 PRESERVE_WHITESPACE,
1710 COLLAPSE_WHITESPACE,
1711 PEDANTIC_WHITESPACE
1712};
1713
1714
1720class TINYXML2_LIB XMLDocument : public XMLNode
1721{
1722 friend class XMLElement;
1723 // Gives access to SetError and Push/PopDepth, but over-access for everything else.
1724 // Wishing C++ had "internal" scope.
1725 friend class XMLNode;
1726 friend class XMLText;
1727 friend class XMLComment;
1728 friend class XMLDeclaration;
1729 friend class XMLUnknown;
1730public:
1732 XMLDocument( bool processEntities = true, Whitespace whitespaceMode = PRESERVE_WHITESPACE );
1733 ~XMLDocument();
1734
1735 virtual XMLDocument* ToDocument() override {
1736 TIXMLASSERT( this == _document );
1737 return this;
1738 }
1739 virtual const XMLDocument* ToDocument() const override {
1740 TIXMLASSERT( this == _document );
1741 return this;
1742 }
1743
1754 XMLError Parse( const char* xml, size_t nBytes=static_cast<size_t>(-1) );
1755
1761 XMLError LoadFile( const char* filename );
1762
1774 XMLError LoadFile( FILE* );
1775
1781 XMLError SaveFile( const char* filename, bool compact = false );
1782
1790 XMLError SaveFile( FILE* fp, bool compact = false );
1791
1792 bool ProcessEntities() const {
1793 return _processEntities;
1794 }
1795 Whitespace WhitespaceMode() const {
1796 return _whitespaceMode;
1797 }
1798
1802 bool HasBOM() const {
1803 return _writeBOM;
1804 }
1807 void SetBOM( bool useBOM ) {
1808 _writeBOM = useBOM;
1809 }
1810
1815 return FirstChildElement();
1816 }
1817 const XMLElement* RootElement() const {
1818 return FirstChildElement();
1819 }
1820
1835 void Print( XMLPrinter* streamer=0 ) const;
1836 virtual bool Accept( XMLVisitor* visitor ) const override;
1837
1843 XMLElement* NewElement( const char* name );
1849 XMLComment* NewComment( const char* comment );
1855 XMLText* NewText( const char* text );
1867 XMLDeclaration* NewDeclaration( const char* text=0 );
1873 XMLUnknown* NewUnknown( const char* text );
1874
1879 void DeleteNode( XMLNode* node );
1880
1883
1885 bool Error() const {
1886 return _errorID != XML_SUCCESS;
1887 }
1889 XMLError ErrorID() const {
1890 return _errorID;
1891 }
1892 const char* ErrorName() const;
1893 static const char* ErrorIDToName(XMLError errorID);
1894
1898 const char* ErrorStr() const;
1899
1901 void PrintError() const;
1902
1904 int ErrorLineNum() const
1905 {
1906 return _errorLineNum;
1907 }
1908
1910 void Clear();
1911
1919 void DeepCopy(XMLDocument* target) const;
1920
1921 // internal
1922 char* Identify( char* p, XMLNode** node, bool first );
1923
1924 // internal
1925 void MarkInUse(const XMLNode* const);
1926
1927 virtual XMLNode* ShallowClone( XMLDocument* /*document*/ ) const override{
1928 return 0;
1929 }
1930 virtual bool ShallowEqual( const XMLNode* /*compare*/ ) const override{
1931 return false;
1932 }
1933
1934private:
1935 XMLDocument( const XMLDocument& ); // not supported
1936 void operator=( const XMLDocument& ); // not supported
1937
1938 bool _writeBOM;
1939 bool _processEntities;
1940 XMLError _errorID;
1941 Whitespace _whitespaceMode;
1942 mutable StrPair _errorStr;
1943 int _errorLineNum;
1944 char* _charBuffer;
1945 int _parseCurLineNum;
1946 int _parsingDepth;
1947 // Memory tracking does add some overhead.
1948 // However, the code assumes that you don't
1949 // have a bunch of unlinked nodes around.
1950 // Therefore it takes less memory to track
1951 // in the document vs. a linked list in the XMLNode,
1952 // and the performance is the same.
1953 DynArray<XMLNode*, 10> _unlinked;
1954
1955 MemPoolT< sizeof(XMLElement) > _elementPool;
1956 MemPoolT< sizeof(XMLAttribute) > _attributePool;
1957 MemPoolT< sizeof(XMLText) > _textPool;
1958 MemPoolT< sizeof(XMLComment) > _commentPool;
1959
1960 static const char* _errorNames[XML_ERROR_COUNT];
1961
1962 void Parse();
1963
1964 void SetError( XMLError error, int lineNum, const char* format, ... );
1965
1966 // Something of an obvious security hole, once it was discovered.
1967 // Either an ill-formed XML or an excessively deep one can overflow
1968 // the stack. Track stack depth, and error out if needed.
1969 class DepthTracker {
1970 public:
1971 explicit DepthTracker(XMLDocument * document) {
1972 this->_document = document;
1973 document->PushDepth();
1974 }
1975 ~DepthTracker() {
1976 _document->PopDepth();
1977 }
1978 private:
1979 XMLDocument * _document;
1980 };
1981 void PushDepth();
1982 void PopDepth();
1983
1984 template<class NodeType, int PoolElementSize>
1985 NodeType* CreateUnlinkedNode( MemPoolT<PoolElementSize>& pool );
1986};
1987
1988template<class NodeType, int PoolElementSize>
1989inline NodeType* XMLDocument::CreateUnlinkedNode( MemPoolT<PoolElementSize>& pool )
1990{
1991 TIXMLASSERT( sizeof( NodeType ) == PoolElementSize );
1992 TIXMLASSERT( sizeof( NodeType ) == pool.ItemSize() );
1993 NodeType* returnNode = new (pool.Alloc()) NodeType( this );
1994 TIXMLASSERT( returnNode );
1995 returnNode->_memPool = &pool;
1996
1997 _unlinked.Push(returnNode);
1998 return returnNode;
1999}
2000
2056class TINYXML2_LIB XMLHandle
2057{
2058public:
2060 explicit XMLHandle( XMLNode* node ) : _node( node ) {
2061 }
2063 explicit XMLHandle( XMLNode& node ) : _node( &node ) {
2064 }
2066 XMLHandle( const XMLHandle& ref ) : _node( ref._node ) {
2067 }
2070 _node = ref._node;
2071 return *this;
2072 }
2073
2076 return XMLHandle( _node ? _node->FirstChild() : 0 );
2077 }
2079 XMLHandle FirstChildElement( const char* name = 0 ) {
2080 return XMLHandle( _node ? _node->FirstChildElement( name ) : 0 );
2081 }
2084 return XMLHandle( _node ? _node->LastChild() : 0 );
2085 }
2087 XMLHandle LastChildElement( const char* name = 0 ) {
2088 return XMLHandle( _node ? _node->LastChildElement( name ) : 0 );
2089 }
2092 return XMLHandle( _node ? _node->PreviousSibling() : 0 );
2093 }
2095 XMLHandle PreviousSiblingElement( const char* name = 0 ) {
2096 return XMLHandle( _node ? _node->PreviousSiblingElement( name ) : 0 );
2097 }
2100 return XMLHandle( _node ? _node->NextSibling() : 0 );
2101 }
2103 XMLHandle NextSiblingElement( const char* name = 0 ) {
2104 return XMLHandle( _node ? _node->NextSiblingElement( name ) : 0 );
2105 }
2106
2109 return _node;
2110 }
2113 return ( _node ? _node->ToElement() : 0 );
2114 }
2117 return ( _node ? _node->ToText() : 0 );
2118 }
2121 return ( _node ? _node->ToUnknown() : 0 );
2122 }
2125 return ( _node ? _node->ToDeclaration() : 0 );
2126 }
2127
2128private:
2129 XMLNode* _node;
2130};
2131
2132
2137class TINYXML2_LIB XMLConstHandle
2138{
2139public:
2140 explicit XMLConstHandle( const XMLNode* node ) : _node( node ) {
2141 }
2142 explicit XMLConstHandle( const XMLNode& node ) : _node( &node ) {
2143 }
2144 XMLConstHandle( const XMLConstHandle& ref ) : _node( ref._node ) {
2145 }
2146
2147 XMLConstHandle& operator=( const XMLConstHandle& ref ) {
2148 _node = ref._node;
2149 return *this;
2150 }
2151
2152 const XMLConstHandle FirstChild() const {
2153 return XMLConstHandle( _node ? _node->FirstChild() : 0 );
2154 }
2155 const XMLConstHandle FirstChildElement( const char* name = 0 ) const {
2156 return XMLConstHandle( _node ? _node->FirstChildElement( name ) : 0 );
2157 }
2158 const XMLConstHandle LastChild() const {
2159 return XMLConstHandle( _node ? _node->LastChild() : 0 );
2160 }
2161 const XMLConstHandle LastChildElement( const char* name = 0 ) const {
2162 return XMLConstHandle( _node ? _node->LastChildElement( name ) : 0 );
2163 }
2164 const XMLConstHandle PreviousSibling() const {
2165 return XMLConstHandle( _node ? _node->PreviousSibling() : 0 );
2166 }
2167 const XMLConstHandle PreviousSiblingElement( const char* name = 0 ) const {
2168 return XMLConstHandle( _node ? _node->PreviousSiblingElement( name ) : 0 );
2169 }
2170 const XMLConstHandle NextSibling() const {
2171 return XMLConstHandle( _node ? _node->NextSibling() : 0 );
2172 }
2173 const XMLConstHandle NextSiblingElement( const char* name = 0 ) const {
2174 return XMLConstHandle( _node ? _node->NextSiblingElement( name ) : 0 );
2175 }
2176
2177
2178 const XMLNode* ToNode() const {
2179 return _node;
2180 }
2181 const XMLElement* ToElement() const {
2182 return ( _node ? _node->ToElement() : 0 );
2183 }
2184 const XMLText* ToText() const {
2185 return ( _node ? _node->ToText() : 0 );
2186 }
2187 const XMLUnknown* ToUnknown() const {
2188 return ( _node ? _node->ToUnknown() : 0 );
2189 }
2190 const XMLDeclaration* ToDeclaration() const {
2191 return ( _node ? _node->ToDeclaration() : 0 );
2192 }
2193
2194private:
2195 const XMLNode* _node;
2196};
2197
2198
2241class TINYXML2_LIB XMLPrinter : public XMLVisitor
2242{
2243public:
2250 XMLPrinter( FILE* file=0, bool compact = false, int depth = 0 );
2251 virtual ~XMLPrinter() {}
2252
2254 void PushHeader( bool writeBOM, bool writeDeclaration );
2258 void OpenElement( const char* name, bool compactMode=false );
2260 void PushAttribute( const char* name, const char* value );
2261 void PushAttribute( const char* name, int value );
2262 void PushAttribute( const char* name, unsigned value );
2263 void PushAttribute( const char* name, int64_t value );
2264 void PushAttribute( const char* name, uint64_t value );
2265 void PushAttribute( const char* name, bool value );
2266 void PushAttribute( const char* name, double value );
2268 virtual void CloseElement( bool compactMode=false );
2269
2271 void PushText( const char* text, bool cdata=false );
2273 void PushText( int value );
2275 void PushText( unsigned value );
2277 void PushText( int64_t value );
2279 void PushText( uint64_t value );
2281 void PushText( bool value );
2283 void PushText( float value );
2285 void PushText( double value );
2286
2288 void PushComment( const char* comment );
2289
2290 void PushDeclaration( const char* value );
2291 void PushUnknown( const char* value );
2292
2293 virtual bool VisitEnter( const XMLDocument& /*doc*/ ) override;
2294 virtual bool VisitExit( const XMLDocument& /*doc*/ ) override {
2295 return true;
2296 }
2297
2298 virtual bool VisitEnter( const XMLElement& element, const XMLAttribute* attribute ) override;
2299 virtual bool VisitExit( const XMLElement& element ) override;
2300
2301 virtual bool Visit( const XMLText& text ) override;
2302 virtual bool Visit( const XMLComment& comment ) override;
2303 virtual bool Visit( const XMLDeclaration& declaration ) override;
2304 virtual bool Visit( const XMLUnknown& unknown ) override;
2305
2310 const char* CStr() const {
2311 return _buffer.Mem();
2312 }
2318 int CStrSize() const {
2319 return _buffer.Size();
2320 }
2325 void ClearBuffer( bool resetToFirstElement = true ) {
2326 _buffer.Clear();
2327 _buffer.Push(0);
2328 _firstElement = resetToFirstElement;
2329 }
2330
2331protected:
2332 virtual bool CompactMode( const XMLElement& ) { return _compactMode; }
2333
2337 virtual void PrintSpace( int depth );
2338 virtual void Print( const char* format, ... );
2339 virtual void Write( const char* data, size_t size );
2340 virtual void Putc( char ch );
2341
2342 inline void Write(const char* data) { Write(data, strlen(data)); }
2343
2344 void SealElementIfJustOpened();
2345 bool _elementJustOpened;
2346 DynArray< const char*, 10 > _stack;
2347
2348private:
2353 void PrepareForNewNode( bool compactMode );
2354 void PrintString( const char*, bool restrictedEntitySet ); // prints out, after detecting entities.
2355
2356 bool _firstElement;
2357 FILE* _fp;
2358 int _depth;
2359 int _textDepth;
2360 bool _processEntities;
2361 bool _compactMode;
2362
2363 enum {
2364 ENTITY_RANGE = 64,
2365 BUF_SIZE = 200
2366 };
2367 bool _entityFlag[ENTITY_RANGE];
2368 bool _restrictedEntityFlag[ENTITY_RANGE];
2369
2370 DynArray< char, 20 > _buffer;
2371
2372 // Prohibit cloning, intentionally not implemented
2373 XMLPrinter( const XMLPrinter& );
2374 XMLPrinter& operator=( const XMLPrinter& );
2375};
2376
2377
2378} // tinyxml2
2379
2380#if defined(_MSC_VER)
2381# pragma warning(pop)
2382#endif
2383
2384#endif // TINYXML2_INCLUDED
Definition tinyxml2.h:1144
int GetLineNum() const
Gets the line number the attribute is in, if the document was parsed from a file.
Definition tinyxml2.h:1154
XMLError QueryFloatValue(float *value) const
See QueryIntValue.
unsigned UnsignedValue() const
Query as an unsigned integer. See IntValue()
Definition tinyxml2.h:1184
void SetAttribute(uint64_t value)
Set the attribute to value.
float FloatValue() const
Query as a float. See IntValue()
Definition tinyxml2.h:1202
XMLError QueryDoubleValue(double *value) const
See QueryIntValue.
void SetAttribute(const char *value)
Set the attribute to a string value.
XMLError QueryUnsignedValue(unsigned int *value) const
See QueryIntValue.
double DoubleValue() const
Query as a double. See IntValue()
Definition tinyxml2.h:1196
XMLError QueryInt64Value(int64_t *value) const
See QueryIntValue.
const char * Name() const
The name of the attribute.
XMLError QueryBoolValue(bool *value) const
See QueryIntValue.
XMLError QueryIntValue(int *value) const
void SetAttribute(int64_t value)
Set the attribute to value.
bool BoolValue() const
Query as a boolean. See IntValue()
Definition tinyxml2.h:1190
void SetAttribute(double value)
Set the attribute to value.
const XMLAttribute * Next() const
The next attribute in the list.
Definition tinyxml2.h:1157
const char * Value() const
The value of the attribute.
void SetAttribute(bool value)
Set the attribute to value.
void SetAttribute(int value)
Set the attribute to value.
int IntValue() const
Definition tinyxml2.h:1165
void SetAttribute(unsigned value)
Set the attribute to value.
void SetAttribute(float value)
Set the attribute to value.
XMLError QueryUnsigned64Value(uint64_t *value) const
See QueryIntValue.
Definition tinyxml2.h:1035
virtual bool Accept(XMLVisitor *visitor) const override
virtual XMLNode * ShallowClone(XMLDocument *document) const override
virtual bool ShallowEqual(const XMLNode *compare) const override
virtual XMLComment * ToComment() override
Safely cast to a Comment, or null.
Definition tinyxml2.h:1038
Definition tinyxml2.h:2138
Definition tinyxml2.h:1074
virtual XMLNode * ShallowClone(XMLDocument *document) const override
virtual bool ShallowEqual(const XMLNode *compare) const override
virtual XMLDeclaration * ToDeclaration() override
Safely cast to a Declaration, or null.
Definition tinyxml2.h:1077
virtual bool Accept(XMLVisitor *visitor) const override
Definition tinyxml2.h:1721
virtual XMLNode * ShallowClone(XMLDocument *) const override
Definition tinyxml2.h:1927
XMLElement * RootElement()
Definition tinyxml2.h:1814
void SetBOM(bool useBOM)
Definition tinyxml2.h:1807
void PrintError() const
A (trivial) utility function that prints the ErrorStr() to stdout.
virtual XMLDocument * ToDocument() override
Safely cast to a Document, or null.
Definition tinyxml2.h:1735
XMLError LoadFile(const char *filename)
bool HasBOM() const
Definition tinyxml2.h:1802
bool Error() const
Return true if there was an error parsing the document.
Definition tinyxml2.h:1885
XMLComment * NewComment(const char *comment)
XMLElement * NewElement(const char *name)
void ClearError()
Clears the error flags.
XMLUnknown * NewUnknown(const char *text)
int ErrorLineNum() const
Return the line where the error occurred, or zero if unknown.
Definition tinyxml2.h:1904
XMLDocument(bool processEntities=true, Whitespace whitespaceMode=PRESERVE_WHITESPACE)
constructor
XMLError LoadFile(FILE *)
void Clear()
Clear the document, resetting it to the initial state.
XMLError SaveFile(const char *filename, bool compact=false)
virtual bool Accept(XMLVisitor *visitor) const override
void Print(XMLPrinter *streamer=0) const
XMLError SaveFile(FILE *fp, bool compact=false)
void DeleteNode(XMLNode *node)
virtual bool ShallowEqual(const XMLNode *) const override
Definition tinyxml2.h:1930
XMLText * NewText(const char *text)
XMLDeclaration * NewDeclaration(const char *text=0)
const char * ErrorStr() const
XMLError Parse(const char *xml, size_t nBytes=static_cast< size_t >(-1))
void DeepCopy(XMLDocument *target) const
XMLError ErrorID() const
Return the errorID.
Definition tinyxml2.h:1889
Definition tinyxml2.h:1268
const char * GetText() const
double DoubleAttribute(const char *name, double defaultValue=0) const
See IntAttribute()
void SetAttribute(const char *name, const char *value)
Sets the named attribute to value.
Definition tinyxml2.h:1468
XMLError QueryInt64Text(int64_t *uval) const
See QueryIntText()
XMLError QueryUnsigned64Attribute(const char *name, uint64_t *value) const
See QueryIntAttribute()
Definition tinyxml2.h:1373
XMLError QueryBoolAttribute(const char *name, bool *value) const
See QueryIntAttribute()
Definition tinyxml2.h:1382
XMLError QueryUnsignedText(unsigned *uval) const
See QueryIntText()
const XMLAttribute * FindAttribute(const char *name) const
Query a specific attribute in the list.
void SetText(const char *inText)
uint64_t Unsigned64Attribute(const char *name, uint64_t defaultValue=0) const
See IntAttribute()
void SetAttribute(const char *name, double value)
Sets the named attribute to value.
Definition tinyxml2.h:1501
XMLError QueryUnsignedAttribute(const char *name, unsigned int *value) const
See QueryIntAttribute()
Definition tinyxml2.h:1355
XMLError QueryBoolText(bool *bval) const
See QueryIntText()
float FloatText(float defaultValue=0) const
See QueryIntText()
const char * Attribute(const char *name, const char *value=0) const
unsigned UnsignedText(unsigned defaultValue=0) const
See QueryIntText()
const XMLAttribute * FirstAttribute() const
Return the first attribute in the list.
Definition tinyxml2.h:1517
void SetText(float value)
Convenience method for setting text inside an element. See SetText() for important limitations.
bool BoolAttribute(const char *name, bool defaultValue=false) const
See IntAttribute()
void SetAttribute(const char *name, float value)
Sets the named attribute to value.
Definition tinyxml2.h:1506
XMLError QueryAttribute(const char *name, int *value) const
Definition tinyxml2.h:1435
XMLError QueryDoubleAttribute(const char *name, double *value) const
See QueryIntAttribute()
Definition tinyxml2.h:1390
int64_t Int64Attribute(const char *name, int64_t defaultValue=0) const
See IntAttribute()
void SetText(double value)
Convenience method for setting text inside an element. See SetText() for important limitations.
XMLError QueryDoubleText(double *dval) const
See QueryIntText()
bool BoolText(bool defaultValue=false) const
See QueryIntText()
virtual XMLNode * ShallowClone(XMLDocument *document) const override
void SetText(uint64_t value)
Convenience method for setting text inside an element. See SetText() for important limitations.
void SetText(int64_t value)
Convenience method for setting text inside an element. See SetText() for important limitations.
void SetText(unsigned value)
Convenience method for setting text inside an element. See SetText() for important limitations.
XMLError QueryInt64Attribute(const char *name, int64_t *value) const
See QueryIntAttribute()
Definition tinyxml2.h:1364
XMLDeclaration * InsertNewDeclaration(const char *text)
See InsertNewChildElement()
double DoubleText(double defaultValue=0) const
See QueryIntText()
virtual XMLElement * ToElement() override
Safely cast to an Element, or null.
Definition tinyxml2.h:1280
XMLError QueryIntAttribute(const char *name, int *value) const
Definition tinyxml2.h:1346
XMLError QueryIntText(int *ival) const
int IntAttribute(const char *name, int defaultValue=0) const
void SetName(const char *str, bool staticMem=false)
Set the name of the element.
Definition tinyxml2.h:1276
void SetAttribute(const char *name, bool value)
Sets the named attribute to value.
Definition tinyxml2.h:1496
int64_t Int64Text(int64_t defaultValue=0) const
See QueryIntText()
virtual bool ShallowEqual(const XMLNode *compare) const override
void SetAttribute(const char *name, int value)
Sets the named attribute to value.
Definition tinyxml2.h:1473
XMLComment * InsertNewComment(const char *comment)
See InsertNewChildElement()
void SetAttribute(const char *name, int64_t value)
Sets the named attribute to value.
Definition tinyxml2.h:1484
float FloatAttribute(const char *name, float defaultValue=0) const
See IntAttribute()
const char * Name() const
Get the name of an element (which is the Value() of the node.)
Definition tinyxml2.h:1272
XMLElement * InsertNewChildElement(const char *name)
XMLError QueryUnsigned64Text(uint64_t *uval) const
See QueryIntText()
XMLText * InsertNewText(const char *text)
See InsertNewChildElement()
virtual bool Accept(XMLVisitor *visitor) const override
XMLError QueryFloatAttribute(const char *name, float *value) const
See QueryIntAttribute()
Definition tinyxml2.h:1398
void SetAttribute(const char *name, uint64_t value)
Sets the named attribute to value.
Definition tinyxml2.h:1490
XMLError QueryStringAttribute(const char *name, const char **value) const
See QueryIntAttribute()
Definition tinyxml2.h:1407
void SetAttribute(const char *name, unsigned value)
Sets the named attribute to value.
Definition tinyxml2.h:1478
void SetText(bool value)
Convenience method for setting text inside an element. See SetText() for important limitations.
void SetText(int value)
Convenience method for setting text inside an element. See SetText() for important limitations.
void DeleteAttribute(const char *name)
uint64_t Unsigned64Text(uint64_t defaultValue=0) const
See QueryIntText()
XMLError QueryFloatText(float *fval) const
See QueryIntText()
XMLUnknown * InsertNewUnknown(const char *text)
See InsertNewChildElement()
unsigned UnsignedAttribute(const char *name, unsigned defaultValue=0) const
See IntAttribute()
Definition tinyxml2.h:2057
XMLHandle PreviousSibling()
Get the previous sibling of this handle.
Definition tinyxml2.h:2091
XMLHandle LastChildElement(const char *name=0)
Get the last child element of this handle.
Definition tinyxml2.h:2087
XMLHandle FirstChild()
Get the first child of this handle.
Definition tinyxml2.h:2075
XMLNode * ToNode()
Safe cast to XMLNode. This can return null.
Definition tinyxml2.h:2108
XMLHandle FirstChildElement(const char *name=0)
Get the first child element of this handle.
Definition tinyxml2.h:2079
XMLHandle PreviousSiblingElement(const char *name=0)
Get the previous sibling element of this handle.
Definition tinyxml2.h:2095
XMLDeclaration * ToDeclaration()
Safe cast to XMLDeclaration. This can return null.
Definition tinyxml2.h:2124
XMLHandle(XMLNode *node)
Create a handle from any node (at any depth of the tree.) This can be a null pointer.
Definition tinyxml2.h:2060
XMLHandle LastChild()
Get the last child of this handle.
Definition tinyxml2.h:2083
XMLHandle & operator=(const XMLHandle &ref)
Assignment.
Definition tinyxml2.h:2069
XMLHandle(XMLNode &node)
Create a handle from a node.
Definition tinyxml2.h:2063
XMLHandle NextSibling()
Get the next sibling of this handle.
Definition tinyxml2.h:2099
XMLElement * ToElement()
Safe cast to XMLElement. This can return null.
Definition tinyxml2.h:2112
XMLText * ToText()
Safe cast to XMLText. This can return null.
Definition tinyxml2.h:2116
XMLUnknown * ToUnknown()
Safe cast to XMLUnknown. This can return null.
Definition tinyxml2.h:2120
XMLHandle NextSiblingElement(const char *name=0)
Get the next sibling element of this handle.
Definition tinyxml2.h:2103
XMLHandle(const XMLHandle &ref)
Copy constructor.
Definition tinyxml2.h:2066
Definition tinyxml2.h:672
void SetUserData(void *userData)
Definition tinyxml2.h:942
const char * Value() const
void SetValue(const char *val, bool staticMem=false)
virtual XMLText * ToText()
Safely cast to Text, or null.
Definition tinyxml2.h:693
virtual XMLDeclaration * ToDeclaration()
Safely cast to a Declaration, or null.
Definition tinyxml2.h:705
const XMLElement * NextSiblingElement(const char *name=0) const
Get the next (right) sibling element of this node, with an optionally supplied name.
void * GetUserData() const
Definition tinyxml2.h:949
const XMLElement * FirstChildElement(const char *name=0) const
void DeleteChild(XMLNode *node)
XMLNode * DeepClone(XMLDocument *target) const
XMLDocument * GetDocument()
Get the XMLDocument that owns this XMLNode.
Definition tinyxml2.h:683
const XMLNode * Parent() const
Get the parent of this node on the DOM.
Definition tinyxml2.h:758
virtual XMLComment * ToComment()
Safely cast to a Comment, or null.
Definition tinyxml2.h:697
const XMLElement * LastChildElement(const char *name=0) const
virtual XMLDocument * ToDocument()
Safely cast to a Document, or null.
Definition tinyxml2.h:701
const XMLNode * LastChild() const
Get the last child node, or null if none exists.
Definition tinyxml2.h:790
const XMLDocument * GetDocument() const
Get the XMLDocument that owns this XMLNode.
Definition tinyxml2.h:678
virtual bool ShallowEqual(const XMLNode *compare) const =0
virtual bool Accept(XMLVisitor *visitor) const =0
virtual XMLNode * ShallowClone(XMLDocument *document) const =0
XMLNode * InsertAfterChild(XMLNode *afterThis, XMLNode *addThis)
const XMLNode * PreviousSibling() const
Get the previous (left) sibling node of this node.
Definition tinyxml2.h:808
virtual XMLElement * ToElement()
Safely cast to an Element, or null.
Definition tinyxml2.h:689
const XMLElement * PreviousSiblingElement(const char *name=0) const
Get the previous (left) sibling element of this node, with an optionally supplied name.
int GetLineNum() const
Gets the line number the node is in, if the document was parsed from a file.
Definition tinyxml2.h:755
virtual XMLUnknown * ToUnknown()
Safely cast to an Unknown, or null.
Definition tinyxml2.h:709
const XMLNode * FirstChild() const
Get the first child node, or null if none exists.
Definition tinyxml2.h:772
bool NoChildren() const
Returns true if this node has no children.
Definition tinyxml2.h:767
XMLNode * InsertFirstChild(XMLNode *addThis)
XMLNode * InsertEndChild(XMLNode *addThis)
const XMLNode * NextSibling() const
Get the next (right) sibling node of this node.
Definition tinyxml2.h:824
Definition tinyxml2.h:2242
virtual void PrintSpace(int depth)
void PushHeader(bool writeBOM, bool writeDeclaration)
void PushText(const char *text, bool cdata=false)
Add a text node.
void PushText(float value)
Add a text node from a float.
void OpenElement(const char *name, bool compactMode=false)
virtual bool VisitExit(const XMLDocument &) override
Visit a document.
Definition tinyxml2.h:2294
virtual bool Visit(const XMLUnknown &unknown) override
Visit an unknown node.
int CStrSize() const
Definition tinyxml2.h:2318
void PushText(int value)
Add a text node from an integer.
void PushText(bool value)
Add a text node from a bool.
virtual bool VisitEnter(const XMLElement &element, const XMLAttribute *attribute) override
Visit an element.
void PushText(uint64_t value)
Add a text node from an unsigned 64bit integer.
virtual bool Visit(const XMLDeclaration &declaration) override
Visit a declaration.
void PushText(unsigned value)
Add a text node from an unsigned.
void ClearBuffer(bool resetToFirstElement=true)
Definition tinyxml2.h:2325
virtual bool VisitEnter(const XMLDocument &) override
Visit a document.
virtual bool Visit(const XMLComment &comment) override
Visit a comment node.
void PushText(int64_t value)
Add a text node from a signed 64bit integer.
virtual bool VisitExit(const XMLElement &element) override
Visit an element.
void PushAttribute(const char *name, const char *value)
If streaming, add an attribute to an open element.
XMLPrinter(FILE *file=0, bool compact=false, int depth=0)
void PushText(double value)
Add a text node from a double.
const char * CStr() const
Definition tinyxml2.h:2310
virtual void CloseElement(bool compactMode=false)
If streaming, close the Element.
virtual bool Visit(const XMLText &text) override
Visit a text node.
void PushComment(const char *comment)
Add a comment.
Definition tinyxml2.h:995
virtual bool ShallowEqual(const XMLNode *compare) const override
virtual XMLText * ToText() override
Safely cast to Text, or null.
Definition tinyxml2.h:1000
virtual XMLNode * ShallowClone(XMLDocument *document) const override
virtual bool Accept(XMLVisitor *visitor) const override
bool CData() const
Returns true if this is a CDATA text element.
Definition tinyxml2.h:1012
void SetCData(bool isCData)
Declare whether this should be CDATA or standard text.
Definition tinyxml2.h:1008
Definition tinyxml2.h:1109
virtual bool ShallowEqual(const XMLNode *compare) const override
virtual XMLNode * ShallowClone(XMLDocument *document) const override
virtual XMLUnknown * ToUnknown() override
Safely cast to an Unknown, or null.
Definition tinyxml2.h:1112
virtual bool Accept(XMLVisitor *visitor) const override
Definition tinyxml2.h:479
virtual bool Visit(const XMLUnknown &)
Visit an unknown node.
Definition tinyxml2.h:514
virtual bool VisitExit(const XMLDocument &)
Visit a document.
Definition tinyxml2.h:488
virtual bool VisitExit(const XMLElement &)
Visit an element.
Definition tinyxml2.h:497
virtual bool VisitEnter(const XMLDocument &)
Visit a document.
Definition tinyxml2.h:484
virtual bool Visit(const XMLComment &)
Visit a comment node.
Definition tinyxml2.h:510
virtual bool Visit(const XMLDeclaration &)
Visit a declaration.
Definition tinyxml2.h:502
virtual bool Visit(const XMLText &)
Visit a text node.
Definition tinyxml2.h:506
virtual bool VisitEnter(const XMLElement &, const XMLAttribute *)
Visit an element.
Definition tinyxml2.h:493