Handle.hpp

Go to the documentation of this file.

#pragma once

 
#include <icarus/signal/Signal.hpp>
 
#include <icarus/core/CoreTypes.hpp>
 
#include <cassert>
#include <string>
 
namespace icarus {

template <typename T> class SignalHandle {
  public:
    SignalHandle(T *ptr, const SignalDescriptor *meta) : ptr_(ptr), meta_(meta) {}

    SignalHandle() : ptr_(nullptr), meta_(nullptr) {}
 
    // =========================================================================
    // Zero-overhead access (hot path)
    // =========================================================================

    T &operator*() {
        ICARUS_ASSERT_PTR(ptr_, "SignalHandle::operator*");
        return *ptr_;
    }
    const T &operator*() const {
        ICARUS_ASSERT_PTR(ptr_, "SignalHandle::operator* const");
        return *ptr_;
    }

    T *operator->() {
        ICARUS_ASSERT_PTR(ptr_, "SignalHandle::operator->");
        return ptr_;
    }
    const T *operator->() const {
        ICARUS_ASSERT_PTR(ptr_, "SignalHandle::operator-> const");
        return ptr_;
    }

    T *ptr() { return ptr_; }
    const T *ptr() const { return ptr_; }
 
    // =========================================================================
    // Introspection (cold path)
    // =========================================================================

    [[nodiscard]] const std::string &name() const {
        assert(meta_ != nullptr && "Cannot access name() on invalid handle");
        return meta_->name;
    }

    [[nodiscard]] const std::string &unit() const {
        assert(meta_ != nullptr && "Cannot access unit() on invalid handle");
        return meta_->unit;
    }

    [[nodiscard]] SignalLifecycle lifecycle() const {
        assert(meta_ != nullptr && "Cannot access lifecycle() on invalid handle");
        return meta_->lifecycle;
    }

    [[nodiscard]] const SignalDescriptor *descriptor() const {
        assert(meta_ != nullptr && "Cannot access descriptor() on invalid handle");
        return meta_;
    }
 
    // =========================================================================
    // Validity check
    // =========================================================================

    explicit operator bool() const { return ptr_ != nullptr; }

    [[nodiscard]] bool valid() const { return ptr_ != nullptr; }
 
  private:
    T *ptr_;                       
    const SignalDescriptor *meta_; 
};
 
} // namespace icarus