TiXmlDocument Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlDocument:

Collaboration diagram for TiXmlDocument:

Public Member Functions
virtual bool	Accept (TiXmlVisitor *content) const
void	ClearError ()
bool	Error () const
int	ErrorCol () const
	The column where the error occured. See ErrorRow() More...
const char *	ErrorDesc () const
	Contains a textual (english) description of the error if one occurs. More...
int	ErrorId () const
int	ErrorRow () const
bool	LoadFile (const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
	Load a file using the given filename. Returns true if successful. More...
bool	LoadFile (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
bool	LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
TiXmlDocument &	operator= (const TiXmlDocument &copy)
virtual const char *	Parse (const char *p, TiXmlParsingData *data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
void	Print () const
virtual void	Print (FILE *cfile, int depth=0) const
	Print this Document to a FILE stream. More...
TiXmlElement *	RootElement ()
const TiXmlElement *	RootElement () const
bool	SaveFile () const
	Save a file using the current document value. Returns true if successful. More...
bool	SaveFile (const char *filename) const
	Save a file using the given filename. Returns true if successful. More...
bool	SaveFile (FILE *) const
	Save a file using the given FILE*. Returns true if successful. More...
void	SetError (int err, const char *errorLocation, TiXmlParsingData *prevData, TiXmlEncoding encoding)
void	SetTabSize (int _tabsize)
int	TabSize () const
	TiXmlDocument ()
	Create an empty document, that has no name. More...
	TiXmlDocument (const char *documentName)
	Create a document with a name. The name of the document is also the filename of the xml. More...
	TiXmlDocument (const TiXmlDocument &copy)
virtual TiXmlDocument *	ToDocument ()
	Cast to a more defined type. Will return null not of the requested type. More...
virtual const TiXmlDocument *	ToDocument () const
	Cast to a more defined type. Will return null not of the requested type. More...
virtual	~TiXmlDocument ()
Public Member Functions inherited from TiXmlNode
virtual bool	Accept (TiXmlVisitor *visitor) const =0
void	Clear ()
	Delete all the children of this node. Does not affect 'this'. More...
virtual TiXmlNode *	Clone () const =0
TiXmlNode *	FirstChild ()
const TiXmlNode *	FirstChild () const
	The first child of this node. Will be null if there are no children. More...
TiXmlNode *	FirstChild (const char *_value)
	The first child of this node with the matching 'value'. Will be null if none found. More...
const TiXmlNode *	FirstChild (const char *value) const
TiXmlElement *	FirstChildElement ()
const TiXmlElement *	FirstChildElement () const
	Convenience function to get through elements. More...
TiXmlElement *	FirstChildElement (const char *_value)
const TiXmlElement *	FirstChildElement (const char *_value) const
	Convenience function to get through elements. More...
TiXmlDocument *	GetDocument ()
const TiXmlDocument *	GetDocument () const
TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)
TiXmlNode *	IterateChildren (const char *_value, const TiXmlNode *previous)
const TiXmlNode *	IterateChildren (const char *value, const TiXmlNode *previous) const
	This flavor of IterateChildren searches for children with a particular 'value'. More...
TiXmlNode *	IterateChildren (const TiXmlNode *previous)
const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const
TiXmlNode *	LastChild ()
	The last child of this node. Will be null if there are no children. More...
const TiXmlNode *	LastChild () const
TiXmlNode *	LastChild (const char *_value)
	The last child of this node matching 'value'. Will be null if there are no children. More...
const TiXmlNode *	LastChild (const char *value) const
TiXmlNode *	LinkEndChild (TiXmlNode *addThis)
TiXmlNode *	NextSibling ()
const TiXmlNode *	NextSibling () const
	Navigate to a sibling node. More...
const TiXmlNode *	NextSibling (const char *) const
	Navigate to a sibling node with the given 'value'. More...
TiXmlNode *	NextSibling (const char *_next)
TiXmlElement *	NextSiblingElement ()
const TiXmlElement *	NextSiblingElement () const
const TiXmlElement *	NextSiblingElement (const char *) const
TiXmlElement *	NextSiblingElement (const char *_next)
bool	NoChildren () const
	Returns true if this node has no children. More...
TiXmlNode *	Parent ()
	One step up the DOM. More...
const TiXmlNode *	Parent () const
TiXmlNode *	PreviousSibling ()
const TiXmlNode *	PreviousSibling () const
	Navigate to a sibling node. More...
const TiXmlNode *	PreviousSibling (const char *) const
	Navigate to a sibling node. More...
TiXmlNode *	PreviousSibling (const char *_prev)
bool	RemoveChild (TiXmlNode *removeThis)
	Delete a child of this node. More...
TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
void	SetValue (const char *_value)
virtual TiXmlComment *	ToComment ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlComment *	ToComment () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlDeclaration *	ToDeclaration () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlDocument *	ToDocument ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlDocument *	ToDocument () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlElement *	ToElement ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlElement *	ToElement () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlText *	ToText ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlText *	ToText () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlUnknown *	ToUnknown ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlUnknown *	ToUnknown () const
	Cast to a more defined type. Will return null if not of the requested type. More...
int	Type () const
const char *	Value () const
const TIXML_STRING &	ValueTStr () const
virtual	~TiXmlNode ()
Public Member Functions inherited from TiXmlBase
int	Column () const
	See Row() More...
void *	GetUserData ()
	Get a pointer to arbitrary user data. More...
const void *	GetUserData () const
	Get a pointer to arbitrary user data. More...
virtual const char *	Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)=0
virtual void	Print (FILE *cfile, int depth) const =0
int	Row () const
void	SetUserData (void *user)
	Set a pointer to arbitrary user data. More...
	TiXmlBase ()
virtual	~TiXmlBase ()

Protected Member Functions
virtual TiXmlNode *	Clone () const
Protected Member Functions inherited from TiXmlNode
void	CopyTo (TiXmlNode *target) const
TiXmlNode *	Identify (const char *start, TiXmlEncoding encoding)
	TiXmlNode (NodeType _type)

Private Member Functions
void	CopyTo (TiXmlDocument *target) const

Private Attributes
bool	error
TIXML_STRING	errorDesc
int	errorId
TiXmlCursor	errorLocation
int	tabsize
bool	useMicrosoftBOM

Additional Inherited Members
Public Types inherited from TiXmlNode
enum	NodeType {   TINYXML_DOCUMENT , TINYXML_ELEMENT , TINYXML_COMMENT , TINYXML_UNKNOWN ,   TINYXML_TEXT , TINYXML_DECLARATION , TINYXML_TYPECOUNT }
Public Types inherited from TiXmlBase
enum	{   TIXML_NO_ERROR = 0 , TIXML_ERROR , TIXML_ERROR_OPENING_FILE , TIXML_ERROR_PARSING_ELEMENT ,   TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME , TIXML_ERROR_READING_ELEMENT_VALUE , TIXML_ERROR_READING_ATTRIBUTES , TIXML_ERROR_PARSING_EMPTY ,   TIXML_ERROR_READING_END_TAG , TIXML_ERROR_PARSING_UNKNOWN , TIXML_ERROR_PARSING_COMMENT , TIXML_ERROR_PARSING_DECLARATION ,   TIXML_ERROR_DOCUMENT_EMPTY , TIXML_ERROR_EMBEDDED_NULL , TIXML_ERROR_PARSING_CDATA , TIXML_ERROR_DOCUMENT_TOP_ONLY ,   TIXML_ERROR_STRING_COUNT }
Static Public Member Functions inherited from TiXmlBase
static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting. More...
static void	SetCondenseWhiteSpace (bool condense)
Static Public Attributes inherited from TiXmlBase
static const int	utf8ByteTable [256]
Static Protected Member Functions inherited from TiXmlBase
static void	ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)
static const char *	GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
static const char *	GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
static int	IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
static int	IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
static bool	IsWhiteSpace (char c)
static bool	IsWhiteSpace (int c)
static const char *	ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding)
static const char *	ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static const char *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)
static bool	StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static int	ToLower (int v, TiXmlEncoding encoding)
Protected Attributes inherited from TiXmlNode
TiXmlNode *	firstChild
TiXmlNode *	lastChild
TiXmlNode *	next
TiXmlNode *	parent
TiXmlNode *	prev
NodeType	type
TIXML_STRING	value
Protected Attributes inherited from TiXmlBase
TiXmlCursor	location
void *	userData
	Field containing a generic user pointer. More...
Static Protected Attributes inherited from TiXmlBase
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

Detailed Description

Always the top level node. A document binds together all the XML pieces. It can be saved, loaded, and printed to the screen. The 'value' of a document node is the xml file name.

Constructor & Destructor Documentation

TiXmlDocument() [1/3]

TiXmlDocument::TiXmlDocument

(

)

Create an empty document, that has no name.

                             : TiXmlNode( TiXmlNode::TINYXML_DOCUMENT )
{
    tabsize = 4;
    useMicrosoftBOM = false;
    ClearError();
}

TiXmlDocument() [2/3]

TiXmlDocument::TiXmlDocument

(

const char *

documentName

)

Create a document with a name. The name of the document is also the filename of the xml.

                                                        : TiXmlNode( TiXmlNode::TINYXML_DOCUMENT )
{
    tabsize = 4;
    useMicrosoftBOM = false;
    value = documentName;
    ClearError();
}

TiXmlDocument() [3/3]

TiXmlDocument::TiXmlDocument

(

const TiXmlDocument &

copy

)

                                                        : TiXmlNode( TiXmlNode::TINYXML_DOCUMENT )
{
    copy.CopyTo( this );
}

~TiXmlDocument()

virtual TiXmlDocument::~TiXmlDocument ( )

inlinevirtual

{}

Member Function Documentation

Accept()

bool TiXmlDocument::Accept ( TiXmlVisitor *  content ) const

virtual

Walk the XML tree visiting this node and all of its children.

Implements TiXmlNode.

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

ClearError()

void TiXmlDocument::ClearError ( )

inline

If you have handled the error, it can be reset with this call. The error state is automatically cleared if you Parse a new XML block.

                                            {   error = false; 
                                                errorId = 0; 
                                                errorDesc = ""; 
                                                errorLocation.row = errorLocation.col = 0; 
                                                //errorLocation.last = 0; 
                                            }

Clone()

TiXmlNode * TiXmlDocument::Clone ( ) const

protectedvirtual

Create an exact duplicate of this node and return it. The memory must be deleted by the caller.

Implements TiXmlNode.

{
    TiXmlDocument* clone = new TiXmlDocument();
    if ( !clone )
        return 0;
 
    CopyTo( clone );
    return clone;
}

CopyTo()

void TiXmlDocument::CopyTo ( TiXmlDocument *  target ) const

private

{
    TiXmlNode::CopyTo( target );
 
    target->error = error;
    target->errorId = errorId;
    target->errorDesc = errorDesc;
    target->tabsize = tabsize;
    target->errorLocation = errorLocation;
    target->useMicrosoftBOM = useMicrosoftBOM;
 
    TiXmlNode* node = 0;
    for ( node = firstChild; node; node = node->NextSibling() )
    {
        target->LinkEndChild( node->Clone() );
    }   
}

Error()

bool TiXmlDocument::Error ( ) const

inline

If an error occurs, Error will be set to true. Also,

• The ErrorId() will contain the integer identifier of the error (not generally useful)
• The ErrorDesc() method will return the name of the error. (very useful)
• The ErrorRow() and ErrorCol() will return the location of the error (if known)

{ return error; }

ErrorCol()

int TiXmlDocument::ErrorCol ( ) const

inline

The column where the error occured. See ErrorRow()

ErrorDesc()

const char * TiXmlDocument::ErrorDesc ( ) const

inline

Contains a textual (english) description of the error if one occurs.

{ return errorDesc.c_str (); }

ErrorId()

int TiXmlDocument::ErrorId ( ) const

inline

Generally, you probably want the error string ( ErrorDesc() ). But if you prefer the ErrorId, this function will fetch it.

{ return errorId; }

ErrorRow()

int TiXmlDocument::ErrorRow ( ) const

inline

Returns the location (if known) of the error. The first column is column 1, and the first row is row 1. A value of 0 means the row and column wasn't applicable (memory errors, for example, have no row/column) or the parser lost the error. (An error in the error reporting, in that case.)

See also

SetTabSize, Row, Column

{ return errorLocation.row+1; }

LoadFile() [1/3]

bool TiXmlDocument::LoadFile	(	const char *	filename,
		TiXmlEncoding	encoding = TIXML_DEFAULT_ENCODING
	)

Load a file using the given filename. Returns true if successful.

{
    TIXML_STRING filename( _filename );
    value = filename;
 
    // reading in binary mode so that tinyxml can normalize the EOL
    FILE* file = TiXmlFOpen( value.c_str (), "rb" );    
 
    if ( file )
    {
        bool result = LoadFile( file, encoding );
        fclose( file );
        return result;
    }
    else
    {
        SetError( TIXML_ERROR_OPENING_FILE, 0, 0, TIXML_ENCODING_UNKNOWN );
        return false;
    }
}

LoadFile() [2/3]

bool TiXmlDocument::LoadFile	(	FILE *	file,
		TiXmlEncoding	encoding = TIXML_DEFAULT_ENCODING
	)

Load a file using the given FILE*. Returns true if successful. Note that this method doesn't stream - the entire object pointed at by the FILE* will be interpreted as an XML file. TinyXML doesn't stream in XML from the current file location. Streaming may be added in the future.

{
    if ( !file ) 
    {
        SetError( TIXML_ERROR_OPENING_FILE, 0, 0, TIXML_ENCODING_UNKNOWN );
        return false;
    }
 
    // Delete the existing data:
    Clear();
    location.Clear();
 
    // Get the file size, so we can pre-allocate the string. HUGE speed impact.
    long length = 0;
    fseek( file, 0, SEEK_END );
    length = ftell( file );
    fseek( file, 0, SEEK_SET );
 
    // Strange case, but good to handle up front.
    if ( length <= 0 )
    {
        SetError( TIXML_ERROR_DOCUMENT_EMPTY, 0, 0, TIXML_ENCODING_UNKNOWN );
        return false;
    }
 
    // Subtle bug here. TinyXml did use fgets. But from the XML spec:
    // 2.11 End-of-Line Handling
    // <snip>
    // <quote>
    // ...the XML processor MUST behave as if it normalized all line breaks in external 
    // parsed entities (including the document entity) on input, before parsing, by translating 
    // both the two-character sequence #xD #xA and any #xD that is not followed by #xA to 
    // a single #xA character.
    // </quote>
    //
    // It is not clear fgets does that, and certainly isn't clear it works cross platform. 
    // Generally, you expect fgets to translate from the convention of the OS to the c/unix
    // convention, and not work generally.
 
    /*
    while( fgets( buf, sizeof(buf), file ) )
    {
        data += buf;
    }
    */
 
    char* buf = new char[ length+1 ];
    buf[0] = 0;
 
    if ( fread( buf, length, 1, file ) != 1 ) {
        delete [] buf;
        SetError( TIXML_ERROR_OPENING_FILE, 0, 0, TIXML_ENCODING_UNKNOWN );
        return false;
    }
 
    // Process the buffer in place to normalize new lines. (See comment above.)
    // Copies from the 'p' to 'q' pointer, where p can advance faster if
    // a newline-carriage return is hit.
    //
    // Wikipedia:
    // Systems based on ASCII or a compatible character set use either LF  (Line feed, '\n', 0x0A, 10 in decimal) or 
    // CR (Carriage return, '\r', 0x0D, 13 in decimal) individually, or CR followed by LF (CR+LF, 0x0D 0x0A)...
    //      * LF:    Multics, Unix and Unix-like systems (GNU/Linux, AIX, Xenix, Mac OS X, FreeBSD, etc.), BeOS, Amiga, RISC OS, and others
    //      * CR+LF: DEC RT-11 and most other early non-Unix, non-IBM OSes, CP/M, MP/M, DOS, OS/2, Microsoft Windows, Symbian OS
    //      * CR:    Commodore 8-bit machines, Apple II family, Mac OS up to version 9 and OS-9
 
    const char* p = buf;    // the read head
    char* q = buf;          // the write head
    const char CR = 0x0d;
    const char LF = 0x0a;
 
    buf[length] = 0;
    while( *p ) {
        assert( p < (buf+length) );
        assert( q <= (buf+length) );
        assert( q <= p );
 
        if ( *p == CR ) {
            *q++ = LF;
            p++;
            if ( *p == LF ) {       // check for CR+LF (and skip LF)
                p++;
            }
        }
        else {
            *q++ = *p++;
        }
    }
    assert( q <= (buf+length) );
    *q = 0;
 
    Parse( buf, 0, encoding );
 
    delete [] buf;
    return !Error();
}

LoadFile() [3/3]

bool TiXmlDocument::LoadFile

(

TiXmlEncoding

encoding = TIXML_DEFAULT_ENCODING

)

Load a file using the current document value. Returns true if successful. Will delete any existing document data before loading.

{
    return LoadFile( Value(), encoding );
}

operator=()

TiXmlDocument & TiXmlDocument::operator=

(

const TiXmlDocument &

copy

)

{
    Clear();
    copy.CopyTo( this );
    return *this;
}

Parse()

const char * TiXmlDocument::Parse ( const char *  p, TiXmlParsingData *  data = 0, TiXmlEncoding  encoding = TIXML_DEFAULT_ENCODING  )

virtual

Parse the given null terminated block of xml data. Passing in an encoding to this method (either TIXML_ENCODING_LEGACY or TIXML_ENCODING_UTF8 will force TinyXml to use that encoding, regardless of what TinyXml might otherwise try to detect.

Implements TiXmlBase.

{
    ClearError();
 
    // Parse away, at the document level. Since a document
    // contains nothing but other tags, most of what happens
    // here is skipping white space.
    if ( !p || !*p )
    {
        SetError( TIXML_ERROR_DOCUMENT_EMPTY, 0, 0, TIXML_ENCODING_UNKNOWN );
        return 0;
    }
 
    // Note that, for a document, this needs to come
    // before the while space skip, so that parsing
    // starts from the pointer we are given.
    location.Clear();
    if ( prevData )
    {
        location.row = prevData->cursor.row;
        location.col = prevData->cursor.col;
    }
    else
    {
        location.row = 0;
        location.col = 0;
    }
    TiXmlParsingData data( p, TabSize(), location.row, location.col );
    location = data.Cursor();
 
    if ( encoding == TIXML_ENCODING_UNKNOWN )
    {
        // Check for the Microsoft UTF-8 lead bytes.
        const unsigned char* pU = (const unsigned char*)p;
        if (    *(pU+0) && *(pU+0) == TIXML_UTF_LEAD_0
             && *(pU+1) && *(pU+1) == TIXML_UTF_LEAD_1
             && *(pU+2) && *(pU+2) == TIXML_UTF_LEAD_2 )
        {
            encoding = TIXML_ENCODING_UTF8;
            useMicrosoftBOM = true;
        }
    }
 
    p = SkipWhiteSpace( p, encoding );
    if ( !p )
    {
        SetError( TIXML_ERROR_DOCUMENT_EMPTY, 0, 0, TIXML_ENCODING_UNKNOWN );
        return 0;
    }
 
    while ( p && *p )
    {
        TiXmlNode* node = Identify( p, encoding );
        if ( node )
        {
            p = node->Parse( p, &data, encoding );
            LinkEndChild( node );
        }
        else
        {
            break;
        }
 
        // Did we get encoding info?
        if (    encoding == TIXML_ENCODING_UNKNOWN
             && node->ToDeclaration() )
        {
            TiXmlDeclaration* dec = node->ToDeclaration();
            const char* enc = dec->Encoding();
            assert( enc );
 
            if ( *enc == 0 )
                encoding = TIXML_ENCODING_UTF8;
            else if ( StringEqual( enc, "UTF-8", true, TIXML_ENCODING_UNKNOWN ) )
                encoding = TIXML_ENCODING_UTF8;
            else if ( StringEqual( enc, "UTF8", true, TIXML_ENCODING_UNKNOWN ) )
                encoding = TIXML_ENCODING_UTF8; // incorrect, but be nice
            else 
                encoding = TIXML_ENCODING_LEGACY;
        }
 
        p = SkipWhiteSpace( p, encoding );
    }
 
    // Was this empty?
    if ( !firstChild ) {
        SetError( TIXML_ERROR_DOCUMENT_EMPTY, 0, 0, encoding );
        return 0;
    }
 
    // All is well.
    return p;
}

Print() [1/2]

void TiXmlDocument::Print ( ) const

inline

Write the document to standard out using formatted printing ("pretty print").

{ Print( stdout, 0 ); }

Print() [2/2]

void TiXmlDocument::Print ( FILE *  cfile, int  depth = 0  ) const

virtual

Print this Document to a FILE stream.

Implements TiXmlBase.

{
    assert( cfile );
    for ( const TiXmlNode* node=FirstChild(); node; node=node->NextSibling() )
    {
        node->Print( cfile, depth );
        fprintf( cfile, "\n" );
    }
}

RootElement() [1/2]

TiXmlElement * TiXmlDocument::RootElement ( )

inline

{ return FirstChildElement(); }

RootElement() [2/2]

const TiXmlElement * TiXmlDocument::RootElement ( ) const

inline

Get the root element – the only top level element – of the document. In well formed XML, there should only be one. TinyXml is tolerant of multiple elements at the document level.

{ return FirstChildElement(); }

SaveFile() [1/3]

bool TiXmlDocument::SaveFile

(

)

const

Save a file using the current document value. Returns true if successful.

{
    return SaveFile( Value() );
}

SaveFile() [2/3]

bool TiXmlDocument::SaveFile

(

const char *

filename

)

const

Save a file using the given filename. Returns true if successful.

{
    // The old c stuff lives on...
    FILE* fp = TiXmlFOpen( filename, "w" );
    if ( fp )
    {
        bool result = SaveFile( fp );
        fclose( fp );
        return result;
    }
    return false;
}

SaveFile() [3/3]

bool TiXmlDocument::SaveFile

(

FILE *

fp

)

const

Save a file using the given FILE*. Returns true if successful.

{
    if ( useMicrosoftBOM ) 
    {
        const unsigned char TIXML_UTF_LEAD_0 = 0xefU;
        const unsigned char TIXML_UTF_LEAD_1 = 0xbbU;
        const unsigned char TIXML_UTF_LEAD_2 = 0xbfU;
 
        fputc( TIXML_UTF_LEAD_0, fp );
        fputc( TIXML_UTF_LEAD_1, fp );
        fputc( TIXML_UTF_LEAD_2, fp );
    }
    Print( fp, 0 );
    return (ferror(fp) == 0);
}

SetError()

void TiXmlDocument::SetError	(	int	err,
		const char *	errorLocation,
		TiXmlParsingData *	prevData,
		TiXmlEncoding	encoding
	)

{   
    // The first error in a chain is more accurate - don't set again!
    if ( error )
        return;
 
    assert( err > 0 && err < TIXML_ERROR_STRING_COUNT );
    error   = true;
    errorId = err;
    errorDesc = errorString[ errorId ];
 
    errorLocation.Clear();
    if ( pError && data )
    {
        data->Stamp( pError, encoding );
        errorLocation = data->Cursor();
    }
}

SetTabSize()

void TiXmlDocument::SetTabSize ( int  _tabsize )

inline

SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column. It does not change the output or input in any way.

By calling this method, with a tab size greater than 0, the row and column of each node and attribute is stored when the file is loaded. Very useful for tracking the DOM back in to the source file.

The tab size is required for calculating the location of nodes. If not set, the default of 4 is used. The tabsize is set per document. Setting the tabsize to 0 disables row/column tracking.

Note that row and column tracking is not supported when using operator>>.

The tab size needs to be enabled before the parse or load. Correct usage:

TiXmlDocument doc;
doc.SetTabSize( 8 );
doc.Load( "myfile.xml" );

See also

Row, Column

{ tabsize = _tabsize; }

TabSize()

int TiXmlDocument::TabSize ( ) const

inline

{ return tabsize; }

ToDocument() [1/2]

virtual TiXmlDocument * TiXmlDocument::ToDocument ( )

inlinevirtual

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

ToDocument() [2/2]

virtual const TiXmlDocument * TiXmlDocument::ToDocument ( ) const

inlinevirtual

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

Member Data Documentation

error

bool TiXmlDocument::error

private

errorDesc

TIXML_STRING TiXmlDocument::errorDesc

private

errorId

int TiXmlDocument::errorId

private

errorLocation

TiXmlCursor TiXmlDocument::errorLocation

private

tabsize

int TiXmlDocument::tabsize

private

useMicrosoftBOM

bool TiXmlDocument::useMicrosoftBOM

private

---

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

• /home/antonio/fedra_doxygen/src/libScan/tinyxml.h
• /home/antonio/fedra_doxygen/src/libScan/tinyxml.cpp
• /home/antonio/fedra_doxygen/src/libScan/tinyxmlparser.cpp