- Add option to save IOP before parsing

- Add iop parser example for IOP parser debugging purposes

Fixes #614, needed for Open-Agriculture/AgIsoVirtualTerminal#140

Author: martonmiklos

CMakeLists.txt

@@ -69,6 +69,7 @@ if(BUILD_EXAMPLES)
   add_subdirectory("examples/virtual_terminal/version3_object_pool")
   add_subdirectory("examples/virtual_terminal/aux_functions")
   add_subdirectory("examples/virtual_terminal/aux_inputs")
+  add_subdirectory("examples/virtual_terminal/iop_parser_tester")
   add_subdirectory("examples/task_controller_client")
   add_subdirectory("examples/task_controller_server")
   add_subdirectory("examples/guidance")

examples/virtual_terminal/version3_object_pool/console_logger.cpp renamed to examples/virtual_terminal/common/console_logger.cpp

@@ -0,0 +1,16 @@
+cmake_minimum_required(VERSION 3.16)
+project(iop_parser)
+
+if(NOT BUILD_EXAMPLES)
+  find_package(isobus REQUIRED)
+endif()
+find_package(Threads REQUIRED)
+
+add_executable(iop_parser main.cpp ../common/console_logger.cpp)
+
+target_compile_features(iop_parser PUBLIC cxx_std_11)
+set_target_properties(iop_parser PROPERTIES CXX_EXTENSIONS OFF)
+
+target_link_libraries(
+  iop_parser PRIVATE isobus::Isobus Threads::Threads
+                     isobus::HardwareIntegration isobus::Utility)

examples/virtual_terminal/iop_parser_tester/CMakeLists.txt

@@ -0,0 +1,43 @@
+#include "isobus/isobus/isobus_virtual_terminal_server_managed_working_set.hpp"
+
+#include <cstdint>
+#include <fstream>
+#include <iostream>
+#include <vector>
+
+#include "../common/console_logger.cpp"
+
+int main(int argc, char *argv[])
+{
+	if (argc != 2)
+	{
+		std::cerr << "Usage: " << argv[0] << " <iop file path>\n";
+		return 1;
+	}
+
+	const char *filename = argv[1];
+	std::ifstream file(filename, std::ios::binary);
+	if (!file)
+	{
+		std::cerr << "Unable to open: " << filename << "\n";
+		return 1;
+	}
+
+	std::vector<std::uint8_t> buffer((std::istreambuf_iterator<char>(file)),
+	                                 std::istreambuf_iterator<char>());
+
+	if (buffer.empty())
+	{
+		std::cerr << "File is empty or not readable.\n";
+		return 1;
+	}
+
+	isobus::CANStackLogger::set_can_stack_logger_sink(&logger);
+
+	isobus::VirtualTerminalServerManagedWorkingSet vt;
+	bool result = vt.parse_iop_into_objects(buffer.data(),
+	                                        static_cast<std::uint32_t>(buffer.size()));
+
+	std::cout << "IOP parse result: " << std::boolalpha << result << "\n";
+	return 0;
+}

examples/virtual_terminal/iop_parser_tester/main.cpp

@@ -6,7 +6,8 @@ if(NOT BUILD_EXAMPLES)
 endif()
 find_package(Threads REQUIRED)
 
-add_executable(VT3ExampleTarget main.cpp console_logger.cpp objectPoolObjects.h)
+add_executable(VT3ExampleTarget main.cpp ../common/console_logger.cpp
+                                objectPoolObjects.h)
 
 target_compile_features(VT3ExampleTarget PUBLIC cxx_std_11)
 set_target_properties(VT3ExampleTarget PROPERTIES CXX_EXTENSIONS OFF)

examples/virtual_terminal/version3_object_pool/CMakeLists.txt

@@ -7,7 +7,7 @@
 #include "isobus/isobus/isobus_virtual_terminal_client_update_helper.hpp"
 #include "isobus/utility/iop_file_interface.hpp"
 
-#include "console_logger.cpp"
+#include "../common/console_logger.cpp"
 #include "objectPoolObjects.h"
 
 #include <atomic>
@@ -102,7 +102,7 @@ int main()
 	// Automatically load the desired CAN driver based on the available drivers
 	std::shared_ptr<isobus::CANHardwarePlugin> canDriver = nullptr;
 #if defined(ISOBUS_SOCKETCAN_AVAILABLE)
-	canDriver = std::make_shared<isobus::SocketCANInterface>("can0");
+	canDriver = std::make_shared<isobus::SocketCANInterface>("vcan0");
 #elif defined(ISOBUS_WINDOWSPCANBASIC_AVAILABLE)
 	canDriver = std::make_shared<isobus::PCANBasicWindowsPlugin>(PCAN_USBBUS1);
 #elif defined(ISOBUS_WINDOWSINNOMAKERUSB2CAN_AVAILABLE)

examples/virtual_terminal/version3_object_pool/main.cpp

@@ -267,6 +267,11 @@ namespace isobus
 		/// @returns The background color on the softkey mask
 		virtual std::uint8_t get_user_layout_softkeymask_bg_color() const;
 
+		/// @brief Callback function which is called before the transferred IOP data parsing is started
+		/// Useful to save IOP data for debugging purposes in the case if the parsing would lead to a crash
+		/// @param ws[in] the working set which object pool processing is about to be started
+		virtual void transferred_object_pool_parse_start(std::shared_ptr<VirtualTerminalServerManagedWorkingSet> &ws) const;
+
 		//-------------- Callbacks/Event driven interface ---------------------
 
 		/// @brief Returns the event dispatcher for repaint events

isobus/include/isobus/isobus/isobus_virtual_terminal_server.hpp

@@ -141,6 +141,7 @@ namespace isobus
 		/// @brief The object pool processing thread will execute this function when it runs
 		void worker_thread_function();
 
+		std::string debugIopSavePath; ///< A path where the IOP will be saved before parsing if it is not an empty string
 		std::unique_ptr<std::thread> objectPoolProcessingThread = nullptr; ///< A thread to process the object pool with, since that can be fairly time consuming.
 		std::shared_ptr<ControlFunction> workingSetControlFunction = nullptr; ///< Stores the control function associated with this working set
 		std::vector<isobus::EventCallbackHandle> callbackHandles; ///< A convenient way to associate callback handles to a working set

isobus/include/isobus/isobus/isobus_virtual_terminal_server_managed_working_set.hpp

@@ -99,6 +99,11 @@ namespace isobus
 		return 0;
 	}
 
+	void VirtualTerminalServer::transferred_object_pool_parse_start(std::shared_ptr<isobus::VirtualTerminalServerManagedWorkingSet> &ws) const
+	{
+		(void)ws;
+	}
+
 	std::uint8_t VirtualTerminalServer::get_user_layout_datamask_bg_color() const
 	{
 		LOG_ERROR("[VT Server]: The Get User Layout Datamask background color is not implemented, returning with black");
@@ -589,6 +594,7 @@ namespace isobus
 								{
 									if (cf->get_any_object_pools())
 									{
+										parentServer->transferred_object_pool_parse_start(cf);
 										cf->start_parsing_thread();
 									}
 									else

isobus/src/isobus_virtual_terminal_server.cpp

@@ -13,6 +13,8 @@
 #include "isobus/utility/to_string.hpp"
 
 #include <cstring>
+#include <fstream>
+#include <iostream>
 
 namespace isobus
 {
@@ -183,6 +185,7 @@ namespace isobus
 			LOG_INFO("[WS]: Beginning parsing of object pool. This pool has " +
 			         isobus::to_string(static_cast<int>(iopFilesRawData.size())) +
 			         " IOP components.");
+
 			for (std::size_t i = 0; i < iopFilesRawData.size(); i++)
 			{
 				if (!parse_iop_into_objects(iopFilesRawData[i].data(), static_cast<std::uint32_t>(iopFilesRawData[i].size())))