Add line/column reporting to exceptions, update it to work with

std::exception as a base, slightly change semantics of entityRef()
function so that it can report line/col.

src/libStreamedXML/BottomHeader.h

@@ -5,3 +5,7 @@
 */
 
 #endif
+/* options for text editors
+kate: replace-trailing-space-save true; space-indent true; tab-width 4;
+vim: expandtab:ts=4:sw=4
+*/

src/libStreamedXML/Callback.h

@@ -177,8 +177,9 @@ public:
     /*! \brief Entity reference.
 
     \param name The name of the entity being referred to.
-    \returns The expanded text.
-    \throws UnknownEntity if the entity is unknown.
+    \param[out] value The expanded text.
+    \retval true if the entity is valid.
+    \retval false if the entity is not valid.
 
     This function is called whenever an entity reference is encountered,
     and \a expandEntities is \a true in your parser. The five standard
@@ -186,12 +187,18 @@ public:
     but anything else will be passed to this function.
 
     */
-    virtual std::wstring entityRef(const std::wstring& name)
+    virtual bool entityRef(const std::wstring& name, std::wstring& value)
     {
-        throw UnknownEntity(name);
+        (void)name;
+        (void)value;
+        return false;
     }
 };
 
 
 
 };
+/* options for text editors
+kate: replace-trailing-space-save true; space-indent true; tab-width 4;
+vim: expandtab:ts=4:sw=4
+*/

src/libStreamedXML/Decoder.cpp

@@ -62,3 +62,7 @@ void Decoder::restart()
 
 
 }
+/* options for text editors
+kate: replace-trailing-space-save true; space-indent true; tab-width 4;
+vim: expandtab:ts=4:sw=4
+*/

src/libStreamedXML/Decoder.h

@@ -70,3 +70,7 @@ private:
 
 
 }
+/* options for text editors
+kate: replace-trailing-space-save true; space-indent true; tab-width 4;
+vim: expandtab:ts=4:sw=4
+*/

src/libStreamedXML/Exceptions.cpp

@@ -8,14 +8,14 @@ namespace lsx {
 
 
 
-Exception::Exception(const std::wstring& reason)
-    : reason(reason)
+Exception::Exception(const std::wstring& reason, int line, int col)
+    : reason(reason), line(line), col(col)
 {
 }
 
 
 
-const char* Exception::what()
+const char* Exception::what() const throw()
 {
     if(utf8Reason.empty()) utf8Reason = utf8::encode(reason, true);
     return utf8Reason.c_str();
@@ -23,39 +23,46 @@ const char* Exception::what()
 
 
 
-NotWellFormed::NotWellFormed(const std::wstring& error)
-    : Exception(format(error)), error(error)
+NotWellFormed::NotWellFormed(const std::wstring& error, int line, int col)
+    : Exception(format(error, line, col), line, col), error(error)
 {
 }
 
 
 
-std::wstring NotWellFormed::format(const std::wstring& error)
+std::wstring NotWellFormed::format(const std::wstring& error, int line, int col)
 {
     std::wostringstream ost;
-    ost << L"Streamed XML is not well formed:\n"
-        << error;
+    ost << L"Streamed XML is not well formed:"
+        << L"\n  line  : " << line + 1
+        << L"\n  column: " << col + 1
+        << L"\n  reason: " << error;
     return ost.str();
 }
 
 
 
-UnknownEntity::UnknownEntity(const std::wstring& name)
-    : Exception(format(name)), name(name)
+UnknownEntity::UnknownEntity(const std::wstring& name, int line, int col)
+    : Exception(format(name, line, col), line, col), name(name)
 {
 }
 
 
 
-std::wstring UnknownEntity::format(const std::wstring& name)
+std::wstring UnknownEntity::format(const std::wstring& name, int line, int col)
 {
     std::wostringstream ost;
-    ost << L"Encountered an unknown entity named '"
-        << name
-        << L"' in the Streamed XML.";
+    ost << L"Encountered an unknown entity in the Streamed XML:"
+        << L"\n  line  : " << line + 1
+        << L"\n  column: " << col + 1
+        << L"\n  name  : " << name;
     return ost.str();
 }
 
 
 
 }
+/* options for text editors
+kate: replace-trailing-space-save true; space-indent true; tab-width 4;
+vim: expandtab:ts=4:sw=4
+*/

src/libStreamedXML/Exceptions.h

@@ -14,30 +14,38 @@ This class is the base class of all exceptions. It simply provides a mechanism f
 message; more specific details must be stored in base classes.
 
 */
-class Exception {
+class Exception : public std::exception {
 public:
     /*! \brief Constructor.
 
     \param reason Reason for the exception.
+    \param line Line number of input (starting from 0).
+    \param col Column of input (starting from 0).
 
     The constructor simply stores the reason for the exception, which may be later accessed for
     reporting to the user.
 
     */
-    Exception(const std::wstring& reason);
+    Exception(const std::wstring& reason, int line, int col);
                
     /// Destructor.
     virtual ~Exception() throw()
     { }
     
     /// Find what caused the error.
-    virtual const char* what();
+    virtual const char* what() const throw();
 
     /// Reason for the exception.
     const std::wstring reason;
 
+    /// Line on which the exception occurred (starting from 0).
+    const int line;
+
+    /// Column on which the exception occurred (starting from 0).
+    const int col;
+    
 private:
-    std::string utf8Reason;
+    mutable std::string utf8Reason;
 };
 
 
@@ -45,18 +53,20 @@ private:
 /// Thrown when XML is not well formed.
 class NotWellFormed : public Exception {
 private:
-    static std::wstring format(const std::wstring& error);
+    static std::wstring format(const std::wstring& error, int line, int col);
 
 public:
     /*! \brief Constructor.
 
     \param error Reason for the error.
+    \param line Line on which the exception occurred.
+    \param col Column on which the exception occurred.
 
     The constructor will store the reason for the error. It will also prepare a suitable message
     for the Exception base class.
 
     */
-    NotWellFormed(const std::wstring& error);
+    NotWellFormed(const std::wstring& error, int line, int col);
     
     /// Destructor.
     virtual ~NotWellFormed() throw()
@@ -71,18 +81,20 @@ public:
 /// Thrown when an unknown entity is referred to.
 class UnknownEntity : public Exception {
 private:
-    static std::wstring format(const std::wstring& name);
+    static std::wstring format(const std::wstring& name, int line, int col);
 
 public:
     /*! \brief Constructor.
 
     \param name Name of the unknown entity.
+    \param line Line on which the exception occurred.
+    \param col Column on which the exception occurred.
     
     The constructor will store the name of the unknown entity. It will also prepare a suitable
     message for the Exception base class.
 
     */
-    UnknownEntity(const std::wstring& name);
+    UnknownEntity(const std::wstring& name, int line, int col);
     
     /// Destructor.
     virtual ~UnknownEntity() throw()
@@ -95,3 +107,7 @@ public:
 
 
 }
+/* options for text editors
+kate: replace-trailing-space-save true; space-indent true; tab-width 4;
+vim: expandtab:ts=4:sw=4
+*/

src/libStreamedXML/ForwardDeclare.h

@@ -22,3 +22,7 @@ class UnknownEntity;
 
 
 }
+/* options for text editors
+kate: replace-trailing-space-save true; space-indent true; tab-width 4;
+vim: expandtab:ts=4:sw=4
+*/

src/libStreamedXML/Parser.cpp

@@ -37,6 +37,8 @@ void Parser::reset()
     skipNextNewline = false;
     state = StateNone;
     restartCount = 0;
+    line = 0;
+    col = 0;
 }
 
 
@@ -59,7 +61,7 @@ void Parser::feedChar(wchar_t ch)
 
 #define ERROR(_reason) do { \
     state = StateError; \
-    throw NotWellFormed(_reason); \
+    throw NotWellFormed(_reason, line, col); \
 }while(0)
     if(ch == xmlRestartMarker[restartCount]) {
         if(++restartCount == 11) {
@@ -84,11 +86,15 @@ void Parser::feedChar(wchar_t ch)
             skipNextNewline = true;
             ch = L'\n';
             c = ClassWhitespace;
+            ++line;
+            col = 0;
             goto doBuffer;
 
         case 0x2028:
             ch = L'\n';
             c = ClassWhitespace;
+            ++line;
+            col = 0;
             break;
 
         case L' ':
@@ -101,6 +107,8 @@ void Parser::feedChar(wchar_t ch)
             if(skipNextNewline) return;
             ch = L'\n';
             c = ClassWhitespace;
+            ++line;
+            col = 0;
             break;
 
         case L':':
@@ -566,6 +574,7 @@ doBuffer:
             break;
     }
 #undef ERROR
+    ++col;
 }
 
 
@@ -577,9 +586,16 @@ std::wstring Parser::entityRef(const std::wstring& ent)
     if(ent == L"apos") return L"'";
     if(ent == L"lt") return L"<";
     if(ent == L"gt") return L">";
-    return callback->entityRef(ent);
+
+    std::wstring result;
+    if(callback->entityRef(ent, result)) return result;
+    throw UnknownEntity(ent, line, col);
 }
 
 
 
 }
+/* options for text editors
+kate: replace-trailing-space-save true; space-indent true; tab-width 4;
+vim: expandtab:ts=4:sw=4
+*/

src/libStreamedXML/Parser.h

@@ -120,6 +120,9 @@ private:
     bool skipNextNewline;
     int elementDepth, xmlCount, restartCount;
 
+    // for reporting errors
+    int line, col;
+
 public:
     /*! \brief Constructor.
 
@@ -221,3 +224,7 @@ public:
 
 
 }
+/* options for text editors
+kate: replace-trailing-space-save true; space-indent true; tab-width 4;
+vim: expandtab:ts=4:sw=4
+*/

src/libStreamedXML/TopHeader.h

@@ -14,3 +14,7 @@
 #include <sstream>
 #include <utf8>
 #include <stdint.h>
+/* options for text editors
+kate: replace-trailing-space-save true; space-indent true; tab-width 4;
+vim: expandtab:ts=4:sw=4
+*/

src/libStreamedXML/TopSource.cpp

@@ -8,3 +8,7 @@
 
 // Below are all the includes used throughout the library.
 
+/* options for text editors
+kate: replace-trailing-space-save true; space-indent true; tab-width 4;
+vim: expandtab:ts=4:sw=4
+*/