Otclient  14/8/2020
TiXmlNode Class Referenceabstract

#include <tinyxml.h>

Inheritance diagram for TiXmlNode:
Collaboration diagram for TiXmlNode:

Public Types

enum  NodeType {
  TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN,
  TINYXML_TEXT, TINYXML_DECLARATION, TINYXML_TYPECOUNT
}
 
- 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

 TiXmlNode (const TiXmlNode &)=delete
 
void operator= (const TiXmlNode &base)=delete
 
virtual ~TiXmlNode ()
 
const char * Value () const
 
const std::string & ValueStr () const
 
const TIXML_STRINGValueTStr () const
 
void SetValue (const char *_value)
 
void SetValue (const std::string &_value)
 STL std::string form. More...
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'. More...
 
TiXmlNodeParent ()
 One step up the DOM. More...
 
const TiXmlNodeParent () const
 
TiXmlNodeFirstChild ()
 
const TiXmlNodeFirstChild (const char *value) const
 
TiXmlNodeFirstChild (const char *_value)
 The first child of this node with the matching 'value'. Will be null if none found. More...
 
const TiXmlNodeLastChild () const
 
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children. More...
 
const TiXmlNodeLastChild (const char *value) const
 
TiXmlNodeLastChild (const char *_value)
 The last child of this node matching 'value'. Will be null if there are no children. More...
 
const TiXmlNodeIterateChildren (const TiXmlNode *previous) const
 
TiXmlNodeIterateChildren (const TiXmlNode *previous)
 
const TiXmlNodeIterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'. More...
 
TiXmlNodeIterateChildren (const char *_value, const TiXmlNode *previous)
 
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
 
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
 
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node. More...
 
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node. More...
 
TiXmlNodePreviousSibling ()
 
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node. More...
 
TiXmlNodePreviousSibling (const char *_prev)
 
const TiXmlNodeNextSibling () const
 Navigate to a sibling node. More...
 
TiXmlNodeNextSibling ()
 
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'. More...
 
TiXmlNodeNextSibling (const char *_next)
 
const TiXmlElementNextSiblingElement () const
 
TiXmlElementNextSiblingElement ()
 
const TiXmlElementNextSiblingElement (const char *) const
 
TiXmlElementNextSiblingElement (const char *_next)
 
const TiXmlElementFirstChildElement () const
 Convenience function to get through elements. More...
 
TiXmlElementFirstChildElement ()
 
const TiXmlElementFirstChildElement (const char *_value) const
 Convenience function to get through elements. More...
 
TiXmlElementFirstChildElement (const char *_value)
 
int Type () const
 
const TiXmlDocumentGetDocument () const
 
TiXmlDocumentGetDocument ()
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
virtual TiXmlNodeClone () const =0
 
virtual bool Accept (TiXmlVisitor *visitor) const =0
 
- Public Member Functions inherited from TiXmlBase
 TiXmlBase (const TiXmlBase &)=delete
 
void operator= (const TiXmlBase &base)=delete
 
 TiXmlBase ()
 
virtual ~TiXmlBase ()
 
virtual void Print (FILE *cfile, int depth) const =0
 
int Row () const
 
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)=0
 

Protected Member Functions

 TiXmlNode (NodeType _type)
 
void CopyTo (TiXmlNode *target) const
 
virtual void StreamIn (std::istream *in, TIXML_STRING *tag)=0
 
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)
 

Protected Attributes

TiXmlNodeparent
 
NodeType type
 
TiXmlNodefirstChild
 
TiXmlNodelastChild
 
TIXML_STRING value
 
TiXmlNodeprev
 
TiXmlNodenext
 
- Protected Attributes inherited from TiXmlBase
TiXmlCursor location
 
void * userData
 Field containing a generic user pointer. More...
 

Friends

class TiXmlDocument
 
class TiXmlElement
 
std::istream & operator>> (std::istream &in, TiXmlNode &base)
 
std::ostream & operator<< (std::ostream &out, const TiXmlNode &base)
 
std::string & operator<< (std::string &out, const TiXmlNode &base)
 Appends the XML node or attribute to a std::string. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting. More...
 
static void EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
 
- Static Public Attributes inherited from TiXmlBase
static const int utf8ByteTable [256]
 
- Static Protected Member Functions inherited from TiXmlBase
static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
 
static bool IsWhiteSpace (char c)
 
static bool IsWhiteSpace (int c)
 
static bool StreamWhiteSpace (std::istream *in, TIXML_STRING *tag)
 
static bool StreamTo (std::istream *in, int character, TIXML_STRING *tag)
 
static const char * ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding)
 
static const char * ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
 
static const char * GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
 
static const char * GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
 
static bool StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
 
static int IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
 
static int IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
 
static int ToLower (int v, TiXmlEncoding encoding)
 
static void ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)
 
- Static Protected Attributes inherited from TiXmlBase
static const char * errorString [TIXML_ERROR_STRING_COUNT]
 

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

Member Enumeration Documentation

◆ NodeType

The types of XML nodes supported by TinyXml. (All the unsupported types are picked up by UNKNOWN.)

Enumerator
TINYXML_DOCUMENT 
TINYXML_ELEMENT 
TINYXML_COMMENT 
TINYXML_UNKNOWN 
TINYXML_TEXT 
TINYXML_DECLARATION 
TINYXML_TYPECOUNT 

Definition at line 469 of file tinyxml.h.

Constructor & Destructor Documentation

◆ TiXmlNode() [1/2]

TiXmlNode::TiXmlNode ( const TiXmlNode )
delete

◆ ~TiXmlNode()

TiXmlNode::~TiXmlNode ( )
virtual

Definition at line 147 of file tinyxml.cpp.

◆ TiXmlNode() [2/2]

TiXmlNode::TiXmlNode ( NodeType  _type)
protected

Definition at line 136 of file tinyxml.cpp.

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

Here is the caller graph for this function:

◆ Clear()

void TiXmlNode::Clear ( )

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

Definition at line 169 of file tinyxml.cpp.

Here is the caller graph for this function:

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

Here is the caller graph for this function:

◆ CopyTo()

void TiXmlNode::CopyTo ( TiXmlNode target) const
protected

Definition at line 161 of file tinyxml.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FirstChild() [1/3]

TiXmlNode* TiXmlNode::FirstChild ( )
inline

Definition at line 530 of file tinyxml.h.

Here is the caller graph for this function:

◆ FirstChild() [2/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 533 of file tinyxml.h.

◆ FirstChild() [3/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 361 of file tinyxml.cpp.

Here is the call graph for this function:

◆ FirstChildElement() [1/4]

TiXmlElement* TiXmlNode::FirstChildElement ( )
inline

Definition at line 672 of file tinyxml.h.

◆ FirstChildElement() [2/4]

const TiXmlElement * TiXmlNode::FirstChildElement ( ) const

Convenience function to get through elements.

Definition at line 446 of file tinyxml.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FirstChildElement() [3/4]

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

Definition at line 678 of file tinyxml.h.

◆ FirstChildElement() [4/4]

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

Convenience function to get through elements.

Definition at line 461 of file tinyxml.cpp.

Here is the call graph for this function:

◆ GetDocument() [1/2]

TiXmlDocument* TiXmlNode::GetDocument ( )
inline

Definition at line 697 of file tinyxml.h.

◆ GetDocument() [2/2]

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

Here is the caller graph for this function:

◆ Identify()

TiXmlNode * TiXmlNode::Identify ( const char *  start,
TiXmlEncoding  encoding 
)
protected

Definition at line 822 of file tinyxmlparser.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

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

Here is the call graph for this function:

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

Here is the call graph for this function:

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

Here is the call graph for this function:

◆ IterateChildren() [1/4]

TiXmlNode* TiXmlNode::IterateChildren ( const char *  _value,
const TiXmlNode previous 
)
inline

Definition at line 576 of file tinyxml.h.

◆ IterateChildren() [2/4]

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

Here is the call graph for this function:

◆ IterateChildren() [3/4]

TiXmlNode* TiXmlNode::IterateChildren ( const TiXmlNode previous)
inline

Definition at line 570 of file tinyxml.h.

◆ IterateChildren() [4/4]

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

Here is the call graph for this function:

◆ LastChild() [1/4]

TiXmlNode* TiXmlNode::LastChild ( )
inline

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

Definition at line 539 of file tinyxml.h.

◆ LastChild() [2/4]

const TiXmlNode* TiXmlNode::LastChild ( ) const
inline

Definition at line 538 of file tinyxml.h.

Here is the caller graph for this function:

◆ LastChild() [3/4]

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

◆ LastChild() [4/4]

const TiXmlNode * TiXmlNode::LastChild ( const char *  value) const

Definition at line 373 of file tinyxml.cpp.

Here is the call graph for this function:

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ NextSibling() [1/4]

TiXmlNode* TiXmlNode::NextSibling ( )
inline

Definition at line 639 of file tinyxml.h.

◆ NextSibling() [2/4]

const TiXmlNode* TiXmlNode::NextSibling ( ) const
inline

Navigate to a sibling node.

Definition at line 638 of file tinyxml.h.

Here is the caller graph for this function:

◆ NextSibling() [3/4]

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

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

Definition at line 413 of file tinyxml.cpp.

Here is the call graph for this function:

◆ NextSibling() [4/4]

TiXmlNode* TiXmlNode::NextSibling ( const char *  _next)
inline

Definition at line 643 of file tinyxml.h.

◆ NextSiblingElement() [1/4]

TiXmlElement* TiXmlNode::NextSiblingElement ( )
inline

Definition at line 652 of file tinyxml.h.

◆ NextSiblingElement() [2/4]

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ NextSiblingElement() [3/4]

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

Here is the call graph for this function:

◆ NextSiblingElement() [4/4]

TiXmlElement* TiXmlNode::NextSiblingElement ( const char *  _next)
inline

Definition at line 661 of file tinyxml.h.

◆ NoChildren()

bool TiXmlNode::NoChildren ( ) const
inline

Returns true if this node has no children.

Definition at line 702 of file tinyxml.h.

◆ operator=()

void TiXmlNode::operator= ( const TiXmlNode base)
delete

◆ Parent() [1/2]

TiXmlNode* TiXmlNode::Parent ( )
inline

One step up the DOM.

Definition at line 526 of file tinyxml.h.

◆ Parent() [2/2]

const TiXmlNode* TiXmlNode::Parent ( ) const
inline

Definition at line 527 of file tinyxml.h.

◆ PreviousSibling() [1/4]

TiXmlNode* TiXmlNode::PreviousSibling ( )
inline

Definition at line 622 of file tinyxml.h.

◆ PreviousSibling() [2/4]

const TiXmlNode* TiXmlNode::PreviousSibling ( ) const
inline

Navigate to a sibling node.

Definition at line 621 of file tinyxml.h.

◆ PreviousSibling() [3/4]

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

Navigate to a sibling node.

Definition at line 425 of file tinyxml.cpp.

Here is the call graph for this function:

◆ PreviousSibling() [4/4]

TiXmlNode* TiXmlNode::PreviousSibling ( const char *  _prev)
inline

Definition at line 626 of file tinyxml.h.

◆ RemoveChild()

bool TiXmlNode::RemoveChild ( TiXmlNode removeThis)

Delete a child of this node.

Definition at line 335 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 296 of file tinyxml.cpp.

Here is the call graph for this function:

◆ SetValue() [1/2]

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

Here is the caller graph for this function:

◆ SetValue() [2/2]

void TiXmlNode::SetValue ( const std::string &  _value)
inline

STL std::string form.

Definition at line 519 of file tinyxml.h.

◆ StreamIn()

virtual void TiXmlNode::StreamIn ( std::istream *  in,
TIXML_STRING tag 
)
protectedpure virtual

Implemented in TiXmlDocument, TiXmlUnknown, TiXmlDeclaration, TiXmlText, TiXmlComment, and TiXmlElement.

Here is the caller graph for this function:

◆ Type()

int TiXmlNode::Type ( ) const
inline

Query the type (as an enumerated value, above) of this node. The possible types are: TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN, TINYXML_TEXT, and TINYXML_DECLARATION.

Definition at line 691 of file tinyxml.h.

Here is the caller graph for this function:

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

Here is the caller graph for this function:

◆ ValueStr()

const std::string& TiXmlNode::ValueStr ( ) const
inline

Return Value() as a std::string. If you only use STL, this is more efficient than calling Value(). Only available in STL mode.

Definition at line 501 of file tinyxml.h.

Here is the caller graph for this function:

◆ ValueTStr()

const TIXML_STRING& TiXmlNode::ValueTStr ( ) const
inline

Definition at line 504 of file tinyxml.h.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<< [1/2]

std::ostream& operator<< ( std::ostream &  out,
const TiXmlNode base 
)
friend

An output stream operator, for every class. Note that this outputs without any newlines or formatting, as opposed to Print(), which includes tabs and new lines.

The operator<< and operator>> are not completely symmetric. Writing a node to a stream is very well defined. You'll get a nice stream of output, without any extra whitespace or newlines.

But reading is not as well defined. (As it always is.) If you create a TiXmlElement (for example) and read that from an input stream, the text needs to define an element or junk will result. This is true of all input streams, but it's worth keeping in mind.

A TiXmlDocument will read nodes until it reads a root element, and all the children of that root element.

Definition at line 1412 of file tinyxml.cpp.

◆ operator<< [2/2]

std::string& operator<< ( std::string &  out,
const TiXmlNode base 
)
friend

Appends the XML node or attribute to a std::string.

Definition at line 1423 of file tinyxml.cpp.

◆ operator>>

std::istream& operator>> ( std::istream &  in,
TiXmlNode base 
)
friend

An input stream operator, for every class. Tolerant of newlines and formatting, but doesn't expect them.

Definition at line 1399 of file tinyxml.cpp.

◆ TiXmlDocument

friend class TiXmlDocument
friend

Definition at line 429 of file tinyxml.h.

◆ TiXmlElement

friend class TiXmlElement
friend

Definition at line 430 of file tinyxml.h.

Member Data Documentation

◆ firstChild

TiXmlNode* TiXmlNode::firstChild
protected

Definition at line 765 of file tinyxml.h.

◆ lastChild

TiXmlNode* TiXmlNode::lastChild
protected

Definition at line 766 of file tinyxml.h.

◆ next

TiXmlNode* TiXmlNode::next
protected

Definition at line 771 of file tinyxml.h.

◆ parent

TiXmlNode* TiXmlNode::parent
protected

Definition at line 762 of file tinyxml.h.

◆ prev

TiXmlNode* TiXmlNode::prev
protected

Definition at line 770 of file tinyxml.h.

◆ type

NodeType TiXmlNode::type
protected

Definition at line 763 of file tinyxml.h.

◆ value

TIXML_STRING TiXmlNode::value
protected

Definition at line 768 of file tinyxml.h.


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