Added "monitor help" command, to display help text on supported GDB custom commands

src/DebugServer/Gdb/CommandPackets/HelpMonitorInfo.cpp

@@ -0,0 +1,51 @@
+#include "HelpMonitorInfo.hpp"
+
+#include <QFile>
+#include <QString>
+
+#include "src/DebugServer/Gdb/ResponsePackets/ErrorResponsePacket.hpp"
+#include "src/DebugServer/Gdb/ResponsePackets/ResponsePacket.hpp"
+
+#include "src/Helpers/Paths.hpp"
+#include "src/Logger/Logger.hpp"
+#include "src/Exceptions/Exception.hpp"
+
+namespace Bloom::DebugServer::Gdb::CommandPackets
+{
+    using TargetController::TargetControllerConsole;
+
+    using ResponsePackets::ErrorResponsePacket;
+    using ResponsePackets::ResponsePacket;
+
+    using Exceptions::Exception;
+
+    HelpMonitorInfo::HelpMonitorInfo(Monitor&& monitorPacket)
+        : Monitor(std::move(monitorPacket))
+    {}
+
+    void HelpMonitorInfo::handle(DebugSession& debugSession, TargetControllerConsole&) {
+        Logger::debug("Handling HelpMonitorInfo packet");
+
+        try {
+            // The file gdbHelpMonitorInfo.txt is included in the binary image as a resource. See src/resource.qrc
+            auto helpFile = QFile(
+                QString::fromStdString(Paths::compiledResourcesPath() + "/resources/gdbHelpMonitorInfo.txt")
+            );
+
+            if (!helpFile.open(QIODevice::ReadOnly)) {
+                throw Exception(
+                    "Failed to open GDB monitor info help file - please report this issue at " + Paths::homeDomainName()
+                        + "/report-issue"
+                );
+            }
+
+            debugSession.connection.writePacket(
+                ResponsePacket(Packet::toHex("\n" + QTextStream(&helpFile).readAll().toUtf8().toStdString() + "\n"))
+            );
+
+        } catch (const Exception& exception) {
+            Logger::error(exception.getMessage());
+            debugSession.connection.writePacket(ErrorResponsePacket());
+        }
+    }
+}

src/DebugServer/Gdb/CommandPackets/HelpMonitorInfo.hpp

@@ -0,0 +1,24 @@
+#pragma once
+
+#include <cstdint>
+
+#include "Monitor.hpp"
+
+namespace Bloom::DebugServer::Gdb::CommandPackets
+{
+    /**
+     * The HelpMonitorInfo class implements a structure for the "monitor help" GDB command.
+     *
+     * We just respond with some help info on the available "monitor" commands.
+     */
+    class HelpMonitorInfo: public Monitor
+    {
+    public:
+        explicit HelpMonitorInfo(Monitor&& monitorPacket);
+
+        void handle(
+            DebugSession& debugSession,
+            TargetController::TargetControllerConsole& targetControllerConsole
+        ) override;
+    };
+}