#include <tinyxml2.h>
Public Member Functions | |
virtual bool | Accept (XMLVisitor *visitor) const =0 |
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 |
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.
|
explicitprotected |
Definition at line 796 of file tinyxml2.cpp.
|
protectedvirtual |
Definition at line 809 of file tinyxml2.cpp.
|
private |
|
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.
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
Definition at line 835 of file tinyxml2.cpp.
void tinyxml2::XMLNode::DeleteChild | ( | XMLNode * | node | ) |
Delete a child of this node.
Definition at line 882 of file tinyxml2.cpp.
void tinyxml2::XMLNode::DeleteChildren | ( | ) |
Delete all the children of this node.
Definition at line 848 of file tinyxml2.cpp.
|
staticprivate |
Definition at line 1156 of file tinyxml2.cpp.
|
inline |
Definition at line 773 of file tinyxml2.h.
|
inline |
Get the first child node, or null if none exists.
Definition at line 769 of file tinyxml2.h.
|
inline |
Definition at line 782 of file tinyxml2.h.
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.
|
inline |
Get the XMLDocument that owns this XMLNode.
Definition at line 686 of file tinyxml2.h.
|
inline |
Get the XMLDocument that owns this XMLNode.
Definition at line 681 of file tinyxml2.h.
|
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.
|
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.
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.
|
private |
Definition at line 1171 of file tinyxml2.cpp.
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.
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.
|
inline |
Definition at line 791 of file tinyxml2.h.
|
inline |
Get the last child node, or null if none exists.
Definition at line 787 of file tinyxml2.h.
|
inline |
Definition at line 800 of file tinyxml2.h.
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.
Definition at line 845 of file tinyxml2.h.
|
inline |
Definition at line 825 of file tinyxml2.h.
|
inline |
Get the next (right) sibling node of this node.
Definition at line 821 of file tinyxml2.h.
|
inline |
Definition at line 832 of file tinyxml2.h.
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.
|
inline |
Returns true if this node has no children.
Definition at line 764 of file tinyxml2.h.
|
inline |
Definition at line 759 of file tinyxml2.h.
|
inline |
Get the parent of this node on the DOM.
Definition at line 755 of file tinyxml2.h.
|
protectedvirtual |
Reimplemented in tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, and tinyxml2::XMLText.
Definition at line 1042 of file tinyxml2.cpp.
|
inline |
Definition at line 809 of file tinyxml2.h.
|
inline |
Get the previous (left) sibling node of this node.
Definition at line 805 of file tinyxml2.h.
|
inline |
Definition at line 816 of file tinyxml2.h.
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.
|
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.
void tinyxml2::XMLNode::SetValue | ( | const char * | val, |
bool | staticMem = false |
||
) |
|
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.
|
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.
|
inlinevirtual |
Safely cast to a Comment, or null.
Reimplemented in tinyxml2::XMLComment.
Definition at line 700 of file tinyxml2.h.
|
inlinevirtual |
Reimplemented in tinyxml2::XMLComment.
Definition at line 722 of file tinyxml2.h.
|
inlinevirtual |
Safely cast to a Declaration, or null.
Reimplemented in tinyxml2::XMLDeclaration.
Definition at line 708 of file tinyxml2.h.
|
inlinevirtual |
Reimplemented in tinyxml2::XMLDeclaration.
Definition at line 728 of file tinyxml2.h.
|
inlinevirtual |
Safely cast to a Document, or null.
Reimplemented in tinyxml2::XMLDocument.
Definition at line 704 of file tinyxml2.h.
|
inlinevirtual |
Reimplemented in tinyxml2::XMLDocument.
Definition at line 725 of file tinyxml2.h.
|
inlinevirtual |
Safely cast to an Element, or null.
Reimplemented in tinyxml2::XMLElement.
Definition at line 692 of file tinyxml2.h.
|
inlinevirtual |
Reimplemented in tinyxml2::XMLElement.
Definition at line 716 of file tinyxml2.h.
|
private |
Definition at line 1185 of file tinyxml2.cpp.
|
inlinevirtual |
Safely cast to Text, or null.
Reimplemented in tinyxml2::XMLText.
Definition at line 696 of file tinyxml2.h.
|
inlinevirtual |
Reimplemented in tinyxml2::XMLText.
Definition at line 719 of file tinyxml2.h.
|
inlinevirtual |
Safely cast to an Unknown, or null.
Reimplemented in tinyxml2::XMLUnknown.
Definition at line 712 of file tinyxml2.h.
|
inlinevirtual |
Reimplemented in tinyxml2::XMLUnknown.
Definition at line 731 of file tinyxml2.h.
|
private |
Definition at line 858 of file tinyxml2.cpp.
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 817 of file tinyxml2.cpp.
|
friend |
Definition at line 676 of file tinyxml2.h.
|
friend |
Definition at line 677 of file tinyxml2.h.
|
protected |
Definition at line 954 of file tinyxml2.h.
|
protected |
Definition at line 959 of file tinyxml2.h.
|
protected |
Definition at line 960 of file tinyxml2.h.
|
private |
Definition at line 968 of file tinyxml2.h.
|
protected |
Definition at line 963 of file tinyxml2.h.
|
protected |
Definition at line 955 of file tinyxml2.h.
|
protected |
Definition at line 957 of file tinyxml2.h.
|
protected |
Definition at line 962 of file tinyxml2.h.
|
protected |
Definition at line 965 of file tinyxml2.h.
|
mutableprotected |
Definition at line 956 of file tinyxml2.h.