TiXmlDocument Class Reference

#include <tinyxml.h>

Inheritance 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 occurred. 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 (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
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 (const std::string &filename, 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...
const TiXmlElement *	RootElement () const
TiXmlElement *	RootElement ()
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...
bool	SaveFile (const std::string &filename) const
	< STL std::string version. 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 std::string &documentName)
	Constructor. More...
	TiXmlDocument (const TiXmlDocument &copy)
virtual const TiXmlDocument *	ToDocument () const
	Cast to a more defined type. Will return null not of the requested type. More...
virtual TiXmlDocument *	ToDocument ()
	Cast to a more defined type. Will return null not of the requested type. More...
virtual	~TiXmlDocument ()
Public Member Functions inherited from TiXmlNode
void	Clear ()
	Delete all the children of this node. Does not affect 'this'. More...
const TiXmlNode *	FirstChild () const
	The first child of this node. Will be null if there are no children. More...
TiXmlNode *	FirstChild ()
const TiXmlNode *	FirstChild (const char *value) const
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 std::string &_value) const
	STL std::string form. More...
TiXmlNode *	FirstChild (const std::string &_value)
	STL std::string form. More...
const TiXmlElement *	FirstChildElement () const
	Convenience function to get through elements. More...
TiXmlElement *	FirstChildElement ()
const TiXmlElement *	FirstChildElement (const char *_value) const
	Convenience function to get through elements. More...
TiXmlElement *	FirstChildElement (const char *_value)
const TiXmlElement *	FirstChildElement (const std::string &_value) const
	STL std::string form. More...
TiXmlElement *	FirstChildElement (const std::string &_value)
	STL std::string form. More...
const TiXmlDocument *	GetDocument () const
TiXmlDocument *	GetDocument ()
TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)
const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const
TiXmlNode *	IterateChildren (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 char *_value, const TiXmlNode *previous)
const TiXmlNode *	IterateChildren (const std::string &_value, const TiXmlNode *previous) const
	STL std::string form. More...
TiXmlNode *	IterateChildren (const std::string &_value, const TiXmlNode *previous)
	STL std::string form. More...
const TiXmlNode *	LastChild () const
TiXmlNode *	LastChild ()
	The last child of this node. Will be null if there are no children. More...
const TiXmlNode *	LastChild (const char *value) 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 std::string &_value) const
	STL std::string form. More...
TiXmlNode *	LastChild (const std::string &_value)
	STL std::string form. More...
TiXmlNode *	LinkEndChild (TiXmlNode *addThis)
const TiXmlNode *	NextSibling (const std::string &_value) const
	STL std::string form. More...
TiXmlNode *	NextSibling (const std::string &_value)
	STL std::string form. More...
const TiXmlNode *	NextSibling () const
	Navigate to a sibling node. More...
TiXmlNode *	NextSibling ()
const TiXmlNode *	NextSibling (const char *) const
	Navigate to a sibling node with the given 'value'. More...
TiXmlNode *	NextSibling (const char *_next)
const TiXmlElement *	NextSiblingElement () const
TiXmlElement *	NextSiblingElement ()
const TiXmlElement *	NextSiblingElement (const char *) const
TiXmlElement *	NextSiblingElement (const char *_next)
const TiXmlElement *	NextSiblingElement (const std::string &_value) const
	STL std::string form. More...
TiXmlElement *	NextSiblingElement (const std::string &_value)
	STL std::string form. More...
bool	NoChildren () const
	Returns true if this node has no children. More...
TiXmlNode *	Parent ()
	One step up the DOM. More...
const TiXmlNode *	Parent () const
const TiXmlNode *	PreviousSibling () const
	Navigate to a sibling node. More...
TiXmlNode *	PreviousSibling ()
const TiXmlNode *	PreviousSibling (const char *) const
	Navigate to a sibling node. More...
TiXmlNode *	PreviousSibling (const char *_prev)
const TiXmlNode *	PreviousSibling (const std::string &_value) const
	STL std::string form. More...
TiXmlNode *	PreviousSibling (const std::string &_value)
	STL std::string form. More...
bool	RemoveChild (TiXmlNode *removeThis)
	Delete a child of this node. More...
TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
void	SetValue (const char *_value)
void	SetValue (const std::string &_value)
	STL std::string form. More...
virtual const TiXmlComment *	ToComment () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlComment *	ToComment ()
	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 TiXmlDeclaration *	ToDeclaration ()
	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 TiXmlElement *	ToElement ()
	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 TiXmlText *	ToText ()
	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...
virtual TiXmlUnknown *	ToUnknown ()
	Cast to a more defined type. Will return null if not of the requested type. More...
int	Type () const
const char *	Value () const
const std::string &	ValueStr () const
const std::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...
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
virtual void	StreamIn (std::istream *in, std::string *tag)
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
std::string	errorDesc
int	errorId
TiXmlCursor	errorLocation
int	tabsize
bool	useMicrosoftBOM

Additional Inherited Members
Public Types inherited from TiXmlNode
enum	NodeType {   DOCUMENT, ELEMENT, COMMENT, UNKNOWN,   TEXT, DECLARATION, TYPECOUNT }
Public Types inherited from TiXmlBase
enum	{   TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY,   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 std::string &str, std::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, std::string *name, TiXmlEncoding encoding)
static const char *	ReadText (const char *in, std::string *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static const char *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)
static bool	StreamTo (std::istream *in, int character, std::string *tag)
static bool	StreamWhiteSpace (std::istream *in, std::string *tag)
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
std::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 *const	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.

Definition at line 1388 of file tinyxml.h.

Constructor & Destructor Documentation

TiXmlDocument::TiXmlDocument

(

)

Create an empty document, that has no name.

Definition at line 893 of file tinyxml.cc.

References ClearError(), tabsize, and useMicrosoftBOM.

Referenced by Clone().

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

TiXmlDocument::TiXmlDocument

(

const char *

documentName

)

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

Definition at line 900 of file tinyxml.cc.

References ClearError(), tabsize, useMicrosoftBOM, and TiXmlNode::value.

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

TiXmlDocument::TiXmlDocument

(

const std::string &

documentName

)

Constructor.

Definition at line 910 of file tinyxml.cc.

References ClearError(), tabsize, useMicrosoftBOM, and TiXmlNode::value.

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

TiXmlDocument::TiXmlDocument

(

const TiXmlDocument &

copy

)

Definition at line 920 of file tinyxml.cc.

References CopyTo().

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

virtual TiXmlDocument::~TiXmlDocument ( )

inlinevirtual

Definition at line 1404 of file tinyxml.h.

{}

Member Function Documentation

bool TiXmlDocument::Accept ( TiXmlVisitor *  content ) const

virtual

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

Implements TiXmlNode.

Definition at line 1170 of file tinyxml.cc.

References TiXmlNode::FirstChild(), TiXmlNode::NextSibling(), TiXmlVisitor::VisitEnter(), and TiXmlVisitor::VisitExit().

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

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.

Definition at line 1510 of file tinyxml.h.

References TiXmlCursor::col, error, errorDesc, errorId, errorLocation, and TiXmlCursor::row.

Referenced by Parse(), and TiXmlDocument().

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

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.

Definition at line 1148 of file tinyxml.cc.

References clone(), CopyTo(), and TiXmlDocument().

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

    CopyTo( clone );
    return clone;
}

void TiXmlDocument::CopyTo ( TiXmlDocument *  target ) const

private

Definition at line 1129 of file tinyxml.cc.

References TiXmlNode::Clone(), TiXmlNode::CopyTo(), error, errorDesc, errorId, errorLocation, TiXmlNode::firstChild, TiXmlNode::LinkEndChild(), TiXmlNode::NextSibling(), tabsize, and useMicrosoftBOM.

Referenced by Clone(), operator=(), and TiXmlDocument().

{
    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() );
    }
}

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)

Definition at line 1459 of file tinyxml.h.

References error.

Referenced by RivetHarvesting::getPoint2DValsErrs(), and LoadFile().

{ return error; }

int TiXmlDocument::ErrorCol ( ) const

inline

The column where the error occurred. See ErrorRow()

Definition at line 1477 of file tinyxml.h.

References TiXmlCursor::col, and errorLocation.

const char* TiXmlDocument::ErrorDesc ( ) const

inline

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

Definition at line 1462 of file tinyxml.h.

References errorDesc.

Referenced by RivetHarvesting::getPoint2DValsErrs().

{ return errorDesc.c_str (); }

int TiXmlDocument::ErrorId ( ) const

inline

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

Definition at line 1467 of file tinyxml.h.

References errorId.

{ return errorId; }

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

Definition at line 1476 of file tinyxml.h.

References errorLocation, and TiXmlCursor::row.

{ return errorLocation.row+1; }

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.

Definition at line 934 of file tinyxml.cc.

References TiXmlNode::Value().

Referenced by RivetHarvesting::getPoint2DValsErrs(), and LoadFile().

{
    // See STL_STRING_BUG below.
    //StringToBuffer buf( value );

    return LoadFile( Value(), encoding );
}

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

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

Definition at line 955 of file tinyxml.cc.

References mergeVDriftHistosByStation::file, lut2db_cfg::filename, LoadFile(), query::result, SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_OPENING_FILE, TIXML_STRING, TiXmlFOpen(), and TiXmlNode::value.

{
    // There was a really terrifying little bug here. The code:
    //      value = filename
    // in the STL case, cause the assignment method of the std::string to
    // be called. What is strange, is that the std::string had the same
    // address as it's c_str() method, and so bad things happen. Looks
    // like a bug in the Microsoft STL implementation.
    // Add an extra string to avoid the crash.
    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;
    }
}

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.

Definition at line 983 of file tinyxml.cc.

References assert(), hitfit::char, TiXmlCursor::Clear(), TiXmlNode::Clear(), data, Error(), TiXmlBase::location, AlCaHLTBitMon_ParallelJobs::p, Parse(), SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_EMPTY, TiXmlBase::TIXML_ERROR_OPENING_FILE, and TIXML_STRING.

{
    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;
    }

    // If we have a file, assume it is all one big XML file, and read it in.
    // The document parser may decide the document ends sooner than the entire file, however.
    TIXML_STRING data;
    data.reserve( length );

    // 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;
    }

    const char* lastPos = buf;
    const char* p = buf;

    buf[length] = 0;
    while( *p ) {
        assert( p < (buf+length) );
        if ( *p == 0xa ) {
            // Newline character. No special rules for this. Append all the characters
            // since the last string, and include the newline.
            data.append( lastPos, (p-lastPos+1) );  // append, include the newline
            ++p;                                    // move past the newline
            lastPos = p;                            // and point to the new buffer (may be 0)
            assert( p <= (buf+length) );
        }
        else if ( *p == 0xd ) {
            // Carriage return. Append what we have so far, then
            // handle moving forward in the buffer.
            if ( (p-lastPos) > 0 ) {
                data.append( lastPos, p-lastPos );  // do not add the CR
            }
            data += (char)0xa;                      // a proper newline

            if ( *(p+1) == 0xa ) {
                // Carriage return - new line sequence
                p += 2;
                lastPos = p;
                assert( p <= (buf+length) );
            }
            else {
                // it was followed by something else...that is presumably characters again.
                ++p;
                lastPos = p;
                assert( p <= (buf+length) );
            }
        }
        else {
            ++p;
        }
    }
    // Handle any left over characters.
    if ( p-lastPos ) {
        data.append( lastPos, p-lastPos );
    }
    delete [] buf;
    buf = 0;

    Parse( data.c_str(), 0, encoding );

    if (  Error() )
        return false;
    else
        return true;
}

bool TiXmlDocument::LoadFile ( const std::string &  filename, TiXmlEncoding  encoding = TIXML_DEFAULT_ENCODING  )

inline

Parameters

encoding

STL std::string version.

Definition at line 1427 of file tinyxml.h.

References LoadFile().

    {
//      StringToBuffer f( filename );
//      return ( f.buffer && LoadFile( f.buffer, encoding ));
        return LoadFile( filename.c_str(), encoding );
    }

TiXmlDocument & TiXmlDocument::operator=

(

const TiXmlDocument &

copy

)

Definition at line 926 of file tinyxml.cc.

References TiXmlNode::Clear(), and CopyTo().

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

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.

Definition at line 716 of file tinyxmlparser.cc.

References assert(), TiXmlCursor::Clear(), ClearError(), TiXmlCursor::col, TiXmlParsingData::Cursor(), TiXmlParsingData::cursor, data, TauDecayModes::dec, TiXmlDeclaration::Encoding(), TiXmlNode::firstChild, TiXmlNode::Identify(), TiXmlNode::LinkEndChild(), TiXmlBase::location, AlCaHLTBitMon_ParallelJobs::p, TiXmlBase::Parse(), TiXmlCursor::row, SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlBase::StringEqual(), TabSize(), TIXML_ENCODING_LEGACY, TIXML_ENCODING_UNKNOWN, TIXML_ENCODING_UTF8, TiXmlBase::TIXML_ERROR_DOCUMENT_EMPTY, TIXML_UTF_LEAD_0, TIXML_UTF_LEAD_1, TIXML_UTF_LEAD_2, TiXmlNode::ToDeclaration(), and useMicrosoftBOM.

Referenced by LoadFile().

{
    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 just returns the input pointer unmodified,
            // except if node is deleted, in which case it returns 0.
            node = LinkEndChild( node );
        }
        else
        {
            break;
        }

        // Did we get encoding info?
        if (    encoding == TIXML_ENCODING_UNKNOWN
             && node && 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;
}

void TiXmlDocument::Print ( void  ) const

inline

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

Definition at line 1518 of file tinyxml.h.

References Print().

Referenced by Print(), and SaveFile().

{ Print( stdout, 0 ); }

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

virtual

Print this Document to a FILE stream.

Implements TiXmlBase.

Definition at line 1159 of file tinyxml.cc.

References assert(), TiXmlNode::FirstChild(), and TiXmlNode::NextSibling().

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

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.

Definition at line 1451 of file tinyxml.h.

References TiXmlNode::FirstChildElement().

{ return FirstChildElement(); }

TiXmlElement* TiXmlDocument::RootElement ( )

inline

Definition at line 1452 of file tinyxml.h.

References TiXmlNode::FirstChildElement().

{ return FirstChildElement(); }

bool TiXmlDocument::SaveFile

(

)

const

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

Definition at line 943 of file tinyxml.cc.

References TiXmlNode::Value().

Referenced by SaveFile().

{
    // See STL_STRING_BUG below.
//  StringToBuffer buf( value );
//
//  if ( buf.buffer && SaveFile( buf.buffer ) )
//      return true;
//
//  return false;
    return SaveFile( Value() );
}

bool TiXmlDocument::SaveFile

(

const char *

filename

)

const

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

Definition at line 1098 of file tinyxml.cc.

References personalPlayback::fp, query::result, SaveFile(), and TiXmlFOpen().

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

bool TiXmlDocument::SaveFile

(

FILE *

fp

)

const

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

Definition at line 1112 of file tinyxml.cc.

References Print(), TIXML_UTF_LEAD_0, TIXML_UTF_LEAD_1, TIXML_UTF_LEAD_2, and useMicrosoftBOM.

{
    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);
}

bool TiXmlDocument::SaveFile ( const std::string &  filename ) const

inline

< STL std::string version.

Definition at line 1433 of file tinyxml.h.

References lut2db_cfg::filename, and SaveFile().

    {
//      StringToBuffer f( filename );
//      return ( f.buffer && SaveFile( f.buffer ));
        return SaveFile( filename.c_str() );
    }

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

Definition at line 812 of file tinyxmlparser.cc.

References assert(), TiXmlCursor::Clear(), TiXmlParsingData::Cursor(), error, errorDesc, errorId, errorLocation, TiXmlBase::errorString, TiXmlParsingData::Stamp(), and TiXmlBase::TIXML_ERROR_STRING_COUNT.

Referenced by TiXmlNode::Identify(), TiXmlNode::InsertAfterChild(), TiXmlNode::InsertBeforeChild(), TiXmlNode::InsertEndChild(), TiXmlNode::LinkEndChild(), LoadFile(), TiXmlAttribute::Parse(), TiXmlElement::Parse(), TiXmlComment::Parse(), TiXmlText::Parse(), TiXmlDeclaration::Parse(), TiXmlUnknown::Parse(), Parse(), TiXmlElement::ReadValue(), TiXmlElement::SetAttribute(), TiXmlElement::StreamIn(), TiXmlComment::StreamIn(), TiXmlText::StreamIn(), TiXmlDeclaration::StreamIn(), TiXmlUnknown::StreamIn(), and StreamIn().

{
    // 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();
    }
}

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

Definition at line 1503 of file tinyxml.h.

References tabsize.

{ tabsize = _tabsize; }

void TiXmlDocument::StreamIn ( std::istream *  in, std::string *  tag  )

protectedvirtual

Implements TiXmlNode.

Definition at line 653 of file tinyxmlparser.cc.

References EnergyCorrector::c, hitfit::char, TiXmlNode::Identify(), SetError(), TiXmlNode::StreamIn(), TiXmlBase::StreamTo(), TIXML_DEFAULT_ENCODING, TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR, TiXmlBase::TIXML_ERROR_EMBEDDED_NULL, TiXmlBase::TIXML_ERROR_PARSING_EMPTY, and TiXmlNode::ToElement().

{
    // The basic issue with a document is that we don't know what we're
    // streaming. Read something presumed to be a tag (and hope), then
    // identify it, and call the appropriate stream method on the tag.
    //
    // This "pre-streaming" will never read the closing ">" so the
    // sub-tag can orient itself.

    if ( !StreamTo( in, '<', tag ) )
    {
        SetError( TIXML_ERROR_PARSING_EMPTY, 0, 0, TIXML_ENCODING_UNKNOWN );
        return;
    }

    while ( in->good() )
    {
        int tagIndex = (int) tag->length();
        while ( in->good() && in->peek() != '>' )
        {
            int c = in->get();
            if ( c <= 0 )
            {
                SetError( TIXML_ERROR_EMBEDDED_NULL, 0, 0, TIXML_ENCODING_UNKNOWN );
                break;
            }
            (*tag) += (char) c;
        }

        if ( in->good() )
        {
            // We now have something we presume to be a node of
            // some sort. Identify it, and call the node to
            // continue streaming.
            TiXmlNode* node = Identify( tag->c_str() + tagIndex, TIXML_DEFAULT_ENCODING );

            if ( node )
            {
                node->StreamIn( in, tag );
                bool isElement = node->ToElement() != 0;
                delete node;
                node = 0;

                // If this is the root element, we're done. Parsing will be
                // done by the >> operator.
                if ( isElement )
                {
                    return;
                }
            }
            else
            {
                SetError( TIXML_ERROR, 0, 0, TIXML_ENCODING_UNKNOWN );
                return;
            }
        }
    }
    // We should have returned sooner.
    SetError( TIXML_ERROR, 0, 0, TIXML_ENCODING_UNKNOWN );
}

int TiXmlDocument::TabSize ( ) const

inline

Definition at line 1505 of file tinyxml.h.

References tabsize.

Referenced by Parse().

{ return tabsize; }

virtual const TiXmlDocument* TiXmlDocument::ToDocument ( ) const

inlinevirtual

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

Reimplemented from TiXmlNode.

Definition at line 1531 of file tinyxml.h.

virtual TiXmlDocument* TiXmlDocument::ToDocument ( )

inlinevirtual

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

Reimplemented from TiXmlNode.

Definition at line 1532 of file tinyxml.h.

Member Data Documentation

bool TiXmlDocument::error

private

Definition at line 1548 of file tinyxml.h.

Referenced by argparse.ArgumentParser::_get_option_tuples(), python.rootplot.argparse.ArgumentParser::_get_option_tuples(), argparse.ArgumentParser::_parse_known_args(), python.rootplot.argparse.ArgumentParser::_parse_known_args(), argparse.ArgumentParser::_parse_optional(), python.rootplot.argparse.ArgumentParser::_parse_optional(), argparse.ArgumentParser::_read_args_from_files(), python.rootplot.argparse.ArgumentParser::_read_args_from_files(), argparse.ArgumentParser::add_subparsers(), python.rootplot.argparse.ArgumentParser::add_subparsers(), ClearError(), CopyTo(), Error(), argparse.ArgumentParser::parse_args(), python.rootplot.argparse.ArgumentParser::parse_args(), argparse.ArgumentParser::parse_known_args(), python.rootplot.argparse.ArgumentParser::parse_known_args(), and SetError().

std::string TiXmlDocument::errorDesc

private

Definition at line 1550 of file tinyxml.h.

Referenced by ClearError(), CopyTo(), ErrorDesc(), and SetError().

int TiXmlDocument::errorId

private

Definition at line 1549 of file tinyxml.h.

Referenced by ClearError(), CopyTo(), ErrorId(), and SetError().

TiXmlCursor TiXmlDocument::errorLocation

private

Definition at line 1552 of file tinyxml.h.

Referenced by ClearError(), CopyTo(), ErrorCol(), ErrorRow(), and SetError().

int TiXmlDocument::tabsize

private

Definition at line 1551 of file tinyxml.h.

Referenced by CopyTo(), SetTabSize(), TabSize(), and TiXmlDocument().

bool TiXmlDocument::useMicrosoftBOM

private

Definition at line 1553 of file tinyxml.h.

Referenced by CopyTo(), Parse(), SaveFile(), and TiXmlDocument().