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

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

TiXmlElement *	RootElement () const

bool	Error () const

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

const int	ErrorId () const

int	ErrorRow ()

int	ErrorCol ()
	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
	Print this Document to a FILE stream. More...

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

Public Member Functions inherited from TiXmlNode
virtual	~TiXmlNode ()

const char *	Value () const

void	SetValue (const char *_value)

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

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

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

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

TiXmlNode *	LastChild () const

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

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

TiXmlNode *	IterateChildren (const char value, TiXmlNode previous) const
	This flavor of IterateChildren searches for children with a particular 'value'. 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...

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

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

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

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

TiXmlElement *	NextSiblingElement () const

TiXmlElement *	NextSiblingElement (const char *) const

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

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

virtual int	Type () const

TiXmlDocument *	GetDocument () const

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

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

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

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

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

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

TiXmlDeclaration *	ToDeclaration () const
	Cast to a more defined type. Will return null 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)

void *	GetUserData ()

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

virtual TiXmlNode *	Clone () const

Protected Member Functions inherited from TiXmlNode
	TiXmlNode (NodeType _type)

void	CopyTo (TiXmlNode *target) const

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

const TiXmlString &	SValue () const

Private Member Functions
void	CopyTo (TiXmlDocument *target) const

Private Attributes
bool	error

int	errorId

TiXmlString	errorDesc

int	tabsize

TiXmlCursor	errorLocation

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

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]

Protected 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_STRING_COUNT }

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

static bool	IsWhiteSpace (char c)

static const char *	ReadName (const char p, TiXmlString name, TiXmlEncoding encoding)

static const char *	ReadText (const char in, TiXmlString 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 TiXmlString &str, TiXmlOutStream *out)

static void	PutString (const TiXmlString &str, TiXmlString *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

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

Constructor & Destructor Documentation

◆ TiXmlDocument() [1/3]

TiXmlDocument::TiXmlDocument ( )

Create an empty document, that has no name.

References ClearError(), and tabsize.

Referenced by Clone(), and TiXmlDocument().

Here is the call graph for this function:

Here is the caller graph for this function:

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

References ClearError(), TiXmlNode::DOCUMENT, tabsize, TiXmlDocument(), TiXmlNode::TiXmlNode(), and TiXmlNode::value.

Here is the call graph for this function:

◆ TiXmlDocument() [3/3]

TiXmlDocument::TiXmlDocument ( const TiXmlDocument & copy )

References CopyTo().

Here is the call graph for this function:

◆ ~TiXmlDocument()

virtual TiXmlDocument::~TiXmlDocument ( )

inlinevirtual

References TiXmlBase::StringToBuffer::buffer, and TIXML_DEFAULT_ENCODING.

Member Function Documentation

◆ operator=()

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

References TiXmlNode::Clear(), and CopyTo().

Here is the call graph for this function:

◆ LoadFile() [1/2]

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.

References TiXmlBase::StringToBuffer::buffer, and TiXmlNode::value.

◆ SaveFile() [1/2]

bool TiXmlDocument::SaveFile ( ) const

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

References TiXmlBase::StringToBuffer::buffer, and TiXmlNode::value.

◆ LoadFile() [2/2]

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

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

References TiXmlString::c_str(), TiXmlCursor::Clear(), TiXmlNode::Clear(), Error(), TiXmlBase::location, Parse(), SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_OPENING_FILE, TIXML_STRING, and TiXmlNode::value.

Here is the call graph for this function:

◆ SaveFile() [2/2]

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

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

References Print().

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.

References TiXmlCursor::Clear(), ClearError(), TiXmlCursor::col, TiXmlParsingData::Cursor(), TiXmlParsingData::cursor, TiXmlDeclaration::Encoding(), TiXmlNode::Identify(), TiXmlNode::LinkEndChild(), TiXmlBase::location, TiXmlBase::Parse(), TiXmlCursor::row, SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlBase::StringEqual(), TabSize(), TIXML_ENCODING_LEGACY, TIXML_ENCODING_UNKNOWN, TIXML_ENCODING_UTF8, TiXmlBase::TIXML_ERROR_DOCUMENT_EMPTY, and TiXmlNode::ToDeclaration().

Referenced by LoadFile(), and CConcXml::LoadXmlAndReadBibliography().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RootElement()

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.

Referenced by CBiblIndex::GetTextAreaElements(), and ReadXmlField().

Here is the caller 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)

Referenced by LoadFile(), and CConcXml::LoadXmlAndReadBibliography().

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.

Referenced by CConcXml::LoadXmlAndReadBibliography().

Here is the caller graph for this function:

◆ ErrorId()

const int TiXmlDocument::ErrorId ( ) const

inline

Generally, you probably want the error string ( ErrorDesc() ). But if you prefer the ErrorId, this function will fetch it.

◆ ErrorRow()

int 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

Referenced by CConcXml::LoadXmlAndReadBibliography().

Here is the caller graph for this function:

◆ ErrorCol()

int TiXmlDocument::ErrorCol ( )

inline

The column where the error occured. See ErrorRow()

Referenced by CConcXml::LoadXmlAndReadBibliography().

Here is the caller graph for this function:

◆ SetTabSize()

void 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

◆ TabSize()

int TiXmlDocument::TabSize ( ) const

inline

Referenced by Parse().

Here is the caller 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.

Referenced by Parse(), and TiXmlDocument().

Here is the caller graph for this function:

◆ Print() [1/2]

void TiXmlDocument::Print ( ) const

inline

Dump the document to standard out.

References Print(), TIXML_OSTREAM, and TIXML_STRING.

Referenced by Print(), SaveFile(), and TiXmlBase::~TiXmlBase().

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.

References TiXmlNode::FirstChild(), TiXmlNode::NextSibling(), and TiXmlBase::Print().

Here is the call graph for this function:

◆ SetError()

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

References TiXmlCursor::Clear(), TiXmlParsingData::Cursor(), error, errorDesc, errorId, errorLocation, TiXmlBase::errorString, TiXmlParsingData::Stamp(), and TiXmlBase::TIXML_ERROR_STRING_COUNT.

Referenced by TiXmlNode::Identify(), LoadFile(), TiXmlAttribute::Parse(), TiXmlElement::Parse(), TiXmlComment::Parse(), TiXmlText::Parse(), TiXmlDeclaration::Parse(), TiXmlUnknown::Parse(), Parse(), TiXmlBase::ReadText(), TiXmlElement::ReadValue(), and TiXmlElement::SetAttribute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StreamOut()

void TiXmlDocument::StreamOut ( TiXmlOutStream * out ) const

protectedvirtual

Implements TiXmlBase.

References TiXmlNode::FirstChild(), TiXmlNode::NextSibling(), TiXmlBase::StreamOut(), and TiXmlNode::ToElement().

Here is the call 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.

References CopyTo(), and TiXmlDocument().

Here is the call graph for this function:

◆ CopyTo()

void TiXmlDocument::CopyTo ( TiXmlDocument * target ) const

private

References TiXmlString::c_str(), TiXmlNode::Clone(), TiXmlNode::CopyTo(), error, errorDesc, TiXmlNode::firstChild, TiXmlNode::LinkEndChild(), and TiXmlNode::NextSibling().

Referenced by Clone(), operator=(), and TiXmlDocument().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ error

bool TiXmlDocument::error

private

Referenced by CopyTo(), and SetError().

◆ errorId

int TiXmlDocument::errorId

private

Referenced by SetError().

◆ errorDesc

TiXmlString TiXmlDocument::errorDesc

private

Referenced by CopyTo(), and SetError().

◆ tabsize

int TiXmlDocument::tabsize

private

Referenced by TiXmlAttribute::Parse(), TiXmlParsingData::Stamp(), TiXmlDocument(), and TiXmlParsingData::TiXmlParsingData().

◆ errorLocation

TiXmlCursor TiXmlDocument::errorLocation

private

Referenced by SetError().

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

◆ operator=()

◆ LoadFile() [1/2]

◆ SaveFile() [1/2]

◆ LoadFile() [2/2]

◆ SaveFile() [2/2]

◆ Parse()

◆ RootElement()

◆ Error()

◆ ErrorDesc()

◆ ErrorId()

◆ ErrorRow()

◆ ErrorCol()

◆ SetTabSize()

◆ TabSize()

◆ ClearError()

◆ Print() [1/2]

◆ Print() [2/2]

◆ SetError()

◆ StreamOut()

◆ Clone()

◆ CopyTo()

Member Data Documentation

◆ error

◆ errorId

◆ errorDesc

◆ tabsize

◆ errorLocation