Add examples directory and enable builds in CI

Created a directory of . In there I have a simple function to add these
source files. It creates and executable and links to the library.

Building of the examples was enabled in CI and then execute them to compare to
the example output for verification they work.

Author: LinuxDevon

.github/workflows/pipeline.yml

@@ -229,3 +229,14 @@ jobs:
     - name: Run build
       run: cmake --build build
 
+  test-examples:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Make build directory
+      run: cmake -Bbuild -DDBC_BUILD_EXAMPLES=ON -H$GITHUB_WORKSPACE
+
+    - name: Run example tests
+      run: cmake --build build --target test-examples

CMakeLists.txt

@@ -8,6 +8,7 @@ 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)
+option(DBC_BUILD_EXAMPLES "Build all the examples in the examples folder." OFF)
 # ---------------------- #
 
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
@@ -123,3 +124,5 @@ add_custom_target(clang-tidy-fix
 	clang-tidy -fix-notes -p ${CMAKE_BINARY_DIR}/compile_commands.json ${SOURCE_FILES} ${HEADER_FILES}
 	DEPENDS ${SOURCE_FILES} ${HEADER_FILES}
 )
+
+add_subdirectory(examples)

src/message.cpp

@@ -111,7 +111,7 @@ const std::string& Message::name() const {
 void Message::add_value_description(const std::string& signal_name, const std::vector<Signal::ValueDescription>& value_descriptor) {
 	for (auto& signal : m_signals) {
 		if (signal.name == signal_name) {
-			signal.value_descriptions = value_descriptor;
+		signal.value_descriptions = value_descriptor;
 			return;
 		}
 	}
@@ -120,7 +120,7 @@ void Message::add_value_description(const std::string& signal_name, const std::v
 std::ostream& operator<<(std::ostream& out, const Message& msg) {
 	out << "Message: {id: " << msg.id() << ", ";
 	out << "name: " << msg.m_name << ", ";
-	out << "size: " << msg.m_size << ", ";
+	out << "size: " << std::to_string(msg.m_size) << ", ";
 	out << "node: " << msg.m_node << "}";
 	return out;
 }

src/signal.cpp

@@ -42,13 +42,13 @@ bool Signal::operator<(const Signal& rhs) const {
 }
 
 std::ostream& operator<<(std::ostream& out, const Signal& sig) {
-	out << "Signal {name: " << sig.name << ", ";
+	out << "Signal: {name: " << sig.name << ", ";
 	out << "Multiplexed: " << (sig.is_multiplexed ? "True" : "False") << ", ";
-	out << "Start bit: " << sig.start_bit << ", ";
-	out << "Size: " << sig.size << ", ";
+	out << "Start bit: " << std::to_string(sig.start_bit) << ", ";
+	out << "Size: " << std::to_string(sig.size) << ", ";
 	out << "Endianness: " << (sig.is_bigendian ? "Big endian" : "Little endian") << ", ";
 	out << "Value Type: " << (sig.is_signed ? "Signed" : "Unsigned") << ", ";
-	out << "Min: " << sig.min << ", Max: " << sig.max << ", ";
+	out << "Min: " << std::to_string(sig.min) << ", Max: " << std::to_string(sig.max) << ", ";
 	out << "Unit: (" << sig.unit << "), ";
 	out << "receivers: ";
 	for (const auto& reciever : sig.receivers) {