#include <tinyxml.h>

Inheritance diagram for TiXmlDocument:

Collaboration diagram for TiXmlDocument:

Public Member Functions
	TiXmlDocument ()
	Create an empty document, that has no name.

	TiXmlDocument (const char *documentName)
	Create a document with a name. The name of the document is also the filename of the xml.

	TiXmlDocument (const TiXmlDocument &copy)

TiXmlDocument &	operator= (const TiXmlDocument &copy)

bool	LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)

bool	SaveFile () const
	Save a file using the current document value. Returns true if successful.

bool	LoadFile (const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
	Load a file using the given filename. Returns true if successful.

bool	SaveFile (const char *filename) const
	Save a file using the given filename. Returns true if successful.

bool	LoadFile (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)

bool	SaveFile (FILE *) const
	Save a file using the given FILE*. Returns true if successful.

virtual const char *	Parse (const char p, TiXmlParsingData data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)

const TiXmlElement *	RootElement () const

TiXmlElement *	RootElement ()

bool	Error () const

const char *	ErrorDesc () const
	Contains a textual (english) description of the error if one occurs.

int	ErrorId () const

int	ErrorRow () const

int	ErrorCol () const
	The column where the error occured. See ErrorRow()

void	SetTabSize (int _tabsize)

int	TabSize () const

void	ClearError ()

void	Print () const

virtual void	Print (FILE *cfile, int depth=0) const
	Print this Document to a FILE stream.

void	SetError (int err, const char errorLocation, TiXmlParsingData prevData, TiXmlEncoding encoding)

virtual const TiXmlDocument *	ToDocument () const
	Cast to a more defined type. Will return null not of the requested type.

virtual TiXmlDocument *	ToDocument ()
	Cast to a more defined type. Will return null not of the requested type.

virtual bool	Accept (TiXmlVisitor *content) const

Public Member Functions inherited from TiXmlNode
const char *	Value () const

const TIXML_STRING &	ValueTStr () const

void	SetValue (const char *_value)

void	Clear ()
	Delete all the children of this node. Does not affect 'this'.

TiXmlNode *	Parent ()
	One step up the DOM.

const TiXmlNode *	Parent () const

const TiXmlNode *	FirstChild () const
	The first child of this node. Will be null if there are no children.

TiXmlNode *	FirstChild ()

const TiXmlNode *	FirstChild (const char *value) const

TiXmlNode *	FirstChild (const char *_value)
	The first child of this node with the matching 'value'. Will be null if none found.

const TiXmlNode *	LastChild () const

TiXmlNode *	LastChild ()
	The last child of this node. Will be null if there are no children.

const TiXmlNode *	LastChild (const char *value) const

TiXmlNode *	LastChild (const char *_value)
	The last child of this node matching 'value'. Will be null if there are no children.

const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const

TiXmlNode *	IterateChildren (const TiXmlNode *previous)

const TiXmlNode *	IterateChildren (const char value, const TiXmlNode previous) const
	This flavor of IterateChildren searches for children with a particular 'value'.

TiXmlNode *	IterateChildren (const char _value, const TiXmlNode previous)

TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)

TiXmlNode *	LinkEndChild (TiXmlNode *addThis)

TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)

TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)

TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)

bool	RemoveChild (TiXmlNode *removeThis)
	Delete a child of this node.

const TiXmlNode *	PreviousSibling () const
	Navigate to a sibling node.

TiXmlNode *	PreviousSibling ()

const TiXmlNode *	PreviousSibling (const char *) const
	Navigate to a sibling node.

TiXmlNode *	PreviousSibling (const char *_prev)

const TiXmlNode *	NextSibling () const
	Navigate to a sibling node.

TiXmlNode *	NextSibling ()

const TiXmlNode *	NextSibling (const char *) const
	Navigate to a sibling node with the given 'value'.

TiXmlNode *	NextSibling (const char *_next)

const TiXmlElement *	NextSiblingElement () const

TiXmlElement *	NextSiblingElement ()

const TiXmlElement *	NextSiblingElement (const char *) const

TiXmlElement *	NextSiblingElement (const char *_next)

const TiXmlElement *	FirstChildElement () const
	Convenience function to get through elements.

TiXmlElement *	FirstChildElement ()

const TiXmlElement *	FirstChildElement (const char *_value) const
	Convenience function to get through elements.

TiXmlElement *	FirstChildElement (const char *_value)

int	Type () const

const TiXmlDocument *	GetDocument () const

TiXmlDocument *	GetDocument ()

bool	NoChildren () const
	Returns true if this node has no children.

virtual const TiXmlElement *	ToElement () const
	Cast to a more defined type. Will return null if not of the requested type.

virtual const TiXmlComment *	ToComment () const
	Cast to a more defined type. Will return null if not of the requested type.

virtual const TiXmlUnknown *	ToUnknown () const
	Cast to a more defined type. Will return null if not of the requested type.

virtual const TiXmlText *	ToText () const
	Cast to a more defined type. Will return null if not of the requested type.

virtual const TiXmlDeclaration *	ToDeclaration () const
	Cast to a more defined type. Will return null if not of the requested type.

virtual TiXmlElement *	ToElement ()
	Cast to a more defined type. Will return null if not of the requested type.

virtual TiXmlComment *	ToComment ()
	Cast to a more defined type. Will return null if not of the requested type.

virtual TiXmlUnknown *	ToUnknown ()
	Cast to a more defined type. Will return null if not of the requested type.

virtual TiXmlText *	ToText ()
	Cast to a more defined type. Will return null if not of the requested type.

virtual TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null if not of the requested type.

Public Member Functions inherited from TiXmlBase
int	Row () const

int	Column () const
	See Row()

void	SetUserData (void *user)
	Set a pointer to arbitrary user data.

void *	GetUserData ()
	Get a pointer to arbitrary user data.

const void *	GetUserData () const
	Get a pointer to arbitrary user data.

Protected Member Functions
virtual TiXmlNode *	Clone () const

Protected Member Functions inherited from TiXmlNode
	TiXmlNode (NodeType _type)

void	CopyTo (TiXmlNode *target) const

TiXmlNode *	Identify (const char *start, TiXmlEncoding encoding)

Additional Inherited Members
Public Types inherited from TiXmlNode
enum	NodeType { TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN, TINYXML_TEXT, TINYXML_DECLARATION, TINYXML_TYPECOUNT }

Public Types inherited from TiXmlBase
enum	{ TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_PARSING_ELEMENT, TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES, TIXML_ERROR_PARSING_EMPTY, TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT, TIXML_ERROR_PARSING_DECLARATION, TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_EMBEDDED_NULL, TIXML_ERROR_PARSING_CDATA, TIXML_ERROR_DOCUMENT_TOP_ONLY, TIXML_ERROR_STRING_COUNT }

Static Public Member Functions inherited from TiXmlBase
static void	SetCondenseWhiteSpace (bool condense)

static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting.

static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)

Static Public Attributes inherited from TiXmlBase
static const int	utf8ByteTable [256]

Static Protected Member Functions inherited from TiXmlBase
static const char *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)

static bool	IsWhiteSpace (char c)

static bool	IsWhiteSpace (int c)

static const char *	ReadName (const char p, TIXML_STRING name, TiXmlEncoding encoding)

static const char *	ReadText (const char in, TIXML_STRING text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)

static const char *	GetEntity (const char in, char value, int *length, TiXmlEncoding encoding)

static const char *	GetChar (const char p, char _value, int *length, TiXmlEncoding encoding)

static bool	StringEqual (const char p, const char endTag, bool ignoreCase, TiXmlEncoding encoding)

static int	IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)

static int	IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)

static int	ToLower (int v, TiXmlEncoding encoding)

static void	ConvertUTF32ToUTF8 (unsigned long input, char output, int length)

Protected Attributes inherited from TiXmlNode
TiXmlNode *	parent

NodeType	type

TiXmlNode *	firstChild

TiXmlNode *	lastChild

TIXML_STRING	value

TiXmlNode *	prev

TiXmlNode *	next

Protected Attributes inherited from TiXmlBase
TiXmlCursor	location

void *	userData
	Field containing a generic user pointer.

Static Protected Attributes inherited from TiXmlBase
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

Detailed Description

Always the top level node. A document binds together all the XML pieces. It can be saved, loaded, and printed to the screen. The 'value' of a document node is the xml file name.

Definition at line 1393 of file tinyxml.h.

Member Function Documentation

bool TiXmlDocument::Accept ( TiXmlVisitor * content ) const

virtual

Walk the XML tree visiting this node and all of its children.

Implements TiXmlNode.

Definition at line 1156 of file tinyxml.cpp.

 {
      if ( visitor->VisitEnter( *this ) )
      {
           for ( const TiXmlNode* node=FirstChild(); node; node=node->NextSibling() )
           {
                if ( !node->Accept( visitor ) )
                     break;
           }
      }
      return visitor->VisitExit( *this );
 }

void TiXmlDocument::ClearError ( )

inline

If you have handled the error, it can be reset with this call. The error state is automatically cleared if you Parse a new XML block.

Definition at line 1511 of file tinyxml.h.

                                                   {    error = false; 
                                                             errorId = 0; 
                                                             errorDesc = ""; 
                                                             errorLocation.row = errorLocation.col = 0; 
                                                             //errorLocation.last = 0; 
                                                        }

TiXmlNode * TiXmlDocument::Clone ( ) const

protectedvirtual

Create an exact duplicate of this node and return it. The memory must be deleted by the caller.

Implements TiXmlNode.

Definition at line 1134 of file tinyxml.cpp.

 {
      TiXmlDocument* clone = new TiXmlDocument();
      if ( !clone )
           return 0;
 
      CopyTo( clone );
      return clone;
 }

bool TiXmlDocument::Error ( ) const

inline

If an error occurs, Error will be set to true. Also,

The ErrorId() will contain the integer identifier of the error (not generally useful)
The ErrorDesc() method will return the name of the error. (very useful)
The ErrorRow() and ErrorCol() will return the location of the error (if known)

Definition at line 1460 of file tinyxml.h.

1460 { return error; }

int TiXmlDocument::ErrorId ( ) const

inline

Generally, you probably want the error string ( ErrorDesc() ). But if you prefer the ErrorId, this function will fetch it.

Definition at line 1468 of file tinyxml.h.

1468 { return errorId; }

int TiXmlDocument::ErrorRow ( ) const

inline

Returns the location (if known) of the error. The first column is column 1, and the first row is row 1. A value of 0 means the row and column wasn't applicable (memory errors, for example, have no row/column) or the parser lost the error. (An error in the error reporting, in that case.)

See also: SetTabSize, Row, Column

Definition at line 1477 of file tinyxml.h.

1477 { return errorLocation.row+1; }

bool TiXmlDocument::LoadFile ( TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING )

Load a file using the current document value. Returns true if successful. Will delete any existing document data before loading.

Definition at line 954 of file tinyxml.cpp.

 {
      return LoadFile( Value(), encoding );
 }

bool TiXmlDocument::LoadFile	(	FILE *	file,
		TiXmlEncoding	encoding = `TIXML_DEFAULT_ENCODING`
	)

Load a file using the given FILE*. Returns true if successful. Note that this method doesn't stream - the entire object pointed at by the FILE* will be interpreted as an XML file. TinyXML doesn't stream in XML from the current file location. Streaming may be added in the future.

Definition at line 986 of file tinyxml.cpp.

 {
      if ( !file ) 
      {
           SetError( TIXML_ERROR_OPENING_FILE, 0, 0, TIXML_ENCODING_UNKNOWN );
           return false;
      }
 
      // Delete the existing data:
      Clear();
      location.Clear();
 
      // Get the file size, so we can pre-allocate the string. HUGE speed impact.
      long length = 0;
      fseek( file, 0, SEEK_END );
      length = ftell( file );
      fseek( file, 0, SEEK_SET );
 
      // Strange case, but good to handle up front.
      if ( length <= 0 )
      {
           SetError( TIXML_ERROR_DOCUMENT_EMPTY, 0, 0, TIXML_ENCODING_UNKNOWN );
           return false;
      }
 
      // Subtle bug here. TinyXml did use fgets. But from the XML spec:
      // 2.11 End-of-Line Handling
      // <snip>
      // <quote>
      // ...the XML processor MUST behave as if it normalized all line breaks in external 
      // parsed entities (including the document entity) on input, before parsing, by translating 
      // both the two-character sequence #xD #xA and any #xD that is not followed by #xA to 
      // a single #xA character.
      // </quote>
      //
      // It is not clear fgets does that, and certainly isn't clear it works cross platform. 
      // Generally, you expect fgets to translate from the convention of the OS to the c/unix
      // convention, and not work generally.
 
      /*
      while( fgets( buf, sizeof(buf), file ) )
      {
           data += buf;
      }
      */
 
      char* buf = new char[ length+1 ];
      buf[0] = 0;
 
      if ( fread( buf, length, 1, file ) != 1 ) {
           delete [] buf;
           SetError( TIXML_ERROR_OPENING_FILE, 0, 0, TIXML_ENCODING_UNKNOWN );
           return false;
      }
 
      // Process the buffer in place to normalize new lines. (See comment above.)
      // Copies from the 'p' to 'q' pointer, where p can advance faster if
      // a newline-carriage return is hit.
      //
      // Wikipedia:
      // Systems based on ASCII or a compatible character set use either LF  (Line feed, '\n', 0x0A, 10 in decimal) or 
      // CR (Carriage return, '\r', 0x0D, 13 in decimal) individually, or CR followed by LF (CR+LF, 0x0D 0x0A)...
      //        * LF:    Multics, Unix and Unix-like systems (GNU/Linux, AIX, Xenix, Mac OS X, FreeBSD, etc.), BeOS, Amiga, RISC OS, and others
     //         * CR+LF: DEC RT-11 and most other early non-Unix, non-IBM OSes, CP/M, MP/M, DOS, OS/2, Microsoft Windows, Symbian OS
     //         * CR:    Commodore 8-bit machines, Apple II family, Mac OS up to version 9 and OS-9
 
      const char* p = buf;     // the read head
      char* q = buf;           // the write head
      const char CR = 0x0d;
      const char LF = 0x0a;
 
      buf[length] = 0;
      while( *p ) {
           assert( p < (buf+length) );
           assert( q <= (buf+length) );
           assert( q <= p );
 
           if ( *p == CR ) {
                *q++ = LF;
                p++;
                if ( *p == LF ) {        // check for CR+LF (and skip LF)
                     p++;
                }
           }
           else {
                *q++ = *p++;
           }
      }
      assert( q <= (buf+length) );
      *q = 0;
 
      Parse( buf, 0, encoding );
 
      delete [] buf;
      return !Error();
 }

const char * TiXmlDocument::Parse	(	const char *	p,
		TiXmlParsingData *	data = `0`,
		TiXmlEncoding	encoding = `TIXML_DEFAULT_ENCODING`
	)

virtual

Parse the given null terminated block of xml data. Passing in an encoding to this method (either TIXML_ENCODING_LEGACY or TIXML_ENCODING_UTF8 will force TinyXml to use that encoding, regardless of what TinyXml might otherwise try to detect.

Implements TiXmlBase.

Definition at line 704 of file tinyxmlparser.cpp.

 {
      ClearError();
 
      // Parse away, at the document level. Since a document
      // contains nothing but other tags, most of what happens
      // here is skipping white space.
      if ( !p || !*p )
      {
           SetError( TIXML_ERROR_DOCUMENT_EMPTY, 0, 0, TIXML_ENCODING_UNKNOWN );
           return 0;
      }
 
      // Note that, for a document, this needs to come
      // before the while space skip, so that parsing
      // starts from the pointer we are given.
      location.Clear();
      if ( prevData )
      {
           location.row = prevData->cursor.row;
           location.col = prevData->cursor.col;
      }
      else
      {
           location.row = 0;
           location.col = 0;
      }
      TiXmlParsingData data( p, TabSize(), location.row, location.col );
      location = data.Cursor();
 
      if ( encoding == TIXML_ENCODING_UNKNOWN )
      {
           // Check for the Microsoft UTF-8 lead bytes.
           const unsigned char* pU = (const unsigned char*)p;
           if ( *(pU+0) && *(pU+0) == TIXML_UTF_LEAD_0
                 && *(pU+1) && *(pU+1) == TIXML_UTF_LEAD_1
                 && *(pU+2) && *(pU+2) == TIXML_UTF_LEAD_2 )
           {
                encoding = TIXML_ENCODING_UTF8;
                useMicrosoftBOM = true;
           }
      }
 
     p = SkipWhiteSpace( p, encoding );
      if ( !p )
      {
           SetError( TIXML_ERROR_DOCUMENT_EMPTY, 0, 0, TIXML_ENCODING_UNKNOWN );
           return 0;
      }
 
      while ( p && *p )
      {
           TiXmlNode* node = Identify( p, encoding );
           if ( node )
           {
                p = node->Parse( p, &data, encoding );
                LinkEndChild( node );
           }
           else
           {
                break;
           }
 
           // Did we get encoding info?
           if (    encoding == TIXML_ENCODING_UNKNOWN
                 && node->ToDeclaration() )
           {
                TiXmlDeclaration* dec = node->ToDeclaration();
                const char* enc = dec->Encoding();
                assert( enc );
 
                if ( *enc == 0 )
                     encoding = TIXML_ENCODING_UTF8;
                else if ( StringEqual( enc, "UTF-8", true, TIXML_ENCODING_UNKNOWN ) )
                     encoding = TIXML_ENCODING_UTF8;
                else if ( StringEqual( enc, "UTF8", true, TIXML_ENCODING_UNKNOWN ) )
                     encoding = TIXML_ENCODING_UTF8;    // incorrect, but be nice
                else 
                     encoding = TIXML_ENCODING_LEGACY;
           }
 
           p = SkipWhiteSpace( p, encoding );
      }
 
      // Was this empty?
      if ( !firstChild ) {
           SetError( TIXML_ERROR_DOCUMENT_EMPTY, 0, 0, encoding );
           return 0;
      }
 
      // All is well.
      return p;
 }

void TiXmlDocument::Print ( ) const

inline

Write the document to standard out using formatted printing ("pretty print").

Definition at line 1519 of file tinyxml.h.

1519 { Print( stdout, 0 ); }

TiXmlDocument::Print

void Print() const

Definition: tinyxml.h:1519

const TiXmlElement* TiXmlDocument::RootElement ( ) const

inline

Get the root element – the only top level element – of the document. In well formed XML, there should only be one. TinyXml is tolerant of multiple elements at the document level.

Definition at line 1452 of file tinyxml.h.

1452 { return FirstChildElement(); }

TiXmlNode::FirstChildElement

const TiXmlElement * FirstChildElement() const

Convenience function to get through elements.

Definition: tinyxml.cpp:452

void TiXmlDocument::SetTabSize ( int _tabsize )

inline

SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column. It does not change the output or input in any way.

By calling this method, with a tab size greater than 0, the row and column of each node and attribute is stored when the file is loaded. Very useful for tracking the DOM back in to the source file.

The tab size is required for calculating the location of nodes. If not set, the default of 4 is used. The tabsize is set per document. Setting the tabsize to 0 disables row/column tracking.

Note that row and column tracking is not supported when using operator>>.

The tab size needs to be enabled before the parse or load. Correct usage:

 TiXmlDocument doc;
 doc.SetTabSize( 8 );
 doc.Load( "myfile.xml" );

See also: Row, Column

Definition at line 1504 of file tinyxml.h.

1504 { tabsize = _tabsize; }

The documentation for this class was generated from the following files:

C:/Users/Brig/Documents/ShapeWorksStudio/src/TinyXML/tinyxml.h
C:/Users/Brig/Documents/ShapeWorksStudio/src/TinyXML/tinyxml.cpp
C:/Users/Brig/Documents/ShapeWorksStudio/src/TinyXML/tinyxmlparser.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation