tinyxml2::XMLDocument Class Reference

#include <tinyxml2.h>

Inherits tinyxml2::XMLNode.

Collaboration diagram for tinyxml2::XMLDocument:

Public Member Functions
	XMLDocument (bool processEntities=true, Whitespace=PRESERVE_WHITESPACE)
	constructor
	~XMLDocument ()
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 (FILE *)
XMLError	SaveFile (const char *filename, bool compact=false)
XMLError	SaveFile (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) const
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 *	ErrorName () const
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.
void	Clear ()
	Clear the document, resetting it to the initial state.
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 optionally 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 optionally 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 *)

Private Member Functions
	XMLDocument (const XMLDocument &)
void	operator= (const XMLDocument &)
void	Parse ()

Private Attributes
bool	_writeBOM
bool	_processEntities
XMLError	_errorID
Whitespace	_whitespace
const char *	_errorStr1
const char *	_errorStr2
char *	_charBuffer
MemPoolT< sizeof(XMLElement) >	_elementPool
MemPoolT< sizeof(XMLAttribute) >	_attributePool
MemPoolT< sizeof(XMLText) >	_textPool
MemPoolT< sizeof(XMLComment) >	_commentPool

Static Private Attributes
static const char *	_errorNames [XML_ERROR_COUNT]

Friends
class	XMLElement

Additional Inherited Members
Protected Member Functions inherited from tinyxml2::XMLNode
	XMLNode (XMLDocument *)
virtual	~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() [1/2]

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

constructor

Here is the call graph for this function:

Here is the caller graph for this function:

~XMLDocument()

tinyxml2::XMLDocument::~XMLDocument

(

)

Here is the call graph for this function:

XMLDocument() [2/2]

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

private

Here is the call graph for this function:

Member Function Documentation

Accept()

bool tinyxml2::XMLDocument::Accept ( XMLVisitor * visitor ) const

virtual

Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the XMLVisitor interface. This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML-2 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():

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

Implements tinyxml2::XMLNode.

Here is the call graph for this function:

Here is the caller graph for this function:

Clear()

void tinyxml2::XMLDocument::Clear

(

)

Clear the document, resetting it to the initial state.

Here is the call graph for this function:

Here is the caller graph for this function:

DeleteNode()

void tinyxml2::XMLDocument::DeleteNode

(

XMLNode *

node

)

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

Here is the call graph for this function:

Error()

bool tinyxml2::XMLDocument::Error ( ) const

inline

Return true if there was an error parsing the document.

Here is the caller graph for this function:

ErrorID()

XMLError tinyxml2::XMLDocument::ErrorID ( ) const

inline

Return the errorID.

ErrorName()

const char * tinyxml2::XMLDocument::ErrorName

(

)

const

Here is the caller graph for this function:

GetErrorStr1()

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

inline

Return a possibly helpful diagnostic location or string.

GetErrorStr2()

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

inline

Return a possibly helpful secondary diagnostic location or string.

HasBOM()

bool tinyxml2::XMLDocument::HasBOM ( ) const

inline

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

Here is the caller graph for this function:

Identify()

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

Here is the call graph for this function:

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.

Here is the call graph for this function:

Here is the caller graph for this function:

LoadFile() [2/2]

XMLError tinyxml2::XMLDocument::LoadFile

(

FILE *

fp

)

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

NOTE: The file should be opened as binary ("rb") not text in order for TinyXML-2 to correctly do newline normalization. Returns XML_NO_ERROR (0) on success, or an errorID.

Here is the call graph for this function:

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.

Here is the call graph for this function:

Here is the caller graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Here is the call graph for this function:

Here is the caller graph for this function:

NewUnknown()

XMLUnknown * tinyxml2::XMLDocument::NewUnknown

(

const char *

text

)

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

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

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

private

Here is the call graph for this function:

Parse() [1/2]

void tinyxml2::XMLDocument::Parse ( )

private

Here is the call graph for this function:

Here is the caller graph for this function:

Parse() [2/2]

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-2 will assume 'xml' points to a null terminated string.

Here is the call graph for this function:

Print()

void tinyxml2::XMLDocument::Print

(

XMLPrinter *

streamer = 0

)

const

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

Here is the call graph for this function:

Here is the caller graph for this function:

PrintError()

void tinyxml2::XMLDocument::PrintError

(

)

const

If there is an error, print it to stdout.

Here is the call graph for this function:

ProcessEntities()

bool tinyxml2::XMLDocument::ProcessEntities ( ) const

inline

Here is the caller graph for this function:

RootElement() [1/2]

XMLElement * tinyxml2::XMLDocument::RootElement ( )

inline

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

Here is the call graph for this function:

RootElement() [2/2]

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

inline

Here is the call graph for this function:

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.

Here is the call graph for this function:

Here is the caller graph for this function:

SaveFile() [2/2]

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.

Here is the call graph for this function:

SetBOM()

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

inline

Sets whether to write the BOM when writing the file.

SetError()

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

Here is the caller graph for this function:

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.

Here is the call graph for this function:

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.

Here is the call graph for this function:

ToDocument() [1/2]

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

inlinevirtual

Safely cast to a Document, or null.

Reimplemented from tinyxml2::XMLNode.

Here is the call graph for this function:

ToDocument() [2/2]

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

inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Here is the call graph for this function:

WhitespaceMode()

Whitespace tinyxml2::XMLDocument::WhitespaceMode ( ) const

inline

Friends And Related Symbol Documentation

XMLElement

friend class XMLElement

friend

Member Data Documentation

_attributePool

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

private

_charBuffer

char* tinyxml2::XMLDocument::_charBuffer

private

_commentPool

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

private

_elementPool

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

private

_errorID

XMLError tinyxml2::XMLDocument::_errorID

private

_errorNames

const char * tinyxml2::XMLDocument::_errorNames

staticprivate

Initial value:

= {
    "XML_SUCCESS",
    "XML_NO_ATTRIBUTE",
    "XML_WRONG_ATTRIBUTE_TYPE",
    "XML_ERROR_FILE_NOT_FOUND",
    "XML_ERROR_FILE_COULD_NOT_BE_OPENED",
    "XML_ERROR_FILE_READ_ERROR",
    "XML_ERROR_ELEMENT_MISMATCH",
    "XML_ERROR_PARSING_ELEMENT",
    "XML_ERROR_PARSING_ATTRIBUTE",
    "XML_ERROR_IDENTIFYING_TAG",
    "XML_ERROR_PARSING_TEXT",
    "XML_ERROR_PARSING_CDATA",
    "XML_ERROR_PARSING_COMMENT",
    "XML_ERROR_PARSING_DECLARATION",
    "XML_ERROR_PARSING_UNKNOWN",
    "XML_ERROR_EMPTY_DOCUMENT",
    "XML_ERROR_MISMATCHED_ELEMENT",
    "XML_ERROR_PARSING",
    "XML_CAN_NOT_CONVERT_TEXT",
    "XML_NO_TEXT_NODE"
  }

_errorStr1

const char* tinyxml2::XMLDocument::_errorStr1

private

_errorStr2

const char* tinyxml2::XMLDocument::_errorStr2

private

_processEntities

bool tinyxml2::XMLDocument::_processEntities

private

_textPool

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

private

_whitespace

Whitespace tinyxml2::XMLDocument::_whitespace

private

_writeBOM

bool tinyxml2::XMLDocument::_writeBOM

private

---

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

• /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/libTierces/tinyxml2.h
• /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/libTierces/tinyxml2.cpp