|
|
|
#include <tinyxml.h>
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() | |
| const char * | ErrorDesc () const |
| Contains a textual (english) description of the error if one occurs. | |
| 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. | |
| bool | LoadFile (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
| bool | LoadFile (const std::string &filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
| TiXmlDocument & | operator= (const TiXmlDocument ©) |
| virtual const char * | Parse (const char *p, TiXmlParsingData *data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
| virtual void | Print (FILE *cfile, int depth=0) const |
| Print this Document to a FILE stream. | |
| void | Print () const |
| TiXmlElement * | RootElement () |
| const TiXmlElement * | RootElement () const |
| bool | SaveFile () const |
| Save a file using the current document value. Returns true if successful. | |
| bool | SaveFile (FILE *) const |
| Save a file using the given FILE*. Returns true if successful. | |
| bool | SaveFile (const char *filename) const |
| Save a file using the given filename. Returns true if successful. | |
| bool | SaveFile (const std::string &filename) const |
| < STL std::string version. | |
| void | SetError (int err, const char *errorLocation, TiXmlParsingData *prevData, TiXmlEncoding encoding) |
| void | SetTabSize (int _tabsize) |
| int | TabSize () const |
| TiXmlDocument (const std::string &documentName) | |
| Constructor. | |
| TiXmlDocument (const TiXmlDocument ©) | |
| TiXmlDocument (const char *documentName) | |
| Create a document with a name. The name of the document is also the filename of the xml. | |
| TiXmlDocument () | |
| Create an empty document, that has no name. | |
| virtual const TiXmlDocument * | ToDocument () const |
| Cast to a more defined type. Will return null not of the requested type. | |
| virtual TiXmlDocument * | ToDocument () |
| Cast to a more defined type. Will return null not of the requested type. | |
| virtual | ~TiXmlDocument () |
Protected Member Functions | |
| virtual TiXmlNode * | Clone () const |
| virtual void | StreamIn (std::istream *in, TIXML_STRING *tag) |
Private Member Functions | |
| void | CopyTo (TiXmlDocument *target) const |
Private Attributes | |
| bool | error |
| TIXML_STRING | errorDesc |
| int | errorId |
| TiXmlCursor | errorLocation |
| int | tabsize |
| bool | useMicrosoftBOM |
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.
| 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.
| TiXmlDocument::TiXmlDocument | ( | const TiXmlDocument & | copy | ) |
Definition at line 920 of file tinyxml.cc.
References CopyTo().
: TiXmlNode( TiXmlNode::DOCUMENT ) { copy.CopyTo( this ); }
| virtual TiXmlDocument::~TiXmlDocument | ( | ) | [inline, virtual] |
| 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(), python::Node::node, TiXmlVisitor::VisitEnter(), and TiXmlVisitor::VisitExit().
| 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 [protected, virtual] |
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(), error, errorDesc, errorId, errorLocation, TiXmlNode::firstChild, TiXmlNode::LinkEndChild(), TiXmlNode::NextSibling(), python::Node::node, 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,
Definition at line 1459 of file tinyxml.h.
References error.
Referenced by 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] |
| 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.)
Definition at line 1476 of file tinyxml.h.
References errorLocation, and TiXmlCursor::row.
{ return errorLocation.row+1; }
| 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 | ( | const std::string & | filename, |
| TiXmlEncoding | encoding = TIXML_DEFAULT_ENCODING |
||
| ) | [inline] |
| encoding | STL std::string version. |
Definition at line 1427 of file tinyxml.h.
References LoadFile().
| 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 TiXmlNode::Clear(), TiXmlCursor::Clear(), AlCaHLTBitMon_QueryRunRegistry::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 | ( | 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 LoadFile().
| TiXmlDocument & TiXmlDocument::operator= | ( | const TiXmlDocument & | copy | ) |
Definition at line 926 of file tinyxml.cc.
References TiXmlNode::Clear(), and CopyTo().
| 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 712 of file tinyxmlparser.cc.
References TiXmlCursor::Clear(), ClearError(), TiXmlCursor::col, TiXmlParsingData::cursor, TiXmlParsingData::Cursor(), AlCaHLTBitMon_QueryRunRegistry::data, 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] |
| 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 TiXmlNode::FirstChild(), python::Node::node, and TiXmlAttribute::Print().
| 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 char * | filename | ) | const |
Save a file using the given filename. Returns true if successful.
Definition at line 1098 of file tinyxml.cc.
References 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 | ( | const std::string & | filename | ) | const [inline] |
< STL std::string version.
Definition at line 1433 of file tinyxml.h.
References lut2db_cfg::filename, and SaveFile().
| 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 |
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().
| void TiXmlDocument::SetError | ( | int | err, |
| const char * | errorLocation, | ||
| TiXmlParsingData * | prevData, | ||
| TiXmlEncoding | encoding | ||
| ) |
Definition at line 808 of file tinyxmlparser.cc.
References 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(), TiXmlElement::Parse(), TiXmlComment::Parse(), TiXmlAttribute::Parse(), Parse(), TiXmlDeclaration::Parse(), TiXmlUnknown::Parse(), TiXmlText::Parse(), TiXmlElement::ReadValue(), and TiXmlElement::SetAttribute().
{
// 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" );
Definition at line 1503 of file tinyxml.h.
References tabsize.
{ tabsize = _tabsize; }
| virtual void TiXmlDocument::StreamIn | ( | std::istream * | in, |
| TIXML_STRING * | tag | ||
| ) | [protected, virtual] |
Implements TiXmlNode.
| int TiXmlDocument::TabSize | ( | ) | const [inline] |
| virtual const TiXmlDocument* TiXmlDocument::ToDocument | ( | ) | const [inline, virtual] |
| virtual TiXmlDocument* TiXmlDocument::ToDocument | ( | ) | [inline, virtual] |
bool TiXmlDocument::error [private] |
Definition at line 1548 of file tinyxml.h.
Referenced by ClearError(), CopyTo(), Error(), and SetError().
TIXML_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().
1.7.3