pogp 0.0.14

The POG Protocol for game development defines a portable game loop and language-neutral binary representations of Inputs and State.
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

use super::Key;
use super::KeyboardInput;

const INPUT_BUFFER_LENGTH: usize = 10;

#[derive(Debug)]
pub struct KeyboardSnapshot {
    inputs: [KeyboardInput; INPUT_BUFFER_LENGTH],
    index: usize,
}

impl KeyboardSnapshot {
    pub fn new() -> Self {
        Self {
            inputs: Default::default(),
            index: 0,
        }
    }

    pub fn add_input(&mut self, input: KeyboardInput) {
        self.inputs[self.index] = input;
        self.advance_index();
    }

    pub fn is_key_down(&self, key: Key) -> bool {
        self.inputs[self.head()].is_key_down(key)
            && !self.inputs[self.last_frame()].is_key_down(key)
    }

    pub fn is_key_pressed(&self, key: Key) -> bool {
        self.inputs[self.head()].is_key_down(key)
    }

    pub fn is_key(&self, key: Key) -> bool {
        self.is_key_pressed(key)
    }

    pub fn is_key_up(&self, key: Key) -> bool {
        !self.inputs[self.head()].is_key_down(key)
            && self.inputs[self.last_frame()].is_key_down(key)
    }

    fn advance_index(&mut self) {
        self.index = if self.index == INPUT_BUFFER_LENGTH - 1 {
            0
        } else {
            self.index + 1
        }
    }

    fn last_frame(&self) -> usize {
        match self.index {
            0 => INPUT_BUFFER_LENGTH - 1,
            1 => INPUT_BUFFER_LENGTH - 2,
            _ => self.index - 2,
        }
    }

    fn head(&self) -> usize {
        if self.index == 0 {
            INPUT_BUFFER_LENGTH - 1
        } else {
            self.index - 1
        }
    }
}

#[cfg(test)]
mod keyboard_snapshot {
    use super::*;

    #[test]
    fn add_input() {
        let mut snapshot = KeyboardSnapshot::new();

        for _ in 0..40 {
            snapshot.add_input(KeyboardInput::from(vec![Key::Enter]));
        }
    }

    #[test]
    fn is_key_down() {
        let mut snapshot = KeyboardSnapshot::new();
        assert_eq!(snapshot.is_key_down(Key::KeyW), false, "false on empty");

        snapshot.add_input(KeyboardInput::from(vec![Key::KeyW]));
        assert_eq!(snapshot.is_key_down(Key::KeyW), true, "true on key down");

        snapshot.add_input(KeyboardInput::from(vec![Key::KeyW]));
        assert_eq!(
            snapshot.is_key_down(Key::KeyW),
            false,
            "false while key down"
        );

        snapshot.add_input(Default::default());
        assert_eq!(snapshot.is_key_down(Key::KeyW), false, "false on key up");
    }

    #[test]
    fn is_key_pressed() {
        let mut snapshot = KeyboardSnapshot::new();
        assert_eq!(
            snapshot.is_key_pressed(Key::IntlYen),
            false,
            "false on empty"
        );

        snapshot.add_input(KeyboardInput::from(vec![Key::IntlYen]));
        assert_eq!(
            snapshot.is_key_pressed(Key::IntlYen),
            true,
            "true on key down"
        );

        snapshot.add_input(KeyboardInput::from(vec![Key::IntlYen]));
        assert_eq!(
            snapshot.is_key_pressed(Key::IntlYen),
            true,
            "true while key down"
        );

        snapshot.add_input(Default::default());
        assert_eq!(
            snapshot.is_key_pressed(Key::IntlYen),
            false,
            "false on key up"
        );
    }

    // #[test]
    // fn is_key_pressed() {}

    #[test]
    fn is_key_up() {
        let mut snapshot = KeyboardSnapshot::new();
        assert_eq!(snapshot.is_key_up(Key::Enter), false, "false on empty");

        snapshot.add_input(KeyboardInput::from(vec![Key::Enter]));
        assert_eq!(snapshot.is_key_up(Key::Enter), false, "false on key down");

        snapshot.add_input(KeyboardInput::from(vec![Key::Enter]));
        assert_eq!(
            snapshot.is_key_up(Key::Enter),
            false,
            "false while key down"
        );

        snapshot.add_input(Default::default());
        assert_eq!(snapshot.is_key_up(Key::Enter), true, "true on key up");

        snapshot.add_input(Default::default());
        assert_eq!(snapshot.is_key_up(Key::Enter), false, "false on next frame");
    }
}