#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLNode:

[legend]

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

int	ChildElementCount () const

int	ChildElementCount (const char *value) const

XMLNode *	DeepClone (XMLDocument *target) const

void	DeleteChild (XMLNode *node)

void	DeleteChildren ()

XMLNode *	FirstChild ()

const XMLNode *	FirstChild () const
	Get the first child node, or null if none exists. More...

XMLElement *	FirstChildElement (const char *name=0)

const XMLElement *	FirstChildElement (const char *name=0) const

XMLDocument *	GetDocument ()
	Get the XMLDocument that owns this XMLNode. More...

const XMLDocument *	GetDocument () const
	Get the XMLDocument that owns this XMLNode. More...

int	GetLineNum () const
	Gets the line number the node is in, if the document was parsed from a file. More...

void *	GetUserData () const

XMLNode *	InsertAfterChild (XMLNode afterThis, XMLNode addThis)

XMLNode *	InsertEndChild (XMLNode *addThis)

XMLNode *	InsertFirstChild (XMLNode *addThis)

XMLNode *	LastChild ()

const XMLNode *	LastChild () const
	Get the last child node, or null if none exists. More...

XMLElement *	LastChildElement (const char *name=0)

const XMLElement *	LastChildElement (const char *name=0) const

XMLNode *	LinkEndChild (XMLNode *addThis)

XMLNode *	NextSibling ()

const XMLNode *	NextSibling () const
	Get the next (right) sibling node of this node. More...

XMLElement *	NextSiblingElement (const char *name=0)

const XMLElement *	NextSiblingElement (const char *name=0) const
	Get the next (right) sibling element of this node, with an optionally supplied name. More...

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

XMLNode *	Parent ()

const XMLNode *	Parent () const
	Get the parent of this node on the DOM. More...

XMLNode *	PreviousSibling ()

const XMLNode *	PreviousSibling () const
	Get the previous (left) sibling node of this node. More...

XMLElement *	PreviousSiblingElement (const char *name=0)

const XMLElement *	PreviousSiblingElement (const char *name=0) const
	Get the previous (left) sibling element of this node, with an optionally supplied name. More...

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

virtual const XMLComment *	ToComment () const

virtual XMLDeclaration *	ToDeclaration ()
	Safely cast to a Declaration, or null. More...

virtual const XMLDeclaration *	ToDeclaration () const

virtual XMLDocument *	ToDocument ()
	Safely cast to a Document, or null. More...

virtual const XMLDocument *	ToDocument () const

virtual XMLElement *	ToElement ()
	Safely cast to an Element, or null. More...

virtual const XMLElement *	ToElement () const

virtual XMLText *	ToText ()
	Safely cast to Text, or null. More...

virtual const XMLText *	ToText () const

virtual XMLUnknown *	ToUnknown ()
	Safely cast to an Unknown, or null. More...

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 671 of file tinyxml2.h.

Constructor & Destructor Documentation

◆ XMLNode() [1/2]

tinyxml2::XMLNode::XMLNode ( XMLDocument * doc )

explicitprotected

Definition at line 811 of file tinyxml2.cpp.

◆ ~XMLNode()

tinyxml2::XMLNode::~XMLNode ( )

protectedvirtual

Definition at line 824 of file tinyxml2.cpp.

◆ XMLNode() [2/2]

tinyxml2::XMLNode::XMLNode ( const XMLNode & )

private

Member Function Documentation

◆ Accept()

virtual bool 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 tinyxml2::XMLDocument, tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, and tinyxml2::XMLText.

◆ ChildElementCount() [1/2]

int tinyxml2::XMLNode::ChildElementCount ( ) const

Definition at line 847 of file tinyxml2.cpp.

◆ ChildElementCount() [2/2]

int tinyxml2::XMLNode::ChildElementCount ( const char * value ) const

Definition at line 834 of file tinyxml2.cpp.

◆ DeepClone()

XMLNode * 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 878 of file tinyxml2.cpp.

◆ DeleteChild()

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

Delete a child of this node.

Definition at line 925 of file tinyxml2.cpp.

◆ DeleteChildren()

void tinyxml2::XMLNode::DeleteChildren ( )

Delete all the children of this node.

Definition at line 891 of file tinyxml2.cpp.

◆ DeleteNode()

void tinyxml2::XMLNode::DeleteNode ( XMLNode * node )

staticprivate

Definition at line 1201 of file tinyxml2.cpp.

◆ FirstChild() [1/2]

XMLNode* tinyxml2::XMLNode::FirstChild ( )

inline

Definition at line 776 of file tinyxml2.h.

◆ FirstChild() [2/2]

const XMLNode* tinyxml2::XMLNode::FirstChild ( ) const

inline

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

Definition at line 772 of file tinyxml2.h.

◆ FirstChildElement() [1/2]

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

inline

Definition at line 785 of file tinyxml2.h.

◆ FirstChildElement() [2/2]

const XMLElement * 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 1037 of file tinyxml2.cpp.

◆ GetDocument() [1/2]

XMLDocument* tinyxml2::XMLNode::GetDocument ( )

inline

Get the XMLDocument that owns this XMLNode.

Definition at line 683 of file tinyxml2.h.

◆ GetDocument() [2/2]

const XMLDocument* tinyxml2::XMLNode::GetDocument ( ) const

inline

Get the XMLDocument that owns this XMLNode.

Definition at line 678 of file tinyxml2.h.

◆ GetLineNum()

int tinyxml2::XMLNode::GetLineNum ( ) const

inline

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

Definition at line 755 of file tinyxml2.h.

◆ GetUserData()

void* 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 949 of file tinyxml2.h.

◆ InsertAfterChild()

XMLNode * 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 999 of file tinyxml2.cpp.

◆ InsertChildPreamble()

void tinyxml2::XMLNode::InsertChildPreamble ( XMLNode * insertThis ) const

private

Definition at line 1216 of file tinyxml2.cpp.

◆ InsertEndChild()

XMLNode * 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 938 of file tinyxml2.cpp.

◆ InsertFirstChild()

XMLNode * 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 968 of file tinyxml2.cpp.

◆ LastChild() [1/2]

XMLNode* tinyxml2::XMLNode::LastChild ( )

inline

Definition at line 794 of file tinyxml2.h.

◆ LastChild() [2/2]

const XMLNode* tinyxml2::XMLNode::LastChild ( ) const

inline

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

Definition at line 790 of file tinyxml2.h.

◆ LastChildElement() [1/2]

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

inline

Definition at line 803 of file tinyxml2.h.

◆ LastChildElement() [2/2]

const XMLElement * 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 1049 of file tinyxml2.cpp.

◆ LinkEndChild()

XMLNode* tinyxml2::XMLNode::LinkEndChild ( XMLNode * addThis )

inline

Definition at line 848 of file tinyxml2.h.

◆ NextSibling() [1/2]

XMLNode* tinyxml2::XMLNode::NextSibling ( )

inline

Definition at line 828 of file tinyxml2.h.

◆ NextSibling() [2/2]

const XMLNode* tinyxml2::XMLNode::NextSibling ( ) const

inline

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

Definition at line 824 of file tinyxml2.h.

◆ NextSiblingElement() [1/2]

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

inline

Definition at line 835 of file tinyxml2.h.

◆ NextSiblingElement() [2/2]

const XMLElement * 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 1061 of file tinyxml2.cpp.

◆ NoChildren()

bool tinyxml2::XMLNode::NoChildren ( ) const

inline

Returns true if this node has no children.

Definition at line 767 of file tinyxml2.h.

◆ operator=()

XMLNode& tinyxml2::XMLNode::operator= ( const XMLNode & )

private

◆ Parent() [1/2]

XMLNode* tinyxml2::XMLNode::Parent ( )

inline

Definition at line 762 of file tinyxml2.h.

◆ Parent() [2/2]

const XMLNode* tinyxml2::XMLNode::Parent ( ) const

inline

Get the parent of this node on the DOM.

Definition at line 758 of file tinyxml2.h.

◆ ParseDeep()

char * tinyxml2::XMLNode::ParseDeep	(	char *	p,
		StrPair *	parentEndTag,
		int *	curLineNumPtr
	)

protectedvirtual

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

Definition at line 1085 of file tinyxml2.cpp.

◆ PreviousSibling() [1/2]

XMLNode* tinyxml2::XMLNode::PreviousSibling ( )

inline

Definition at line 812 of file tinyxml2.h.

◆ PreviousSibling() [2/2]

const XMLNode* tinyxml2::XMLNode::PreviousSibling ( ) const

inline

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

Definition at line 808 of file tinyxml2.h.

◆ PreviousSiblingElement() [1/2]

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

inline

Definition at line 819 of file tinyxml2.h.

◆ PreviousSiblingElement() [2/2]

const XMLElement * 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 1073 of file tinyxml2.cpp.

◆ SetUserData()

void 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 942 of file tinyxml2.h.

◆ SetValue()

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

Set the Value of an XML node.

See also: Value()

Definition at line 868 of file tinyxml2.cpp.

◆ ShallowClone()

virtual XMLNode* 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 tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, tinyxml2::XMLText, and tinyxml2::XMLDocument.

◆ ShallowEqual()

virtual bool 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 tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, tinyxml2::XMLText, and tinyxml2::XMLDocument.

◆ ToComment() [1/2]

virtual XMLComment* tinyxml2::XMLNode::ToComment ( )

inlinevirtual

Safely cast to a Comment, or null.

Reimplemented in tinyxml2::XMLComment.

Definition at line 697 of file tinyxml2.h.

◆ ToComment() [2/2]

virtual const XMLComment* tinyxml2::XMLNode::ToComment ( ) const

inlinevirtual

Reimplemented in tinyxml2::XMLComment.

Definition at line 719 of file tinyxml2.h.

◆ ToDeclaration() [1/2]

virtual XMLDeclaration* tinyxml2::XMLNode::ToDeclaration ( )

inlinevirtual

Safely cast to a Declaration, or null.

Reimplemented in tinyxml2::XMLDeclaration.

Definition at line 705 of file tinyxml2.h.

◆ ToDeclaration() [2/2]

virtual const XMLDeclaration* tinyxml2::XMLNode::ToDeclaration ( ) const

inlinevirtual

Reimplemented in tinyxml2::XMLDeclaration.

Definition at line 725 of file tinyxml2.h.

◆ ToDocument() [1/2]

virtual XMLDocument* tinyxml2::XMLNode::ToDocument ( )

inlinevirtual

Safely cast to a Document, or null.

Reimplemented in tinyxml2::XMLDocument.

Definition at line 701 of file tinyxml2.h.

◆ ToDocument() [2/2]

virtual const XMLDocument* tinyxml2::XMLNode::ToDocument ( ) const

inlinevirtual

Reimplemented in tinyxml2::XMLDocument.

Definition at line 722 of file tinyxml2.h.

◆ ToElement() [1/2]

virtual XMLElement* tinyxml2::XMLNode::ToElement ( )

inlinevirtual

Safely cast to an Element, or null.

Reimplemented in tinyxml2::XMLElement.

Definition at line 689 of file tinyxml2.h.

◆ ToElement() [2/2]

virtual const XMLElement* tinyxml2::XMLNode::ToElement ( ) const

inlinevirtual

Reimplemented in tinyxml2::XMLElement.

Definition at line 713 of file tinyxml2.h.

◆ ToElementWithName()

const XMLElement * tinyxml2::XMLNode::ToElementWithName ( const char * name ) const

private

Definition at line 1230 of file tinyxml2.cpp.

◆ ToText() [1/2]

virtual XMLText* tinyxml2::XMLNode::ToText ( )

inlinevirtual

Safely cast to Text, or null.

Reimplemented in tinyxml2::XMLText.

Definition at line 693 of file tinyxml2.h.

◆ ToText() [2/2]

virtual const XMLText* tinyxml2::XMLNode::ToText ( ) const

inlinevirtual

Reimplemented in tinyxml2::XMLText.

Definition at line 716 of file tinyxml2.h.

◆ ToUnknown() [1/2]

virtual XMLUnknown* tinyxml2::XMLNode::ToUnknown ( )

inlinevirtual

Safely cast to an Unknown, or null.

Reimplemented in tinyxml2::XMLUnknown.

Definition at line 709 of file tinyxml2.h.

◆ ToUnknown() [2/2]

virtual const XMLUnknown* tinyxml2::XMLNode::ToUnknown ( ) const

inlinevirtual

Reimplemented in tinyxml2::XMLUnknown.

Definition at line 728 of file tinyxml2.h.

◆ Unlink()

void tinyxml2::XMLNode::Unlink ( XMLNode * child )

private

Definition at line 901 of file tinyxml2.cpp.

◆ Value()

const char * 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 860 of file tinyxml2.cpp.

Friends And Related Function Documentation

◆ XMLDocument

friend class XMLDocument

friend

Definition at line 673 of file tinyxml2.h.

◆ XMLElement

friend class XMLElement

friend

Definition at line 674 of file tinyxml2.h.

Member Data Documentation

◆ _document

XMLDocument* tinyxml2::XMLNode::_document

protected

Definition at line 957 of file tinyxml2.h.

◆ _firstChild

XMLNode* tinyxml2::XMLNode::_firstChild

protected

Definition at line 962 of file tinyxml2.h.

◆ _lastChild

XMLNode* tinyxml2::XMLNode::_lastChild

protected

Definition at line 963 of file tinyxml2.h.

◆ _memPool

MemPool* tinyxml2::XMLNode::_memPool

private

Definition at line 971 of file tinyxml2.h.

◆ _next

XMLNode* tinyxml2::XMLNode::_next

protected

Definition at line 966 of file tinyxml2.h.

◆ _parent

XMLNode* tinyxml2::XMLNode::_parent

protected

Definition at line 958 of file tinyxml2.h.

◆ _parseLineNum

int tinyxml2::XMLNode::_parseLineNum

protected

Definition at line 960 of file tinyxml2.h.

◆ _prev

XMLNode* tinyxml2::XMLNode::_prev

protected

Definition at line 965 of file tinyxml2.h.

◆ _userData

void* tinyxml2::XMLNode::_userData

protected

Definition at line 968 of file tinyxml2.h.

◆ _value

StrPair tinyxml2::XMLNode::_value

mutableprotected

Definition at line 959 of file tinyxml2.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ XMLNode() [1/2]

◆ ~XMLNode()

◆ XMLNode() [2/2]

Member Function Documentation

◆ Accept()

◆ ChildElementCount() [1/2]

◆ ChildElementCount() [2/2]

◆ DeepClone()

◆ DeleteChild()

◆ DeleteChildren()

◆ DeleteNode()

◆ FirstChild() [1/2]

◆ FirstChild() [2/2]

◆ FirstChildElement() [1/2]

◆ FirstChildElement() [2/2]

◆ GetDocument() [1/2]

◆ GetDocument() [2/2]

◆ GetLineNum()

◆ GetUserData()

◆ InsertAfterChild()

◆ InsertChildPreamble()

◆ InsertEndChild()

◆ InsertFirstChild()

◆ LastChild() [1/2]

◆ LastChild() [2/2]

◆ LastChildElement() [1/2]

◆ LastChildElement() [2/2]

◆ LinkEndChild()

◆ NextSibling() [1/2]

◆ NextSibling() [2/2]

◆ NextSiblingElement() [1/2]

◆ NextSiblingElement() [2/2]

◆ NoChildren()

◆ operator=()

◆ Parent() [1/2]

◆ Parent() [2/2]

◆ ParseDeep()

◆ PreviousSibling() [1/2]

◆ PreviousSibling() [2/2]

◆ PreviousSiblingElement() [1/2]

◆ PreviousSiblingElement() [2/2]

◆ SetUserData()

◆ SetValue()

◆ ShallowClone()

◆ ShallowEqual()

◆ ToComment() [1/2]

◆ ToComment() [2/2]

◆ ToDeclaration() [1/2]

◆ ToDeclaration() [2/2]

◆ ToDocument() [1/2]

◆ ToDocument() [2/2]

◆ ToElement() [1/2]

◆ ToElement() [2/2]

◆ ToElementWithName()

◆ ToText() [1/2]

◆ ToText() [2/2]

◆ ToUnknown() [1/2]

◆ ToUnknown() [2/2]

◆ Unlink()

◆ Value()

Friends And Related Function Documentation

◆ XMLDocument

◆ XMLElement

Member Data Documentation

◆ _document

◆ _firstChild

◆ _lastChild

◆ _memPool

◆ _next

◆ _parent

◆ _parseLineNum