#include <src/tinyxml/tinyxml.h>
Public Types | |
enum | NodeType { DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, DECLARATION, STYLESHEETREFERENCE, TYPECOUNT } |
Public Member Functions | |
virtual bool | Accept (TiXmlVisitor *visitor) const =0 |
void | Clear () |
Delete all the children of this node. Does not affect 'this'. | |
virtual TiXmlNode * | Clone () const =0 |
TiXmlNode * | FirstChild (const char *_value) |
The first child of this node with the matching 'value'. Will be null if none found. | |
const TiXmlNode * | FirstChild (const char *value) const |
TiXmlNode * | FirstChild () |
const TiXmlNode * | FirstChild () const |
The first child of this node. Will be null if there are no children. | |
TiXmlElement * | FirstChildElement (const char *_value) |
const TiXmlElement * | FirstChildElement (const char *_value) const |
Convenience function to get through elements. | |
TiXmlElement * | FirstChildElement () |
const TiXmlElement * | FirstChildElement () const |
Convenience function to get through elements. | |
TiXmlDocument * | GetDocument () |
const TiXmlDocument * | GetDocument () const |
TiXmlNode * | InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis) |
TiXmlNode * | InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis) |
TiXmlNode * | InsertEndChild (const TiXmlNode &addThis) |
TiXmlNode * | IterateChildren (const char *_value, 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 TiXmlNode *previous) |
const TiXmlNode * | IterateChildren (const TiXmlNode *previous) const |
TiXmlNode * | LastChild (const char *_value) |
The last child of this node matching 'value'. Will be null if there are no children. | |
const TiXmlNode * | LastChild (const char *value) const |
TiXmlNode * | LastChild () |
The last child of this node. Will be null if there are no children. | |
const TiXmlNode * | LastChild () const |
TiXmlNode * | LinkEndChild (TiXmlNode *addThis) |
TiXmlNode * | NextSibling (const char *_next) |
const TiXmlNode * | NextSibling (const char *) const |
Navigate to a sibling node with the given 'value'. | |
TiXmlNode * | NextSibling () |
const TiXmlNode * | NextSibling () const |
Navigate to a sibling node. | |
TiXmlElement * | NextSiblingElement (const char *_next) |
const TiXmlElement * | NextSiblingElement (const char *) const |
TiXmlElement * | NextSiblingElement () |
const TiXmlElement * | NextSiblingElement () const |
bool | NoChildren () const |
Returns true if this node has no children. | |
const TiXmlNode * | Parent () const |
TiXmlNode * | Parent () |
One step up the DOM. | |
TiXmlNode * | PreviousSibling (const char *_prev) |
const TiXmlNode * | PreviousSibling (const char *) const |
Navigate to a sibling node. | |
TiXmlNode * | PreviousSibling () |
const TiXmlNode * | PreviousSibling () const |
Navigate to a sibling node. | |
bool | RemoveChild (TiXmlNode *removeThis) |
Delete a child of this node. | |
TiXmlNode * | ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis) |
void | SetValue (const char *_value) |
virtual TiXmlComment * | ToComment () |
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 TiXmlDeclaration * | ToDeclaration () |
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 const TiXmlDocument * | ToDocument () const |
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 const TiXmlElement * | ToElement () const |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlStylesheetReference * | ToStylesheetReference () |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual const TiXmlStylesheetReference * | ToStylesheetReference () const |
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 const TiXmlText * | ToText () const |
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 const TiXmlUnknown * | ToUnknown () const |
Cast to a more defined type. Will return null if not of the requested type. | |
int | Type () const |
const char * | Value () const |
const TIXML_STRING & | ValueTStr () const |
virtual | ~TiXmlNode () |
Protected Member Functions | |
void | CopyTo (TiXmlNode *target) const |
TiXmlNode * | Identify (const char *start, TiXmlEncoding encoding) |
TiXmlNode (NodeType _type) | |
Protected Attributes | |
TiXmlNode * | firstChild |
TiXmlNode * | lastChild |
TiXmlNode * | next |
TiXmlNode * | parent |
TiXmlNode * | prev |
NodeType | type |
TIXML_STRING | value |
Private Member Functions | |
void | operator= (const TiXmlNode &base) |
TiXmlNode (const TiXmlNode &) | |
Friends | |
class | TiXmlDocument |
class | TiXmlElement |
enum TiXmlNode::NodeType |
TiXmlNode::~TiXmlNode | ( | ) | [virtual] |
References firstChild, and next.
TiXmlNode::TiXmlNode | ( | NodeType | _type | ) | [protected] |
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, TiXmlStylesheetReference, TiXmlUnknown, and TiXmlDocument.
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(), TiXmlStylesheetReference::operator=(), TiXmlDeclaration::operator=(), TiXmlComment::operator=(), and TiXmlDocument::operator=().
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, TiXmlStylesheetReference, TiXmlUnknown, and TiXmlDocument.
Referenced by TiXmlDocument::CopyTo(), TiXmlElement::CopyTo(), InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), and ReplaceChild().
void TiXmlNode::CopyTo | ( | TiXmlNode * | target | ) | const [protected] |
References SetValue(), TiXmlBase::userData, and value.
Referenced by TiXmlUnknown::CopyTo(), TiXmlStylesheetReference::CopyTo(), TiXmlDeclaration::CopyTo(), TiXmlText::CopyTo(), TiXmlComment::CopyTo(), TiXmlDocument::CopyTo(), and TiXmlElement::CopyTo().
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 char * | value | ) | const |
The first child of this node with the matching 'value'. Will be null if none found.
References firstChild, next, and Value().
TiXmlNode* TiXmlNode::FirstChild | ( | ) | [inline] |
References firstChild.
const TiXmlNode* TiXmlNode::FirstChild | ( | ) | const [inline] |
The first child of this node. Will be null if there are no children.
References firstChild.
Referenced by TiXmlDocument::Accept(), TiXmlElement::Accept(), FirstChildElement(), TiXmlElement::GetText(), IterateChildren(), TiXmlDocument::Print(), TiXmlPrinter::VisitEnter(), and TiXmlPrinter::VisitExit().
TiXmlElement* TiXmlNode::FirstChildElement | ( | const char * | _value | ) | [inline] |
const TiXmlElement * TiXmlNode::FirstChildElement | ( | const char * | _value | ) | const |
Convenience function to get through elements.
References FirstChild(), NextSibling(), and ToElement().
TiXmlElement* TiXmlNode::FirstChildElement | ( | ) | [inline] |
const TiXmlElement * TiXmlNode::FirstChildElement | ( | ) | const |
Convenience function to get through elements.
References FirstChild(), NextSibling(), and ToElement().
Referenced by TiXmlDocument::RootElement().
TiXmlDocument* TiXmlNode::GetDocument | ( | ) | [inline] |
const 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(), InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), LinkEndChild(), TiXmlStylesheetReference::Parse(), TiXmlDeclaration::Parse(), TiXmlText::Parse(), TiXmlComment::Parse(), TiXmlUnknown::Parse(), TiXmlElement::Parse(), TiXmlElement::ReadValue(), and TiXmlElement::SetAttribute().
TiXmlNode * TiXmlNode::Identify | ( | const char * | start, | |
TiXmlEncoding | encoding | |||
) | [protected] |
References GetDocument(), TiXmlBase::IsAlpha(), parent, TiXmlText::SetCDATA(), TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlBase::StringEqual(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_OUT_OF_MEMORY, and TiXmlElement.
Referenced by TiXmlDocument::Parse(), and TiXmlElement::ReadValue().
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(), DOCUMENT, GetDocument(), lastChild, next, parent, prev, TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_TOP_ONLY, and Type().
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(), DOCUMENT, firstChild, GetDocument(), next, parent, prev, TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_TOP_ONLY, and Type().
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(), DOCUMENT, GetDocument(), LinkEndChild(), TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_TOP_ONLY, and Type().
const TiXmlNode * TiXmlNode::IterateChildren | ( | const char * | value, | |
const TiXmlNode * | previous | |||
) | const |
This flavor of IterateChildren searches for children with a particular 'value'.
References FirstChild(), NextSibling(), and parent.
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.
TiXmlNode* TiXmlNode::LastChild | ( | const char * | _value | ) | [inline] |
The last child of this node matching 'value'. Will be null if there are no children.
const TiXmlNode * TiXmlNode::LastChild | ( | const char * | value | ) | const |
TiXmlNode* TiXmlNode::LastChild | ( | ) | [inline] |
const TiXmlNode* TiXmlNode::LastChild | ( | ) | const [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.
References DOCUMENT, firstChild, GetDocument(), lastChild, next, parent, prev, TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_TOP_ONLY, and Type().
Referenced by TiXmlDocument::CopyTo(), TiXmlElement::CopyTo(), InsertEndChild(), TiXmlDocument::Parse(), and TiXmlElement::ReadValue().
TiXmlNode* TiXmlNode::NextSibling | ( | const char * | _next | ) | [inline] |
const TiXmlNode * TiXmlNode::NextSibling | ( | const char * | _value | ) | const |
const TiXmlNode* TiXmlNode::NextSibling | ( | ) | const [inline] |
Navigate to a sibling node.
References next.
Referenced by TiXmlHandle::Child(), TiXmlDocument::CopyTo(), TiXmlElement::CopyTo(), FirstChildElement(), IterateChildren(), NextSiblingElement(), and TiXmlElement::Print().
TiXmlElement* TiXmlNode::NextSiblingElement | ( | const char * | _next | ) | [inline] |
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.
References NextSibling(), and ToElement().
TiXmlElement* TiXmlNode::NextSiblingElement | ( | ) | [inline] |
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.
References NextSibling(), and ToElement().
Referenced by TiXmlHandle::ChildElement().
bool TiXmlNode::NoChildren | ( | ) | const [inline] |
void TiXmlNode::operator= | ( | const TiXmlNode & | base | ) | [private] |
TiXmlNode* TiXmlNode::PreviousSibling | ( | const char * | _prev | ) | [inline] |
const TiXmlNode * TiXmlNode::PreviousSibling | ( | const char * | _value | ) | const |
const TiXmlNode* TiXmlNode::PreviousSibling | ( | ) | const [inline] |
bool TiXmlNode::RemoveChild | ( | TiXmlNode * | removeThis | ) |
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 value.
Referenced by CopyTo(), TiXmlComment::TiXmlComment(), and TiXmlText::TiXmlText().
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 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 TiXmlDeclaration* TiXmlNode::ToDeclaration | ( | ) | const [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlDeclaration.
Referenced by TiXmlDocument::Parse().
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 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.
Referenced by GetDocument().
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.
Referenced by FirstChildElement(), and NextSiblingElement().
virtual TiXmlStylesheetReference* TiXmlNode::ToStylesheetReference | ( | ) | [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlStylesheetReference.
virtual const TiXmlStylesheetReference* TiXmlNode::ToStylesheetReference | ( | ) | const [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlStylesheetReference.
virtual TiXmlText* TiXmlNode::ToText | ( | ) | [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlText.
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.
Referenced by TiXmlElement::GetText(), TiXmlElement::Print(), and TiXmlPrinter::VisitEnter().
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] |
Query the type (as an enumerated value, above) of this node. The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.
Reimplemented in TiXmlStylesheetReference.
References type.
Referenced by InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), and LinkEndChild().
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 value.
Referenced by TiXmlElement::Clone(), FirstChild(), TiXmlElement::GetText(), LastChild(), TiXmlDocument::LoadFile(), NextSibling(), PreviousSibling(), TiXmlDocument::SaveFile(), TiXmlPrinter::Visit(), TiXmlPrinter::VisitEnter(), and TiXmlPrinter::VisitExit().
const TIXML_STRING& TiXmlNode::ValueTStr | ( | ) | const [inline] |
friend class TiXmlDocument [friend] |
Reimplemented from TiXmlBase.
friend class TiXmlElement [friend] |
TiXmlNode* TiXmlNode::firstChild [protected] |
TiXmlNode* TiXmlNode::lastChild [protected] |
Referenced by Clear(), InsertAfterChild(), LastChild(), LinkEndChild(), TiXmlElement::Print(), RemoveChild(), ReplaceChild(), TiXmlElement::TiXmlElement(), and TiXmlNode().
TiXmlNode* TiXmlNode::next [protected] |
Referenced by Clear(), FirstChild(), InsertAfterChild(), InsertBeforeChild(), LinkEndChild(), NextSibling(), RemoveChild(), ReplaceChild(), TiXmlNode(), and ~TiXmlNode().
TiXmlNode* TiXmlNode::parent [protected] |
Referenced by GetDocument(), Identify(), InsertAfterChild(), InsertBeforeChild(), IterateChildren(), LinkEndChild(), Parent(), RemoveChild(), ReplaceChild(), and TiXmlNode().
TiXmlNode* TiXmlNode::prev [protected] |
Referenced by InsertAfterChild(), InsertBeforeChild(), LastChild(), LinkEndChild(), PreviousSibling(), RemoveChild(), ReplaceChild(), and TiXmlNode().
NodeType TiXmlNode::type [protected] |
TIXML_STRING TiXmlNode::value [protected] |
Referenced by TiXmlText::Blank(), CopyTo(), TiXmlDocument::LoadFile(), TiXmlText::Parse(), TiXmlComment::Parse(), TiXmlUnknown::Parse(), TiXmlElement::Parse(), TiXmlUnknown::Print(), TiXmlText::Print(), TiXmlComment::Print(), TiXmlElement::Print(), SetValue(), TiXmlDocument::TiXmlDocument(), TiXmlElement::TiXmlElement(), Value(), and ValueTStr().