termina 0.3.1

A cross-platform VT manipulation library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

pub(crate) mod base64;
pub mod escape;
pub mod event;
pub(crate) mod parse;
pub mod style;
mod terminal;

use std::{fmt, num::NonZeroU16};

pub use event::{reader::EventReader, Event};
#[cfg(windows)]
pub use parse::windows;
pub use parse::Parser;

pub use terminal::{PlatformHandle, PlatformTerminal, Terminal};

#[cfg(feature = "event-stream")]
pub use event::stream::EventStream;

/// A helper type which avoids tripping over Unix terminal's one-indexed conventions.
///
/// Coordinates and terminal dimensions are one-based in Termina on both Unix and Windows.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
// CREDIT: <https://github.com/wezterm/wezterm/blob/a87358516004a652ad840bc1661bdf65ffc89b43/termwiz/src/escape/mod.rs#L527-L588>.
// This can be seen as a reimplementation on top of NonZeroU16.
pub struct OneBased(NonZeroU16);

impl OneBased {
    pub const fn new(n: u16) -> Option<Self> {
        match NonZeroU16::new(n) {
            Some(n) => Some(Self(n)),
            None => None,
        }
    }

    pub const fn from_zero_based(n: u16) -> Self {
        Self(unsafe { NonZeroU16::new_unchecked(n + 1) })
    }

    pub const fn get(self) -> u16 {
        self.0.get()
    }

    pub const fn get_zero_based(self) -> u16 {
        self.get() - 1
    }
}

impl Default for OneBased {
    fn default() -> Self {
        Self(unsafe { NonZeroU16::new_unchecked(1) })
    }
}

impl fmt::Display for OneBased {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.0.fmt(f)
    }
}

impl From<NonZeroU16> for OneBased {
    fn from(n: NonZeroU16) -> Self {
        Self(n)
    }
}

/// The dimensions of a terminal screen.
///
/// For both Unix and Windows, Termina returns the rows and columns.
/// Pixel width and height are not supported on Windows.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct WindowSize {
    /// The width - the number of columns.
    #[doc(alias = "width")]
    pub cols: u16,
    /// The height - the number of rows.
    #[doc(alias = "height")]
    pub rows: u16,
    /// The height of the window in pixels.
    pub pixel_width: Option<u16>,
    /// The width of the window in pixels.
    pub pixel_height: Option<u16>,
}