|
osgEarth 2.1.1
|
|
osgEarth 2.1.1
|
#include <tinyxml.h>
Inheritance diagram for TiXmlDocument: Collaboration diagram for TiXmlDocument:Public Member Functions | |
| TiXmlDocument () | |
| Create an empty document, that has no name. | |
| TiXmlDocument (const char *documentName) | |
| Create a document with a name. The name of the document is also the filename of the xml. | |
| TiXmlDocument (const TiXmlDocument ©) | |
| void | operator= (const TiXmlDocument ©) |
| virtual | ~TiXmlDocument () |
| bool | LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
| bool | SaveFile () const |
| Save a file using the current document value. Returns true if successful. | |
| bool | LoadFile (const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
| Load a file using the given filename. Returns true if successful. | |
| bool | SaveFile (const char *filename) const |
| Save a file using the given filename. Returns true if successful. | |
| bool | LoadFile (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
| bool | SaveFile (FILE *) const |
| Save a file using the given FILE*. Returns true if successful. | |
| virtual const char * | Parse (const char *p, TiXmlParsingData *data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
| const TiXmlElement * | RootElement () const |
| TiXmlElement * | RootElement () |
| bool | Error () const |
| const char * | ErrorDesc () const |
| Contains a textual (english) description of the error if one occurs. | |
| int | ErrorId () const |
| int | ErrorRow () const |
| int | ErrorCol () const |
| The column where the error occured. See ErrorRow() | |
| void | SetTabSize (int _tabsize) |
| int | TabSize () const |
| void | ClearError () |
| void | Print () const |
| virtual void | Print (FILE *cfile, int depth=0) const |
| Print this Document to a FILE stream. | |
| void | SetError (int err, const char *errorLocation, TiXmlParsingData *prevData, TiXmlEncoding encoding) |
| 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 bool | Accept (TiXmlVisitor *content) const |
Protected Member Functions | |
| virtual TiXmlNode * | Clone () const |
Private Member Functions | |
| void | CopyTo (TiXmlDocument *target) const |
Private Attributes | |
| bool | error |
| int | errorId |
| TIXML_STRING | errorDesc |
| int | tabsize |
| TiXmlCursor | errorLocation |
| 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 869 of file tinyxml.cpp.
: TiXmlNode( TiXmlNode::TINYXML_DOCUMENT ) { tabsize = 4; useMicrosoftBOM = false; ClearError(); }
Here is the call graph for this function: Here is the caller graph for this function:| 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 876 of file tinyxml.cpp.
: TiXmlNode( TiXmlNode::TINYXML_DOCUMENT ) { tabsize = 4; useMicrosoftBOM = false; value = documentName; ClearError(); }
Here is the call graph for this function:| TiXmlDocument::TiXmlDocument | ( | const TiXmlDocument & | copy | ) |
Definition at line 896 of file tinyxml.cpp.
: TiXmlNode( TiXmlNode::TINYXML_DOCUMENT ) { copy.CopyTo( this ); }
Here is the call graph for this function:| 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 1111 of file tinyxml.cpp.
{
if ( visitor->VisitEnter( *this ) )
{
for ( const TiXmlNode* node=FirstChild(); node; node=node->NextSibling() )
{
if ( !node->Accept( visitor ) )
break;
}
}
return visitor->VisitExit( *this );
}
Here is the call graph for this function:| 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 1504 of file tinyxml.h.
{ error = false;
errorId = 0;
errorDesc = "";
errorLocation.row = errorLocation.col = 0;
//errorLocation.last = 0;
}
Here is the caller graph for this function:| 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 1089 of file tinyxml.cpp.
{
TiXmlDocument* clone = new TiXmlDocument();
if ( !clone )
return 0;
CopyTo( clone );
return clone;
}
Here is the call graph for this function:| void TiXmlDocument::CopyTo | ( | TiXmlDocument * | target | ) | const [private] |
Definition at line 1070 of file tinyxml.cpp.
{
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() );
}
}
Here is the call graph for this function: Here is the caller graph for this function:| bool TiXmlDocument::Error | ( | ) | const [inline] |
If an error occurs, Error will be set to true. Also,
Definition at line 1453 of file tinyxml.h.
{ return error; }
Here is the caller graph for this function:| int TiXmlDocument::ErrorCol | ( | ) | const [inline] |
The column where the error occured. See ErrorRow()
Definition at line 1471 of file tinyxml.h.
Here is the caller graph for this function:| 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 1461 of file tinyxml.h.
{ 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 1470 of file tinyxml.h.
{ return errorLocation.row+1; }
Here is the caller graph for this function:| 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 909 of file tinyxml.cpp.
Here is the call graph for this function: Here is the caller graph for this function:| 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 920 of file tinyxml.cpp.
{
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;
}
}
Here is the call graph for this function:| 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 941 of file tinyxml.cpp.
{
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();
}
Here is the call graph for this function:| void TiXmlDocument::operator= | ( | const TiXmlDocument & | copy | ) |
| 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 704 of file tinyxmlparser.cpp.
{
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;
}
Here is the call graph for this function: Here is the caller graph for this function:| void TiXmlDocument::Print | ( | ) | const [inline] |
| void TiXmlDocument::Print | ( | FILE * | cfile, |
| int | depth = 0 |
||
| ) | const [virtual] |
Print this Document to a FILE stream.
Implements TiXmlBase.
Definition at line 1100 of file tinyxml.cpp.
{
assert( cfile );
for ( const TiXmlNode* node=FirstChild(); node; node=node->NextSibling() )
{
node->Print( cfile, depth );
fprintf( cfile, "\n" );
}
}
Here is the call graph for this function:| 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 1445 of file tinyxml.h.
{ return FirstChildElement(); }
Here is the call graph for this function: Here is the caller graph for this function:| TiXmlElement* TiXmlDocument::RootElement | ( | ) | [inline] |
Definition at line 1446 of file tinyxml.h.
{ return FirstChildElement(); }
Here is the call graph for this function:| bool TiXmlDocument::SaveFile | ( | FILE * | fp | ) | const |
Save a file using the given FILE*. Returns true if successful.
Definition at line 1053 of file tinyxml.cpp.
{
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);
}
Here is the call graph for this function:| bool TiXmlDocument::SaveFile | ( | ) | const |
Save a file using the current document value. Returns true if successful.
Definition at line 915 of file tinyxml.cpp.
Here is the call graph for this function: Here is the caller graph for this function:| bool TiXmlDocument::SaveFile | ( | const char * | filename | ) | const |
Save a file using the given filename. Returns true if successful.
Definition at line 1039 of file tinyxml.cpp.
{
// The old c stuff lives on...
FILE* fp = TiXmlFOpen( filename, "w" );
if ( fp )
{
bool result = SaveFile( fp );
fclose( fp );
return result;
}
return false;
}
Here is the call graph for this function:| void TiXmlDocument::SetError | ( | int | err, |
| const char * | errorLocation, | ||
| TiXmlParsingData * | prevData, | ||
| TiXmlEncoding | encoding | ||
| ) |
Definition at line 798 of file tinyxmlparser.cpp.
{
// 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();
}
}
Here is the call graph for this function: Here is the caller graph for this function:| 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 1497 of file tinyxml.h.
{ tabsize = _tabsize; }
| int TiXmlDocument::TabSize | ( | ) | const [inline] |
| virtual TiXmlDocument* TiXmlDocument::ToDocument | ( | ) | [inline, virtual] |
| virtual const TiXmlDocument* TiXmlDocument::ToDocument | ( | ) | const [inline, virtual] |
bool TiXmlDocument::error [private] |
TIXML_STRING TiXmlDocument::errorDesc [private] |
int TiXmlDocument::errorId [private] |
TiXmlCursor TiXmlDocument::errorLocation [private] |
int TiXmlDocument::tabsize [private] |
bool TiXmlDocument::useMicrosoftBOM [private] |
1.7.3
