/* ========================================

  Copyright (C) 2025 Amlal El Mahrouss, Licensed under the Apache 2.0 license.

======================================== */

#ifndef DK_NEKERNEL_CONTRACT_H
#define DK_NEKERNEL_CONTRACT_H

/// @brief NeKernel Debugging Protocol
/// @author Amlal El Mahrouss

#ifdef DK_NEKERNEL_DEBUGGER

#include <CompilerKit/Config.h>
#include <DebuggerKit/DebuggerContract.h>

namespace DebuggerKit::NeKernel {
class NeKernelContract;

namespace Detail {
  inline constexpr auto     kDebugCmdLen  = 256U;
  inline constexpr auto     kDebugPort    = 51820;
  inline constexpr auto     kDebugMagic   = "NE1.0.0;";
  inline constexpr uint16_t kDebugVersion = 0x0100;
  inline constexpr auto     kDebugDelim   = ';';
  inline constexpr auto     kDebugEnd     = '\r';
  typedef int64_t           dk_socket_type;
}  // namespace Detail

/// =========================================================== ///
/// \brief NeKernel Debugger Contract
/// \author Amlal El Mahrouss
/// =========================================================== ///
class NeKernelContract final DK_DEBUGGER_CONTRACT {
 public:
  NeKernelContract();
  virtual ~NeKernelContract() override;

 public:
  NeKernelContract& operator=(const NeKernelContract&) = default;
  NeKernelContract(const NeKernelContract&)            = default;

 public:
  bool Attach(CompilerKit::STLString path, CompilerKit::STLString arg_v,
              ProcessID& pid) noexcept override;
  bool BreakAt(CompilerKit::STLString symbol) noexcept override;
  bool Break() noexcept override;
  bool Continue() noexcept override;
  bool Detach() noexcept override;

 private:
  CompilerKit::STLString m_kernel_path{};
  Detail::dk_socket_type m_socket{0};
};
}  // namespace DebuggerKit::NeKernel

#endif  // ifdef DK_NEKERNEL_DEBUGGER

#endif  // DK_NEKERNEL_CONTRACT_H