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

#include <rtt/marsh/tinyxml.h>

Inheritance diagram for RTT::marsh::TiXmlNode:

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

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

void	SetValue (const char *_value)
	Changes the value of the node. More...

void	Clear ()
	Delete all the children of this node. Does not affect 'this'. More...

TiXmlNode *	Parent ()
	One step up the DOM. More...

const TiXmlNode *	Parent () const

const TiXmlNode *	FirstChild () const
	The first child of this node. Will be null if there are no children. More...

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

TiXmlNode *	FirstChild (const char *value)
	The first child of this node with the matching 'value'. Will be null if none found. More...

const TiXmlNode *	LastChild () const

TiXmlNode *	LastChild ()
	The last child of this node. Will be null if there are no children. More...

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

const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const
	An alternate way to walk the children of a node. More...

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'. More...

TiXmlNode *	IterateChildren (const char value, TiXmlNode previous)

TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)
	Add a new node related to this. More...

TiXmlNode *	LinkEndChild (TiXmlNode *addThis)
	Add a new node related to this. More...

TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
	Add a new node related to this. More...

TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
	Add a new node related to this. More...

TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
	Replace a child of this node. More...

bool	RemoveChild (TiXmlNode *removeThis)
	Delete a child of this node. More...

const TiXmlNode *	PreviousSibling () const
	Navigate to a sibling node. More...

TiXmlNode *	PreviousSibling ()

const TiXmlNode *	PreviousSibling (const char *) const
	Navigate to a sibling node. More...

TiXmlNode *	PreviousSibling (const char *)

const TiXmlNode *	NextSibling () const
	Navigate to a sibling node. More...

TiXmlNode *	NextSibling ()

const TiXmlNode *	NextSibling (const char *) const
	Navigate to a sibling node with the given 'value'. More...

TiXmlNode *	NextSibling (const char *)

const TiXmlElement *	NextSiblingElement () const
	Convenience function to get through elements. More...

TiXmlElement *	NextSiblingElement ()

const TiXmlElement *	NextSiblingElement (const char *) const
	Convenience function to get through elements. More...

TiXmlElement *	NextSiblingElement (const char *)

const TiXmlElement *	FirstChildElement () const
	Convenience function to get through elements. More...

TiXmlElement *	FirstChildElement ()

const TiXmlElement *	FirstChildElement (const char *value) const
	Convenience function to get through elements. More...

TiXmlElement *	FirstChildElement (const char *value)

int	Type () const
	Query the type (as an enumerated value, above) of this node. More...

const TiXmlDocument *	GetDocument () const
	Return a pointer to the Document this node lives in. More...

TiXmlDocument *	GetDocument ()

bool	NoChildren () const
	Returns true if this node has no children. More...

virtual const TiXmlDocument *	ToDocument () const
	Cast to a more defined type. Will return null if not of the requested type. More...

virtual const TiXmlElement *	ToElement () const
	Cast to a more defined type. Will return null if not of the requested type. More...

virtual const TiXmlComment *	ToComment () const
	Cast to a more defined type. Will return null if not of the requested type. More...

virtual const TiXmlUnknown *	ToUnknown () const
	Cast to a more defined type. Will return null if not of the requested type. More...

virtual const TiXmlText *	ToText () const
	Cast to a more defined type. Will return null if not of the requested type. More...

virtual const TiXmlDeclaration *	ToDeclaration () const
	Cast to a more defined type. Will return null if not of the requested type. More...

virtual TiXmlDocument *	ToDocument ()
	Cast to a more defined type. Will return null if not of the requested type. More...

virtual TiXmlElement *	ToElement ()
	Cast to a more defined type. Will return null if not of the requested type. More...

virtual TiXmlComment *	ToComment ()
	Cast to a more defined type. Will return null if not of the requested type. More...

virtual TiXmlUnknown *	ToUnknown ()
	Cast to a more defined type. Will return null if not of the requested type. More...

virtual TiXmlText *	ToText ()
	Cast to a more defined type. Will return null if not of the requested type. More...

virtual TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null if not of the requested type. More...

virtual TiXmlNode *	Clone () const =0
	Create an exact duplicate of this node and return it. More...

virtual void	Print (FILE *cfile, int depth) const =0
	All TinyXml classes can print themselves to a filestream. More...

int	Row () const
	Return the position, in the original source file, of this node or attribute. More...

int	Column () const
	See Row() More...

void	SetUserData (void *user)

void *	GetUserData ()

virtual const char *	Parse (const char p, TiXmlParsingData data, TiXmlEncoding encoding)=0

Static Public Member Functions
static void	SetCondenseWhiteSpace (bool condense)
	The world does not agree on whether white space should be kept or not. More...

static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting. More...

Static Public Attributes
static const int	utf8ByteTable [256]

Protected Member Functions
	TiXmlNode (NodeType _type)

void	CopyTo (TiXmlNode *target) const

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

virtual void	StreamOut (TIXML_OSTREAM *) const =0

Static Protected Member Functions
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)

Protected Attributes
TiXmlNode *	parent

NodeType	type

TiXmlNode *	firstChild

TiXmlNode *	lastChild

TIXML_STRING	value

TiXmlNode *	prev

TiXmlNode *	next

TiXmlCursor	location

void *	userData
	Field containing a generic user pointer. More...

Static Protected Attributes
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

Friends
class	TiXmlDocument

class	TiXmlElement

TIXML_OSTREAM &	operator<< (TIXML_OSTREAM &out, const TiXmlNode &base)

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

Member Enumeration Documentation

anonymous enum

inherited

Enumerator
TIXML_NO_ERROR
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

Definition at line 249 of file tinyxml.h.

enum RTT::marsh::TiXmlNode::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

Definition at line 467 of file tinyxml.h.

Constructor & Destructor Documentation

RTT::marsh::TiXmlNode::~TiXmlNode ( )

virtual

Definition at line 195 of file tinyxml.cpp.

References firstChild, and next.

RTT::marsh::TiXmlNode::TiXmlNode ( NodeType _type )

protected

Definition at line 184 of file tinyxml.cpp.

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

Referenced by RTT::marsh::TiXmlDeclaration::TiXmlDeclaration(), RTT::marsh::TiXmlDocument::TiXmlDocument(), and RTT::marsh::TiXmlElement::TiXmlElement().

Member Function Documentation

void RTT::marsh::TiXmlNode::Clear ( )

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

Definition at line 216 of file tinyxml.cpp.

References firstChild, lastChild, and next.

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

virtual TiXmlNode* RTT::marsh::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 RTT::marsh::TiXmlDocument, RTT::marsh::TiXmlUnknown, RTT::marsh::TiXmlDeclaration, RTT::marsh::TiXmlText, RTT::marsh::TiXmlComment, and RTT::marsh::TiXmlElement.

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

int RTT::marsh::TiXmlBase::Column ( ) const

inlineinherited

See Row()

Definition at line 236 of file tinyxml.h.

void RTT::marsh::TiXmlBase::ConvertUTF32ToUTF8	(	unsigned long	input,
		char *	output,
		int *	length
	)

staticprotectedinherited

Definition at line 127 of file tinyxmlparser.cpp.

Referenced by RTT::marsh::TiXmlBase::GetEntity().

void RTT::marsh::TiXmlNode::CopyTo ( TiXmlNode * target ) const

protected

Definition at line 209 of file tinyxml.cpp.

References SetValue(), RTT::marsh::TiXmlBase::userData, and value.

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

const TiXmlNode* RTT::marsh::TiXmlNode::FirstChild ( ) const

inline

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

Definition at line 525 of file tinyxml.h.

Referenced by RTT::marsh::TiXmlHandle::Child(), RTT::marsh::TiXmlHandle::FirstChild(), FirstChildElement(), RTT::marsh::TiXmlElement::GetText(), IterateChildren(), RTT::marsh::Tiny2CPFHandler::populateBag(), RTT::marsh::TiXmlDocument::Print(), and RTT::marsh::TiXmlDocument::StreamOut().

TiXmlNode* RTT::marsh::TiXmlNode::FirstChild ( )

inline

Definition at line 526 of file tinyxml.h.

const TiXmlNode * RTT::marsh::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 365 of file tinyxml.cpp.

References firstChild, next, and Value().

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

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

Definition at line 377 of file tinyxml.cpp.

References firstChild, next, and Value().

const TiXmlElement * RTT::marsh::TiXmlNode::FirstChildElement ( ) const

Convenience function to get through elements.

Definition at line 518 of file tinyxml.cpp.

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

Referenced by RTT::marsh::TiXmlHandle::ChildElement(), and RTT::marsh::TiXmlHandle::FirstChildElement().

TiXmlElement * RTT::marsh::TiXmlNode::FirstChildElement ( )

Definition at line 532 of file tinyxml.cpp.

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

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

Convenience function to get through elements.

Definition at line 546 of file tinyxml.cpp.

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

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

Definition at line 560 of file tinyxml.cpp.

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

static const char* RTT::marsh::TiXmlBase::GetChar	(	const char *	p,
		char *	_value,
		int *	length,
		TiXmlEncoding	encoding
	)

inlinestaticprotectedinherited

Definition at line 323 of file tinyxml.h.

References RTT::marsh::TIXML_ENCODING_UTF8, TIXML_OSTREAM, and TIXML_STRING.

Referenced by RTT::marsh::TiXmlBase::ReadText().

const TiXmlDocument * RTT::marsh::TiXmlNode::GetDocument ( ) const

Return a pointer to the Document this node lives in.

Returns null if not in a document.

Definition at line 631 of file tinyxml.cpp.

References parent, and ToDocument().

Referenced by LinkEndChild(), and RTT::marsh::TiXmlElement::SetAttribute().

TiXmlDocument * RTT::marsh::TiXmlNode::GetDocument ( )

Definition at line 643 of file tinyxml.cpp.

References parent, and ToDocument().

const char * RTT::marsh::TiXmlBase::GetEntity	(	const char *	in,
		char *	value,
		int *	length,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

Definition at line 467 of file tinyxmlparser.cpp.

References RTT::marsh::TiXmlBase::ConvertUTF32ToUTF8(), RTT::marsh::TIXML_ENCODING_UTF8, and TIXML_STRING.

void* RTT::marsh::TiXmlBase::GetUserData ( )

inlineinherited

Definition at line 239 of file tinyxml.h.

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

protected

Definition at line 843 of file tinyxmlparser.cpp.

References RTT::marsh::TiXmlBase::IsAlpha(), RTT::marsh::TiXmlBase::IsWhiteSpace(), parent, RTT::marsh::TiXmlText::SetCDATA(), RTT::marsh::TiXmlDocument::SetError(), RTT::marsh::TiXmlBase::SkipWhiteSpace(), RTT::marsh::TiXmlBase::StringEqual(), RTT::marsh::TIXML_DEFAULT_ENCODING, RTT::marsh::TIXML_ENCODING_UNKNOWN, RTT::marsh::TiXmlBase::TIXML_ERROR_EMBEDDED_NULL, RTT::marsh::TiXmlBase::TIXML_ERROR_OUT_OF_MEMORY, TIXML_STRING, and RTT::marsh::TiXmlBase::TiXmlElement.

TiXmlNode * RTT::marsh::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 289 of file tinyxml.cpp.

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

TiXmlNode * RTT::marsh::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 263 of file tinyxml.cpp.

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

TiXmlNode * RTT::marsh::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 253 of file tinyxml.cpp.

References Clone(), and LinkEndChild().

int RTT::marsh::TiXmlBase::IsAlpha	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

Definition at line 168 of file tinyxmlparser.cpp.

Referenced by Identify(), and RTT::marsh::TiXmlBase::ReadName().

int RTT::marsh::TiXmlBase::IsAlphaNum	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

Definition at line 189 of file tinyxmlparser.cpp.

Referenced by RTT::marsh::TiXmlBase::ReadName().

static bool RTT::marsh::TiXmlBase::IsWhiteSpace ( char c )

inlinestaticprotectedinherited

Definition at line 284 of file tinyxml.h.

Referenced by RTT::marsh::TiXmlText::Blank(), Identify(), RTT::marsh::TiXmlAttribute::Parse(), RTT::marsh::TiXmlDeclaration::Parse(), RTT::marsh::TiXmlBase::ReadText(), and RTT::marsh::TiXmlBase::SkipWhiteSpace().

static bool RTT::marsh::TiXmlBase::IsWhiteSpace ( int c )

inlinestaticprotectedinherited

Definition at line 288 of file tinyxml.h.

References TIXML_OSTREAM, and TIXML_STRING.

static bool RTT::marsh::TiXmlBase::IsWhiteSpaceCondensed ( )

inlinestaticinherited

Return the current white space setting.

Definition at line 215 of file tinyxml.h.

Referenced by RTT::marsh::TiXmlElement::ReadValue().

const TiXmlNode * RTT::marsh::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 411 of file tinyxml.cpp.

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

TiXmlNode * RTT::marsh::TiXmlNode::IterateChildren ( TiXmlNode * previous )

Definition at line 424 of file tinyxml.cpp.

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

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

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

Definition at line 437 of file tinyxml.cpp.

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

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

Definition at line 450 of file tinyxml.cpp.

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

const TiXmlNode* RTT::marsh::TiXmlNode::LastChild ( ) const

inline

Definition at line 530 of file tinyxml.h.

TiXmlNode* RTT::marsh::TiXmlNode::LastChild ( )

inline

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

Definition at line 531 of file tinyxml.h.

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

Definition at line 389 of file tinyxml.cpp.

References lastChild, prev, and Value().

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

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

Definition at line 400 of file tinyxml.cpp.

References lastChild, prev, and Value().

TiXmlNode * RTT::marsh::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 233 of file tinyxml.cpp.

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

Referenced by RTT::marsh::TiXmlElement::CopyTo(), InsertEndChild(), and RTT::marsh::TiXmlDocument::SaveFile().

const TiXmlNode* RTT::marsh::TiXmlNode::NextSibling ( ) const

inline

Navigate to a sibling node.

Definition at line 621 of file tinyxml.h.

Referenced by RTT::marsh::TiXmlHandle::Child(), RTT::marsh::TiXmlElement::CopyTo(), FirstChildElement(), IterateChildren(), NextSiblingElement(), RTT::marsh::Tiny2CPFHandler::populateBag(), RTT::marsh::TiXmlElement::Print(), RTT::marsh::TiXmlDocument::Print(), RTT::marsh::TiXmlDocument::SaveFile(), RTT::marsh::TiXmlElement::StreamOut(), and RTT::marsh::TiXmlDocument::StreamOut().

TiXmlNode* RTT::marsh::TiXmlNode::NextSibling ( )

inline

Definition at line 622 of file tinyxml.h.

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

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

Definition at line 463 of file tinyxml.cpp.

References next, and Value().

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

Definition at line 474 of file tinyxml.cpp.

References next, and Value().

const TiXmlElement * RTT::marsh::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 574 of file tinyxml.cpp.

References NextSibling(), and ToElement().

Referenced by RTT::marsh::TiXmlHandle::ChildElement().

TiXmlElement * RTT::marsh::TiXmlNode::NextSiblingElement ( )

Definition at line 588 of file tinyxml.cpp.

References NextSibling(), and ToElement().

const TiXmlElement * RTT::marsh::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 602 of file tinyxml.cpp.

References NextSibling(), and ToElement().

TiXmlElement * RTT::marsh::TiXmlNode::NextSiblingElement ( const char * _value )

Definition at line 616 of file tinyxml.cpp.

References NextSibling(), and ToElement().

bool RTT::marsh::TiXmlNode::NoChildren ( ) const

inline

Returns true if this node has no children.

Definition at line 673 of file tinyxml.h.

TiXmlNode* RTT::marsh::TiXmlNode::Parent ( )

inline

One step up the DOM.

Definition at line 522 of file tinyxml.h.

const TiXmlNode* RTT::marsh::TiXmlNode::Parent ( ) const

inline

Definition at line 523 of file tinyxml.h.

virtual const char* RTT::marsh::TiXmlBase::Parse	(	const char *	p,
		TiXmlParsingData *	data,
		TiXmlEncoding	encoding
	)

pure virtualinherited

Implemented in RTT::marsh::TiXmlDocument, RTT::marsh::TiXmlUnknown, RTT::marsh::TiXmlDeclaration, RTT::marsh::TiXmlText, RTT::marsh::TiXmlComment, RTT::marsh::TiXmlElement, and RTT::marsh::TiXmlAttribute.

Referenced by RTT::marsh::TiXmlAttributeSet::Find(), RTT::marsh::TiXmlDocument::Parse(), and RTT::marsh::TiXmlElement::ReadValue().

const TiXmlNode* RTT::marsh::TiXmlNode::PreviousSibling ( ) const

inline

Navigate to a sibling node.

Definition at line 606 of file tinyxml.h.

TiXmlNode* RTT::marsh::TiXmlNode::PreviousSibling ( )

inline

Definition at line 607 of file tinyxml.h.

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

Navigate to a sibling node.

Definition at line 485 of file tinyxml.cpp.

References prev, and Value().

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

Definition at line 496 of file tinyxml.cpp.

References prev, and Value().

virtual void RTT::marsh::TiXmlBase::Print	(	FILE *	cfile,
		int	depth
	)		const

pure virtualinherited

All TinyXml classes can print themselves to a filestream.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implemented in RTT::marsh::TiXmlDocument, RTT::marsh::TiXmlUnknown, RTT::marsh::TiXmlDeclaration, RTT::marsh::TiXmlText, RTT::marsh::TiXmlComment, RTT::marsh::TiXmlElement, and RTT::marsh::TiXmlAttribute.

Referenced by RTT::marsh::TiXmlElement::Print(), and RTT::marsh::TiXmlDocument::Print().

void RTT::marsh::TiXmlBase::PutString	(	const TIXML_STRING &	str,
		TIXML_OSTREAM *	out
	)

staticprotectedinherited

Definition at line 75 of file tinyxml.cpp.

References TIXML_STRING.

Referenced by RTT::marsh::TiXmlAttribute::Print(), RTT::marsh::TiXmlText::Print(), RTT::marsh::TiXmlAttribute::StreamOut(), RTT::marsh::TiXmlText::StreamOut(), and RTT::marsh::TiXmlDeclaration::StreamOut().

void RTT::marsh::TiXmlBase::PutString	(	const TIXML_STRING &	str,
		TIXML_STRING *	out
	)

staticprotectedinherited

Definition at line 82 of file tinyxml.cpp.

const char * RTT::marsh::TiXmlBase::ReadName	(	const char *	p,
		TIXML_STRING *	name,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

Definition at line 437 of file tinyxmlparser.cpp.

References RTT::marsh::TiXmlBase::IsAlpha(), and RTT::marsh::TiXmlBase::IsAlphaNum().

Referenced by RTT::marsh::TiXmlAttribute::Parse(), and RTT::marsh::TiXmlElement::Parse().

const char * RTT::marsh::TiXmlBase::ReadText	(	const char *	in,
		TIXML_STRING *	text,
		bool	ignoreWhiteSpace,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

Definition at line 601 of file tinyxmlparser.cpp.

References RTT::marsh::TiXmlBase::GetChar(), RTT::marsh::TiXmlBase::IsWhiteSpace(), RTT::marsh::TiXmlBase::SkipWhiteSpace(), RTT::marsh::TiXmlBase::StringEqual(), RTT::marsh::TIXML_DEFAULT_ENCODING, RTT::marsh::TIXML_ENCODING_UNKNOWN, RTT::marsh::TiXmlBase::TIXML_ERROR, RTT::marsh::TiXmlBase::TIXML_ERROR_EMBEDDED_NULL, RTT::marsh::TiXmlBase::TIXML_ERROR_PARSING_EMPTY, TIXML_STRING, and ToElement().

Referenced by RTT::marsh::TiXmlAttribute::Parse(), RTT::marsh::TiXmlComment::Parse(), and RTT::marsh::TiXmlText::Parse().

bool RTT::marsh::TiXmlNode::RemoveChild ( TiXmlNode * removeThis )

Delete a child of this node.

Definition at line 343 of file tinyxml.cpp.

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

TiXmlNode * RTT::marsh::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 315 of file tinyxml.cpp.

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

int RTT::marsh::TiXmlBase::Row ( ) const

inlineinherited

Return the position, in the original source file, of this node or attribute.

The row and column are 1-based. (That is the first row and first column is 1,1). If the returns values are 0 or less, then the parser does not have a row and column value.

Generally, the row and column value will be set when the TiXmlDocument::Load(), TiXmlDocument::LoadFile(), or any TiXmlNode::Parse() is called. It will NOT be set when the DOM was created from operator>>.

The values reflect the initial load. Once the DOM is modified programmatically (by adding or changing nodes and attributes) the new values will NOT update to reflect changes in the document.

There is a minor performance cost to computing the row and column. Computation can be disabled if TiXmlDocument::SetTabSize() is called with 0 as the value.

See also: TiXmlDocument::SetTabSize()

Definition at line 235 of file tinyxml.h.

Referenced by RTT::marsh::Tiny2CPFHandler::populateBag().

static void RTT::marsh::TiXmlBase::SetCondenseWhiteSpace ( bool condense )

inlinestaticinherited

The world does not agree on whether white space should be kept or not.

In order to make everyone happy, these global, static functions are provided to set whether or not TinyXml will condense all white space into a single space or not. The default is to condense. Note changing this values is not thread safe.

Definition at line 212 of file tinyxml.h.

void RTT::marsh::TiXmlBase::SetUserData ( void * user )

inlineinherited

Definition at line 238 of file tinyxml.h.

void RTT::marsh::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 511 of file tinyxml.h.

References RTT::marsh::TiXmlCursor::Clear().

Referenced by CopyTo(), RTT::marsh::TiXmlAttribute::SetDoubleValue(), and RTT::marsh::TiXmlAttribute::SetIntValue().

const char * RTT::marsh::TiXmlBase::SkipWhiteSpace	(	const char *	p,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

Definition at line 353 of file tinyxmlparser.cpp.

References RTT::marsh::TiXmlBase::IsWhiteSpace(), RTT::marsh::TIXML_ENCODING_UTF8, TIXML_STRING, and RTT::marsh::TIXML_UTF_LEAD_2.

Referenced by Identify(), RTT::marsh::TiXmlAttribute::Parse(), RTT::marsh::TiXmlElement::Parse(), RTT::marsh::TiXmlComment::Parse(), RTT::marsh::TiXmlDeclaration::Parse(), RTT::marsh::TiXmlUnknown::Parse(), RTT::marsh::TiXmlDocument::Parse(), RTT::marsh::TiXmlBase::ReadText(), and RTT::marsh::TiXmlElement::ReadValue().

virtual void RTT::marsh::TiXmlBase::StreamOut ( TIXML_OSTREAM * ) const

protectedpure virtualinherited

Implemented in RTT::marsh::TiXmlDocument, RTT::marsh::TiXmlUnknown, RTT::marsh::TiXmlDeclaration, RTT::marsh::TiXmlText, RTT::marsh::TiXmlComment, RTT::marsh::TiXmlElement, and RTT::marsh::TiXmlAttribute.

Referenced by RTT::marsh::operator<<(), RTT::marsh::TiXmlElement::StreamOut(), and RTT::marsh::TiXmlDocument::StreamOut().

bool RTT::marsh::TiXmlBase::StringEqual	(	const char *	p,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

Definition at line 561 of file tinyxmlparser.cpp.

References RTT::marsh::TiXmlBase::ToLower().

Referenced by Identify(), RTT::marsh::TiXmlElement::Parse(), RTT::marsh::TiXmlComment::Parse(), RTT::marsh::TiXmlText::Parse(), RTT::marsh::TiXmlDeclaration::Parse(), RTT::marsh::TiXmlDocument::Parse(), RTT::marsh::TiXmlBase::ReadText(), and RTT::marsh::TiXmlElement::ReadValue().

virtual const TiXmlComment* RTT::marsh::TiXmlNode::ToComment ( ) const

inlinevirtual

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

Reimplemented in RTT::marsh::TiXmlComment.

Definition at line 677 of file tinyxml.h.

virtual TiXmlComment* RTT::marsh::TiXmlNode::ToComment ( )

inlinevirtual

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

Reimplemented in RTT::marsh::TiXmlComment.

Definition at line 684 of file tinyxml.h.

virtual const TiXmlDeclaration* RTT::marsh::TiXmlNode::ToDeclaration ( ) const

inlinevirtual

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

Reimplemented in RTT::marsh::TiXmlDeclaration.

Definition at line 680 of file tinyxml.h.

Referenced by RTT::marsh::TiXmlDocument::Parse().

virtual TiXmlDeclaration* RTT::marsh::TiXmlNode::ToDeclaration ( )

inlinevirtual

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

Reimplemented in RTT::marsh::TiXmlDeclaration.

Definition at line 687 of file tinyxml.h.

References TIXML_STRING.

virtual const TiXmlDocument* RTT::marsh::TiXmlNode::ToDocument ( ) const

inlinevirtual

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

Reimplemented in RTT::marsh::TiXmlDocument.

Definition at line 675 of file tinyxml.h.

Referenced by GetDocument().

virtual TiXmlDocument* RTT::marsh::TiXmlNode::ToDocument ( )

inlinevirtual

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

Reimplemented in RTT::marsh::TiXmlDocument.

Definition at line 682 of file tinyxml.h.

virtual const TiXmlElement* RTT::marsh::TiXmlNode::ToElement ( ) const

inlinevirtual

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

Reimplemented in RTT::marsh::TiXmlElement.

Definition at line 676 of file tinyxml.h.

Referenced by FirstChildElement(), NextSiblingElement(), RTT::marsh::Tiny2CPFHandler::populateBag(), RTT::marsh::TiXmlBase::ReadText(), and RTT::marsh::TiXmlDocument::StreamOut().

virtual TiXmlElement* RTT::marsh::TiXmlNode::ToElement ( )

inlinevirtual

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

Reimplemented in RTT::marsh::TiXmlElement.

Definition at line 683 of file tinyxml.h.

static int RTT::marsh::TiXmlBase::ToLower	(	int	v,
		TiXmlEncoding	encoding
	)

inlinestaticprotectedinherited

Definition at line 384 of file tinyxml.h.

References RTT::marsh::TIXML_ENCODING_UTF8.

Referenced by RTT::marsh::TiXmlBase::StringEqual().

virtual const TiXmlText* RTT::marsh::TiXmlNode::ToText ( ) const

inlinevirtual

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

Reimplemented in RTT::marsh::TiXmlText.

Definition at line 679 of file tinyxml.h.

Referenced by RTT::marsh::TiXmlElement::GetText(), RTT::marsh::Tiny2CPFHandler::populateBag(), and RTT::marsh::TiXmlElement::Print().

virtual TiXmlText* RTT::marsh::TiXmlNode::ToText ( )

inlinevirtual

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

Reimplemented in RTT::marsh::TiXmlText.

Definition at line 686 of file tinyxml.h.

virtual const TiXmlUnknown* RTT::marsh::TiXmlNode::ToUnknown ( ) const

inlinevirtual

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

Reimplemented in RTT::marsh::TiXmlUnknown.

Definition at line 678 of file tinyxml.h.

virtual TiXmlUnknown* RTT::marsh::TiXmlNode::ToUnknown ( )

inlinevirtual

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

Reimplemented in RTT::marsh::TiXmlUnknown.

Definition at line 685 of file tinyxml.h.

int RTT::marsh::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 664 of file tinyxml.h.

Referenced by RTT::marsh::Tiny2CPFHandler::populateBag().

const char* RTT::marsh::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 492 of file tinyxml.h.

Referenced by RTT::marsh::TiXmlElement::Clone(), FirstChild(), RTT::marsh::TiXmlElement::GetText(), LastChild(), NextSibling(), RTT::marsh::Tiny2CPFHandler::populateBag(), and PreviousSibling().

Friends And Related Function Documentation

TIXML_OSTREAM& operator<<	(	TIXML_OSTREAM &	out,
		const TiXmlNode &	base
	)

friend

Definition at line 1698 of file tinyxml.cpp.

Referenced by RTT::marsh::operator<<().

friend class TiXmlDocument

friend

Definition at line 427 of file tinyxml.h.

friend class TiXmlElement

friend

Definition at line 428 of file tinyxml.h.

Member Data Documentation

const char * RTT::marsh::TiXmlBase::errorString

staticprotectedinherited

Initial value:

=
{
    "No error",
    "Error",
    "Failed to open file",
    "Memory allocation failed.",
    "Error parsing Element.",
    "Failed to read Element name",
    "Error reading Element value.",
    "Error reading Attributes.",
    "Error: empty tag.",
    "Error reading end tag.",
    "Error parsing Unknown.",
    "Error parsing Comment.",
    "Error parsing Declaration.",
    "Error document empty.",
    "Error null (0) or unexpected EOF found in input stream.",
    "Error parsing CDATA.",
}

Definition at line 373 of file tinyxml.h.

Referenced by RTT::marsh::TiXmlDocument::SetError().

TiXmlNode* RTT::marsh::TiXmlNode::firstChild

protected

Definition at line 712 of file tinyxml.h.

Referenced by Clear(), RTT::marsh::TiXmlElement::CopyTo(), FirstChild(), InsertBeforeChild(), LinkEndChild(), RTT::marsh::TiXmlElement::Print(), RemoveChild(), ReplaceChild(), RTT::marsh::TiXmlDocument::SaveFile(), RTT::marsh::TiXmlElement::StreamOut(), RTT::marsh::TiXmlElement::TiXmlElement(), TiXmlNode(), and ~TiXmlNode().

TiXmlNode* RTT::marsh::TiXmlNode::lastChild

protected

Definition at line 713 of file tinyxml.h.

Referenced by Clear(), InsertAfterChild(), LastChild(), LinkEndChild(), RTT::marsh::TiXmlElement::Print(), RemoveChild(), ReplaceChild(), RTT::marsh::TiXmlElement::TiXmlElement(), and TiXmlNode().

TiXmlCursor RTT::marsh::TiXmlBase::location

protectedinherited

Definition at line 375 of file tinyxml.h.

Referenced by RTT::marsh::TiXmlDocument::LoadFile(), RTT::marsh::TiXmlAttribute::Parse(), RTT::marsh::TiXmlElement::Parse(), RTT::marsh::TiXmlComment::Parse(), RTT::marsh::TiXmlText::Parse(), RTT::marsh::TiXmlDeclaration::Parse(), RTT::marsh::TiXmlUnknown::Parse(), and RTT::marsh::TiXmlDocument::Parse().

TiXmlNode* RTT::marsh::TiXmlNode::next

protected

Definition at line 718 of file tinyxml.h.

Referenced by Clear(), FirstChild(), InsertAfterChild(), InsertBeforeChild(), LinkEndChild(), RTT::marsh::TiXmlAttribute::Next(), NextSibling(), RemoveChild(), ReplaceChild(), TiXmlNode(), and ~TiXmlNode().

TiXmlNode* RTT::marsh::TiXmlNode::parent

protected

Definition at line 709 of file tinyxml.h.

Referenced by GetDocument(), Identify(), InsertAfterChild(), InsertBeforeChild(), IterateChildren(), LinkEndChild(), RemoveChild(), ReplaceChild(), and TiXmlNode().

TiXmlNode* RTT::marsh::TiXmlNode::prev

protected

Definition at line 717 of file tinyxml.h.

Referenced by InsertAfterChild(), InsertBeforeChild(), LastChild(), LinkEndChild(), RTT::marsh::TiXmlAttribute::Previous(), PreviousSibling(), RemoveChild(), ReplaceChild(), and TiXmlNode().

NodeType RTT::marsh::TiXmlNode::type

protected

Definition at line 710 of file tinyxml.h.

Referenced by TiXmlNode().

void* RTT::marsh::TiXmlBase::userData

protectedinherited

Field containing a generic user pointer.

Definition at line 378 of file tinyxml.h.

Referenced by CopyTo().

const int RTT::marsh::TiXmlBase::utf8ByteTable

staticinherited

Initial value:

=
{
    
        1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
        1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
        1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
        1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
        1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
        1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
        1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
        1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
        1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
        1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
        1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
        1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
        1,  1,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  
        2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  
        3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  
        4,  4,  4,  4,  4,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1   
}

Definition at line 243 of file tinyxml.h.

TIXML_STRING RTT::marsh::TiXmlNode::value

protected

Definition at line 715 of file tinyxml.h.

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

rtt/marsh/tinyxml.h
rtt/marsh/tinyxml.cpp
rtt/marsh/tinyxmlparser.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation