#include <tinyxml.h>

Inheritance diagram for TiXmlNode:

[legend]

Public Member Functions
virtual bool	Accept (TiXmlVisitor *visitor) const =0

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

virtual TiXmlNode *	Clone () const =0

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

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

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

TiXmlElement *	FirstChildElement ()

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

TiXmlElement *	FirstChildElement (const char *_value)

const TiXmlDocument *	GetDocument () const

TiXmlDocument *	GetDocument ()

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

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

TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)

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'. More...

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

const TiXmlNode *	LastChild () const

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

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

TiXmlNode *	LinkEndChild (TiXmlNode *addThis)

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

TiXmlNode *	NextSibling ()

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

TiXmlNode *	NextSibling (const char *_next)

const TiXmlElement *	NextSiblingElement () const

TiXmlElement *	NextSiblingElement ()

const TiXmlElement *	NextSiblingElement (const char *) const

TiXmlElement *	NextSiblingElement (const char *_next)

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

TiXmlNode *	Parent ()
	One step up the DOM. More...

const TiXmlNode *	Parent () const

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

TiXmlNode *	PreviousSibling ()

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

TiXmlNode *	PreviousSibling (const char *_prev)

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

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

void	SetValue (const char *_value)

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

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

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

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

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

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

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

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

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

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

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

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

int	Type () const

const char *	Value () const

const TIXML_STRING &	ValueTStr () const

virtual	~TiXmlNode ()

Public Member Functions inherited from TiXmlBase
int	Column () const
	See Row() More...

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

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

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

virtual void	Print (FILE *cfile, int depth) const =0

int	Row () const

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

	TiXmlBase ()

virtual	~TiXmlBase ()

Protected Member Functions
void	CopyTo (TiXmlNode *target) const

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

	TiXmlNode (NodeType _type)

Protected Attributes
TiXmlNode *	firstChild

TiXmlNode *	lastChild

TiXmlNode *	next

TiXmlNode *	parent

TiXmlNode *	prev

NodeType	type

TIXML_STRING	value

Protected Attributes inherited from TiXmlBase
TiXmlCursor	location

void *	userData
	Field containing a generic user pointer. More...

Private Member Functions
void	operator= (const TiXmlNode &base)

	TiXmlNode (const TiXmlNode &)

Friends
class	TiXmlDocument

class	TiXmlElement

Additional Inherited Members
Static Public Member Functions inherited from TiXmlBase
static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)

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

static void	SetCondenseWhiteSpace (bool condense)

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

Static Protected Member Functions inherited from TiXmlBase
static void	ConvertUTF32ToUTF8 (unsigned long input, char output, int length)

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

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

static int	IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)

static int	IsAlphaNum (unsigned char anyByte, 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 *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)

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

static int	ToLower (int v, TiXmlEncoding encoding)

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

Detailed Description

The parent class for everything in the Document Object Model. (Except for attributes). Nodes have siblings, a parent, and children. A node can be in a document, or stand on its own. The type of a TiXmlNode can be queried, and it can be cast to its more defined type.

Definition at line 472 of file tinyxml.h.

Member Enumeration Documentation

enum TiXmlNode::NodeType

The types of XML nodes supported by TinyXml. (All the unsupported types are picked up by UNKNOWN.)

Enumerator
TINYXML_DOCUMENT
TINYXML_ELEMENT
TINYXML_COMMENT
TINYXML_UNKNOWN
TINYXML_TEXT
TINYXML_DECLARATION
TINYXML_TYPECOUNT

Definition at line 512 of file tinyxml.h.

Constructor & Destructor Documentation

TiXmlNode::~TiXmlNode ( )

virtual

Definition at line 147 of file tinyxml.cpp.

TiXmlNode::TiXmlNode ( NodeType _type )

protected

Definition at line 136 of file tinyxml.cpp.

TiXmlNode::TiXmlNode ( const TiXmlNode & )

private

Member Function Documentation

virtual bool TiXmlNode::Accept ( TiXmlVisitor * visitor ) const

pure virtual

Accept a hierchical visit the nodes in the TinyXML DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the TiXmlVisitor interface.

This is essentially a SAX interface for TinyXML. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML is unchanged by using this interface versus any other.)

The interface has been based on ideas from:

Which are both good references for "visiting".

An example of using Accept():

TiXmlPrinter printer;
tinyxmlDoc.Accept( &printer );
const char* xmlcstr = printer.CStr();

Implemented in TiXmlDocument, TiXmlUnknown, TiXmlDeclaration, TiXmlText, TiXmlComment, and TiXmlElement.

void TiXmlNode::Clear ( )

Delete all the children of this node. Does not affect 'this'.

Definition at line 169 of file tinyxml.cpp.

virtual TiXmlNode* TiXmlNode::Clone ( ) const

pure virtual

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

Implemented in TiXmlDocument, TiXmlUnknown, TiXmlDeclaration, TiXmlText, TiXmlComment, and TiXmlElement.

void TiXmlNode::CopyTo ( TiXmlNode * target ) const

protected

Definition at line 161 of file tinyxml.cpp.

const TiXmlNode* TiXmlNode::FirstChild ( ) const

inline

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

Definition at line 578 of file tinyxml.h.

TiXmlNode* TiXmlNode::FirstChild ( )

inline

Definition at line 580 of file tinyxml.h.

const TiXmlNode * TiXmlNode::FirstChild ( const char * value ) const

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

Definition at line 361 of file tinyxml.cpp.

TiXmlNode* TiXmlNode::FirstChild ( const char * _value )

inline

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

Definition at line 586 of file tinyxml.h.

const TiXmlElement * TiXmlNode::FirstChildElement ( ) const

Convenience function to get through elements.

Definition at line 452 of file tinyxml.cpp.

TiXmlElement* TiXmlNode::FirstChildElement ( )

inline

Definition at line 750 of file tinyxml.h.

const TiXmlElement * TiXmlNode::FirstChildElement ( const char * _value ) const

Convenience function to get through elements.

Definition at line 467 of file tinyxml.cpp.

TiXmlElement* TiXmlNode::FirstChildElement ( const char * _value )

inline

Definition at line 758 of file tinyxml.h.

const TiXmlDocument * TiXmlNode::GetDocument ( ) const

Return a pointer to the Document this node lives in. Returns null if not in a document.

Definition at line 512 of file tinyxml.cpp.

TiXmlDocument* TiXmlNode::GetDocument ( )

inline

Definition at line 780 of file tinyxml.h.

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

protected

Definition at line 818 of file tinyxmlparser.cpp.

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

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.

Definition at line 263 of file tinyxml.cpp.

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

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.

Definition at line 230 of file tinyxml.cpp.

TiXmlNode * TiXmlNode::InsertEndChild ( const TiXmlNode & addThis )

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.

Definition at line 214 of file tinyxml.cpp.

const TiXmlNode * TiXmlNode::IterateChildren ( const TiXmlNode * previous ) const

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.

Definition at line 385 of file tinyxml.cpp.

TiXmlNode* TiXmlNode::IterateChildren ( const TiXmlNode * previous )

inline

Definition at line 630 of file tinyxml.h.

const TiXmlNode * TiXmlNode::IterateChildren	(	const char *	value,
		const TiXmlNode *	previous
	)		const

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

Definition at line 399 of file tinyxml.cpp.

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

inline

Definition at line 638 of file tinyxml.h.

const TiXmlNode* TiXmlNode::LastChild ( ) const

inline

Definition at line 593 of file tinyxml.h.

TiXmlNode* TiXmlNode::LastChild ( )

inline

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

Definition at line 595 of file tinyxml.h.

const TiXmlNode * TiXmlNode::LastChild ( const char * value ) const

Definition at line 373 of file tinyxml.cpp.

TiXmlNode* TiXmlNode::LastChild ( const char * _value )

inline

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

Definition at line 600 of file tinyxml.h.

TiXmlNode * TiXmlNode::LinkEndChild ( TiXmlNode * addThis )

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

Definition at line 186 of file tinyxml.cpp.

const TiXmlNode* TiXmlNode::NextSibling ( ) const

inline

Navigate to a sibling node.

Definition at line 706 of file tinyxml.h.

TiXmlNode* TiXmlNode::NextSibling ( )

inline

Definition at line 709 of file tinyxml.h.

const TiXmlNode * TiXmlNode::NextSibling ( const char * _value ) const

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

Definition at line 413 of file tinyxml.cpp.

TiXmlNode* TiXmlNode::NextSibling ( const char * _next )

inline

Definition at line 715 of file tinyxml.h.

const TiXmlElement * TiXmlNode::NextSiblingElement ( ) const

Convenience function to get through elements. Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

Definition at line 482 of file tinyxml.cpp.

TiXmlElement* TiXmlNode::NextSiblingElement ( )

inline

Definition at line 726 of file tinyxml.h.

const TiXmlElement * TiXmlNode::NextSiblingElement ( const char * _value ) const

Convenience function to get through elements. Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

Definition at line 497 of file tinyxml.cpp.

TiXmlElement* TiXmlNode::NextSiblingElement ( const char * _next )

inline

Definition at line 737 of file tinyxml.h.

bool TiXmlNode::NoChildren ( ) const

inline

Returns true if this node has no children.

Definition at line 786 of file tinyxml.h.

void TiXmlNode::operator= ( const TiXmlNode & base )

private

TiXmlNode* TiXmlNode::Parent ( )

inline

One step up the DOM.

Definition at line 572 of file tinyxml.h.

const TiXmlNode* TiXmlNode::Parent ( ) const

inline

Definition at line 575 of file tinyxml.h.

const TiXmlNode* TiXmlNode::PreviousSibling ( ) const

inline

Navigate to a sibling node.

Definition at line 684 of file tinyxml.h.

TiXmlNode* TiXmlNode::PreviousSibling ( )

inline

Definition at line 687 of file tinyxml.h.

const TiXmlNode * TiXmlNode::PreviousSibling ( const char * _value ) const

Navigate to a sibling node.

Definition at line 425 of file tinyxml.cpp.

TiXmlNode* TiXmlNode::PreviousSibling ( const char * _prev )

inline

Definition at line 693 of file tinyxml.h.

bool TiXmlNode::RemoveChild ( TiXmlNode * removeThis )

Delete a child of this node.

Definition at line 335 of file tinyxml.cpp.

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

Replace a child of this node. Returns a pointer to the new object or NULL if an error occured.

Definition at line 296 of file tinyxml.cpp.

void TiXmlNode::SetValue ( const char * _value )

inline

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

Definition at line 560 of file tinyxml.h.

virtual const TiXmlComment* TiXmlNode::ToComment ( ) const

inlinevirtual