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

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::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) const
	Print the Document. More...

virtual bool	Accept (XMLVisitor *visitor) const
	Accept a hierarchical visit of the nodes in the TinyXML-2 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...

void	Clear ()
	Clear the document, resetting it to the initial state. 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 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
	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 optionally 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 optionally 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 )

Private Member Functions
	XMLDocument (const XMLDocument &)

void	operator= (const XMLDocument &)

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

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.

Definition at line 1445 of file tinyxml2.h.

Constructor & Destructor Documentation

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

constructor

Definition at line 1505 of file tinyxml2.cpp.

References tinyxml2::XMLNode::_document.

tinyxml2::XMLDocument::~XMLDocument ( )

Definition at line 1519 of file tinyxml2.cpp.

References _attributePool, _charBuffer, _commentPool, _elementPool, _textPool, tinyxml2::XMLNode::DeleteChildren(), Error(), and TIXMLASSERT.

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

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.

Definition at line 574 of file tinyxml2.cpp.

References tinyxml2::XMLNode::FirstChild(), tinyxml2::XMLNode::NextSibling(), tinyxml2::XMLVisitor::VisitEnter(), and tinyxml2::XMLVisitor::VisitExit().

Referenced by Print().

void tinyxml2::XMLDocument::Clear ( )

Clear the document, resetting it to the initial state.

Definition at line 1542 of file tinyxml2.cpp.

References _charBuffer, _errorID, _errorStr1, _errorStr2, tinyxml2::XMLNode::DeleteChildren(), and tinyxml2::XML_NO_ERROR.

Referenced by LoadFile(), and Parse().

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

inline

Delete a node associated with this document.

It will be unlinked from the DOM.

Definition at line 1591 of file tinyxml2.h.

References tinyxml2::XMLNode::_parent, and tinyxml2::XMLNode::DeleteChild().

bool tinyxml2::XMLDocument::Error ( ) const

inline

Return true if there was an error parsing the document.

Definition at line 1598 of file tinyxml2.h.

References tinyxml2::XML_NO_ERROR.

Referenced by tinyxml2::XMLNode::ParseDeep(), and ~XMLDocument().

XMLError tinyxml2::XMLDocument::ErrorID ( ) const

inline

Return the errorID.

Definition at line 1602 of file tinyxml2.h.

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

inline

Return a possibly helpful diagnostic location or string.

Definition at line 1606 of file tinyxml2.h.

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

inline

Return a possibly helpful secondary diagnostic location or string.

Definition at line 1610 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 1514 of file tinyxml2.h.

Referenced by tinyxml2::XMLPrinter::VisitEnter().

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

Definition at line 499 of file tinyxml2.cpp.

References _commentPool, _elementPool, tinyxml2::XMLNode::_memPool, _textPool, tinyxml2::XMLText::SetCData(), tinyxml2::XMLUtil::SkipWhiteSpace(), tinyxml2::XMLUtil::StringEqual(), TIXMLASSERT, and XMLElement.

Referenced by tinyxml2::XMLNode::ParseDeep().

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

References _errorID, Clear(), SetError(), and tinyxml2::XML_ERROR_FILE_NOT_FOUND.

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

References _charBuffer, _errorID, _writeBOM, Clear(), tinyxml2::XMLNode::ParseDeep(), tinyxml2::XMLUtil::ReadBOM(), SetError(), tinyxml2::XMLUtil::SkipWhiteSpace(), tinyxml2::XML_ERROR_EMPTY_DOCUMENT, and tinyxml2::XML_ERROR_FILE_READ_ERROR.

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

References _commentPool, and tinyxml2::XMLNode::SetValue().

Referenced by tinyxml2::XMLComment::ShallowClone().

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

References _commentPool, and tinyxml2::XMLNode::SetValue().

Referenced by midaspace::print_VTK_START(), and tinyxml2::XMLDeclaration::ShallowClone().

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

References _elementPool, tinyxml2::XMLElement::SetName(), and XMLElement.

Referenced by midaspace::Mesh::print_results(), midaspace::print_VTK_data_body(), midaspace::Mesh::print_VTK_elems(), midaspace::print_VTK_init_cell_data(), midaspace::print_VTK_init_point_data(), midaspace::Mesh::print_VTK_nodes(), midaspace::print_VTK_START(), and tinyxml2::XMLElement::ShallowClone().

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

References _textPool, and tinyxml2::XMLNode::SetValue().

Referenced by midaspace::Mesh::print_results(), midaspace::print_VTK_data_body(), midaspace::Mesh::print_VTK_elems(), midaspace::Mesh::print_VTK_nodes(), and tinyxml2::XMLText::ShallowClone().

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.

Definition at line 1591 of file tinyxml2.cpp.

References _commentPool, and tinyxml2::XMLNode::SetValue().

Referenced by tinyxml2::XMLUnknown::ShallowClone().

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

Definition at line 1683 of file tinyxml2.cpp.

References _charBuffer, _errorID, _writeBOM, Clear(), tinyxml2::XMLNode::ParseDeep(), tinyxml2::XMLUtil::ReadBOM(), SetError(), tinyxml2::XMLUtil::SkipWhiteSpace(), and tinyxml2::XML_ERROR_EMPTY_DOCUMENT.

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

Definition at line 1712 of file tinyxml2.cpp.

References Accept().

Referenced by SaveFile().

void tinyxml2::XMLDocument::PrintError ( ) const

If there is an error, print it to stdout.

Definition at line 1730 of file tinyxml2.cpp.

References _errorID, _errorStr1, _errorStr2, and TIXML_SNPRINTF.

bool tinyxml2::XMLDocument::ProcessEntities ( ) const

inline

Definition at line 1504 of file tinyxml2.h.

Referenced by tinyxml2::XMLElement::ParseAttributes(), tinyxml2::XMLText::ParseDeep(), and tinyxml2::XMLPrinter::VisitEnter().

XMLElement* tinyxml2::XMLDocument::RootElement ( )

inline

Return the root element of DOM.

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

Definition at line 1526 of file tinyxml2.h.

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

inline

Definition at line 1529 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 1656 of file tinyxml2.cpp.

References _errorID, SetError(), and tinyxml2::XML_ERROR_FILE_COULD_NOT_BE_OPENED.

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

References _errorID, and Print().

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

inline

Sets whether to write the BOM when writing the file.

Definition at line 1519 of file tinyxml2.h.

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

Definition at line 1722 of file tinyxml2.cpp.

References _errorID, _errorStr1, and _errorStr2.

Referenced by LoadFile(), Parse(), tinyxml2::XMLElement::ParseAttributes(), tinyxml2::XMLNode::ParseDeep(), tinyxml2::XMLText::ParseDeep(), tinyxml2::XMLComment::ParseDeep(), tinyxml2::XMLDeclaration::ParseDeep(), tinyxml2::XMLUnknown::ParseDeep(), and SaveFile().

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 1622 of file tinyxml2.h.

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 1625 of file tinyxml2.h.

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

inlinevirtual