Always the top level node. More...

#include <tinyxml.h>

Inheritance diagram for gear::TiXmlDocument:

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

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

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

	TiXmlDocument (const TiXmlDocument &copy)

TiXmlDocument &	operator= (const TiXmlDocument &copy)

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

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

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

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

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

bool	SaveFile (const std::string &filename) const
	< STL std::string version.

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 TiXmlElement *	RootElement () const
	Get the root element – the only top level element – of the document. More...

TiXmlElement *	RootElement ()

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

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

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

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

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

void	SetTabSize (int _tabsize)
	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. More...

int	TabSize () const

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

void	Print () const
	Dump the document to standard out. More...

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

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

Public Member Functions inherited from gear::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	SetValue (const std::string &_value)
	STL std::string form.

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

TiXmlNode *	Parent ()
	One step up the DOM.

const TiXmlNode *	Parent () const

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

TiXmlNode *	FirstChild ()

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

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

const TiXmlNode *	LastChild () const

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

const TiXmlNode *	LastChild (const char *value) const

TiXmlNode *	LastChild (const char *value)
	The last child of this node matching 'value'. Will be null if there are no children.

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

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

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

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

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

TiXmlNode *	IterateChildren (const char value, TiXmlNode previous)

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

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

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.

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

TiXmlNode *	PreviousSibling ()

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

TiXmlNode *	PreviousSibling (const char *)

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

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

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

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

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

TiXmlNode *	NextSibling ()

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

TiXmlNode *	NextSibling (const char *)

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

TiXmlElement *	NextSiblingElement ()

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

TiXmlElement *	NextSiblingElement (const char *)

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

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

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)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from gear::TiXmlBase
int	Row () const
	Return the position, in the original source file, of this node or attribute. More...

int	Column () const
	See Row()

void	SetUserData (void *user)

void *	GetUserData ()

Protected Member Functions
virtual void	StreamOut (TIXML_OSTREAM *out) const

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

virtual void	StreamIn (TIXML_ISTREAM in, TIXML_STRING tag)

Protected Member Functions inherited from gear::TiXmlNode
	TiXmlNode (NodeType _type)

void	CopyTo (TiXmlNode *target) const

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

const TIXML_STRING &	SValue () const

Additional Inherited Members
Public Types inherited from gear::TiXmlNode
enum	NodeType { DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, DECLARATION, TYPECOUNT }
	The types of XML nodes supported by TinyXml. More...

Public Types inherited from gear::TiXmlBase
enum	{ TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY, TIXML_ERROR_PARSING_ELEMENT, TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES, TIXML_ERROR_PARSING_EMPTY, TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT, TIXML_ERROR_PARSING_DECLARATION, TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_EMBEDDED_NULL, TIXML_ERROR_STRING_COUNT }

Static Public Member Functions inherited from gear::TiXmlBase
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.

Static Public Attributes inherited from gear::TiXmlBase
static const int	utf8ByteTable [256]

Static Protected Member Functions inherited from gear::TiXmlBase
static const char *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)

static bool	IsWhiteSpace (char c)

static bool	StreamWhiteSpace (TIXML_ISTREAM in, TIXML_STRING tag)

static bool	StreamTo (TIXML_ISTREAM in, int character, TIXML_STRING tag)

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 inherited from gear::TiXmlNode
TiXmlNode *	parent {}

NodeType	type {}

TiXmlNode *	firstChild {}

TiXmlNode *	lastChild {}

TIXML_STRING	value {}

TiXmlNode *	prev {}

TiXmlNode *	next {}

Protected Attributes inherited from gear::TiXmlBase
TiXmlCursor	location {}

void *	userData
	Field containing a generic user pointer.

Static Protected Attributes inherited from gear::TiXmlBase
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

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

Member Function Documentation

void gear::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 1262 of file tinyxml.h.

Referenced by Parse(), and TiXmlDocument().

TiXmlNode * gear::TiXmlDocument::Clone ( ) const

protectedvirtual

Create an exact duplicate of this node and return it.

The memory must be deleted by the caller.

Implements gear::TiXmlNode.

Definition at line 1031 of file tinyxml.cc.

References TiXmlDocument().

bool gear::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 1215 of file tinyxml.h.

Referenced by LoadFile().

int gear::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 1223 of file tinyxml.h.

int gear::TiXmlDocument::ErrorRow ( )

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

Referenced by gear::GearXML::createGearMgr().

bool gear::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 921 of file tinyxml.cc.

Referenced by gear::GearXML::createGearMgr(), gear::MergeXML::setFile1(), and gear::MergeXML::setFile2().

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

inline

Parameters

encoding STL std::string version.

Definition at line 1185 of file tinyxml.h.

const char * gear::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 gear::TiXmlBase.

Definition at line 689 of file tinyxmlparser.cc.

References ClearError(), gear::TiXmlDeclaration::Encoding(), gear::TiXmlNode::LinkEndChild(), and gear::TiXmlNode::ToDeclaration().

Referenced by LoadFile().

void gear::TiXmlDocument::Print ( ) const

inline

Dump the document to standard out.

Definition at line 1270 of file tinyxml.h.

References Print().

Referenced by Print(), and SaveFile().

const TiXmlElement* gear::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 1207 of file tinyxml.h.

References gear::TiXmlNode::FirstChildElement().

Referenced by gear::GearXML::createGearMgr().

void gear::TiXmlDocument::SetTabSize ( int _tabsize )

inline

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation