#include <tinyxml2.hpp>

Public Member Functions
	XMLDocument (bool processEntities=true)
	constructor More...

	~XMLDocument ()

virtual XMLDocument *	ToDocument ()
	Safely cast to a Document, or null. More...

virtual const XMLDocument *	ToDocument () const

int	parse (const char *xml)

int	loadFile (const char *filename)

int	loadFile (FILE *)

int	saveFile (const char *filename)

int	saveFile (FILE *)

bool	ProcessEntities () const

bool	HasBOM () const

void	SetBOM (bool useBOM)

XMLElement *	RootElement ()

const XMLElement *	RootElement () const

void	print (XMLPrinter *streamer=0)

virtual bool	accept (XMLVisitor *visitor) const

XMLElement *	newElement (const char *name)

XMLComment *	newComment (const char *comment)

XMLText *	newText (const char *text)

XMLDeclaration *	newDeclaration (const char *text=0)

XMLUnknown *	newUnknown (const char *text)

void	DeleteNode (XMLNode *node)

void	setError (int error, const char str1, const char str2)

bool	Error () const
	Return true if there was an error parsing the document. More...

int	ErrorID () const
	Return the errorID. More...

const char *	GetErrorStr1 () const
	Return a possibly helpful diagnostic location or string. More...

const char *	GetErrorStr2 () const
	Return a possibly helpful secondary diagnostic location or string. More...

void	printError () const
	If there is an error, print it to stdout. More...

char *	identify (char p, XMLNode *node)

virtual XMLNode *	shallowClone (XMLDocument *) const

virtual bool	shallowEqual (const XMLNode *) const

Public Member Functions inherited from tinyxml2::XMLNode
const XMLDocument *	GetDocument () const
	Get the XMLDocument that owns this XMLNode. More...

XMLDocument *	GetDocument ()
	Get the XMLDocument that owns this XMLNode. More...

virtual XMLElement *	ToElement ()
	Safely cast to an Element, or null. More...

virtual XMLText *	ToText ()
	Safely cast to Text, or null. More...

virtual XMLComment *	ToComment ()
	Safely cast to a Comment, or null. More...

virtual XMLDeclaration *	ToDeclaration ()
	Safely cast to a Declaration, or null. More...

virtual XMLUnknown *	ToUnknown ()
	Safely cast to an Unknown, or null. More...

virtual const XMLElement *	ToElement () const

virtual const XMLText *	ToText () const

virtual const XMLComment *	ToComment () const

virtual const XMLDeclaration *	ToDeclaration () const

virtual const XMLUnknown *	ToUnknown () const

const char *	Value () const

void	setValue (const char *val, bool staticMem=false)

const XMLNode *	Parent () const
	Get the parent of this node on the DOM. More...

XMLNode *	Parent ()

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

const XMLNode *	FirstChild () const
	Get the first child node, or null if none exists. More...

XMLNode *	FirstChild ()

const XMLElement *	firstChildElement (const char *value=0) const

XMLElement *	FirstChildElement (const char *_value=0)

const XMLNode *	LastChild () const
	Get the last child node, or null if none exists. More...

XMLNode *	LastChild ()

const XMLElement *	lastChildElement (const char *value=0) const

XMLElement *	LastChildElement (const char *_value=0)

const XMLNode *	PreviousSibling () const
	Get the previous (left) sibling node of this node. More...

XMLNode *	PreviousSibling ()

const XMLElement *	previousSiblingElement (const char *value=0) const
	Get the previous (left) sibling element of this node, with an opitionally supplied name. More...

XMLElement *	PreviousSiblingElement (const char *_value=0)

const XMLNode *	NextSibling () const
	Get the next (right) sibling node of this node. More...

XMLNode *	NextSibling ()

const XMLElement *	nextSiblingElement (const char *value=0) const
	Get the next (right) sibling element of this node, with an opitionally supplied name. More...

XMLElement *	NextSiblingElement (const char *_value=0)

XMLNode *	insertEndChild (XMLNode *addThis)

XMLNode *	LinkEndChild (XMLNode *addThis)

XMLNode *	insertFirstChild (XMLNode *addThis)

XMLNode *	insertAfterChild (XMLNode afterThis, XMLNode addThis)

void	deleteChildren ()

void	deleteChild (XMLNode *node)

virtual char *	parseDeep (char , StrPair )

Private Member Functions
	XMLDocument (const XMLDocument &)

void	operator= (const XMLDocument &)

void	initDocument ()

Private Attributes
bool	writeBOM

bool	processEntities

int	errorID

const char *	errorStr1

const char *	errorStr2

char *	charBuffer

MemPoolT< sizeof(XMLElement) >	elementPool

MemPoolT< sizeof(XMLAttribute) >	attributePool

MemPoolT< sizeof(XMLText) >	textPool

MemPoolT< sizeof(XMLComment) >	commentPool

Friends
class	XMLElement

Additional Inherited Members
Protected Member Functions inherited from tinyxml2::XMLNode
	XMLNode (XMLDocument *)

virtual	~XMLNode ()

	XMLNode (const XMLNode &)

XMLNode &	operator= (const XMLNode &)

Protected Attributes inherited from tinyxml2::XMLNode
XMLDocument *	document

XMLNode *	parent

StrPair	value

XMLNode *	firstChild

XMLNode *	lastChild

XMLNode *	prev

XMLNode *	next

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.

Constructor & Destructor Documentation

XMLDocument::XMLDocument ( bool processEntities = true )

constructor

XMLDocument::~XMLDocument ( )

tinyxml2::XMLDocument::XMLDocument ( const XMLDocument & )

private

Member Function Documentation

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

void tinyxml2::XMLDocument::DeleteNode ( XMLNode * node )

inline

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

bool tinyxml2::XMLDocument::Error ( ) const

inline

Return true if there was an error parsing the document.

int tinyxml2::XMLDocument::ErrorID ( ) const

inline

Return the errorID.

const char* tinyxml2::XMLDocument::GetErrorStr1 ( ) const

inline

Return a possibly helpful diagnostic location or string.

const char* tinyxml2::XMLDocument::GetErrorStr2 ( ) const

inline

Return a possibly helpful secondary diagnostic location or string.

bool tinyxml2::XMLDocument::HasBOM ( ) const

inline

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

char * XMLDocument::identify	(	char *	p,
		XMLNode **	node
	)

void XMLDocument::initDocument ( )

private

int XMLDocument::loadFile ( const char * filename )

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

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

XMLComment * XMLDocument::newComment ( const char * comment )

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

XMLDeclaration * 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"?>

XMLElement * XMLDocument::newElement ( const char * name )

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

XMLText * XMLDocument::newText ( const char * text )

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

XMLUnknown * XMLDocument::newUnknown ( const char * text )

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

void tinyxml2::XMLDocument::operator= ( const XMLDocument & )

private

int XMLDocument::parse ( const char * xml )

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

void 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

void XMLDocument::printError ( ) const

If there is an error, print it to stdout.

bool tinyxml2::XMLDocument::ProcessEntities ( ) const

inline

XMLElement* tinyxml2::XMLDocument::RootElement ( )

inline

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

const XMLElement* tinyxml2::XMLDocument::RootElement ( ) const

inline

int XMLDocument::saveFile ( const char * filename )

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

int XMLDocument::saveFile ( FILE * fp )

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.

void tinyxml2::XMLDocument::SetBOM ( bool useBOM )

inline

Sets whether to write the BOM when writing the file.

void XMLDocument::setError	(	int	error,
		const char *	str1,
		const char *	str2
	)

virtual XMLNode* tinyxml2::XMLDocument::shallowClone ( XMLDocument * document ) const

inlinevirtual

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.

virtual bool tinyxml2::XMLDocument::shallowEqual ( const XMLNode * compare ) const

inlinevirtual

Test if 2 nodes are the same, but don't test children. The 2 nodes do not need to be in the same Document.

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

Implements tinyxml2::XMLNode.

virtual XMLDocument* tinyxml2::XMLDocument::ToDocument ( )

inlinevirtual

Safely cast to a Document, or null.

Reimplemented from tinyxml2::XMLNode.

virtual const XMLDocument* tinyxml2::XMLDocument::ToDocument ( ) const

inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Friends And Related Function Documentation

friend class XMLElement

friend

Member Data Documentation

MemPoolT< sizeof(XMLAttribute) > tinyxml2::XMLDocument::attributePool

private

char* tinyxml2::XMLDocument::charBuffer

private

MemPoolT< sizeof(XMLComment) > tinyxml2::XMLDocument::commentPool

private

MemPoolT< sizeof(XMLElement) > tinyxml2::XMLDocument::elementPool

private

int tinyxml2::XMLDocument::errorID

private

const char* tinyxml2::XMLDocument::errorStr1

private

const char* tinyxml2::XMLDocument::errorStr2

private

bool tinyxml2::XMLDocument::processEntities

private

MemPoolT< sizeof(XMLText) > tinyxml2::XMLDocument::textPool

private

bool tinyxml2::XMLDocument::writeBOM

private

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

/home/johan/Documents/UNamur/VirtualBelgium/Workspace/VirtualBelgium/include/tinyxml2.hpp
/home/johan/Documents/UNamur/VirtualBelgium/Workspace/VirtualBelgium/src/tinyxml2.cpp

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation