Warnings are now inserted into an optional data structure instead of being directly printed to the standard error

This allows one to parse a DBC with or without considering the warnings and clears the outputs in the console

Author: Avi SZYCHTER

include/CANDatabase.h

@@ -24,20 +24,33 @@
  * retrieve the name of the source file.
  */
 class CANDatabase {
+public:
+  /**
+   * @brief A parsing warning and its location
+   */
+  struct parsing_warning {
+    int line;
+    std::string description;
+  };
+
 public:
   /**
    * @brief Parse a CANDatabase from the given source file.
    * @param filename Path to the file to parse
+   * @param warnings (Optional) Filled with all the warnings found during the parsing
    * @throw CANDatabaseException if the parsing failed
    */
-  static CANDatabase fromFile(const std::string& filename);
+  static CANDatabase fromFile(
+    const std::string& filename, std::vector<parsing_warning>* warnings = nullptr);
 
   /**
    * @brief Construct a CANDatabase object from a database described by src_string
    * @param src_string Source string to parse
+   * @param warnings (Optional) Filled with all the warnings found during the parsing
    * @throw CANDatabaseException if the parsing failed
    */
-  static CANDatabase fromString(const std::string& src_string);
+  static CANDatabase fromString(
+    const std::string& src_string, std::vector<parsing_warning>* warnings = nullptr);
 
 public:
   struct IDKey {

include/DBCParser.h

@@ -7,10 +7,13 @@
 #include <memory>
 
 namespace DBCParser {
-  CANDatabase fromTokenizer(const std::string& name,
-                            Tokenizer& tokenizer);
+  CANDatabase fromTokenizer(
+    const std::string& name, Tokenizer& tokenizer,
+    std::vector<CANDatabase::parsing_warning>* warnings = nullptr);
 
-  CANDatabase fromTokenizer(Tokenizer& tokenizer);
+  CANDatabase fromTokenizer(
+    Tokenizer& tokenizer, 
+    std::vector<CANDatabase::parsing_warning>* warnings = nullptr);
 };
 
 #endif

include/ParsingUtils.h

@@ -4,12 +4,16 @@
 #include "Tokenizer.h"
 #include <string>
 #include <iostream>
+#include "CANDatabase.h"
 #include "CANDatabaseException.h"
 
-void throw_error(const std::string& category, const std::string& description,
-                unsigned long long line);
+void throw_error(
+  const std::string& category, const std::string& description,
+  unsigned long long line);
 
-void warning(const std::string& description, unsigned long long line) ;
+void warning(
+  std::vector<CANDatabase::parsing_warning>* warnings, 
+  const std::string& description, unsigned long long line);
 
 const Token&
 assert_token(Tokenizer& tokenizer, const std::string& token);

src/models/CANDatabase.cpp

@@ -14,19 +14,19 @@ std::size_t CANDatabase::size() const {
   return map_.size();
 }
 
-CANDatabase CANDatabase::fromFile(const std::string& filename) {
+CANDatabase CANDatabase::fromFile(const std::string& filename, std::vector<parsing_warning>* warnings) {
   std::ifstream test_stream(filename);
   if (!test_stream.good()) {
     throw CANDatabaseException("Cannot find file " + filename);
   }
 
   FileTokenizer tokenizer(filename);
-  return DBCParser::fromTokenizer(filename, tokenizer);
+  return DBCParser::fromTokenizer(filename, tokenizer, warnings);
 }
 
-CANDatabase CANDatabase::fromString(const std::string & src_string) {
+CANDatabase CANDatabase::fromString(const std::string & src_string, std::vector<parsing_warning>* warnings) {
   StringTokenizer tokenizer(src_string);
-  return DBCParser::fromTokenizer(tokenizer);
+  return DBCParser::fromTokenizer(tokenizer, warnings);
 }
 
 const CANFrame& CANDatabase::at(const std::string& name) const {
@@ -50,16 +50,6 @@ CANFrame& CANDatabase::at(unsigned long long id) {
 }
 
 void CANDatabase::addFrame(const CANFrame& frame) {
-  if(strKeyIndex_.find(frame.name()) != strKeyIndex_.end()) {
-    std::cout << "WARNING: Double declaration of a frame with name "
-              << "\"" << frame.name() << "\"" << std::endl;
-  }
-  
-  if(intKeyIndex_.find(frame.can_id()) != intKeyIndex_.end()) {
-    std::cout << "WARNING: Double declaration of a frame with id "
-              << frame.can_id() << std::endl;
-  }
-
   IDKey map_key = { frame.name(), frame.can_id() };
 
   map_.insert(std::make_pair(map_key, frame));