notcurses 3.6.0

A high level Rust wrapper for the notcurses C 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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

// notcurses::input::input
//
//!
//

use crate::{
    input::{InputType, Key, KeyMod, Received},
    Position,
};

/// A received input.
#[derive(Clone, Copy, PartialEq, Eq)]
pub struct Input {
    /// The received input event.
    pub received: Received,

    /// Keyboard modifiers.
    pub keymod: KeyMod,

    /// The type of the input.
    pub itype: InputType,

    /// The cell position of the event, if defined.
    pub cell: Option<Position>,

    /// Pixel offset within the cell, if defined.
    pub offset: Option<Position>,
}

mod core_impls {
    use super::{Input, Position};
    use crate::sys::{NcInput, NcReceived};
    use core::fmt;

    impl fmt::Display for Input {
        #[rustfmt::skip]
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            let cell = if let Some(c) = self.cell { c.to_string() } else { "None".into() };
            let offset = if let Some(o) = self.offset { o.to_string() } else { "None".into() };
            write!(f,
                "{} {} {} {} {}",
                self.received, self.keymod, self.itype, cell, offset,
            )
        }
    }

    impl fmt::Debug for Input {
        #[rustfmt::skip]
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            let cell = if let Some(c) = self.cell { c.to_string() } else { "None".into() };
            let offset = if let Some(o) = self.offset { o.to_string() } else { "None".into() };
            write!(f,
                "Input {{received:{} mod:{} type:{} cell:{} offset:{} }}",
                self.received, self.keymod, self.itype, cell, offset,
            )
        }
    }

    impl From<(NcReceived, NcInput)> for Input {
        fn from(received_input: (NcReceived, NcInput)) -> Input {
            let (received, input) = received_input;

            // cell position & offset is only relevant for mouse events
            let (mut cell, mut offset) = (None, None);
            if let NcReceived::Key(k) = received {
                if k.is_mouse() {
                    if input.y != -1 {
                        // != undefined
                        cell = Some(Position::new(input.x, input.y));
                    }
                    if input.ypx != -1 {
                        offset = Some(Position::new(input.xpx, input.ypx));
                    }
                }
            };

            Input {
                received: received.into(),
                keymod: input.modifiers.into(),
                itype: input.evtype.into(),
                cell,
                offset,
            }
        }
    }
}

/// # methods
impl Input {
    /* Received */

    /// Returns `true` if any actual input has been received.
    #[inline]
    pub const fn received(&self) -> bool {
        !matches![self.received, Received::NoInput]
    }

    /// Returns `true` if some [`Key`] has been received.
    #[inline]
    pub const fn some_key(&self) -> bool {
        matches!(self.received, Received::Key(_))
    }

    /// Returns `true` if a specific [`Key`] has been received.
    #[inline]
    pub fn is_key(&self, key: Key) -> bool {
        self.received.is_key(key)
    }

    /// Returns `true` if some `character` has been received.
    #[inline]
    pub const fn some_char(&self) -> bool {
        matches!(self.received, Received::Char(_))
    }

    /// Returns `true` if a specific `character` has been received.
    #[inline]
    pub const fn is_char(&self, character: char) -> bool {
        self.received.is_char(character)
    }

    /* InputType */

    /// Returns `true` if this' a `Press` input type.
    #[inline]
    pub const fn is_press(&self) -> bool {
        self.itype.is_press()
    }

    /// Returns `true` if this' a `Repeat` input type.
    #[inline]
    pub const fn is_repeat(&self) -> bool {
        self.itype.is_repeat()
    }

    /// Returns `true` if this' a `Release` input type.
    #[inline]
    pub const fn is_release(&self) -> bool {
        self.itype.is_release()
    }
}