TiXmlUnknown Class Reference

#include <mtkpp/src/tinyxml/tinyxml.h>

Inheritance diagram for TiXmlUnknown:

Collaboration diagram for TiXmlUnknown:

List of all members.

Public Types
enum	NodeType {   DOCUMENT, ELEMENT, COMMENT, UNKNOWN,   TEXT, DECLARATION, TYPECOUNT }
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_DOCUMENT_TOP_ONLY, TIXML_ERROR_STRING_COUNT }
Public Member Functions
	TiXmlUnknown ()
virtual	~TiXmlUnknown ()
	TiXmlUnknown (const TiXmlUnknown &copy)
void	operator= (const TiXmlUnknown &copy)
virtual TiXmlNode *	Clone () const
	Creates a copy of this Unknown and returns it.
virtual void	Print (FILE *cfile, int depth) const
virtual const char *	Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
virtual const TiXmlUnknown *	ToUnknown () const
	Cast to a more defined type. Will return null not of the requested type.
virtual TiXmlUnknown *	ToUnknown ()
	Cast to a more defined type. Will return null not of the requested type.
virtual bool	Accept (TiXmlVisitor *content) const
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 TiXmlDocument *	ToDocument ()
	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 TiXmlElement *	ToElement ()
	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 TiXmlComment *	ToComment ()
	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 TiXmlText *	ToText ()
	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 TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null if not of the requested type.
int	Row () const
int	Column () const
	See Row()
void	SetUserData (void *user)
	Set a pointer to arbitrary user data.
void *	GetUserData ()
	Get a pointer to arbitrary user data.
const void *	GetUserData () const
	Get a pointer to arbitrary user data.
Static Public Member Functions
static void	SetCondenseWhiteSpace (bool condense)
static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting.
static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
Static Public Attributes
static const int	utf8ByteTable [256]
Protected Member Functions
void	CopyTo (TiXmlUnknown *target) const
void	CopyTo (TiXmlNode *target) const
TiXmlNode *	Identify (const char *start, TiXmlEncoding encoding)
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 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.
Static Protected Attributes
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

---

Detailed Description

Any tag that tinyXml doesn't recognize is saved as an unknown. It is a tag of text, but should not be modified. It will be written back to the XML, unchanged, when the file is saved.

DTD tags get thrown into TiXmlUnknowns.

---

Member Enumeration Documentation

enum TiXmlNode::NodeType [inherited]

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

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_DOCUMENT_TOP_ONLY
TIXML_ERROR_STRING_COUNT

---

Constructor & Destructor Documentation

TiXmlUnknown::TiXmlUnknown

(

)

[inline]

Referenced by Clone().

virtual TiXmlUnknown::~TiXmlUnknown

(

)

[inline, virtual]

TiXmlUnknown::TiXmlUnknown

(

const TiXmlUnknown &

copy

)

[inline]

References CopyTo().

---

Member Function Documentation

void TiXmlUnknown::operator=

(

const TiXmlUnknown &

copy

)

[inline]

References CopyTo().

TiXmlNode * TiXmlUnknown::Clone

(

)

const [virtual]

Creates a copy of this Unknown and returns it.

Implements TiXmlNode.

References CopyTo(), and TiXmlUnknown().

void TiXmlUnknown::Print	(	FILE *	cfile,
		int	depth
	)		const [virtual]

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

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

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

Implements TiXmlBase.

References TiXmlNode::value.

const char * TiXmlUnknown::Parse	(	const char *	p,
		TiXmlParsingData *	data,
		TiXmlEncoding	encoding
	)		[virtual]

Implements TiXmlBase.

References TiXmlParsingData::Cursor(), TiXmlNode::GetDocument(), TiXmlBase::location, TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlParsingData::Stamp(), TiXmlBase::TIXML_ERROR_PARSING_UNKNOWN, and TiXmlNode::value.

virtual const TiXmlUnknown* TiXmlUnknown::ToUnknown

(

)

const [inline, virtual]

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

Reimplemented from TiXmlNode.

virtual TiXmlUnknown* TiXmlUnknown::ToUnknown

(

)

[inline, virtual]

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

Reimplemented from TiXmlNode.

bool TiXmlUnknown::Accept

(

TiXmlVisitor *

content

)

const [virtual]

Walk the XML tree visiting this node and all of its children.

Implements TiXmlNode.

References TiXmlVisitor::Visit().

void TiXmlUnknown::CopyTo

(

TiXmlUnknown *

target

)

const [protected]

Referenced by Clone(), operator=(), and TiXmlUnknown().

const char* TiXmlNode::Value

(

)

const [inline, inherited]

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 TiXmlNode::value.

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

const TIXML_STRING& TiXmlNode::ValueTStr

(

)

const [inline, inherited]

References TiXmlNode::value.

Referenced by TiXmlPrinter::Visit().

void TiXmlNode::SetValue

(

const char *

_value

)

[inline, inherited]

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 TiXmlNode::value.

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

void TiXmlNode::Clear

(

)

[inherited]

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

References TiXmlNode::firstChild, TiXmlNode::lastChild, and TiXmlNode::next.

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

TiXmlNode* TiXmlNode::Parent

(

)

[inline, inherited]

One step up the DOM.

References TiXmlNode::parent.

const TiXmlNode* TiXmlNode::Parent

(

)

const [inline, inherited]

References TiXmlNode::parent.

const TiXmlNode* TiXmlNode::FirstChild

(

)

const [inline, inherited]

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

References TiXmlNode::firstChild.

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

TiXmlNode* TiXmlNode::FirstChild

(

)

[inline, inherited]

References TiXmlNode::firstChild.

const TiXmlNode * TiXmlNode::FirstChild

(

const char *

value

)

const [inherited]

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

References TiXmlNode::firstChild, TiXmlNode::next, and TiXmlNode::Value().

TiXmlNode* TiXmlNode::FirstChild

(

const char *

_value

)

[inline, inherited]

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

const TiXmlNode* TiXmlNode::LastChild

(

)

const [inline, inherited]

References TiXmlNode::lastChild.

Referenced by TiXmlPrinter::VisitEnter().

TiXmlNode* TiXmlNode::LastChild

(

)

[inline, inherited]

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

References TiXmlNode::lastChild.

const TiXmlNode * TiXmlNode::LastChild

(

const char *

value

)

const [inherited]

References TiXmlNode::lastChild, TiXmlNode::prev, and TiXmlNode::Value().

TiXmlNode* TiXmlNode::LastChild

(

const char *

_value

)

[inline, inherited]

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

const TiXmlNode * TiXmlNode::IterateChildren

(

const TiXmlNode *

previous

)

const [inherited]

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 TiXmlNode::FirstChild(), TiXmlNode::NextSibling(), and TiXmlNode::parent.

TiXmlNode* TiXmlNode::IterateChildren

(

const TiXmlNode *

previous

)

[inline, inherited]

const TiXmlNode * TiXmlNode::IterateChildren	(	const char *	value,
		const TiXmlNode *	previous
	)		const [inherited]

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

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

TiXmlNode* TiXmlNode::IterateChildren	(	const char *	_value,
		const TiXmlNode *	previous
	)		[inline, inherited]

TiXmlNode * TiXmlNode::InsertEndChild

(

const TiXmlNode &

addThis

)

[inherited]

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 TiXmlNode::Clone(), TiXmlNode::DOCUMENT, TiXmlNode::GetDocument(), TiXmlNode::LinkEndChild(), TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_TOP_ONLY, and TiXmlNode::Type().

TiXmlNode * TiXmlNode::LinkEndChild

(

TiXmlNode *

addThis

)

[inherited]

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

References TiXmlNode::DOCUMENT, TiXmlNode::firstChild, TiXmlNode::GetDocument(), TiXmlNode::lastChild, TiXmlNode::next, TiXmlNode::parent, TiXmlNode::prev, TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_TOP_ONLY, and TiXmlNode::Type().

Referenced by TiXmlElement::CopyTo(), TiXmlDocument::CopyTo(), TiXmlNode::InsertEndChild(), TiXmlDocument::Parse(), and TiXmlElement::ReadValue().

TiXmlNode * TiXmlNode::InsertBeforeChild	(	TiXmlNode *	beforeThis,
		const TiXmlNode &	addThis
	)		[inherited]

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 TiXmlNode::Clone(), TiXmlNode::DOCUMENT, TiXmlNode::firstChild, TiXmlNode::GetDocument(), TiXmlNode::next, TiXmlNode::parent, TiXmlNode::prev, TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_TOP_ONLY, and TiXmlNode::Type().

TiXmlNode * TiXmlNode::InsertAfterChild	(	TiXmlNode *	afterThis,
		const TiXmlNode &	addThis
	)		[inherited]

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 TiXmlNode::Clone(), TiXmlNode::DOCUMENT, TiXmlNode::GetDocument(), TiXmlNode::lastChild, TiXmlNode::next, TiXmlNode::parent, TiXmlNode::prev, TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_TOP_ONLY, and TiXmlNode::Type().

TiXmlNode * TiXmlNode::ReplaceChild	(	TiXmlNode *	replaceThis,
		const TiXmlNode &	withThis
	)		[inherited]

Replace a child of this node. Returns a pointer to the new object or NULL if an error occured.

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

bool TiXmlNode::RemoveChild

(

TiXmlNode *

removeThis

)

[inherited]

Delete a child of this node.

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

const TiXmlNode* TiXmlNode::PreviousSibling

(

)

const [inline, inherited]

Navigate to a sibling node.

References TiXmlNode::prev.

TiXmlNode* TiXmlNode::PreviousSibling

(

)

[inline, inherited]

References TiXmlNode::prev.

const TiXmlNode * TiXmlNode::PreviousSibling

(

const char *

_value

)

const [inherited]

Navigate to a sibling node.

References TiXmlNode::prev, and TiXmlNode::Value().

TiXmlNode* TiXmlNode::PreviousSibling

(

const char *

_prev

)

[inline, inherited]

const TiXmlNode* TiXmlNode::NextSibling

(

)

const [inline, inherited]

Navigate to a sibling node.

References TiXmlNode::next.

Referenced by TiXmlHandle::Child(), TiXmlElement::CopyTo(), TiXmlDocument::CopyTo(), TiXmlNode::FirstChildElement(), TiXmlNode::IterateChildren(), TiXmlNode::NextSiblingElement(), and TiXmlElement::Print().

TiXmlNode* TiXmlNode::NextSibling

(

)

[inline, inherited]

References TiXmlNode::next.

const TiXmlNode * TiXmlNode::NextSibling

(

const char *

_value

)

const [inherited]

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

References TiXmlNode::next, and TiXmlNode::Value().

TiXmlNode* TiXmlNode::NextSibling

(

const char *

_next

)

[inline, inherited]

const TiXmlElement * TiXmlNode::NextSiblingElement

(

)

const [inherited]

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 TiXmlNode::NextSibling(), and TiXmlNode::ToElement().

Referenced by TiXmlHandle::ChildElement().

TiXmlElement* TiXmlNode::NextSiblingElement

(

)

[inline, inherited]

const TiXmlElement * TiXmlNode::NextSiblingElement

(

const char *

_value

)

const [inherited]

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 TiXmlNode::NextSibling(), and TiXmlNode::ToElement().

TiXmlElement* TiXmlNode::NextSiblingElement

(

const char *

_next

)

[inline, inherited]

const TiXmlElement * TiXmlNode::FirstChildElement

(

)

const [inherited]

Convenience function to get through elements.

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

Referenced by TiXmlDocument::RootElement().

TiXmlElement* TiXmlNode::FirstChildElement

(

)

[inline, inherited]

const TiXmlElement * TiXmlNode::FirstChildElement

(

const char *

_value

)

const [inherited]

Convenience function to get through elements.

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

TiXmlElement* TiXmlNode::FirstChildElement

(

const char *

_value

)

[inline, inherited]

int TiXmlNode::Type

(

)

const [inline, inherited]

Query the type (as an enumerated value, above) of this node. The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.

References TiXmlNode::type.

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

const TiXmlDocument * TiXmlNode::GetDocument

(

)

const [inherited]

Return a pointer to the Document this node lives in. Returns null if not in a document.

References TiXmlNode::parent, and TiXmlNode::ToDocument().

Referenced by TiXmlNode::Identify(), TiXmlNode::InsertAfterChild(), TiXmlNode::InsertBeforeChild(), TiXmlNode::InsertEndChild(), TiXmlNode::LinkEndChild(), TiXmlElement::Parse(), TiXmlComment::Parse(), TiXmlText::Parse(), TiXmlDeclaration::Parse(), Parse(), TiXmlElement::ReadValue(), and TiXmlElement::SetAttribute().

TiXmlDocument* TiXmlNode::GetDocument

(

)

[inline, inherited]

bool TiXmlNode::NoChildren

(

)

const [inline, inherited]

Returns true if this node has no children.

References TiXmlNode::firstChild.

virtual const TiXmlDocument* TiXmlNode::ToDocument

(

)

const [inline, virtual, inherited]

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

Reimplemented in TiXmlDocument.

Referenced by TiXmlNode::GetDocument().

virtual TiXmlDocument* TiXmlNode::ToDocument

(

)

[inline, virtual, inherited]

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

Reimplemented in TiXmlDocument.

virtual const TiXmlElement* TiXmlNode::ToElement

(

)

const [inline, virtual, inherited]

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

Reimplemented in TiXmlElement.

Referenced by TiXmlNode::FirstChildElement(), and TiXmlNode::NextSiblingElement().

virtual TiXmlElement* TiXmlNode::ToElement

(

)

[inline, virtual, inherited]

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

Reimplemented in TiXmlElement.

virtual const TiXmlComment* TiXmlNode::ToComment

(

)

const [inline, virtual, inherited]

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

Reimplemented in TiXmlComment.

virtual TiXmlComment* TiXmlNode::ToComment

(

)

[inline, virtual, inherited]

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

Reimplemented in TiXmlComment.

virtual const TiXmlText* TiXmlNode::ToText

(

)

const [inline, virtual, inherited]

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 TiXmlText* TiXmlNode::ToText

(

)

[inline, virtual, inherited]

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

Reimplemented in TiXmlText.

virtual const TiXmlDeclaration* TiXmlNode::ToDeclaration

(

)

const [inline, virtual, inherited]

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

Reimplemented in TiXmlDeclaration.

Referenced by TiXmlDocument::Parse().

virtual TiXmlDeclaration* TiXmlNode::ToDeclaration

(

)

[inline, virtual, inherited]

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

Reimplemented in TiXmlDeclaration.

void TiXmlNode::CopyTo

(

TiXmlNode *

target

)

const [protected, inherited]

References TiXmlNode::SetValue(), TiXmlBase::userData, and TiXmlNode::value.

TiXmlNode * TiXmlNode::Identify	(	const char *	start,
		TiXmlEncoding	encoding
	)		[protected, inherited]

References TiXmlNode::GetDocument(), TiXmlBase::IsAlpha(), TiXmlNode::parent, TiXmlText::SetCDATA(), TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlBase::StringEqual(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_OUT_OF_MEMORY, and TiXmlNode::TiXmlElement.

Referenced by TiXmlDocument::Parse(), and TiXmlElement::ReadValue().

static void TiXmlBase::SetCondenseWhiteSpace

(

bool

condense

)

[inline, static, inherited]

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 value is not thread safe.

References TiXmlBase::condenseWhiteSpace.

static bool TiXmlBase::IsWhiteSpaceCondensed

(

)

[inline, static, inherited]

Return the current white space setting.

References TiXmlBase::condenseWhiteSpace.

Referenced by TiXmlElement::ReadValue().

int TiXmlBase::Row

(

)

const [inline, inherited]

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()

References TiXmlBase::location, and TiXmlCursor::row.

int TiXmlBase::Column

(

)

const [inline, inherited]

See Row()

References TiXmlCursor::col, and TiXmlBase::location.

void TiXmlBase::SetUserData

(

void *

user

)

[inline, inherited]

Set a pointer to arbitrary user data.

References TiXmlBase::userData.

void* TiXmlBase::GetUserData

(

)

[inline, inherited]

Get a pointer to arbitrary user data.

References TiXmlBase::userData.

const void* TiXmlBase::GetUserData

(

)

const [inline, inherited]

Get a pointer to arbitrary user data.

References TiXmlBase::userData.

void TiXmlBase::EncodeString	(	const TIXML_STRING &	str,
		TIXML_STRING *	out
	)		[static, inherited]

Expands entities in a string. Note this should not contian the tag's '<', '>', etc, or they will be transformed into entities!

References TiXmlBase::entity.

Referenced by TiXmlAttribute::Print(), TiXmlText::Print(), and TiXmlPrinter::Visit().

const char * TiXmlBase::SkipWhiteSpace	(	const char *	p,
		TiXmlEncoding	encoding
	)		[static, protected, inherited]

References TiXmlBase::IsWhiteSpace(), TIXML_ENCODING_UTF8, TIXML_UTF_LEAD_0, TIXML_UTF_LEAD_1, and TIXML_UTF_LEAD_2.

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

static bool TiXmlBase::IsWhiteSpace

(

char

c

)

[inline, static, protected, inherited]

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

static bool TiXmlBase::IsWhiteSpace

(

int

c

)

[inline, static, protected, inherited]

References TiXmlBase::IsWhiteSpace().

const char * TiXmlBase::ReadName	(	const char *	p,
		TIXML_STRING *	name,
		TiXmlEncoding	encoding
	)		[static, protected, inherited]

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

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

const char * TiXmlBase::ReadText	(	const char *	in,
		TIXML_STRING *	text,
		bool	ignoreWhiteSpace,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)		[static, protected, inherited]

References TiXmlBase::condenseWhiteSpace, TiXmlBase::GetChar(), TiXmlBase::IsWhiteSpace(), TiXmlBase::SkipWhiteSpace(), and TiXmlBase::StringEqual().

Referenced by TiXmlAttribute::Parse(), and TiXmlText::Parse().

const char * TiXmlBase::GetEntity	(	const char *	in,
		char *	value,
		int *	length,
		TiXmlEncoding	encoding
	)		[static, protected, inherited]

References TiXmlBase::Entity::chr, TiXmlBase::ConvertUTF32ToUTF8(), TiXmlBase::entity, TiXmlBase::NUM_ENTITY, TIXML_ENCODING_UTF8, and TIXML_STRING.

Referenced by TiXmlBase::GetChar().

static const char* TiXmlBase::GetChar	(	const char *	p,
		char *	_value,
		int *	length,
		TiXmlEncoding	encoding
	)		[inline, static, protected, inherited]

References TiXmlBase::GetEntity(), TIXML_ENCODING_UTF8, and TiXmlBase::utf8ByteTable.

Referenced by TiXmlBase::ReadText().

bool TiXmlBase::StringEqual	(	const char *	p,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)		[static, protected, inherited]

References TiXmlBase::ToLower().

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

int TiXmlBase::IsAlpha	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)		[static, protected, inherited]

Referenced by TiXmlNode::Identify(), and TiXmlBase::ReadName().

int TiXmlBase::IsAlphaNum	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)		[static, protected, inherited]

Referenced by TiXmlBase::ReadName().

static int TiXmlBase::ToLower	(	int	v,
		TiXmlEncoding	encoding
	)		[inline, static, protected, inherited]

References TIXML_ENCODING_UTF8.

Referenced by TiXmlBase::StringEqual().

void TiXmlBase::ConvertUTF32ToUTF8	(	unsigned long	input,
		char *	output,
		int *	length
	)		[static, protected, inherited]

Referenced by TiXmlBase::GetEntity().

---

Member Data Documentation

TiXmlNode* TiXmlNode::parent [protected, inherited]

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

NodeType TiXmlNode::type [protected, inherited]

Referenced by TiXmlNode::TiXmlNode(), and TiXmlNode::Type().

TiXmlNode* TiXmlNode::firstChild [protected, inherited]

Referenced by TiXmlNode::Clear(), TiXmlElement::CopyTo(), TiXmlDocument::CopyTo(), TiXmlNode::FirstChild(), TiXmlNode::InsertBeforeChild(), TiXmlNode::LinkEndChild(), TiXmlNode::NoChildren(), TiXmlDocument::Parse(), TiXmlElement::Print(), TiXmlNode::RemoveChild(), TiXmlNode::ReplaceChild(), TiXmlElement::TiXmlElement(), TiXmlNode::TiXmlNode(), and TiXmlNode::~TiXmlNode().

TiXmlNode* TiXmlNode::lastChild [protected, inherited]

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

TIXML_STRING TiXmlNode::value [protected, inherited]

Referenced by TiXmlText::Blank(), TiXmlNode::CopyTo(), TiXmlDocument::LoadFile(), TiXmlElement::Parse(), TiXmlComment::Parse(), TiXmlText::Parse(), Parse(), TiXmlElement::Print(), TiXmlComment::Print(), TiXmlText::Print(), Print(), TiXmlNode::SetValue(), TiXmlDocument::TiXmlDocument(), TiXmlElement::TiXmlElement(), TiXmlNode::Value(), and TiXmlNode::ValueTStr().

TiXmlNode* TiXmlNode::prev [protected, inherited]

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

TiXmlNode* TiXmlNode::next [protected, inherited]

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

const int TiXmlBase::utf8ByteTable [static, inherited]

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       
}

Referenced by TiXmlBase::GetChar(), and TiXmlParsingData::Stamp().

const char * TiXmlBase::errorString [static, protected, inherited]

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.",
        "Error when TiXmlDocument added to document, because TiXmlDocument can only be at the root.",
}

Referenced by TiXmlDocument::SetError().

TiXmlCursor TiXmlBase::location [protected, inherited]

Referenced by TiXmlBase::Column(), TiXmlDocument::LoadFile(), TiXmlAttribute::Parse(), TiXmlElement::Parse(), TiXmlComment::Parse(), TiXmlText::Parse(), TiXmlDeclaration::Parse(), Parse(), TiXmlDocument::Parse(), and TiXmlBase::Row().

void* TiXmlBase::userData [protected, inherited]

Field containing a generic user pointer.

Referenced by TiXmlNode::CopyTo(), TiXmlBase::GetUserData(), and TiXmlBase::SetUserData().

---

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

• tinyxml.h
• tinyxml.cpp
• tinyxmlparser.cpp