TinyXML class. See http://www.grinninglizard.com/tinyxml. More...

#include <tinyxml.h>

Inheritance diagram for TiXmlDocument:

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)

void	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) override

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

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

void	SetTabSize (int _tabsize)

int	TabSize () const

void	ClearError ()

void	Print () const

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

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

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

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

virtual bool	Accept (TiXmlVisitor *content) const override

Public Member Functions inherited from TiXmlNode
virtual	~TiXmlNode ()

const char *	Value () const

const std::string &	ValueStr () 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

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

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

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

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)

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

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

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

TiXmlElement *	NextSiblingElement ()

const TiXmlElement *	NextSiblingElement (const char *) const

TiXmlElement *	NextSiblingElement (const char *_next)

const TiXmlElement *	PreviousSiblingElement () const

TiXmlElement *	PreviousSiblingElement ()

const TiXmlElement *	PreviousSiblingElement (const char *) const

TiXmlElement *	PreviousSiblingElement (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...

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

int	Type () const

const TiXmlDocument *	GetDocument () const

TiXmlDocument *	GetDocument ()

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

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

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

Public Member Functions inherited from TiXmlBase
	TiXmlBase ()

virtual	~TiXmlBase ()

int	Row () const

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

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

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

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

Protected Member Functions
virtual TiXmlNode *	Clone () const override

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

Protected Member Functions inherited from TiXmlNode
	TiXmlNode (NodeType _type)

void	CopyTo (TiXmlNode *target) const

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

Private Member Functions
void	CopyTo (TiXmlDocument *target) const

Private Attributes
bool	error

int	errorId

TIXML_STRING	errorDesc

int	tabsize

TiXmlCursor	errorLocation

bool	useMicrosoftBOM

Additional Inherited Members
Public Types inherited from TiXmlNode
enum	NodeType { DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, DECLARATION, TYPECOUNT }

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

TinyXML class. See http://www.grinninglizard.com/tinyxml.

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.

See

See also: http://www.grinninglizard.com/tinyxml

Definition at line 1547 of file tinyxml.h.

Constructor & Destructor Documentation

◆ TiXmlDocument() [1/4]

TiXmlDocument::TiXmlDocument ( )

Create an empty document, that has no name.

Definition at line 913 of file tinyxml_inl.h.

◆ 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 920 of file tinyxml_inl.h.

◆ TiXmlDocument() [3/4]

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

Constructor.

◆ TiXmlDocument() [4/4]

TiXmlDocument::TiXmlDocument ( const TiXmlDocument & copy )

Definition at line 940 of file tinyxml_inl.h.

◆ ~TiXmlDocument()

virtual TiXmlDocument::~TiXmlDocument ( )

inlinevirtual

Definition at line 1562 of file tinyxml.h.

Member Function Documentation

◆ Accept()

bool TiXmlDocument::Accept ( TiXmlVisitor * content ) const

overridevirtual

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

Implements TiXmlNode.

Definition at line 1185 of file tinyxml_inl.h.

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

◆ Clone()

TiXmlNode * TiXmlDocument::Clone ( ) const

overrideprotectedvirtual

Create an exact duplicate of this node and return it. The memory must be deleted by the caller.

Implements TiXmlNode.

Definition at line 1163 of file tinyxml_inl.h.

◆ CopyTo()

void TiXmlDocument::CopyTo ( TiXmlDocument * target ) const

private

Definition at line 1148 of file tinyxml_inl.h.

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

◆ ErrorCol()

int TiXmlDocument::ErrorCol ( ) const

inline

The column where the error occured. See ErrorRow()

Definition at line 1648 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 1627 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 1634 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 1645 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 974 of file tinyxml_inl.h.

◆ 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 1586 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 1002 of file tinyxml_inl.h.

◆ 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 953 of file tinyxml_inl.h.

◆ operator=()

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

Definition at line 946 of file tinyxml_inl.h.

◆ Parse()

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

overridevirtual

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 733 of file tinyxmlparser_inl.h.

◆ Print() [1/2]

void TiXmlDocument::Print ( ) const

inline

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

Definition at line 1696 of file tinyxml.h.

◆ Print() [2/2]

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

overridevirtual

Print this Document to a FILE stream.

Implements TiXmlBase.

Definition at line 1174 of file tinyxml_inl.h.

◆ RootElement() [1/2]

TiXmlElement* TiXmlDocument::RootElement ( )

inline

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

◆ SaveFile() [1/4]

bool TiXmlDocument::SaveFile ( ) const

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

Definition at line 962 of file tinyxml_inl.h.

◆ SaveFile() [2/4]

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

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

Definition at line 1117 of file tinyxml_inl.h.

◆ SaveFile() [3/4]

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

inline

< STL std::string version.

Definition at line 1592 of file tinyxml.h.

◆ SaveFile() [4/4]

bool TiXmlDocument::SaveFile ( FILE * fp ) const

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

Definition at line 1131 of file tinyxml_inl.h.

◆ SetError()

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

Definition at line 827 of file tinyxmlparser_inl.h.

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

◆ StreamIn()

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

overrideprotectedvirtual

Implements TiXmlNode.

◆ TabSize()

int TiXmlDocument::TabSize ( ) const

inline

Definition at line 1680 of file tinyxml.h.

◆ ToDocument() [1/2]

virtual const TiXmlDocument* TiXmlDocument::ToDocument ( ) const

inlineoverridevirtual

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

Reimplemented from TiXmlNode.

Definition at line 1710 of file tinyxml.h.

◆ ToDocument() [2/2]

virtual TiXmlDocument* TiXmlDocument::ToDocument ( )

inlineoverridevirtual

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

Reimplemented from TiXmlNode.

Definition at line 1713 of file tinyxml.h.

Member Data Documentation

◆ error

bool TiXmlDocument::error

private

Definition at line 1731 of file tinyxml.h.

◆ errorDesc

TIXML_STRING TiXmlDocument::errorDesc

private

Definition at line 1732 of file tinyxml.h.

◆ errorId

int TiXmlDocument::errorId

private

Definition at line 1732 of file tinyxml.h.

◆ errorLocation

TiXmlCursor TiXmlDocument::errorLocation

private

Definition at line 1734 of file tinyxml.h.

◆ tabsize

int TiXmlDocument::tabsize

private

Definition at line 1733 of file tinyxml.h.

◆ useMicrosoftBOM

bool TiXmlDocument::useMicrosoftBOM

private

Definition at line 1735 of file tinyxml.h.

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

DDCore/include/XML/tinyxml.h
DDCore/src/XML/tinyxml_inl.h
DDCore/src/XML/tinyxmlparser_inl.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

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

◆ CopyTo()

◆ Error()

◆ ErrorCol()

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

◆ ToDocument() [1/2]

◆ ToDocument() [2/2]

Member Data Documentation

◆ error

◆ errorDesc

◆ errorId

◆ errorLocation

◆ tabsize

◆ useMicrosoftBOM