chore! new project filesystem structure.

Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>

1 files changed, 43 insertions, 0 deletions

diff --git a/include/DebuggerKit/DebuggerContract.h b/include/DebuggerKit/DebuggerContract.h
new file mode 100644
index 0000000..e205e26
--- /dev/null
+++ b/include/DebuggerKit/DebuggerContract.h
@@ -0,0 +1,43 @@
+/* ========================================
+
+  Copyright (C) 2025 Amlal El Mahrouss, Licensed under the Apache 2.0 license.
+
+======================================== */
+
+#pragma once
+
+#include <DebuggerKit/Detail/Config.h>
+#include <unordered_map>
+
+#define DK_DEBUGGER_CONTRACT : public ::DebuggerKit::IDebuggerContract
+
+namespace DebuggerKit {
+class IDebuggerContract;
+
+/// =========================================================== ///
+/// \brief Debugger contract class in C++, as per the design states.
+/// \author Amlal El Mahrouss
+/// =========================================================== ///
+class IDebuggerContract {
+ public:
+  explicit IDebuggerContract() = default;
+  virtual ~IDebuggerContract() = default;
+
+ public:
+  IDebuggerContract& operator=(const IDebuggerContract&) = default;
+  IDebuggerContract(const IDebuggerContract&)            = default;
+
+ public:
+  virtual bool Attach(std::string path, std::string argv, ProcessID& pid) noexcept = 0;
+  virtual bool BreakAt(std::string symbol) noexcept                                = 0;
+  virtual bool Break() noexcept                                                    = 0;
+  virtual bool Continue() noexcept                                                 = 0;
+  virtual bool Detach() noexcept                                                   = 0;
+
+  virtual std::unordered_map<uintptr_t, uintptr_t>& Get() { return m_breakpoints; }
+
+ protected:
+  ProcessID                                m_pid{(ProcessID) ~0};
+  std::unordered_map<uintptr_t, uintptr_t> m_breakpoints;
+};
+}  // namespace DebuggerKit