AxioDL
/
tinyxml2
mirror of https://github.com/AxioDL/tinyxml2.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #628 from leethomason/errorstr 

Revamp error system
This commit is contained in:
Lee Thomason 2017-11-01 08:53:11 -07:00 committed by GitHub
parent 82e48435de d548b7e717
commit 4155ac0c73
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 78 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

106
tinyxml2.cpp
View File

@ -165,6 +165,7 @@ void StrPair::TransferTo( StrPair* other )
_end = 0; _end = 0;
} }
void StrPair::Reset() void StrPair::Reset()
{ {
if ( _flags & NEEDS_DELETE ) { if ( _flags & NEEDS_DELETE ) {
@ -1019,7 +1020,7 @@ char* XMLNode::ParseDeep( char* p, StrPair* parentEndTag, int* curLineNumPtr )
if ( !p ) { if ( !p ) {
DeleteNode( node ); DeleteNode( node );
if ( !_document->Error() ) { if ( !_document->Error() ) {
_document->SetError( XML_ERROR_PARSING, 0, 0, initialLineNum); _document->SetError( XML_ERROR_PARSING, initialLineNum, 0);
} }
break; break;
} }
@ -1039,7 +1040,7 @@ char* XMLNode::ParseDeep( char* p, StrPair* parentEndTag, int* curLineNumPtr )
} }
} }
if ( !wellLocated ) { if ( !wellLocated ) {
_document->SetError( XML_ERROR_PARSING_DECLARATION, decl->Value(), 0, initialLineNum); _document->SetError( XML_ERROR_PARSING_DECLARATION, initialLineNum, "XMLDeclaration value=%s", decl->Value());
DeleteNode( node ); DeleteNode( node );
break; break;
} }
@ -1074,7 +1075,7 @@ char* XMLNode::ParseDeep( char* p, StrPair* parentEndTag, int* curLineNumPtr )
} }
} }
if ( mismatch ) { if ( mismatch ) {
_document->SetError( XML_ERROR_MISMATCHED_ELEMENT, ele->Name(), 0, initialLineNum); _document->SetError( XML_ERROR_MISMATCHED_ELEMENT, initialLineNum, "XMLElement name=%s", ele->Name());
DeleteNode( node ); DeleteNode( node );
break; break;
} }
@ -1131,11 +1132,10 @@ const XMLElement* XMLNode::ToElementWithName( const char* name ) const
// --------- XMLText ---------- // // --------- XMLText ---------- //
char* XMLText::ParseDeep( char* p, StrPair*, int* curLineNumPtr ) char* XMLText::ParseDeep( char* p, StrPair*, int* curLineNumPtr )
{ {
const char* start = p;
if ( this->CData() ) { if ( this->CData() ) {
p = _value.ParseText( p, "]]>", StrPair::NEEDS_NEWLINE_NORMALIZATION, curLineNumPtr ); p = _value.ParseText( p, "]]>", StrPair::NEEDS_NEWLINE_NORMALIZATION, curLineNumPtr );
if ( !p ) { if ( !p ) {
_document->SetError( XML_ERROR_PARSING_CDATA, start, 0, _parseLineNum ); _document->SetError( XML_ERROR_PARSING_CDATA, _parseLineNum, 0 );
} }
return p; return p;
} }
@ -1150,7 +1150,7 @@ char* XMLText::ParseDeep( char* p, StrPair*, int* curLineNumPtr )
return p-1; return p-1;
} }
if ( !p ) { if ( !p ) {
_document->SetError( XML_ERROR_PARSING_TEXT, start, 0, _parseLineNum ); _document->SetError( XML_ERROR_PARSING_TEXT, _parseLineNum, 0 );
} }
} }
return 0; return 0;
@ -1198,10 +1198,9 @@ XMLComment::~XMLComment()
char* XMLComment::ParseDeep( char* p, StrPair*, int* curLineNumPtr ) char* XMLComment::ParseDeep( char* p, StrPair*, int* curLineNumPtr )
{ {
// Comment parses as text. // Comment parses as text.
const char* start = p;
p = _value.ParseText( p, "-->", StrPair::COMMENT, curLineNumPtr ); p = _value.ParseText( p, "-->", StrPair::COMMENT, curLineNumPtr );
if ( p == 0 ) { if ( p == 0 ) {
_document->SetError( XML_ERROR_PARSING_COMMENT, start, 0, _parseLineNum ); _document->SetError( XML_ERROR_PARSING_COMMENT, _parseLineNum, 0 );
} }
return p; return p;
} }
@ -1248,10 +1247,9 @@ XMLDeclaration::~XMLDeclaration()
char* XMLDeclaration::ParseDeep( char* p, StrPair*, int* curLineNumPtr ) char* XMLDeclaration::ParseDeep( char* p, StrPair*, int* curLineNumPtr )
{ {
// Declaration parses as text. // Declaration parses as text.
const char* start = p;
p = _value.ParseText( p, "?>", StrPair::NEEDS_NEWLINE_NORMALIZATION, curLineNumPtr ); p = _value.ParseText( p, "?>", StrPair::NEEDS_NEWLINE_NORMALIZATION, curLineNumPtr );
if ( p == 0 ) { if ( p == 0 ) {
_document->SetError( XML_ERROR_PARSING_DECLARATION, start, 0, _parseLineNum ); _document->SetError( XML_ERROR_PARSING_DECLARATION, _parseLineNum, 0 );
} }
return p; return p;
} }
@ -1297,11 +1295,9 @@ XMLUnknown::~XMLUnknown()
char* XMLUnknown::ParseDeep( char* p, StrPair*, int* curLineNumPtr ) char* XMLUnknown::ParseDeep( char* p, StrPair*, int* curLineNumPtr )
{ {
// Unknown parses as text. // Unknown parses as text.
const char* start = p;
p = _value.ParseText( p, ">", StrPair::NEEDS_NEWLINE_NORMALIZATION, curLineNumPtr ); p = _value.ParseText( p, ">", StrPair::NEEDS_NEWLINE_NORMALIZATION, curLineNumPtr );
if ( !p ) { if ( !p ) {
_document->SetError( XML_ERROR_PARSING_UNKNOWN, start, 0, _parseLineNum ); _document->SetError( XML_ERROR_PARSING_UNKNOWN, _parseLineNum, 0 );
} }
return p; return p;
} }
@ -1804,14 +1800,13 @@ void XMLElement::DeleteAttribute( const char* name )
char* XMLElement::ParseAttributes( char* p, int* curLineNumPtr ) char* XMLElement::ParseAttributes( char* p, int* curLineNumPtr )
{ {
const char* start = p;
XMLAttribute* prevAttribute = 0; XMLAttribute* prevAttribute = 0;
// Read the attributes. // Read the attributes.
while( p ) { while( p ) {
p = XMLUtil::SkipWhiteSpace( p, curLineNumPtr ); p = XMLUtil::SkipWhiteSpace( p, curLineNumPtr );
if ( !(*p) ) { if ( !(*p) ) {
_document->SetError( XML_ERROR_PARSING_ELEMENT, start, Name(), _parseLineNum ); _document->SetError( XML_ERROR_PARSING_ELEMENT, _parseLineNum, "XMLElement name=%s", Name() );
return 0; return 0;
} }
@ -1826,7 +1821,7 @@ char* XMLElement::ParseAttributes( char* p, int* curLineNumPtr )
p = attrib->ParseDeep( p, _document->ProcessEntities(), curLineNumPtr ); p = attrib->ParseDeep( p, _document->ProcessEntities(), curLineNumPtr );
if ( !p || Attribute( attrib->Name() ) ) { if ( !p || Attribute( attrib->Name() ) ) {
DeleteAttribute( attrib ); DeleteAttribute( attrib );
_document->SetError( XML_ERROR_PARSING_ATTRIBUTE, start, p, attrLineNum ); _document->SetError( XML_ERROR_PARSING_ATTRIBUTE, attrLineNum, "XMLElement name=%s", Name() );
return 0; return 0;
} }
// There is a minor bug here: if the attribute in the source xml // There is a minor bug here: if the attribute in the source xml
@ -1855,7 +1850,7 @@ char* XMLElement::ParseAttributes( char* p, int* curLineNumPtr )
return p+2; // done; sealed element. return p+2; // done; sealed element.
} }
else { else {
_document->SetError( XML_ERROR_PARSING_ELEMENT, start, p, _parseLineNum ); _document->SetError( XML_ERROR_PARSING_ELEMENT, _parseLineNum, 0 );
return 0; return 0;
} }
} }
@ -2001,8 +1996,7 @@ XMLDocument::XMLDocument( bool processEntities, Whitespace whitespaceMode ) :
_processEntities( processEntities ), _processEntities( processEntities ),
_errorID(XML_SUCCESS), _errorID(XML_SUCCESS),
_whitespaceMode( whitespaceMode ), _whitespaceMode( whitespaceMode ),
_errorStr1(), _errorStr(),
_errorStr2(),
_errorLineNum( 0 ), _errorLineNum( 0 ),
_charBuffer( 0 ), _charBuffer( 0 ),
_parseCurLineNum( 0 ), _parseCurLineNum( 0 ),
@ -2160,7 +2154,7 @@ XMLError XMLDocument::LoadFile( const char* filename )
Clear(); Clear();
FILE* fp = callfopen( filename, "rb" ); FILE* fp = callfopen( filename, "rb" );
if ( !fp ) { if ( !fp ) {
SetError( XML_ERROR_FILE_NOT_FOUND, filename, 0, 0 ); SetError( XML_ERROR_FILE_NOT_FOUND, 0, "filename=%s", filename ? filename : "<null>");
return _errorID; return _errorID;
} }
LoadFile( fp ); LoadFile( fp );
@ -2197,7 +2191,7 @@ XMLError XMLDocument::LoadFile( FILE* fp )
fseek( fp, 0, SEEK_SET ); fseek( fp, 0, SEEK_SET );
if ( fgetc( fp ) == EOF && ferror( fp ) != 0 ) { if ( fgetc( fp ) == EOF && ferror( fp ) != 0 ) {
SetError( XML_ERROR_FILE_READ_ERROR, 0, 0, 0 ); SetError( XML_ERROR_FILE_READ_ERROR, 0, 0 );
return _errorID; return _errorID;
} }
@ -2205,19 +2199,19 @@ XMLError XMLDocument::LoadFile( FILE* fp )
const long filelength = ftell( fp ); const long filelength = ftell( fp );
fseek( fp, 0, SEEK_SET ); fseek( fp, 0, SEEK_SET );
if ( filelength == -1L ) { if ( filelength == -1L ) {
SetError( XML_ERROR_FILE_READ_ERROR, 0, 0, 0 ); SetError( XML_ERROR_FILE_READ_ERROR, 0, 0 );
return _errorID; return _errorID;
} }
TIXMLASSERT( filelength >= 0 ); TIXMLASSERT( filelength >= 0 );
if ( !LongFitsIntoSizeTMinusOne<>::Fits( filelength ) ) { if ( !LongFitsIntoSizeTMinusOne<>::Fits( filelength ) ) {
// Cannot handle files which won't fit in buffer together with null terminator // Cannot handle files which won't fit in buffer together with null terminator
SetError( XML_ERROR_FILE_READ_ERROR, 0, 0, 0 ); SetError( XML_ERROR_FILE_READ_ERROR, 0, 0 );
return _errorID; return _errorID;
} }
if ( filelength == 0 ) { if ( filelength == 0 ) {
SetError( XML_ERROR_EMPTY_DOCUMENT, 0, 0, 0 ); SetError( XML_ERROR_EMPTY_DOCUMENT, 0, 0 );
return _errorID; return _errorID;
} }
@ -2226,7 +2220,7 @@ XMLError XMLDocument::LoadFile( FILE* fp )
_charBuffer = new char[size+1]; _charBuffer = new char[size+1];
size_t read = fread( _charBuffer, 1, size, fp ); size_t read = fread( _charBuffer, 1, size, fp );
if ( read != size ) { if ( read != size ) {
SetError( XML_ERROR_FILE_READ_ERROR, 0, 0, 0 ); SetError( XML_ERROR_FILE_READ_ERROR, 0, 0 );
return _errorID; return _errorID;
} }
@ -2241,7 +2235,7 @@ XMLError XMLDocument::SaveFile( const char* filename, bool compact )
{ {
FILE* fp = callfopen( filename, "w" ); FILE* fp = callfopen( filename, "w" );
if ( !fp ) { if ( !fp ) {
SetError( XML_ERROR_FILE_COULD_NOT_BE_OPENED, filename, 0, 0 ); SetError( XML_ERROR_FILE_COULD_NOT_BE_OPENED, 0, "filename=%s", filename ? filename : "<null>");
return _errorID; return _errorID;
} }
SaveFile(fp, compact); SaveFile(fp, compact);
@ -2266,7 +2260,7 @@ XMLError XMLDocument::Parse( const char* p, size_t len )
Clear(); Clear();
if ( len == 0 || !p || !*p ) { if ( len == 0 || !p || !*p ) {
SetError( XML_ERROR_EMPTY_DOCUMENT, 0, 0, 0 ); SetError( XML_ERROR_EMPTY_DOCUMENT, 0, 0 );
return _errorID; return _errorID;
} }
if ( len == (size_t)(-1) ) { if ( len == (size_t)(-1) ) {
@ -2304,21 +2298,30 @@ void XMLDocument::Print( XMLPrinter* streamer ) const
} }
void XMLDocument::SetError( XMLError error, const char* str1, const char* str2, int lineNum ) void XMLDocument::SetError( XMLError error, int lineNum, const char* format, ... )
{ {
TIXMLASSERT( error >= 0 && error < XML_ERROR_COUNT ); TIXMLASSERT( error >= 0 && error < XML_ERROR_COUNT );
_errorID = error; _errorID = error;
_errorStr1.Reset();
_errorStr2.Reset();
_errorLineNum = lineNum; _errorLineNum = lineNum;
_errorStr.Reset();
if (str1) if (format) {
_errorStr1.SetStr(str1); size_t BUFFER_SIZE = 1000;
if (str2) char* buffer = new char[BUFFER_SIZE];
_errorStr2.SetStr(str2); TIXML_SNPRINTF(buffer, BUFFER_SIZE, "Error=%s ErrorID=%d (0x%x) Line number=%d: ", ErrorIDToName(error), int(error), int(error), lineNum);
size_t len = strlen(buffer);
va_list va;
va_start( va, format );
TIXML_VSNPRINTF( buffer + len, BUFFER_SIZE - len, format, va );
va_end( va );
_errorStr.SetStr(buffer);
delete [] buffer;
}
} }
/*static*/ const char* XMLDocument::ErrorIDToName(XMLError errorID) /*static*/ const char* XMLDocument::ErrorIDToName(XMLError errorID)
{ {
TIXMLASSERT( errorID >= 0 && errorID < XML_ERROR_COUNT ); TIXMLASSERT( errorID >= 0 && errorID < XML_ERROR_COUNT );
@ -2327,14 +2330,15 @@ void XMLDocument::SetError( XMLError error, const char* str1, const char* str2,
return errorName; return errorName;
} }
const char* XMLDocument::GetErrorStr1() const const char* XMLDocument::ErrorStr() const
{ {
return _errorStr1.GetStr(); return _errorStr.Empty() ? "" : _errorStr.GetStr();
} }
const char* XMLDocument::GetErrorStr2() const
void XMLDocument::PrintError() const
{ {
return _errorStr2.GetStr(); printf("%s\n", ErrorStr());
} }
const char* XMLDocument::ErrorName() const const char* XMLDocument::ErrorName() const
@ -2342,28 +2346,6 @@ const char* XMLDocument::ErrorName() const
return ErrorIDToName(_errorID); return ErrorIDToName(_errorID);
} }
void XMLDocument::PrintError() const
{
if ( Error() ) {
static const int LEN = 20;
char buf1[LEN] = { 0 };
char buf2[LEN] = { 0 };
if ( !_errorStr1.Empty() ) {
TIXML_SNPRINTF( buf1, LEN, "%s", _errorStr1.GetStr() );
}
if ( !_errorStr2.Empty() ) {
TIXML_SNPRINTF( buf2, LEN, "%s", _errorStr2.GetStr() );
}
// Should check INT_MIN <= _errorID && _errorId <= INT_MAX, but that
// causes a clang "always true" -Wtautological-constant-out-of-range-compare warning
TIXMLASSERT( 0 <= _errorID && XML_ERROR_COUNT - 1 <= INT_MAX );
printf( "XMLDocument error id=%d '%s' str1=%s str2=%s line=%d\n",
static_cast<int>( _errorID ), ErrorName(), buf1, buf2, _errorLineNum );
}
}
void XMLDocument::Parse() void XMLDocument::Parse()
{ {
TIXMLASSERT( NoChildren() ); // Clear() must have been called previously TIXMLASSERT( NoChildren() ); // Clear() must have been called previously
@ -2374,7 +2356,7 @@ void XMLDocument::Parse()
p = XMLUtil::SkipWhiteSpace( p, &_parseCurLineNum ); p = XMLUtil::SkipWhiteSpace( p, &_parseCurLineNum );
p = const_cast<char*>( XMLUtil::ReadBOM( p, &_writeBOM ) ); p = const_cast<char*>( XMLUtil::ReadBOM( p, &_writeBOM ) );
if ( !*p ) { if ( !*p ) {
SetError( XML_ERROR_EMPTY_DOCUMENT, 0, 0, 0 ); SetError( XML_ERROR_EMPTY_DOCUMENT, 0, 0 );
return; return;
} }
ParseDeep(p, 0, &_parseCurLineNum ); ParseDeep(p, 0, &_parseCurLineNum );

30
tinyxml2.h
View File

@ -1635,6 +1635,13 @@ enum Whitespace {
class TINYXML2_LIB XMLDocument : public XMLNode class TINYXML2_LIB XMLDocument : public XMLNode
{ {
friend class XMLElement; friend class XMLElement;
// Gives access to SetError, but over-access for everything else.
// Wishing C++ had "internal" scope.
friend class XMLNode;
friend class XMLText;
friend class XMLComment;
friend class XMLDeclaration;
friend class XMLUnknown;
public: public:
/// constructor /// constructor
XMLDocument( bool processEntities = true, Whitespace whitespaceMode = PRESERVE_WHITESPACE ); XMLDocument( bool processEntities = true, Whitespace whitespaceMode = PRESERVE_WHITESPACE );
@ -1786,10 +1793,8 @@ public:
*/ */
void DeleteNode( XMLNode* node ); void DeleteNode( XMLNode* node );
void SetError( XMLError error, const char* str1, const char* str2, int lineNum );
void ClearError() { void ClearError() {
SetError(XML_SUCCESS, 0, 0, 0); SetError(XML_SUCCESS, 0, 0);
} }
/// Return true if there was an error parsing the document. /// Return true if there was an error parsing the document.
@ -1803,19 +1808,19 @@ public:
const char* ErrorName() const; const char* ErrorName() const;
static const char* ErrorIDToName(XMLError errorID); static const char* ErrorIDToName(XMLError errorID);
/// Return a possibly helpful diagnostic location or string. /** Returns a "long form" error description. A hopefully helpful
const char* GetErrorStr1() const; diagnostic with location, line number, and/or additional info.
*/
const char* ErrorStr() const;
/// Return a possibly helpful secondary diagnostic location or string. /// A (trivial) utility function that prints the ErrorStr() to stdout.
const char* GetErrorStr2() const; void PrintError() const;
/// Return the line where the error occured, or zero if unknown. /// Return the line where the error occured, or zero if unknown.
int GetErrorLineNum() const int ErrorLineNum() const
{ {
return _errorLineNum; return _errorLineNum;
} }
/// If there is an error, print it to stdout.
void PrintError() const;
/// Clear the document, resetting it to the initial state. /// Clear the document, resetting it to the initial state.
void Clear(); void Clear();
@ -1850,8 +1855,7 @@ private:
bool _processEntities; bool _processEntities;
XMLError _errorID; XMLError _errorID;
Whitespace _whitespaceMode; Whitespace _whitespaceMode;
mutable StrPair _errorStr1; mutable StrPair _errorStr;
mutable StrPair _errorStr2;
int _errorLineNum; int _errorLineNum;
char* _charBuffer; char* _charBuffer;
int _parseCurLineNum; int _parseCurLineNum;
@ -1872,6 +1876,8 @@ private:
void Parse(); void Parse();
void SetError( XMLError error, int lineNum, const char* format, ... );
template<class NodeType, int PoolElementSize> template<class NodeType, int PoolElementSize>
NodeType* CreateUnlinkedNode( MemPoolT<PoolElementSize>& pool ); NodeType* CreateUnlinkedNode( MemPoolT<PoolElementSize>& pool );
}; };

22
xmltest.cpp
View File

@ -1962,11 +1962,9 @@ int main( int argc, const char ** argv )
XMLDocument doc; XMLDocument doc;
for( int i = 0; i < XML_ERROR_COUNT; i++ ) { for( int i = 0; i < XML_ERROR_COUNT; i++ ) {
const XMLError error = static_cast<XMLError>(i); const XMLError error = static_cast<XMLError>(i);
doc.SetError( error, 0, 0, 0 ); const char* name = XMLDocument::ErrorIDToName(error);
XMLTest( "ErrorID() after SetError()", error, doc.ErrorID() ); XMLTest( "ErrorName() after ClearError()", true, name != 0 );
const char* name = doc.ErrorName(); XMLTest( "ErrorName() after ClearError()", true, strlen(name) > 0 );
XMLTest( "ErrorName() after SetError()", true, name != 0 );
XMLTest( "ErrorName() after SetError()", true, strlen(name) > 0 );
} }
} }
@ -2077,7 +2075,7 @@ int main( int argc, const char ** argv )
XMLTest(testString, parseError, doc.ErrorID()); XMLTest(testString, parseError, doc.ErrorID());
XMLTest(testString, true, doc.Error()); XMLTest(testString, true, doc.Error());
XMLTest(testString, expected_error, parseError); XMLTest(testString, expected_error, parseError);
XMLTest(testString, expectedLine, doc.GetErrorLineNum()); XMLTest(testString, expectedLine, doc.ErrorLineNum());
}; };
void TestStringLines(const char *testString, const char *docStr, const char *expectedLines) void TestStringLines(const char *testString, const char *docStr, const char *expectedLines)
@ -2196,6 +2194,18 @@ int main( int argc, const char ** argv )
"D01L01E02E03A03A03T03E04A04A04T04E05A05A05T05E06A06A06T06E07A07A07T07E08A08A08T08E09T09E10T10"); "D01L01E02E03A03A03T03E04A04A04T04E05A05A05T05E06A06A06T06E07A07A07T07E08A08A08T08E09T09E10T10");
} }
{
const char* xml = "<Hello>Text</Error>";
XMLDocument doc;
doc.Parse(xml);
XMLTest("Test mismatched elements.", true, doc.Error());
XMLTest("Test mismatched elements.", XML_ERROR_MISMATCHED_ELEMENT, doc.ErrorID());
// For now just make sure calls work & doesn't crash.
// May solidify the error output in the future.
printf("%s\n", doc.ErrorStr());
doc.PrintError();
}
// ----------- Performance tracking -------------- // ----------- Performance tracking --------------
{ {
#if defined( _MSC_VER ) #if defined( _MSC_VER )