#include <tinyxml.h>

Inheritance diagram for TiXmlDocument:

Collaboration diagram for TiXmlDocument:

[legend]

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)

TiXmlDocument &	operator= (const TiXmlDocument &copy)

virtual	~TiXmlDocument ()

bool	LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)

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

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

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

bool	LoadFile (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)

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

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

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

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

const TiXmlElement *	RootElement () const

TiXmlElement *	RootElement ()

bool	Error () const

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

int	ErrorId () const

int	ErrorRow () const

void	SetTabSize (int _tabsize)

int	TabSize () const

void	ClearError ()

void	Print () const

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

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

virtual bool	Accept (TiXmlVisitor *content) const

Public Member Functions inherited from TiXmlNode
	TiXmlNode (const TiXmlNode &)=delete

void	operator= (const TiXmlNode &base)=delete

virtual	~TiXmlNode ()

const char *	Value () const

const std::string &	ValueStr () const

const TIXML_STRING &	ValueTStr () const

void	SetValue (const char *_value)

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

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

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

const TiXmlNode *	Parent () const

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

const TiXmlNode *	LastChild () const

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

const TiXmlNode *	LastChild (const char *value) const

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

const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const

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)

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

TiXmlElement *	NextSiblingElement ()

const TiXmlElement *	NextSiblingElement (const char *) const

TiXmlElement *	NextSiblingElement (const char *_next)

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

TiXmlElement *	FirstChildElement ()

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

TiXmlElement *	FirstChildElement (const char *_value)

int	Type () const

const TiXmlDocument *	GetDocument () const

TiXmlDocument *	GetDocument ()

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

Public Member Functions inherited from TiXmlBase
	TiXmlBase (const TiXmlBase &)=delete

void	operator= (const TiXmlBase &base)=delete

	TiXmlBase ()

virtual	~TiXmlBase ()

int	Row () const

Protected Member Functions
virtual TiXmlNode *	Clone () const

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

Protected Member Functions inherited from TiXmlNode
	TiXmlNode (NodeType _type)

void	CopyTo (TiXmlNode *target) const

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

Additional Inherited Members
Public Types inherited from TiXmlNode
enum	NodeType { TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN, TINYXML_TEXT, TINYXML_DECLARATION, TINYXML_TYPECOUNT }

Public Types inherited from TiXmlBase
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 }

Static Public Member Functions inherited from TiXmlBase
static void	SetCondenseWhiteSpace (bool condense)

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

static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)

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

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

static bool	IsWhiteSpace (char c)

static bool	IsWhiteSpace (int c)

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

static bool	StreamTo (std::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 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 TiXmlNode
TiXmlNode *	parent

NodeType	type

TiXmlNode *	firstChild

TiXmlNode *	lastChild

TIXML_STRING	value

TiXmlNode *	prev

TiXmlNode *	next

Protected Attributes inherited from TiXmlBase
TiXmlCursor	location

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

Static Protected Attributes inherited from 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 1310 of file tinyxml.h.

Constructor & Destructor Documentation

◆ TiXmlDocument() [1/4]

TiXmlDocument::TiXmlDocument ( )

Create an empty document, that has no name.

Definition at line 716 of file tinyxml.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TiXmlDocument() [2/4]

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 723 of file tinyxml.cpp.

Here is the call graph for this function:

◆ TiXmlDocument() [3/4]

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

Constructor.

Definition at line 733 of file tinyxml.cpp.

Here is the call graph for this function:

◆ TiXmlDocument() [4/4]

TiXmlDocument::TiXmlDocument ( const TiXmlDocument & copy )

Definition at line 743 of file tinyxml.cpp.

◆ ~TiXmlDocument()

virtual TiXmlDocument::~TiXmlDocument ( )

inlinevirtual

Definition at line 1326 of file tinyxml.h.

Member Function Documentation

◆ Accept()

bool TiXmlDocument::Accept ( TiXmlVisitor * content ) const

virtual

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

Implements TiXmlNode.

Definition at line 959 of file tinyxml.cpp.

Here is the call graph for this function:

◆ ClearError()

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

Here is the caller graph for this function:

◆ Clone()

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 937 of file tinyxml.cpp.

Here is the call graph for this function:

◆ Error()

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

Here is the caller graph for this function:

◆ ErrorDesc()

const char* TiXmlDocument::ErrorDesc ( ) const

inline

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

Definition at line 1380 of file tinyxml.h.

Here is the caller graph for this function:

◆ ErrorId()

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

◆ ErrorRow()

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

◆ LoadFile() [1/4]

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 768 of file tinyxml.cpp.

Here is the call graph for this function:

◆ LoadFile() [2/4]

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

inline

Parameters

encoding STL std::string version.

Definition at line 1349 of file tinyxml.h.

◆ LoadFile() [3/4]

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 789 of file tinyxml.cpp.

Here is the call graph for this function:

◆ LoadFile() [4/4]

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 757 of file tinyxml.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

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

Definition at line 749 of file tinyxml.cpp.

Here is the call graph for this function:

◆ Parse()

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.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Print() [1/2]

void TiXmlDocument::Print ( ) const

inline

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

Definition at line 1436 of file tinyxml.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Print() [2/2]

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

virtual

Print this Document to a FILE stream.

Implements TiXmlBase.

Definition at line 948 of file tinyxml.cpp.

Here is the call graph for this function:

◆ RootElement() [1/2]

TiXmlElement* TiXmlDocument::RootElement ( )

inline

Definition at line 1370 of file tinyxml.h.

Here is the call graph for this function:

◆ RootElement() [2/2]

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

Here is the call graph for this function:

◆ SaveFile() [1/4]

bool TiXmlDocument::SaveFile ( ) const

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

Definition at line 763 of file tinyxml.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveFile() [2/4]

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

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

Definition at line 887 of file tinyxml.cpp.

Here is the call graph for this function:

◆ SaveFile() [3/4]

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

inline

< STL std::string version.

Definition at line 1353 of file tinyxml.h.

Here is the call graph for this function:

◆ SaveFile() [4/4]

bool TiXmlDocument::SaveFile ( FILE * fp ) const

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

Definition at line 901 of file tinyxml.cpp.

Here is the call graph for this function:

◆ SetError()

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

Definition at line 802 of file tinyxmlparser.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTabSize()

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

Here is the caller graph for this function:

◆ StreamIn()

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

protectedvirtual

Implements TiXmlNode.

Definition at line 645 of file tinyxmlparser.cpp.

Here is the call graph for this function:

◆ TabSize()

int TiXmlDocument::TabSize ( ) const

inline

Definition at line 1423 of file tinyxml.h.

Here is the caller graph for this function:

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

src/framework/xml/tinyxml.h
src/framework/xml/tinyxml.cpp
src/framework/xml/tinyxmlparser.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TiXmlDocument() [1/4]

◆ TiXmlDocument() [2/4]

◆ TiXmlDocument() [3/4]

◆ TiXmlDocument() [4/4]

◆ ~TiXmlDocument()

Member Function Documentation

◆ Accept()

◆ ClearError()

◆ Clone()

◆ Error()

◆ ErrorDesc()

◆ ErrorId()

◆ ErrorRow()

◆ LoadFile() [1/4]

◆ LoadFile() [2/4]

◆ LoadFile() [3/4]

◆ LoadFile() [4/4]

◆ operator=()

◆ Parse()

◆ Print() [1/2]

◆ Print() [2/2]

◆ RootElement() [1/2]

◆ RootElement() [2/2]

◆ SaveFile() [1/4]

◆ SaveFile() [2/4]

◆ SaveFile() [3/4]

◆ SaveFile() [4/4]

◆ SetError()

◆ SetTabSize()

◆ StreamIn()

◆ TabSize()