#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLDocument:

Collaboration diagram for tinyxml2::XMLDocument:

[legend]

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 XMLDocument *	ToDocument ()
	Safely cast to a Document, 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 XMLDocument *	ToDocument () 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 *name=0) const

XMLElement *	FirstChildElement (const char *name=0)

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

XMLNode *	LastChild ()

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

XMLElement *	LastChildElement (const char *name=0)

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

XMLNode *	PreviousSibling ()

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

XMLElement *	PreviousSiblingElement (const char *name=0)

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

XMLNode *	NextSibling ()

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

XMLElement *	NextSiblingElement (const char *name=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 XMLNode *	ShallowClone (XMLDocument *document) const =0

virtual bool	ShallowEqual (const XMLNode *compare) const =0

virtual bool	Accept (XMLVisitor *visitor) const =0

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 ()

virtual char *	ParseDeep (char , StrPair )

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

Constructor & Destructor Documentation

◆ XMLDocument() [1/2]

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

constructor

Definition at line 1770 of file tinyxml2.cpp.

                                                                      :
    XMLNode( 0 ),
    _writeBOM( false ),
    _processEntities( processEntities ),
    _errorID( XML_NO_ERROR ),
    _whitespace( whitespace ),
    _errorStr1( 0 ),
    _errorStr2( 0 ),
    _charBuffer( 0 )
{
    // avoid VC++ C4355 warning about 'this' in initializer list (C4355 is off by default in VS2012+)
    _document = this;
}

◆ ~XMLDocument()

tinyxml2::XMLDocument::~XMLDocument ( )

Definition at line 1785 of file tinyxml2.cpp.

{
    Clear();
}

◆ XMLDocument() [2/2]

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

private

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:

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

{
    TIXMLASSERT( visitor );
    if ( visitor->VisitEnter( *this ) ) {
        for ( const XMLNode* node=FirstChild(); node; node=node->NextSibling() ) {
            if ( !node->Accept( visitor ) ) {
                break;
            }
        }
    }
    return visitor->VisitExit( *this );
}

Referenced by Print().

◆ Clear()

void tinyxml2::XMLDocument::Clear ( )

Clear the document, resetting it to the initial state.

Definition at line 1791 of file tinyxml2.cpp.

{
    DeleteChildren();
 
#ifdef DEBUG
    const bool hadError = Error();
#endif
    _errorID = XML_NO_ERROR;
    _errorStr1 = 0;
    _errorStr2 = 0;
 
    delete [] _charBuffer;
    _charBuffer = 0;
 
#if 0
    _textPool.Trace( "text" );
    _elementPool.Trace( "element" );
    _commentPool.Trace( "comment" );
    _attributePool.Trace( "attribute" );
#endif
 
#ifdef DEBUG
    if ( !hadError ) {
        TIXMLASSERT( _elementPool.CurrentAllocs()   == _elementPool.Untracked() );
        TIXMLASSERT( _attributePool.CurrentAllocs() == _attributePool.Untracked() );
        TIXMLASSERT( _textPool.CurrentAllocs()      == _textPool.Untracked() );
        TIXMLASSERT( _commentPool.CurrentAllocs()   == _commentPool.Untracked() );
    }
#endif
}

Referenced by LoadFile(), Parse(), and ~XMLDocument().

◆ DeleteNode()

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

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

Definition at line 1888 of file tinyxml2.cpp.

                                            {
    TIXMLASSERT( node );
    TIXMLASSERT(node->_document == this );
    if (node->_parent) {
        node->_parent->DeleteChild( node );
    }
    else {
        // Isn't in the tree.
        // Use the parent delete.
        // Also, we need to mark it tracked: we 'know'
        // it was never used.
        node->_memPool->SetTracked();
        // Call the static XMLNode version:
        XMLNode::DeleteNode(node);
    }
}

◆ Error()

bool tinyxml2::XMLDocument::Error ( ) const

inline

Return true if there was an error parsing the document.

Definition at line 1677 of file tinyxml2.h.

                       {
        return _errorID != XML_NO_ERROR;
    }

Referenced by Clear(), Parse(), tinyxml2::XMLNode::ParseDeep(), and PrintError().

◆ ErrorID()

XMLError tinyxml2::XMLDocument::ErrorID ( ) const

inline

Return the errorID.

Definition at line 1681 of file tinyxml2.h.

                              {
        return _errorID;
    }

◆ ErrorName()

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

Definition at line 2061 of file tinyxml2.cpp.

{
    TIXMLASSERT( _errorID >= 0 && _errorID < XML_ERROR_COUNT );
    const char* errorName = _errorNames[_errorID];
    TIXMLASSERT( errorName && errorName[0] );
    return errorName;
}

Referenced by PrintError().

◆ GetErrorStr1()

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

inline

Return a possibly helpful diagnostic location or string.

Definition at line 1687 of file tinyxml2.h.

                                     {
        return _errorStr1;
    }

◆ GetErrorStr2()

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

inline

Return a possibly helpful secondary diagnostic location or string.

Definition at line 1691 of file tinyxml2.h.

                                     {
        return _errorStr2;
    }

◆ HasBOM()

bool tinyxml2::XMLDocument::HasBOM ( ) const

inline

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

Definition at line 1595 of file tinyxml2.h.

                        {
        return _writeBOM;
    }

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

◆ Identify()

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

Definition at line 611 of file tinyxml2.cpp.

{
    TIXMLASSERT( node );
    TIXMLASSERT( p );
    char* const start = p;
    p = XMLUtil::SkipWhiteSpace( p );
    if( !*p ) {
        *node = 0;
        TIXMLASSERT( p );
        return p;
    }
 
    // These strings define the matching patterns:
    static const char* xmlHeader        = { "<?" };
    static const char* commentHeader    = { "<!--" };
    static const char* cdataHeader      = { "<![CDATA[" };
    static const char* dtdHeader        = { "<!" };
    static const char* elementHeader    = { "<" };  // and a header for everything else; check last.
 
    static const int xmlHeaderLen       = 2;
    static const int commentHeaderLen   = 4;
    static const int cdataHeaderLen     = 9;
    static const int dtdHeaderLen       = 2;
    static const int elementHeaderLen   = 1;
 
    TIXMLASSERT( sizeof( XMLComment ) == sizeof( XMLUnknown ) );        // use same memory pool
    TIXMLASSERT( sizeof( XMLComment ) == sizeof( XMLDeclaration ) );    // use same memory pool
    XMLNode* returnNode = 0;
    if ( XMLUtil::StringEqual( p, xmlHeader, xmlHeaderLen ) ) {
        TIXMLASSERT( sizeof( XMLDeclaration ) == _commentPool.ItemSize() );
        returnNode = new (_commentPool.Alloc()) XMLDeclaration( this );
        returnNode->_memPool = &_commentPool;
        p += xmlHeaderLen;
    }
    else if ( XMLUtil::StringEqual( p, commentHeader, commentHeaderLen ) ) {
        TIXMLASSERT( sizeof( XMLComment ) == _commentPool.ItemSize() );
        returnNode = new (_commentPool.Alloc()) XMLComment( this );
        returnNode->_memPool = &_commentPool;
        p += commentHeaderLen;
    }
    else if ( XMLUtil::StringEqual( p, cdataHeader, cdataHeaderLen ) ) {
        TIXMLASSERT( sizeof( XMLText ) == _textPool.ItemSize() );
        XMLText* text = new (_textPool.Alloc()) XMLText( this );
        returnNode = text;
        returnNode->_memPool = &_textPool;
        p += cdataHeaderLen;
        text->SetCData( true );
    }
    else if ( XMLUtil::StringEqual( p, dtdHeader, dtdHeaderLen ) ) {
        TIXMLASSERT( sizeof( XMLUnknown ) == _commentPool.ItemSize() );
        returnNode = new (_commentPool.Alloc()) XMLUnknown( this );
        returnNode->_memPool = &_commentPool;
        p += dtdHeaderLen;
    }
    else if ( XMLUtil::StringEqual( p, elementHeader, elementHeaderLen ) ) {
        TIXMLASSERT( sizeof( XMLElement ) == _elementPool.ItemSize() );
        returnNode = new (_elementPool.Alloc()) XMLElement( this );
        returnNode->_memPool = &_elementPool;
        p += elementHeaderLen;
    }
    else {
        TIXMLASSERT( sizeof( XMLText ) == _textPool.ItemSize() );
        returnNode = new (_textPool.Alloc()) XMLText( this );
        returnNode->_memPool = &_textPool;
        p = start;  // Back it up, all the text counts.
    }
 
    TIXMLASSERT( returnNode );
    TIXMLASSERT( p );
    *node = returnNode;
    return p;
}

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

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

{
    Clear();
    FILE* fp = callfopen( filename, "rb" );
    if ( !fp ) {
        SetError( XML_ERROR_FILE_NOT_FOUND, filename, 0 );
        return _errorID;
    }
    LoadFile( fp );
    fclose( fp );
    return _errorID;
}

Referenced by Database::fromXml(), and LoadFile().

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

Definition at line 1940 of file tinyxml2.cpp.

{
    Clear();
 
    fseek( fp, 0, SEEK_SET );
    if ( fgetc( fp ) == EOF && ferror( fp ) != 0 ) {
        SetError( XML_ERROR_FILE_READ_ERROR, 0, 0 );
        return _errorID;
    }
 
    fseek( fp, 0, SEEK_END );
    const long filelength = ftell( fp );
    fseek( fp, 0, SEEK_SET );
    if ( filelength == -1L ) {
        SetError( XML_ERROR_FILE_READ_ERROR, 0, 0 );
        return _errorID;
    }
    TIXMLASSERT( filelength >= 0 );
 
    if ( !LongFitsIntoSizeTMinusOne<>::Fits( filelength ) ) {
        // Cannot handle files which won't fit in buffer together with null terminator
        SetError( XML_ERROR_FILE_READ_ERROR, 0, 0 );
        return _errorID;
    }
 
    if ( filelength == 0 ) {
        SetError( XML_ERROR_EMPTY_DOCUMENT, 0, 0 );
        return _errorID;
    }
 
    const size_t size = filelength;
    TIXMLASSERT( _charBuffer == 0 );
    _charBuffer = new char[size+1];
    size_t read = fread( _charBuffer, 1, size, fp );
    if ( read != size ) {
        SetError( XML_ERROR_FILE_READ_ERROR, 0, 0 );
        return _errorID;
    }
 
    _charBuffer[size] = 0;
 
    Parse();
    return _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 1833 of file tinyxml2.cpp.

{
    TIXMLASSERT( sizeof( XMLComment ) == _commentPool.ItemSize() );
    XMLComment* comment = new (_commentPool.Alloc()) XMLComment( this );
    comment->_memPool = &_commentPool;
    comment->SetValue( str );
    return comment;
}

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

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

{
    TIXMLASSERT( sizeof( XMLDeclaration ) == _commentPool.ItemSize() );
    XMLDeclaration* dec = new (_commentPool.Alloc()) XMLDeclaration( this );
    dec->_memPool = &_commentPool;
    dec->SetValue( str ? str : "xml version=\"1.0\" encoding=\"UTF-8\"" );
    return dec;
}

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

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

{
    TIXMLASSERT( sizeof( XMLElement ) == _elementPool.ItemSize() );
    XMLElement* ele = new (_elementPool.Alloc()) XMLElement( this );
    ele->_memPool = &_elementPool;
    ele->SetName( name );
    return ele;
}

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

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

{
    TIXMLASSERT( sizeof( XMLText ) == _textPool.ItemSize() );
    XMLText* text = new (_textPool.Alloc()) XMLText( this );
    text->_memPool = &_textPool;
    text->SetValue( str );
    return text;
}

Referenced by tinyxml2::XMLElement::SetText(), and tinyxml2::XMLText::ShallowClone().

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

{
    TIXMLASSERT( sizeof( XMLUnknown ) == _commentPool.ItemSize() );
    XMLUnknown* unk = new (_commentPool.Alloc()) XMLUnknown( this );
    unk->_memPool = &_commentPool;
    unk->SetValue( str );
    return unk;
}

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

◆ operator=()

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

private

◆ Parse() [1/2]

void tinyxml2::XMLDocument::Parse ( )

private

Definition at line 2091 of file tinyxml2.cpp.

{
    TIXMLASSERT( NoChildren() ); // Clear() must have been called previously
    TIXMLASSERT( _charBuffer );
    char* p = _charBuffer;
    p = XMLUtil::SkipWhiteSpace( p );
    p = const_cast<char*>( XMLUtil::ReadBOM( p, &_writeBOM ) );
    if ( !*p ) {
        SetError( XML_ERROR_EMPTY_DOCUMENT, 0, 0 );
        return;
    }
    ParseDeep(p, 0 );
}

Referenced by LoadFile(), and Parse().

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

Definition at line 2010 of file tinyxml2.cpp.

{
    Clear();
 
    if ( len == 0 || !p || !*p ) {
        SetError( XML_ERROR_EMPTY_DOCUMENT, 0, 0 );
        return _errorID;
    }
    if ( len == (size_t)(-1) ) {
        len = strlen( p );
    }
    TIXMLASSERT( _charBuffer == 0 );
    _charBuffer = new char[ len+1 ];
    memcpy( _charBuffer, p, len );
    _charBuffer[len] = 0;
 
    Parse();
    if ( Error() ) {
        // clean up now essentially dangling memory.
        // and the parse fail can put objects in the
        // pools that are dead and inaccessible.
        DeleteChildren();
        _elementPool.Clear();
        _attributePool.Clear();
        _textPool.Clear();
        _commentPool.Clear();
    }
    return _errorID;
}

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

{
    if ( streamer ) {
        Accept( streamer );
    }
    else {
        XMLPrinter stdoutStreamer( stdout );
        Accept( &stdoutStreamer );
    }
}

Referenced by SaveFile().

◆ PrintError()

void tinyxml2::XMLDocument::PrintError ( ) const

If there is an error, print it to stdout.

Definition at line 2069 of file tinyxml2.cpp.

{
    if ( Error() ) {
        static const int LEN = 20;
        char buf1[LEN] = { 0 };
        char buf2[LEN] = { 0 };
 
        if ( _errorStr1 ) {
            TIXML_SNPRINTF( buf1, LEN, "%s", _errorStr1 );
        }
        if ( _errorStr2 ) {
            TIXML_SNPRINTF( buf2, LEN, "%s", _errorStr2 );
        }
 
        // Should check INT_MIN <= _errorID && _errorId <= INT_MAX, but that
        // causes a clang "always true" -Wtautological-constant-out-of-range-compare warning
        TIXMLASSERT( 0 <= _errorID && XML_ERROR_COUNT - 1 <= INT_MAX );
        printf( "XMLDocument error id=%d '%s' str1=%s str2=%s\n",
                static_cast<int>( _errorID ), ErrorName(), buf1, buf2 );
    }
}

◆ ProcessEntities()

bool tinyxml2::XMLDocument::ProcessEntities ( ) const

inline

Definition at line 1585 of file tinyxml2.h.

                                        {
        return _processEntities;
    }

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

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

                                            {
        return FirstChildElement();
    }

◆ RootElement() [2/2]

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

inline

Definition at line 1610 of file tinyxml2.h.

                                            {
        return FirstChildElement();
    }

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

{
    FILE* fp = callfopen( filename, "w" );
    if ( !fp ) {
        SetError( XML_ERROR_FILE_COULD_NOT_BE_OPENED, filename, 0 );
        return _errorID;
    }
    SaveFile(fp, compact);
    fclose( fp );
    return _errorID;
}

Referenced by SaveFile().

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

Definition at line 1999 of file tinyxml2.cpp.

{
    // Clear any error from the last save, otherwise it will get reported
    // for *this* call.
    SetError( XML_NO_ERROR, 0, 0 );
    XMLPrinter stream( fp, compact );
    Print( &stream );
    return _errorID;
}

◆ SetBOM()

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

inline

Sets whether to write the BOM when writing the file.

Definition at line 1600 of file tinyxml2.h.

                               {
        _writeBOM = useBOM;
    }

◆ SetError()

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

Definition at line 2053 of file tinyxml2.cpp.

{
    TIXMLASSERT( error >= 0 && error < XML_ERROR_COUNT );
    _errorID = error;
    _errorStr1 = str1;
    _errorStr2 = str2;
}

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

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

                                                            {
        return 0;
    }

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

                                                        {
        return false;
    }

◆ ToDocument() [1/2]

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

inlinevirtual

Safely cast to a Document, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 1528 of file tinyxml2.h.

                                                    {
        TIXMLASSERT( this == _document );
        return this;
    }

◆ ToDocument() [2/2]

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

inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1532 of file tinyxml2.h.

                                                    {
        TIXMLASSERT( this == _document );
        return this;
    }

◆ WhitespaceMode()

Whitespace tinyxml2::XMLDocument::WhitespaceMode ( ) const

inline

Definition at line 1588 of file tinyxml2.h.

                                        {
        return _whitespace;
    }

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

Friends And Related Function Documentation

◆ XMLElement

friend class XMLElement

friend

Definition at line 1522 of file tinyxml2.h.

Referenced by Identify(), and NewElement().

Member Data Documentation

◆ _attributePool

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

private

Definition at line 1723 of file tinyxml2.h.

Referenced by Clear(), tinyxml2::XMLElement::FindOrCreateAttribute(), Parse(), and tinyxml2::XMLElement::ParseAttributes().

◆ _charBuffer

char* tinyxml2::XMLDocument::_charBuffer

private

Definition at line 1720 of file tinyxml2.h.

Referenced by Clear(), LoadFile(), and Parse().

◆ _commentPool

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

private

Definition at line 1725 of file tinyxml2.h.

Referenced by Clear(), Identify(), NewComment(), NewDeclaration(), NewUnknown(), and Parse().

◆ _elementPool

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

private

Definition at line 1722 of file tinyxml2.h.

Referenced by Clear(), Identify(), NewElement(), and Parse().

◆ _errorID

XMLError tinyxml2::XMLDocument::_errorID

private

Definition at line 1716 of file tinyxml2.h.

Referenced by Clear(), ErrorName(), LoadFile(), Parse(), PrintError(), SaveFile(), and SetError().

◆ _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"
}

Definition at line 1727 of file tinyxml2.h.

Referenced by ErrorName().

◆ _errorStr1

const char* tinyxml2::XMLDocument::_errorStr1

private

Definition at line 1718 of file tinyxml2.h.

Referenced by Clear(), PrintError(), and SetError().

◆ _errorStr2

const char* tinyxml2::XMLDocument::_errorStr2

private

Definition at line 1719 of file tinyxml2.h.

Referenced by Clear(), PrintError(), and SetError().

◆ _processEntities

bool tinyxml2::XMLDocument::_processEntities

private

Definition at line 1715 of file tinyxml2.h.

◆ _textPool

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

private

Definition at line 1724 of file tinyxml2.h.

Referenced by Clear(), Identify(), NewText(), and Parse().

◆ _whitespace

Whitespace tinyxml2::XMLDocument::_whitespace

private

Definition at line 1717 of file tinyxml2.h.

◆ _writeBOM

bool tinyxml2::XMLDocument::_writeBOM

private

Definition at line 1714 of file tinyxml2.h.

Referenced by Parse().

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

sdk/tools/xml2sdb/tinyxml2.h
sdk/tools/xml2sdb/tinyxml2.cpp

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()

◆ DeleteNode()

◆ Error()

◆ ErrorID()

◆ ErrorName()

◆ GetErrorStr1()

◆ GetErrorStr2()

◆ HasBOM()

◆ Identify()

◆ LoadFile() [1/2]

◆ LoadFile() [2/2]

◆ NewComment()

◆ NewDeclaration()

◆ NewElement()

◆ NewText()

◆ NewUnknown()

◆ operator=()

◆ Parse() [1/2]

◆ Parse() [2/2]

◆ Print()

◆ PrintError()

◆ ProcessEntities()

◆ 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

◆ XMLElement

Member Data Documentation

◆ _attributePool

◆ _charBuffer

◆ _commentPool

◆ _elementPool

◆ _errorID

◆ _errorNames

◆ _errorStr1

◆ _errorStr2

◆ _processEntities

◆ _textPool

◆ _whitespace

◆ _writeBOM