osgEarth 2.1.1
|
#include <tinyxml.h>
Public Types | |
enum | NodeType { TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN, TINYXML_TEXT, TINYXML_DECLARATION, TINYXML_TYPECOUNT } |
Public Member Functions | |
virtual | ~TiXmlNode () |
const char * | Value () const |
const TIXML_STRING & | ValueTStr () const |
void | SetValue (const char *_value) |
void | Clear () |
Delete all the children of this node. Does not affect 'this'. | |
TiXmlNode * | Parent () |
One step up the DOM. | |
const TiXmlNode * | Parent () const |
const TiXmlNode * | FirstChild () const |
The first child of this node. Will be null if there are no children. | |
TiXmlNode * | FirstChild () |
const TiXmlNode * | FirstChild (const char *value) const |
TiXmlNode * | FirstChild (const char *_value) |
The first child of this node with the matching 'value'. Will be null if none found. | |
const TiXmlNode * | LastChild () const |
TiXmlNode * | LastChild () |
The last child of this node. Will be null if there are no children. | |
const TiXmlNode * | LastChild (const char *value) const |
TiXmlNode * | LastChild (const char *_value) |
The last child of this node matching 'value'. Will be null if there are no children. | |
const TiXmlNode * | IterateChildren (const TiXmlNode *previous) const |
TiXmlNode * | IterateChildren (const TiXmlNode *previous) |
const TiXmlNode * | IterateChildren (const char *value, const TiXmlNode *previous) const |
This flavor of IterateChildren searches for children with a particular 'value'. | |
TiXmlNode * | IterateChildren (const char *_value, const TiXmlNode *previous) |
TiXmlNode * | InsertEndChild (const TiXmlNode &addThis) |
TiXmlNode * | LinkEndChild (TiXmlNode *addThis) |
TiXmlNode * | InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis) |
TiXmlNode * | InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis) |
TiXmlNode * | ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis) |
bool | RemoveChild (TiXmlNode *removeThis) |
Delete a child of this node. | |
const TiXmlNode * | PreviousSibling () const |
Navigate to a sibling node. | |
TiXmlNode * | PreviousSibling () |
const TiXmlNode * | PreviousSibling (const char *) const |
Navigate to a sibling node. | |
TiXmlNode * | PreviousSibling (const char *_prev) |
const TiXmlNode * | NextSibling () const |
Navigate to a sibling node. | |
TiXmlNode * | NextSibling () |
const TiXmlNode * | NextSibling (const char *) const |
Navigate to a sibling node with the given 'value'. | |
TiXmlNode * | NextSibling (const char *_next) |
const TiXmlElement * | NextSiblingElement () const |
TiXmlElement * | NextSiblingElement () |
const TiXmlElement * | NextSiblingElement (const char *) const |
TiXmlElement * | NextSiblingElement (const char *_next) |
const TiXmlElement * | FirstChildElement () const |
Convenience function to get through elements. | |
TiXmlElement * | FirstChildElement () |
const TiXmlElement * | FirstChildElement (const char *_value) const |
Convenience function to get through elements. | |
TiXmlElement * | FirstChildElement (const char *_value) |
int | Type () const |
const TiXmlDocument * | GetDocument () const |
TiXmlDocument * | GetDocument () |
bool | NoChildren () const |
Returns true if this node has no children. | |
virtual const TiXmlDocument * | ToDocument () const |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual const TiXmlElement * | ToElement () const |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual const TiXmlComment * | ToComment () const |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual const TiXmlUnknown * | ToUnknown () const |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual const TiXmlText * | ToText () const |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual const TiXmlDeclaration * | ToDeclaration () const |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlDocument * | ToDocument () |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlElement * | ToElement () |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlComment * | ToComment () |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlUnknown * | ToUnknown () |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlText * | ToText () |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlDeclaration * | ToDeclaration () |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlNode * | Clone () const =0 |
virtual bool | Accept (TiXmlVisitor *visitor) const =0 |
Protected Member Functions | |
TiXmlNode (NodeType _type) | |
void | CopyTo (TiXmlNode *target) const |
TiXmlNode * | Identify (const char *start, TiXmlEncoding encoding) |
Protected Attributes | |
TiXmlNode * | parent |
NodeType | type |
TiXmlNode * | firstChild |
TiXmlNode * | lastChild |
TIXML_STRING | value |
TiXmlNode * | prev |
TiXmlNode * | next |
Private Member Functions | |
TiXmlNode (const TiXmlNode &) | |
void | operator= (const TiXmlNode &base) |
Friends | |
class | TiXmlDocument |
class | TiXmlElement |
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.
enum TiXmlNode::NodeType |
TiXmlNode::~TiXmlNode | ( | ) | [virtual] |
Definition at line 147 of file tinyxml.cpp.
{ TiXmlNode* node = firstChild; TiXmlNode* temp = 0; while ( node ) { temp = node; node = node->next; delete temp; } }
TiXmlNode::TiXmlNode | ( | NodeType | _type | ) | [protected] |
Definition at line 136 of file tinyxml.cpp.
TiXmlNode::TiXmlNode | ( | const TiXmlNode & | ) | [private] |
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.
void TiXmlNode::Clear | ( | ) |
Delete all the children of this node. Does not affect 'this'.
Definition at line 169 of file tinyxml.cpp.
{ TiXmlNode* node = firstChild; TiXmlNode* temp = 0; while ( node ) { temp = node; node = node->next; delete temp; } firstChild = 0; lastChild = 0; }
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.
void TiXmlNode::CopyTo | ( | TiXmlNode * | target | ) | const [protected] |
TiXmlNode* TiXmlNode::FirstChild | ( | ) | [inline] |
Definition at line 523 of file tinyxml.h.
{ return firstChild; }
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 357 of file tinyxml.cpp.
{ const TiXmlNode* node; for ( node = firstChild; node; node = node->next ) { if ( strcmp( node->Value(), _value ) == 0 ) return node; } return 0; }
TiXmlNode* TiXmlNode::FirstChild | ( | const char * | _value | ) | [inline] |
The first child of this node with the matching 'value'. Will be null if none found.
const TiXmlNode* TiXmlNode::FirstChild | ( | ) | const [inline] |
const TiXmlElement * TiXmlNode::FirstChildElement | ( | ) | const |
Convenience function to get through elements.
Definition at line 448 of file tinyxml.cpp.
{ const TiXmlNode* node; for ( node = FirstChild(); node; node = node->NextSibling() ) { if ( node->ToElement() ) return node->ToElement(); } return 0; }
TiXmlElement* TiXmlNode::FirstChildElement | ( | ) | [inline] |
Definition at line 665 of file tinyxml.h.
{ return const_cast< TiXmlElement* >( (const_cast< const TiXmlNode* >(this))->FirstChildElement() ); }
const TiXmlElement * TiXmlNode::FirstChildElement | ( | const char * | _value | ) | const |
Convenience function to get through elements.
Definition at line 463 of file tinyxml.cpp.
{ const TiXmlNode* node; for ( node = FirstChild( _value ); node; node = node->NextSibling( _value ) ) { if ( node->ToElement() ) return node->ToElement(); } return 0; }
TiXmlElement* TiXmlNode::FirstChildElement | ( | const char * | _value | ) | [inline] |
Definition at line 671 of file tinyxml.h.
{ return const_cast< TiXmlElement* >( (const_cast< const TiXmlNode* >(this))->FirstChildElement( _value ) ); }
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 508 of file tinyxml.cpp.
{ const TiXmlNode* node; for( node = this; node; node = node->parent ) { if ( node->ToDocument() ) return node->ToDocument(); } return 0; }
TiXmlDocument* TiXmlNode::GetDocument | ( | ) | [inline] |
Definition at line 690 of file tinyxml.h.
{ return const_cast< TiXmlDocument* >( (const_cast< const TiXmlNode* >(this))->GetDocument() ); }
TiXmlNode * TiXmlNode::Identify | ( | const char * | start, |
TiXmlEncoding | encoding | ||
) | [protected] |
Definition at line 818 of file tinyxmlparser.cpp.
{ TiXmlNode* returnNode = 0; p = SkipWhiteSpace( p, encoding ); if( !p || !*p || *p != '<' ) { return 0; } p = SkipWhiteSpace( p, encoding ); if ( !p || !*p ) { return 0; } // What is this thing? // - Elements start with a letter or underscore, but xml is reserved. // - Comments: <!-- // - Decleration: <?xml // - Everthing else is unknown to tinyxml. // const char* xmlHeader = { "<?xml" }; const char* commentHeader = { "<!--" }; const char* dtdHeader = { "<!" }; const char* cdataHeader = { "<![CDATA[" }; if ( StringEqual( p, xmlHeader, true, encoding ) ) { #ifdef DEBUG_PARSER TIXML_LOG( "XML parsing Declaration\n" ); #endif returnNode = new TiXmlDeclaration(); } else if ( StringEqual( p, commentHeader, false, encoding ) ) { #ifdef DEBUG_PARSER TIXML_LOG( "XML parsing Comment\n" ); #endif returnNode = new TiXmlComment(); } else if ( StringEqual( p, cdataHeader, false, encoding ) ) { #ifdef DEBUG_PARSER TIXML_LOG( "XML parsing CDATA\n" ); #endif TiXmlText* text = new TiXmlText( "" ); text->SetCDATA( true ); returnNode = text; } else if ( StringEqual( p, dtdHeader, false, encoding ) ) { #ifdef DEBUG_PARSER TIXML_LOG( "XML parsing Unknown(1)\n" ); #endif returnNode = new TiXmlUnknown(); } else if ( IsAlpha( *(p+1), encoding ) || *(p+1) == '_' ) { #ifdef DEBUG_PARSER TIXML_LOG( "XML parsing Element\n" ); #endif returnNode = new TiXmlElement( "" ); } else { #ifdef DEBUG_PARSER TIXML_LOG( "XML parsing Unknown(2)\n" ); #endif returnNode = new TiXmlUnknown(); } if ( returnNode ) { // Set the parent, so it can report errors returnNode->parent = this; } return returnNode; }
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 260 of file tinyxml.cpp.
{ if ( !afterThis || afterThis->parent != this ) { return 0; } if ( addThis.Type() == TiXmlNode::TINYXML_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; }
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 228 of file tinyxml.cpp.
{ if ( !beforeThis || beforeThis->parent != this ) { return 0; } if ( addThis.Type() == TiXmlNode::TINYXML_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; }
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 213 of file tinyxml.cpp.
{ if ( addThis.Type() == TiXmlNode::TINYXML_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 char * | value, |
const TiXmlNode * | previous | ||
) | const |
This flavor of IterateChildren searches for children with a particular 'value'.
Definition at line 395 of file tinyxml.cpp.
{ if ( !previous ) { return FirstChild( val ); } else { assert( previous->parent == this ); return previous->NextSibling( val ); } }
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 381 of file tinyxml.cpp.
{ if ( !previous ) { return FirstChild(); } else { assert( previous->parent == this ); return previous->NextSibling(); } }
const TiXmlNode* TiXmlNode::LastChild | ( | ) | const [inline] |
TiXmlNode* TiXmlNode::LastChild | ( | ) | [inline] |
const TiXmlNode * TiXmlNode::LastChild | ( | const char * | value | ) | const |
TiXmlNode* TiXmlNode::LastChild | ( | const char * | _value | ) | [inline] |
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.
Definition at line 186 of file tinyxml.cpp.
{ assert( node->parent == 0 || node->parent == this ); assert( node->GetDocument() == 0 || node->GetDocument() == this->GetDocument() ); if ( node->Type() == TiXmlNode::TINYXML_DOCUMENT ) { delete node; 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; }
TiXmlNode* TiXmlNode::NextSibling | ( | const char * | _next | ) | [inline] |
const TiXmlNode* TiXmlNode::NextSibling | ( | ) | const [inline] |
TiXmlNode* TiXmlNode::NextSibling | ( | ) | [inline] |
const TiXmlNode * TiXmlNode::NextSibling | ( | const char * | _value | ) | const |
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 478 of file tinyxml.cpp.
{ const TiXmlNode* node; for ( node = NextSibling(); node; node = node->NextSibling() ) { if ( node->ToElement() ) return node->ToElement(); } return 0; }
TiXmlElement* TiXmlNode::NextSiblingElement | ( | ) | [inline] |
Definition at line 645 of file tinyxml.h.
{ return const_cast< TiXmlElement* >( (const_cast< const TiXmlNode* >(this))->NextSiblingElement() ); }
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 493 of file tinyxml.cpp.
{ const TiXmlNode* node; for ( node = NextSibling( _value ); node; node = node->NextSibling( _value ) ) { if ( node->ToElement() ) return node->ToElement(); } return 0; }
TiXmlElement* TiXmlNode::NextSiblingElement | ( | const char * | _next | ) | [inline] |
Definition at line 654 of file tinyxml.h.
{ return const_cast< TiXmlElement* >( (const_cast< const TiXmlNode* >(this))->NextSiblingElement( _next ) ); }
bool TiXmlNode::NoChildren | ( | ) | const [inline] |
Returns true if this node has no children.
Definition at line 695 of file tinyxml.h.
{ return !firstChild; }
void TiXmlNode::operator= | ( | const TiXmlNode & | base | ) | [private] |
TiXmlNode* TiXmlNode::Parent | ( | ) | [inline] |
const TiXmlNode* TiXmlNode::Parent | ( | ) | const [inline] |
const TiXmlNode * TiXmlNode::PreviousSibling | ( | const char * | _value | ) | const |
TiXmlNode* TiXmlNode::PreviousSibling | ( | const char * | _prev | ) | [inline] |
const TiXmlNode* TiXmlNode::PreviousSibling | ( | ) | const [inline] |
TiXmlNode* TiXmlNode::PreviousSibling | ( | ) | [inline] |
bool TiXmlNode::RemoveChild | ( | TiXmlNode * | removeThis | ) |
Delete a child of this node.
Definition at line 331 of file tinyxml.cpp.
{ if ( !removeThis ) { return false; } if ( removeThis->parent != this ) { assert( 0 ); return false; } if ( removeThis->next ) removeThis->next->prev = removeThis->prev; else lastChild = removeThis->prev; if ( removeThis->prev ) removeThis->prev->next = removeThis->next; else firstChild = removeThis->next; delete removeThis; return true; }
Replace a child of this node. Returns a pointer to the new object or NULL if an error occured.
Definition at line 292 of file tinyxml.cpp.
{ if ( !replaceThis ) return 0; if ( replaceThis->parent != this ) return 0; if ( withThis.ToDocument() ) { // A document can never be a child. Thanks to Noam. TiXmlDocument* document = GetDocument(); if ( document ) document->SetError( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN ); 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] |
virtual TiXmlComment* TiXmlNode::ToComment | ( | ) | [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlComment.
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.
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 702 of file tinyxml.h.
virtual TiXmlDeclaration* TiXmlNode::ToDeclaration | ( | ) | [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlDeclaration.
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 697 of file tinyxml.h.
virtual TiXmlDocument* TiXmlNode::ToDocument | ( | ) | [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlDocument.
virtual TiXmlElement* TiXmlNode::ToElement | ( | ) | [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlElement.
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 698 of file tinyxml.h.
virtual TiXmlText* TiXmlNode::ToText | ( | ) | [inline, virtual] |
virtual const TiXmlText* TiXmlNode::ToText | ( | ) | const [inline, virtual] |
virtual TiXmlUnknown* TiXmlNode::ToUnknown | ( | ) | [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlUnknown.
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.
int TiXmlNode::Type | ( | ) | const [inline] |
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 487 of file tinyxml.h.
{ return value.c_str (); }
const TIXML_STRING& TiXmlNode::ValueTStr | ( | ) | const [inline] |
friend class TiXmlDocument [friend] |
friend class TiXmlElement [friend] |
TiXmlNode* TiXmlNode::firstChild [protected] |
TiXmlNode* TiXmlNode::lastChild [protected] |
TiXmlNode* TiXmlNode::next [protected] |
TiXmlNode* TiXmlNode::parent [protected] |
TiXmlNode* TiXmlNode::prev [protected] |
NodeType TiXmlNode::type [protected] |
TIXML_STRING TiXmlNode::value [protected] |