Working single header creation

Clang format added line endings because the creation of single header needs extra line before EOF
Reformatted the spacing of the cmake for the tests
Added line before EOF in files.

Author: LinuxDevon

.clang-format

@@ -102,3 +102,5 @@ AllowShortLambdasOnASingleLine: Empty
 
 # We do not want clang-format to put all arguments on a new line
 AllowAllArgumentsOnNextLine: false
+
+InsertNewlineAtEOF: true

CMakeLists.txt

@@ -9,6 +9,7 @@ project(dbc
 option(DBC_ENABLE_TESTS "Enable Unittests" ON)
 option(DBC_TEST_LOCALE_INDEPENDENCE "Used to deterime if the libary is locale agnostic when it comes to converting floats. You need `de_DE.UTF-8` locale installed for this testing." OFF)
 option(DBC_GENERATE_DOCS "Use doxygen if installed to generated documentation files" OFF)
+option(DBC_GENERATE_SINGLE_HEADER "This will run the generator for the single header file version. Default is OFF since we make a static build. Requires cargo installed." OFF)
 # ---------------------- #
 
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
@@ -94,11 +95,12 @@ target_sources(${PROJECT_NAME} INTERFACE FILE_SET HEADERS
         FILES ${HEADER_FILES}
 )
 
-add_custom_target(release
-					WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-					COMMAND ${CMAKE_SOURCE_DIR}/scripts/create_single_header.sh
-					DEPENDS ${PROJECT_NAME}
-)
+if(DBC_GENERATE_SINGLE_HEADER)
+    add_custom_target(single_header ALL
+    					WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+    					COMMAND ${CMAKE_SOURCE_DIR}/scripts/create_single_header.sh
+    )
+endif()
 
 ## Installation
 # install lib

README.md

@@ -36,6 +36,15 @@ cmake -LH .. | grep -B1 "DBC_"
 cmake -LAH ..
 ```
 
+### Creating a Single Header File
+
+If you want to generate one header file you will need to run the `./scripts/create_single_header.sh`.
+
+It requires you have `cargo` installed from rust. See these instructions if you don't have that https://www.rust-lang.org/tools/install.
+It uses the https://github.com/Felerius/cpp-amalgamate crate to do the single header file creation.
+
+The output will be generated in the `build/single_header/libdbc/` folder. You can run a cmake command to build this as well as other targets.
+
 ## Testing
 
 I am trying to always make sure that this is very well tested code. I am using Catch2 to do this

include/libdbc/dbc.hpp

@@ -1,4 +1,3 @@
-
 #ifndef __DBC_HPP__
 #define __DBC_HPP__
 

include/libdbc/exceptions/error.hpp

@@ -21,4 +21,4 @@ class validity_error : public exception {
 
 } // libdbc
 
-#endif // __ERROR_HPP__
+#endif // __ERROR_HPP__

scripts/create_single_header.sh

@@ -7,7 +7,7 @@ cargo install cpp-amalgamate
 rm -rf build/single_header/
 mkdir -p build/single_header/libdbc
 
-files=$(find src -name "*.cpp")
-files="${files} $(find include -name "*.hpp")"
+source_files=$(find src -name "*.cpp")
+include_files=$(find include -name "*.hpp")
 
-cpp-amalgamate -d include -d build/_deps/fastfloat-src/include ${files} -o build/single_header/libdbc/libdbc.hpp
+cpp-amalgamate -d include -d build/_deps/fastfloat-src/include -o build/single_header/libdbc/libdbc.hpp ${source_files} ${include_files}

src/signal.cpp

@@ -51,4 +51,4 @@ std::ostream& operator<<(std::ostream& out, const Signal& sig) {
 		out << r;
 	return out << "}";
 }
-}
+}

test/CMakeLists.txt

@@ -3,9 +3,9 @@ enable_testing()
 # Download and build Catch2 test framework
 Include(FetchContent)
 FetchContent_Declare(
-  Catch2
-  GIT_REPOSITORY https://github.com/catchorg/Catch2.git
-  GIT_TAG        v3.5.2
+	Catch2
+	GIT_REPOSITORY https://github.com/catchorg/Catch2.git
+	GIT_TAG        v3.5.2
 )
 FetchContent_MakeAvailable(Catch2)
 include(Catch)
@@ -14,21 +14,22 @@ include(Catch)
 set(CMAKE_CXX_STANDARD 17)
 
 if (MSVC)
-    add_compile_options(/W4 /WX)
+	add_compile_options(/W4 /WX)
 else()
-    add_compile_options(-Wall -Wextra -Wpedantic -Werror)
+	add_compile_options(-Wall -Wextra -Wpedantic -Werror)
 endif()
 
 # Code coverage compiler specific
 if (GCC)
   add_compile_options(--coverage)
 endif()
 
+
 add_executable(dbcParserTests
-    test_dbc.cpp
-    test_utils.cpp
-    test_parseMessage.cpp
-    common.cpp
+	test_dbc.cpp
+	test_utils.cpp
+	test_parse_message.cpp
+	common.cpp
 )
 
 target_compile_definitions(dbcParserTests PRIVATE TESTDBCFILES_PATH="${CMAKE_CURRENT_SOURCE_DIR}/dbcs")
@@ -40,16 +41,31 @@ catch_discover_tests(dbcParserTests)
 # We want a seperate binary for this test. We setup global locals which mess with all of the testing.
 # Opting for a sperate test running so we don't conflict
 if(DBC_TEST_LOCALE_INDEPENDENCE)
-  add_executable(dbcLocaleTests
-      locale_testing/test_locale_main.cpp
-      common.cpp
-  )
+	add_executable(dbcLocaleTests
+		locale_testing/test_locale_main.cpp
+		common.cpp
+	)
 
-  target_compile_definitions(dbcLocaleTests PRIVATE TESTDBCFILES_PATH="${CMAKE_CURRENT_SOURCE_DIR}/dbcs")
-  target_link_libraries(dbcLocaleTests PRIVATE dbc Catch2::Catch2WithMain)
-  target_include_directories(dbcLocaleTests PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
+	target_compile_definitions(dbcLocaleTests PRIVATE TESTDBCFILES_PATH="${CMAKE_CURRENT_SOURCE_DIR}/dbcs")
+	target_link_libraries(dbcLocaleTests PRIVATE dbc Catch2::Catch2WithMain)
+	target_include_directories(dbcLocaleTests PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
 
-  catch_discover_tests(dbcLocaleTests)
+catch_discover_tests(dbcLocaleTests)
 else()
-  message(WARNING "Locale independent testing is turned off!")
+	message(WARNING "Locale independent testing is turned off!")
+endif()
+
+# Again another test binary to ensure we aren't including our other headers.
+# It should compile and run on one include
+if(DBC_GENERATE_SINGLE_HEADER)
+	add_executable(dbcSingleHeaderTest
+		single_header_testing/test_single_header.cpp
+		common.cpp
+	)
+
+	target_compile_definitions(dbcSingleHeaderTest PRIVATE TESTDBCFILES_PATH="${CMAKE_CURRENT_SOURCE_DIR}/dbcs")
+	target_link_libraries(dbcSingleHeaderTest PRIVATE Catch2::Catch2WithMain)
+	target_include_directories(dbcSingleHeaderTest PRIVATE ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_BINARY_DIR}/single_header/)
+
+	catch_discover_tests(dbcSingleHeaderTest)
 endif()

test/single_header_testing/test_single_header.cpp

@@ -0,0 +1,56 @@
+#include "common.hpp"
+#include "defines.hpp"
+#include <libdbc/libdbc.hpp>
+
+#include <catch2/catch_approx.hpp>
+#include <catch2/catch_test_macros.hpp>
+#include <catch2/matchers/catch_matchers.hpp>
+
+TEST_CASE("Testing dbc file loading", "[fileio]") {
+	auto parser = std::unique_ptr<libdbc::DbcParser>(new libdbc::DbcParser());
+
+	SECTION("Loading a single simple dbc file", "[dbc]") {
+		std::vector<std::string> nodes = {"DBG", "DRIVER", "IO", "MOTOR", "SENSOR"};
+
+		libdbc::Message msg(500, "IO_DEBUG", 4, "IO");
+
+		std::vector<std::string> receivers{"DBG"};
+		libdbc::Signal sig("IO_DEBUG_test_unsigned", false, 0, 8, false, false, 1, 0, 0, 0, "", receivers);
+		msg.appendSignal(sig);
+
+		std::vector<libdbc::Message> msgs = {msg};
+
+		parser->parse_file(SIMPLE_DBC_FILE);
+
+		REQUIRE(parser->get_version() == "1.0.0");
+
+		REQUIRE(parser->get_nodes() == nodes);
+
+		REQUIRE(parser->get_messages() == msgs);
+
+		REQUIRE(parser->get_messages().front().getSignals() == msg.getSignals());
+	}
+}
+
+TEST_CASE("Testing  big endian, little endian") {
+	std::string dbc_contents = PRIMITIVE_DBC + R"(BO_ 234 MSG1: 8 Vector__XXX
+ SG_ Sig1 : 55|16@0- (0.1,0) [-3276.8|-3276.7] "C" Vector__XXX
+ SG_ Sig2 : 39|16@1- (0.1,0) [-3276.8|-3276.7] "C" Vector__XXX)";
+	const auto filename = create_temporary_dbc_with(dbc_contents.c_str());
+
+	auto parser = libdbc::DbcParser();
+	parser.parse_file(filename.c_str());
+
+	REQUIRE(parser.get_messages().size() == 1);
+	REQUIRE(parser.get_messages().at(0).name() == "MSG1");
+	REQUIRE(parser.get_messages().at(0).size() == 8);
+	REQUIRE(parser.get_messages().at(0).getSignals().size() == 2);
+	{
+		const auto signal = parser.get_messages().at(0).getSignals().at(0);
+		REQUIRE(signal.is_bigendian == true);
+	}
+	{
+		const auto signal = parser.get_messages().at(0).getSignals().at(1);
+		REQUIRE(signal.is_bigendian == false);
+	}
+}