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

#include "tinyxml.h"

Inheritance diagram for TiXmlNode:

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 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 bool	Accept (TiXmlVisitor *visitor) const =0
	Accept a hierchical visit the nodes in the TinyXML DOM. More...

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

virtual TiXmlNode *	Clone () const =0
	Create an exact duplicate of this node and return it. More...

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 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
	Return a pointer to the Document this node lives in. More...

TiXmlDocument *	GetDocument ()

TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const 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 *	InsertEndChild (const TiXmlNode &addThis)
	Add a new node related to this. 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)

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)
	Add a new node related to this. 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
	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)

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)
	Replace a child of this node. More...

void	SetValue (const char *_value)
	Changes the value of the node. 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
	Query the type (as an enumerated value, above) of this node. More...

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

const TiXmlString &	ValueTStr () const

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

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

Friends
class	TiXmlDocument

class	TiXmlElement

Additional Inherited Members
Static Public Member Functions inherited from TiXmlBase
static void	EncodeString (const TiXmlString &str, TiXmlString *out)
	Expands entities in a string. More...

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

static void	SetCondenseWhiteSpace (bool condense)
	The world does not agree on whether white space should be kept or not. More...

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

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

Member Enumeration Documentation

◆ NodeType

enum TiXmlNode::NodeType

The types of XML nodes supported by TinyXml.

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

Definition at line 462 of file tinyxml.h.

Member Function Documentation

◆ Accept()

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.

Referenced by TiXmlElement::Accept(), and TiXmlDocument::Accept().

◆ Clear()

void TiXmlNode::Clear ( )

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

Definition at line 191 of file tinyxml.cpp.

Referenced by TiXmlDocument::LoadFile().

◆ Clone()

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 TiXmlUnknown, TiXmlDeclaration, TiXmlComment, and TiXmlElement.

Referenced by InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), and ReplaceChild().

◆ FirstChild() [1/3]

const TiXmlNode* TiXmlNode::FirstChild ( ) const

inline

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

Definition at line 522 of file tinyxml.h.

Referenced by TiXmlElement::Accept(), TiXmlDocument::Accept(), FirstChild(), FirstChildElement(), TiXmlElement::GetText(), IterateChildren(), TiXmlDocument::Print(), TiXmlPrinter::VisitEnter(), and TiXmlPrinter::VisitExit().

◆ FirstChild() [2/3]

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 379 of file tinyxml.cpp.

References Value().

◆ FirstChild() [3/3]

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

References FirstChild().

◆ FirstChildElement() [1/2]

const TiXmlElement * TiXmlNode::FirstChildElement ( ) const

Convenience function to get through elements.

Definition at line 470 of file tinyxml.cpp.

References FirstChild(), NextSibling(), and ToElement().

Referenced by TiXmlDocument::RootElement().

◆ FirstChildElement() [2/2]

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

Convenience function to get through elements.

Definition at line 485 of file tinyxml.cpp.

References FirstChild(), NextSibling(), and ToElement().

◆ GetDocument()

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

References ToDocument().

Referenced by InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), LinkEndChild(), and ReplaceChild().

◆ InsertAfterChild()

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 282 of file tinyxml.cpp.

References Clone(), GetDocument(), and Type().

◆ InsertBeforeChild()

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 250 of file tinyxml.cpp.

References Clone(), GetDocument(), and Type().

◆ InsertEndChild()

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 235 of file tinyxml.cpp.

References Clone(), GetDocument(), LinkEndChild(), and Type().

◆ IterateChildren() [1/2]

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 403 of file tinyxml.cpp.

References FirstChild(), and NextSibling().

◆ IterateChildren() [2/2]

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 417 of file tinyxml.cpp.

References FirstChild(), and NextSibling().

◆ LastChild() [1/2]

TiXmlNode* TiXmlNode::LastChild ( )

inline

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

Definition at line 532 of file tinyxml.h.

◆ LastChild() [2/2]

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

◆ LinkEndChild()

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 208 of file tinyxml.cpp.

References GetDocument(), and Type().

Referenced by InsertEndChild().

◆ NextSibling() [1/2]

const TiXmlNode* TiXmlNode::NextSibling ( ) const

inline

Navigate to a sibling node.

Definition at line 631 of file tinyxml.h.

Referenced by TiXmlElement::Accept(), TiXmlDocument::Accept(), FirstChildElement(), IterateChildren(), NextSiblingElement(), and TiXmlDocument::Print().

◆ NextSibling() [2/2]

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

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

Definition at line 431 of file tinyxml.cpp.

References Value().

◆ NextSiblingElement() [1/2]

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 500 of file tinyxml.cpp.

References NextSibling(), and ToElement().

◆ NextSiblingElement() [2/2]

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 515 of file tinyxml.cpp.

References NextSibling(), and ToElement().

◆ NoChildren()

bool TiXmlNode::NoChildren ( ) const

inline

Returns true if this node has no children.

Definition at line 695 of file tinyxml.h.

◆ Parent()

TiXmlNode* TiXmlNode::Parent ( )

inline

One step up the DOM.

Definition at line 519 of file tinyxml.h.

◆ PreviousSibling() [1/2]

const TiXmlNode* TiXmlNode::PreviousSibling ( ) const

inline

Navigate to a sibling node.

Definition at line 614 of file tinyxml.h.

◆ PreviousSibling() [2/2]

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

Navigate to a sibling node.

Definition at line 443 of file tinyxml.cpp.

References Value().

◆ RemoveChild()

bool TiXmlNode::RemoveChild ( TiXmlNode * removeThis )

Delete a child of this node.

Definition at line 353 of file tinyxml.cpp.

◆ ReplaceChild()

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 314 of file tinyxml.cpp.

References Clone(), GetDocument(), and ToDocument().

◆ SetValue()

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

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

◆ ToComment() [1/2]

virtual const TiXmlComment* TiXmlNode::ToComment ( ) const

inlinevirtual

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

Reimplemented in TiXmlComment.

Definition at line 699 of file tinyxml.h.

◆ ToComment() [2/2]

virtual TiXmlComment* TiXmlNode::ToComment ( )

inlinevirtual

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

Reimplemented in TiXmlComment.

Definition at line 706 of file tinyxml.h.

◆ ToDeclaration() [1/2]

virtual const TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) const

inlinevirtual

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

Reimplemented in TiXmlDeclaration.

Definition at line 702 of file tinyxml.h.

◆ ToDeclaration() [2/2]

virtual TiXmlDeclaration* TiXmlNode::ToDeclaration ( )

inlinevirtual

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

Reimplemented in TiXmlDeclaration.

Definition at line 709 of file tinyxml.h.

◆ ToDocument() [1/2]

virtual const TiXmlDocument* TiXmlNode::ToDocument ( ) const

inlinevirtual

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

Reimplemented in TiXmlDocument.

Definition at line 697 of file tinyxml.h.

Referenced by GetDocument(), and ReplaceChild().

◆ ToDocument() [2/2]

virtual TiXmlDocument* TiXmlNode::ToDocument ( )

inlinevirtual

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

Reimplemented in TiXmlDocument.

Definition at line 704 of file tinyxml.h.

◆ ToElement() [1/2]

virtual const TiXmlElement* TiXmlNode::ToElement ( ) const

inlinevirtual

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

Reimplemented in TiXmlElement.

Definition at line 698 of file tinyxml.h.

Referenced by FirstChildElement(), and NextSiblingElement().

◆ ToElement() [2/2]

virtual TiXmlElement* TiXmlNode::ToElement ( )

inlinevirtual

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

Reimplemented in TiXmlElement.

Definition at line 705 of file tinyxml.h.

◆ ToText() [1/2]

virtual const TiXmlText* TiXmlNode::ToText ( ) const

inlinevirtual

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

Reimplemented in TiXmlText.

Definition at line 701 of file tinyxml.h.

Referenced by TiXmlElement::GetText(), and TiXmlPrinter::VisitEnter().

◆ ToText() [2/2]

virtual TiXmlText* TiXmlNode::ToText ( )

inlinevirtual

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

Reimplemented in TiXmlText.

Definition at line 708 of file tinyxml.h.

◆ ToUnknown() [1/2]

virtual const TiXmlUnknown* TiXmlNode::ToUnknown ( ) const

inlinevirtual

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

Reimplemented in TiXmlUnknown.

Definition at line 700 of file tinyxml.h.

◆ ToUnknown() [2/2]

virtual TiXmlUnknown* TiXmlNode::ToUnknown ( )

inlinevirtual

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

Reimplemented in TiXmlUnknown.

Definition at line 707 of file tinyxml.h.

◆ Type()

int TiXmlNode::Type ( ) const

inline

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

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

Definition at line 684 of file tinyxml.h.

Referenced by InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), and LinkEndChild().

◆ Value()

const char* TiXmlNode::Value ( ) const

inline

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.

Definition at line 487 of file tinyxml.h.

Referenced by TiXmlElement::Clone(), FirstChild(), TiXmlElement::GetText(), TiXmlDocument::LoadFile(), NextSibling(), PreviousSibling(), TiXmlDocument::SaveFile(), TiXmlPrinter::Visit(), TiXmlPrinter::VisitEnter(), and TiXmlPrinter::VisitExit().

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

panda/src/dxml/tinyxml.h
panda/src/dxml/tinyxml.cpp
panda/src/dxml/tinyxmlparser.cpp

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ NodeType

Member Function Documentation

◆ Accept()

◆ Clear()

◆ Clone()

◆ FirstChild() [1/3]

◆ FirstChild() [2/3]

◆ FirstChild() [3/3]

◆ FirstChildElement() [1/2]

◆ FirstChildElement() [2/2]

◆ GetDocument()

◆ InsertAfterChild()

◆ InsertBeforeChild()

◆ InsertEndChild()

◆ IterateChildren() [1/2]

◆ IterateChildren() [2/2]

◆ LastChild() [1/2]

◆ LastChild() [2/2]

◆ LinkEndChild()

◆ NextSibling() [1/2]

◆ NextSibling() [2/2]

◆ NextSiblingElement() [1/2]

◆ NextSiblingElement() [2/2]

◆ NoChildren()

◆ Parent()

◆ PreviousSibling() [1/2]

◆ PreviousSibling() [2/2]

◆ RemoveChild()

◆ ReplaceChild()

◆ SetValue()

◆ ToComment() [1/2]

◆ ToComment() [2/2]

◆ ToDeclaration() [1/2]

◆ ToDeclaration() [2/2]

◆ ToDocument() [1/2]

◆ ToDocument() [2/2]

◆ ToElement() [1/2]

◆ ToElement() [2/2]

◆ ToText() [1/2]

◆ ToText() [2/2]

◆ ToUnknown() [1/2]

◆ ToUnknown() [2/2]

◆ Type()

◆ Value()