tinyxml2::XMLDocument Class Reference

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLDocument:

Public Member Functions
	XMLDocument (bool processEntities=true, Whitespace=PRESERVE_WHITESPACE)
	constructor
virtual XMLDocument *	ToDocument ()
	Safely cast to a Document, or null.
virtual const XMLDocument *	ToDocument () const
XMLError	Parse (const char *xml, size_t nBytes=(size_t)(-1))
XMLError	LoadFile (const char *filename)
XMLError	LoadFile (std::FILE *)
XMLError	SaveFile (const char *filename, bool compact=false)
XMLError	SaveFile (std::FILE *fp, bool compact=false)
bool	ProcessEntities () const
Whitespace	WhitespaceMode () 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 (XMLError error, const char *str1, const char *str2)
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.
void	PrintError () const
	If there is an error, print it to stdout.
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.
XMLDocument *	GetDocument ()
	Get the XMLDocument that owns this XMLNode.
virtual XMLElement *	ToElement ()
	Safely cast to an Element, or null.
virtual XMLText *	ToText ()
	Safely cast to Text, or null.
virtual XMLComment *	ToComment ()
	Safely cast to a Comment, or null.
virtual XMLDeclaration *	ToDeclaration ()
	Safely cast to a Declaration, or null.
virtual XMLUnknown *	ToUnknown ()
	Safely cast to an Unknown, or null.
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.
XMLNode *	Parent ()
bool	NoChildren () const
	Returns true if this node has no children.
const XMLNode *	FirstChild () const
	Get the first child node, or null if none exists.
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.
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.
XMLNode *	PreviousSibling ()
const XMLElement *	PreviousSiblingElement (const char *value=0) const
	Get the previous (left) sibling element of this node, with an opitionally supplied name.
XMLElement *	PreviousSiblingElement (const char *value=0)
const XMLNode *	NextSibling () const
	Get the next (right) sibling node of this node.
XMLNode *	NextSibling ()
const XMLElement *	NextSiblingElement (const char *value=0) const
	Get the next (right) sibling element of this node, with an opitionally supplied name.
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 *)

Friends
class	XMLElement

Additional Inherited Members
Protected Member Functions inherited from tinyxml2::XMLNode
	XMLNode (XMLDocument *)
	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.

Definition at line 1340 of file tinyxml2.h.

Constructor & Destructor Documentation

XMLDocument()

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

constructor

Definition at line 1485 of file tinyxml2.cpp.

~XMLDocument()

tinyxml2::XMLDocument::~XMLDocument

(

)

Definition at line 1499 of file tinyxml2.cpp.

Member Function Documentation

Accept()

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:

• http://www.saxproject.org/
• http://c2.com/cgi/wiki?HierarchicalVisitorPattern

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.

DeleteNode()

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

inline

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

Definition at line 1486 of file tinyxml2.h.

Error()

bool tinyxml2::XMLDocument::Error ( ) const

inline

Return true if there was an error parsing the document.

Definition at line 1493 of file tinyxml2.h.

ErrorID()

XMLError tinyxml2::XMLDocument::ErrorID ( ) const

inline

Return the errorID.

Definition at line 1497 of file tinyxml2.h.

GetErrorStr1()

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

inline

Return a possibly helpful diagnostic location or string.

Definition at line 1501 of file tinyxml2.h.

GetErrorStr2()

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

inline

Return a possibly helpful secondary diagnostic location or string.

Definition at line 1505 of file tinyxml2.h.

HasBOM()

bool tinyxml2::XMLDocument::HasBOM ( ) const

inline

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

Definition at line 1409 of file tinyxml2.h.

Identify()

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

Definition at line 495 of file tinyxml2.cpp.

LoadFile() [1/2]

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 1574 of file tinyxml2.cpp.

LoadFile() [2/2]

XMLError tinyxml2::XMLDocument::LoadFile

(

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

NewComment()

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 1538 of file tinyxml2.cpp.

NewDeclaration()

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 1556 of file tinyxml2.cpp.

NewElement()

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 1529 of file tinyxml2.cpp.

NewText()

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 1547 of file tinyxml2.cpp.

NewUnknown()

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 1565 of file tinyxml2.cpp.

Parse()

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 1661 of file tinyxml2.cpp.

Print()

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 1689 of file tinyxml2.cpp.

PrintError()

void tinyxml2::XMLDocument::PrintError

(

)

const

If there is an error, print it to stdout.

Definition at line 1707 of file tinyxml2.cpp.

ProcessEntities()

bool tinyxml2::XMLDocument::ProcessEntities ( ) const

inline

Definition at line 1399 of file tinyxml2.h.

RootElement() [1/2]

XMLElement * tinyxml2::XMLDocument::RootElement ( )

inline

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

Definition at line 1421 of file tinyxml2.h.

RootElement() [2/2]

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

inline

Definition at line 1424 of file tinyxml2.h.

SaveFile() [1/2]

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 1634 of file tinyxml2.cpp.

SaveFile() [2/2]

XMLError tinyxml2::XMLDocument::SaveFile	(	std::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.

SetBOM()

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

inline

Sets whether to write the BOM when writing the file.

Definition at line 1414 of file tinyxml2.h.

SetError()

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

Definition at line 1699 of file tinyxml2.cpp.

ShallowClone()

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.

Definition at line 1514 of file tinyxml2.h.

ShallowEqual()

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.

Definition at line 1517 of file tinyxml2.h.

ToDocument() [1/2]

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

inlinevirtual

Safely cast to a Document, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 1348 of file tinyxml2.h.

ToDocument() [2/2]

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

inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1351 of file tinyxml2.h.

WhitespaceMode()

Whitespace tinyxml2::XMLDocument::WhitespaceMode ( ) const

inline

Definition at line 1402 of file tinyxml2.h.

Friends And Related Symbol Documentation

XMLElement

friend class XMLElement

friend

Definition at line 1342 of file tinyxml2.h.

---

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

• G:/work/subversion/scol-technologies/trunk/scol/plugins/sXml/include/tinyxml2.h
• G:/work/subversion/scol-technologies/trunk/scol/plugins/sXml/src/tinyxml2.cpp