TiXmlDocument Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlDocument:

Collaboration diagram for TiXmlDocument:

List of all members.

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

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 (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)

bool SaveFile (FILE *) const

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

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.

int ErrorId () const

int ErrorRow ()

int ErrorCol ()

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

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.

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

virtual const TiXmlDocument * ToDocument () const

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

virtual TiXmlDocument * ToDocument ()

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

Protected Member Functions

virtual void StreamOut (TIXML_OSTREAM *out) const

virtual TiXmlNode * Clone () const

Private Member Functions

void CopyTo (TiXmlDocument *target) const

Private Attributes

bool error

int errorId

TIXML_STRING errorDesc

int tabsize

TiXmlCursor errorLocation

bool useMicrosoftBOM

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

Constructor & Destructor Documentation

TiXmlDocument::TiXmlDocument ( )

Create an empty document, that has no name.

Definition at line 941 of file tinyxml.cpp.

References ClearError(), tabsize, and useMicrosoftBOM.

Referenced by Clone().

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

References ClearError(), tabsize, useMicrosoftBOM, and TiXmlNode::value.

TiXmlDocument::TiXmlDocument ( const TiXmlDocument & copy )

Definition at line 968 of file tinyxml.cpp.

References CopyTo().

virtual TiXmlDocument::~TiXmlDocument ( ) [inline, virtual]

Definition at line 1235 of file tinyxml.h.

Member Function Documentation

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

Definition at line 974 of file tinyxml.cpp.

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

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

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

Referenced by LoadFile(), and Lugre::LuaXML_ParseFile().

bool TiXmlDocument::SaveFile ( ) const

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

Definition at line 993 of file tinyxml.cpp.

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

Referenced by Lugre::LuaXML_SaveFile(), and SaveFile().

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

References LoadFile(), SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_OPENING_FILE, and TiXmlNode::value.

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

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

Definition at line 1146 of file tinyxml.cpp.

References SaveFile().

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

References assert, TiXmlCursor::Clear(), TiXmlNode::Clear(), Error(), TiXmlBase::location, Parse(), SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_EMPTY, TiXmlBase::TIXML_ERROR_OPENING_FILE, and TIXML_STRING.

bool TiXmlDocument::SaveFile ( FILE * fp ) const

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

Definition at line 1160 of file tinyxml.cpp.

References Print(), TIXML_UTF_LEAD_0, TIXML_UTF_LEAD_1, TIXML_UTF_LEAD_2, and useMicrosoftBOM.

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

References assert, TiXmlCursor::Clear(), ClearError(), TiXmlCursor::col, TiXmlParsingData::Cursor(), TiXmlParsingData::cursor, TiXmlDeclaration::Encoding(), TiXmlNode::firstChild, 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, TIXML_UTF_LEAD_0, TIXML_UTF_LEAD_1, TIXML_UTF_LEAD_2, TiXmlNode::ToDeclaration(), and useMicrosoftBOM.

Referenced by LoadFile(), and Lugre::LuaXML_ParseString().

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

References TiXmlNode::FirstChildElement().

TiXmlElement* TiXmlDocument::RootElement ( ) [inline]

Definition at line 1281 of file tinyxml.h.

References TiXmlNode::FirstChildElement().

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

References error.

Referenced by LoadFile().

const char* TiXmlDocument::ErrorDesc ( ) const [inline]

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

Definition at line 1291 of file tinyxml.h.

References errorDesc.

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

References errorId.

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

Definition at line 1305 of file tinyxml.h.

References errorLocation, and TiXmlCursor::row.

int TiXmlDocument::ErrorCol ( ) [inline]

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

Definition at line 1306 of file tinyxml.h.

References TiXmlCursor::col, and errorLocation.

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

References tabsize.

int TiXmlDocument::TabSize ( ) const [inline]

Definition at line 1334 of file tinyxml.h.

References tabsize.

Referenced by TiXmlAttribute::Parse(), and Parse().

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

References TiXmlCursor::col, error, errorDesc, errorId, errorLocation, and TiXmlCursor::row.

Referenced by Parse(), and TiXmlDocument().

void TiXmlDocument::Print ( ) const [inline]

Dump the document to standard out.

Definition at line 1347 of file tinyxml.h.

Referenced by SaveFile().

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

Print this Document to a FILE stream.

Implements TiXmlBase.

Definition at line 1203 of file tinyxml.cpp.

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

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

Definition at line 783 of file tinyxmlparser.cpp.

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

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

virtual const TiXmlDocument* TiXmlDocument::ToDocument ( ) const [inline, virtual]

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

Reimplemented from TiXmlNode.

Definition at line 1354 of file tinyxml.h.

virtual TiXmlDocument* TiXmlDocument::ToDocument ( ) [inline, virtual]

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

Reimplemented from TiXmlNode.

Definition at line 1355 of file tinyxml.h.

void TiXmlDocument::StreamOut ( TIXML_OSTREAM * out ) const [protected, virtual]

Implements TiXmlBase.

Definition at line 1213 of file tinyxml.cpp.

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

TiXmlNode * TiXmlDocument::Clone ( ) const [protected, virtual]

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

Implements TiXmlNode.

Definition at line 1192 of file tinyxml.cpp.

References CopyTo(), and TiXmlDocument().

void TiXmlDocument::CopyTo ( TiXmlDocument * target ) const [private]

Definition at line 1177 of file tinyxml.cpp.

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

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

Member Data Documentation

bool TiXmlDocument::error [private]

Definition at line 1368 of file tinyxml.h.

Referenced by ClearError(), CopyTo(), Error(), and SetError().

int TiXmlDocument::errorId [private]

Definition at line 1369 of file tinyxml.h.

Referenced by ClearError(), ErrorId(), and SetError().

TIXML_STRING TiXmlDocument::errorDesc [private]

Definition at line 1370 of file tinyxml.h.

Referenced by ClearError(), CopyTo(), ErrorDesc(), and SetError().

int TiXmlDocument::tabsize [private]

Definition at line 1371 of file tinyxml.h.

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

TiXmlCursor TiXmlDocument::errorLocation [private]

Definition at line 1372 of file tinyxml.h.

Referenced by ClearError(), ErrorCol(), ErrorRow(), and SetError().

bool TiXmlDocument::useMicrosoftBOM [private]

Definition at line 1373 of file tinyxml.h.

Referenced by Parse(), SaveFile(), and TiXmlDocument().

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

/var/www/sfz/trunk/lugre/include/tinyxml.h
/var/www/sfz/trunk/lugre/src/tinyxml.cpp
/var/www/sfz/trunk/lugre/src/tinyxmlparser.cpp


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 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.
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 (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
bool	SaveFile (FILE *) const
	Save a file using the given FILE*. Returns true if successful.
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.
int	ErrorId () const
int	ErrorRow ()
int	ErrorCol ()
	The column where the error occured. See ErrorRow().
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.
void	SetError (int err, const char errorLocation, TiXmlParsingData prevData, TiXmlEncoding encoding)
virtual const TiXmlDocument *	ToDocument () const
	Cast to a more defined type. Will return null not of the requested type.
virtual TiXmlDocument *	ToDocument ()
	Cast to a more defined type. Will return null not of the requested type.
Protected Member Functions
virtual void	StreamOut (TIXML_OSTREAM *out) const
virtual TiXmlNode *	Clone () const
Private Member Functions
void	CopyTo (TiXmlDocument *target) const
Private Attributes
bool	error
int	errorId
TIXML_STRING	errorDesc
int	tabsize
TiXmlCursor	errorLocation
bool	useMicrosoftBOM