wry/src/utils/linkedlist.rs

use {
    crate::utils::numcell::NumCell,
    std::{
        cell::Cell,
        fmt::{Debug, Formatter},
        mem,
        ops::Deref,
        ptr::NonNull,
    },
};

const LINKED_NODE_REF_COUNT: usize = !(!0 >> 1);

pub struct LinkedList<T> {
    root: LinkedNode<T>,
}

impl<T: Debug> Debug for LinkedList<T> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.debug_list().entries(self.iter()).finish()
    }
}

impl<T> Default for LinkedList<T> {
    fn default() -> Self {
        Self::new()
    }
}

impl<T> LinkedList<T> {
    pub fn new() -> Self {
        Self {
            root: LinkedNode::new(None),
        }
    }

    pub fn append_all(&self, other: &LinkedList<T>) {
        if other.is_empty() || self.root.data == other.root.data {
            return;
        }
        unsafe {
            let o_root = other.root.data;
            let o_first = o_root.as_ref().next.get();
            let o_last = o_root.as_ref().prev.get();
            let s_first = self.root.data;
            let s_last = s_first.as_ref().prev.get();
            o_first.as_ref().prev.set(s_last);
            s_last.as_ref().next.set(o_first);
            o_last.as_ref().next.set(s_first);
            s_first.as_ref().prev.set(o_last);
            o_root.as_ref().next.set(o_root);
            o_root.as_ref().prev.set(o_root);
        }
    }

    fn endpoint(&self, ep: NonNull<NodeData<T>>) -> Option<NodeRef<T>> {
        unsafe {
            if ep != self.root.data {
                ep.as_ref().rc.fetch_add(1);
                Some(NodeRef { data: ep })
            } else {
                None
            }
        }
    }

    pub fn is_empty(&self) -> bool {
        self.last().is_none()
    }

    pub fn is_not_empty(&self) -> bool {
        !self.is_empty()
    }

    pub fn last(&self) -> Option<NodeRef<T>> {
        unsafe { self.endpoint(self.root.data.as_ref().prev.get()) }
    }

    pub fn first(&self) -> Option<NodeRef<T>> {
        unsafe { self.endpoint(self.root.data.as_ref().next.get()) }
    }

    pub fn add_last(&self, t: T) -> LinkedNode<T> {
        self.root.prepend(t)
    }

    pub fn add_first(&self, t: T) -> LinkedNode<T> {
        self.root.append(t)
    }

    pub fn add_last_existing(&self, t: &NodeRef<T>) {
        self.root.prepend_existing(t)
    }

    #[expect(dead_code)]
    pub fn add_first_existing(&self, t: &NodeRef<T>) {
        self.root.append_existing(t)
    }

    pub fn rotate_last(&self, t: &NodeRef<T>) {
        unsafe {
            let root = self.root.data.as_ref();
            root.prev.get().as_ref().next.set(root.next.get());
            root.next.get().as_ref().prev.set(root.prev.get());
            root.prev.set(t.data);
            root.next.set(t.data.as_ref().next.get());
            t.data.as_ref().next.get().as_ref().prev.set(self.root.data);
            t.data.as_ref().next.set(self.root.data);
        }
    }

    pub fn iter(&self) -> LinkedListIter<T> {
        unsafe {
            let root = self.root.data.as_ref();
            root.rc.fetch_add(1);
            root.next.get().as_ref().rc.fetch_add(1);
            LinkedListIter {
                root: self.root.data,
                next: root.next.get(),
            }
        }
    }

    pub fn rev_iter(&self) -> RevLinkedListIter<T> {
        unsafe {
            let root = self.root.data.as_ref();
            root.rc.fetch_add(1);
            root.prev.get().as_ref().rc.fetch_add(1);
            RevLinkedListIter {
                root: self.root.data,
                next: root.prev.get(),
            }
        }
    }
}

pub struct LinkedListIter<T> {
    root: NonNull<NodeData<T>>,
    next: NonNull<NodeData<T>>,
}

impl<T> Iterator for LinkedListIter<T> {
    type Item = NodeRef<T>;

    fn next(&mut self) -> Option<Self::Item> {
        if self.root == self.next {
            return None;
        }
        unsafe {
            let old_next = self.next;
            self.next = old_next.as_ref().next.get();
            self.next.as_ref().rc.fetch_add(1);
            Some(NodeRef { data: old_next })
        }
    }
}

impl<T> Drop for LinkedListIter<T> {
    fn drop(&mut self) {
        unsafe {
            dec_ref_count(self.root, 1);
            dec_ref_count(self.next, 1);
        }
    }
}

pub struct RevLinkedListIter<T> {
    root: NonNull<NodeData<T>>,
    next: NonNull<NodeData<T>>,
}

impl<T> Iterator for RevLinkedListIter<T> {
    type Item = NodeRef<T>;

    fn next(&mut self) -> Option<Self::Item> {
        if self.root == self.next {
            return None;
        }
        unsafe {
            let old_next = self.next;
            self.next = old_next.as_ref().prev.get();
            self.next.as_ref().rc.fetch_add(1);
            Some(NodeRef { data: old_next })
        }
    }
}

impl<T> Drop for RevLinkedListIter<T> {
    fn drop(&mut self) {
        unsafe {
            dec_ref_count(self.root, 1);
            dec_ref_count(self.next, 1);
        }
    }
}

#[repr(transparent)]
#[must_use]
pub struct LinkedNode<T> {
    data: NonNull<NodeData<T>>,
}

impl<T: Debug> Debug for LinkedNode<T> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        unsafe { self.data.as_ref().data.as_ref().unwrap_unchecked().fmt(f) }
    }
}

impl<T> Deref for LinkedNode<T> {
    type Target = NodeRef<T>;

    fn deref(&self) -> &Self::Target {
        unsafe { mem::transmute(self) }
    }
}

#[repr(transparent)]
pub struct NodeRef<T> {
    data: NonNull<NodeData<T>>,
}

impl<T: Debug> Debug for NodeRef<T> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        unsafe { self.data.as_ref().data.as_ref().unwrap_unchecked().fmt(f) }
    }
}

impl<T> Deref for NodeRef<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        unsafe { self.data.as_ref().data.as_ref().unwrap_unchecked() }
    }
}

impl<T> Drop for NodeRef<T> {
    fn drop(&mut self) {
        unsafe {
            dec_ref_count(self.data, 1);
        }
    }
}

impl<T> Clone for NodeRef<T> {
    fn clone(&self) -> Self {
        unsafe {
            self.data.as_ref().rc.fetch_add(1);
            Self { data: self.data }
        }
    }
}

impl<T> NodeRef<T> {
    pub fn prepend(&self, t: T) -> LinkedNode<T> {
        unsafe { prepend(self.data, t) }
    }

    pub fn append(&self, t: T) -> LinkedNode<T> {
        unsafe { append(self.data, t) }
    }

    pub fn prepend_existing(&self, t: &NodeRef<T>) {
        unsafe { prepend_existing(self.data, t) }
    }

    pub fn append_existing(&self, t: &NodeRef<T>) {
        unsafe { append_existing(self.data, t) }
    }

    fn peer<F>(&self, peer: F) -> Option<NodeRef<T>>
    where
        F: FnOnce(&NodeData<T>) -> &Cell<NonNull<NodeData<T>>>,
    {
        unsafe {
            let data = self.data.as_ref();
            let other = peer(data).get();
            if other.as_ref().data.is_some() {
                other.as_ref().rc.fetch_add(1);
                Some(NodeRef { data: other })
            } else {
                None
            }
        }
    }

    pub fn prev(&self) -> Option<NodeRef<T>> {
        self.peer(|d| &d.prev)
    }

    pub fn next(&self) -> Option<NodeRef<T>> {
        self.peer(|d| &d.next)
    }

    pub fn detach(&self) {
        unsafe {
            let data = self.data.as_ref();
            data.prev.get().as_ref().next.set(data.next.get());
            data.next.get().as_ref().prev.set(data.prev.get());
            data.prev.set(self.data);
            data.next.set(self.data);
        }
    }
}

struct NodeData<T> {
    rc: NumCell<usize>,
    prev: Cell<NonNull<NodeData<T>>>,
    next: Cell<NonNull<NodeData<T>>>,
    data: Option<T>,
}

unsafe fn dec_ref_count<T>(slf: NonNull<NodeData<T>>, n: usize) {
    unsafe {
        if slf.as_ref().rc.fetch_sub(n) == n {
            drop(Box::from_raw(slf.as_ptr()));
        }
    }
}

impl<T> Drop for LinkedNode<T> {
    fn drop(&mut self) {
        unsafe {
            self.detach();
            dec_ref_count(self.data, LINKED_NODE_REF_COUNT);
        }
    }
}

impl<T> LinkedNode<T> {
    fn new(t: Option<T>) -> Self {
        let node = Box::leak(Box::new(NodeData {
            rc: NumCell::new(LINKED_NODE_REF_COUNT),
            prev: Cell::new(NonNull::dangling()),
            next: Cell::new(NonNull::dangling()),
            data: t,
        }));
        let ptr = NonNull::from(&mut *node);
        node.prev.set(ptr);
        node.next.set(ptr);
        LinkedNode { data: node.into() }
    }

    pub fn detached(t: T) -> Self {
        Self::new(Some(t))
    }

    pub fn to_ref(&self) -> NodeRef<T> {
        unsafe {
            self.data.as_ref().rc.fetch_add(1);
            NodeRef { data: self.data }
        }
    }
}

unsafe fn prepend_existing<T>(data: NonNull<NodeData<T>>, t: &NodeRef<T>) {
    unsafe {
        let dref = data.as_ref();
        let tref = t.data.as_ref();
        if tref.rc.get() < LINKED_NODE_REF_COUNT {
            log::error!("Trying to prepend a node whose linked node has already been dropped");
            return;
        }
        t.detach();
        tref.prev.set(dref.prev.get());
        tref.next.set(data);
        dref.prev.get().as_ref().next.set(t.data);
        dref.prev.set(t.data);
    }
}

unsafe fn prepend<T>(data: NonNull<NodeData<T>>, t: T) -> LinkedNode<T> {
    unsafe {
        let dref = data.as_ref();
        let node = NonNull::new_unchecked(Box::into_raw(Box::new(NodeData {
            rc: NumCell::new(LINKED_NODE_REF_COUNT),
            prev: Cell::new(dref.prev.get()),
            next: Cell::new(data),
            data: Some(t),
        })));
        dref.prev.get().as_ref().next.set(node);
        dref.prev.set(node);
        LinkedNode { data: node }
    }
}

unsafe fn append_existing<T>(data: NonNull<NodeData<T>>, t: &NodeRef<T>) {
    unsafe {
        let dref = data.as_ref();
        let tref = t.data.as_ref();
        if tref.rc.get() < LINKED_NODE_REF_COUNT {
            log::error!("Trying to append a node whose linked node has already been dropped");
            return;
        }
        t.detach();
        tref.prev.set(data);
        tref.next.set(dref.next.get());
        dref.next.get().as_ref().prev.set(t.data);
        dref.next.set(t.data);
    }
}

unsafe fn append<T>(data: NonNull<NodeData<T>>, t: T) -> LinkedNode<T> {
    unsafe {
        let dref = data.as_ref();
        let node = NonNull::new_unchecked(Box::into_raw(Box::new(NodeData {
            rc: NumCell::new(LINKED_NODE_REF_COUNT),
            prev: Cell::new(data),
            next: Cell::new(dref.next.get()),
            data: Some(t),
        })));
        dref.next.get().as_ref().prev.set(node);
        dref.next.set(node);
        LinkedNode { data: node }
    }
}