Include file path and line number in parsing errors

include/sdf/Error.hh

@@ -19,6 +19,7 @@
 
 #include <iostream>
 #include <string>
+#include <ignition/utils/ImplPtr.hh>
 #include <sdf/sdf_config.h>
 #include "sdf/system_util.hh"
 
@@ -145,15 +146,33 @@ namespace sdf
 
   class SDFORMAT_VISIBLE Error
   {
-    /// \brief default constructor
-    public: Error() = default;
+    /// \brief Default constructor
+    public: Error();
 
     /// \brief Constructor.
     /// \param[in] _code The error code.
     /// \param[in] _message A description of the error.
     /// \sa ErrorCode.
     public: Error(const ErrorCode _code, const std::string &_message);
 
+    /// \brief Constructor.
+    /// \param[in] _code The error code.
+    /// \param[in] _message A description of the error.
+    /// \param[in] _filePath The file path that is related to this error.
+    /// \sa ErrorCode.
+    public: Error(const ErrorCode _code, const std::string &_message,
+                  const std::string &_filePath);
+
+    /// \brief Constructor.
+    /// \param[in] _code The error code.
+    /// \param[in] _message A description of the error.
+    /// \param[in] _filePath The file path that is related to this error.
+    /// \param[in] _lineNumber The line number in the provided file path where
+    /// this error was raised.
+    /// \sa ErrorCode.
+    public: Error(const ErrorCode _code, const std::string &_message,
+                  const std::string &_filePath, int _lineNumber);
+
     /// \brief Get the error code.
     /// \return An error code.
     /// \sa ErrorCode.
@@ -163,6 +182,16 @@ namespace sdf
     /// \return Error message.
     public: std::string Message() const;
 
+    /// \brief Get the file path associated with this error.
+    /// \return Path of the file that this error is related to. Returns an empty
+    /// string if there is no related file.
+    public: std::string FilePath() const;
+
+    /// \brief Get the line number associated with this error.
+    /// \return Line number. Returns -1 if there is no line number associated
+    /// with this error.
+    public: int LineNumber() const;
+
     /// \brief Safe bool conversion.
     /// \return True if this Error's Code() != NONE. In otherwords, this is
     /// true when there is an error.
@@ -184,26 +213,35 @@ namespace sdf
     public: friend std::ostream &operator<<(std::ostream &_out,
                                             const sdf::Error &_err)
     {
-      _out << "Error Code "
-        << static_cast<std::underlying_type<sdf::ErrorCode>::type>(_err.Code())
-        << " Msg: " << _err.Message();
+      if (_err.FilePath().empty())
+      {
+        _out << "Error Code "
+          << static_cast<std::underlying_type<sdf::ErrorCode>::type>(
+              _err.Code())
+          << " Msg: " << _err.Message();
+      }
+      else if (_err.LineNumber() < 1)
+      {
+        _out << "Error Code "
+          << static_cast<std::underlying_type<sdf::ErrorCode>::type>(
+              _err.Code())
+          << ": [" << _err.FilePath() << "]: "
+          << " Msg: " << _err.Message();
+      }
+      else
+      {
+        _out << "Error Code "
+          << static_cast<std::underlying_type<sdf::ErrorCode>::type>(
+              _err.Code())
+          << ": [" << _err.FilePath() << ":L"
+          << std::to_string(_err.LineNumber()) << "]: "
+          << " Msg: " << _err.Message();
+      }
       return _out;
     }
 
-    /// \brief The error code value.
-    private: ErrorCode code = ErrorCode::NONE;
-
-#ifdef _WIN32
-  // Disable warning C4251 which is triggered by
-  // std::string
-  #pragma warning(push)
-  #pragma warning(disable: 4251)
-#endif
-    /// \brief Description of the error.
-    private: std::string message = "";
-#ifdef _WIN32
-  #pragma warning(pop)
-#endif
+    /// \brief Private data pointer.
+    IGN_UTILS_IMPL_PTR(dataPtr)
   };
   }
 }

src/Error.cc

@@ -19,35 +19,98 @@
 
 using namespace sdf;
 
+class sdf::Error::Implementation
+{
+  /// \brief The error code value.
+  public: ErrorCode code = ErrorCode::NONE;
+
+#ifdef _WIN32
+  // Disable warning C4251 which is triggered by
+  // std::string
+  #pragma warning(push)
+  #pragma warning(disable: 4251)
+#endif
+  /// \brief Description of the error.
+  public: std::string message = "";
+
+  /// \brief File path where the error was raised.
+  public: std::string filePath = "";
+#ifdef _WIN32
+  #pragma warning(pop)
+#endif
+
+  /// \brief Line number in the file path where the error was raised.
+  public: int lineNumber = -1;
+};
+
+/////////////////////////////////////////////////
+Error::Error()
+  : dataPtr(ignition::utils::MakeImpl<Implementation>())
+{}
+
 /////////////////////////////////////////////////
 Error::Error(const ErrorCode _code, const std::string &_message)
+  : dataPtr(ignition::utils::MakeImpl<Implementation>())
+{
+  this->dataPtr->code = _code;
+  this->dataPtr->message = _message;
+}
+
+/////////////////////////////////////////////////
+Error::Error(const ErrorCode _code, const std::string &_message,
+             const std::string &_filePath)
+  : dataPtr(ignition::utils::MakeImpl<Implementation>())
 {
-  this->code = _code;
-  this->message = _message;
+  this->dataPtr->code = _code;
+  this->dataPtr->message = _message;
+  this->dataPtr->filePath = _filePath;
+}
+
+/////////////////////////////////////////////////
+Error::Error(const ErrorCode _code, const std::string &_message,
+             const std::string &_filePath, int _lineNumber)
+  : dataPtr(ignition::utils::MakeImpl<Implementation>())
+{
+  this->dataPtr->code = _code;
+  this->dataPtr->message = _message;
+  this->dataPtr->filePath = _filePath;
+  this->dataPtr->lineNumber = _lineNumber;
 }
 
 /////////////////////////////////////////////////
 ErrorCode Error::Code() const
 {
-  return this->code;
+  return this->dataPtr->code;
 }
 
 /////////////////////////////////////////////////
 std::string Error::Message() const
 {
-  return this->message;
+  return this->dataPtr->message;
+}
+
+/////////////////////////////////////////////////
+std::string Error::FilePath() const
+{
+  return this->dataPtr->filePath;
+}
+
+/////////////////////////////////////////////////
+int Error::LineNumber() const
+{
+  return this->dataPtr->lineNumber;
 }
 
 /////////////////////////////////////////////////
 // cppcheck-suppress unusedFunction
 Error::operator bool() const
 {
-  return this->code != ErrorCode::NONE;
+  return this->dataPtr->code != ErrorCode::NONE;
 }
 
 /////////////////////////////////////////////////
 bool Error::operator==(const bool _value) const
 {
-  return ((this->code != ErrorCode::NONE) && _value) ||
-         ((this->code == ErrorCode::NONE) && !_value);
+  return ((this->dataPtr->code != ErrorCode::NONE) && _value) ||
+         ((this->dataPtr->code == ErrorCode::NONE) && !_value);
 }

src/Error_TEST.cc

@@ -26,18 +26,38 @@ TEST(Error, DefaultConstruction)
   EXPECT_EQ(error, false);
   EXPECT_EQ(error.Code(), sdf::ErrorCode::NONE);
   EXPECT_TRUE(error.Message().empty());
+  EXPECT_TRUE(error.FilePath().empty());
+  EXPECT_LE(error.LineNumber(), 0);
 
   if (error)
     FAIL();
 }
 
 /////////////////////////////////////////////////
-TEST(Error, ValueConstruction)
+TEST(Error, ValueConstructionWithoutFile)
 {
   sdf::Error error(sdf::ErrorCode::FILE_READ, "Unable to read a file");
   EXPECT_EQ(error, true);
   EXPECT_EQ(error.Code(), sdf::ErrorCode::FILE_READ);
   EXPECT_EQ(error.Message(), "Unable to read a file");
+  EXPECT_TRUE(error.FilePath().empty());
+  EXPECT_LE(error.LineNumber(), 0);
+
+  if (!error)
+    FAIL();
+}
+
+/////////////////////////////////////////////////
+TEST(Error, ValueConstructionWithFile)
+{
+  const std::string emptyFilePath = "Empty/file/path";
+  sdf::Error error(sdf::ErrorCode::FILE_READ, "Unable to read a file",
+                   emptyFilePath, 10);
+  EXPECT_EQ(error, true);
+  EXPECT_EQ(error.Code(), sdf::ErrorCode::FILE_READ);
+  EXPECT_EQ(error.Message(), "Unable to read a file");
+  EXPECT_EQ(error.FilePath(), emptyFilePath);
+  EXPECT_EQ(error.LineNumber(), 10);
 
   if (!error)
     FAIL();

src/ign.cc

@@ -41,7 +41,7 @@ extern "C" SDFORMAT_VISIBLE int cmdCheck(const char *_path)
   {
     for (auto &error : errors)
     {
-      std::cerr << "Error: " << error.Message() << std::endl;
+      std::cerr << error << std::endl;
     }
     return -1;
   }