arch: move and improve asm_pointer

1 files changed, 56 insertions, 0 deletions

diff --git a/arch/include/arch/asm_pointer.hpp b/arch/include/arch/asm_pointer.hpp
new file mode 100644
index 0000000..c867d8f
--- /dev/null
+++ b/arch/include/arch/asm_pointer.hpp
@@ -0,0 +1,56 @@
+#ifndef TEACHOS_MEMORY_ASM_POINTER_HPP
+#define TEACHOS_MEMORY_ASM_POINTER_HPP
+
+#include <bit>
+
+namespace teachos::arch
+{
+
+  /**
+   * @brief A pointer that is defined in some assembly source file.
+   *
+   * @tparam Type The type of the pointer
+   * @since 0.0.1
+   */
+  template<typename Type>
+  struct asm_pointer
+  {
+    using value_type = Type;
+    using pointer = value_type *;
+    using const_pointer = value_type const *;
+    using reference = value_type &;
+    using const_reference = value_type const &;
+
+    asm_pointer() = delete;
+    asm_pointer(asm_pointer const &) = delete;
+    asm_pointer(asm_pointer &&) = delete;
+
+    auto constexpr operator=(asm_pointer const &) = delete;
+    auto constexpr operator=(asm_pointer &&) = delete;
+
+    auto get() const noexcept -> pointer { return m_ptr; }
+
+    auto constexpr operator+(std::ptrdiff_t offset) const noexcept -> pointer
+    {
+      return std::bit_cast<pointer>(m_ptr) + offset;
+    }
+
+    auto constexpr operator*() noexcept -> reference { return *(std::bit_cast<pointer>(m_ptr)); }
+
+    auto constexpr operator*() const noexcept -> const_reference { return *(std::bit_cast<const_pointer>(m_ptr)); }
+
+    auto constexpr operator[](std::ptrdiff_t offset) noexcept -> reference { return *(*this + offset); }
+
+    auto constexpr operator[](std::ptrdiff_t offset) const noexcept -> const_reference { return *(*this + offset); }
+
+    auto constexpr operator->() noexcept -> pointer { return m_ptr; }
+
+    auto constexpr operator->() const noexcept -> const_pointer { return m_ptr; }
+
+  private:
+    pointer m_ptr;
+  };
+
+}  // namespace teachos::arch
+
+#endif  // TEACHOS_MEMORY_ASM_POINTER_HPP