NumeRe v1.1.4
NumeRe: Framework für Numerische Rechnungen
tinyxml2::XMLNode Class Referenceabstract

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLNode:
Collaboration diagram for tinyxml2::XMLNode:

Public Member Functions

const XMLDocumentGetDocument () const
 Get the XMLDocument that owns this XMLNode. More...
 
XMLDocumentGetDocument ()
 Get the XMLDocument that owns this XMLNode. More...
 
virtual XMLElementToElement ()
 Safely cast to an Element, or null. More...
 
virtual XMLTextToText ()
 Safely cast to Text, or null. More...
 
virtual XMLCommentToComment ()
 Safely cast to a Comment, or null. More...
 
virtual XMLDocumentToDocument ()
 Safely cast to a Document, or null. More...
 
virtual XMLDeclarationToDeclaration ()
 Safely cast to a Declaration, or null. More...
 
virtual XMLUnknownToUnknown ()
 Safely cast to an Unknown, or null. More...
 
virtual const XMLElementToElement () const
 
virtual const XMLTextToText () const
 
virtual const XMLCommentToComment () const
 
virtual const XMLDocumentToDocument () const
 
virtual const XMLDeclarationToDeclaration () const
 
virtual const XMLUnknownToUnknown () const
 
const char * Value () const
 
void SetValue (const char *val, bool staticMem=false)
 
int GetLineNum () const
 Gets the line number the node is in, if the document was parsed from a file. More...
 
const XMLNodeParent () const
 Get the parent of this node on the DOM. More...
 
XMLNodeParent ()
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
const XMLNodeFirstChild () const
 Get the first child node, or null if none exists. More...
 
XMLNodeFirstChild ()
 
const XMLElementFirstChildElement (const char *name=0) const
 
XMLElementFirstChildElement (const char *name=0)
 
const XMLNodeLastChild () const
 Get the last child node, or null if none exists. More...
 
XMLNodeLastChild ()
 
const XMLElementLastChildElement (const char *name=0) const
 
XMLElementLastChildElement (const char *name=0)
 
const XMLNodePreviousSibling () const
 Get the previous (left) sibling node of this node. More...
 
XMLNodePreviousSibling ()
 
const XMLElementPreviousSiblingElement (const char *name=0) const
 Get the previous (left) sibling element of this node, with an optionally supplied name. More...
 
XMLElementPreviousSiblingElement (const char *name=0)
 
const XMLNodeNextSibling () const
 Get the next (right) sibling node of this node. More...
 
XMLNodeNextSibling ()
 
const XMLElementNextSiblingElement (const char *name=0) const
 Get the next (right) sibling element of this node, with an optionally supplied name. More...
 
XMLElementNextSiblingElement (const char *name=0)
 
XMLNodeInsertEndChild (XMLNode *addThis)
 
XMLNodeLinkEndChild (XMLNode *addThis)
 
XMLNodeInsertFirstChild (XMLNode *addThis)
 
XMLNodeInsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
 
void DeleteChildren ()
 
void DeleteChild (XMLNode *node)
 
virtual XMLNodeShallowClone (XMLDocument *document) const =0
 
XMLNodeDeepClone (XMLDocument *target) const
 
virtual bool ShallowEqual (const XMLNode *compare) const =0
 
virtual bool Accept (XMLVisitor *visitor) const =0
 
void SetUserData (void *userData)
 
void * GetUserData () const
 

Protected Member Functions

 XMLNode (XMLDocument *)
 
virtual ~XMLNode ()
 
virtual char * ParseDeep (char *p, StrPair *parentEndTag, int *curLineNumPtr)
 

Protected Attributes

XMLDocument_document
 
XMLNode_parent
 
StrPair _value
 
int _parseLineNum
 
XMLNode_firstChild
 
XMLNode_lastChild
 
XMLNode_prev
 
XMLNode_next
 
void * _userData
 

Private Member Functions

void Unlink (XMLNode *child)
 
void InsertChildPreamble (XMLNode *insertThis) const
 
const XMLElementToElementWithName (const char *name) const
 
 XMLNode (const XMLNode &)
 
XMLNodeoperator= (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 674 of file tinyxml2.h.

Constructor & Destructor Documentation

◆ XMLNode() [1/2]

tinyxml2::XMLNode::XMLNode ( XMLDocument doc)
explicitprotected

Definition at line 796 of file tinyxml2.cpp.

◆ ~XMLNode()

tinyxml2::XMLNode::~XMLNode ( )
protectedvirtual

Definition at line 809 of file tinyxml2.cpp.

References _parent, DeleteChildren(), and Unlink().

Referenced by DeleteNode().

Here is the call graph for this function:

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

◆ 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 835 of file tinyxml2.cpp.

References DeepClone(), FirstChild(), InsertEndChild(), NextSibling(), ShallowClone(), and TIXMLASSERT.

Referenced by DeepClone().

Here is the call graph for this function:

◆ DeleteChild()

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

Delete a child of this node.

Definition at line 882 of file tinyxml2.cpp.

References _document, _next, _parent, _prev, DeleteNode(), TIXMLASSERT, and Unlink().

Referenced by DeleteChildren(), and tinyxml2::XMLDocument::DeleteNode().

Here is the call graph for this function:

◆ DeleteChildren()

void tinyxml2::XMLNode::DeleteChildren ( )

Delete all the children of this node.

Definition at line 848 of file tinyxml2.cpp.

References _firstChild, _lastChild, DeleteChild(), and TIXMLASSERT.

Referenced by tinyxml2::XMLDocument::Clear(), tinyxml2::XMLDocument::Parse(), and ~XMLNode().

Here is the call graph for this function:

◆ DeleteNode()

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

Definition at line 1156 of file tinyxml2.cpp.

References _document, _memPool, tinyxml2::MemPool::Free(), tinyxml2::XMLDocument::MarkInUse(), TIXMLASSERT, ToDocument(), and ~XMLNode().

Referenced by DeleteChild(), tinyxml2::XMLDocument::DeleteNode(), and ParseDeep().

Here is the call graph for this function:

◆ FirstChild() [1/2]

XMLNode * tinyxml2::XMLNode::FirstChild ( )
inline

Definition at line 773 of file tinyxml2.h.

◆ FirstChild() [2/2]

◆ FirstChildElement() [1/2]

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

Definition at line 782 of file tinyxml2.h.

References name.

◆ 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 994 of file tinyxml2.cpp.

References _firstChild, _next, name, and ToElementWithName().

Referenced by CustomWindow::layout(), CustomWindow::layoutChild(), CustomWindow::layoutMenu(), PackageDialog::loadProjectFile(), parseHeader(), and NumeRe::XLSXSpreadSheet::readFile().

Here is the call graph for this function:

◆ GetDocument() [1/2]

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

Get the XMLDocument that owns this XMLNode.

Definition at line 686 of file tinyxml2.h.

References TIXMLASSERT.

◆ GetDocument() [2/2]

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

Get the XMLDocument that owns this XMLNode.

Definition at line 681 of file tinyxml2.h.

References TIXMLASSERT.

Referenced by tinyxml2::XMLElement::SetText().

◆ 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 752 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 946 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 956 of file tinyxml2.cpp.

References _document, _next, _parent, _prev, InsertChildPreamble(), InsertEndChild(), and TIXMLASSERT.

Here is the call graph for this function:

◆ InsertChildPreamble()

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

Definition at line 1171 of file tinyxml2.cpp.

References _document, _memPool, _parent, tinyxml2::XMLDocument::MarkInUse(), tinyxml2::MemPool::SetTracked(), TIXMLASSERT, and Unlink().

Referenced by InsertAfterChild(), InsertEndChild(), and InsertFirstChild().

Here is the call graph for this function:

◆ 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 895 of file tinyxml2.cpp.

References _document, _firstChild, _lastChild, _next, _parent, _prev, InsertChildPreamble(), and TIXMLASSERT.

Referenced by DeepClone(), tinyxml2::XMLDocument::DeepCopy(), InsertAfterChild(), tinyxml2::XMLElement::InsertNewChildElement(), tinyxml2::XMLElement::InsertNewComment(), tinyxml2::XMLElement::InsertNewDeclaration(), tinyxml2::XMLElement::InsertNewText(), tinyxml2::XMLElement::InsertNewUnknown(), ParseDeep(), parseLayoutScript(), and PackageDialog::saveProjectFile().

Here is the call graph for this function:

◆ 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 925 of file tinyxml2.cpp.

References _document, _firstChild, _lastChild, _next, _parent, _prev, InsertChildPreamble(), and TIXMLASSERT.

Referenced by parseLayoutScript(), PackageDialog::saveProjectFile(), and tinyxml2::XMLElement::SetText().

Here is the call graph for this function:

◆ LastChild() [1/2]

XMLNode * tinyxml2::XMLNode::LastChild ( )
inline

Definition at line 791 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 787 of file tinyxml2.h.

Referenced by ParseDeep().

◆ LastChildElement() [1/2]

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

Definition at line 800 of file tinyxml2.h.

References name.

◆ 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 1006 of file tinyxml2.cpp.

References _lastChild, _prev, name, and ToElementWithName().

Here is the call graph for this function:

◆ LinkEndChild()

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

Definition at line 845 of file tinyxml2.h.

◆ NextSibling() [1/2]

XMLNode * tinyxml2::XMLNode::NextSibling ( )
inline

Definition at line 825 of file tinyxml2.h.

◆ NextSibling() [2/2]

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

◆ NextSiblingElement() [1/2]

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

Definition at line 832 of file tinyxml2.h.

References name.

◆ 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 1018 of file tinyxml2.cpp.

References _next, name, and ToElementWithName().

Referenced by PackageDialog::loadProjectFile(), parseHeader(), and NumeRe::XLSXSpreadSheet::readFile().

Here is the call graph for this function:

◆ NoChildren()

bool tinyxml2::XMLNode::NoChildren ( ) const
inline

Returns true if this node has no children.

Definition at line 764 of file tinyxml2.h.

Referenced by tinyxml2::XMLDocument::Parse().

◆ operator=()

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

◆ Parent() [1/2]

XMLNode * tinyxml2::XMLNode::Parent ( )
inline

Definition at line 759 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 755 of file tinyxml2.h.

Referenced by tinyxml2::XMLPrinter::VisitEnter().

◆ ParseDeep()

◆ PreviousSibling() [1/2]

XMLNode * tinyxml2::XMLNode::PreviousSibling ( )
inline

Definition at line 809 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 805 of file tinyxml2.h.

◆ PreviousSiblingElement() [1/2]

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

Definition at line 816 of file tinyxml2.h.

References name.

◆ 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 1030 of file tinyxml2.cpp.

References _prev, name, and ToElementWithName().

Here is the call graph for this function:

◆ 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 939 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 825 of file tinyxml2.cpp.

References _value, tinyxml2::StrPair::SetInternedStr(), and tinyxml2::StrPair::SetStr().

Referenced by tinyxml2::XMLDocument::NewComment(), tinyxml2::XMLDocument::NewText(), tinyxml2::XMLDocument::NewUnknown(), and tinyxml2::XMLElement::SetText().

Here is the call graph for this function:

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

Referenced by DeepClone().

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

◆ ToComment() [1/2]

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

Safely cast to a Comment, or null.

Reimplemented in tinyxml2::XMLComment.

Definition at line 700 of file tinyxml2.h.

Referenced by tinyxml2::XMLElement::GetText().

◆ ToComment() [2/2]

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

Reimplemented in tinyxml2::XMLComment.

Definition at line 722 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 708 of file tinyxml2.h.

Referenced by ParseDeep().

◆ ToDeclaration() [2/2]

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

Reimplemented in tinyxml2::XMLDeclaration.

Definition at line 728 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 704 of file tinyxml2.h.

Referenced by DeleteNode(), ParseDeep(), and Value().

◆ ToDocument() [2/2]

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

Reimplemented in tinyxml2::XMLDocument.

Definition at line 725 of file tinyxml2.h.

◆ ToElement() [1/2]

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

◆ ToElement() [2/2]

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

Reimplemented in tinyxml2::XMLElement.

Definition at line 716 of file tinyxml2.h.

◆ ToElementWithName()

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

Definition at line 1185 of file tinyxml2.cpp.

References tinyxml2::XMLElement::Name(), name, tinyxml2::XMLUtil::StringEqual(), and ToElement().

Referenced by FirstChildElement(), LastChildElement(), NextSiblingElement(), and PreviousSiblingElement().

Here is the call graph for this function:

◆ ToText() [1/2]

◆ ToText() [2/2]

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

Reimplemented in tinyxml2::XMLText.

Definition at line 719 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 712 of file tinyxml2.h.

◆ ToUnknown() [2/2]

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

Reimplemented in tinyxml2::XMLUnknown.

Definition at line 731 of file tinyxml2.h.

◆ Unlink()

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

Definition at line 858 of file tinyxml2.cpp.

References _document, _firstChild, _lastChild, _next, _parent, _prev, and TIXMLASSERT.

Referenced by DeleteChild(), InsertChildPreamble(), and ~XMLNode().

◆ Value()

Friends And Related Function Documentation

◆ XMLDocument

friend class XMLDocument
friend

Definition at line 676 of file tinyxml2.h.

◆ XMLElement

friend class XMLElement
friend

Definition at line 677 of file tinyxml2.h.

Member Data Documentation

◆ _document

◆ _firstChild

XMLNode* tinyxml2::XMLNode::_firstChild
protected

◆ _lastChild

XMLNode* tinyxml2::XMLNode::_lastChild
protected

◆ _memPool

MemPool* tinyxml2::XMLNode::_memPool
private

◆ _next

XMLNode* tinyxml2::XMLNode::_next
protected

◆ _parent

◆ _parseLineNum

◆ _prev

XMLNode* tinyxml2::XMLNode::_prev
protected

◆ _userData

void* tinyxml2::XMLNode::_userData
protected

Definition at line 965 of file tinyxml2.h.

◆ _value


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