TiXmlDocument Class Reference

Always the top level node. More...

#include <tinyxml.h>

Inheritance diagram for TiXmlDocument:

List of all members.

Public Types

enum NodeType {
DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
TEXT, DECLARATION, TYPECOUNT
}

The types of XML nodes supported by TinyXml. More...

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)

void operator= (const TiXmlDocument &copy)

virtual ~TiXmlDocument ()

bool LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)

Load a file using the current document value.

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)

Load a file using the given FILE*.

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)

Parse the given null terminated block of xml data.

const TiXmlElement * RootElement () const

Get the root element -- the only top level element -- of the document.

TiXmlElement * RootElement ()

bool Error () const

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

const char * ErrorDesc () const

Contains a textual (english) description of the error if one occurs.

int ErrorId () const

Generally, you probably want the error string ( ErrorDesc() ).

int ErrorRow () const

Returns the location (if known) of the error.

int ErrorCol () const

The column where the error occured. See ErrorRow().

void SetTabSize (int _tabsize)

SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column.

int TabSize () const

void ClearError ()

If you have handled the error, it can be reset with this call.

void Print () const

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

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

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

const char * Value () const

The meaning of 'value' changes for the specific type of TiXmlNode.

const TIXML_STRING & ValueTStr () const

void SetValue (const char *_value)

Changes the value of the node.

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

The first child of this node with the matching 'value'. Will be null if none found. The first child of this node with the matching 'value'. Will be null if none found.

TiXmlNode * FirstChild (const char *_value)

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

An alternate way to walk the children of a node.

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)

Add a new node related to this.

TiXmlNode * LinkEndChild (TiXmlNode *addThis)

Add a new node related to this.

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

Add a new node related to this.

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

Add a new node related to this.

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

Replace a child of this node.

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

Convenience function to get through elements.

TiXmlElement * NextSiblingElement ()

const TiXmlElement * NextSiblingElement (const char *) const

Convenience function to get through elements.

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

Query the type (as an enumerated value, above) of this node.

const TiXmlDocument * GetDocument () const

Return a pointer to the Document this node lives in.

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 TiXmlElement * ToElement ()

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 TiXmlComment * ToComment ()

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 TiXmlUnknown * ToUnknown ()

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 TiXmlText * ToText ()

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 TiXmlDeclaration * ToDeclaration ()

Cast to a more defined type. Will return null if not of the requested type.

int Row () const

Return the position, in the original source file, of this node or attribute.

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.

Static Public Member Functions

static void SetCondenseWhiteSpace (bool condense)

The world does not agree on whether white space should be kept or not.

static bool IsWhiteSpaceCondensed ()

Return the current white space setting.

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

Expands entities in a string.

Static Public Attributes

static const int utf8ByteTable [256]

Protected Member Functions

virtual TiXmlNode * Clone () const

Create an exact duplicate of this node and return it.

void CopyTo (TiXmlNode *target) const

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

Static Protected Member Functions

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

TiXmlNode * parent

NodeType type

TiXmlNode * firstChild

TiXmlNode * lastChild

TIXML_STRING value

TiXmlNode * prev

TiXmlNode * next

TiXmlCursor location

void * userData

Field containing a generic user pointer.

Static Protected Attributes

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.

Member Enumeration Documentation

anonymous enum [inherited]

Enumerator:

TIXML_NO_ERROR
TIXML_ERROR
TIXML_ERROR_OPENING_FILE
TIXML_ERROR_OUT_OF_MEMORY
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

enum TiXmlNode::NodeType [inherited]

The types of XML nodes supported by TinyXml.

(All the unsupported types are picked up by UNKNOWN.)

Enumerator:

DOCUMENT
ELEMENT
COMMENT
UNKNOWN
TEXT
DECLARATION
TYPECOUNT

Constructor & Destructor Documentation

TiXmlDocument::TiXmlDocument ( )

Create an empty document, that has no name.

TiXmlDocument::TiXmlDocument ( const char * documentName )

Create a document with a name. The name of the document is also the filename of the xml.

TiXmlDocument::TiXmlDocument ( const TiXmlDocument & copy )

virtual TiXmlDocument::~TiXmlDocument ( ) [inline, virtual]

Member Function Documentation

virtual bool TiXmlDocument::Accept ( TiXmlVisitor * content ) const [virtual]

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

Implements TiXmlNode.

void TiXmlNode::Clear ( ) [inherited]

Delete all the children of this node. Does not affect '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.

virtual TiXmlNode* TiXmlDocument::Clone ( ) const [protected, virtual]

Create an exact duplicate of this node and return it.

The memory must be deleted by the caller.

Implements TiXmlNode.

int TiXmlBase::Column ( ) const [inline, inherited]

See Row().

static void TiXmlBase::ConvertUTF32ToUTF8	(	unsigned long	input,
		char *	output,
		int *	length
	)			`[static, protected, inherited]`

void TiXmlNode::CopyTo ( TiXmlNode * target ) const [protected, inherited]

static void TiXmlBase::EncodeString	(	const TIXML_STRING &	str,
		TIXML_STRING *	out
	)			`[static, inherited]`

Expands entities in a string.

Note this should not contian the tag's '<', '>', etc, or they will be transformed into entities!

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)

int TiXmlDocument::ErrorCol ( ) const [inline]

The column where the error occured. See ErrorRow().

const char* TiXmlDocument::ErrorDesc ( ) const [inline]

Contains a textual (english) description of the error if one occurs.

int TiXmlDocument::ErrorId ( ) const [inline]

Generally, you probably want the error string ( ErrorDesc() ).

But if you prefer the ErrorId, this function will fetch it.

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

TiXmlNode* TiXmlNode::FirstChild ( const char * _value ) [inline, inherited]

const TiXmlNode* TiXmlNode::FirstChild ( const char * value ) const [inherited]

The first child of this node with the matching 'value'. Will be null if none found. The first child of this node with the matching 'value'. Will be null if none found.

TiXmlNode* TiXmlNode::FirstChild ( ) [inline, inherited]

const TiXmlNode* TiXmlNode::FirstChild ( ) const [inline, inherited]

The first child of this node. Will be null if there are no children.

TiXmlElement* TiXmlNode::FirstChildElement ( const char * _value ) [inline, inherited]

const TiXmlElement* TiXmlNode::FirstChildElement ( const char * _value ) const [inherited]

Convenience function to get through elements.

TiXmlElement* TiXmlNode::FirstChildElement ( ) [inline, inherited]

const TiXmlElement* TiXmlNode::FirstChildElement ( ) const [inherited]

Convenience function to get through elements.

Referenced by RootElement().

static const char* TiXmlBase::GetChar	(	const char *	p,
		char *	_value,
		int *	length,
		TiXmlEncoding	encoding
	)			`[inline, static, protected, inherited]`

TiXmlDocument* TiXmlNode::GetDocument ( ) [inline, inherited]

const TiXmlDocument* TiXmlNode::GetDocument ( ) const [inherited]

Return a pointer to the Document this node lives in.

Returns null if not in a document.

static const char* TiXmlBase::GetEntity	(	const char *	in,
		char *	value,
		int *	length,
		TiXmlEncoding	encoding
	)			`[static, protected, inherited]`

Referenced by TiXmlBase::GetChar().

const void* TiXmlBase::GetUserData ( ) const [inline, inherited]

Get a pointer to arbitrary user data.

void* TiXmlBase::GetUserData ( ) [inline, inherited]

Get a pointer to arbitrary user data.

TiXmlNode* TiXmlNode::Identify	(	const char *	start,
		TiXmlEncoding	encoding
	)			`[protected, inherited]`

TiXmlNode* TiXmlNode::InsertAfterChild	(	TiXmlNode *	afterThis,
		const TiXmlNode &	addThis
	)			`[inherited]`

Add a new node related to this.

Adds a child after the specified child. Returns a pointer to the new object or NULL if an error occured.

TiXmlNode* TiXmlNode::InsertBeforeChild	(	TiXmlNode *	beforeThis,
		const TiXmlNode &	addThis
	)			`[inherited]`

Add a new node related to this.

Adds a child before the specified child. Returns a pointer to the new object or NULL if an error occured.

TiXmlNode* TiXmlNode::InsertEndChild ( const TiXmlNode & addThis ) [inherited]

Add a new node related to this.

Adds a child past the LastChild. Returns a pointer to the new object or NULL if an error occured.

static int TiXmlBase::IsAlpha	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)			`[static, protected, inherited]`

static int TiXmlBase::IsAlphaNum	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)			`[static, protected, inherited]`

static bool TiXmlBase::IsWhiteSpace ( int c ) [inline, static, protected, inherited]

static bool TiXmlBase::IsWhiteSpace ( char c ) [inline, static, protected, inherited]

Referenced by TiXmlBase::IsWhiteSpace().

static bool TiXmlBase::IsWhiteSpaceCondensed ( ) [inline, static, inherited]

Return the current white space setting.

TiXmlNode* TiXmlNode::IterateChildren	(	const char *	_value,
		const TiXmlNode *	previous
	)			`[inline, inherited]`

const TiXmlNode* TiXmlNode::IterateChildren	(	const char *	value,
		const TiXmlNode *	previous
	)			const `[inherited]`

This flavor of IterateChildren searches for children with a particular 'value'.

TiXmlNode* TiXmlNode::IterateChildren ( const TiXmlNode * previous ) [inline, inherited]

const TiXmlNode* TiXmlNode::IterateChildren ( const TiXmlNode * previous ) const [inherited]

An alternate way to walk the children of a node.

One way to iterate over nodes is:

			for( child = parent->FirstChild(); child; child = child->NextSibling() )

IterateChildren does the same thing with the syntax:

			child = 0;
			while( child = parent->IterateChildren( child ) )

IterateChildren takes the previous child as input and finds the next one. If the previous child is null, it returns the first. IterateChildren will return null when done.

TiXmlNode* TiXmlNode::LastChild ( const char * _value ) [inline, inherited]

The last child of this node matching 'value'. Will be null if there are no children.

const TiXmlNode* TiXmlNode::LastChild ( const char * value ) const [inherited]

TiXmlNode* TiXmlNode::LastChild ( ) [inline, inherited]

The last child of this node. Will be null if there are no children.

const TiXmlNode* TiXmlNode::LastChild ( ) const [inline, inherited]

TiXmlNode* TiXmlNode::LinkEndChild ( TiXmlNode * addThis ) [inherited]

Add a new node related to this.

Adds a child past the LastChild.

NOTE: the node to be added is passed by pointer, and will be henceforth owned (and deleted) by tinyXml. This method is efficient and avoids an extra copy, but should be used with care as it uses a different memory model than the other insert functions.

See also:: InsertEndChild

bool TiXmlDocument::LoadFile	(	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.

bool TiXmlDocument::LoadFile	(	const char *	filename,
		TiXmlEncoding	encoding = `TIXML_DEFAULT_ENCODING`
	)

Load a file using the given filename. Returns true if successful.

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.

TiXmlNode* TiXmlNode::NextSibling ( const char * _next ) [inline, inherited]

const TiXmlNode* TiXmlNode::NextSibling ( const char * ) const [inherited]

Navigate to a sibling node with the given 'value'.

TiXmlNode* TiXmlNode::NextSibling ( ) [inline, inherited]

const TiXmlNode* TiXmlNode::NextSibling ( ) const [inline, inherited]

Navigate to a sibling node.

TiXmlElement* TiXmlNode::NextSiblingElement ( const char * _next ) [inline, inherited]

const TiXmlElement* TiXmlNode::NextSiblingElement ( const char * ) const [inherited]

Convenience function to get through elements.

Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

TiXmlElement* TiXmlNode::NextSiblingElement ( ) [inline, inherited]

const TiXmlElement* TiXmlNode::NextSiblingElement ( ) const [inherited]

Convenience function to get through elements.

Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

bool TiXmlNode::NoChildren ( ) const [inline, inherited]

Returns true if this node has no children.

void TiXmlDocument::operator= ( const TiXmlDocument & copy )

const TiXmlNode* TiXmlNode::Parent ( ) const [inline, inherited]

TiXmlNode* TiXmlNode::Parent ( ) [inline, inherited]

One step up the DOM.

virtual 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.

TiXmlNode* TiXmlNode::PreviousSibling ( const char * _prev ) [inline, inherited]

const TiXmlNode* TiXmlNode::PreviousSibling ( const char * ) const [inherited]

Navigate to a sibling node.

TiXmlNode* TiXmlNode::PreviousSibling ( ) [inline, inherited]

const TiXmlNode* TiXmlNode::PreviousSibling ( ) const [inline, inherited]

Navigate to a sibling node.

virtual void TiXmlDocument::Print	(	FILE *	cfile,
		int	depth = `0`
	)			const `[virtual]`

Print this Document to a FILE stream.

Implements TiXmlBase.

void TiXmlDocument::Print ( ) const [inline]

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

Referenced by Print().

static const char* TiXmlBase::ReadName	(	const char *	p,
		TIXML_STRING *	name,
		TiXmlEncoding	encoding
	)			`[static, protected, inherited]`

static const char* TiXmlBase::ReadText	(	const char *	in,
		TIXML_STRING *	text,
		bool	ignoreWhiteSpace,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)			`[static, protected, inherited]`

bool TiXmlNode::RemoveChild ( TiXmlNode * removeThis ) [inherited]

Delete a child of this node.

TiXmlNode* TiXmlNode::ReplaceChild	(	TiXmlNode *	replaceThis,
		const TiXmlNode &	withThis
	)			`[inherited]`

Replace a child of this node.

Returns a pointer to the new object or NULL if an error occured.

TiXmlElement* TiXmlDocument::RootElement ( ) [inline]

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.

int TiXmlBase::Row ( ) const [inline, inherited]

Return the position, in the original source file, of this node or attribute.

The row and column are 1-based. (That is the first row and first column is 1,1). If the returns values are 0 or less, then the parser does not have a row and column value.

Generally, the row and column value will be set when the TiXmlDocument::Load(), TiXmlDocument::LoadFile(), or any TiXmlNode::Parse() is called. It will NOT be set when the DOM was created from operator>>.

The values reflect the initial load. Once the DOM is modified programmatically (by adding or changing nodes and attributes) the new values will NOT update to reflect changes in the document.

There is a minor performance cost to computing the row and column. Computation can be disabled if TiXmlDocument::SetTabSize() is called with 0 as the value.

See also:: TiXmlDocument::SetTabSize()

bool TiXmlDocument::SaveFile ( FILE * ) const

Save a file using the given FILE*. Returns true if successful.

bool TiXmlDocument::SaveFile ( const char * filename ) const

Save a file using the given filename. Returns true if successful.

bool TiXmlDocument::SaveFile ( ) const

Save a file using the current document value. Returns true if successful.

static void TiXmlBase::SetCondenseWhiteSpace ( bool condense ) [inline, static, inherited]

The world does not agree on whether white space should be kept or not.

In order to make everyone happy, these global, static functions are provided to set whether or not TinyXml will condense all white space into a single space or not. The default is to condense. Note changing this value is not thread safe.

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

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

void TiXmlBase::SetUserData ( void * user ) [inline, inherited]

Set a pointer to arbitrary user data.

void TiXmlNode::SetValue ( const char * _value ) [inline, inherited]

Changes the value of the node.

Defined as:

		Document:	filename of the xml file
		Element:	name of the element
		Comment:	the comment text
		Unknown:	the tag contents
		Text:		the text string

Referenced by TiXmlComment::TiXmlComment(), and TiXmlText::TiXmlText().

static const char* TiXmlBase::SkipWhiteSpace	(	const char *	,
		TiXmlEncoding	encoding
	)			`[static, protected, inherited]`

static bool TiXmlBase::StringEqual	(	const char *	p,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)			`[static, protected, inherited]`

int TiXmlDocument::TabSize ( ) const [inline]

virtual TiXmlComment* TiXmlNode::ToComment ( ) [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlComment.

virtual const TiXmlComment* TiXmlNode::ToComment ( ) const [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlComment.

virtual TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlDeclaration.

virtual const TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) const [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlDeclaration.

virtual TiXmlDocument* TiXmlDocument::ToDocument ( ) [inline, virtual]

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

virtual const TiXmlDocument* TiXmlDocument::ToDocument ( ) const [inline, virtual]

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

virtual TiXmlElement* TiXmlNode::ToElement ( ) [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlElement.

virtual const TiXmlElement* TiXmlNode::ToElement ( ) const [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlElement.

static int TiXmlBase::ToLower	(	int	v,
		TiXmlEncoding	encoding
	)			`[inline, static, protected, inherited]`

virtual TiXmlText* TiXmlNode::ToText ( ) [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlText.

virtual const TiXmlText* TiXmlNode::ToText ( ) const [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlText.

virtual TiXmlUnknown* TiXmlNode::ToUnknown ( ) [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlUnknown.

virtual const TiXmlUnknown* TiXmlNode::ToUnknown ( ) const [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlUnknown.

int TiXmlNode::Type ( ) const [inline, inherited]

Query the type (as an enumerated value, above) of this node.

The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.

const char* TiXmlNode::Value ( ) const [inline, inherited]

The meaning of 'value' changes for the specific type of TiXmlNode.

		Document:	filename of the xml file
		Element:	name of the element
		Comment:	the comment text
		Unknown:	the tag contents
		Text:		the text string

The subclasses will wrap this function.

const TIXML_STRING& TiXmlNode::ValueTStr ( ) const [inline, inherited]

Member Data Documentation

const char* TiXmlBase::errorString[TIXML_ERROR_STRING_COUNT] [static, protected, inherited]

TiXmlNode* TiXmlNode::firstChild [protected, inherited]

Referenced by TiXmlNode::FirstChild(), and TiXmlNode::NoChildren().

TiXmlNode* TiXmlNode::lastChild [protected, inherited]

Referenced by TiXmlNode::LastChild().

TiXmlCursor TiXmlBase::location [protected, inherited]

Referenced by TiXmlBase::Column(), and TiXmlBase::Row().

TiXmlNode* TiXmlNode::next [protected, inherited]

Referenced by TiXmlNode::NextSibling().

TiXmlNode* TiXmlNode::parent [protected, inherited]

Referenced by TiXmlNode::Parent().

TiXmlNode* TiXmlNode::prev [protected, inherited]

Referenced by TiXmlNode::PreviousSibling().

NodeType TiXmlNode::type [protected, inherited]

Referenced by TiXmlNode::Type().

void* TiXmlBase::userData [protected, inherited]

Field containing a generic user pointer.

Referenced by TiXmlBase::GetUserData(), and TiXmlBase::SetUserData().

const int TiXmlBase::utf8ByteTable[256] [static, inherited]

Referenced by TiXmlBase::GetChar().

TIXML_STRING TiXmlNode::value [protected, inherited]

Referenced by TiXmlNode::SetValue(), TiXmlNode::Value(), and TiXmlNode::ValueTStr().

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

include/sk/other/tinyxml/tinyxml.h


Public Types
enum	NodeType { DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, DECLARATION, TYPECOUNT }
	The types of XML nodes supported by TinyXml. More...
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)
void	operator= (const TiXmlDocument &copy)
virtual	~TiXmlDocument ()
bool	LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
	Load a file using the current document value.
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)
	Load a file using the given FILE*.
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)
	Parse the given null terminated block of xml data.
const TiXmlElement *	RootElement () const
	Get the root element -- the only top level element -- of the document.
TiXmlElement *	RootElement ()
bool	Error () const
	If an error occurs, Error will be set to true.
const char *	ErrorDesc () const
	Contains a textual (english) description of the error if one occurs.
int	ErrorId () const
	Generally, you probably want the error string ( ErrorDesc() ).
int	ErrorRow () const
	Returns the location (if known) of the error.
int	ErrorCol () const
	The column where the error occured. See ErrorRow().
void	SetTabSize (int _tabsize)
	SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column.
int	TabSize () const
void	ClearError ()
	If you have handled the error, it can be reset with this call.
void	Print () const
	Write the document to standard out using formatted printing ("pretty print").
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
	Walk the XML tree visiting this node and all of its children.
const char *	Value () const
	The meaning of 'value' changes for the specific type of TiXmlNode.
const TIXML_STRING &	ValueTStr () const
void	SetValue (const char *_value)
	Changes the value of the node.
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
	The first child of this node with the matching 'value'. Will be null if none found. The first child of this node with the matching 'value'. Will be null if none found.
TiXmlNode *	FirstChild (const char *_value)
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
	An alternate way to walk the children of a node.
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)
	Add a new node related to this.
TiXmlNode *	LinkEndChild (TiXmlNode *addThis)
	Add a new node related to this.
TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
	Add a new node related to this.
TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
	Add a new node related to this.
TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
	Replace a child of this node.
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
	Convenience function to get through elements.
TiXmlElement *	NextSiblingElement ()
const TiXmlElement *	NextSiblingElement (const char *) const
	Convenience function to get through elements.
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
	Query the type (as an enumerated value, above) of this node.
const TiXmlDocument *	GetDocument () const
	Return a pointer to the Document this node lives in.
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 TiXmlElement *	ToElement ()
	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 TiXmlComment *	ToComment ()
	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 TiXmlUnknown *	ToUnknown ()
	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 TiXmlText *	ToText ()
	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 TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null if not of the requested type.
int	Row () const
	Return the position, in the original source file, of this node or attribute.
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.
Static Public Member Functions
static void	SetCondenseWhiteSpace (bool condense)
	The world does not agree on whether white space should be kept or not.
static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting.
static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
	Expands entities in a string.
Static Public Attributes
static const int	utf8ByteTable [256]
Protected Member Functions
virtual TiXmlNode *	Clone () const
	Create an exact duplicate of this node and return it.
void	CopyTo (TiXmlNode *target) const
TiXmlNode *	Identify (const char *start, TiXmlEncoding encoding)
Static Protected Member Functions
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
TiXmlNode *	parent
NodeType	type
TiXmlNode *	firstChild
TiXmlNode *	lastChild
TIXML_STRING	value
TiXmlNode *	prev
TiXmlNode *	next
TiXmlCursor	location
void *	userData
	Field containing a generic user pointer.
Static Protected Attributes
static const char *	errorString [TIXML_ERROR_STRING_COUNT]