Merge branch 'starting-library'

Author: LinuxDevon

CMakeLists.txt

@@ -1,12 +1,12 @@
 cmake_minimum_required(VERSION 3.10)
 
-project(DBC)
+project(dbc)
 
 # specify the C++ standard
 set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED True)
 
-# Add in the debug flag
+# Add in the debug flag0.
 set(GCC_COVERAGE_COMPILE_FLAGS "-g")
 set(CMAKE_CXX_FLAGS  "${CMAKE_CXX_FLAGS} ${GCC_COVERAGE_COMPILE_FLAGS}")
 
@@ -19,3 +19,4 @@ include_directories(include)
 add_subdirectory(test)
 add_subdirectory(doc)
 
+add_library(${PROJECT_NAME} STATIC ${SOURCE})

README.md

@@ -1,17 +1,25 @@
-# C++ DBC Header Only File Parser
+# C++ DBC Parser
 
 This is to provide a library header only file to read in DBC files. I was looking around and couldn't
 find a simple library that didn't have dependencies. So here we are making one. I got some inspiration
 from the python dbc library here: https://pypi.org/project/cantools/
 
 ## Testing
 
-I am trying to alwasy make sure that this is very well tested code. I am using Catch2 to do this
+I am trying to always make sure that this is very well tested code. I am using Catch2 to do this
 testing and if you aren't familiar here is the documentation: https://github.com/catchorg/Catch2/blob/master/docs/Readme.md#top
 
+To run the tests locally you can use the following:
+```bash
+mkdir build
+cd build
+cmake ..
+make test -j
+```
+
 ## Building
 
-I am using Cmake to be able to build the tests. I plan on doing more with it but this is what it
+I am using Cmake to be able to build the tests and the lib. I plan on doing more with it but this is what it
 is for now. I am doing developement on the WSL Ubuntu 18.04 kernel. This doesn't mean that IDEs aren't
 welcome but the build process might not be suited for this. You will need to modify it for your
 needs. Feel free to submit changes so the building process will be more robust.
@@ -24,8 +32,6 @@ cmake ..
 make
 ```
 
-These steps produce an executable in the bin folder.
-
 ## Contributing
 
 I welcome all help! Please feel free to fork and start some pull requests!

doc/Doxyfile.in

@@ -6,6 +6,13 @@ INPUT                  = @doxy_main_page@ \
                          @PROJECT_SOURCE_DIR@ \
                          @PROJECT_BINARY_DIR@
 FILE_PATTERNS          = *.h \
-                         *.cc
+                         *.hpp \
+                         *.cc \
+                         *.ccp
 RECURSIVE              = YES
-USE_MDFILE_AS_MAINPAGE = @doxy_main_page@
+USE_MDFILE_AS_MAINPAGE = @doxy_main_page@
+
+EXCLUDE_PATTERNS       = */third_party/*
+EXCLUDE_PATTERNS 	  += */test/*
+
+HAVE_DOT 			   = YES

src/dbc.hpp

@@ -1,8 +1,67 @@
+#include "exceptions/error.hpp"
+#include "util/utils.hpp"
 
-namespace dbc {
+#include <regex>
 
-class parser {
+namespace libdbc {
 
-};
+	class Parser {
+	public:
+		virtual ~Parser() = default;
+
+		virtual void parse_file(const std::string& file) = 0;
+
+	protected:
+
+
+	};
+
+	class DbcParser : public Parser {
+	public:
+		DbcParser() : version(""), version_re("(VERSION)\\s\"(.*)\"") {}
+
+		virtual ~DbcParser() = default;
+
+		virtual void parse_file(const std::string& file) final override {
+			std::ifstream s(file.c_str());
+			std::string line;
+
+			parse_dbc_header(s);
+
+			while(!s.eof()) {
+				utils::SafeString::get_line(s, line);
+
+			}
+
+		}
+
+		std::string get_version() const {
+			return version;
+		}
+
+	private:
+		std::string version;
+
+		const std::regex version_re;
+
+		void parse_dbc_header(std::istream& file_stream) {
+			std::string line;
+			std::smatch match;
+
+			utils::SafeString::get_line(file_stream, line);
+
+			if(!std::regex_search(line, match, version_re)) {
+				throw validity_error();
+			}
+
+			version = match.str(2);
+
+		}
+
+	};
+
+	struct Message {
+
+	};
 
 }

src/exceptions/error.hpp

@@ -0,0 +1,16 @@
+
+namespace libdbc {
+
+	class exception : public std::exception {
+		const char * what() const throw() {
+			return "libdbc exception occurred";
+		}
+	};
+
+	class validity_error : public exception {
+		const char * what() const throw() {
+			return "invalid file issue";
+		}
+	};
+
+} // libdbc

src/util/utils.cpp

@@ -1,6 +1,6 @@
 #include "util/utils.hpp"
 
-namespace Utils {
+namespace utils {
 
 	std::istream & SafeString::get_line( std::istream & stream, std::string & line ) {
 		std::string newline;

src/util/utils.hpp

@@ -2,7 +2,7 @@
 #include <fstream>
 #include <iostream>
 
-namespace Utils {
+namespace utils {
 
 	class SafeString {
 	public:

test/CMakeLists.txt

@@ -1,7 +1,7 @@
 project(tests VERSION 0.1.0)
 
 list(APPEND TEST_SOURCES main.cpp
-			 test_file_loading.cpp
+			 test_dbc.cpp
 			 test_utils.cpp)
 
 include_directories(SYSTEM ${PROJECT_SOURCE_DIR}/third_party/Catch2/single_include)

test/dbcs/Sample2.dbc

@@ -0,0 +1,38 @@
+VERSION "1.0.0"
+
+NS_ :
+	BA_
+	BA_DEF_
+	BA_DEF_DEF_
+	BA_DEF_DEF_REL_
+	BA_DEF_REL_
+	BA_DEF_SGTYPE_
+	BA_REL_
+	BA_SGTYPE_
+	BO_TX_BU_
+	BU_BO_REL_
+	BU_EV_REL_
+	BU_SG_REL_
+	CAT_
+	CAT_DEF_
+	CM_
+	ENVVAR_DATA_
+	EV_DATA_
+	FILTER
+	NS_DESC_
+	SGTYPE_
+	SGTYPE_VAL_
+	SG_MUL_VAL_
+	SIGTYPE_VALTYPE_
+	SIG_GROUP_
+	SIG_TYPE_REF_
+	SIG_VALTYPE_
+	VAL_
+	VAL_TABLE_
+
+BS_:
+
+BU_: DBG DRIVER IO MOTOR SENSOR
+
+BO_ 500 IO_DEBUG: 4 IO
+ SG_ IO_DEBUG_test_unsigned : 0|8@1+ (1,0) [0|0] "" DBG

test/defines.hpp

@@ -1,3 +1,5 @@
 #include <string>
 
-static const std::string TEXT_FILE = "./dbcs/TextFile.txt";
+static const std::string TEXT_FILE = "./dbcs/TextFile.txt";
+static const std::string DBC_FILE_1 = "./dbcs/Sample1.dbc";
+static const std::string DBC_FILE_2 = "./dbcs/Sample2.dbc";