The parent class for everything in the Document Object Model. More...

#include <tinyxml.h>

Public Types
enum	NodeType { TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN, TINYXML_TEXT, TINYXML_DECLARATION, TINYXML_TYPECOUNT }
	The types of XML nodes supported by TinyXml. More...

Public Types inherited from omega::xml::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 }

Public Member Functions
virtual	~TiXmlNode ()

const char *	Value () const
	The meaning of 'value' changes for the specific type of TiXmlNode. More...

const TIXML_STRING &	ValueTStr () const

void	SetValue (const char *_value)
	Changes the value of the node. More...

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

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

const TiXmlNode *	Parent () const

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
	The first child of this node with the matching 'value'. More...

TiXmlNode *	FirstChild (const char *_value)
	The first child of this node with the matching 'value'. Will be null if none found. 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 *	IterateChildren (const TiXmlNode *previous) const
	An alternate way to walk the children of a node. More...

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)

TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)
	Add a new node related to this. More...

TiXmlNode *	LinkEndChild (TiXmlNode *addThis)
	Add a new node related to this. More...

TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
	Add a new node related to this. More...

TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
	Add a new node related to this. More...

TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
	Replace a child of this node. More...

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

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 *	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
	Convenience function to get through elements. More...

TiXmlElement *	NextSiblingElement ()

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

TiXmlElement *	NextSiblingElement (const char *_next)

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)

int	Type () const
	Query the type (as an enumerated value, above) of this node. More...

const TiXmlDocument *	GetDocument () const
	Return a pointer to the Document this node lives in. More...

TiXmlDocument *	GetDocument ()

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

virtual const TiXmlDocument *	ToDocument () const
	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 const TiXmlComment *	ToComment () const
	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 const TiXmlText *	ToText () const
	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 TiXmlDocument *	ToDocument ()
	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 TiXmlComment *	ToComment ()
	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...

virtual TiXmlText *	ToText ()
	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 TiXmlNode *	Clone () const =0
	Create an exact duplicate of this node and return it. More...

virtual bool	Accept (TiXmlVisitor *visitor) const =0
	Accept a hierchical visit the nodes in the TinyXML DOM. More...

Public Member Functions inherited from omega::xml::TiXmlBase
	TiXmlBase ()

virtual	~TiXmlBase ()

virtual void	Print (FILE *cfile, int depth) const =0
	All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null. More...

int	Row () const
	Return the position, in the original source file, of this node or attribute. More...

int	Column () const
	See Row() More...

void	SetUserData (void *user)
	Set a pointer to arbitrary user data. 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

Protected Member Functions
	TiXmlNode (NodeType _type)

void	CopyTo (TiXmlNode *target) const

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

Protected Attributes
TiXmlNode *	parent

NodeType	type

TiXmlNode *	firstChild

TiXmlNode *	lastChild

TIXML_STRING	value

TiXmlNode *	prev

TiXmlNode *	next

Protected Attributes inherited from omega::xml::TiXmlBase
TiXmlCursor	location

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

Friends
class	TiXmlDocument

class	TiXmlElement

Additional Inherited Members
Static Public Member Functions inherited from omega::xml::TiXmlBase
static void	SetCondenseWhiteSpace (bool condense)
	The world does not agree on whether white space should be kept or not. More...

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

static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
	Expands entities in a string. More...

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

Static Protected Member Functions inherited from omega::xml::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)

Static Protected Attributes inherited from omega::xml::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.

Inheritance diagram for omega::xml::TiXmlNode:

Member Enumeration Documentation

enum omega::xml::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

Constructor & Destructor Documentation

virtual omega::xml::TiXmlNode::~TiXmlNode ( )

virtual

omega::xml::TiXmlNode::TiXmlNode ( NodeType _type )

protected

Member Function Documentation

virtual bool omega::xml::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 omega::xml::TiXmlDocument, omega::xml::TiXmlUnknown, omega::xml::TiXmlDeclaration, omega::xml::TiXmlText, omega::xml::TiXmlComment, and omega::xml::TiXmlElement.

void omega::xml::TiXmlNode::Clear ( )

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

virtual TiXmlNode* omega::xml::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 omega::xml::TiXmlDocument, omega::xml::TiXmlUnknown, omega::xml::TiXmlDeclaration, omega::xml::TiXmlText, omega::xml::TiXmlComment, and omega::xml::TiXmlElement.

void omega::xml::TiXmlNode::CopyTo ( TiXmlNode * target ) const

protected

const TiXmlNode* omega::xml::TiXmlNode::FirstChild ( ) const

inline

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

TiXmlNode* omega::xml::TiXmlNode::FirstChild ( )

inline

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

The first child of this node with the matching 'value'.

Will be null if none found.

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

inline

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

const TiXmlElement* omega::xml::TiXmlNode::FirstChildElement ( ) const

Convenience function to get through elements.

TiXmlElement* omega::xml::TiXmlNode::FirstChildElement ( )

inline

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

Convenience function to get through elements.

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

inline

const TiXmlDocument* omega::xml::TiXmlNode::GetDocument ( ) const

Return a pointer to the Document this node lives in.

Returns null if not in a document.

TiXmlDocument* omega::xml::TiXmlNode::GetDocument ( )

inline

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

protected

TiXmlNode* omega::xml::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.

TiXmlNode* omega::xml::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.

TiXmlNode* omega::xml::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.

const TiXmlNode* omega::xml::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.

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

inline

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

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

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

inline

const TiXmlNode* omega::xml::TiXmlNode::LastChild ( ) const

inline

TiXmlNode* omega::xml::TiXmlNode::LastChild ( )

inline

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

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

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

inline

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

TiXmlNode* omega::xml::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

const TiXmlNode* omega::xml::TiXmlNode::NextSibling ( ) const

inline

Navigate to a sibling node.

TiXmlNode* omega::xml::TiXmlNode::NextSibling ( )

inline

const TiXmlNode* omega::xml::TiXmlNode::NextSibling ( const char * ) const

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

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

inline

const TiXmlElement* omega::xml::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.

TiXmlElement* omega::xml::TiXmlNode::NextSiblingElement ( )

inline

const TiXmlElement* omega::xml::TiXmlNode::NextSiblingElement ( const char * ) 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.

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

inline

bool omega::xml::TiXmlNode::NoChildren ( ) const

inline

Returns true if this node has no children.

TiXmlNode* omega::xml::TiXmlNode::Parent ( )

inline

One step up the DOM.

const TiXmlNode* omega::xml::TiXmlNode::Parent ( ) const

inline

const TiXmlNode* omega::xml::TiXmlNode::PreviousSibling ( ) const

inline

Navigate to a sibling node.

TiXmlNode* omega::xml::TiXmlNode::PreviousSibling ( )

inline

const TiXmlNode* omega::xml::TiXmlNode::PreviousSibling ( const char * ) const

Navigate to a sibling node.

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

inline

bool omega::xml::TiXmlNode::RemoveChild ( TiXmlNode * removeThis )

Delete a child of this node.

TiXmlNode* omega::xml::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.

void omega::xml::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

virtual const TiXmlComment* omega::xml::TiXmlNode::ToComment ( ) const

inlinevirtual