#include <tinyxml.h>

Inheritance diagram for TiXmlDocument:

Public Member Functions
virtual bool	Accept (TiXmlVisitor *content) const

void	ClearError ()

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

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)

bool	LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)

TiXmlDocument &	operator= (const TiXmlDocument &copy)

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

void	Print () const

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

TiXmlElement *	RootElement ()

const TiXmlElement *	RootElement () const

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

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

void	SetTabSize (int _tabsize)

int	TabSize () const

	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 TiXmlDocument &copy)

virtual	~TiXmlDocument ()

Public Member Functions inherited from TiXmlNode
void	Clear ()
	Delete all the children of this node. Does not affect 'this'. More...

TiXmlNode *	FirstChild ()

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 char *value) const

TiXmlElement *	FirstChildElement ()

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

TiXmlElement *	FirstChildElement (const char *_value)

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

TiXmlDocument *	GetDocument ()

const TiXmlDocument *	GetDocument () const

TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)

TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)

TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)

TiXmlNode *	IterateChildren (const char _value, 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 TiXmlNode *previous)

const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const

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

const TiXmlNode *	LastChild () 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 char *value) const

TiXmlNode *	LinkEndChild (TiXmlNode *addThis)

TiXmlNode *	NextSibling ()

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

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

TiXmlNode *	NextSibling (const char *_next)

TiXmlElement *	NextSiblingElement ()

const TiXmlElement *	NextSiblingElement () const

const TiXmlElement *	NextSiblingElement (const char *) const

TiXmlElement *	NextSiblingElement (const char *_next)

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

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

const TiXmlNode *	Parent () const

TiXmlNode *	PreviousSibling ()

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

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

TiXmlNode *	PreviousSibling (const char *_prev)

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

TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)

void	SetValue (const char *_value)

int	Type () const

const char *	Value () const

const TIXML_STRING &	ValueTStr () const

virtual	~TiXmlNode ()

Public Member Functions inherited from TiXmlBase
int	Row () const

	TiXmlBase ()

virtual	~TiXmlBase ()

Protected Member Functions
virtual TiXmlNode *	Clone () const

Protected Member Functions inherited from TiXmlNode
void	CopyTo (TiXmlNode *target) const

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

	TiXmlNode (NodeType _type)

Private Member Functions
void	CopyTo (TiXmlDocument *target) const

Private Attributes
bool	error

TIXML_STRING	errorDesc

int	errorId

TiXmlCursor	errorLocation

int	tabsize

bool	useMicrosoftBOM

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	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)

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

static void	SetCondenseWhiteSpace (bool condense)

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

Static Protected Member Functions inherited from TiXmlBase
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, 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 *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)

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

static int	ToLower (int v, TiXmlEncoding encoding)

Protected Attributes inherited from TiXmlNode
TiXmlNode *	firstChild

TiXmlNode *	lastChild

TiXmlNode *	next

TiXmlNode *	parent

TiXmlNode *	prev

NodeType	type

TIXML_STRING	value

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

Constructor & Destructor Documentation

◆ TiXmlDocument() [1/3]

TiXmlDocument::TiXmlDocument ( )

Create an empty document, that has no name.

Definition at line 913 of file tinyxml.cpp.

◆ TiXmlDocument() [2/3]

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

◆ TiXmlDocument() [3/3]

TiXmlDocument::TiXmlDocument ( const TiXmlDocument & copy )

Definition at line 940 of file tinyxml.cpp.

◆ ~TiXmlDocument()

virtual TiXmlDocument::~TiXmlDocument ( )

inlinevirtual

Definition at line 1610 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 1156 of file tinyxml.cpp.

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

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

◆ CopyTo()

void TiXmlDocument::CopyTo ( TiXmlDocument * target ) const

private

Definition at line 1115 of file tinyxml.cpp.

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

◆ ErrorDesc()

const char* TiXmlDocument::ErrorDesc ( ) const

inline

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

Definition at line 1674 of file tinyxml.h.

◆ 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 1680 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 1690 of file tinyxml.h.

◆ LoadFile() [1/3]

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

◆ LoadFile() [2/3]

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

◆ LoadFile() [3/3]

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

◆ operator=()

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

Definition at line 946 of file tinyxml.cpp.

◆ 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 704 of file tinyxmlparser.cpp.

◆ Print() [1/2]

void TiXmlDocument::Print ( ) const

inline

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

Definition at line 1739 of file tinyxml.h.

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

◆ RootElement() [1/2]

TiXmlElement* TiXmlDocument::RootElement ( )

inline

Definition at line 1662 of file tinyxml.h.

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

◆ SaveFile() [1/3]

bool TiXmlDocument::SaveFile ( ) const

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

Definition at line 960 of file tinyxml.cpp.

◆ SaveFile() [2/3]

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

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

Definition at line 1084 of file tinyxml.cpp.

◆ SaveFile() [3/3]

bool TiXmlDocument::SaveFile ( FILE * fp ) const

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

Definition at line 1098 of file tinyxml.cpp.

◆ SetError()

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

Definition at line 798 of file tinyxmlparser.cpp.

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

◆ TabSize()

int TiXmlDocument::TabSize ( ) const

inline

Definition at line 1723 of file tinyxml.h.

Member Data Documentation

◆ error

bool TiXmlDocument::error

private

Definition at line 1774 of file tinyxml.h.

◆ errorDesc

TIXML_STRING TiXmlDocument::errorDesc

private

Definition at line 1776 of file tinyxml.h.

◆ errorId

int TiXmlDocument::errorId

private

Definition at line 1775 of file tinyxml.h.

◆ errorLocation

TiXmlCursor TiXmlDocument::errorLocation

private

Definition at line 1778 of file tinyxml.h.

◆ tabsize

int TiXmlDocument::tabsize

private

Definition at line 1777 of file tinyxml.h.

◆ useMicrosoftBOM

bool TiXmlDocument::useMicrosoftBOM

private

Definition at line 1779 of file tinyxml.h.

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TiXmlDocument() [1/3]

◆ TiXmlDocument() [2/3]

◆ TiXmlDocument() [3/3]

◆ ~TiXmlDocument()

Member Function Documentation

◆ Accept()

◆ ClearError()

◆ Clone()

◆ CopyTo()

◆ Error()

◆ ErrorDesc()

◆ ErrorId()

◆ ErrorRow()

◆ LoadFile() [1/3]

◆ LoadFile() [2/3]

◆ LoadFile() [3/3]

◆ operator=()

◆ Parse()

◆ Print() [1/2]

◆ Print() [2/2]

◆ RootElement() [1/2]

◆ RootElement() [2/2]

◆ SaveFile() [1/3]

◆ SaveFile() [2/3]

◆ SaveFile() [3/3]

◆ SetError()

◆ SetTabSize()

◆ TabSize()

Member Data Documentation

◆ error

◆ errorDesc

◆ errorId

◆ errorLocation

◆ tabsize

◆ useMicrosoftBOM