A Document binds together all the functionality. More...

#include <tinyxml2.h>

Inheritance diagram for XMLDocument:

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

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

virtual const XMLDocument *	ToDocument () const
XMLError	Parse (const char *xml, size_t nBytes=(size_t)(-1))
	Parse an XML file from a character string. More...

XMLError	LoadFile (const char *filename)
	Load an XML file from disk. More...

XMLError	LoadFile (FILE *)
	Load an XML file from disk. More...

XMLError	SaveFile (const char *filename, bool compact=false)
	Save the XML file to disk. More...

XMLError	SaveFile (FILE *fp, bool compact=false)
	Save the XML file to disk. More...

bool	ProcessEntities () const
Whitespace	WhitespaceMode () const
bool	HasBOM () const
	Returns true if this document has a leading Byte Order Mark of UTF8. More...

void	SetBOM (bool useBOM)
	Sets whether to write the BOM when writing the file. More...

XMLElement *	RootElement ()
	Return the root element of DOM. More...

const XMLElement *	RootElement () const
void	Print (XMLPrinter *streamer=0)
	Print the Document. More...

virtual bool	Accept (XMLVisitor *visitor) const
	Accept a hierarchical visit of the nodes in the TinyXML DOM. More...

XMLElement *	NewElement (const char *name)
	Create a new Element associated with this Document. More...

XMLComment *	NewComment (const char *comment)
	Create a new Comment associated with this Document. More...

XMLText *	NewText (const char *text)
	Create a new Text associated with this Document. More...

XMLDeclaration *	NewDeclaration (const char *text=0)
	Create a new Declaration associated with this Document. More...

XMLUnknown *	NewUnknown (const char *text)
	Create a new Unknown associated with this Document. More...

void	DeleteNode (XMLNode *node)
	Delete a node associated with this document. More...

void	SetError (XMLError error, const char str1, const char str2)
bool	Error () const
	Return true if there was an error parsing the document. More...

XMLError	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
	Make a copy of this node, but not its children. More...

virtual bool	ShallowEqual (const XMLNode *) const
	Test if 2 nodes are the same, but don't test children. More...

Public Member Functions inherited from 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
	The meaning of 'value' changes for the specific type. More...

void	SetValue (const char *val, bool staticMem=false)
	Set the Value of an XML node. More...

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
	Get the first child element, or optionally the first child element with the specified name. More...

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
	Get the last child element or optionally the last child element with the specified name. More...

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)
	Add a child node as the last (right) child. More...

XMLNode *	LinkEndChild (XMLNode *addThis)
XMLNode *	InsertFirstChild (XMLNode *addThis)
	Add a child node as the first (left) child. More...

XMLNode *	InsertAfterChild (XMLNode afterThis, XMLNode addThis)
	Add a node after the specified child node. More...

void	DeleteChildren ()
	Delete all the children of this node. More...

void	DeleteChild (XMLNode *node)
	Delete a child of this node. More...

virtual char *	ParseDeep (char , StrPair )

Friends
class	XMLElement

Additional Inherited Members
Protected Member Functions inherited from XMLNode
	XMLNode (XMLDocument *)
virtual	~XMLNode ()
	XMLNode (const XMLNode &)
XMLNode &	operator= (const XMLNode &)
Protected Attributes inherited from 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	(	bool	processEntities = `true`,
		Whitespace	= `PRESERVE_WHITESPACE`
	)

constructor

~XMLDocument ( )

Member Function Documentation

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

void DeleteNode ( XMLNode * node)

inline

Delete a node associated with this document.

It will be unlinked from the DOM.

bool Error ( ) const

inline

Return true if there was an error parsing the document.

XMLError ErrorID ( ) const

inline

Return the errorID.

const char* GetErrorStr1 ( ) const

inline

Return a possibly helpful diagnostic location or string.

const char* GetErrorStr2 ( ) const

inline

Return a possibly helpful secondary diagnostic location or string.

bool HasBOM ( ) const

inline

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

char* Identify	(	char *	p,
		XMLNode **	node
	)

XMLError LoadFile ( const char * filename)

Load an XML file from disk.

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

XMLError LoadFile ( FILE * )

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* NewComment ( const char * comment)

Create a new Comment associated with this Document.

The memory for the Comment is managed by the Document.

XMLDeclaration* 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* NewElement ( const char * name)

Create a new Element associated with this Document.

The memory for the Element is managed by the Document.

XMLText* NewText ( const char * text)

Create a new Text associated with this Document.

The memory for the Text is managed by the Document.

XMLUnknown* NewUnknown ( const char * text)

Create a new Unknown associated with this Document.

The memory forthe object is managed by the Document.

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

void 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 PrintError ( ) const

If there is an error, print it to stdout.

bool ProcessEntities ( ) const

inline

XMLElement* RootElement ( )

inline

Return the root element of DOM.

Equivalent to FirstChildElement(). To get the first node, use FirstChild().

const XMLElement* RootElement ( ) const

inline

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

Save the XML file to disk.

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

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

void SetBOM ( bool useBOM)

inline

Sets whether to write the BOM when writing the file.

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

virtual XMLNode* 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 XMLNode.

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

virtual XMLDocument* ToDocument ( )

inlinevirtual

Safely cast to a Document, or null.

Reimplemented from XMLNode.

virtual const XMLDocument*
ToDocument ( ) const

inlinevirtual

Reimplemented from XMLNode.

Whitespace WhitespaceMode ( ) const

inline

Friends And Related Function Documentation

friend class XMLElement

friend

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

/Users/cocos2d/MyWork/cocos2d-x/cocos2dx/support/tinyxml2/tinyxml2.h

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation