#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLDocument:

Public Member Functions
virtual bool	Accept (XMLVisitor *visitor) const
void	DeleteNode (XMLNode *node)
bool	Error () const
	Return true if there was an error parsing the document.
XMLError	ErrorID () const
	Return the errorID.
const char *	GetErrorStr1 () const
	Return a possibly helpful diagnostic location or string.
const char *	GetErrorStr2 () const
	Return a possibly helpful secondary diagnostic location or string.
bool	HasBOM () const
char *	Identify (char p, XMLNode *node)
XMLError	LoadFile (const char *filename)
XMLError	LoadFile (FILE *)
XMLComment *	NewComment (const char *comment)
XMLDeclaration *	NewDeclaration (const char *text=0)
XMLElement *	NewElement (const char *name)
XMLText *	NewText (const char *text)
XMLUnknown *	NewUnknown (const char *text)
XMLError	Parse (const char *xml, size_t nBytes=(size_t)(-1))
void	Print (XMLPrinter *streamer=0)
void	PrintError () const
	If there is an error, print it to stdout.
bool	ProcessEntities () const
XMLElement *	RootElement ()
const XMLElement *	RootElement () const
XMLError	SaveFile (const char *filename, bool compact=false)
XMLError	SaveFile (FILE *fp, bool compact=false)
void	SetBOM (bool useBOM)
void	SetError (XMLError error, const char str1, const char str2)
virtual XMLNode *	ShallowClone (XMLDocument *) const
virtual bool	ShallowEqual (const XMLNode *) const
virtual XMLDocument *	ToDocument ()
	Safely cast to a Document, or null.
virtual const XMLDocument *	ToDocument () const
Whitespace	WhitespaceMode () const
	XMLDocument (bool processEntities=true, Whitespace=PRESERVE_WHITESPACE)
	constructor
	~XMLDocument ()
Private Member Functions
void	InitDocument ()
void	operator= (const XMLDocument &)
	XMLDocument (const XMLDocument &)
Private Attributes
MemPoolT< sizeof(XMLAttribute) >	_attributePool
char *	_charBuffer
MemPoolT< sizeof(XMLComment) >	_commentPool
MemPoolT< sizeof(XMLElement) >	_elementPool
XMLError	_errorID
const char *	_errorStr1
const char *	_errorStr2
bool	_processEntities
MemPoolT< sizeof(XMLText) >	_textPool
Whitespace	_whitespace
bool	_writeBOM
Friends
class	XMLElement

Detailed Description

A Document binds together all the functionality. It can be saved, loaded, and printed to the screen. All Nodes are connected and allocated to a Document. If the Document is deleted, all its Nodes are also deleted.

Definition at line 1357 of file tinyxml2.h.

Constructor & Destructor Documentation

tinyxml2::XMLDocument::XMLDocument	(	bool	processEntities = `true`,
		Whitespace	whitespace = `PRESERVE_WHITESPACE`
	)

constructor

Definition at line 1491 of file tinyxml2.cpp.

tinyxml2::XMLDocument::~XMLDocument ( )

Definition at line 1505 of file tinyxml2.cpp.

tinyxml2::XMLDocument::XMLDocument ( const XMLDocument & ) [private]

Member Function Documentation

bool tinyxml2::XMLDocument::Accept ( XMLVisitor * visitor ) const [virtual]

Accept a hierarchical visit of the nodes in the TinyXML DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the TiXmlVisitor interface.

This is essentially a SAX interface for TinyXML. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML is unchanged by using this interface versus any other.)

The interface has been based on ideas from:

Which are both good references for "visiting".

An example of using Accept():

    	TiXmlPrinter printer;
    	tinyxmlDoc.Accept( &printer );
    	const char* xmlcstr = printer.CStr();

Implements tinyxml2::XMLNode.

Definition at line 570 of file tinyxml2.cpp.

void tinyxml2::XMLDocument::DeleteNode ( XMLNode * node ) [inline]

Delete a node associated with this document. It will be unlinked from the DOM.

Definition at line 1503 of file tinyxml2.h.

bool tinyxml2::XMLDocument::Error ( ) const [inline]

Return true if there was an error parsing the document.

Definition at line 1510 of file tinyxml2.h.

XMLError tinyxml2::XMLDocument::ErrorID ( ) const [inline]

Return the errorID.

Definition at line 1514 of file tinyxml2.h.

const char* tinyxml2::XMLDocument::GetErrorStr1 ( ) const [inline]

Return a possibly helpful diagnostic location or string.

Definition at line 1518 of file tinyxml2.h.

const char* tinyxml2::XMLDocument::GetErrorStr2 ( ) const [inline]

Return a possibly helpful secondary diagnostic location or string.

Definition at line 1522 of file tinyxml2.h.

bool tinyxml2::XMLDocument::HasBOM ( ) const [inline]

Returns true if this document has a leading Byte Order Mark of UTF8.

Definition at line 1426 of file tinyxml2.h.

char * tinyxml2::XMLDocument::Identify	(	char *	p,
		XMLNode **	node
	)

Definition at line 495 of file tinyxml2.cpp.

void tinyxml2::XMLDocument::InitDocument ( ) [private]

Definition at line 1528 of file tinyxml2.cpp.

XMLError tinyxml2::XMLDocument::LoadFile ( const char * filename )

Load an XML file from disk. Returns XML_NO_ERROR (0) on success, or an errorID.

Definition at line 1584 of file tinyxml2.cpp.

XMLError tinyxml2::XMLDocument::LoadFile ( FILE * fp )

Load an XML file from disk. You are responsible for providing and closing the FILE*.

Returns XML_NO_ERROR (0) on success, or an errorID.

Definition at line 1606 of file tinyxml2.cpp.

XMLComment * tinyxml2::XMLDocument::NewComment ( const char * comment )

Create a new Comment associated with this Document. The memory for the Comment is managed by the Document.

Definition at line 1548 of file tinyxml2.cpp.

XMLDeclaration * tinyxml2::XMLDocument::NewDeclaration ( const char * text = 0 )

Create a new Declaration associated with this Document. The memory for the object is managed by the Document.

If the 'text' param is null, the standard declaration is used.:

    		<?xml version="1.0" encoding="UTF-8"?>

Definition at line 1566 of file tinyxml2.cpp.

XMLElement * tinyxml2::XMLDocument::NewElement ( const char * name )

Create a new Element associated with this Document. The memory for the Element is managed by the Document.

Definition at line 1539 of file tinyxml2.cpp.

XMLText * tinyxml2::XMLDocument::NewText ( const char * text )

Create a new Text associated with this Document. The memory for the Text is managed by the Document.

Definition at line 1557 of file tinyxml2.cpp.

XMLUnknown * tinyxml2::XMLDocument::NewUnknown ( const char * text )

Create a new Unknown associated with this Document. The memory forthe object is managed by the Document.

Definition at line 1575 of file tinyxml2.cpp.

void tinyxml2::XMLDocument::operator= ( const XMLDocument & ) [private]

XMLError tinyxml2::XMLDocument::Parse	(	const char *	xml,
		size_t	nBytes = `(size_t)(-1)`
	)

Parse an XML file from a character string. Returns XML_NO_ERROR (0) on success, or an errorID.

You may optionally pass in the 'nBytes', which is the number of bytes which will be parsed. If not specified, TinyXML will assume 'xml' points to a null terminated string.

Definition at line 1668 of file tinyxml2.cpp.

void tinyxml2::XMLDocument::Print ( XMLPrinter * streamer = 0 )

Print the Document. If the Printer is not provided, it will print to stdout. If you provide Printer, this can print to a file:

    	XMLPrinter printer( fp );
    	doc.Print( &printer );

Or you can use a printer to print to memory:

    	XMLPrinter printer;
    	doc->Print( &printer );
    	// printer.CStr() has a const char* to the XML

Definition at line 1696 of file tinyxml2.cpp.

void tinyxml2::XMLDocument::PrintError ( ) const

If there is an error, print it to stdout.

Definition at line 1714 of file tinyxml2.cpp.

bool tinyxml2::XMLDocument::ProcessEntities ( ) const [inline]

Definition at line 1416 of file tinyxml2.h.

XMLElement* tinyxml2::XMLDocument::RootElement ( ) [inline]

Return the root element of DOM. Equivalent to FirstChildElement(). To get the first node, use FirstChild().

Definition at line 1438 of file tinyxml2.h.

const XMLElement* tinyxml2::XMLDocument::RootElement ( ) const [inline]

Definition at line 1441 of file tinyxml2.h.

XMLError tinyxml2::XMLDocument::SaveFile	(	const char *	filename,
		bool	compact = `false`
	)

Save the XML file to disk. Returns XML_NO_ERROR (0) on success, or an errorID.

Definition at line 1641 of file tinyxml2.cpp.

XMLError tinyxml2::XMLDocument::SaveFile	(	FILE *	fp,
		bool	compact = `false`
	)

Save the XML file to disk. You are responsible for providing and closing the FILE*.

Returns XML_NO_ERROR (0) on success, or an errorID.

Definition at line 1660 of file tinyxml2.cpp.

void tinyxml2::XMLDocument::SetBOM ( bool useBOM ) [inline]

Sets whether to write the BOM when writing the file.

Definition at line 1431 of file tinyxml2.h.

void tinyxml2::XMLDocument::SetError	(	XMLError	error,
		const char *	str1,
		const char *	str2
	)

Definition at line 1706 of file tinyxml2.cpp.

virtual XMLNode* tinyxml2::XMLDocument::ShallowClone ( XMLDocument * document ) const [inline, virtual]

Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())

Note: if called on a XMLDocument, this will return null.

Implements tinyxml2::XMLNode.

Definition at line 1531 of file tinyxml2.h.

virtual bool tinyxml2::XMLDocument::ShallowEqual ( const XMLNode * compare ) const [inline, virtual]