#include <tinyxml2.h>

Inheritance diagram for BT_TinyXML2::XMLNode:

Public Member Functions
virtual bool	Accept (XMLVisitor *visitor) const =0
XMLNode *	DeepClone (XMLDocument *target) const
void	DeleteChild (XMLNode *node)
void	DeleteChildren ()
const XMLNode *	FirstChild () const
	Get the first child node, or null if none exists.
XMLNode *	FirstChild ()
const XMLElement *	FirstChildElement (const char *name=0) const
XMLElement *	FirstChildElement (const char *name=0)
const XMLDocument *	GetDocument () const
	Get the XMLDocument that owns this XMLNode.
XMLDocument *	GetDocument ()
	Get the XMLDocument that owns this XMLNode.
int	GetLineNum () const
	Gets the line number the node is in, if the document was parsed from a file.
void *	GetUserData () const
XMLNode *	InsertAfterChild (XMLNode afterThis, XMLNode addThis)
XMLNode *	InsertEndChild (XMLNode *addThis)
XMLNode *	InsertFirstChild (XMLNode *addThis)
const XMLNode *	LastChild () const
	Get the last child node, or null if none exists.
XMLNode *	LastChild ()
const XMLElement *	LastChildElement (const char *name=0) const
XMLElement *	LastChildElement (const char *name=0)
XMLNode *	LinkEndChild (XMLNode *addThis)
const XMLNode *	NextSibling () const
	Get the next (right) sibling node of this node.
XMLNode *	NextSibling ()
const XMLElement *	NextSiblingElement (const char *name=0) const
	Get the next (right) sibling element of this node, with an optionally supplied name.
XMLElement *	NextSiblingElement (const char *name=0)
bool	NoChildren () const
	Returns true if this node has no children.
const XMLNode *	Parent () const
	Get the parent of this node on the DOM.
XMLNode *	Parent ()
const XMLNode *	PreviousSibling () const
	Get the previous (left) sibling node of this node.
XMLNode *	PreviousSibling ()
const XMLElement *	PreviousSiblingElement (const char *name=0) const
	Get the previous (left) sibling element of this node, with an optionally supplied name.
XMLElement *	PreviousSiblingElement (const char *name=0)
void	SetUserData (void *userData)
void	SetValue (const char *val, bool staticMem=false)
virtual XMLNode *	ShallowClone (XMLDocument *document) const =0
virtual bool	ShallowEqual (const XMLNode *compare) const =0
virtual XMLComment *	ToComment ()
	Safely cast to a Comment, or null.
virtual const XMLComment *	ToComment () const
virtual XMLDeclaration *	ToDeclaration ()
	Safely cast to a Declaration, or null.
virtual const XMLDeclaration *	ToDeclaration () const
virtual XMLDocument *	ToDocument ()
	Safely cast to a Document, or null.
virtual const XMLDocument *	ToDocument () const
virtual XMLElement *	ToElement ()
	Safely cast to an Element, or null.
virtual const XMLElement *	ToElement () const
virtual XMLText *	ToText ()
	Safely cast to Text, or null.
virtual const XMLText *	ToText () const
virtual XMLUnknown *	ToUnknown ()
	Safely cast to an Unknown, or null.
virtual const XMLUnknown *	ToUnknown () const
const char *	Value () const
Protected Member Functions
virtual char *	ParseDeep (char p, StrPair parentEndTag, int *curLineNumPtr)
	XMLNode (XMLDocument *)
virtual	~XMLNode ()
Protected Attributes
XMLDocument *	_document
XMLNode *	_firstChild
XMLNode *	_lastChild
XMLNode *	_next
XMLNode *	_parent
int	_parseLineNum
XMLNode *	_prev
void *	_userData
StrPair	_value
Private Member Functions
void	InsertChildPreamble (XMLNode *insertThis) const
XMLNode &	operator= (const XMLNode &)
const XMLElement *	ToElementWithName (const char *name) const
void	Unlink (XMLNode *child)
	XMLNode (const XMLNode &)
Static Private Member Functions
static void	DeleteNode (XMLNode *node)
Private Attributes
MemPool *	_memPool
Friends
class	XMLDocument
class	XMLElement

Detailed Description

XMLNode is a base class for every object that is in the XML Document Object Model (DOM), except XMLAttributes. Nodes have siblings, a parent, and children which can be navigated. A node is always in a XMLDocument. The type of a XMLNode can be queried, and it can be cast to its more defined type.

A XMLDocument allocates memory for all its Nodes. When the XMLDocument gets deleted, all its Nodes will also be deleted.

	A Document can contain:	Element	(container or leaf)
							Comment (leaf)
							Unknown (leaf)
							Declaration( leaf )

	An Element can contain:	Element (container or leaf)
							Text	(leaf)
							Attributes (not on tree)
							Comment (leaf)
							Unknown (leaf)

Definition at line 667 of file tinyxml2.h.

Constructor & Destructor Documentation

BT_TinyXML2::XMLNode::XMLNode ( XMLDocument * doc ) [explicit, protected]

Definition at line 742 of file tinyxml2.cpp.

BT_TinyXML2::XMLNode::~XMLNode ( ) [protected, virtual]

Definition at line 755 of file tinyxml2.cpp.

BT_TinyXML2::XMLNode::XMLNode ( const XMLNode & ) [private]

Member Function Documentation

virtual bool BT_TinyXML2::XMLNode::Accept ( XMLVisitor * visitor ) const [pure virtual]

Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the XMLVisitor interface.

This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML-2 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():

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

Implemented in BT_TinyXML2::XMLDocument, BT_TinyXML2::XMLElement, BT_TinyXML2::XMLUnknown, BT_TinyXML2::XMLDeclaration, BT_TinyXML2::XMLComment, and BT_TinyXML2::XMLText.

XMLNode * BT_TinyXML2::XMLNode::DeepClone ( XMLDocument * target ) const

Make a copy of this node and all its children.

If the 'target' is null, then the nodes will be allocated in the current document. If 'target' is specified, the memory will be allocated is the specified XMLDocument.

NOTE: This is probably not the correct tool to copy a document, since XMLDocuments can have multiple top level XMLNodes. You probably want to use XMLDocument::DeepCopy()

Definition at line 781 of file tinyxml2.cpp.

void BT_TinyXML2::XMLNode::DeleteChild ( XMLNode * node )

Delete a child of this node.

Definition at line 828 of file tinyxml2.cpp.

void BT_TinyXML2::XMLNode::DeleteChildren ( )

Delete all the children of this node.

Definition at line 794 of file tinyxml2.cpp.

void BT_TinyXML2::XMLNode::DeleteNode ( XMLNode * node ) [static, private]

Reimplemented in BT_TinyXML2::XMLDocument.

Definition at line 1102 of file tinyxml2.cpp.

const XMLNode* BT_TinyXML2::XMLNode::FirstChild ( ) const [inline]

Get the first child node, or null if none exists.

Definition at line 762 of file tinyxml2.h.

XMLNode* BT_TinyXML2::XMLNode::FirstChild ( ) [inline]

Definition at line 766 of file tinyxml2.h.

const XMLElement * BT_TinyXML2::XMLNode::FirstChildElement ( const char * name = 0 ) const

Get the first child element, or optionally the first child element with the specified name.

Definition at line 940 of file tinyxml2.cpp.

XMLElement* BT_TinyXML2::XMLNode::FirstChildElement ( const char * name = 0 ) [inline]

Definition at line 775 of file tinyxml2.h.

const XMLDocument* BT_TinyXML2::XMLNode::GetDocument ( ) const [inline]

Get the XMLDocument that owns this XMLNode.

Definition at line 674 of file tinyxml2.h.

XMLDocument* BT_TinyXML2::XMLNode::GetDocument ( ) [inline]

Get the XMLDocument that owns this XMLNode.

Definition at line 679 of file tinyxml2.h.

int BT_TinyXML2::XMLNode::GetLineNum ( ) const [inline]

Gets the line number the node is in, if the document was parsed from a file.

Definition at line 745 of file tinyxml2.h.

void* BT_TinyXML2::XMLNode::GetUserData ( ) const [inline]

Get user data set into the XMLNode. TinyXML-2 in no way processes or interprets user data. It is initially 0.

Definition at line 939 of file tinyxml2.h.

XMLNode * BT_TinyXML2::XMLNode::InsertAfterChild	(	XMLNode *	afterThis,
		XMLNode *	addThis
	)

Add a node after the specified child node. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the afterThis node is not a child of this node, or if the node does not belong to the same document.

Definition at line 902 of file tinyxml2.cpp.

void BT_TinyXML2::XMLNode::InsertChildPreamble ( XMLNode * insertThis ) const [private]

Definition at line 1117 of file tinyxml2.cpp.

XMLNode * BT_TinyXML2::XMLNode::InsertEndChild ( XMLNode * addThis )

Add a child node as the last (right) child. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the node does not belong to the same document.

Definition at line 841 of file tinyxml2.cpp.

XMLNode * BT_TinyXML2::XMLNode::InsertFirstChild ( XMLNode * addThis )

Add a child node as the first (left) child. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the node does not belong to the same document.

Definition at line 871 of file tinyxml2.cpp.

const XMLNode* BT_TinyXML2::XMLNode::LastChild ( ) const [inline]

Get the last child node, or null if none exists.

Definition at line 780 of file tinyxml2.h.

XMLNode* BT_TinyXML2::XMLNode::LastChild ( ) [inline]

Definition at line 784 of file tinyxml2.h.

const XMLElement * BT_TinyXML2::XMLNode::LastChildElement ( const char * name = 0 ) const

Get the last child element or optionally the last child element with the specified name.

Definition at line 952 of file tinyxml2.cpp.

XMLElement* BT_TinyXML2::XMLNode::LastChildElement ( const char * name = 0 ) [inline]

Definition at line 793 of file tinyxml2.h.

XMLNode* BT_TinyXML2::XMLNode::LinkEndChild ( XMLNode * addThis ) [inline]

Definition at line 838 of file tinyxml2.h.

const XMLNode* BT_TinyXML2::XMLNode::NextSibling ( ) const [inline]

Get the next (right) sibling node of this node.

Definition at line 814 of file tinyxml2.h.

XMLNode* BT_TinyXML2::XMLNode::NextSibling ( ) [inline]

Definition at line 818 of file tinyxml2.h.

const XMLElement * BT_TinyXML2::XMLNode::NextSiblingElement ( const char * name = 0 ) const

Get the next (right) sibling element of this node, with an optionally supplied name.

Definition at line 964 of file tinyxml2.cpp.

XMLElement* BT_TinyXML2::XMLNode::NextSiblingElement ( const char * name = 0 ) [inline]

Definition at line 825 of file tinyxml2.h.

bool BT_TinyXML2::XMLNode::NoChildren ( ) const [inline]

Returns true if this node has no children.

Definition at line 757 of file tinyxml2.h.

XMLNode& BT_TinyXML2::XMLNode::operator= ( const XMLNode & ) [private]

const XMLNode* BT_TinyXML2::XMLNode::Parent ( ) const [inline]

Get the parent of this node on the DOM.

Definition at line 748 of file tinyxml2.h.

XMLNode* BT_TinyXML2::XMLNode::Parent ( ) [inline]

Definition at line 752 of file tinyxml2.h.

char * BT_TinyXML2::XMLNode::ParseDeep	(	char *	p,
		StrPair *	parentEndTag,
		int *	curLineNumPtr
	)		`[protected, virtual]`

Reimplemented in BT_TinyXML2::XMLElement, BT_TinyXML2::XMLUnknown, BT_TinyXML2::XMLDeclaration, BT_TinyXML2::XMLComment, and BT_TinyXML2::XMLText.

Definition at line 988 of file tinyxml2.cpp.

const XMLNode* BT_TinyXML2::XMLNode::PreviousSibling ( ) const [inline]

Get the previous (left) sibling node of this node.

Definition at line 798 of file tinyxml2.h.

XMLNode* BT_TinyXML2::XMLNode::PreviousSibling ( ) [inline]

Definition at line 802 of file tinyxml2.h.

const XMLElement * BT_TinyXML2::XMLNode::PreviousSiblingElement ( const char * name = 0 ) const

Get the previous (left) sibling element of this node, with an optionally supplied name.

Definition at line 976 of file tinyxml2.cpp.

XMLElement* BT_TinyXML2::XMLNode::PreviousSiblingElement ( const char * name = 0 ) [inline]

Definition at line 809 of file tinyxml2.h.

void BT_TinyXML2::XMLNode::SetUserData ( void * userData ) [inline]

Set user data into the XMLNode. TinyXML-2 in no way processes or interprets user data. It is initially 0.

Definition at line 932 of file tinyxml2.h.

void BT_TinyXML2::XMLNode::SetValue	(	const char *	val,
		bool	staticMem = `false`
	)

Set the Value of an XML node.

See also:: Value()

Definition at line 771 of file tinyxml2.cpp.

virtual XMLNode* BT_TinyXML2::XMLNode::ShallowClone ( XMLDocument * document ) const [pure virtual]

Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())

Note: if called on a XMLDocument, this will return null.

Implemented in BT_TinyXML2::XMLDocument, BT_TinyXML2::XMLElement, BT_TinyXML2::XMLUnknown, BT_TinyXML2::XMLDeclaration, BT_TinyXML2::XMLComment, and BT_TinyXML2::XMLText.

virtual bool BT_TinyXML2::XMLNode::ShallowEqual ( const XMLNode * compare ) const [pure virtual]

Test if 2 nodes are the same, but don't test children. The 2 nodes do not need to be in the same Document.

Note: if called on a XMLDocument, this will return false.

Implemented in BT_TinyXML2::XMLDocument, BT_TinyXML2::XMLElement, BT_TinyXML2::XMLUnknown, BT_TinyXML2::XMLDeclaration, BT_TinyXML2::XMLComment, and BT_TinyXML2::XMLText.

virtual XMLComment* BT_TinyXML2::XMLNode::ToComment ( ) [inline, virtual]

Safely cast to a Comment, or null.

Reimplemented in BT_TinyXML2::XMLComment.

Definition at line 693 of file tinyxml2.h.

virtual const XMLComment* BT_TinyXML2::XMLNode::ToComment ( ) const [inline, virtual]

Reimplemented in BT_TinyXML2::XMLComment.

Definition at line 715 of file tinyxml2.h.

virtual XMLDeclaration* BT_TinyXML2::XMLNode::ToDeclaration ( ) [inline, virtual]

Safely cast to a Declaration, or null.

Reimplemented in BT_TinyXML2::XMLDeclaration.

Definition at line 701 of file tinyxml2.h.

virtual const XMLDeclaration* BT_TinyXML2::XMLNode::ToDeclaration ( ) const [inline, virtual]

Reimplemented in BT_TinyXML2::XMLDeclaration.

Definition at line 721 of file tinyxml2.h.

virtual XMLDocument* BT_TinyXML2::XMLNode::ToDocument ( ) [inline, virtual]

Safely cast to a Document, or null.

Reimplemented in BT_TinyXML2::XMLDocument.

Definition at line 697 of file tinyxml2.h.

virtual const XMLDocument* BT_TinyXML2::XMLNode::ToDocument ( ) const [inline, virtual]

Reimplemented in BT_TinyXML2::XMLDocument.

Definition at line 718 of file tinyxml2.h.

virtual XMLElement* BT_TinyXML2::XMLNode::ToElement ( ) [inline, virtual]

Safely cast to an Element, or null.

Reimplemented in BT_TinyXML2::XMLElement.

Definition at line 685 of file tinyxml2.h.

virtual const XMLElement* BT_TinyXML2::XMLNode::ToElement ( ) const [inline, virtual]

Reimplemented in BT_TinyXML2::XMLElement.

Definition at line 709 of file tinyxml2.h.

const XMLElement * BT_TinyXML2::XMLNode::ToElementWithName ( const char * name ) const [private]

Definition at line 1131 of file tinyxml2.cpp.

virtual XMLText* BT_TinyXML2::XMLNode::ToText ( ) [inline, virtual]

Safely cast to Text, or null.

Reimplemented in BT_TinyXML2::XMLText.

Definition at line 689 of file tinyxml2.h.

virtual const XMLText* BT_TinyXML2::XMLNode::ToText ( ) const [inline, virtual]

Reimplemented in BT_TinyXML2::XMLText.

Definition at line 712 of file tinyxml2.h.

virtual XMLUnknown* BT_TinyXML2::XMLNode::ToUnknown ( ) [inline, virtual]

Safely cast to an Unknown, or null.

Reimplemented in BT_TinyXML2::XMLUnknown.

Definition at line 705 of file tinyxml2.h.

virtual const XMLUnknown* BT_TinyXML2::XMLNode::ToUnknown ( ) const [inline, virtual]

Reimplemented in BT_TinyXML2::XMLUnknown.

Definition at line 724 of file tinyxml2.h.

void BT_TinyXML2::XMLNode::Unlink ( XMLNode * child ) [private]

Definition at line 804 of file tinyxml2.cpp.

const char * BT_TinyXML2::XMLNode::Value ( ) const

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

    	Document:	empty (NULL is returned, not an empty string)
    	Element:	name of the element
    	Comment:	the comment text
    	Unknown:	the tag contents
    	Text:		the text string

Definition at line 763 of file tinyxml2.cpp.