hxptr.hpp

Go to the documentation of this file.

#pragma once
// SPDX-FileCopyrightText: © 2017-2026 Adrian Johnston.
// SPDX-License-Identifier: MIT
// This file is licensed under the MIT license found in the LICENSE.md file.

 
#include "libhatchet.h"
 
// HX_USE_MACROS_WITH_MODULE allows including macros alongside the module.
#if HX_USE_MACROS_WITH_MODULE
#error Header does not provide macros alone.
#endif
 
#include "hxutility.h"
 
HX_NS_BEGIN_

template<typename T_, typename deleter_t_=hxdefault_delete>
class hxptr : private deleter_t_ {
public:
    // No arrays allowed because there is no delete[] equivalent. Use hxref for
    // pointer and reference types..
    static_assert(!hxis_array<T_>::value, "hxptr does not support array types");
    static_assert(!hxis_reference<T_>::value, "hxptr does not support reference types");
    static_assert(!hxis_pointer<T_>::value, "hxptr does not support pointer types");

    using element_t = T_;

    hxconstexpr explicit hxptr(T_* ptr_=hxnull, deleter_t_ deleter_=deleter_t_()) noexcept;

    hxconstexpr hxptr(hxptr&& other_) noexcept;

    hxconstexpr ~hxptr(void) noexcept;

    hxconstexpr hxptr& operator=(hxptr&& other_) noexcept;

    hxattr_nodiscard hxconstexpr T_& operator*(void) const;

    hxattr_nodiscard hxconstexpr T_* operator->(void) const;

    hxattr_nodiscard hxconstexpr operator bool(void) const;

    hxattr_nodiscard hxconstexpr bool operator==(const hxptr& other_) const;

    hxattr_nodiscard hxconstexpr bool operator==(hxnullptr_t) const;
 
#if HX_CPLUSPLUS < 202002L // C++20 defaults != from ==.
    hxattr_nodiscard hxconstexpr bool operator!=(const hxptr& other_) const;

    hxattr_nodiscard hxconstexpr bool operator!=(hxnullptr_t) const;
#endif

    template<typename function_t_>
    hxattr_nodiscard hxconstexpr auto and_then(function_t_&& callable_) const
        -> hxremove_cvref_t<decltype(hxforward<function_t_>(callable_)(hxdeclval<T_&>()))>;

    hxattr_nodiscard hxconstexpr const deleter_t_& deleter(void) const;

    hxattr_nodiscard hxconstexpr deleter_t_& deleter(void);

    hxattr_nodiscard hxconstexpr T_* get(void) const { return m_ptr_; }

    template<typename function_t_>
    hxattr_nodiscard hxconstexpr hxptr or_else(function_t_&& callable_) &&;
 
    // An lvalue `hxptr` cannot yield ownership without leaving a dangling copy.
    template<typename function_t_>
    hxptr or_else(function_t_&& callable_) const& = delete;

    hxattr_nodiscard hxconstexpr T_* release(void);

    hxconstexpr void reset(T_* ptr_=hxnull) noexcept;

    hxconstexpr void swap(hxptr& other_) noexcept;

    template<typename U_=hxremove_cv_t<T_>>
    hxattr_nodiscard hxconstexpr hxremove_cv_t<T_> value_or(U_&& default_value_) const;
 
private:
    hxptr(const hxptr&) = delete;
    hxptr& operator=(const hxptr&) = delete;
 
    T_* m_ptr_;
};

template<typename T_, hxsystem_allocator_t allocator_=hxsystem_allocator_current,
    hxalignment_t align_=hxalignment, typename... args_t_>
hxattr_nodiscard hxptr<T_> hxmake_ptr(args_t_&&... args_) noexcept {
    return hxptr<T_>(hxnew<T_, allocator_, align_>(hxforward<args_t_>(args_)...));
}
 
#include "detail/hxptr.inl"
HX_NS_END_