Debugger for xeus-cpp with testing framework

.gitignore

@@ -48,3 +48,5 @@ bld
 
 # MacOS specific files
 *.DS_Store
+
+.cache/

CMakeLists.txt

@@ -164,6 +164,10 @@ configure_kernel("/share/jupyter/kernels/xc11/")
 configure_kernel("/share/jupyter/kernels/xc17/")
 configure_kernel("/share/jupyter/kernels/xc23/")
 
+if(NOT EMSCRIPTEN AND NOT WIN32)
+    configure_kernel("/share/jupyter/kernels/xcpp17-debugger/")
+endif()
+
 # Source files
 # ============
 
@@ -178,6 +182,7 @@ set(XEUS_CPP_HEADERS
     include/xeus-cpp/xmagics.hpp
     include/xeus-cpp/xoptions.hpp
     include/xeus-cpp/xpreamble.hpp
+    include/xeus-cpp/xdebugger.hpp
     #src/xinspect.hpp
     #src/xsystem.hpp
     #src/xparser.hpp
@@ -192,6 +197,9 @@ set(XEUS_CPP_SRC
     src/xparser.cpp
     src/xutils.cpp
     src/xmagics/os.cpp
+    src/xdebugger.cpp
+    src/xdebuglldb_client.cpp
+    src/xinternal_utils.cpp
 )
 
 if(NOT EMSCRIPTEN)

include/xeus-cpp/xdebugger.hpp

@@ -0,0 +1,118 @@
+/************************************************************************************
+ * Copyright (c) 2023, xeus-cpp contributors                                        *
+ *                                                                                  *
+ * Distributed under the terms of the BSD 3-Clause License.                         *
+ *                                                                                  *
+ * The full license is in the file LICENSE, distributed with this software.         *
+ ************************************************************************************/
+
+#ifndef XEUS_CPP_XDEBUGGER_HPP
+#define XEUS_CPP_XDEBUGGER_HPP
+
+#ifdef __GNUC__
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wattributes"
+#endif
+
+#include <string>
+
+#include "nlohmann/json.hpp"
+#include "xeus-cpp/xinterpreter.hpp"
+#include "xeus-zmq/xdebugger_base.hpp"
+#include "xeus_cpp_config.hpp"
+
+namespace xcpp
+{
+    class xdebuglldb_client;
+
+    class XEUS_CPP_API debugger : public xeus::xdebugger_base
+    {
+    public:
+
+        using base_type = xeus::xdebugger_base;
+
+        debugger(
+            xeus::xcontext& context,
+            const xeus::xconfiguration& config,
+            const std::string& user_name,
+            const std::string& session_id,
+            const nl::json& debugger_config
+        );
+
+        virtual ~debugger();
+
+    private:
+
+        nl::json inspect_variables_request(const nl::json& message);
+        nl::json stack_trace_request(const nl::json& message);
+        nl::json attach_request(const nl::json& message);
+        nl::json configuration_done_request(const nl::json& message);
+        nl::json set_breakpoints_request(const nl::json& message);
+        nl::json dump_cell_request(const nl::json& message);
+        nl::json rich_inspect_variables_request(const nl::json& message);
+        nl::json copy_to_globals_request(const nl::json& message);
+        nl::json source_request(const nl::json& message);
+
+        bool get_variable_info_from_lldb(
+            const std::string& var_name,
+            int frame_id,
+            nl::json& data,
+            nl::json& metadata,
+            int sequence
+        );
+        void get_container_info(
+            const std::string& var_name,
+            int frame_id,
+            const std::string& var_type,
+            nl::json& data,
+            nl::json& metadata,
+            int sequence,
+            int size
+        );
+        bool is_container_type(const std::string& type) const;
+
+        bool start_lldb();
+        bool start() override;
+        void stop() override;
+        xeus::xdebugger_info get_debugger_info() const override;
+        virtual std::string get_cell_temporary_file(const std::string& code) const override;
+
+        bool connect_to_lldb_tcp();
+        std::string send_dap_message(const nl::json& message);
+        std::string receive_dap_response();
+
+        xdebuglldb_client* p_debuglldb_client;
+        std::string m_lldb_host;
+        std::string m_lldb_port;
+        nl::json m_debugger_config;
+        bool m_is_running;
+        int m_tcp_socket;
+        bool m_tcp_connected;
+        pid_t jit_process_pid;
+
+        using breakpoint_list_t = std::map<std::string, std::vector<nl::json>>;
+        breakpoint_list_t m_breakpoint_list;
+
+        xcpp::interpreter* m_interpreter;
+
+        std::unordered_map<std::string, std::vector<std::string>> m_hash_to_sequential;
+        std::unordered_map<std::string, std::string> m_sequential_to_hash;
+
+        bool m_copy_to_globals_available;
+    };
+
+    XEUS_CPP_API
+    std::unique_ptr<xeus::xdebugger> make_cpp_debugger(
+        xeus::xcontext& context,
+        const xeus::xconfiguration& config,
+        const std::string& user_name,
+        const std::string& session_id,
+        const nl::json& debugger_config
+    );
+}
+
+#ifdef __GNUC__
+#pragma GCC diagnostic pop
+#endif
+
+#endif

include/xeus-cpp/xinterpreter.hpp

@@ -15,6 +15,7 @@
 #include <streambuf>
 #include <string>
 #include <vector>
+#include <thread>
 
 #include "clang/Interpreter/CppInterOp.h" // from CppInterOp package
 
@@ -39,6 +40,27 @@ namespace xcpp
 
         void publish_stdout(const std::string&);
         void publish_stderr(const std::string&);
+        static int32_t get_current_pid();
+
+        std::vector<int> get_execution_count(const std::string& code) const
+        {
+            auto it = m_code_to_execution_count_map.find(code);
+            if (it != m_code_to_execution_count_map.end())
+            {
+                return it->second;
+            }
+            return {};
+        }
+
+        std::string get_code_from_execution_count(int execution_count) const
+        {
+            auto it = m_execution_count_to_code_map.find(execution_count);
+            if(it != m_execution_count_to_code_map.end()) 
+            {
+                return it->second;
+            }
+            return "";
+        }
 
     private:
 
@@ -85,6 +107,9 @@ namespace xcpp
 
         xoutput_buffer m_cout_buffer;
         xoutput_buffer m_cerr_buffer;
+
+        std::map<std::string, std::vector<int>> m_code_to_execution_count_map;
+        std::map<int, std::string> m_execution_count_to_code_map;
     };
 }