Nebula
|
#include <tinyxml.h>
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.
Inherits TiXmlBase.
Inherited by TiXmlComment, TiXmlDeclaration, TiXmlDocument, TiXmlElement, TiXmlText, and TiXmlUnknown.
Public Types | |
enum | NodeType { DOCUMENT , ELEMENT , COMMENT , UNKNOWN , TEXT , DECLARATION , TYPECOUNT } |
The types of XML nodes supported by TinyXml. More... | |
Public 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_PARSING_CDATA , TIXML_ERROR_STRING_COUNT } |
Public Member Functions | |
virtual | ~TiXmlNode () |
const char * | Value () const |
The meaning of 'value' changes for the specific type of TiXmlNode. | |
void | SetValue (const char *_value) |
Changes the value of the node. | |
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 |
The first child of this node with the matching 'value'. Will be null if none found. | |
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 |
An alternate way to walk the children of a node. | |
TiXmlNode * | IterateChildren (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, TiXmlNode *previous) |
TiXmlNode * | InsertEndChild (const TiXmlNode &addThis) |
Add a new node related to this. | |
TiXmlNode * | LinkEndChild (TiXmlNode *addThis) |
Add a new node related to this. | |
TiXmlNode * | InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis) |
Add a new node related to this. | |
TiXmlNode * | InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis) |
Add a new node related to this. | |
TiXmlNode * | ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis) |
Replace a child of this node. | |
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 *) |
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 *) |
const TiXmlElement * | NextSiblingElement () const |
Convenience function to get through elements. | |
TiXmlElement * | NextSiblingElement () |
const TiXmlElement * | NextSiblingElement (const char *) const |
Convenience function to get through elements. | |
TiXmlElement * | NextSiblingElement (const char *) |
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 |
Query the type (as an enumerated value, above) of this node. | |
const TiXmlDocument * | GetDocument () const |
Return a pointer to the Document this node lives in. | |
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 |
Create an exact duplicate of this node and return it. | |
Public Member Functions inherited from TiXmlBase | |
TiXmlBase () | |
virtual | ~TiXmlBase () |
virtual void | Print (const Ptr< IO::TextWriter > &textWriter, int depth) const =0 |
All TinyXml classes can print themselves to a filestream. | |
int | Row () const |
Return the position, in the original source file, of this node or attribute. | |
int | Column () const |
See Row() | |
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 |
TiXmlNode * | Identify (const char *start, TiXmlEncoding encoding) |
Protected Member Functions inherited from TiXmlBase | |
virtual void | StreamOut (TIXML_OSTREAM *) const =0 |
Protected Attributes | |
TiXmlNode * | parent |
NodeType | type |
TiXmlNode * | firstChild |
TiXmlNode * | lastChild |
TIXML_STRING | value |
TiXmlNode * | prev |
TiXmlNode * | next |
Protected Attributes inherited from TiXmlBase | |
TiXmlCursor | location |
void * | userData |
Field containing a generic user pointer. | |
Private Member Functions | |
TiXmlNode (const TiXmlNode &) | |
void | operator= (const TiXmlNode &base) |
Friends | |
class | TiXmlDocument |
class | TiXmlElement |
TIXML_OSTREAM & | operator<< (TIXML_OSTREAM &out, const TiXmlNode &base) |
Additional Inherited Members | |
Static Public Member Functions inherited from TiXmlBase | |
static void | SetCondenseWhiteSpace (bool condense) |
The world does not agree on whether white space should be kept or not. | |
static bool | IsWhiteSpaceCondensed () |
Return the current white space setting. | |
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 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 void | PutString (const TIXML_STRING &str, TIXML_OSTREAM *out) |
static void | PutString (const TIXML_STRING &str, TIXML_STRING *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] |
enum TiXmlNode::NodeType |
|
virtual |
|
protected |
|
private |
void TiXmlNode::Clear | ( | ) |
Delete all the children of this node. Does not affect 'this'.
|
pure virtual |
Create an exact duplicate of this node and return it.
The memory must be deleted by the caller.
Implemented in TiXmlComment, TiXmlDeclaration, TiXmlDocument, TiXmlElement, TiXmlText, and TiXmlUnknown.
|
protected |
|
inline |
|
inline |
The first child of this node. Will be null if there are no children.
TiXmlNode * TiXmlNode::FirstChild | ( | const char * | value | ) |
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.
TiXmlElement * TiXmlNode::FirstChildElement | ( | ) |
const TiXmlElement * TiXmlNode::FirstChildElement | ( | ) | const |
Convenience function to get through elements.
TiXmlElement * TiXmlNode::FirstChildElement | ( | const char * | value | ) |
const TiXmlElement * TiXmlNode::FirstChildElement | ( | const char * | value | ) | const |
Convenience function to get through elements.
TiXmlDocument * TiXmlNode::GetDocument | ( | ) |
const TiXmlDocument * TiXmlNode::GetDocument | ( | ) | const |
Return a pointer to the Document this node lives in.
Returns null if not in a document.
|
protected |
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.
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.
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.
const TiXmlNode * TiXmlNode::IterateChildren | ( | const char * | value, |
const TiXmlNode * | previous ) const |
This flavor of IterateChildren searches for children with a particular 'value'.
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.
|
inline |
The last child of this node. Will be null if there are no children.
|
inline |
TiXmlNode * TiXmlNode::LastChild | ( | const char * | value | ) |
The last child of this node matching 'value'. Will be null if there are no children.
const TiXmlNode * TiXmlNode::LastChild | ( | const char * | value | ) | const |
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.
|
inline |
|
inline |
Navigate to a sibling node.
TiXmlNode * TiXmlNode::NextSibling | ( | const char * | _value | ) |
const TiXmlNode * TiXmlNode::NextSibling | ( | const char * | _value | ) | const |
Navigate to a sibling node with the given 'value'.
TiXmlElement * TiXmlNode::NextSiblingElement | ( | ) |
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.
TiXmlElement * TiXmlNode::NextSiblingElement | ( | const char * | _value | ) |
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.
|
inline |
Returns true if this node has no children.
|
private |
|
inline |
One step up the DOM.
|
inline |
|
inline |
|
inline |
Navigate to a sibling node.
TiXmlNode * TiXmlNode::PreviousSibling | ( | const char * | _value | ) |
const TiXmlNode * TiXmlNode::PreviousSibling | ( | const char * | _value | ) | const |
Navigate to a sibling node.
bool TiXmlNode::RemoveChild | ( | TiXmlNode * | removeThis | ) |
Delete a child of this node.
Replace a child of this node.
Returns a pointer to the new object or NULL if an error occured.
|
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
|
inlinevirtual |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlComment.
|
inlinevirtual |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlComment.
|
inlinevirtual |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlDeclaration.
|
inlinevirtual |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlDeclaration.
|
inlinevirtual |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlDocument.
|
inlinevirtual |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlDocument.
|
inlinevirtual |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlElement.
|
inlinevirtual |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlElement.
|
inlinevirtual |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlText.
|
inlinevirtual |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlText.
|
inlinevirtual |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlUnknown.
|
inlinevirtual |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlUnknown.
|
inline |
Query the type (as an enumerated value, above) of this node.
The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.
|
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.
|
friend |
|
friend |
|
friend |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |