Merge pull request #5 from xatavian/topic-checkframe-all

Added CHECKFRAME operation to can-parse and improved the CppCAN::analysis functions

Author: xatavian

.gitignore

@@ -1,3 +1,5 @@
 bin/*
 !bin/.gitkeep
-.vs
+.vs
+build/*
+.vscode/

CMakeLists.txt

@@ -2,8 +2,9 @@ cmake_minimum_required(VERSION 3.7.0)
 
 project(CPP-CAN-Parser)
 
-
 include(CTest)
+include(GenerateExportHeader)
+
 
 set(CPPPARSER_INCLUDE_DIRECTORY 
 	${CMAKE_CURRENT_LIST_DIR}/include
@@ -12,7 +13,7 @@ set(CPPPARSER_INCLUDE_DIRECTORY
 set(CPPPARSER_SRC_FILES
 	src/models/CANDatabase.cpp
 	src/models/CANFrame.cpp
-  src/models/CANSignal.cpp
+  	src/models/CANSignal.cpp
 	src/parsing/DBCParser.cpp
 	src/parsing/ParsingUtils.cpp
 	src/parsing/Tokenizer.cpp
@@ -22,16 +23,51 @@ set(CPP_CAN_PARSER_COMPILATION_TYPE SHARED)
 if(CPP_CAN_PARSER_USE_STATIC)
 	set(CPP_CAN_PARSER_COMPILATION_TYPE STATIC)
 endif()
-	
-add_library(cpp-can-parser 
+
+set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS True)
+add_library(cpp-can-parser
 	${CPP_CAN_PARSER_COMPILATION_TYPE} 
 	${CPPPARSER_SRC_FILES})
 target_include_directories(cpp-can-parser 
-	PUBLIC ${CPPPARSER_INCLUDE_DIRECTORY})
+	PUBLIC ${CPPPARSER_INCLUDE_DIRECTORY}
+		   ${CMAKE_CURRENT_BINARY_DIR}/exports/)
+generate_export_header(cpp-can-parser
+	BASE_NAME cpp_can_parser
+	EXPORT_FILE_NAME ${CMAKE_CURRENT_BINARY_DIR}/exports/cpp_can_parser_export.h)
+install(FILES cpp-can-parser
+		${CMAKE_CURRENT_BINARY_DIR}/cpp_can_parser_export.h
+		DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/include)
 
 add_executable(can-parse 
 	utils/can-parse/can-parse.cpp
 	utils/can-parse/print-frame.cpp
 	utils/can-parse/print-single-frame.cpp
 	utils/can-parse/check-frame.cpp)
-target_link_libraries(can-parse cpp-can-parser)
+target_link_libraries(can-parse cpp-can-parser)
+
+if(BUILD_TESTING)
+	file(COPY tests/dbc-files/
+		DESTINATION dbc-files/)
+	
+	add_executable(cpc-test-parsing
+		tests/test-parsing.cpp)
+	target_link_libraries(cpc-test-parsing PUBLIC cpp-can-parser)
+
+	add_test(NAME cpc-test-parsing
+			COMMAND cpc-test-parsing)
+
+	add_test(NAME cpc-checkframe-1
+			 COMMAND can-parse checkframe dbc-files/single-frame-1.dbc)
+
+	add_test(NAME cpc-checkframe-2
+			 COMMAND can-parse checkframe dbc-files/single-frame-2.dbc)
+
+	add_test(NAME cpc-checkframe-big-endian-1
+			 COMMAND can-parse checkframe 294 dbc-files/big-endian-1.dbc)
+
+	add_test(NAME cpc-checkframe-big-endian-2
+			 COMMAND can-parse checkframe 1807 dbc-files/big-endian-1.dbc)
+	
+	add_test(NAME cpc-checkframe-big-endian-3
+			 COMMAND can-parse checkframe 1800 dbc-files/big-endian-1.dbc)
+endif()

include/CANDatabase.h

@@ -6,6 +6,7 @@
 #include <exception>
 #include <map>
 
+#include "cpp_can_parser_export.h"
 #include "CANFrame.h"
 #include "CANDatabaseException.h"
 
@@ -23,21 +24,34 @@
  * If the database was parsed from a file, the filename() method can be used to
  * retrieve the name of the source file.
  */
-class CANDatabase {
+class CPP_CAN_PARSER_EXPORT CANDatabase {
+public:
+  /**
+   * @brief A parsing warning and its location
+   */
+  struct parsing_warning {
+    unsigned long long 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 {
@@ -60,7 +74,7 @@ class CANDatabase {
   /**
    * @brief Creates a CANDatabase object with no source file
    */
-  CANDatabase() = default;
+  CANDatabase();
 
   /**
    * @brief Creates a CANDatabase object that has been constructed from a file
@@ -72,23 +86,24 @@ class CANDatabase {
    * Creates a copy of the database: the individual frames are deep copied so there is no
    * shared memory betwwen the two databases.
    */
-  CANDatabase(const CANDatabase&) = default;
+  CANDatabase(const CANDatabase&);
 
   /**
    * @brief Makes a copy of the given database
    */
-  CANDatabase& operator=(const CANDatabase&) = default;
+  CANDatabase& operator=(const CANDatabase&);
 
   /**
    * @brief Moves a CANDatabase object. The CANFrame objects are NOT deep copied.
    */
-  CANDatabase(CANDatabase&&) = default;
+  CANDatabase(CANDatabase&&);
 
   /**
-   * @see CANDatabase(const CANDatabase&&)
+   * @see CANDatabase(CANDatabase&&)
    */
-  CANDatabase& operator=(CANDatabase&&) = default;
+  CANDatabase& operator=(CANDatabase&&);
 
+  ~CANDatabase();
 public:
   /**
    * @brief Get the frame with the given frame name
@@ -182,11 +197,8 @@ class CANDatabase {
   void removeFrame(const std::string& name);
 
 private:
-  std::string filename_;
-  container_type map_; // Index by CAN ID
-
-  std::map<unsigned long long, IDKey> intKeyIndex_;
-  std::map<std::string, IDKey> strKeyIndex_;
+  class CANDatabaseImpl;
+  CANDatabaseImpl* impl;
 };
 
 #endif

include/CANDatabaseAnalysis.h

@@ -7,14 +7,24 @@ namespace CppCAN {
 namespace analysis {
     /**
      * @brief Analyses the frame signals to see if some signals are overlapping
+     * @param src The CANFrame instance to inspect
      * @return true if no overlapping is detected, false otherwise
      */
     bool is_frame_layout_ok(const CANFrame& src);
 
+    /**
+     * @brief Overload of is_frame_layout_ok() that outputs a diagnosis of the
+     *        problematic signals if a layout error is detected.
+     * @param src The CANFrame instance to inspect
+     * @param diagnosis Filled with the names of all the overlapping signals
+     * @return true if no overlapping is detected, false otherwise
+     */
+    bool is_frame_layout_ok(const CANFrame& src, std::vector<std::string>& diagnosis);
+
     /**
      * @brief Like is_frame_layout_ok() but throws a CANDatabaseException if the layout is ill-formed
      */
-    void assert_frame_layout();
+    void assert_frame_layout(const CANFrame& src);
 }    
 } // namespace CppCAN
 

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);

include/Tokenizer.h

@@ -38,8 +38,8 @@ class Tokenizer {
   bool started;
 
 protected:
-  unsigned long long charCnt;
-  unsigned long long lineCnt;
+  size_t charCnt;
+  size_t lineCnt;
   bool addLine;
 };