ddc
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
TiXmlNode Class Referenceabstract

#include <tinyxml.h>

Inheritance diagram for TiXmlNode:
Inheritance graph
[legend]
Collaboration diagram for TiXmlNode:
Collaboration graph
[legend]

Public Types

enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
 

Public Member Functions

virtual ~TiXmlNode ()
 
const char * Value () const
 
void SetValue (const char *_value)
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'. More...
 
TiXmlNodeParent () const
 One step up the DOM. More...
 
TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children. More...
 
TiXmlNodeFirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found. More...
 
TiXmlNodeLastChild () const
 
TiXmlNodeLastChild (const char *value) const
 The last child of this node. Will be null if there are no children. More...
 
TiXmlNodeIterateChildren (TiXmlNode *previous) const
 The last child of this node matching 'value'. Will be null if there are no children. More...
 
TiXmlNodeIterateChildren (const char *value, TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'. More...
 
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...
 
TiXmlNodePreviousSibling () const
 Navigate to a sibling node. More...
 
TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node. More...
 
TiXmlNodeNextSibling () const
 Navigate to a sibling node. More...
 
TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'. More...
 
TiXmlElementNextSiblingElement () const
 
TiXmlElementNextSiblingElement (const char *) const
 
TiXmlElementFirstChildElement () const
 Convenience function to get through elements. More...
 
TiXmlElementFirstChildElement (const char *value) const
 Convenience function to get through elements. More...
 
virtual int Type () const
 
TiXmlDocumentGetDocument () const
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlElementToElement () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlCommentToComment () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlTextToText () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
virtual TiXmlNodeClone () const =0
 
- Public Member Functions inherited from TiXmlBase
 TiXmlBase ()
 
virtual ~TiXmlBase ()
 
virtual void Print (FILE *cfile, int depth) const =0
 
int Row () const
 
int Column () const
 See Row() More...
 
void SetUserData (void *user)
 
void * GetUserData ()
 
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)=0
 

Protected Member Functions

 TiXmlNode (NodeType _type)
 
void CopyTo (TiXmlNode *target) const
 
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)
 
const TiXmlStringSValue () const
 
- Protected Member Functions inherited from TiXmlBase
virtual void StreamOut (TiXmlOutStream *) const =0
 

Protected Attributes

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

Private Member Functions

 TiXmlNode (const TiXmlNode &)
 
void operator= (const TiXmlNode &base)
 

Friends

class TiXmlDocument
 
class TiXmlElement
 
TiXmlOutStreamoperator<< (TiXmlOutStream &out, const TiXmlNode &base)
 

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 Public Attributes inherited from TiXmlBase
static const int utf8ByteTable [256]
 
- Protected Types inherited from TiXmlBase
enum  {
  TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY,
  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_STRING_COUNT
}
 
- Static Protected Member Functions inherited from TiXmlBase
static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
 
static bool IsWhiteSpace (char c)
 
static const char * ReadName (const char *p, TiXmlString *name, TiXmlEncoding encoding)
 
static const char * ReadText (const char *in, TiXmlString *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 void PutString (const TiXmlString &str, TiXmlOutStream *out)
 
static void PutString (const TiXmlString &str, TiXmlString *out)
 
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.

Member Enumeration Documentation

◆ NodeType

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

Enumerator
DOCUMENT 
ELEMENT 
COMMENT 
UNKNOWN 
TEXT 
DECLARATION 
TYPECOUNT 

Constructor & Destructor Documentation

◆ ~TiXmlNode()

TiXmlNode::~TiXmlNode ( )
virtual

References firstChild, and next.

◆ TiXmlNode() [1/2]

TiXmlNode::TiXmlNode ( NodeType  _type)
protected

◆ TiXmlNode() [2/2]

TiXmlNode::TiXmlNode ( const TiXmlNode )
private

Member Function Documentation

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

References TiXmlString::c_str(), and value.

Referenced by TiXmlElement::Clone(), GetCWBFormattedStringRecursive(), GetTextFromXMLRecursive(), CConcXml::ReadMorphXmlFileIntoGraTable(), and ReadXmlField().

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

◆ SetValue()

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

References TiXmlBase::StringToBuffer::buffer, TiXmlCursor::Clear(), and value.

Referenced by CopyTo(), TiXmlAttribute::SetDoubleValue(), TiXmlAttribute::SetIntValue(), TiXmlText::TiXmlText(), and TiXmlText::~TiXmlText().

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

◆ Clear()

void TiXmlNode::Clear ( )

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

References firstChild, lastChild, and next.

Referenced by TiXmlElement::ClearThis(), TiXmlDocument::LoadFile(), TiXmlComment::operator=(), TiXmlDeclaration::operator=(), and TiXmlDocument::operator=().

Here is the caller graph for this function:

◆ Parent()

TiXmlNode* TiXmlNode::Parent ( ) const
inline

One step up the DOM.

References parent.

◆ FirstChild() [1/2]

TiXmlNode* TiXmlNode::FirstChild ( ) const
inline

◆ FirstChild() [2/2]

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

The first child of this node with the matching 'value'. Will be null if none found.

References firstChild, next, SValue(), and TIXML_STRING.

Here is the call graph for this function:

◆ LastChild() [1/2]

TiXmlNode* TiXmlNode::LastChild ( ) const
inline

◆ LastChild() [2/2]

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

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

References lastChild, prev, SValue(), and TIXML_STRING.

Here is the call graph for this function:

◆ IterateChildren() [1/2]

TiXmlNode * TiXmlNode::IterateChildren ( TiXmlNode previous) const

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

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.

References FirstChild(), NextSibling(), and parent.

Referenced by LastChild().

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

◆ IterateChildren() [2/2]

TiXmlNode * TiXmlNode::IterateChildren ( const char *  value,
TiXmlNode previous 
) const

This flavor of IterateChildren searches for children with a particular 'value'.

References FirstChild(), NextSibling(), and parent.

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.

References Clone(), and LinkEndChild().

Referenced by LastChild().

Here is the call graph for this function:
Here is the caller 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.

@sa InsertEndChild

References firstChild, lastChild, next, parent, and prev.

Referenced by TiXmlElement::CopyTo(), TiXmlDocument::CopyTo(), InsertEndChild(), LastChild(), TiXmlDocument::Parse(), and TiXmlElement::ReadValue().

Here is the caller 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.

References Clone(), firstChild, next, parent, and prev.

Referenced by LastChild().

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.

References Clone(), lastChild, next, parent, and prev.

Referenced by LastChild().

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

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

References Clone(), firstChild, lastChild, next, parent, and prev.

Referenced by LastChild().

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

◆ RemoveChild()

bool TiXmlNode::RemoveChild ( TiXmlNode removeThis)

Delete a child of this node.

References firstChild, lastChild, next, parent, and prev.

Referenced by LastChild().

Here is the caller graph for this function:

◆ PreviousSibling() [1/2]

TiXmlNode* TiXmlNode::PreviousSibling ( ) const
inline

Navigate to a sibling node.

References NextSibling(), and prev.

Here is the call graph for this function:

◆ PreviousSibling() [2/2]

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

Navigate to a sibling node.

References prev, SValue(), and TIXML_STRING.

Here is the call graph for this function:

◆ NextSibling() [1/2]

TiXmlNode* TiXmlNode::NextSibling ( ) const
inline

◆ NextSibling() [2/2]

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

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

References next, SValue(), and TIXML_STRING.

Here is the call graph for this function:

◆ NextSiblingElement() [1/2]

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.

References NextSibling(), and ToElement().

Referenced by TiXmlHandle::ChildElement(), NextSibling(), and CConcXml::ReadMorphXmlFileIntoGraTable().

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

◆ NextSiblingElement() [2/2]

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.

References NextSibling(), and ToElement().

Here is the call graph for this function:

◆ FirstChildElement() [1/2]

TiXmlElement * TiXmlNode::FirstChildElement ( ) const

Convenience function to get through elements.

References FirstChild(), NextSibling(), and ToElement().

Referenced by TiXmlHandle::ChildElement(), TiXmlHandle::FirstChildElement(), NextSibling(), and CConcXml::ReadMorphXmlFileIntoGraTable().

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

◆ FirstChildElement() [2/2]

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

Convenience function to get through elements.

References FirstChild(), NextSibling(), and ToElement().

Here is the call graph for this function:

◆ Type()

virtual int TiXmlNode::Type ( ) const
inlinevirtual

Query the type (as an enumerated value, above) of this node. The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.

References GetDocument(), and type.

Referenced by GetCWBFormattedStringRecursive(), and GetTextFromXMLRecursive().

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

◆ GetDocument()

TiXmlDocument * TiXmlNode::GetDocument ( ) const

Return a pointer to the Document this node lives in. Returns null if not in a document.

References parent, and ToDocument().

Referenced by Identify(), TiXmlAttribute::Parse(), TiXmlElement::Parse(), TiXmlComment::Parse(), TiXmlText::Parse(), TiXmlDeclaration::Parse(), TiXmlUnknown::Parse(), TiXmlElement::ReadValue(), TiXmlElement::SetAttribute(), and Type().

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

◆ NoChildren()

bool TiXmlNode::NoChildren ( ) const
inline

Returns true if this node has no children.

References firstChild.

◆ ToDocument()

TiXmlDocument* TiXmlNode::ToDocument ( ) const
inline

Cast to a more defined type. Will return null not of the requested type.

References DOCUMENT, and type.

Referenced by GetDocument().

Here is the caller graph for this function:

◆ ToElement()

TiXmlElement* TiXmlNode::ToElement ( ) const
inline

Cast to a more defined type. Will return null not of the requested type.

References ELEMENT, and type.

Referenced by FirstChildElement(), GetCWBFormattedStringRecursive(), CBiblIndex::GetTextAreaElements(), NextSiblingElement(), TiXmlBase::ReadText(), and TiXmlDocument::StreamOut().

Here is the caller graph for this function:

◆ ToComment()

TiXmlComment* TiXmlNode::ToComment ( ) const
inline

Cast to a more defined type. Will return null not of the requested type.

References COMMENT, and type.

◆ ToUnknown()

TiXmlUnknown* TiXmlNode::ToUnknown ( ) const
inline

Cast to a more defined type. Will return null not of the requested type.

References type, and UNKNOWN.

◆ ToText()

TiXmlText* TiXmlNode::ToText ( ) const
inline

Cast to a more defined type. Will return null not of the requested type.

References TEXT, and type.

Referenced by TiXmlElement::Print().

Here is the caller graph for this function:

◆ ToDeclaration()

TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) const
inline

Cast to a more defined type. Will return null not of the requested type.

References TiXmlElement::Clone(), TiXmlElement::CopyTo(), DECLARATION, Identify(), TIXML_STRING, TiXmlNode(), and type.

Referenced by TiXmlDocument::Parse().

Here is the call graph for this function:
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.

Referenced by TiXmlElement::CopyTo(), TiXmlDocument::CopyTo(), InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), and ReplaceChild().

Here is the caller graph for this function:

◆ CopyTo()

void TiXmlNode::CopyTo ( TiXmlNode target) const
protected

References TiXmlString::c_str(), SetValue(), TiXmlBase::userData, and value.

Referenced by TiXmlElement::CopyTo(), TiXmlComment::CopyTo(), TiXmlText::CopyTo(), TiXmlDeclaration::CopyTo(), TiXmlUnknown::CopyTo(), and TiXmlDocument::CopyTo().

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

◆ Identify()

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

◆ SValue()

const TiXmlString& TiXmlNode::SValue ( ) const
inlineprotected

References value.

Referenced by FirstChild(), LastChild(), NextSibling(), and PreviousSibling().

Here is the caller graph for this function:

◆ operator=()

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

Friends And Related Function Documentation

◆ TiXmlDocument

friend class TiXmlDocument
friend

◆ TiXmlElement

friend class TiXmlElement
friend

◆ operator<<

TiXmlOutStream& operator<< ( TiXmlOutStream out,
const TiXmlNode base 
)
friend

Referenced by operator<<().

Member Data Documentation

◆ parent

TiXmlNode* TiXmlNode::parent
protected

◆ type

NodeType TiXmlNode::type
protected

◆ firstChild

TiXmlNode* TiXmlNode::firstChild
protected

◆ lastChild

TiXmlNode* TiXmlNode::lastChild
protected

◆ value

TiXmlString TiXmlNode::value
protected

◆ prev

TiXmlNode* TiXmlNode::prev
protected

◆ next

TiXmlNode* TiXmlNode::next
protected

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