nux-1.16.0
TiXmlNode Class Reference

The parent class for everything in the Document Object Model. More...

#include <NuxCore/TinyXML/tinyxml.h>

Inheritance diagram for TiXmlNode:
TiXmlBase TiXmlComment TiXmlDeclaration TiXmlDocument TiXmlElement TiXmlText TiXmlUnknown

List of all members.

Public Types

enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
 The types of XML nodes supported by TinyXml. More...

Public Member Functions

const char * Value () const
 The meaning of 'value' changes for the specific type of TiXmlNode.
const TIXML_STRING & ValueTStr () const
void SetValue (const char *_value)
 Changes the value of the node.
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
TiXmlNodeParent ()
 One step up the DOM.
const TiXmlNodeParent () const
const TiXmlNodeFirstChild () const
TiXmlNodeFirstChild ()
const TiXmlNodeFirstChild (const char *value) const
 The first child of this node with the matching 'value'.
TiXmlNodeFirstChild (const char *_value)
 The first child of this node with the matching 'value'. Will be null if none found.
const TiXmlNodeLastChild () const
TiXmlNodeLastChild ()
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.
const TiXmlNodeIterateChildren (const TiXmlNode *previous) const
 An alternate way to walk the children of a node.
TiXmlNodeIterateChildren (const TiXmlNode *previous)
const TiXmlNodeIterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
TiXmlNodeIterateChildren (const char *_value, const TiXmlNode *previous)
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
 Add a new node related to this.
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 Replace a child of this node.
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
TiXmlNodePreviousSibling ()
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
TiXmlNodePreviousSibling (const char *_prev)
const TiXmlNodeNextSibling () const
 Navigate to a sibling node.
TiXmlNodeNextSibling ()
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
TiXmlNodeNextSibling (const char *_next)
const TiXmlElementNextSiblingElement () const
 Convenience function to get through elements.
TiXmlElementNextSiblingElement ()
const TiXmlElementNextSiblingElement (const char *) const
 Convenience function to get through elements.
TiXmlElementNextSiblingElement (const char *_next)
const TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
TiXmlElementFirstChildElement ()
const TiXmlElementFirstChildElement (const char *_value) const
 Convenience function to get through elements.
TiXmlElementFirstChildElement (const char *_value)
int Type () const
 Query the type (as an enumerated value, above) of this node.
const TiXmlDocumentGetDocument () const
 Return a pointer to the Document this node lives in.
TiXmlDocumentGetDocument ()
bool NoChildren () const
 Returns true if this node has no children.
virtual const TiXmlDocumentToDocument () const
virtual const TiXmlElementToElement () const
virtual const TiXmlCommentToComment () const
virtual const TiXmlUnknownToUnknown () const
virtual const TiXmlTextToText () const
virtual const TiXmlDeclarationToDeclaration () const
virtual TiXmlDocumentToDocument ()
virtual TiXmlElementToElement ()
virtual TiXmlCommentToComment ()
virtual TiXmlUnknownToUnknown ()
virtual TiXmlTextToText ()
virtual TiXmlDeclarationToDeclaration ()
virtual TiXmlNodeClone () const =0
 Create an exact duplicate of this node and return it.
virtual bool Accept (TiXmlVisitor *visitor) const =0
 Accept a hierchical visit the nodes in the TinyXML DOM.

Protected Member Functions

 TiXmlNode (NodeType _type)
void CopyTo (TiXmlNode *target) const
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)

Protected Attributes

TiXmlNodeparent
NodeType type
TiXmlNodefirstChild
TiXmlNodelastChild
TIXML_STRING value
TiXmlNodeprev
TiXmlNodenext

Friends

class TiXmlDocument
class TiXmlElement

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


Member Enumeration Documentation

The types of XML nodes supported by TinyXml.

(All the unsupported types are picked up by UNKNOWN.)

Definition at line 542 of file tinyxml.h.

  {
    DOCUMENT,
    ELEMENT,
    COMMENT,
    UNKNOWN,
    TEXT,
    DECLARATION,
    TYPECOUNT
  };

Member Function Documentation

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

Referenced by TiXmlDocument::Accept(), and TiXmlElement::Accept().

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

Referenced by InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), and ReplaceChild().

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

References Value().

{
  const TiXmlNode *node;

  for ( node = firstChild; node; node = node->next )
  {
    if ( strcmp ( node->Value(), _value ) == 0 )
      return node;
  }

  return 0;
}
const TiXmlNode* TiXmlNode::FirstChild ( ) const [inline]

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

Definition at line 623 of file tinyxml.h.

Referenced by TiXmlDocument::Accept(), TiXmlElement::Accept(), FirstChildElement(), TiXmlElement::GetText(), IterateChildren(), TiXmlDocument::Print(), TiXmlPrinter::VisitEnter(), and TiXmlPrinter::VisitExit().

  {
    return firstChild;  
  }
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 550 of file tinyxml.cpp.

References ToDocument().

Referenced by InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), LinkEndChild(), and TiXmlElement::SetAttribute().

{
  const TiXmlNode *node;

  for ( node = this; node; node = node->parent )
  {
    if ( node->ToDocument() )
      return node->ToDocument();
  }

  return 0;
}
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 296 of file tinyxml.cpp.

References Clone(), GetDocument(), and Type().

{
  if ( !afterThis || afterThis->parent != this )
  {
    return 0;
  }

  if ( addThis.Type() == TiXmlNode::DOCUMENT )
  {
    if ( GetDocument() ) GetDocument()->SetError ( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );

    return 0;
  }

  TiXmlNode *node = addThis.Clone();

  if ( !node )
    return 0;

  node->parent = this;

  node->prev = afterThis;
  node->next = afterThis->next;

  if ( afterThis->next )
  {
    afterThis->next->prev = node;
  }
  else
  {
    assert ( lastChild == afterThis );
    lastChild = node;
  }

  afterThis->next = node;
  return node;
}
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 257 of file tinyxml.cpp.

References Clone(), GetDocument(), and Type().

{
  if ( !beforeThis || beforeThis->parent != this )
  {
    return 0;
  }

  if ( addThis.Type() == TiXmlNode::DOCUMENT )
  {
    if ( GetDocument() ) GetDocument()->SetError ( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );

    return 0;
  }

  TiXmlNode *node = addThis.Clone();

  if ( !node )
    return 0;

  node->parent = this;

  node->next = beforeThis;
  node->prev = beforeThis->prev;

  if ( beforeThis->prev )
  {
    beforeThis->prev->next = node;
  }
  else
  {
    assert ( firstChild == beforeThis );
    firstChild = node;
  }

  beforeThis->prev = node;
  return node;
}
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 239 of file tinyxml.cpp.

References Clone(), GetDocument(), LinkEndChild(), and Type().

{
  if ( addThis.Type() == TiXmlNode::DOCUMENT )
  {
    if ( GetDocument() ) GetDocument()->SetError ( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );

    return 0;
  }

  TiXmlNode *node = addThis.Clone();

  if ( !node )
    return 0;

  return LinkEndChild ( node );
}
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 414 of file tinyxml.cpp.

References FirstChild(), and NextSibling().

{
  if ( !previous )
  {
    return FirstChild();
  }
  else
  {
    assert ( previous->parent == this );
    return previous->NextSibling();
  }
}
const TiXmlNode* TiXmlNode::LastChild ( ) const [inline]

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

Definition at line 639 of file tinyxml.h.

Referenced by TiXmlPrinter::VisitEnter().

  {
    return lastChild;  
  }
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 209 of file tinyxml.cpp.

References GetDocument(), and Type().

Referenced by InsertEndChild(), and TiXmlDocument::Parse().

{
  assert ( node->parent == 0 || node->parent == this );
  assert ( node->GetDocument() == 0 || node->GetDocument() == this->GetDocument() );

  if ( node->Type() == TiXmlNode::DOCUMENT )
  {
    delete node;
    node = 0;

    if ( GetDocument() ) GetDocument()->SetError ( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );

    return 0;
  }

  node->parent = this;

  node->prev = lastChild;
  node->next = 0;

  if ( lastChild )
    lastChild->next = node;
  else
    firstChild = node;                  // it was an empty list.

  lastChild = node;
  return node;
}
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 534 of file tinyxml.cpp.

References NextSibling(), and ToElement().

{
  const TiXmlNode *node;

  for ( node = NextSibling ( _value );
        node;
        node = node->NextSibling ( _value ) )
  {
    if ( node->ToElement() )
      return node->ToElement();
  }

  return 0;
}
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 518 of file tinyxml.cpp.

References NextSibling(), and ToElement().

Referenced by TiXmlHandle::ChildElement(), and nux::NodeNetCom::CreateFromXML().

{
  const TiXmlNode *node;

  for ( node = NextSibling();
        node;
        node = node->NextSibling() )
  {
    if ( node->ToElement() )
      return node->ToElement();
  }

  return 0;
}
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 335 of file tinyxml.cpp.

References Clone().

{
  if ( replaceThis->parent != this )
    return 0;

  TiXmlNode *node = withThis.Clone();

  if ( !node )
    return 0;

  node->next = replaceThis->next;
  node->prev = replaceThis->prev;

  if ( replaceThis->next )
    replaceThis->next->prev = node;
  else
    lastChild = node;

  if ( replaceThis->prev )
    replaceThis->prev->next = node;
  else
    firstChild = node;

  delete replaceThis;
  node->parent = this;
  return node;
}
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 597 of file tinyxml.h.

Referenced by TiXmlComment::TiXmlComment(), and TiXmlText::TiXmlText().

  {
    value = _value;
  }
virtual TiXmlComment* TiXmlNode::ToComment ( ) [inline, virtual]

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

Reimplemented in TiXmlComment.

Definition at line 914 of file tinyxml.h.

  {
    return 0;  
  }
virtual const TiXmlComment* TiXmlNode::ToComment ( ) const [inline, virtual]

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

Reimplemented in TiXmlComment.

Definition at line 889 of file tinyxml.h.

  {
    return 0;  
  }
virtual const TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) const [inline, virtual]

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

Reimplemented in TiXmlDeclaration.

Definition at line 901 of file tinyxml.h.

Referenced by TiXmlDocument::Parse().

  {
    return 0;  
  }
virtual TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) [inline, virtual]

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

Reimplemented in TiXmlDeclaration.

Definition at line 926 of file tinyxml.h.

  {
    return 0;  
  }
virtual TiXmlDocument* TiXmlNode::ToDocument ( ) [inline, virtual]

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

Reimplemented in TiXmlDocument.

Definition at line 906 of file tinyxml.h.

  {
    return 0;  
  }
virtual const TiXmlDocument* TiXmlNode::ToDocument ( ) const [inline, virtual]

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

Reimplemented in TiXmlDocument.

Definition at line 881 of file tinyxml.h.

Referenced by GetDocument().

  {
    return 0;  
  }
virtual const TiXmlElement* TiXmlNode::ToElement ( ) const [inline, virtual]

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

Reimplemented in TiXmlElement.

Definition at line 885 of file tinyxml.h.

Referenced by FirstChildElement(), and NextSiblingElement().

  {
    return 0;  
  }
virtual TiXmlElement* TiXmlNode::ToElement ( ) [inline, virtual]

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

Reimplemented in TiXmlElement.

Definition at line 910 of file tinyxml.h.

  {
    return 0;  
  }
virtual TiXmlText* TiXmlNode::ToText ( ) [inline, virtual]

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

Reimplemented in TiXmlText.

Definition at line 922 of file tinyxml.h.

  {
    return 0;  
  }
virtual const TiXmlText* TiXmlNode::ToText ( ) const [inline, virtual]

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

Reimplemented in TiXmlText.

Definition at line 897 of file tinyxml.h.

Referenced by TiXmlElement::GetText(), TiXmlElement::Print(), and TiXmlPrinter::VisitEnter().

  {
    return 0;  
  }
virtual TiXmlUnknown* TiXmlNode::ToUnknown ( ) [inline, virtual]

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

Reimplemented in TiXmlUnknown.

Definition at line 918 of file tinyxml.h.

  {
    return 0;  
  }
virtual const TiXmlUnknown* TiXmlNode::ToUnknown ( ) const [inline, virtual]

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

Reimplemented in TiXmlUnknown.

Definition at line 893 of file tinyxml.h.

  {
    return 0;  
  }
int TiXmlNode::Type ( ) const [inline]

Query the type (as an enumerated value, above) of this node.

The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.

Definition at line 861 of file tinyxml.h.

Referenced by InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), and LinkEndChild().

  {
    return type;
  }
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 567 of file tinyxml.h.

Referenced by TiXmlElement::Clone(), FirstChild(), TiXmlElement::GetText(), TiXmlDocument::LoadFile(), NextSibling(), PreviousSibling(), TiXmlDocument::SaveFile(), TiXmlPrinter::Visit(), TiXmlPrinter::VisitEnter(), and TiXmlPrinter::VisitExit().

  {
    return value.c_str ();
  }

The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends