vte/
definitions.rs

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
#[allow(dead_code)]
#[derive(Debug, Copy, Clone)]
pub enum State {
   Anywhere = 0,
   CsiEntry = 1,
   CsiIgnore = 2,
   CsiIntermediate = 3,
   CsiParam = 4,
   DcsEntry = 5,
   DcsIgnore = 6,
   DcsIntermediate = 7,
   DcsParam = 8,
   DcsPassthrough = 9,
   Escape = 10,
   EscapeIntermediate = 11,
   Ground = 12,
   OscString = 13,
   SosPmApcString = 14,
   Utf8 = 15,
}

#[allow(dead_code)]
#[derive(Debug, Clone, Copy)]
pub enum Action {
   None = 0,
   Clear = 1,
   Collect = 2,
   CsiDispatch = 3,
   EscDispatch = 4,
   Execute = 5,
   Hook = 6,
   Ignore = 7,
   OscEnd = 8,
   OscPut = 9,
   OscStart = 10,
   Param = 11,
   Print = 12,
   Put = 13,
   Unhook = 14,
   BeginUtf8 = 15,
}

/// Unpack a u8 into a State and Action
///
/// The implementation of this assumes that there are *precisely* 16 variants for both Action and
/// State. Furthermore, it assumes that the enums are tag-only; that is, there is no data in any
/// variant.
///
/// Bad things will happen if those invariants are violated.
#[inline(always)]
pub fn unpack(delta: u8) -> (State, Action) {
    (
        // State is stored in bottom 4 bits
        unsafe { ::core::mem::transmute(delta & 0x0f) },

        // Action is stored in top 4 bits
        unsafe { ::core::mem::transmute(delta >> 4) },
    )
}

#[cfg(test)]
mod tests {
    use super::{State, Action, unpack};
    #[test]
    fn unpack_state_action() {
        match unpack(0xee) {
            (State::SosPmApcString, Action::Unhook) => (),
            _ => panic!("unpack failed"),
        }

        match unpack(0x0f) {
            (State::Utf8, Action::None) => (),
            _ => panic!("unpack failed"),
        }

        match unpack(0xff) {
            (State::Utf8, Action::BeginUtf8) => (),
            _ => panic!("unpack failed"),
        }
    }
}