chiro 0.1.3

A curses-style terminal view that runs inside a pixel buffer (Rewrite of chiropterm)
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

use enum_map::Enum;

use crate::shared::*;

#[derive(Clone, Copy, Debug, PartialEq)]
pub enum Event {
    Exit,
    Tick(u64),
    Mouse(MouseEvent),
    Type(TypeEvent),
    Press(PressEvent),
}

#[derive(Clone, Copy, Debug, PartialEq)]
pub enum MouseEvent {
    Click {
        mouse_button: MouseButton, 
        now: Zel, 
        now_click_selection: Option<Affordance>,
        now_scroll_selection: Option<Affordance>,
    },
    Up {
        mouse_button: MouseButton, 
        now: Zel, 
        now_click_selection: Option<Affordance>,
        now_scroll_selection: Option<Affordance>,
    },
    Drag { 
        mouse_button: MouseButton, 
        start: Zel, 
        last: Zel,
        now: Zel,
        now_click_selection: Option<Affordance>,
        now_scroll_selection: Option<Affordance>,
    },
    Wiggle { 
        last: Zel,
        now: Zel,
        now_click_selection: Option<Affordance>,
        now_scroll_selection: Option<Affordance>,
    },
    Scroll(f32, Zel, Option<Affordance>),
    // wheel?
}

#[derive(Clone, Copy, Debug, Enum, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub enum MouseButton {
    Left, Right
}

impl MouseButton {
    pub const ALL: [MouseButton; 2] = [MouseButton::Left, MouseButton::Right];
}

// TODO: Add an "is_accept()" method that returns true for enter and space
#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub enum TypeEvent {
    Down(TypeKey),
    Up(TypeKey),
    Type(char),
}

#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub struct TypeKey {
    pub code: TypeKeyCode,
    pub shift: bool,
    pub control: bool,
}

#[derive(Debug, Enum, Eq, PartialEq, Ord, PartialOrd, Hash, Clone, Copy)]
pub enum TypeKeyCode {
    // Unashamedly inspired by a similar enum from minifb
    Key0 = 0, Key1 = 1, Key2 = 2, Key3 = 3, Key4 = 4,
    Key5 = 5, Key6 = 6, Key7 = 7, Key8 = 8, Key9 = 9,

    A = 10, B = 11, C = 12, D = 13, E = 14, F = 15,
    G = 16, H = 17, I = 18, J = 19, K = 20, L = 21,
    M = 22, N = 23, O = 24, P = 25, Q = 26, R = 27,
    S = 28, T = 29, U = 30, V = 31, W = 32, X = 33,
    Y = 34, Z = 35,

    F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15,

    Down, Left, Right, Up,
    Apostrophe, Backquote,

    Backslash, Comma, Equal, LeftBracket,
    Minus, Period, RightBracket, Semicolon,
    Slash, Backspace, Delete, End, Enter,

    Escape,
    Home, Insert, Menu,
    PageDown, PageUp,
    Pause, 
    
    Space, Tab,

    // TODO: Shift punctuation
    Tilde,
    Exclamation, At, Pound, Dollar, Percent, Caret, Ampersand, Asterisk,
    LeftParen, RightParen, Underscore, Plus, LeftBrace, RightBrace,
    Pipe, Colon, DoubleQuote,
    LessThan, GreaterThan, QuestionMark,

    // don't include Lock, Shift, Alt, Super, and Ctrl -- terminals don't respond to 
    // these by themselves

    // don't expose NumPad keys separately: terminals don't know the difference
    // and doing so encourages developers to make UIs that won't work on most laptops
}


impl TypeEvent {
    pub fn alter_combo(&mut self, alter: impl FnOnce(&mut TypeKey)) {
        match self {
            TypeEvent::Down(k) => alter(k),
            TypeEvent::Up(k) => alter(k),
            TypeEvent::Type(_) => {},
        }
    }

    pub fn get_combo(&self) -> Option<TypeKey> {
        match self {
            TypeEvent::Down(k) => Some(*k),
            TypeEvent::Up(k) => Some(*k),
            TypeEvent::Type(_) => None,
        }
    }
}

#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub enum PressEvent {
    Press(PressKey),
    Release(PressKey),
}

#[derive(Debug, Enum, Eq, PartialEq, Ord, PartialOrd, Hash, Clone, Copy)]
pub enum PressKey {
    // Unashamedly inspired by a similar enum from minifb
    // Removes some keys that terminals would understand but which a game wouldn't
    Key0 = 0, Key1 = 1, Key2 = 2, Key3 = 3, Key4 = 4,
    Key5 = 5, Key6 = 6, Key7 = 7, Key8 = 8, Key9 = 9,

    A = 10, B = 11, C = 12, D = 13, E = 14, F = 15,
    G = 16, H = 17, I = 18, J = 19, K = 20, L = 21,
    M = 22, N = 23, O = 24, P = 25, Q = 26, R = 27,
    S = 28, T = 29, U = 30, V = 31, W = 32, X = 33,
    Y = 34, Z = 35,

    F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15,

    Down, Left, Right, Up,
    Apostrophe, Backquote,

    Backslash, Comma, Equal, LeftBracket,
    Minus, Period, RightBracket, Semicolon,
    Slash, Backspace, Delete, End, Enter,

    Escape,
    Home, Insert, Menu,
    PageDown, PageUp,
    Pause, 
    
    Space, Tab,

    Shift, Control, Super, Alt,
}