bo-bin 0.4.0

use crate::{LineNumber, Position};
use std::fmt::Debug;
use std::io::Error;
use termion::color;
use termion::event::{Event, MouseEvent};

#[derive(Debug)]
#[allow(clippy::module_name_repetitions)]
pub struct ConsoleSize {
    pub height: u16,
    pub width: u16,
}

impl From<(u16, u16)> for ConsoleSize {
    fn from(t: (u16, u16)) -> Self {
        Self {
            height: t.1,
            width: t.0,
        }
    }
}

impl Default for ConsoleSize {
    fn default() -> Self {
        Self {
            height: 80,
            width: 120,
        }
    }
}

impl ConsoleSize {
    #[must_use]
    pub fn restrict_to_text_area(&self) -> Self {
        Self {
            height: self.height.saturating_sub(2),
            width: self.width,
        }
    }
}

// Note to self: ": Debug" means that all implementations of that traut
// must implement the Debug trait as well.
pub trait Console: Debug {
    /// Read the next event from the console input.termion
    ///
    /// # Errors
    /// Will return an error if an event can't be read from the console input.
    fn read_event(&mut self) -> Result<Event, Error>;

    fn clear_screen(&self);

    fn clear_current_line(&self);

    /// # Errors
    /// Will return an error if the terminal can't be flushed
    fn flush(&self) -> Result<(), Error>;

    fn hide_cursor(&self);

    fn show_cursor(&self);

    fn set_bg_color(&self, color: color::Rgb);

    fn reset_bg_color(&self);

    fn set_fg_color(&self, color: color::Rgb);

    fn reset_fg_color(&self);

    fn to_alternate_screen(&self);

    fn to_main_screen(&self);

    fn clear_all(&self);

    fn size(&self) -> ConsoleSize;

    fn text_area_size(&self) -> ConsoleSize;

    fn middle_of_screen_line_number(&self) -> LineNumber;

    fn bottom_of_screen_line_number(&self) -> LineNumber;

    fn get_cursor_index_from_mouse_event(&self, mouse_event: MouseEvent, x_offset: u8) -> Position;

    fn set_cursor_position_in_text_area(&self, position: &Position, row_prefix_length: u8);

    fn set_cursor_position_anywhere(&self, position: &Position);

    fn set_cursor_as_steady_bar(&self);

    fn set_cursor_as_steady_block(&self);
}