dumo 0.1.0

#![cfg(feature = "alloc")]

mod cache;
mod state;
#[cfg(test)]
mod tests;
mod wrap;

use core::fmt::Debug;
use core::marker::PhantomData;

use self::cache::CacheKey;
use self::state::State;
use embedded_graphics::draw_target::DrawTarget;
use ratatui_core::backend::{Backend, ClearType, WindowSize};
use ratatui_core::buffer::Cell;
use ratatui_core::layout::{Position, Size};
use ratatui_core::style::Modifier;

use crate::backend::DrawTargetBackend;
use crate::blink::{Blink, Blinked, ControlBlinking, ControlCursorBlinking};
use crate::cursor::{Colors, Cursor, Extent, Symbol};
use crate::error::{AdvanceCursorBlinkingError, Error};

use super::traits;
use super::{WrapTrait, Wrapper};

/// Wrapper that is required in order for a cursor to reveal itself whenever [`show_cursor`] or
/// [`set_cursor_position`] is called, keeping track of its position and driving its animation,
/// redrawing cells not only as the cursor is blinking, but also when the cursor leaves a cell.
///
/// For this purpose, the [`CursorWrapper`] layer maintains a cache with the last known content
/// of every cell position, removing entries on [`Backend::clear`] or [`Backend::clear_region`]
/// calls.
///
/// [`show_cursor`]: ratatui_core::terminal::Terminal::show_cursor
/// [`set_cursor_position`]: ratatui_core::terminal::Frame::set_cursor_position
#[derive(Debug, Clone)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct CursorWrapper<'a, B, D>
where
    B: DrawTargetBackend<D, Error = Error<D::Error>>,
    D: DrawTarget,
    D::Error: Debug,
{
    backend: B,
    cursor: Cursor<'a>,
    state: State,
    phantom: PhantomData<D>,
}

/// Backend configuration retrieval and modification of the [`CursorWrapper`] layer.
///
/// A backend wrapper that implements this trait allows the fields of a [`CursorWrapper`] that are
/// configurable to have their values read or have new values assigned.
pub trait ConfigureCursorWrapper<'a> {
    /// Returns the blink animation cycle for the cursor.
    ///
    /// # Examples
    ///
    /// ```
    /// # #[cfg(not(all(feature = "alloc", feature = "font-8x24", feature = "font-4-bits")))]
    /// # {
    /// #     compile_error!("doc-test is missing required features");
    /// # }
    /// #
    /// use dumo::blink::Blink;
    /// use dumo::cursor::{Colors, Cursor, Extent};
    /// use dumo::fonts::*;
    /// use dumo::{ConfigureCursorWrapper, DumoBackend};
    /// # use embedded_graphics::mock_display::MockDisplay;
    /// # use embedded_graphics::pixelcolor::Rgb565;
    ///
    /// # let mut display: MockDisplay<Rgb565> = MockDisplay::new();
    /// let backend = DumoBackend::new(&mut display, &FONT_8X24_4_BITS).with_cursor(
    ///     Cursor::default()
    ///         .blink(Blink::with_period(10))
    ///         .colors(Colors::InvertedReset)
    ///         .extent(Extent::Underline { height: 2 }),
    /// );
    ///
    /// let cursor_blink = backend.get_cursor_blink();
    /// ```
    fn get_cursor_blink(&self) -> Blink;

    /// Sets the blink animation cycle for the cursor.
    ///
    /// # Examples
    ///
    /// ```
    /// # #[cfg(not(all(feature = "alloc", feature = "font-8x24", feature = "font-4-bits")))]
    /// # {
    /// #     compile_error!("doc-test is missing required features");
    /// # }
    /// #
    /// use dumo::blink::Blink;
    /// use dumo::cursor::{Colors, Cursor, Extent};
    /// use dumo::fonts::*;
    /// use dumo::{ConfigureCursorWrapper, DumoBackend};
    /// # use embedded_graphics::mock_display::MockDisplay;
    /// # use embedded_graphics::pixelcolor::Rgb565;
    ///
    /// # let mut display: MockDisplay<Rgb565> = MockDisplay::new();
    /// let mut backend = DumoBackend::new(&mut display, &FONT_8X24_4_BITS).with_cursor(
    ///     Cursor::default()
    ///         .blink(Blink::with_period(10))
    ///         .colors(Colors::InvertedReset)
    ///         .extent(Extent::Underline { height: 2 }),
    /// );
    ///
    /// backend.set_cursor_blink(Blink::with_period(12));
    /// ```
    fn set_cursor_blink(&mut self, blink: Blink);

    /// Returns the method used by the cursor for choosing colors.
    ///
    /// # Examples
    ///
    /// ```
    /// # #[cfg(not(all(feature = "alloc", feature = "font-8x24", feature = "font-4-bits")))]
    /// # {
    /// #     compile_error!("doc-test is missing required features");
    /// # }
    /// #
    /// use dumo::blink::Blink;
    /// use dumo::cursor::{Colors, Cursor, Extent};
    /// use dumo::fonts::*;
    /// use dumo::{ConfigureCursorWrapper, DumoBackend};
    /// # use embedded_graphics::mock_display::MockDisplay;
    /// # use embedded_graphics::pixelcolor::Rgb565;
    ///
    /// # let mut display: MockDisplay<Rgb565> = MockDisplay::new();
    /// let backend = DumoBackend::new(&mut display, &FONT_8X24_4_BITS).with_cursor(
    ///     Cursor::default()
    ///         .blink(Blink::with_period(10))
    ///         .colors(Colors::InvertedReset)
    ///         .extent(Extent::Underline { height: 2 }),
    /// );
    ///
    /// let cursor_colors = backend.get_cursor_colors();
    /// ```
    fn get_cursor_colors(&self) -> Colors;

    /// Sets the method used by the cursor for choosing colors.
    ///
    /// # Examples
    ///
    /// ```
    /// # #[cfg(not(all(feature = "alloc", feature = "font-8x24", feature = "font-4-bits")))]
    /// # {
    /// #     compile_error!("doc-test is missing required features");
    /// # }
    /// #
    /// use dumo::blink::Blink;
    /// use dumo::cursor::{Colors, Cursor, Extent};
    /// use dumo::fonts::*;
    /// use dumo::{ConfigureCursorWrapper, DumoBackend};
    /// # use embedded_graphics::mock_display::MockDisplay;
    /// # use embedded_graphics::pixelcolor::Rgb565;
    ///
    /// # let mut display: MockDisplay<Rgb565> = MockDisplay::new();
    /// let mut backend = DumoBackend::new(&mut display, &FONT_8X24_4_BITS).with_cursor(
    ///     Cursor::default()
    ///         .blink(Blink::with_period(10))
    ///         .colors(Colors::InvertedReset)
    ///         .extent(Extent::Underline { height: 2 }),
    /// );
    ///
    /// backend.set_cursor_colors(Colors::ReversedReset);
    /// ```
    fn set_cursor_colors(&mut self, colors: Colors);

    /// Returns the shape that represents the cursor inside of the cell area.
    ///
    /// # Examples
    ///
    /// ```
    /// # #[cfg(not(all(feature = "alloc", feature = "font-8x24", feature = "font-4-bits")))]
    /// # {
    /// #     compile_error!("doc-test is missing required features");
    /// # }
    /// #
    /// use dumo::blink::Blink;
    /// use dumo::cursor::{Colors, Cursor, Extent};
    /// use dumo::fonts::*;
    /// use dumo::{ConfigureCursorWrapper, DumoBackend};
    /// # use embedded_graphics::mock_display::MockDisplay;
    /// # use embedded_graphics::pixelcolor::Rgb565;
    ///
    /// # let mut display: MockDisplay<Rgb565> = MockDisplay::new();
    /// let backend = DumoBackend::new(&mut display, &FONT_8X24_4_BITS).with_cursor(
    ///     Cursor::default()
    ///         .blink(Blink::with_period(10))
    ///         .colors(Colors::InvertedReset)
    ///         .extent(Extent::Underline { height: 2 }),
    /// );
    ///
    /// let cursor_extent = backend.get_cursor_extent();
    /// ```
    fn get_cursor_extent(&self) -> Extent;

    /// Sets the shape that represents the cursor inside of the cell area.
    ///
    /// # Examples
    ///
    /// ```
    /// # #[cfg(not(all(feature = "alloc", feature = "font-8x24", feature = "font-4-bits")))]
    /// # {
    /// #     compile_error!("doc-test is missing required features");
    /// # }
    /// #
    /// use dumo::blink::Blink;
    /// use dumo::cursor::{Colors, Cursor, Extent};
    /// use dumo::fonts::*;
    /// use dumo::{ConfigureCursorWrapper, DumoBackend};
    /// # use embedded_graphics::mock_display::MockDisplay;
    /// # use embedded_graphics::pixelcolor::Rgb565;
    ///
    /// # let mut display: MockDisplay<Rgb565> = MockDisplay::new();
    /// let mut backend = DumoBackend::new(&mut display, &FONT_8X24_4_BITS).with_cursor(
    ///     Cursor::default()
    ///         .blink(Blink::with_period(10))
    ///         .colors(Colors::InvertedReset)
    ///         .extent(Extent::Underline { height: 2 }),
    /// );
    ///
    /// backend.set_cursor_extent(Extent::VerticalBar { width: 2 });
    /// ```
    fn set_cursor_extent(&mut self, extent: Extent);

    /// Returns the source of the content that the cursor uses to symbolize itself.
    ///
    /// # Examples
    ///
    /// ```
    /// # #[cfg(not(all(feature = "alloc", feature = "font-8x24", feature = "font-4-bits")))]
    /// # {
    /// #     compile_error!("doc-test is missing required features");
    /// # }
    /// #
    /// use dumo::blink::Blink;
    /// use dumo::cursor::{Colors, Cursor, Symbol};
    /// use dumo::fonts::*;
    /// use dumo::{ConfigureCursorWrapper, DumoBackend};
    /// # use embedded_graphics::mock_display::MockDisplay;
    /// # use embedded_graphics::pixelcolor::Rgb565;
    ///
    /// # let mut display: MockDisplay<Rgb565> = MockDisplay::new();
    /// let backend = DumoBackend::new(&mut display, &FONT_8X24_4_BITS).with_cursor(
    ///     Cursor::default()
    ///         .blink(Blink::with_period(10))
    ///         .colors(Colors::InvertedReset)
    ///         .symbol(Symbol::Custom("🮕🮕")),
    /// );
    ///
    /// let cursor_symbol = backend.get_cursor_symbol();
    /// ```
    fn get_cursor_symbol(&self) -> Symbol<'a>;

    /// Sets the source of the content that the cursor uses to symbolize itself.
    ///
    /// # Examples
    ///
    /// ```
    /// # #[cfg(not(all(feature = "alloc", feature = "font-8x24", feature = "font-4-bits")))]
    /// # {
    /// #     compile_error!("doc-test is missing required features");
    /// # }
    /// #
    /// use dumo::blink::Blink;
    /// use dumo::cursor::{Colors, Cursor, Symbol};
    /// use dumo::fonts::*;
    /// use dumo::{ConfigureCursorWrapper, DumoBackend};
    /// # use embedded_graphics::mock_display::MockDisplay;
    /// # use embedded_graphics::pixelcolor::Rgb565;
    ///
    /// # let mut display: MockDisplay<Rgb565> = MockDisplay::new();
    /// let mut backend = DumoBackend::new(&mut display, &FONT_8X24_4_BITS).with_cursor(
    ///     Cursor::default()
    ///         .blink(Blink::with_period(10))
    ///         .colors(Colors::InvertedReset)
    ///         .symbol(Symbol::Custom("🮕🮕")),
    /// );
    ///
    /// backend.set_cursor_symbol(Symbol::UnderCursor);
    /// ```
    fn set_cursor_symbol(&mut self, symbol: Symbol<'a>);
}

impl<'a, B, D> CursorWrapper<'a, B, D>
where
    B: DrawTargetBackend<D, Error = Error<D::Error>>,
    D: DrawTarget,
    D::Error: Debug,
{
    /// Creates a new wrapper around the specified backend, configuring the appearance of a cursor,
    /// indicating the last position that [`Backend::set_cursor_position`] receives as a parameter,
    /// first being positioned at the [`ORIGIN`](ratatui_core::layout::Position::ORIGIN).
    ///
    /// # Examples
    ///
    /// ```
    /// # #[cfg(not(all(feature = "alloc", feature = "font-8x24", feature = "font-4-bits")))]
    /// # {
    /// #     compile_error!("doc-test is missing required features");
    /// # }
    /// #
    /// use dumo::blink::Blink;
    /// use dumo::cursor::{Colors, Cursor, Extent};
    /// use dumo::fonts::*;
    /// use dumo::{CursorWrapper, DumoBackend};
    /// # use embedded_graphics::mock_display::MockDisplay;
    /// # use embedded_graphics::pixelcolor::Rgb565;
    ///
    /// # let mut display: MockDisplay<Rgb565> = MockDisplay::new();
    /// let wrapper = CursorWrapper::new(
    ///     DumoBackend::new(&mut display, &FONT_8X24_4_BITS),
    ///     Cursor::default()
    ///         .blink(Blink::with_period(10))
    ///         .colors(Colors::InvertedReset)
    ///         .extent(Extent::Underline { height: 2 }),
    /// );
    /// ```
    pub const fn new(backend: B, cursor: Cursor<'a>) -> Self {
        Self {
            backend,
            cursor,
            state: State::new(),
            phantom: PhantomData,
        }
    }

    fn draw_internal<'z, I, const HIDDEN: bool>(&mut self, content: I) -> Result<(), B::Error>
    where
        I: Iterator<Item = (u16, u16, &'z Cell)>,
    {
        use unicode_width::UnicodeWidthStr;

        let cursor_blink = self.cursor.blink.get(self.state.ticks);
        let previous_cursor_blink = self.cursor.blink.get(self.state.ticks.wrapping_sub(1));
        let cursor_position = self.get_cursor_position()?;
        let mut cursor_content = None;

        let content = content.inspect(|&(x, y, cell)| {
            let key = CacheKey::new(x, y);
            let end = cell.symbol().width();
            let mut cell = cell.clone();

            if HIDDEN {
                cell.modifier = cell.modifier.union(Modifier::HIDDEN)
            }

            if y == cursor_position.y {
                for right in (0..end)
                    .filter_map(|x_offset| x_offset.try_into().ok())
                    .filter_map(|x_offset| x.checked_add(x_offset))
                {
                    if right == cursor_position.x {
                        cursor_content.replace((x, y, cell.clone()));
                    }
                }
            }

            self.state.cache.insert_or_replace(key, cell);
        });

        if HIDDEN {
            self.backend.draw_hidden(content)?;
        } else {
            self.backend.draw(content)?;
        }

        let cursor_is_visible = !self.state.cursor_hidden;
        let cursor_is_dirty = self.backend.take_dirty_cursor()?.is_some();
        let cursor_hidden_toggled = self.state.cursor_hidden_toggled.take().is_some();
        let cursor_blink_changed = cursor_blink != previous_cursor_blink;
        let cursor_position_changed = self.state.cursor_position_changed.is_some();

        if let Some(position) = self.state.cursor_position_changed.take()
            && (cursor_is_visible || cursor_hidden_toggled)
            && (cursor_blink_changed || previous_cursor_blink == Blinked(true))
        {
            let default_content = Some((position.x, position.y, &Cell::EMPTY));
            let cursor_content = self.state.cache.find(position).or(default_content);
            self.backend.draw(cursor_content.into_iter())?;
        }

        if cursor_is_visible {
            let default_content = Some((cursor_position.x, cursor_position.y, &Cell::EMPTY));
            let cursor_content = match cursor_content.as_ref() {
                Some(&(x, y, ref cell)) => Some((x, y, cell)),
                None if cursor_is_dirty
                    || cursor_blink_changed
                    || cursor_position_changed
                    || self.state.cursor_changed =>
                {
                    self.state.cache.find(cursor_position).or(default_content)
                }
                None => None,
            };

            if cursor_blink == Blinked(true) {
                self.backend.draw_cursor(
                    cursor_content.into_iter(),
                    self.cursor.colors,
                    self.cursor.extent,
                    self.cursor.symbol,
                )?;
            } else if cursor_blink_changed {
                self.backend.draw(cursor_content.into_iter())?;
            }
        }

        self.state.cursor_changed = false;

        if self.state.blinking {
            self.advance_blink_by(1)?;
        }

        Ok(())
    }
}

impl<B, D> Backend for CursorWrapper<'_, B, D>
where
    B: DrawTargetBackend<D, Error = Error<D::Error>>,
    D: DrawTarget,
    D::Error: Debug,
{
    type Error = B::Error;

    fn draw<'z, I>(&mut self, content: I) -> Result<(), Self::Error>
    where
        I: Iterator<Item = (u16, u16, &'z Cell)>,
    {
        self.draw_internal::<I, false>(content)
    }

    fn hide_cursor(&mut self) -> Result<(), Self::Error> {
        let cursor_hidden = self.state.cursor_hidden;

        self.state.cursor_hidden = true;

        let is_update = !cursor_hidden;
        if is_update {
            let is_revert = self.state.cursor_hidden_toggled.is_some();
            if is_revert {
                self.state.cursor_hidden_toggled.take();
            } else {
                self.state.cursor_hidden_toggled.replace(());
            }
        }

        Ok(())
    }

    fn show_cursor(&mut self) -> Result<(), Self::Error> {
        let cursor_hidden = self.state.cursor_hidden;

        self.state.cursor_hidden = false;

        let is_update = cursor_hidden;
        if is_update {
            let is_revert = self.state.cursor_hidden_toggled.is_some();
            if is_revert {
                self.state.cursor_hidden_toggled.take();
            } else {
                self.state.cursor_hidden_toggled.replace(());
            }
        }

        Ok(())
    }

    fn get_cursor_position(&mut self) -> Result<Position, Self::Error> {
        self.backend.get_cursor_position()
    }

    fn set_cursor_position<P: Into<Position>>(&mut self, position: P) -> Result<(), Self::Error> {
        let position = position.into();
        let cursor_position = self.get_cursor_position()?;

        self.backend.set_cursor_position(position)?;

        let is_update = position != cursor_position;
        if is_update {
            if let Some(cursor_position) = self.state.cursor_position_changed {
                let is_revert = position == cursor_position;
                if is_revert {
                    self.state.cursor_position_changed.take();
                }
            } else {
                self.state.cursor_position_changed.replace(cursor_position);
            }
        }

        Ok(())
    }

    fn clear(&mut self) -> Result<(), Self::Error> {
        let cursor_blink = self.cursor.blink.get(self.state.ticks);
        let cursor_position = self.get_cursor_position()?;
        let cursor_is_visible = !self.state.cursor_hidden;

        self.backend.clear()?;
        self.state.cache.clear();

        if cursor_is_visible && cursor_blink == Blinked(true) {
            let default_content = Some((cursor_position.x, cursor_position.y, &Cell::EMPTY));
            let cursor_content = self.state.cache.find(cursor_position).or(default_content);
            self.backend.draw_cursor(
                cursor_content.into_iter(),
                self.cursor.colors,
                self.cursor.extent,
                self.cursor.symbol,
            )?;
        }

        Ok(())
    }

    fn clear_region(&mut self, clear_type: ClearType) -> Result<(), Self::Error> {
        let cursor_blink = self.cursor.blink.get(self.state.ticks);
        let cursor_position = self.get_cursor_position()?;
        let cursor_is_visible = !self.state.cursor_hidden;

        let [x, y] = {
            let Position { x, y } = cursor_position;
            if let Some((x, y, _)) = self.state.cache.find(cursor_position) {
                [x, y]
            } else {
                [x, y]
            }
        };

        let cursor_is_below_or_right = |key: CacheKey| y > key.y || y == key.y && x > key.x;
        let cursor_is_above_or_left = |key: CacheKey| y < key.y || y == key.y && x < key.x;
        let cursor_is_above_or_below = |key: CacheKey| y != key.y;
        let cursor_is_above_or_below_or_right = |key: CacheKey| y != key.y || x > key.x;

        self.backend.clear_region(clear_type)?;

        match clear_type {
            ClearType::All => self.state.cache.clear(),
            ClearType::AfterCursor => self.state.cache.retain(cursor_is_below_or_right),
            ClearType::BeforeCursor => self.state.cache.retain(cursor_is_above_or_left),
            ClearType::CurrentLine => self.state.cache.retain(cursor_is_above_or_below),
            ClearType::UntilNewLine => self.state.cache.retain(cursor_is_above_or_below_or_right),
        };

        if cursor_is_visible && cursor_blink == Blinked(true) {
            let default_content = Some((cursor_position.x, cursor_position.y, &Cell::EMPTY));
            let cursor_content = self.state.cache.find(cursor_position).or(default_content);
            self.backend.draw_cursor(
                cursor_content.into_iter(),
                self.cursor.colors,
                self.cursor.extent,
                self.cursor.symbol,
            )?;
        }

        Ok(())
    }

    fn size(&self) -> Result<Size, Self::Error> {
        self.backend.size()
    }

    fn window_size(&mut self) -> Result<WindowSize, Self::Error> {
        self.backend.window_size()
    }

    fn flush(&mut self) -> Result<(), Self::Error> {
        self.backend.flush()
    }
}

impl<B, D> DrawTargetBackend<D> for CursorWrapper<'_, B, D>
where
    B: DrawTargetBackend<D, Error = Error<D::Error>>,
    D: DrawTarget,
    D::Error: Debug,
{
    fn call(&mut self, f: impl FnMut(&mut D) -> Result<(), D::Error>) -> Result<(), D::Error> {
        self.backend.call(f)
    }

    fn draw_hidden<'z, I>(&mut self, content: I) -> Result<(), Self::Error>
    where
        I: Iterator<Item = (u16, u16, &'z Cell)>,
    {
        self.draw_internal::<I, true>(content)
    }

    fn draw_cursor<'z, I>(
        &mut self,
        content: I,
        colors: Colors,
        extent: Extent,
        symbol: Symbol,
    ) -> Result<(), Self::Error>
    where
        I: Iterator<Item = (u16, u16, &'z Cell)>,
    {
        self.backend.draw_cursor(content, colors, extent, symbol)
    }

    fn advance_blink_by(&mut self, ticks: usize) -> Result<(), Self::Error> {
        self.state.ticks = self.state.ticks.wrapping_add(ticks);

        self.backend.advance_blink_by(ticks)
    }

    fn take_dirty_cursor(&mut self) -> Result<Option<()>, Self::Error> {
        self.backend.take_dirty_cursor()
    }
}

impl<'a, B, D> ConfigureCursorWrapper<'a> for CursorWrapper<'a, B, D>
where
    B: DrawTargetBackend<D, Error = Error<D::Error>>,
    D: DrawTarget,
    D::Error: Debug,
{
    fn get_cursor_blink(&self) -> Blink {
        self.cursor.blink
    }

    fn set_cursor_blink(&mut self, blink: Blink) {
        self.cursor.blink = blink;
    }

    fn get_cursor_colors(&self) -> Colors {
        self.cursor.colors
    }

    fn set_cursor_colors(&mut self, colors: Colors) {
        self.state.cursor_changed |= colors != self.cursor.colors;
        self.cursor.colors = colors;
    }

    fn get_cursor_extent(&self) -> Extent {
        self.cursor.extent
    }

    fn set_cursor_extent(&mut self, extent: Extent) {
        self.state.cursor_changed |= extent != self.cursor.extent;
        self.cursor.extent = extent;
    }

    fn get_cursor_symbol(&self) -> Symbol<'a> {
        self.cursor.symbol
    }

    fn set_cursor_symbol(&mut self, symbol: Symbol<'a>) {
        self.state.cursor_changed |= symbol != self.cursor.symbol;
        self.cursor.symbol = symbol;
    }
}

impl<B, D> ControlBlinking<D> for CursorWrapper<'_, B, D>
where
    B: DrawTargetBackend<D, Error = Error<D::Error>>,
    D: DrawTarget,
    D::Error: Debug,
{
    fn blinking(&self) -> bool {
        self.state.blinking
    }

    fn start_blinking(&mut self) {
        self.state.blinking = true;
    }

    fn stop_blinking(&mut self) {
        self.state.blinking = false;
    }
}

impl<B, D> ControlCursorBlinking for CursorWrapper<'_, B, D>
where
    B: DrawTargetBackend<D, Error = Error<D::Error>>,
    D: DrawTarget,
    D::Error: Debug,
{
    fn advance_cursor_blink_to(&mut self, blinked: Blinked) -> Result<(), B::Error> {
        use AdvanceCursorBlinkingError::*;

        self.state.ticks = match self.cursor.blink {
            Blink::Repeat(delay, blink) => match blinked {
                Blinked(false) => {
                    if delay == 0 {
                        Err(Error::AdvanceCursorBlinking(InvalidBlinked))
                    } else if let Some(period) = delay.checked_add(blink) {
                        let cycles = self.state.ticks.div_ceil(period);
                        let ticks = cycles.wrapping_mul(period);

                        Ok(ticks)
                    } else {
                        Ok(0)
                    }
                }
                Blinked(true) => {
                    if blink == 0 {
                        if delay == 0 {
                            Ok(self.state.ticks)
                        } else {
                            Err(Error::AdvanceCursorBlinking(InvalidBlinked))
                        }
                    } else if let Some(period) = delay.checked_add(blink) {
                        let cycles = self.state.ticks.saturating_sub(delay).div_ceil(period);
                        let ticks = cycles.wrapping_mul(period).saturating_add(delay);

                        Ok(ticks)
                    } else {
                        Ok(delay)
                    }
                }
            },
        }?;

        Ok(())
    }
}

impl<B, D> Wrapper for CursorWrapper<'_, B, D>
where
    B: DrawTargetBackend<D, Error = Error<D::Error>>,
    D: DrawTarget,
    D::Error: Debug,
{
    type Inner = B;

    fn inner(&self) -> &Self::Inner {
        &self.backend
    }

    fn inner_mut(&mut self) -> &mut Self::Inner {
        &mut self.backend
    }

    fn into_inner(self) -> Self::Inner {
        self.backend
    }
}

impl<B, D> WrapTrait<traits::ConfigureBackend> for CursorWrapper<'_, B, D>
where
    B: DrawTargetBackend<D, Error = Error<D::Error>>,
    D: DrawTarget,
    D::Error: Debug,
{
}

impl<B, D> WrapTrait<traits::ConfigureBlinkWrapper> for CursorWrapper<'_, B, D>
where
    B: DrawTargetBackend<D, Error = Error<D::Error>>,
    D: DrawTarget,
    D::Error: Debug,
{
}

/// Blanket implementation of the [`ConfigureCursorWrapper`] trait for function call passthrough.
impl<'a, W, B> ConfigureCursorWrapper<'a> for W
where
    B: ConfigureCursorWrapper<'a>,
    W: WrapTrait<traits::ConfigureCursorWrapper, Inner = B>,
{
    fn get_cursor_blink(&self) -> Blink {
        self.inner().get_cursor_blink()
    }

    fn set_cursor_blink(&mut self, blink: Blink) {
        self.inner_mut().set_cursor_blink(blink);
    }

    fn get_cursor_colors(&self) -> Colors {
        self.inner().get_cursor_colors()
    }

    fn set_cursor_colors(&mut self, colors: Colors) {
        self.inner_mut().set_cursor_colors(colors);
    }

    fn get_cursor_extent(&self) -> Extent {
        self.inner().get_cursor_extent()
    }

    fn set_cursor_extent(&mut self, extent: Extent) {
        self.inner_mut().set_cursor_extent(extent);
    }

    fn get_cursor_symbol(&self) -> Symbol<'a> {
        self.inner().get_cursor_symbol()
    }

    fn set_cursor_symbol(&mut self, symbol: Symbol<'a>) {
        self.inner_mut().set_cursor_symbol(symbol);
    }
}