#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLDocument:

Classes
class	DepthTracker

Public Member Functions
virtual bool	Accept (XMLVisitor *visitor) const override

void	Clear ()
	Clear the document, resetting it to the initial state. More...

void	ClearError ()
	Clears the error flags. More...

void	DeepCopy (XMLDocument *target) const

void	DeleteNode (XMLNode *node)

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

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

int	ErrorLineNum () const
	Return the line where the error occurred, or zero if unknown. More...

const char *	ErrorName () const

const char *	ErrorStr () const

bool	HasBOM () const

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

XMLError	LoadFile (const char *filename)

XMLError	LoadFile (FILE *)

void	MarkInUse (const XMLNode *const)

XMLComment *	NewComment (const char *comment)

XMLDeclaration *	NewDeclaration (const char *text=0)

XMLElement *	NewElement (const char *name)

XMLText *	NewText (const char *text)

XMLUnknown *	NewUnknown (const char *text)

XMLError	Parse (const char *xml, size_t nBytes=static_cast< size_t >(-1))

void	Print (XMLPrinter *streamer=0) const

void	PrintError () const
	A (trivial) utility function that prints the ErrorStr() to stdout. More...

bool	ProcessEntities () const

XMLElement *	RootElement ()

const XMLElement *	RootElement () const

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

XMLError	SaveFile (FILE *fp, bool compact=false)

void	SetBOM (bool useBOM)

virtual XMLNode *	ShallowClone (XMLDocument *) const override

virtual bool	ShallowEqual (const XMLNode *) const override

virtual const XMLDocument *	ToDocument () const override

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

Whitespace	WhitespaceMode () const

	XMLDocument (bool processEntities=true, Whitespace whitespaceMode=PRESERVE_WHITESPACE)
	constructor More...

	~XMLDocument ()

Public Member Functions inherited from tinyxml2::XMLNode
int	ChildElementCount () const

int	ChildElementCount (const char *value) const

XMLNode *	DeepClone (XMLDocument *target) const

void	DeleteChild (XMLNode *node)

void	DeleteChildren ()

XMLNode *	FirstChild ()

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

XMLElement *	FirstChildElement (const char *name=0)

const XMLElement *	FirstChildElement (const char *name=0) const

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

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

int	GetLineNum () const
	Gets the line number the node is in, if the document was parsed from a file. More...

void *	GetUserData () const

XMLNode *	InsertAfterChild (XMLNode afterThis, XMLNode addThis)

XMLNode *	InsertEndChild (XMLNode *addThis)

XMLNode *	InsertFirstChild (XMLNode *addThis)

XMLNode *	LastChild ()

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

XMLElement *	LastChildElement (const char *name=0)

const XMLElement *	LastChildElement (const char *name=0) const

XMLNode *	LinkEndChild (XMLNode *addThis)

XMLNode *	NextSibling ()

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

XMLElement *	NextSiblingElement (const char *name=0)

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

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

XMLNode *	Parent ()

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

XMLNode *	PreviousSibling ()

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

XMLElement *	PreviousSiblingElement (const char *name=0)

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

void	SetUserData (void *userData)

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

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

virtual const XMLComment *	ToComment () const

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

virtual const XMLDeclaration *	ToDeclaration () const

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

virtual const XMLElement *	ToElement () const

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

virtual const XMLText *	ToText () const

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

virtual const XMLUnknown *	ToUnknown () const

const char *	Value () const

Static Public Member Functions
static const char *	ErrorIDToName (XMLError errorID)

Private Member Functions
template<class NodeType , int PoolElementSize>
NodeType *	CreateUnlinkedNode (MemPoolT< PoolElementSize > &pool)

void	operator= (const XMLDocument &)

void	Parse ()

void	PopDepth ()

void	PushDepth ()

void	SetError (XMLError error, int lineNum, const char *format,...)

	XMLDocument (const XMLDocument &)

Private Attributes
MemPoolT< sizeof(XMLAttribute) >	_attributePool

char *	_charBuffer

MemPoolT< sizeof(XMLComment) >	_commentPool

MemPoolT< sizeof(XMLElement) >	_elementPool

XMLError	_errorID

int	_errorLineNum

StrPair	_errorStr

int	_parseCurLineNum

int	_parsingDepth

bool	_processEntities

MemPoolT< sizeof(XMLText) >	_textPool

DynArray< XMLNode *, 10 >	_unlinked

Whitespace	_whitespaceMode

bool	_writeBOM

Static Private Attributes
static const char *	_errorNames [XML_ERROR_COUNT]

Friends
class	XMLComment

class	XMLDeclaration

class	XMLElement

class	XMLNode

class	XMLText

class	XMLUnknown

Additional Inherited Members
Protected Member Functions inherited from tinyxml2::XMLNode
virtual char *	ParseDeep (char p, StrPair parentEndTag, int *curLineNumPtr)

	XMLNode (XMLDocument *)

virtual	~XMLNode ()

Protected Attributes inherited from tinyxml2::XMLNode
XMLDocument *	_document

XMLNode *	_firstChild

XMLNode *	_lastChild

XMLNode *	_next

XMLNode *	_parent

int	_parseLineNum

XMLNode *	_prev

void *	_userData

StrPair	_value

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

Constructor & Destructor Documentation

◆ XMLDocument() [1/2]

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

constructor

Definition at line 2196 of file tinyxml2.cpp.

◆ ~XMLDocument()

tinyxml2::XMLDocument::~XMLDocument ( )

Definition at line 2218 of file tinyxml2.cpp.

◆ XMLDocument() [2/2]

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

private

Member Function Documentation

◆ Accept()

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

overridevirtual

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

◆ Clear()

void tinyxml2::XMLDocument::Clear ( )

Clear the document, resetting it to the initial state.

Definition at line 2237 of file tinyxml2.cpp.

◆ ClearError()

void tinyxml2::XMLDocument::ClearError ( )

Clears the error flags.

Definition at line 2503 of file tinyxml2.cpp.

◆ CreateUnlinkedNode()

template<class NodeType , int PoolElementSize>

NodeType * tinyxml2::XMLDocument::CreateUnlinkedNode ( MemPoolT< PoolElementSize > & pool )

inlineprivate

Definition at line 1989 of file tinyxml2.h.

◆ DeepCopy()

void tinyxml2::XMLDocument::DeepCopy ( XMLDocument * target ) const

Copies this document to a target document. The target will be completely cleared before the copy. If you want to copy a sub-tree, see XMLNode::DeepClone().

NOTE: that the 'target' must be non-null.

Definition at line 2271 of file tinyxml2.cpp.

◆ DeleteNode()

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

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

Definition at line 2339 of file tinyxml2.cpp.

◆ Error()

bool tinyxml2::XMLDocument::Error ( ) const

inline

Return true if there was an error parsing the document.

Definition at line 1885 of file tinyxml2.h.

◆ ErrorID()

XMLError tinyxml2::XMLDocument::ErrorID ( ) const

inline

Return the errorID.

Definition at line 1889 of file tinyxml2.h.

◆ ErrorIDToName()

const char * tinyxml2::XMLDocument::ErrorIDToName ( XMLError errorID )

static

Definition at line 2538 of file tinyxml2.cpp.

◆ ErrorLineNum()

int tinyxml2::XMLDocument::ErrorLineNum ( ) const

inline

Return the line where the error occurred, or zero if unknown.

Definition at line 1904 of file tinyxml2.h.

◆ ErrorName()

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

Definition at line 2557 of file tinyxml2.cpp.

◆ ErrorStr()

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

Returns a "long form" error description. A hopefully helpful diagnostic with location, line number, and/or additional info.

Definition at line 2546 of file tinyxml2.cpp.

◆ HasBOM()

bool tinyxml2::XMLDocument::HasBOM ( ) const

inline

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

Definition at line 1802 of file tinyxml2.h.

◆ Identify()

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

Definition at line 715 of file tinyxml2.cpp.

◆ LoadFile() [1/2]

XMLError tinyxml2::XMLDocument::LoadFile ( const char * filename )

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

Definition at line 2357 of file tinyxml2.cpp.

◆ 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_SUCCESS (0) on success, or an errorID.

Definition at line 2376 of file tinyxml2.cpp.

◆ MarkInUse()

void tinyxml2::XMLDocument::MarkInUse ( const XMLNode * const node )

Definition at line 2224 of file tinyxml2.cpp.

◆ 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 2292 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 2308 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 2284 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 2300 of file tinyxml2.cpp.

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

Definition at line 2316 of file tinyxml2.cpp.

◆ operator=()

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

private

◆ Parse() [1/2]

void tinyxml2::XMLDocument::Parse ( )

private

Definition at line 2562 of file tinyxml2.cpp.

◆ Parse() [2/2]

XMLError tinyxml2::XMLDocument::Parse	(	const char *	xml,
		size_t	nBytes = `static_cast<size_t>(-1)`
	)

Parse an XML file from a character string. Returns XML_SUCCESS (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 2460 of file tinyxml2.cpp.

◆ PopDepth()

void tinyxml2::XMLDocument::PopDepth ( )

private

Definition at line 2586 of file tinyxml2.cpp.

◆ 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

Definition at line 2491 of file tinyxml2.cpp.

◆ PrintError()

void tinyxml2::XMLDocument::PrintError ( ) const

A (trivial) utility function that prints the ErrorStr() to stdout.

Definition at line 2552 of file tinyxml2.cpp.

◆ ProcessEntities()

bool tinyxml2::XMLDocument::ProcessEntities ( ) const

inline

Definition at line 1792 of file tinyxml2.h.

◆ PushDepth()

void tinyxml2::XMLDocument::PushDepth ( )

private

Definition at line 2578 of file tinyxml2.cpp.

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

◆ RootElement() [2/2]

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

inline

Definition at line 1817 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_SUCCESS (0) on success, or an errorID.

Definition at line 2430 of file tinyxml2.cpp.

◆ 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_SUCCESS (0) on success, or an errorID.

Definition at line 2449 of file tinyxml2.cpp.

◆ SetBOM()

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

inline

Sets whether to write the BOM when writing the file.

Definition at line 1807 of file tinyxml2.h.

◆ SetError()

void tinyxml2::XMLDocument::SetError	(	XMLError	error,
		int	lineNum,
		const char *	format,
			...
	)

private

Definition at line 2510 of file tinyxml2.cpp.

◆ ShallowClone()

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

inlineoverridevirtual

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

◆ ShallowEqual()

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

inlineoverridevirtual

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

◆ ToDocument() [1/2]

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

inlineoverridevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1739 of file tinyxml2.h.

◆ ToDocument() [2/2]

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

inlineoverridevirtual

Safely cast to a Document, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 1735 of file tinyxml2.h.

◆ WhitespaceMode()

Whitespace tinyxml2::XMLDocument::WhitespaceMode ( ) const

inline

Definition at line 1795 of file tinyxml2.h.

Friends And Related Function Documentation

◆ XMLComment

friend class XMLComment

friend

Definition at line 1727 of file tinyxml2.h.

◆ XMLDeclaration

friend class XMLDeclaration

friend

Definition at line 1728 of file tinyxml2.h.

◆ XMLElement

friend class XMLElement

friend

Definition at line 1722 of file tinyxml2.h.

◆ XMLNode

friend class XMLNode

friend

Definition at line 1725 of file tinyxml2.h.

◆ XMLText

friend class XMLText

friend

Definition at line 1726 of file tinyxml2.h.

◆ XMLUnknown

friend class XMLUnknown

friend

Definition at line 1729 of file tinyxml2.h.

Member Data Documentation

◆ _attributePool

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

private

Definition at line 1956 of file tinyxml2.h.

◆ _charBuffer

char* tinyxml2::XMLDocument::_charBuffer

private

Definition at line 1944 of file tinyxml2.h.

◆ _commentPool

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

private

Definition at line 1958 of file tinyxml2.h.

◆ _elementPool

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

private

Definition at line 1955 of file tinyxml2.h.

◆ _errorID

XMLError tinyxml2::XMLDocument::_errorID

private

Definition at line 1940 of file tinyxml2.h.

◆ _errorLineNum

int tinyxml2::XMLDocument::_errorLineNum

private

Definition at line 1943 of file tinyxml2.h.

◆ _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_PARSING_ELEMENT",
    "XML_ERROR_PARSING_ATTRIBUTE",
    "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",
        "XML_ELEMENT_DEPTH_EXCEEDED"
}

Definition at line 1960 of file tinyxml2.h.

◆ _errorStr

StrPair tinyxml2::XMLDocument::_errorStr

mutableprivate

Definition at line 1942 of file tinyxml2.h.

◆ _parseCurLineNum

int tinyxml2::XMLDocument::_parseCurLineNum

private

Definition at line 1945 of file tinyxml2.h.

◆ _parsingDepth

int tinyxml2::XMLDocument::_parsingDepth

private

Definition at line 1946 of file tinyxml2.h.

◆ _processEntities

bool tinyxml2::XMLDocument::_processEntities

private

Definition at line 1939 of file tinyxml2.h.

◆ _textPool

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

private

Definition at line 1957 of file tinyxml2.h.

◆ _unlinked

DynArray<XMLNode*, 10> tinyxml2::XMLDocument::_unlinked

private

Definition at line 1953 of file tinyxml2.h.

◆ _whitespaceMode

Whitespace tinyxml2::XMLDocument::_whitespaceMode

private

Definition at line 1941 of file tinyxml2.h.

◆ _writeBOM

bool tinyxml2::XMLDocument::_writeBOM

private

Definition at line 1938 of file tinyxml2.h.

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

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XMLDocument() [1/2]

◆ ~XMLDocument()

◆ XMLDocument() [2/2]

Member Function Documentation

◆ Accept()

◆ Clear()

◆ ClearError()

◆ CreateUnlinkedNode()

◆ DeepCopy()

◆ DeleteNode()

◆ Error()

◆ ErrorID()

◆ ErrorIDToName()

◆ ErrorLineNum()

◆ ErrorName()

◆ ErrorStr()

◆ HasBOM()

◆ Identify()

◆ LoadFile() [1/2]

◆ LoadFile() [2/2]

◆ MarkInUse()

◆ NewComment()

◆ NewDeclaration()

◆ NewElement()

◆ NewText()

◆ NewUnknown()

◆ operator=()

◆ Parse() [1/2]

◆ Parse() [2/2]

◆ PopDepth()

◆ Print()

◆ PrintError()

◆ ProcessEntities()

◆ PushDepth()

◆ RootElement() [1/2]

◆ RootElement() [2/2]

◆ SaveFile() [1/2]

◆ SaveFile() [2/2]

◆ SetBOM()

◆ SetError()

◆ ShallowClone()

◆ ShallowEqual()

◆ ToDocument() [1/2]

◆ ToDocument() [2/2]

◆ WhitespaceMode()

Friends And Related Function Documentation

◆ XMLComment

◆ XMLDeclaration

◆ XMLElement

◆ XMLNode

◆ XMLText

◆ XMLUnknown

Member Data Documentation

◆ _attributePool

◆ _charBuffer

◆ _commentPool

◆ _elementPool

◆ _errorID

◆ _errorLineNum

◆ _errorNames

◆ _errorStr

◆ _parseCurLineNum

◆ _parsingDepth

◆ _processEntities

◆ _textPool

◆ _unlinked

◆ _whitespaceMode

◆ _writeBOM