serenity/AK/MaybeOwned.h

/*
 * Copyright (c) 2022, Tim Schumacher <timschumi@gmx.de>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/NonnullOwnPtr.h>
#include <AK/Variant.h>

namespace AK {

template<typename T>
class MaybeOwned {
    AK_MAKE_NONCOPYABLE(MaybeOwned);

public:
    template<DerivedFrom<T> U>
    MaybeOwned(NonnullOwnPtr<U> handle)
        : m_handle(static_cast<NonnullOwnPtr<T>&&>(move(handle)))
    {
    }

    // This is made `explicit` to not accidentally create a non-owning MaybeOwned,
    // which may not always be intended.
    explicit MaybeOwned(T& handle)
        : m_handle(&handle)
    {
    }

    MaybeOwned(MaybeOwned&&) = default;
    MaybeOwned& operator=(MaybeOwned&&) = default;

    template<DerivedFrom<T> U>
    MaybeOwned(MaybeOwned<U>&& other)
        : m_handle(downcast<U, T>(move(other.m_handle)))
    {
    }

    T* ptr()
    {
        if (m_handle.template has<T*>())
            return m_handle.template get<T*>();
        else
            return m_handle.template get<NonnullOwnPtr<T>>();
    }

    T const* ptr() const
    {
        if (m_handle.template has<T*>())
            return m_handle.template get<T*>();
        else
            return m_handle.template get<NonnullOwnPtr<T>>();
    }

    T* operator->() { return ptr(); }
    T const* operator->() const { return ptr(); }

    T& operator*() { return *ptr(); }
    T const& operator*() const { return *ptr(); }

    bool is_owned() const { return m_handle.template has<NonnullOwnPtr<T>>(); }

private:
    template<typename F>
    friend class MaybeOwned;

    template<typename HT>
    using Handle = Variant<NonnullOwnPtr<HT>, HT*>;

    template<typename U, typename D>
    Handle<D> downcast(Handle<U>&& variant)
    {
        if (variant.template has<U*>())
            return variant.template get<U*>();
        else
            return static_cast<NonnullOwnPtr<T>&&>(move(variant.template get<NonnullOwnPtr<U>>()));
    }

    Handle<T> m_handle;
};

}

#if USING_AK_GLOBALLY
using AK::MaybeOwned;
#endif