Merge branch 'master' into parsingMessage

Author: Murmele

CMakeLists.txt

@@ -1,10 +1,22 @@
-cmake_minimum_required(VERSION 3.10)
+cmake_minimum_required(VERSION 3.23)
+# FILE_SET needs cmake 3.23
 
-project(dbc)
+project(dbc VERSION 0.1.1 DESCRIPTION "C++ DBC Parser")
+
+# package
+set(CPACK_PACKAGE_VERSION_MAJOR ${PROJECT_VERSION_MAJOR})
+set(CPACK_PACKAGE_VERSION_MINOR ${PROJECT_VERSION_MINOR})
+set(CPACK_PACKAGE_VERSION_PATCH ${PROJECT_VERSION_PATCH})
+set(CPACK_RESOURCE_FILE_LICENSE ${CMAKE_CURRENT_SOURCE_DIR}/LICENSE)
+set(CPACK_RESOURCE_FILE_README ${CMAKE_CURRENT_SOURCE_DIR}/README.md)
+include(CPack)
 
 option(DEBUG "use debug flag" NO)
 option(ENABLE_TESTS "Enable Unittests" ON)
 
+# defines variables used in the dbc.pc.in
+include(GNUInstallDirs)
+
 # specify the C++ standard
 set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED True)
@@ -24,14 +36,22 @@ endif()
 
 set(CMAKE_CXX_FLAGS  "${CMAKE_CXX_FLAGS} ${GCC_COVERAGE_COMPILE_FLAGS}")
 
+add_subdirectory(third_party/bitstream)
+
 # add where to find the source files
 # file(GLOB_RECURSE SOURCE ${PROJECT_SOURCE_DIR}/src/ *.cpp)
 list(APPEND SOURCE ${PROJECT_SOURCE_DIR}/src/utils.cpp
 				   ${PROJECT_SOURCE_DIR}/src/message.cpp
 				   ${PROJECT_SOURCE_DIR}/src/signal.cpp
 				   ${PROJECT_SOURCE_DIR}/src/dbc.cpp)
 
-add_subdirectory(third_party/bitstream)
+set(HEADER_FILES
+  ${PROJECT_SOURCE_DIR}/include/libdbc/dbc.hpp
+  ${PROJECT_SOURCE_DIR}/include/libdbc/message.hpp
+  ${PROJECT_SOURCE_DIR}/include/libdbc/signal.hpp
+  ${PROJECT_SOURCE_DIR}/include/libdbc/utils/utils.hpp
+  ${PROJECT_SOURCE_DIR}/include/libdbc/exceptions/error.hpp
+)
 
 include_directories(src)
 include_directories(include)
@@ -45,8 +65,30 @@ add_subdirectory(doc)
 
 add_library(${PROJECT_NAME} STATIC ${SOURCE})
 target_link_libraries(${PROJECT_NAME} bitstream)
+target_sources(${PROJECT_NAME} INTERFACE FILE_SET HEADERS
+	TYPE HEADERS
+	BASE_DIRS ${PROJECT_SOURCE_DIR}/include/libdbc
+	FILES ${HEADER_FILES})
 
 add_custom_target(release
 					WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
 					COMMAND ${CMAKE_SOURCE_DIR}/scripts/create_single_header.sh
 					DEPENDS ${PROJECT_NAME})
+
+## Installation
+# install lib
+install(TARGETS ${PROJECT_NAME}
+		DESTINATION ${CMAKE_INSTALL_LIBDIR})
+
+# install headers
+install(TARGETS ${PROJECT_NAME}
+		FILE_SET HEADERS
+		DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/lib${PROJECT_NAME}
+		INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+)
+
+# Generate pkg-config file
+configure_file(${PROJECT_NAME}.pc.in ${PROJECT_NAME}.pc @ONLY)
+install(
+    FILES ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc
+    DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig)

dbc.pc.in

@@ -0,0 +1,10 @@
+prefix=@CMAKE_INSTALL_PREFIX@
+exec_prefix=${prefix}
+includedir=${prefix}/@CMAKE_INSTALL_INCLUDEDIR@
+libdir=${exec_prefix}/@CMAKE_INSTALL_LIBDIR@
+
+Name: @PROJECT_NAME@
+Description: @CPACK_PACKAGE_DESCRIPTION_SUMMARY@
+Version: @CPACK_PACKAGE_VERSION@
+Cflags: -I${includedir}
+Libs: -L${libdir} -l@PROJECT_NAME@

include/libdbc/exceptions/error.hpp

@@ -6,34 +6,19 @@
 namespace libdbc {
 
 	class exception : public std::exception {
+	public:
 		const char * what() const throw() {
 			return "libdbc exception occurred";
 		}
 	};
 
 	class validity_error : public exception {
+	public:
 		const char * what() const throw() {
-			return "Invalid DBC file...";
+			return "Invalid DBC file";
 		}
 	};
 
-	class header_error : public validity_error {
-		header_error(const char* line, const char* expected, const char * file) :
-			line(line), expected(expected), file(file) {}
-
-		const char * what() const throw() {
-			std::ostringstream os;
-			os << "Issue with the header line ( " << line << " ) in file ( ";
-			os << file << " ). Expected to find: " << expected;
-			return os.str().c_str();
-		}
-
-	private:
-		const char * line;
-		const char * expected;
-		const char * file;
-	};
-
 } // libdbc
 
 #endif // __ERROR_HPP__

test/test_dbc.cpp

@@ -35,6 +35,15 @@ TEST_CASE("Testing dbc file loading error issues", "[fileio][error]") {
 		// very well standardized for now we ignore this type of error.
 		CHECK_NOTHROW(parser->parse_file(MISSING_NEW_SYMBOLS_DBC_FILE));
 	}
+
+	SECTION("Verify that what() method is accessible for all exceptions", "[error]")
+	{
+		auto generic_error = libdbc::exception();
+		REQUIRE(generic_error.what() == "libdbc exception occurred");
+
+		auto validity_check = libdbc::validity_error();
+		REQUIRE(validity_check.what() == "Invalid DBC file");
+	}
 }
 
 TEST_CASE("Testing dbc file loading", "[fileio]") {