Always the top level node. More...

#include <tinyxml.h>

Inheritance diagram for TiXmlDocument:

Collaboration diagram for TiXmlDocument:

[legend]

Public Types
enum	{ TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, 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 }

enum	NodeType { TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN, TINYXML_TEXT, TINYXML_DECLARATION, TINYXML_TYPECOUNT }
	The types of XML nodes supported by TinyXml. More...

Public Member Functions
	TiXmlDocument ()
	Create an empty document, that has no name. More...

	TiXmlDocument (const char *documentName)
	Create a document with a name. The name of the document is also the filename of the xml. More...

	TiXmlDocument (const std::string &documentName)
	Constructor. More...

	TiXmlDocument (const TiXmlDocument &copy)

virtual	~TiXmlDocument ()

virtual bool	Accept (TiXmlVisitor *content) const
	Walk the XML tree visiting this node and all of its children. More...

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

void	ClearError ()
	If you have handled the error, it can be reset with this call. More...

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

bool	Error () const
	If an error occurs, Error will be set to true. More...

int	ErrorCol () const
	The column where the error occured. See ErrorRow() More...

const char *	ErrorDesc () const
	Contains a textual (english) description of the error if one occurs. More...

int	ErrorId () const
	Generally, you probably want the error string ( ErrorDesc() ). More...

int	ErrorRow () const
	Returns the location (if known) of the error. More...

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'. 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 *	FirstChild (const std::string &_value) const
	STL std::string form. More...

TiXmlNode *	FirstChild (const std::string &_value)
	STL std::string form. More...

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)

const TiXmlElement *	FirstChildElement (const std::string &_value) const
	STL std::string form. More...

TiXmlElement *	FirstChildElement (const std::string &_value)
	STL std::string form. More...

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

TiXmlDocument *	GetDocument ()

void *	GetUserData ()
	Get a pointer to arbitrary user data. More...

const void *	GetUserData () const
	Get a pointer to arbitrary user data. More...

TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const 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 *	InsertEndChild (const TiXmlNode &addThis)
	Add a new node related to this. More...

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

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

TiXmlNode *	IterateChildren (const char _value, const TiXmlNode previous)

const TiXmlNode *	IterateChildren (const std::string &_value, const TiXmlNode *previous) const
	STL std::string form. More...

TiXmlNode *	IterateChildren (const std::string &_value, const TiXmlNode *previous)
	STL std::string form. 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 *	LastChild (const std::string &_value) const
	STL std::string form. More...

TiXmlNode *	LastChild (const std::string &_value)
	STL std::string form. More...

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

bool	LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
	Load a file using the current document value. More...

bool	LoadFile (const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
	Load a file using the given filename. Returns true if successful. More...

bool	LoadFile (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
	Load a file using the given FILE*. More...

bool	LoadFile (const std::string &filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
	Loads a XML file. More...

const TiXmlNode *	NextSibling (const std::string &_value) const
	STL std::string form. More...

TiXmlNode *	NextSibling (const std::string &_value)
	STL std::string form. More...

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 *_next)

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 *_next)

const TiXmlElement *	NextSiblingElement (const std::string &_value) const
	STL std::string form. More...

TiXmlElement *	NextSiblingElement (const std::string &_value)
	STL std::string form. More...

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

void	operator= (const TiXmlDocument &copy)

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

const TiXmlNode *	Parent () const

virtual const char *	Parse (const char p, TiXmlParsingData data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
	Parse the given null terminated block of xml data. 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 *_prev)

const TiXmlNode *	PreviousSibling (const std::string &_value) const
	STL std::string form. More...

TiXmlNode *	PreviousSibling (const std::string &_value)
	STL std::string form. More...

void	Print () const
	Write the document to standard out using formatted printing ("pretty print"). More...

virtual void	Print (FILE *cfile, int depth=0) const
	Print this Document to a FILE stream. More...

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

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

const TiXmlElement *	RootElement () const
	Get the root element – the only top level element – of the document. More...

TiXmlElement *	RootElement ()

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

bool	SaveFile () const
	Save a file using the current document value. Returns true if successful. More...

bool	SaveFile (const char *filename) const
	Save a file using the given filename. Returns true if successful. More...

bool	SaveFile (FILE *) const
	Save a file using the given FILE*. Returns true if successful. More...

bool	SaveFile (const std::string &filename) const
	Saves a XML structure to file. More...

void	SetError (int err, const char errorLocation, TiXmlParsingData prevData, TiXmlEncoding encoding)

void	SetTabSize (int _tabsize)
	SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column. More...

void	SetUserData (void *user)
	Set a pointer to arbitrary user data. More...

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

void	SetValue (const std::string &_value)
	STL std::string form. More...

int	TabSize () const

virtual const TiXmlComment *	ToComment () const
	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 const TiXmlDeclaration *	ToDeclaration () const
	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 const TiXmlDocument *	ToDocument () const
	Cast to a more defined type. Will return null not of the requested type. More...

virtual TiXmlDocument *	ToDocument ()
	Cast to a more defined type. Will return null 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 TiXmlElement *	ToElement ()
	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 TiXmlText *	ToText ()
	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 TiXmlUnknown *	ToUnknown ()
	Cast to a more defined type. Will return null if not of the requested type. More...

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

const char *	Value () const
	The meaning of 'value' changes for the specific type of TiXmlNode. More...

const std::string &	ValueStr () const
	Return Value() as a std::string. More...

const std::string &	ValueTStr () const

Static Public Member Functions
static void	EncodeString (const std::string &str, std::string *out)
	Expands entities in a string. More...

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

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

Static Public Attributes
static const int	utf8ByteTable [256]

Protected Member Functions
virtual TiXmlNode *	Clone () const
	Create an exact duplicate of this node and return it. More...

void	CopyTo (TiXmlNode *target) const

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

virtual void	StreamIn (std::istream in, std::string tag)

Static Protected Member Functions
static void	ConvertUTF32ToUTF8 (unsigned long input, char output, int length)

static const char *	GetChar (const char p, char _value, int *length, TiXmlEncoding encoding)

static const char *	GetEntity (const char in, char value, int *length, TiXmlEncoding encoding)

static int	IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)

static int	IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)

static bool	IsWhiteSpace (char c)

static bool	IsWhiteSpace (int c)

static const char *	ReadName (const char p, std::string name, TiXmlEncoding encoding)

static const char *	ReadText (const char in, std::string text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)

static const char *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)

static bool	StreamTo (std::istream in, int character, std::string tag)

static bool	StreamWhiteSpace (std::istream in, std::string tag)

static bool	StringEqual (const char p, const char endTag, bool ignoreCase, TiXmlEncoding encoding)

static int	ToLower (int v, TiXmlEncoding encoding)

Protected Attributes
TiXmlNode *	firstChild

TiXmlNode *	lastChild

TiXmlCursor	location

TiXmlNode *	next

TiXmlNode *	parent

TiXmlNode *	prev

NodeType	type

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

std::string	value

Static Protected Attributes
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

Private Member Functions
void	CopyTo (TiXmlDocument *target) const

Private Attributes
bool	error

std::string	errorDesc

int	errorId

TiXmlCursor	errorLocation

int	tabsize

bool	useMicrosoftBOM

Detailed Description

Always the top level node.

A document binds together all the XML pieces. It can be saved, loaded, and printed to the screen. The 'value' of a document node is the xml file name.

Definition at line 1411 of file tinyxml.h.

Member Enumeration Documentation

anonymous enum

inherited

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

Definition at line 284 of file tinyxml.h.

enum TiXmlNode::NodeType

inherited

The types of XML nodes supported by TinyXml.

(All the unsupported types are picked up by UNKNOWN.)

Enumerator
TINYXML_DOCUMENT
TINYXML_ELEMENT
TINYXML_COMMENT
TINYXML_UNKNOWN
TINYXML_TEXT
TINYXML_DECLARATION
TINYXML_TYPECOUNT

Definition at line 485 of file tinyxml.h.

Constructor & Destructor Documentation

TiXmlDocument::TiXmlDocument ( )

Create an empty document, that has no name.

Definition at line 871 of file tinyxml.cpp.

TiXmlDocument::TiXmlDocument ( const char * documentName )

Create a document with a name. The name of the document is also the filename of the xml.

Definition at line 878 of file tinyxml.cpp.

TiXmlDocument::TiXmlDocument ( const std::string & documentName )

Constructor.

Definition at line 888 of file tinyxml.cpp.

TiXmlDocument::TiXmlDocument ( const TiXmlDocument & copy )

Definition at line 898 of file tinyxml.cpp.

virtual TiXmlDocument::~TiXmlDocument ( )

inlinevirtual

Definition at line 1427 of file tinyxml.h.

Member Function Documentation

bool TiXmlDocument::Accept ( TiXmlVisitor * content ) const

virtual

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

Implements TiXmlNode.

Definition at line 1113 of file tinyxml.cpp.

void TiXmlNode::Clear ( )

inherited

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

Definition at line 171 of file tinyxml.cpp.

void TiXmlDocument::ClearError ( )

inline

If you have handled the error, it can be reset with this call.

The error state is automatically cleared if you Parse a new XML block.

Definition at line 1541 of file tinyxml.h.

TiXmlNode * TiXmlDocument::Clone ( ) const

protectedvirtual

Create an exact duplicate of this node and return it.

The memory must be deleted by the caller.

Implements TiXmlNode.

Definition at line 1091 of file tinyxml.cpp.

int TiXmlBase::Column ( ) const

inlineinherited

See Row()

Definition at line 265 of file tinyxml.h.

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

staticprotectedinherited

Definition at line 90 of file tinyxmlparser.cpp.

void TiXmlNode::CopyTo ( TiXmlNode * target ) const

protectedinherited

Definition at line 163 of file tinyxml.cpp.

void TiXmlDocument::CopyTo ( TiXmlDocument * target ) const

private

Definition at line 1072 of file tinyxml.cpp.

void TiXmlBase::EncodeString	(	const std::string &	str,
		std::string *	out
	)

staticinherited

Expands entities in a string.

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

Definition at line 54 of file tinyxml.cpp.

bool TiXmlDocument::Error ( ) const

inline

If an error occurs, Error will be set to true.

Also,

The ErrorId() will contain the integer identifier of the error (not generally useful)
The ErrorDesc() method will return the name of the error. (very useful)
The ErrorRow() and ErrorCol() will return the location of the error (if known)

Definition at line 1490 of file tinyxml.h.

int TiXmlDocument::ErrorCol ( ) const

inline

The column where the error occured. See ErrorRow()

Definition at line 1508 of file tinyxml.h.

const char* TiXmlDocument::ErrorDesc ( ) const

inline

Contains a textual (english) description of the error if one occurs.

Definition at line 1493 of file tinyxml.h.

int TiXmlDocument::ErrorId ( ) const

inline

Generally, you probably want the error string ( ErrorDesc() ).

But if you prefer the ErrorId, this function will fetch it.

Definition at line 1498 of file tinyxml.h.

int TiXmlDocument::ErrorRow ( ) const

inline

Returns the location (if known) of the error.

The first column is column 1, and the first row is row 1. A value of 0 means the row and column wasn't applicable (memory errors, for example, have no row/column) or the parser lost the error. (An error in the error reporting, in that case.)

See also: SetTabSize, Row, Column

Definition at line 1507 of file tinyxml.h.

const TiXmlNode* TiXmlNode::FirstChild ( ) const

inlineinherited

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

Definition at line 545 of file tinyxml.h.

TiXmlNode* TiXmlNode::FirstChild ( )

inlineinherited

Definition at line 546 of file tinyxml.h.

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.

Definition at line 359 of file tinyxml.cpp.

TiXmlNode* TiXmlNode::FirstChild ( const char * _value )

inlineinherited

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

Definition at line 549 of file tinyxml.h.

const TiXmlNode* TiXmlNode::FirstChild ( const std::string & _value ) const

inlineinherited

STL std::string form.

Definition at line 563 of file tinyxml.h.

TiXmlNode* TiXmlNode::FirstChild ( const std::string & _value )

inlineinherited

STL std::string form.

Definition at line 564 of file tinyxml.h.

const TiXmlElement * TiXmlNode::FirstChildElement ( ) const

inherited

Convenience function to get through elements.

Definition at line 450 of file tinyxml.cpp.

TiXmlElement* TiXmlNode::FirstChildElement ( )

inlineinherited

Definition at line 688 of file tinyxml.h.

const TiXmlElement * TiXmlNode::FirstChildElement ( const char * _value ) const

inherited

Convenience function to get through elements.

Definition at line 465 of file tinyxml.cpp.

TiXmlElement* TiXmlNode::FirstChildElement ( const char * _value )

inlineinherited

Definition at line 694 of file tinyxml.h.

const TiXmlElement* TiXmlNode::FirstChildElement ( const std::string & _value ) const

inlineinherited

STL std::string form.

Definition at line 699 of file tinyxml.h.

TiXmlElement* TiXmlNode::FirstChildElement ( const std::string & _value )

inlineinherited

STL std::string form.

Definition at line 700 of file tinyxml.h.

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

inlinestaticprotectedinherited

Definition at line 347 of file tinyxml.h.

const TiXmlDocument * TiXmlNode::GetDocument ( ) const

inherited

Return a pointer to the Document this node lives in.

Returns null if not in a document.

Definition at line 510 of file tinyxml.cpp.

TiXmlDocument* TiXmlNode::GetDocument ( )

inlineinherited

Definition at line 713 of file tinyxml.h.

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

staticprotectedinherited

Definition at line 442 of file tinyxmlparser.cpp.

void* TiXmlBase::GetUserData ( )

inlineinherited

Get a pointer to arbitrary user data.

Definition at line 268 of file tinyxml.h.

const void* TiXmlBase::GetUserData ( ) const

inlineinherited

Get a pointer to arbitrary user data.

Definition at line 269 of file tinyxml.h.

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

protectedinherited

Definition at line 822 of file tinyxmlparser.cpp.

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.

Definition at line 262 of file tinyxml.cpp.

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.

Definition at line 230 of file tinyxml.cpp.

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.

Definition at line 215 of file tinyxml.cpp.

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

staticprotectedinherited

Definition at line 131 of file tinyxmlparser.cpp.

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

staticprotectedinherited

Definition at line 152 of file tinyxmlparser.cpp.

static bool TiXmlBase::IsWhiteSpace ( char c )

inlinestaticprotectedinherited

Definition at line 310 of file tinyxml.h.

static bool TiXmlBase::IsWhiteSpace ( int c )

inlinestaticprotectedinherited

Definition at line 314 of file tinyxml.h.

static bool TiXmlBase::IsWhiteSpaceCondensed ( )

inlinestaticinherited

Return the current white space setting.

Definition at line 244 of file tinyxml.h.

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.

Definition at line 383 of file tinyxml.cpp.

TiXmlNode* TiXmlNode::IterateChildren ( const TiXmlNode * previous )

inlineinherited

Definition at line 586 of file tinyxml.h.

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

inherited

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

Definition at line 397 of file tinyxml.cpp.

TiXmlNode* TiXmlNode::IterateChildren	(	const char *	_value,
		const TiXmlNode *	previous
	)

inlineinherited

Definition at line 592 of file tinyxml.h.

const TiXmlNode* TiXmlNode::IterateChildren	(	const std::string &	_value,
		const TiXmlNode *	previous
	)		const

inlineinherited

STL std::string form.

Definition at line 597 of file tinyxml.h.

TiXmlNode* TiXmlNode::IterateChildren	(	const std::string &	_value,
		const TiXmlNode *	previous
	)

inlineinherited

STL std::string form.

Definition at line 598 of file tinyxml.h.

const TiXmlNode* TiXmlNode::LastChild ( ) const

inlineinherited

Definition at line 554 of file tinyxml.h.

TiXmlNode* TiXmlNode::LastChild ( )

inlineinherited

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

Definition at line 555 of file tinyxml.h.

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

inherited

Definition at line 371 of file tinyxml.cpp.

TiXmlNode* TiXmlNode::LastChild ( const char * _value )

inlineinherited

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

Definition at line 558 of file tinyxml.h.

const TiXmlNode* TiXmlNode::LastChild ( const std::string & _value ) const

inlineinherited

STL std::string form.

Definition at line 565 of file tinyxml.h.

TiXmlNode* TiXmlNode::LastChild ( const std::string & _value )

inlineinherited

STL std::string form.

Definition at line 566 of file tinyxml.h.

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

Definition at line 188 of file tinyxml.cpp.

bool TiXmlDocument::LoadFile ( TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING )

Load a file using the current document value.

Returns true if successful. Will delete any existing document data before loading.

Definition at line 911 of file tinyxml.cpp.

bool TiXmlDocument::LoadFile	(	const char *	filename,
		TiXmlEncoding	encoding = `TIXML_DEFAULT_ENCODING`
	)

Load a file using the given filename. Returns true if successful.

Definition at line 922 of file tinyxml.cpp.

bool TiXmlDocument::LoadFile	(	FILE *	file,
		TiXmlEncoding	encoding = `TIXML_DEFAULT_ENCODING`
	)

Load a file using the given FILE*.

Returns true if successful. Note that this method doesn't stream - the entire object pointed at by the FILE* will be interpreted as an XML file. TinyXML doesn't stream in XML from the current file location. Streaming may be added in the future.

Definition at line 943 of file tinyxml.cpp.

bool TiXmlDocument::LoadFile	(	const std::string &	filename,
		TiXmlEncoding	encoding = `TIXML_DEFAULT_ENCODING`
	)

inline

Loads a XML file.

Parameters

filename	name of the file to load
encoding	character encoding of the file

Returns: true if successful

Parameters

encoding STL std::string version.

Definition at line 1456 of file tinyxml.h.

const TiXmlNode* TiXmlNode::NextSibling ( const std::string & _value ) const

inlineinherited

STL std::string form.

Definition at line 649 of file tinyxml.h.

TiXmlNode* TiXmlNode::NextSibling ( const std::string & _value )

inlineinherited

STL std::string form.

Definition at line 650 of file tinyxml.h.

const TiXmlNode* TiXmlNode::NextSibling ( ) const

inlineinherited

Navigate to a sibling node.

Definition at line 654 of file tinyxml.h.

TiXmlNode* TiXmlNode::NextSibling ( )

inlineinherited

Definition at line 655 of file tinyxml.h.

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

inherited

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

Definition at line 411 of file tinyxml.cpp.

TiXmlNode* TiXmlNode::NextSibling ( const char * _next )

inlineinherited

Definition at line 659 of file tinyxml.h.

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.

Definition at line 480 of file tinyxml.cpp.

TiXmlElement* TiXmlNode::NextSiblingElement ( )

inlineinherited

Definition at line 668 of file tinyxml.h.

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.

Definition at line 495 of file tinyxml.cpp.

TiXmlElement* TiXmlNode::NextSiblingElement ( const char * _next )

inlineinherited

Definition at line 677 of file tinyxml.h.

const TiXmlElement* TiXmlNode::NextSiblingElement ( const std::string & _value ) const

inlineinherited

STL std::string form.

Definition at line 682 of file tinyxml.h.

TiXmlElement* TiXmlNode::NextSiblingElement ( const std::string & _value )

inlineinherited

STL std::string form.

Definition at line 683 of file tinyxml.h.

bool TiXmlNode::NoChildren ( ) const

inlineinherited

Returns true if this node has no children.

Definition at line 718 of file tinyxml.h.

void TiXmlDocument::operator= ( const TiXmlDocument & copy )

Definition at line 904 of file tinyxml.cpp.

TiXmlNode* TiXmlNode::Parent ( )

inlineinherited

One step up the DOM.

Definition at line 542 of file tinyxml.h.

const TiXmlNode* TiXmlNode::Parent ( ) const

inlineinherited

Definition at line 543 of file tinyxml.h.

const char * TiXmlDocument::Parse	(	const char *	p,
		TiXmlParsingData *	data = `0`,
		TiXmlEncoding	encoding = `TIXML_DEFAULT_ENCODING`
	)

virtual

Parse the given null terminated block of xml data.

Passing in an encoding to this method (either TIXML_ENCODING_LEGACY or TIXML_ENCODING_UTF8 will force TinyXml to use that encoding, regardless of what TinyXml might otherwise try to detect.

Implements TiXmlBase.

Definition at line 708 of file tinyxmlparser.cpp.

const TiXmlNode* TiXmlNode::PreviousSibling ( ) const

inlineinherited

Navigate to a sibling node.

Definition at line 637 of file tinyxml.h.

TiXmlNode* TiXmlNode::PreviousSibling ( )

inlineinherited

Definition at line 638 of file tinyxml.h.

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

inherited

Navigate to a sibling node.

Definition at line 423 of file tinyxml.cpp.

TiXmlNode* TiXmlNode::PreviousSibling ( const char * _prev )

inlineinherited

Definition at line 642 of file tinyxml.h.

const TiXmlNode* TiXmlNode::PreviousSibling ( const std::string & _value ) const

inlineinherited

STL std::string form.

Definition at line 647 of file tinyxml.h.

TiXmlNode* TiXmlNode::PreviousSibling ( const std::string & _value )

inlineinherited

STL std::string form.

Definition at line 648 of file tinyxml.h.

void TiXmlDocument::Print ( ) const

inline

Write the document to standard out using formatted printing ("pretty print").

Definition at line 1549 of file tinyxml.h.

void TiXmlDocument::Print	(	FILE *	cfile,
		int	depth = `0`
	)		const

virtual

Print this Document to a FILE stream.

Implements TiXmlBase.

Definition at line 1102 of file tinyxml.cpp.

const char * TiXmlBase::ReadName	(	const char *	p,
		std::string *	name,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

Definition at line 405 of file tinyxmlparser.cpp.

const char * TiXmlBase::ReadText	(	const char *	in,
		std::string *	text,
		bool	ignoreWhiteSpace,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

Definition at line 578 of file tinyxmlparser.cpp.

bool TiXmlNode::RemoveChild ( TiXmlNode * removeThis )

inherited

Delete a child of this node.

Definition at line 333 of file tinyxml.cpp.

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.

Definition at line 294 of file tinyxml.cpp.

const TiXmlElement* TiXmlDocument::RootElement ( ) const

inline

Get the root element – the only top level element – of the document.

In well formed XML, there should only be one. TinyXml is tolerant of multiple elements at the document level.

Definition at line 1482 of file tinyxml.h.

TiXmlElement* TiXmlDocument::RootElement ( )

inline

Definition at line 1483 of file tinyxml.h.

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

bool TiXmlDocument::SaveFile ( ) const

Save a file using the current document value. Returns true if successful.

Definition at line 917 of file tinyxml.cpp.

bool TiXmlDocument::SaveFile ( const char * filename ) const

Save a file using the given filename. Returns true if successful.

Definition at line 1041 of file tinyxml.cpp.

bool TiXmlDocument::SaveFile ( FILE * fp ) const

Save a file using the given FILE*. Returns true if successful.

Definition at line 1055 of file tinyxml.cpp.

bool TiXmlDocument::SaveFile ( const std::string & filename ) const

inline

Saves a XML structure to file.

Parameters

filename name of the file to save to

Returns: true if successful< STL std::string version.

Definition at line 1466 of file tinyxml.h.

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

Definition at line 241 of file tinyxml.h.

void TiXmlDocument::SetError	(	int	err,
		const char *	errorLocation,
		TiXmlParsingData *	prevData,
		TiXmlEncoding	encoding
	)

Definition at line 802 of file tinyxmlparser.cpp.

void TiXmlDocument::SetTabSize ( int _tabsize )

inline

SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column.

It does not change the output or input in any way.

By calling this method, with a tab size greater than 0, the row and column of each node and attribute is stored when the file is loaded. Very useful for tracking the DOM back in to the source file.

The tab size is required for calculating the location of nodes. If not set, the default of 4 is used. The tabsize is set per document. Setting the tabsize to 0 disables row/column tracking.

Note that row and column tracking is not supported when using operator>>.

The tab size needs to be enabled before the parse or load. Correct usage:

TiXmlDocument doc;
doc.SetTabSize( 8 );
doc.Load( "myfile.xml" );

See also: Row, Column

Definition at line 1534 of file tinyxml.h.

void TiXmlBase::SetUserData ( void * user )

inlineinherited

Set a pointer to arbitrary user data.

Definition at line 267 of file tinyxml.h.

void TiXmlNode::SetValue ( const char * _value )

inlineinherited

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

void TiXmlNode::SetValue ( const std::string & _value )

inlineinherited

STL std::string form.

Definition at line 535 of file tinyxml.h.

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

staticprotectedinherited

Definition at line 318 of file tinyxmlparser.cpp.

void TiXmlDocument::StreamIn	(	std::istream *	in,
		std::string *	tag
	)

protectedvirtual

Implements TiXmlNode.

Definition at line 645 of file tinyxmlparser.cpp.

bool TiXmlBase::StreamTo	(	std::istream *	in,
		int	character,
		std::string *	tag
	)

staticprotectedinherited

Definition at line 384 of file tinyxmlparser.cpp.

bool TiXmlBase::StreamWhiteSpace	(	std::istream *	in,
		std::string *	tag
	)

staticprotectedinherited

Definition at line 369 of file tinyxmlparser.cpp.

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

staticprotectedinherited

Definition at line 538 of file tinyxmlparser.cpp.

int TiXmlDocument::TabSize ( ) const

inline

Definition at line 1536 of file tinyxml.h.

virtual const TiXmlComment* TiXmlNode::ToComment ( ) const

inlinevirtualinherited

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

Reimplemented in TiXmlComment.

Definition at line 722 of file tinyxml.h.

virtual TiXmlComment* TiXmlNode::ToComment ( )

inlinevirtualinherited

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

Reimplemented in TiXmlComment.

Definition at line 729 of file tinyxml.h.

virtual const TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) const

inlinevirtualinherited

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

Reimplemented in TiXmlDeclaration.

Definition at line 725 of file tinyxml.h.

virtual TiXmlDeclaration* TiXmlNode::ToDeclaration ( )

inlinevirtualinherited

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

Reimplemented in TiXmlDeclaration.

Definition at line 732 of file tinyxml.h.

virtual const TiXmlDocument* TiXmlDocument::ToDocument ( ) const

inlinevirtual

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

Reimplemented from TiXmlNode.

Definition at line 1562 of file tinyxml.h.

virtual TiXmlDocument* TiXmlDocument::ToDocument ( )

inlinevirtual

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

Reimplemented from TiXmlNode.

Definition at line 1563 of file tinyxml.h.

virtual const TiXmlElement* TiXmlNode::ToElement ( ) const

inlinevirtualinherited

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

Reimplemented in TiXmlElement.

Definition at line 721 of file tinyxml.h.

virtual TiXmlElement* TiXmlNode::ToElement ( )

inlinevirtualinherited

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

Reimplemented in TiXmlElement.

Definition at line 728 of file tinyxml.h.

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

inlinestaticprotectedinherited

Definition at line 402 of file tinyxml.h.

virtual const TiXmlText* TiXmlNode::ToText ( ) const

inlinevirtualinherited

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

Reimplemented in TiXmlText.

Definition at line 724 of file tinyxml.h.

virtual TiXmlText* TiXmlNode::ToText ( )

inlinevirtualinherited

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

Reimplemented in TiXmlText.

Definition at line 731 of file tinyxml.h.

virtual const TiXmlUnknown* TiXmlNode::ToUnknown ( ) const

inlinevirtualinherited

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

Reimplemented in TiXmlUnknown.

Definition at line 723 of file tinyxml.h.

virtual TiXmlUnknown* TiXmlNode::ToUnknown ( )

inlinevirtualinherited

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

Reimplemented in TiXmlUnknown.

Definition at line 730 of file tinyxml.h.

int TiXmlNode::Type ( ) const

inlineinherited

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

const char* TiXmlNode::Value ( ) const

inlineinherited

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

const std::string& TiXmlNode::ValueStr ( ) const

inlineinherited

Return Value() as a std::string.

If you only use STL, this is more efficient than calling Value(). Only available in STL mode.

Definition at line 517 of file tinyxml.h.

const std::string& TiXmlNode::ValueTStr ( ) const

inlineinherited

Definition at line 520 of file tinyxml.h.

Member Data Documentation

bool TiXmlDocument::error

private

Definition at line 1579 of file tinyxml.h.

std::string TiXmlDocument::errorDesc

private

Definition at line 1581 of file tinyxml.h.

int TiXmlDocument::errorId

private

Definition at line 1580 of file tinyxml.h.

TiXmlCursor TiXmlDocument::errorLocation

private

Definition at line 1583 of file tinyxml.h.

const char * TiXmlBase::errorString

staticprotectedinherited

Initial value:

=
{
  "No error",
  "Error",
  "Failed to open file",
  "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.",
}

Definition at line 391 of file tinyxml.h.

TiXmlNode* TiXmlNode::firstChild

protectedinherited

Definition at line 781 of file tinyxml.h.

TiXmlNode* TiXmlNode::lastChild

protectedinherited

Definition at line 782 of file tinyxml.h.

TiXmlCursor TiXmlBase::location

protectedinherited

Definition at line 393 of file tinyxml.h.

TiXmlNode* TiXmlNode::next

protectedinherited

Definition at line 787 of file tinyxml.h.

TiXmlNode* TiXmlNode::parent

protectedinherited

Definition at line 778 of file tinyxml.h.

TiXmlNode* TiXmlNode::prev

protectedinherited

Definition at line 786 of file tinyxml.h.

int TiXmlDocument::tabsize

private

Definition at line 1582 of file tinyxml.h.

NodeType TiXmlNode::type

protectedinherited

Definition at line 779 of file tinyxml.h.

bool TiXmlDocument::useMicrosoftBOM

private

Definition at line 1584 of file tinyxml.h.

void* TiXmlBase::userData

protectedinherited

Field containing a generic user pointer.

Definition at line 396 of file tinyxml.h.

const int 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 273 of file tinyxml.h.

std::string TiXmlNode::value

protectedinherited

Definition at line 784 of file tinyxml.h.

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

include/madara/utility/tinyxml.h
include/madara/utility/tinyxml.cpp
include/madara/utility/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

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation