win32console 0.1.5

Provides a wrapper to interact with the windows console from rust
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

use crate::structs::focus_event::FocusEventRecord;
use crate::structs::input_event::{KeyEventRecord, MouseEventRecord};
use crate::structs::menu_event::MenuEventRecord;
use crate::structs::window_buffer_size_event::WindowBufferSizeRecord;
use winapi::um::wincon::{INPUT_RECORD, KEY_EVENT_RECORD, MOUSE_EVENT_RECORD, WINDOW_BUFFER_SIZE_RECORD, MENU_EVENT_RECORD, FOCUS_EVENT_RECORD};
use winapi::um::wincontypes::{
    FOCUS_EVENT, KEY_EVENT, MENU_EVENT, MOUSE_EVENT, WINDOW_BUFFER_SIZE_EVENT,
};

/// Represents an `INPUT_RECORD` which describes an input event in the console input buffer.
///
/// link: `https://docs.microsoft.com/en-us/windows/console/input-record-str`
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum InputRecord {
    /// The Event member contains a `KEY_EVENT_RECORD` structure with
    /// information about a keyboard event.
    KeyEvent(KeyEventRecord),
    /// The Event member contains a `MOUSE_EVENT_RECORD` structure with
    /// information about a mouse movement or button press event.
    MouseEvent(MouseEventRecord),
    /// The Event member contains a `WINDOW_BUFFER_SIZE_RECORD` structure with
    /// information about the new size of the console screen buffer.
    WindowBufferSizeEvent(WindowBufferSizeRecord),
    /// The Event member contains a `FOCUS_EVENT_RECORD` structure. These
    /// events are used internally and should be ignored.
    FocusEvent(FocusEventRecord),
    /// The Event member contains a `MENU_EVENT_RECORD` structure. These
    /// events are used internally and should be ignored.
    MenuEvent(MenuEventRecord),
}

impl From<INPUT_RECORD> for InputRecord {
    fn from(record: INPUT_RECORD) -> Self {
        match record.EventType {
            KEY_EVENT => {
                InputRecord::KeyEvent(KeyEventRecord::from(unsafe { *record.Event.KeyEvent() }))
            }
            MOUSE_EVENT => InputRecord::MouseEvent(unsafe { *record.Event.MouseEvent() }.into()),
            WINDOW_BUFFER_SIZE_EVENT => InputRecord::WindowBufferSizeEvent(
                unsafe { *record.Event.WindowBufferSizeEvent() }.into(),
            ),
            FOCUS_EVENT => InputRecord::FocusEvent(unsafe { *record.Event.FocusEvent() }.into()),
            MENU_EVENT => InputRecord::MenuEvent(unsafe { *record.Event.MenuEvent() }.into()),
            code => unreachable!("Invalid input record type: {}", code),
        }
    }
}

impl Into<INPUT_RECORD> for InputRecord{
    fn into(self) -> INPUT_RECORD {
        match self {
            InputRecord::KeyEvent(event) => event.into(),
            InputRecord::MouseEvent(event) => event.into(),
            InputRecord::WindowBufferSizeEvent(event) => event.into(),
            InputRecord::FocusEvent(event) => event.into(),
            InputRecord::MenuEvent(event) => event.into(),
        }
    }
}

impl Into<INPUT_RECORD> for KeyEventRecord{
    fn into(self) -> INPUT_RECORD {
        INPUT_RECORD{
            EventType: KEY_EVENT,
            Event: unsafe {
                let event : KEY_EVENT_RECORD = self.into();
                std::mem::transmute_copy(&event)
            }
        }
    }
}

impl Into<INPUT_RECORD> for MouseEventRecord{
    fn into(self) -> INPUT_RECORD {
        INPUT_RECORD{
            EventType: MOUSE_EVENT,
            Event: unsafe {
                let event : MOUSE_EVENT_RECORD = self.into();
                std::mem::transmute_copy(&event)
            }
        }
    }
}

impl Into<INPUT_RECORD> for WindowBufferSizeRecord{
    fn into(self) -> INPUT_RECORD {
        INPUT_RECORD{
            EventType: WINDOW_BUFFER_SIZE_EVENT,
            Event: unsafe {
                let event : WINDOW_BUFFER_SIZE_RECORD = self.into();
                std::mem::transmute_copy(&event)
            }
        }
    }
}

impl Into<INPUT_RECORD> for MenuEventRecord{
    fn into(self) -> INPUT_RECORD {
        INPUT_RECORD{
            EventType: MENU_EVENT,
            Event: unsafe {
                let event : MENU_EVENT_RECORD = self.into();
                std::mem::transmute_copy(&event)
            }
        }
    }
}

impl Into<INPUT_RECORD> for FocusEventRecord{
    fn into(self) -> INPUT_RECORD {
        INPUT_RECORD{
            EventType: FOCUS_EVENT,
            Event: unsafe {
                let event : FOCUS_EVENT_RECORD = self.into();
                std::mem::transmute_copy(&event)
            }
        }
    }
}

#[cfg(test)]
mod tests{
    use super::*;
    use crate::structs::input_event::ControlKeyState;

    #[test]
    fn key_event_into_input_record_test(){
        let mut key_event : KeyEventRecord = unsafe { std::mem::zeroed() };
        key_event.control_key_state = ControlKeyState::new(1);
        key_event.u_char = 'a';
        key_event.key_down = true;
        key_event.virtual_key_code = 2;
        key_event.repeat_count = 4;
        key_event.virtual_scan_code = 8;

        let record : INPUT_RECORD = key_event.into();
        assert_eq!(record.EventType, KEY_EVENT);

        let from_record = KeyEventRecord::from(unsafe { *record.Event.KeyEvent() });

        assert_eq!(key_event.virtual_scan_code, from_record.virtual_scan_code);
        assert_eq!(key_event.repeat_count, from_record.repeat_count);
        assert_eq!(key_event.key_down, from_record.key_down);
        assert_eq!(key_event.u_char, from_record.u_char);
        assert_eq!(key_event.control_key_state, from_record.control_key_state);
    }
}