textual 1.0.0-dev

A reactive TUI framework inspired by the Python Textual 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

use std::io;

use crate::driver::{DriverOptions, KeyboardProtocol, PointerShape, Size};

#[cfg(not(target_os = "windows"))]
mod posix;
#[cfg(target_os = "windows")]
mod windows;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct CapabilityProfile {
    pub supports_dim_reliably: bool,
    pub supports_reverse_reliably: bool,
    pub supports_pointer_shapes: bool,
    pub supports_kitty_keyboard: bool,
    pub supports_focus_change: bool,
    pub requires_mode_reassert_on_resize: bool,
}

pub(crate) trait PlatformDriver {
    fn start(
        &mut self,
        options: DriverOptions,
        keyboard_protocol: KeyboardProtocol,
    ) -> io::Result<bool>;

    fn stop(&mut self, options: DriverOptions, keyboard_enhanced: bool) -> io::Result<()>;

    fn refresh_size(&mut self) -> io::Result<Size>;

    fn reassert_runtime_modes(&mut self, started: bool) -> io::Result<()>;

    fn set_pointer_shape(
        &mut self,
        started: bool,
        options: DriverOptions,
        shape: PointerShape,
    ) -> io::Result<()>;
}

pub(crate) fn make_platform_driver() -> Box<dyn PlatformDriver> {
    #[cfg(target_os = "windows")]
    {
        return Box::new(windows::WindowsPlatformDriver);
    }

    #[cfg(not(target_os = "windows"))]
    {
        Box::new(posix::PosixPlatformDriver)
    }
}

pub(crate) fn detect_pointer_shapes_enabled() -> bool {
    #[cfg(target_os = "windows")]
    {
        return windows::detect_pointer_shapes_enabled();
    }

    #[cfg(not(target_os = "windows"))]
    {
        posix::detect_pointer_shapes_enabled()
    }
}

pub(crate) fn capability_profile() -> CapabilityProfile {
    #[cfg(target_os = "windows")]
    {
        return windows::capability_profile();
    }

    #[cfg(not(target_os = "windows"))]
    {
        posix::capability_profile()
    }
}