tinyxml.h
上传用户:shhsgm
上传日期:2013-12-24
资源大小:95k
文件大小:53k
源码类别:

xml/soap/webservice

开发平台:

Visual C++

  1. /*
  2. www.sourceforge.net/projects/tinyxml
  3. Original code (2.0 and earlier )copyright (c) 2000-2002 Lee Thomason (www.grinninglizard.com)
  4. This software is provided 'as-is', without any express or implied
  5. warranty. In no event will the authors be held liable for any
  6. damages arising from the use of this software.
  7. Permission is granted to anyone to use this software for any
  8. purpose, including commercial applications, and to alter it and
  9. redistribute it freely, subject to the following restrictions:
  10. 1. The origin of this software must not be misrepresented; you must
  11. not claim that you wrote the original software. If you use this
  12. software in a product, an acknowledgment in the product documentation
  13. would be appreciated but is not required.
  14. 2. Altered source versions must be plainly marked as such, and
  15. must not be misrepresented as being the original software.
  16. 3. This notice may not be removed or altered from any source
  17. distribution.
  18. */
  19. #ifndef TINYXML_INCLUDED
  20. #define TINYXML_INCLUDED
  21. #ifdef _MSC_VER
  22. #pragma warning( push )
  23. #pragma warning( disable : 4530 )
  24. #pragma warning( disable : 4786 )
  25. #endif
  26. #include <ctype.h>
  27. #include <stdio.h>
  28. #include <stdlib.h>
  29. #include <string.h>
  30. #include <assert.h>
  31. // Help out windows:
  32. #if defined( _DEBUG ) && !defined( DEBUG )
  33. #define DEBUG
  34. #endif
  35. #ifdef TIXML_USE_STL
  36. #include <string>
  37.   #include <iostream>
  38. #define TIXML_STRING std::string
  39. #define TIXML_ISTREAM std::istream
  40. #define TIXML_OSTREAM std::ostream
  41. #else
  42. #include "tinystr.h"
  43. #define TIXML_STRING TiXmlString
  44. #define TIXML_OSTREAM TiXmlOutStream
  45. #endif
  46. // Deprecated library function hell. Compilers want to use the
  47. // new safe versions. This probably doesn't fully address the problem,
  48. // but it gets closer. There are too many compilers for me to fully
  49. // test. If you get compilation troubles, undefine TIXML_SAFE
  50. #define TIXML_SAFE // TinyXml isn't fully buffer overrun protected, safe code. This is work in progress.
  51. #ifdef TIXML_SAFE
  52. #if defined(_MSC_VER) && (_MSC_VER >= 1400 )
  53. // Microsoft visual studio, version 2005 and higher.
  54. #define TIXML_SNPRINTF _snprintf_s
  55. #define TIXML_SNSCANF  _snscanf_s
  56. #elif defined(_MSC_VER) && (_MSC_VER >= 1200 )
  57. // Microsoft visual studio, version 6 and higher.
  58. //#pragma message( "Using _sn* functions." )
  59. #define TIXML_SNPRINTF _snprintf
  60. #define TIXML_SNSCANF  _snscanf
  61. #elif defined(__GNUC__) && (__GNUC__ >= 3 )
  62. // GCC version 3 and higher.s
  63. //#warning( "Using sn* functions." )
  64. #define TIXML_SNPRINTF snprintf
  65. #define TIXML_SNSCANF  snscanf
  66. #endif
  67. #endif
  68. class TiXmlDocument;
  69. class TiXmlElement;
  70. class TiXmlComment;
  71. class TiXmlUnknown;
  72. class TiXmlAttribute;
  73. class TiXmlText;
  74. class TiXmlDeclaration;
  75. class TiXmlParsingData;
  76. const int TIXML_MAJOR_VERSION = 2;
  77. const int TIXML_MINOR_VERSION = 4;
  78. const int TIXML_PATCH_VERSION = 3;
  79. /* Internal structure for tracking location of items 
  80. in the XML file.
  81. */
  82. struct TiXmlCursor
  83. {
  84. TiXmlCursor() { Clear(); }
  85. void Clear() { row = col = -1; }
  86. int row; // 0 based.
  87. int col; // 0 based.
  88. };
  89. // Only used by Attribute::Query functions
  90. enum 
  91. TIXML_SUCCESS,
  92. TIXML_NO_ATTRIBUTE,
  93. TIXML_WRONG_TYPE
  94. };
  95. // Used by the parsing routines.
  96. enum TiXmlEncoding
  97. {
  98. TIXML_ENCODING_UNKNOWN,
  99. TIXML_ENCODING_UTF8,
  100. TIXML_ENCODING_LEGACY
  101. };
  102. const TiXmlEncoding TIXML_DEFAULT_ENCODING = TIXML_ENCODING_UNKNOWN;
  103. /** TiXmlBase is a base class for every class in TinyXml.
  104. It does little except to establish that TinyXml classes
  105. can be printed and provide some utility functions.
  106. In XML, the document and elements can contain
  107. other elements and other types of nodes.
  108. @verbatim
  109. A Document can contain: Element (container or leaf)
  110. Comment (leaf)
  111. Unknown (leaf)
  112. Declaration( leaf )
  113. An Element can contain: Element (container or leaf)
  114. Text (leaf)
  115. Attributes (not on tree)
  116. Comment (leaf)
  117. Unknown (leaf)
  118. A Decleration contains: Attributes (not on tree)
  119. @endverbatim
  120. */
  121. class TiXmlBase
  122. {
  123. friend class TiXmlNode;
  124. friend class TiXmlElement;
  125. friend class TiXmlDocument;
  126. public:
  127. TiXmlBase() : userData(0) {}
  128. virtual ~TiXmlBase() {}
  129. /** All TinyXml classes can print themselves to a filestream.
  130. This is a formatted print, and will insert tabs and newlines.
  131. (For an unformatted stream, use the << operator.)
  132. */
  133. virtual void Print( FILE* cfile, int depth ) const = 0;
  134. /** The world does not agree on whether white space should be kept or
  135. not. In order to make everyone happy, these global, static functions
  136. are provided to set whether or not TinyXml will condense all white space
  137. into a single space or not. The default is to condense. Note changing this
  138. values is not thread safe.
  139. */
  140. static void SetCondenseWhiteSpace( bool condense ) { condenseWhiteSpace = condense; }
  141. /// Return the current white space setting.
  142. static bool IsWhiteSpaceCondensed() { return condenseWhiteSpace; }
  143. /** Return the position, in the original source file, of this node or attribute.
  144. The row and column are 1-based. (That is the first row and first column is
  145. 1,1). If the returns values are 0 or less, then the parser does not have
  146. a row and column value.
  147. Generally, the row and column value will be set when the TiXmlDocument::Load(),
  148. TiXmlDocument::LoadFile(), or any TiXmlNode::Parse() is called. It will NOT be set
  149. when the DOM was created from operator>>.
  150. The values reflect the initial load. Once the DOM is modified programmatically
  151. (by adding or changing nodes and attributes) the new values will NOT update to
  152. reflect changes in the document.
  153. There is a minor performance cost to computing the row and column. Computation
  154. can be disabled if TiXmlDocument::SetTabSize() is called with 0 as the value.
  155. @sa TiXmlDocument::SetTabSize()
  156. */
  157. int Row() const { return location.row + 1; }
  158. int Column() const { return location.col + 1; } ///< See Row()
  159. void  SetUserData( void* user ) { userData = user; }
  160. void* GetUserData() { return userData; }
  161. // Table that returs, for a given lead byte, the total number of bytes
  162. // in the UTF-8 sequence.
  163. static const int utf8ByteTable[256];
  164. virtual const char* Parse( const char* p, 
  165. TiXmlParsingData* data, 
  166. TiXmlEncoding encoding /*= TIXML_ENCODING_UNKNOWN */ ) = 0;
  167. enum
  168. {
  169. TIXML_NO_ERROR = 0,
  170. TIXML_ERROR,
  171. TIXML_ERROR_OPENING_FILE,
  172. TIXML_ERROR_OUT_OF_MEMORY,
  173. TIXML_ERROR_PARSING_ELEMENT,
  174. TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME,
  175. TIXML_ERROR_READING_ELEMENT_VALUE,
  176. TIXML_ERROR_READING_ATTRIBUTES,
  177. TIXML_ERROR_PARSING_EMPTY,
  178. TIXML_ERROR_READING_END_TAG,
  179. TIXML_ERROR_PARSING_UNKNOWN,
  180. TIXML_ERROR_PARSING_COMMENT,
  181. TIXML_ERROR_PARSING_DECLARATION,
  182. TIXML_ERROR_DOCUMENT_EMPTY,
  183. TIXML_ERROR_EMBEDDED_NULL,
  184. TIXML_ERROR_PARSING_CDATA,
  185. TIXML_ERROR_STRING_COUNT
  186. };
  187. protected:
  188. // See STL_STRING_BUG
  189. // Utility class to overcome a bug.
  190. class StringToBuffer
  191. {
  192.   public:
  193. StringToBuffer( const TIXML_STRING& str );
  194. ~StringToBuffer();
  195. char* buffer;
  196. };
  197. static const char* SkipWhiteSpace( const char*, TiXmlEncoding encoding );
  198. inline static bool IsWhiteSpace( char c )
  199. return ( isspace( (unsigned char) c ) || c == 'n' || c == 'r' ); 
  200. }
  201. inline static bool IsWhiteSpace( int c )
  202. {
  203. if ( c < 256 )
  204. return IsWhiteSpace( (char) c );
  205. return false; // Again, only truly correct for English/Latin...but usually works.
  206. }
  207. virtual void StreamOut (TIXML_OSTREAM *) const = 0;
  208. #ifdef TIXML_USE_STL
  209.     static bool StreamWhiteSpace( TIXML_ISTREAM * in, TIXML_STRING * tag );
  210.     static bool StreamTo( TIXML_ISTREAM * in, int character, TIXML_STRING * tag );
  211. #endif
  212. /* Reads an XML name into the string provided. Returns
  213. a pointer just past the last character of the name,
  214. or 0 if the function has an error.
  215. */
  216. static const char* ReadName( const char* p, TIXML_STRING* name, TiXmlEncoding encoding );
  217. /* Reads text. Returns a pointer past the given end tag.
  218. Wickedly complex options, but it keeps the (sensitive) code in one place.
  219. */
  220. static const char* ReadText( const char* in, // where to start
  221. TIXML_STRING* text, // the string read
  222. bool ignoreWhiteSpace, // whether to keep the white space
  223. const char* endTag, // what ends this text
  224. bool ignoreCase, // whether to ignore case in the end tag
  225. TiXmlEncoding encoding ); // the current encoding
  226. // If an entity has been found, transform it into a character.
  227. static const char* GetEntity( const char* in, char* value, int* length, TiXmlEncoding encoding );
  228. // Get a character, while interpreting entities.
  229. // The length can be from 0 to 4 bytes.
  230. inline static const char* GetChar( const char* p, char* _value, int* length, TiXmlEncoding encoding )
  231. {
  232. assert( p );
  233. if ( encoding == TIXML_ENCODING_UTF8 )
  234. {
  235. *length = utf8ByteTable[ *((unsigned char*)p) ];
  236. assert( *length >= 0 && *length < 5 );
  237. }
  238. else
  239. {
  240. *length = 1;
  241. }
  242. if ( *length == 1 )
  243. {
  244. if ( *p == '&' )
  245. return GetEntity( p, _value, length, encoding );
  246. *_value = *p;
  247. return p+1;
  248. }
  249. else if ( *length )
  250. {
  251. //strncpy( _value, p, *length ); // lots of compilers don't like this function (unsafe),
  252. // and the null terminator isn't needed
  253. for( int i=0; p[i] && i<*length; ++i ) {
  254. _value[i] = p[i];
  255. }
  256. return p + (*length);
  257. }
  258. else
  259. {
  260. // Not valid text.
  261. return 0;
  262. }
  263. }
  264. // Puts a string to a stream, expanding entities as it goes.
  265. // Note this should not contian the '<', '>', etc, or they will be transformed into entities!
  266. static void PutString( const TIXML_STRING& str, TIXML_OSTREAM* out );
  267. static void PutString( const TIXML_STRING& str, TIXML_STRING* out );
  268. // Return true if the next characters in the stream are any of the endTag sequences.
  269. // Ignore case only works for english, and should only be relied on when comparing
  270. // to English words: StringEqual( p, "version", true ) is fine.
  271. static bool StringEqual( const char* p,
  272. const char* endTag,
  273. bool ignoreCase,
  274. TiXmlEncoding encoding );
  275. static const char* errorString[ TIXML_ERROR_STRING_COUNT ];
  276. TiXmlCursor location;
  277.     /// Field containing a generic user pointer
  278. void* userData;
  279. // None of these methods are reliable for any language except English.
  280. // Good for approximation, not great for accuracy.
  281. static int IsAlpha( unsigned char anyByte, TiXmlEncoding encoding );
  282. static int IsAlphaNum( unsigned char anyByte, TiXmlEncoding encoding );
  283. inline static int ToLower( int v, TiXmlEncoding encoding )
  284. {
  285. if ( encoding == TIXML_ENCODING_UTF8 )
  286. {
  287. if ( v < 128 ) return tolower( v );
  288. return v;
  289. }
  290. else
  291. {
  292. return tolower( v );
  293. }
  294. }
  295. static void ConvertUTF32ToUTF8( unsigned long input, char* output, int* length );
  296. private:
  297. TiXmlBase( const TiXmlBase& ); // not implemented.
  298. void operator=( const TiXmlBase& base ); // not allowed.
  299. struct Entity
  300. {
  301. const char*     str;
  302. unsigned int strLength;
  303. char     chr;
  304. };
  305. enum
  306. {
  307. NUM_ENTITY = 5,
  308. MAX_ENTITY_LENGTH = 6
  309. };
  310. static Entity entity[ NUM_ENTITY ];
  311. static bool condenseWhiteSpace;
  312. };
  313. /** The parent class for everything in the Document Object Model.
  314. (Except for attributes).
  315. Nodes have siblings, a parent, and children. A node can be
  316. in a document, or stand on its own. The type of a TiXmlNode
  317. can be queried, and it can be cast to its more defined type.
  318. */
  319. class TiXmlNode : public TiXmlBase
  320. {
  321. friend class TiXmlDocument;
  322. friend class TiXmlElement;
  323. public:
  324. #ifdef TIXML_USE_STL
  325.     /** An input stream operator, for every class. Tolerant of newlines and
  326.     formatting, but doesn't expect them.
  327.     */
  328.     friend std::istream& operator >> (std::istream& in, TiXmlNode& base);
  329.     /** An output stream operator, for every class. Note that this outputs
  330.     without any newlines or formatting, as opposed to Print(), which
  331.     includes tabs and new lines.
  332.     The operator<< and operator>> are not completely symmetric. Writing
  333.     a node to a stream is very well defined. You'll get a nice stream
  334.     of output, without any extra whitespace or newlines.
  335.     
  336.     But reading is not as well defined. (As it always is.) If you create
  337.     a TiXmlElement (for example) and read that from an input stream,
  338.     the text needs to define an element or junk will result. This is
  339.     true of all input streams, but it's worth keeping in mind.
  340.     A TiXmlDocument will read nodes until it reads a root element, and
  341. all the children of that root element.
  342.     */
  343.     friend std::ostream& operator<< (std::ostream& out, const TiXmlNode& base);
  344. /// Appends the XML node or attribute to a std::string.
  345. friend std::string& operator<< (std::string& out, const TiXmlNode& base );
  346. #else
  347.     // Used internally, not part of the public API.
  348.     friend TIXML_OSTREAM& operator<< (TIXML_OSTREAM& out, const TiXmlNode& base);
  349. #endif
  350. /** The types of XML nodes supported by TinyXml. (All the
  351. unsupported types are picked up by UNKNOWN.)
  352. */
  353. enum NodeType
  354. {
  355. DOCUMENT,
  356. ELEMENT,
  357. COMMENT,
  358. UNKNOWN,
  359. TEXT,
  360. DECLARATION,
  361. TYPECOUNT
  362. };
  363. virtual ~TiXmlNode();
  364. /** The meaning of 'value' changes for the specific type of
  365. TiXmlNode.
  366. @verbatim
  367. Document: filename of the xml file
  368. Element: name of the element
  369. Comment: the comment text
  370. Unknown: the tag contents
  371. Text: the text string
  372. @endverbatim
  373. The subclasses will wrap this function.
  374. */
  375. const char *Value() const { return value.c_str (); }
  376.     #ifdef TIXML_USE_STL
  377. /** Return Value() as a std::string. If you only use STL,
  378.     this is more efficient than calling Value().
  379. Only available in STL mode.
  380. */
  381. const std::string& ValueStr() const { return value; }
  382. #endif
  383. /** Changes the value of the node. Defined as:
  384. @verbatim
  385. Document: filename of the xml file
  386. Element: name of the element
  387. Comment: the comment text
  388. Unknown: the tag contents
  389. Text: the text string
  390. @endverbatim
  391. */
  392. void SetValue(const char * _value) { value = _value;}
  393.     #ifdef TIXML_USE_STL
  394. /// STL std::string form.
  395. void SetValue( const std::string& _value ) { value = _value; }
  396. #endif
  397. /// Delete all the children of this node. Does not affect 'this'.
  398. void Clear();
  399. /// One step up the DOM.
  400. TiXmlNode* Parent() { return parent; }
  401. const TiXmlNode* Parent() const { return parent; }
  402. const TiXmlNode* FirstChild() const { return firstChild; } ///< The first child of this node. Will be null if there are no children.
  403. TiXmlNode* FirstChild() { return firstChild; }
  404. const TiXmlNode* FirstChild( const char * value ) const; ///< The first child of this node with the matching 'value'. Will be null if none found.
  405. TiXmlNode* FirstChild( const char * value ); ///< The first child of this node with the matching 'value'. Will be null if none found.
  406. const TiXmlNode* LastChild() const { return lastChild; } /// The last child of this node. Will be null if there are no children.
  407. TiXmlNode* LastChild() { return lastChild; }
  408. const TiXmlNode* LastChild( const char * value ) const; /// The last child of this node matching 'value'. Will be null if there are no children.
  409. TiXmlNode* LastChild( const char * value );
  410.     #ifdef TIXML_USE_STL
  411. const TiXmlNode* FirstChild( const std::string& _value ) const { return FirstChild (_value.c_str ()); } ///< STL std::string form.
  412. TiXmlNode* FirstChild( const std::string& _value ) { return FirstChild (_value.c_str ()); } ///< STL std::string form.
  413. const TiXmlNode* LastChild( const std::string& _value ) const { return LastChild (_value.c_str ()); } ///< STL std::string form.
  414. TiXmlNode* LastChild( const std::string& _value ) { return LastChild (_value.c_str ()); } ///< STL std::string form.
  415. #endif
  416. /** An alternate way to walk the children of a node.
  417. One way to iterate over nodes is:
  418. @verbatim
  419. for( child = parent->FirstChild(); child; child = child->NextSibling() )
  420. @endverbatim
  421. IterateChildren does the same thing with the syntax:
  422. @verbatim
  423. child = 0;
  424. while( child = parent->IterateChildren( child ) )
  425. @endverbatim
  426. IterateChildren takes the previous child as input and finds
  427. the next one. If the previous child is null, it returns the
  428. first. IterateChildren will return null when done.
  429. */
  430. const TiXmlNode* IterateChildren( const TiXmlNode* previous ) const;
  431. TiXmlNode* IterateChildren( TiXmlNode* previous );
  432. /// This flavor of IterateChildren searches for children with a particular 'value'
  433. const TiXmlNode* IterateChildren( const char * value, const TiXmlNode* previous ) const;
  434. TiXmlNode* IterateChildren( const char * value, TiXmlNode* previous );
  435.     #ifdef TIXML_USE_STL
  436. const TiXmlNode* IterateChildren( const std::string& _value, const TiXmlNode* previous ) const { return IterateChildren (_value.c_str (), previous); } ///< STL std::string form.
  437. TiXmlNode* IterateChildren( const std::string& _value, TiXmlNode* previous ) { return IterateChildren (_value.c_str (), previous); } ///< STL std::string form.
  438. #endif
  439. /** Add a new node related to this. Adds a child past the LastChild.
  440. Returns a pointer to the new object or NULL if an error occured.
  441. */
  442. TiXmlNode* InsertEndChild( const TiXmlNode& addThis );
  443. /** Add a new node related to this. Adds a child past the LastChild.
  444. NOTE: the node to be added is passed by pointer, and will be
  445. henceforth owned (and deleted) by tinyXml. This method is efficient
  446. and avoids an extra copy, but should be used with care as it
  447. uses a different memory model than the other insert functions.
  448. @sa InsertEndChild
  449. */
  450. TiXmlNode* LinkEndChild( TiXmlNode* addThis );
  451. /** Add a new node related to this. Adds a child before the specified child.
  452. Returns a pointer to the new object or NULL if an error occured.
  453. */
  454. TiXmlNode* InsertBeforeChild( TiXmlNode* beforeThis, const TiXmlNode& addThis );
  455. /** Add a new node related to this. Adds a child after the specified child.
  456. Returns a pointer to the new object or NULL if an error occured.
  457. */
  458. TiXmlNode* InsertAfterChild(  TiXmlNode* afterThis, const TiXmlNode& addThis );
  459. /** Replace a child of this node.
  460. Returns a pointer to the new object or NULL if an error occured.
  461. */
  462. TiXmlNode* ReplaceChild( TiXmlNode* replaceThis, const TiXmlNode& withThis );
  463. /// Delete a child of this node.
  464. bool RemoveChild( TiXmlNode* removeThis );
  465. /// Navigate to a sibling node.
  466. const TiXmlNode* PreviousSibling() const { return prev; }
  467. TiXmlNode* PreviousSibling() { return prev; }
  468. /// Navigate to a sibling node.
  469. const TiXmlNode* PreviousSibling( const char * ) const;
  470. TiXmlNode* PreviousSibling( const char * );
  471.     #ifdef TIXML_USE_STL
  472. const TiXmlNode* PreviousSibling( const std::string& _value ) const { return PreviousSibling (_value.c_str ()); } ///< STL std::string form.
  473. TiXmlNode* PreviousSibling( const std::string& _value )  { return PreviousSibling (_value.c_str ()); } ///< STL std::string form.
  474. const TiXmlNode* NextSibling( const std::string& _value) const { return NextSibling (_value.c_str ()); } ///< STL std::string form.
  475. TiXmlNode* NextSibling( const std::string& _value)  { return NextSibling (_value.c_str ()); } ///< STL std::string form.
  476. #endif
  477. /// Navigate to a sibling node.
  478. const TiXmlNode* NextSibling() const { return next; }
  479. TiXmlNode* NextSibling() { return next; }
  480. /// Navigate to a sibling node with the given 'value'.
  481. const TiXmlNode* NextSibling( const char * ) const;
  482. TiXmlNode* NextSibling( const char * );
  483. /** Convenience function to get through elements.
  484. Calls NextSibling and ToElement. Will skip all non-Element
  485. nodes. Returns 0 if there is not another element.
  486. */
  487. const TiXmlElement* NextSiblingElement() const;
  488. TiXmlElement* NextSiblingElement();
  489. /** Convenience function to get through elements.
  490. Calls NextSibling and ToElement. Will skip all non-Element
  491. nodes. Returns 0 if there is not another element.
  492. */
  493. const TiXmlElement* NextSiblingElement( const char * ) const;
  494. TiXmlElement* NextSiblingElement( const char * );
  495.     #ifdef TIXML_USE_STL
  496. const TiXmlElement* NextSiblingElement( const std::string& _value) const { return NextSiblingElement (_value.c_str ()); } ///< STL std::string form.
  497. TiXmlElement* NextSiblingElement( const std::string& _value) { return NextSiblingElement (_value.c_str ()); } ///< STL std::string form.
  498. #endif
  499. /// Convenience function to get through elements.
  500. const TiXmlElement* FirstChildElement() const;
  501. TiXmlElement* FirstChildElement();
  502. /// Convenience function to get through elements.
  503. const TiXmlElement* FirstChildElement( const char * value ) const;
  504. TiXmlElement* FirstChildElement( const char * value );
  505.     #ifdef TIXML_USE_STL
  506. const TiXmlElement* FirstChildElement( const std::string& _value ) const { return FirstChildElement (_value.c_str ()); } ///< STL std::string form.
  507. TiXmlElement* FirstChildElement( const std::string& _value ) { return FirstChildElement (_value.c_str ()); } ///< STL std::string form.
  508. #endif
  509. /** Query the type (as an enumerated value, above) of this node.
  510. The possible types are: DOCUMENT, ELEMENT, COMMENT,
  511. UNKNOWN, TEXT, and DECLARATION.
  512. */
  513. int Type() const { return type; }
  514. /** Return a pointer to the Document this node lives in.
  515. Returns null if not in a document.
  516. */
  517. const TiXmlDocument* GetDocument() const;
  518. TiXmlDocument* GetDocument();
  519. /// Returns true if this node has no children.
  520. bool NoChildren() const { return !firstChild; }
  521. virtual const TiXmlDocument*    ToDocument()    const { return 0; } ///< Cast to a more defined type. Will return null if not of the requested type.
  522. virtual const TiXmlElement*     ToElement()     const { return 0; } ///< Cast to a more defined type. Will return null if not of the requested type.
  523. virtual const TiXmlComment*     ToComment()     const { return 0; } ///< Cast to a more defined type. Will return null if not of the requested type.
  524. virtual const TiXmlUnknown*     ToUnknown()     const { return 0; } ///< Cast to a more defined type. Will return null if not of the requested type.
  525. virtual const TiXmlText*        ToText()        const { return 0; } ///< Cast to a more defined type. Will return null if not of the requested type.
  526. virtual const TiXmlDeclaration* ToDeclaration() const { return 0; } ///< Cast to a more defined type. Will return null if not of the requested type.
  527. virtual TiXmlDocument*          ToDocument()    { return 0; } ///< Cast to a more defined type. Will return null if not of the requested type.
  528. virtual TiXmlElement*           ToElement()     { return 0; } ///< Cast to a more defined type. Will return null if not of the requested type.
  529. virtual TiXmlComment*           ToComment()     { return 0; } ///< Cast to a more defined type. Will return null if not of the requested type.
  530. virtual TiXmlUnknown*           ToUnknown()     { return 0; } ///< Cast to a more defined type. Will return null if not of the requested type.
  531. virtual TiXmlText*             ToText()        { return 0; } ///< Cast to a more defined type. Will return null if not of the requested type.
  532. virtual TiXmlDeclaration*       ToDeclaration() { return 0; } ///< Cast to a more defined type. Will return null if not of the requested type.
  533. /** Create an exact duplicate of this node and return it. The memory must be deleted
  534. by the caller. 
  535. */
  536. virtual TiXmlNode* Clone() const = 0;
  537. protected:
  538. TiXmlNode( NodeType _type );
  539. // Copy to the allocated object. Shared functionality between Clone, Copy constructor,
  540. // and the assignment operator.
  541. void CopyTo( TiXmlNode* target ) const;
  542. #ifdef TIXML_USE_STL
  543.     // The real work of the input operator.
  544.     virtual void StreamIn( TIXML_ISTREAM* in, TIXML_STRING* tag ) = 0;
  545. #endif
  546. // Figure out what is at *p, and parse it. Returns null if it is not an xml node.
  547. TiXmlNode* Identify( const char* start, TiXmlEncoding encoding );
  548. TiXmlNode* parent;
  549. NodeType type;
  550. TiXmlNode* firstChild;
  551. TiXmlNode* lastChild;
  552. TIXML_STRING value;
  553. TiXmlNode* prev;
  554. TiXmlNode* next;
  555. private:
  556. TiXmlNode( const TiXmlNode& ); // not implemented.
  557. void operator=( const TiXmlNode& base ); // not allowed.
  558. };
  559. /** An attribute is a name-value pair. Elements have an arbitrary
  560. number of attributes, each with a unique name.
  561. @note The attributes are not TiXmlNodes, since they are not
  562.   part of the tinyXML document object model. There are other
  563.   suggested ways to look at this problem.
  564. */
  565. class TiXmlAttribute : public TiXmlBase
  566. {
  567. friend class TiXmlAttributeSet;
  568. public:
  569. /// Construct an empty attribute.
  570. TiXmlAttribute() : TiXmlBase()
  571. {
  572. document = 0;
  573. prev = next = 0;
  574. }
  575. #ifdef TIXML_USE_STL
  576. /// std::string constructor.
  577. TiXmlAttribute( const std::string& _name, const std::string& _value )
  578. {
  579. name = _name;
  580. value = _value;
  581. document = 0;
  582. prev = next = 0;
  583. }
  584. #endif
  585. /// Construct an attribute with a name and value.
  586. TiXmlAttribute( const char * _name, const char * _value )
  587. {
  588. name = _name;
  589. value = _value;
  590. document = 0;
  591. prev = next = 0;
  592. }
  593. const char* Name()  const { return name.c_str (); } ///< Return the name of this attribute.
  594. const char* Value() const { return value.c_str (); } ///< Return the value of this attribute.
  595. int IntValue() const; ///< Return the value of this attribute, converted to an integer.
  596. double DoubleValue() const; ///< Return the value of this attribute, converted to a double.
  597. // Get the tinyxml string representation
  598. const TIXML_STRING& NameTStr() const { return name; }
  599. /** QueryIntValue examines the value string. It is an alternative to the
  600. IntValue() method with richer error checking.
  601. If the value is an integer, it is stored in 'value' and 
  602. the call returns TIXML_SUCCESS. If it is not
  603. an integer, it returns TIXML_WRONG_TYPE.
  604. A specialized but useful call. Note that for success it returns 0,
  605. which is the opposite of almost all other TinyXml calls.
  606. */
  607. int QueryIntValue( int* _value ) const;
  608. /// QueryDoubleValue examines the value string. See QueryIntValue().
  609. int QueryDoubleValue( double* _value ) const;
  610. void SetName( const char* _name ) { name = _name; } ///< Set the name of this attribute.
  611. void SetValue( const char* _value ) { value = _value; } ///< Set the value.
  612. void SetIntValue( int _value ); ///< Set the value from an integer.
  613. void SetDoubleValue( double _value ); ///< Set the value from a double.
  614.     #ifdef TIXML_USE_STL
  615. /// STL std::string form.
  616. void SetName( const std::string& _name ) { name = _name; }
  617. /// STL std::string form.
  618. void SetValue( const std::string& _value ) { value = _value; }
  619. #endif
  620. /// Get the next sibling attribute in the DOM. Returns null at end.
  621. const TiXmlAttribute* Next() const;
  622. TiXmlAttribute* Next();
  623. /// Get the previous sibling attribute in the DOM. Returns null at beginning.
  624. const TiXmlAttribute* Previous() const;
  625. TiXmlAttribute* Previous();
  626. bool operator==( const TiXmlAttribute& rhs ) const { return rhs.name == name; }
  627. bool operator<( const TiXmlAttribute& rhs )  const { return name < rhs.name; }
  628. bool operator>( const TiXmlAttribute& rhs )  const { return name > rhs.name; }
  629. /* Attribute parsing starts: first letter of the name
  630.  returns: the next char after the value end quote
  631. */
  632. virtual const char* Parse( const char* p, TiXmlParsingData* data, TiXmlEncoding encoding );
  633. // Prints this Attribute to a FILE stream.
  634. virtual void Print( FILE* cfile, int depth ) const;
  635. virtual void StreamOut( TIXML_OSTREAM * out ) const;
  636. // [internal use]
  637. // Set the document pointer so the attribute can report errors.
  638. void SetDocument( TiXmlDocument* doc ) { document = doc; }
  639. private:
  640. TiXmlAttribute( const TiXmlAttribute& ); // not implemented.
  641. void operator=( const TiXmlAttribute& base ); // not allowed.
  642. TiXmlDocument* document; // A pointer back to a document, for error reporting.
  643. TIXML_STRING name;
  644. TIXML_STRING value;
  645. TiXmlAttribute* prev;
  646. TiXmlAttribute* next;
  647. };
  648. /* A class used to manage a group of attributes.
  649. It is only used internally, both by the ELEMENT and the DECLARATION.
  650. The set can be changed transparent to the Element and Declaration
  651. classes that use it, but NOT transparent to the Attribute
  652. which has to implement a next() and previous() method. Which makes
  653. it a bit problematic and prevents the use of STL.
  654. This version is implemented with circular lists because:
  655. - I like circular lists
  656. - it demonstrates some independence from the (typical) doubly linked list.
  657. */
  658. class TiXmlAttributeSet
  659. {
  660. public:
  661. TiXmlAttributeSet();
  662. ~TiXmlAttributeSet();
  663. void Add( TiXmlAttribute* attribute );
  664. void Remove( TiXmlAttribute* attribute );
  665. const TiXmlAttribute* First() const { return ( sentinel.next == &sentinel ) ? 0 : sentinel.next; }
  666. TiXmlAttribute* First() { return ( sentinel.next == &sentinel ) ? 0 : sentinel.next; }
  667. const TiXmlAttribute* Last() const { return ( sentinel.prev == &sentinel ) ? 0 : sentinel.prev; }
  668. TiXmlAttribute* Last() { return ( sentinel.prev == &sentinel ) ? 0 : sentinel.prev; }
  669. const TiXmlAttribute* Find( const TIXML_STRING& name ) const;
  670. TiXmlAttribute* Find( const TIXML_STRING& name );
  671. private:
  672. //*ME: Because of hidden/disabled copy-construktor in TiXmlAttribute (sentinel-element),
  673. //*ME: this class must be also use a hidden/disabled copy-constructor !!!
  674. TiXmlAttributeSet( const TiXmlAttributeSet& ); // not allowed
  675. void operator=( const TiXmlAttributeSet& ); // not allowed (as TiXmlAttribute)
  676. TiXmlAttribute sentinel;
  677. };
  678. /** The element is a container class. It has a value, the element name,
  679. and can contain other elements, text, comments, and unknowns.
  680. Elements also contain an arbitrary number of attributes.
  681. */
  682. class TiXmlElement : public TiXmlNode
  683. {
  684. public:
  685. /// Construct an element.
  686. TiXmlElement (const char * in_value);
  687. #ifdef TIXML_USE_STL
  688. /// std::string constructor.
  689. TiXmlElement( const std::string& _value );
  690. #endif
  691. TiXmlElement( const TiXmlElement& );
  692. void operator=( const TiXmlElement& base );
  693. virtual ~TiXmlElement();
  694. /** Given an attribute name, Attribute() returns the value
  695. for the attribute of that name, or null if none exists.
  696. */
  697. const char* Attribute( const char* name ) const;
  698. /** Given an attribute name, Attribute() returns the value
  699. for the attribute of that name, or null if none exists.
  700. If the attribute exists and can be converted to an integer,
  701. the integer value will be put in the return 'i', if 'i'
  702. is non-null.
  703. */
  704. const char* Attribute( const char* name, int* i ) const;
  705. /** Given an attribute name, Attribute() returns the value
  706. for the attribute of that name, or null if none exists.
  707. If the attribute exists and can be converted to an double,
  708. the double value will be put in the return 'd', if 'd'
  709. is non-null.
  710. */
  711. const char* Attribute( const char* name, double* d ) const;
  712. /** QueryIntAttribute examines the attribute - it is an alternative to the
  713. Attribute() method with richer error checking.
  714. If the attribute is an integer, it is stored in 'value' and 
  715. the call returns TIXML_SUCCESS. If it is not
  716. an integer, it returns TIXML_WRONG_TYPE. If the attribute
  717. does not exist, then TIXML_NO_ATTRIBUTE is returned.
  718. */
  719. int QueryIntAttribute( const char* name, int* _value ) const;
  720. /// QueryDoubleAttribute examines the attribute - see QueryIntAttribute().
  721. int QueryDoubleAttribute( const char* name, double* _value ) const;
  722. /// QueryFloatAttribute examines the attribute - see QueryIntAttribute().
  723. int QueryFloatAttribute( const char* name, float* _value ) const {
  724. double d;
  725. int result = QueryDoubleAttribute( name, &d );
  726. if ( result == TIXML_SUCCESS ) {
  727. *_value = (float)d;
  728. }
  729. return result;
  730. }
  731. /** Sets an attribute of name to a given value. The attribute
  732. will be created if it does not exist, or changed if it does.
  733. */
  734. void SetAttribute( const char* name, const char * _value );
  735.     #ifdef TIXML_USE_STL
  736. const char* Attribute( const std::string& name ) const { return Attribute( name.c_str() ); }
  737. const char* Attribute( const std::string& name, int* i ) const { return Attribute( name.c_str(), i ); }
  738. const char* Attribute( const std::string& name, double* d ) const { return Attribute( name.c_str(), d ); }
  739. int QueryIntAttribute( const std::string& name, int* _value ) const { return QueryIntAttribute( name.c_str(), _value ); }
  740. int QueryDoubleAttribute( const std::string& name, double* _value ) const { return QueryDoubleAttribute( name.c_str(), _value ); }
  741. /// STL std::string form.
  742. void SetAttribute( const std::string& name, const std::string& _value );
  743. ///< STL std::string form.
  744. void SetAttribute( const std::string& name, int _value );
  745. #endif
  746. /** Sets an attribute of name to a given value. The attribute
  747. will be created if it does not exist, or changed if it does.
  748. */
  749. void SetAttribute( const char * name, int value );
  750. /** Sets an attribute of name to a given value. The attribute
  751. will be created if it does not exist, or changed if it does.
  752. */
  753. void SetDoubleAttribute( const char * name, double value );
  754. /** Deletes an attribute with the given name.
  755. */
  756. void RemoveAttribute( const char * name );
  757.     #ifdef TIXML_USE_STL
  758. void RemoveAttribute( const std::string& name ) { RemoveAttribute (name.c_str ()); } ///< STL std::string form.
  759. #endif
  760. const TiXmlAttribute* FirstAttribute() const { return attributeSet.First(); } ///< Access the first attribute in this element.
  761. TiXmlAttribute* FirstAttribute()  { return attributeSet.First(); }
  762. const TiXmlAttribute* LastAttribute() const  { return attributeSet.Last(); } ///< Access the last attribute in this element.
  763. TiXmlAttribute* LastAttribute() { return attributeSet.Last(); }
  764. /** Convenience function for easy access to the text inside an element. Although easy
  765. and concise, GetText() is limited compared to getting the TiXmlText child
  766. and accessing it directly.
  767. If the first child of 'this' is a TiXmlText, the GetText()
  768. returns the character string of the Text node, else null is returned.
  769. This is a convenient method for getting the text of simple contained text:
  770. @verbatim
  771. <foo>This is text</foo>
  772. const char* str = fooElement->GetText();
  773. @endverbatim
  774. 'str' will be a pointer to "This is text". 
  775. Note that this function can be misleading. If the element foo was created from
  776. this XML:
  777. @verbatim
  778. <foo><b>This is text</b></foo> 
  779. @endverbatim
  780. then the value of str would be null. The first child node isn't a text node, it is
  781. another element. From this XML:
  782. @verbatim
  783. <foo>This is <b>text</b></foo> 
  784. @endverbatim
  785. GetText() will return "This is ".
  786. WARNING: GetText() accesses a child node - don't become confused with the 
  787.  similarly named TiXmlHandle::Text() and TiXmlNode::ToText() which are 
  788.  safe type casts on the referenced node.
  789. */
  790. const char* GetText() const;
  791. /// Creates a new Element and returns it - the returned element is a copy.
  792. virtual TiXmlNode* Clone() const;
  793. // Print the Element to a FILE stream.
  794. virtual void Print( FILE* cfile, int depth ) const;
  795. /* Attribtue parsing starts: next char past '<'
  796.  returns: next char past '>'
  797. */
  798. virtual const char* Parse( const char* p, TiXmlParsingData* data, TiXmlEncoding encoding );
  799. virtual const TiXmlElement*     ToElement()     const { return this; } ///< Cast to a more defined type. Will return null not of the requested type.
  800. virtual TiXmlElement*           ToElement()           { return this; } ///< Cast to a more defined type. Will return null not of the requested type.
  801. protected:
  802. void CopyTo( TiXmlElement* target ) const;
  803. void ClearThis(); // like clear, but initializes 'this' object as well
  804. // Used to be public [internal use]
  805. #ifdef TIXML_USE_STL
  806.     virtual void StreamIn( TIXML_ISTREAM * in, TIXML_STRING * tag );
  807. #endif
  808. virtual void StreamOut( TIXML_OSTREAM * out ) const;
  809. /* [internal use]
  810. Reads the "value" of the element -- another element, or text.
  811. This should terminate with the current end tag.
  812. */
  813. const char* ReadValue( const char* in, TiXmlParsingData* prevData, TiXmlEncoding encoding );
  814. private:
  815. TiXmlAttributeSet attributeSet;
  816. };
  817. /** An XML comment.
  818. */
  819. class TiXmlComment : public TiXmlNode
  820. {
  821. public:
  822. /// Constructs an empty comment.
  823. TiXmlComment() : TiXmlNode( TiXmlNode::COMMENT ) {}
  824. TiXmlComment( const TiXmlComment& );
  825. void operator=( const TiXmlComment& base );
  826. virtual ~TiXmlComment() {}
  827. /// Returns a copy of this Comment.
  828. virtual TiXmlNode* Clone() const;
  829. /// Write this Comment to a FILE stream.
  830. virtual void Print( FILE* cfile, int depth ) const;
  831. /* Attribtue parsing starts: at the ! of the !--
  832.  returns: next char past '>'
  833. */
  834. virtual const char* Parse( const char* p, TiXmlParsingData* data, TiXmlEncoding encoding );
  835. virtual const TiXmlComment*  ToComment() const { return this; } ///< Cast to a more defined type. Will return null not of the requested type.
  836. virtual TiXmlComment*  ToComment() { return this; } ///< Cast to a more defined type. Will return null not of the requested type.
  837. protected:
  838. void CopyTo( TiXmlComment* target ) const;
  839. // used to be public
  840. #ifdef TIXML_USE_STL
  841.     virtual void StreamIn( TIXML_ISTREAM * in, TIXML_STRING * tag );
  842. #endif
  843. virtual void StreamOut( TIXML_OSTREAM * out ) const;
  844. private:
  845. };
  846. /** XML text. A text node can have 2 ways to output the next. "normal" output 
  847. and CDATA. It will default to the mode it was parsed from the XML file and
  848. you generally want to leave it alone, but you can change the output mode with 
  849. SetCDATA() and query it with CDATA().
  850. */
  851. class TiXmlText : public TiXmlNode
  852. {
  853. friend class TiXmlElement;
  854. public:
  855. /** Constructor for text element. By default, it is treated as 
  856. normal, encoded text. If you want it be output as a CDATA text
  857. element, set the parameter _cdata to 'true'
  858. */
  859. TiXmlText (const char * initValue ) : TiXmlNode (TiXmlNode::TEXT)
  860. {
  861. SetValue( initValue );
  862. cdata = false;
  863. }
  864. virtual ~TiXmlText() {}
  865. #ifdef TIXML_USE_STL
  866. /// Constructor.
  867. TiXmlText( const std::string& initValue ) : TiXmlNode (TiXmlNode::TEXT)
  868. {
  869. SetValue( initValue );
  870. cdata = false;
  871. }
  872. #endif
  873. TiXmlText( const TiXmlText& copy ) : TiXmlNode( TiXmlNode::TEXT ) { copy.CopyTo( this ); }
  874. void operator=( const TiXmlText& base )   { base.CopyTo( this ); }
  875. /// Write this text object to a FILE stream.
  876. virtual void Print( FILE* cfile, int depth ) const;
  877. /// Queries whether this represents text using a CDATA section.
  878. bool CDATA() { return cdata; }
  879. /// Turns on or off a CDATA representation of text.
  880. void SetCDATA( bool _cdata ) { cdata = _cdata; }
  881. virtual const char* Parse( const char* p, TiXmlParsingData* data, TiXmlEncoding encoding );
  882. virtual const TiXmlText* ToText() const { return this; } ///< Cast to a more defined type. Will return null not of the requested type.
  883. virtual TiXmlText*       ToText()       { return this; } ///< Cast to a more defined type. Will return null not of the requested type.
  884. protected :
  885. ///  [internal use] Creates a new Element and returns it.
  886. virtual TiXmlNode* Clone() const;
  887. void CopyTo( TiXmlText* target ) const;
  888. virtual void StreamOut ( TIXML_OSTREAM * out ) const;
  889. bool Blank() const; // returns true if all white space and new lines
  890. // [internal use]
  891. #ifdef TIXML_USE_STL
  892.     virtual void StreamIn( TIXML_ISTREAM * in, TIXML_STRING * tag );
  893. #endif
  894. private:
  895. bool cdata; // true if this should be input and output as a CDATA style text element
  896. };
  897. /** In correct XML the declaration is the first entry in the file.
  898. @verbatim
  899. <?xml version="1.0" standalone="yes"?>
  900. @endverbatim
  901. TinyXml will happily read or write files without a declaration,
  902. however. There are 3 possible attributes to the declaration:
  903. version, encoding, and standalone.
  904. Note: In this version of the code, the attributes are
  905. handled as special cases, not generic attributes, simply
  906. because there can only be at most 3 and they are always the same.
  907. */
  908. class TiXmlDeclaration : public TiXmlNode
  909. {
  910. public:
  911. /// Construct an empty declaration.
  912. TiXmlDeclaration()   : TiXmlNode( TiXmlNode::DECLARATION ) {}
  913. #ifdef TIXML_USE_STL
  914. /// Constructor.
  915. TiXmlDeclaration( const std::string& _version,
  916. const std::string& _encoding,
  917. const std::string& _standalone );
  918. #endif
  919. /// Construct.
  920. TiXmlDeclaration( const char* _version,
  921. const char* _encoding,
  922. const char* _standalone );
  923. TiXmlDeclaration( const TiXmlDeclaration& copy );
  924. void operator=( const TiXmlDeclaration& copy );
  925. virtual ~TiXmlDeclaration() {}
  926. /// Version. Will return an empty string if none was found.
  927. const char *Version() const { return version.c_str (); }
  928. /// Encoding. Will return an empty string if none was found.
  929. const char *Encoding() const { return encoding.c_str (); }
  930. /// Is this a standalone document?
  931. const char *Standalone() const { return standalone.c_str (); }
  932. /// Creates a copy of this Declaration and returns it.
  933. virtual TiXmlNode* Clone() const;
  934. /// Print this declaration to a FILE stream.
  935. virtual void Print( FILE* cfile, int depth ) const;
  936. virtual const char* Parse( const char* p, TiXmlParsingData* data, TiXmlEncoding encoding );
  937. virtual const TiXmlDeclaration* ToDeclaration() const { return this; } ///< Cast to a more defined type. Will return null not of the requested type.
  938. virtual TiXmlDeclaration*       ToDeclaration()       { return this; } ///< Cast to a more defined type. Will return null not of the requested type.
  939. protected:
  940. void CopyTo( TiXmlDeclaration* target ) const;
  941. // used to be public
  942. #ifdef TIXML_USE_STL
  943.     virtual void StreamIn( TIXML_ISTREAM * in, TIXML_STRING * tag );
  944. #endif
  945. virtual void StreamOut ( TIXML_OSTREAM * out) const;
  946. private:
  947. TIXML_STRING version;
  948. TIXML_STRING encoding;
  949. TIXML_STRING standalone;
  950. };
  951. /** Any tag that tinyXml doesn't recognize is saved as an
  952. unknown. It is a tag of text, but should not be modified.
  953. It will be written back to the XML, unchanged, when the file
  954. is saved.
  955. DTD tags get thrown into TiXmlUnknowns.
  956. */
  957. class TiXmlUnknown : public TiXmlNode
  958. {
  959. public:
  960. TiXmlUnknown() : TiXmlNode( TiXmlNode::UNKNOWN ) {}
  961. virtual ~TiXmlUnknown() {}
  962. TiXmlUnknown( const TiXmlUnknown& copy ) : TiXmlNode( TiXmlNode::UNKNOWN ) { copy.CopyTo( this ); }
  963. void operator=( const TiXmlUnknown& copy ) { copy.CopyTo( this ); }
  964. /// Creates a copy of this Unknown and returns it.
  965. virtual TiXmlNode* Clone() const;
  966. /// Print this Unknown to a FILE stream.
  967. virtual void Print( FILE* cfile, int depth ) const;
  968. virtual const char* Parse( const char* p, TiXmlParsingData* data, TiXmlEncoding encoding );
  969. virtual const TiXmlUnknown*     ToUnknown()     const { return this; } ///< Cast to a more defined type. Will return null not of the requested type.
  970. virtual TiXmlUnknown*           ToUnknown()     { return this; } ///< Cast to a more defined type. Will return null not of the requested type.
  971. protected:
  972. void CopyTo( TiXmlUnknown* target ) const;
  973. #ifdef TIXML_USE_STL
  974.     virtual void StreamIn( TIXML_ISTREAM * in, TIXML_STRING * tag );
  975. #endif
  976. virtual void StreamOut ( TIXML_OSTREAM * out ) const;
  977. private:
  978. };
  979. /** Always the top level node. A document binds together all the
  980. XML pieces. It can be saved, loaded, and printed to the screen.
  981. The 'value' of a document node is the xml file name.
  982. */
  983. class TiXmlDocument : public TiXmlNode
  984. {
  985. public:
  986. /// Create an empty document, that has no name.
  987. TiXmlDocument();
  988. /// Create a document with a name. The name of the document is also the filename of the xml.
  989. TiXmlDocument( const char * documentName );
  990. #ifdef TIXML_USE_STL
  991. /// Constructor.
  992. TiXmlDocument( const std::string& documentName );
  993. #endif
  994. TiXmlDocument( const TiXmlDocument& copy );
  995. void operator=( const TiXmlDocument& copy );
  996. virtual ~TiXmlDocument() {}
  997. /** Load a file using the current document value.
  998. Returns true if successful. Will delete any existing
  999. document data before loading.
  1000. */
  1001. bool LoadFile( TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING );
  1002. /// Save a file using the current document value. Returns true if successful.
  1003. bool SaveFile() const;
  1004. /// Load a file using the given filename. Returns true if successful.
  1005. bool LoadFile( const char * filename, TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING );
  1006. /// Save a file using the given filename. Returns true if successful.
  1007. bool SaveFile( const char * filename ) const;
  1008. /** Load a file using the given FILE*. Returns true if successful. Note that this method
  1009. doesn't stream - the entire object pointed at by the FILE*
  1010. will be interpreted as an XML file. TinyXML doesn't stream in XML from the current
  1011. file location. Streaming may be added in the future.
  1012. */
  1013. bool LoadFile( FILE*, TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING );
  1014. /// Save a file using the given FILE*. Returns true if successful.
  1015. bool SaveFile( FILE* ) const;
  1016. #ifdef TIXML_USE_STL
  1017. bool LoadFile( const std::string& filename, TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING ) ///< STL std::string version.
  1018. {
  1019. StringToBuffer f( filename );
  1020. return ( f.buffer && LoadFile( f.buffer, encoding ));
  1021. }
  1022. bool SaveFile( const std::string& filename ) const ///< STL std::string version.
  1023. {
  1024. StringToBuffer f( filename );
  1025. return ( f.buffer && SaveFile( f.buffer ));
  1026. }
  1027. #endif
  1028. /** Parse the given null terminated block of xml data. Passing in an encoding to this
  1029. method (either TIXML_ENCODING_LEGACY or TIXML_ENCODING_UTF8 will force TinyXml
  1030. to use that encoding, regardless of what TinyXml might otherwise try to detect.
  1031. */
  1032. virtual const char* Parse( const char* p, TiXmlParsingData* data = 0, TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING );
  1033. /** Get the root element -- the only top level element -- of the document.
  1034. In well formed XML, there should only be one. TinyXml is tolerant of
  1035. multiple elements at the document level.
  1036. */
  1037. const TiXmlElement* RootElement() const { return FirstChildElement(); }
  1038. TiXmlElement* RootElement() { return FirstChildElement(); }
  1039. /** If an error occurs, Error will be set to true. Also,
  1040. - The ErrorId() will contain the integer identifier of the error (not generally useful)
  1041. - The ErrorDesc() method will return the name of the error. (very useful)
  1042. - The ErrorRow() and ErrorCol() will return the location of the error (if known)
  1043. */
  1044. bool Error() const { return error; }
  1045. /// Contains a textual (english) description of the error if one occurs.
  1046. const char * ErrorDesc() const { return errorDesc.c_str (); }
  1047. /** Generally, you probably want the error string ( ErrorDesc() ). But if you
  1048. prefer the ErrorId, this function will fetch it.
  1049. */
  1050. int ErrorId() const { return errorId; }
  1051. /** Returns the location (if known) of the error. The first column is column 1, 
  1052. and the first row is row 1. A value of 0 means the row and column wasn't applicable
  1053. (memory errors, for example, have no row/column) or the parser lost the error. (An
  1054. error in the error reporting, in that case.)
  1055. @sa SetTabSize, Row, Column
  1056. */
  1057. int ErrorRow() { return errorLocation.row+1; }
  1058. int ErrorCol() { return errorLocation.col+1; } ///< The column where the error occured. See ErrorRow()
  1059. /** SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol())
  1060. to report the correct values for row and column. It does not change the output
  1061. or input in any way.
  1062. By calling this method, with a tab size
  1063. greater than 0, the row and column of each node and attribute is stored
  1064. when the file is loaded. Very useful for tracking the DOM back in to
  1065. the source file.
  1066. The tab size is required for calculating the location of nodes. If not
  1067. set, the default of 4 is used. The tabsize is set per document. Setting
  1068. the tabsize to 0 disables row/column tracking.
  1069. Note that row and column tracking is not supported when using operator>>.
  1070. The tab size needs to be enabled before the parse or load. Correct usage:
  1071. @verbatim
  1072. TiXmlDocument doc;
  1073. doc.SetTabSize( 8 );
  1074. doc.Load( "myfile.xml" );
  1075. @endverbatim
  1076. @sa Row, Column
  1077. */
  1078. void SetTabSize( int _tabsize ) { tabsize = _tabsize; }
  1079. int TabSize() const { return tabsize; }
  1080. /** If you have handled the error, it can be reset with this call. The error
  1081. state is automatically cleared if you Parse a new XML block.
  1082. */
  1083. void ClearError() { error = false; 
  1084. errorId = 0; 
  1085. errorDesc = ""; 
  1086. errorLocation.row = errorLocation.col = 0; 
  1087. //errorLocation.last = 0; 
  1088. }
  1089. /** Dump the document to standard out. */
  1090. void Print() const { Print( stdout, 0 ); }
  1091. /// Print this Document to a FILE stream.
  1092. virtual void Print( FILE* cfile, int depth = 0 ) const;
  1093. // [internal use]
  1094. void SetError( int err, const char* errorLocation, TiXmlParsingData* prevData, TiXmlEncoding encoding );
  1095. virtual const TiXmlDocument*    ToDocument()    const { return this; } ///< Cast to a more defined type. Will return null not of the requested type.
  1096. virtual TiXmlDocument*          ToDocument()          { return this; } ///< Cast to a more defined type. Will return null not of the requested type.
  1097. protected :
  1098. virtual void StreamOut ( TIXML_OSTREAM * out) const;
  1099. // [internal use]
  1100. virtual TiXmlNode* Clone() const;
  1101. #ifdef TIXML_USE_STL
  1102.     virtual void StreamIn( TIXML_ISTREAM * in, TIXML_STRING * tag );
  1103. #endif
  1104. private:
  1105. void CopyTo( TiXmlDocument* target ) const;
  1106. bool error;
  1107. int  errorId;
  1108. TIXML_STRING errorDesc;
  1109. int tabsize;
  1110. TiXmlCursor errorLocation;
  1111. bool useMicrosoftBOM; // the UTF-8 BOM were found when read. Note this, and try to write.
  1112. };
  1113. /**
  1114. A TiXmlHandle is a class that wraps a node pointer with null checks; this is
  1115. an incredibly useful thing. Note that TiXmlHandle is not part of the TinyXml
  1116. DOM structure. It is a separate utility class.
  1117. Take an example:
  1118. @verbatim
  1119. <Document>
  1120. <Element attributeA = "valueA">
  1121. <Child attributeB = "value1" />
  1122. <Child attributeB = "value2" />
  1123. </Element>
  1124. <Document>
  1125. @endverbatim
  1126. Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very 
  1127. easy to write a *lot* of code that looks like:
  1128. @verbatim
  1129. TiXmlElement* root = document.FirstChildElement( "Document" );
  1130. if ( root )
  1131. {
  1132. TiXmlElement* element = root->FirstChildElement( "Element" );
  1133. if ( element )
  1134. {
  1135. TiXmlElement* child = element->FirstChildElement( "Child" );
  1136. if ( child )
  1137. {
  1138. TiXmlElement* child2 = child->NextSiblingElement( "Child" );
  1139. if ( child2 )
  1140. {
  1141. // Finally do something useful.
  1142. @endverbatim
  1143. And that doesn't even cover "else" cases. TiXmlHandle addresses the verbosity
  1144. of such code. A TiXmlHandle checks for null pointers so it is perfectly safe 
  1145. and correct to use:
  1146. @verbatim
  1147. TiXmlHandle docHandle( &document );
  1148. TiXmlElement* child2 = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", 1 ).Element();
  1149. if ( child2 )
  1150. {
  1151. // do something useful
  1152. @endverbatim
  1153. Which is MUCH more concise and useful.
  1154. It is also safe to copy handles - internally they are nothing more than node pointers.
  1155. @verbatim
  1156. TiXmlHandle handleCopy = handle;
  1157. @endverbatim
  1158. What they should not be used for is iteration:
  1159. @verbatim
  1160. int i=0; 
  1161. while ( true )
  1162. {
  1163. TiXmlElement* child = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", i ).Element();
  1164. if ( !child )
  1165. break;
  1166. // do something
  1167. ++i;
  1168. }
  1169. @endverbatim
  1170. It seems reasonable, but it is in fact two embedded while loops. The Child method is 
  1171. a linear walk to find the element, so this code would iterate much more than it needs 
  1172. to. Instead, prefer:
  1173. @verbatim
  1174. TiXmlElement* child = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).FirstChild( "Child" ).Element();
  1175. for( child; child; child=child->NextSiblingElement() )
  1176. {
  1177. // do something
  1178. }
  1179. @endverbatim
  1180. */
  1181. class TiXmlHandle
  1182. {
  1183. public:
  1184. /// Create a handle from any node (at any depth of the tree.) This can be a null pointer.
  1185. TiXmlHandle( TiXmlNode* _node ) { this->node = _node; }
  1186. /// Copy constructor
  1187. TiXmlHandle( const TiXmlHandle& ref ) { this->node = ref.node; }
  1188. TiXmlHandle operator=( const TiXmlHandle& ref ) { this->node = ref.node; return *this; }
  1189. /// Return a handle to the first child node.
  1190. TiXmlHandle FirstChild() const;
  1191. /// Return a handle to the first child node with the given name.
  1192. TiXmlHandle FirstChild( const char * value ) const;
  1193. /// Return a handle to the first child element.
  1194. TiXmlHandle FirstChildElement() const;
  1195. /// Return a handle to the first child element with the given name.
  1196. TiXmlHandle FirstChildElement( const char * value ) const;
  1197. /** Return a handle to the "index" child with the given name. 
  1198. The first child is 0, the second 1, etc.
  1199. */
  1200. TiXmlHandle Child( const char* value, int index ) const;
  1201. /** Return a handle to the "index" child. 
  1202. The first child is 0, the second 1, etc.
  1203. */
  1204. TiXmlHandle Child( int index ) const;
  1205. /** Return a handle to the "index" child element with the given name. 
  1206. The first child element is 0, the second 1, etc. Note that only TiXmlElements
  1207. are indexed: other types are not counted.
  1208. */
  1209. TiXmlHandle ChildElement( const char* value, int index ) const;
  1210. /** Return a handle to the "index" child element. 
  1211. The first child element is 0, the second 1, etc. Note that only TiXmlElements
  1212. are indexed: other types are not counted.
  1213. */
  1214. TiXmlHandle ChildElement( int index ) const;
  1215. #ifdef TIXML_USE_STL
  1216. TiXmlHandle FirstChild( const std::string& _value ) const { return FirstChild( _value.c_str() ); }
  1217. TiXmlHandle FirstChildElement( const std::string& _value ) const { return FirstChildElement( _value.c_str() ); }
  1218. TiXmlHandle Child( const std::string& _value, int index ) const { return Child( _value.c_str(), index ); }
  1219. TiXmlHandle ChildElement( const std::string& _value, int index ) const { return ChildElement( _value.c_str(), index ); }
  1220. #endif
  1221. /// Return the handle as a TiXmlNode. This may return null.
  1222. TiXmlNode* Node() const { return node; } 
  1223. /// Return the handle as a TiXmlElement. This may return null.
  1224. TiXmlElement* Element() const { return ( ( node && node->ToElement() ) ? node->ToElement() : 0 ); }
  1225. /// Return the handle as a TiXmlText. This may return null.
  1226. TiXmlText* Text() const { return ( ( node && node->ToText() ) ? node->ToText() : 0 ); }
  1227. /// Return the handle as a TiXmlUnknown. This may return null;
  1228. TiXmlUnknown* Unknown() const { return ( ( node && node->ToUnknown() ) ? node->ToUnknown() : 0 ); }
  1229. private:
  1230. TiXmlNode* node;
  1231. };
  1232. #ifdef _MSC_VER
  1233. #pragma warning( pop )
  1234. #endif
  1235. #endif