#include <tinyxml.h>

Inheritance diagram for TiXmlNode:

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 TiXmlNode *	FirstChild (const std::string &_value) const
	STL std::string form. More...

TiXmlNode *	FirstChild (const std::string &_value)
	STL std::string form. 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 TiXmlElement *	FirstChildElement (const std::string &_value) const
	STL std::string form. More...

TiXmlElement *	FirstChildElement (const std::string &_value)
	STL std::string form. More...

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 *	IterateChildren (const std::string &_value, const TiXmlNode *previous) const
	STL std::string form. More...

TiXmlNode *	IterateChildren (const std::string &_value, const TiXmlNode *previous)
	STL std::string form. More...

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

const TiXmlNode *	LastChild (const std::string &_value) const
	STL std::string form. More...

TiXmlNode *	LastChild (const std::string &_value)
	STL std::string form. More...

TiXmlNode *	LinkEndChild (TiXmlNode *addThis)

const TiXmlNode *	NextSibling (const std::string &_value) const
	STL std::string form. More...

TiXmlNode *	NextSibling (const std::string &_value)
	STL std::string form. More...

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)

const TiXmlElement *	NextSiblingElement (const std::string &_value) const
	STL std::string form. More...

TiXmlElement *	NextSiblingElement (const std::string &_value)
	STL std::string form. More...

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)

const TiXmlNode *	PreviousSibling (const std::string &_value) const
	STL std::string form. More...

TiXmlNode *	PreviousSibling (const std::string &_value)
	STL std::string form. More...

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

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

void	SetValue (const char *_value)

void	SetValue (const std::string &_value)
	STL std::string form. More...

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 std::string &	ValueStr () const

const std::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)

virtual void	StreamIn (std::istream in, std::string tag)=0

	TiXmlNode (NodeType _type)

Protected Attributes
TiXmlNode *	firstChild

TiXmlNode *	lastChild

TiXmlNode *	next

TiXmlNode *	parent

TiXmlNode *	prev

NodeType	type

std::string	value

Protected Attributes inherited from TiXmlBase
TiXmlCursor	location

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

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

	TiXmlNode (const TiXmlNode &)

Friends
std::ostream &	operator<< (std::ostream &out, const TiXmlNode &base)

std::string &	operator<< (std::string &out, const TiXmlNode &base)
	Appends the XML node or attribute to a std::string. More...

std::istream &	operator>> (std::istream &in, TiXmlNode &base)

class	TiXmlDocument

class	TiXmlElement

Additional Inherited Members
Static Public Member Functions inherited from TiXmlBase
static void	EncodeString (const std::string &str, std::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, std::string name, TiXmlEncoding encoding)

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

static const char *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)

static bool	StreamTo (std::istream in, int character, std::string tag)

static bool	StreamWhiteSpace (std::istream in, std::string tag)

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 *const	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 427 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
DOCUMENT
ELEMENT
COMMENT
UNKNOWN
TEXT
DECLARATION
TYPECOUNT

Definition at line 466 of file tinyxml.h.

Constructor & Destructor Documentation

TiXmlNode::~TiXmlNode ( )

virtual

Definition at line 154 of file tinyxml.cc.

TiXmlNode::TiXmlNode ( NodeType _type )

protected

Definition at line 143 of file tinyxml.cc.

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 175 of file tinyxml.cc.

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 168 of file tinyxml.cc.

const TiXmlNode* TiXmlNode::FirstChild ( ) const

inline

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

Definition at line 526 of file tinyxml.h.

TiXmlNode* TiXmlNode::FirstChild ( )

inline

Definition at line 527 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 348 of file tinyxml.cc.

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 530 of file tinyxml.h.

const TiXmlNode* TiXmlNode::FirstChild ( const std::string & _value ) const

inline

STL std::string form.

Definition at line 544 of file tinyxml.h.

TiXmlNode* TiXmlNode::FirstChild ( const std::string & _value )

inline

STL std::string form.

Definition at line 545 of file tinyxml.h.

const TiXmlElement * TiXmlNode::FirstChildElement ( ) const

Convenience function to get through elements.

Definition at line 439 of file tinyxml.cc.

TiXmlElement* TiXmlNode::FirstChildElement ( )

inline

Definition at line 669 of file tinyxml.h.

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

Convenience function to get through elements.

Definition at line 454 of file tinyxml.cc.

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

inline

Definition at line 675 of file tinyxml.h.

const TiXmlElement* TiXmlNode::FirstChildElement ( const std::string & _value ) const

inline

STL std::string form.

Definition at line 680 of file tinyxml.h.

TiXmlElement* TiXmlNode::FirstChildElement ( const std::string & _value )

inline

STL std::string form.

Definition at line 681 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 499 of file tinyxml.cc.

TiXmlDocument* TiXmlNode::GetDocument ( )

inline

Definition at line 694 of file tinyxml.h.

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

protected

Definition at line 832 of file tinyxmlparser.cc.

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

Definition at line 266 of file tinyxml.cc.

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

Definition at line 234 of file tinyxml.cc.

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

Definition at line 219 of file tinyxml.cc.

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 372 of file tinyxml.cc.

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

inline

Definition at line 567 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 386 of file tinyxml.cc.

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

inline

Definition at line 573 of file tinyxml.h.

const TiXmlNode* TiXmlNode::IterateChildren	(	const std::string &	_value,
		const TiXmlNode *	previous
	)		const

inline

STL std::string form.

Definition at line 578 of file tinyxml.h.

TiXmlNode* TiXmlNode::IterateChildren	(	const std::string &	_value,
		const TiXmlNode *	previous
	)

inline

STL std::string form.

Definition at line 579 of file tinyxml.h.

const TiXmlNode* TiXmlNode::LastChild ( ) const

inline

Definition at line 535 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 536 of file tinyxml.h.

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

Definition at line 360 of file tinyxml.cc.

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 539 of file tinyxml.h.

const TiXmlNode* TiXmlNode::LastChild ( const std::string & _value ) const

inline

STL std::string form.

Definition at line 546 of file tinyxml.h.

TiXmlNode* TiXmlNode::LastChild ( const std::string & _value )

inline

STL std::string form.

Definition at line 547 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 192 of file tinyxml.cc.

const TiXmlNode* TiXmlNode::NextSibling ( const std::string & _value ) const

inline

STL std::string form.

Definition at line 630 of file tinyxml.h.

TiXmlNode* TiXmlNode::NextSibling ( const std::string & _value )

inline

STL std::string form.

Definition at line 631 of file tinyxml.h.

const TiXmlNode* TiXmlNode::NextSibling ( ) const

inline

Navigate to a sibling node.

Definition at line 635 of file tinyxml.h.

TiXmlNode* TiXmlNode::NextSibling ( )

inline

Definition at line 636 of file tinyxml.h.

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

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

Definition at line 400 of file tinyxml.cc.

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

inline

Definition at line 640 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 469 of file tinyxml.cc.

TiXmlElement* TiXmlNode::NextSiblingElement ( )

inline

Definition at line 649 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 484 of file tinyxml.cc.

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

inline

Definition at line 658 of file tinyxml.h.

const TiXmlElement* TiXmlNode::NextSiblingElement ( const std::string & _value ) const

inline

STL std::string form.

Definition at line 663 of file tinyxml.h.

TiXmlElement* TiXmlNode::NextSiblingElement ( const std::string & _value )

inline

STL std::string form.

Definition at line 664 of file tinyxml.h.

bool TiXmlNode::NoChildren ( ) const

inline

Returns true if this node has no children.

Definition at line 699 of file tinyxml.h.

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

private

TiXmlNode* TiXmlNode::Parent ( )

inline

One step up the DOM.

Definition at line 523 of file tinyxml.h.

const TiXmlNode* TiXmlNode::Parent ( ) const

inline

Definition at line 524 of file tinyxml.h.

const TiXmlNode* TiXmlNode::PreviousSibling ( ) const

inline

Navigate to a sibling node.

Definition at line 618 of file tinyxml.h.

TiXmlNode* TiXmlNode::PreviousSibling ( )

inline

Definition at line 619 of file tinyxml.h.

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

Navigate to a sibling node.

Definition at line 412 of file tinyxml.cc.

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

inline

Definition at line 623 of file tinyxml.h.

const TiXmlNode* TiXmlNode::PreviousSibling ( const std::string & _value ) const

inline

STL std::string form.

Definition at line 628 of file tinyxml.h.

TiXmlNode* TiXmlNode::PreviousSibling ( const std::string & _value )

inline

STL std::string form.

Definition at line 629 of file tinyxml.h.

bool TiXmlNode::RemoveChild ( TiXmlNode * removeThis )

Delete a child of this node.

Definition at line 326 of file tinyxml.cc.

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

Definition at line 298 of file tinyxml.cc.

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 512 of file tinyxml.h.

void TiXmlNode::SetValue ( const std::string & _value )

inline

STL std::string form.

Definition at line 516 of file tinyxml.h.

virtual void TiXmlNode::StreamIn	(	std::istream *	in,
		std::string *	tag
	)

protectedpure virtual

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

virtual const TiXmlComment* TiXmlNode::ToComment ( ) const

inlinevirtual