async_ui_internal_utils 0.0.2

use std::{mem::replace, task::Waker};

use crate::dummy_waker::dummy_waker;

/// An arena to contain many doubly-linked lists of wakers.
pub struct WakersArena {
    items: Vec<Item>,
}

#[derive(Debug, Clone)]
struct Item {
    waker: Waker,
    prev: usize,
    next: usize,
}

pub struct WakerSlot(usize);
impl WakerSlot {
    pub const INVALID: Self = Self(usize::MAX);
}

pub struct WakersSublist(pub(crate) usize);

impl WakersArena {
    /// Create a new arena with no list in it yet.
    pub fn new() -> Self {
        Self {
            items: vec![
                Item {
                    waker: dummy_waker(),
                    next: 1,
                    prev: 1,
                },
                Item {
                    waker: dummy_waker(),
                    prev: 0,
                    next: 0,
                },
            ],
        }
    }
    /// Create an empty doubly-linked list of wakers in the arena.
    ///
    /// The returned [WakersSublist] can be used to access this list later.
    pub fn add_sublist(&mut self) -> WakersSublist {
        let free_head = &mut self.items[0];
        // Is the free list empty?
        let (index, must_fix_free_list) = if free_head.next == 0 {
            (
                self.grow_full_list(), // not enough capacity, grow the list
                false,                 // in this case the node was never in the free list
            )
        } else {
            (
                free_head.next, // the first item in the free list
                true, // need to fix the free list afterward because we just took something from it
            )
        };
        let node = &mut self.items[index];
        let (old_free_prev, old_free_next) = (
            replace(&mut node.prev, index),
            replace(&mut node.next, index),
        );
        // fix the free list
        if must_fix_free_list {
            self.items[old_free_prev].next = old_free_next;
            self.items[old_free_next].prev = old_free_prev;
        }
        WakersSublist(index)
    }
    /// Allocate space in a list for a waker.
    ///
    /// The allocated slot will have a dummy no-op waker put in.
    /// Use [update][WakersArena::update] to set your actual waker.
    pub fn add(&mut self, &WakersSublist(sublist_head_index): &WakersSublist) -> WakerSlot {
        let free_head = &mut self.items[0];
        // Is the free list empty?
        let (index, must_fix_free_list) = if free_head.next == 0 {
            (
                self.grow_full_list(), // not enough capacity, grow the list
                false,                 // in this case the node was never in the free list
            )
        } else {
            (
                free_head.next, // the first item in the free list
                true, // need to fix the free list afterward because we just took something from it
            )
        };
        // add to used list
        let used_head = &mut self.items[sublist_head_index];
        let old_used_prev = replace(&mut used_head.prev, index);
        self.items[old_used_prev].next = index;
        let node = &mut self.items[index];
        let (old_free_prev, old_free_next) = (
            replace(&mut node.prev, old_used_prev),
            replace(&mut node.next, sublist_head_index),
        );
        // fix the free list
        if must_fix_free_list {
            self.items[old_free_prev].next = old_free_next;
            self.items[old_free_next].prev = old_free_prev;
        }
        WakerSlot(index)
    }
    /// Remove a previously added waker.
    pub fn remove(&mut self, handle: &WakerSlot) {
        let &WakerSlot(index) = handle;
        // add to free list
        let free_head = &mut self.items[0];
        let old_free_next = replace(&mut free_head.next, index);
        self.items[old_free_next].prev = index;
        let node = &mut self.items[index];
        let (old_used_prev, old_used_next) = (
            replace(&mut node.prev, 0),
            replace(&mut node.next, old_free_next),
        );
        node.waker = dummy_waker();
        // fix the used list
        self.items[old_used_prev].next = old_used_next;
        self.items[old_used_next].prev = old_used_prev;
    }
    /// If the sublist is empty (contains only the head node), remove it and return true.
    pub fn remove_sublist_if_empty(
        &mut self,
        &WakersSublist(sublist_head_index): &WakersSublist,
    ) -> bool {
        let head = &mut self.items[sublist_head_index];
        if head.next == sublist_head_index {
            head.prev = 0;
            let free_head = &mut self.items[0];
            let old_next = replace(&mut free_head.next, sublist_head_index);
            self.items[old_next].prev = sublist_head_index;
            self.items[sublist_head_index].next = old_next;
            true
        } else {
            false
        }
    }
    /// Set the waker in the slot.
    ///
    /// This method checks [Waker::will_wake] first.
    pub fn update(&mut self, &WakerSlot(slot): &WakerSlot, waker: &Waker) {
        let target = &mut self.items[slot].waker;
        if !target.will_wake(waker) {
            *target = waker.to_owned();
        }
    }
    /// Iterate over all the wakers in the given sublist.
    ///
    /// Useful for waking the wakers.
    pub fn iter<'s>(
        &'s self,
        &WakersSublist(sublist_head_index): &WakersSublist,
    ) -> impl Iterator<Item = &'s Waker> + 's {
        let mut index = self.items[sublist_head_index].next;
        std::iter::from_fn(move || {
            if index != sublist_head_index {
                let item = &self.items[index];
                index = item.next;
                Some(&item.waker)
            } else {
                None
            }
        })
    }
    /// Double the capacity of the list and return the index of a free, disconnected node.
    fn grow_full_list(&mut self) -> usize {
        let old_len = self.items.len();
        self.items.extend((old_len..(old_len * 2)).map(|idx| Item {
            waker: dummy_waker(),
            prev: idx - 1,
            next: idx + 1,
        }));
        self.items[old_len + 1].prev = 0;
        self.items[old_len * 2 - 1].next = 0;
        let free_head = &mut self.items[0];
        free_head.prev = old_len * 2 - 1;
        free_head.next = old_len + 1;
        old_len
    }
}

impl Default for WakersArena {
    fn default() -> Self {
        Self::new()
    }
}