summaryrefslogtreecommitdiffstats
path: root/tests/basic/test_keypress.cpp
blob: 551458a0d9d60e685b57d612fc67071e852fecbc (plain)
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
/* Copyright 2017 Fred Sundvik
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "test_common.hpp"

using testing::_;
using testing::Return;
using testing::InSequence;

class KeyPress : public TestFixture {};

TEST_F(KeyPress, SendKeyboardIsNotCalledWhenNoKeyIsPressed) {
    TestDriver driver;
    EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
    keyboard_task();
}

TEST_F(KeyPress, CorrectKeyIsReportedWhenPressed) {
    TestDriver driver;
    press_key(0, 0);
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_A)));
    keyboard_task();
    release_key(0, 0);
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
    keyboard_task();
}

TEST_F(KeyPress, CorrectKeysAreReportedWhenTwoKeysArePressed) {
    TestDriver driver;
    press_key(1, 0);
    press_key(0, 3);
    // Note that QMK only processes one key at a time
    // See issue #1476 for more information
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_B)));
    keyboard_task();
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_B, KC_C)));
    keyboard_task();
    release_key(1, 0);
    release_key(0, 3);
    // Note that the first key released is the first one in the matrix order
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_C)));
    keyboard_task();
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
    keyboard_task();
}

TEST_F(KeyPress, ANonMappedKeyDoesNothing) {
    TestDriver driver;
    press_key(2, 0);
    EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
    keyboard_task();
    keyboard_task();
}

TEST_F(KeyPress, LeftShiftIsReportedCorrectly) {
    TestDriver driver;
    press_key(3, 0);
    press_key(0, 0);
    // Unfortunately modifiers are also processed in the wrong order
    // See issue #1476 for more information
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_A)));
    keyboard_task();
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_A, KC_LSFT)));
    keyboard_task();
    release_key(0, 0);
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
    keyboard_task();
    release_key(3, 0);
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
    keyboard_task();
}

TEST_F(KeyPress, PressLeftShiftAndControl) {
    TestDriver driver;
    press_key(3, 0);
    press_key(5, 0);
    // Unfortunately modifiers are also processed in the wrong order
    // See issue #1476 for more information
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
    keyboard_task();
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_LCTRL)));
    keyboard_task();
}

TEST_F(KeyPress, LeftAndRightShiftCanBePressedAtTheSameTime) {
    TestDriver driver;
    press_key(3, 0);
    press_key(4, 0);
    // Unfortunately modifiers are also processed in the wrong order
    // See issue #1476 for more information
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
    keyboard_task();
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_RSFT)));
    keyboard_task();
}

TEST_F(KeyPress, RightShiftLeftControlAndCharWithTheSameKey) {
    TestDriver driver;
    press_key(6, 0);
    // BUG: The press is split into two reports
    // BUG: It reports RSFT instead of LSFT
    // See issue #524 for more information
    // The underlying cause is that we use only one bit to represent the right hand
    // modifiers.
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_RSFT, KC_RCTRL)));
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_RSFT, KC_RCTRL, KC_O)));
    keyboard_task();
    release_key(6, 0);
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_RSFT, KC_RCTRL)));
    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
    keyboard_task();
}

TEST_F(KeyPress, PressPlusEqualReleaseBeforePress) {
  TestDriver driver;
  InSequence s;

  press_key(1, 1); // KC_PLUS
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_EQL)));
  run_one_scan_loop();
  testing::Mock::VerifyAndClearExpectations(&driver);

  release_key(1, 1); // KC_PLUS
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
  run_one_scan_loop();
  testing::Mock::VerifyAndClearExpectations(&driver);

  press_key(0, 1); // KC_EQL
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQL)));
  run_one_scan_loop();
  testing::Mock::VerifyAndClearExpectations(&driver);

  release_key(0, 1); // KC_EQL
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
  run_one_scan_loop();
  testing::Mock::VerifyAndClearExpectations(&driver);
}

TEST_F(KeyPress, PressPlusEqualDontReleaseBeforePress) {
  TestDriver driver;
  InSequence s;

  press_key(1, 1); // KC_PLUS
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_EQL)));
  run_one_scan_loop();
  testing::Mock::VerifyAndClearExpectations(&driver);

  press_key(0, 1); // KC_EQL
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQL)));
  run_one_scan_loop();
  testing::Mock::VerifyAndClearExpectations(&driver);

  release_key(1, 1); //KC_PLS
  // BUG: Should really still return KC_EQL, but this is fine too
  // It's also called twice for some reason
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(2);
  run_one_scan_loop();
  testing::Mock::VerifyAndClearExpectations(&driver);

  release_key(0, 1); // KC_EQL
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
  run_one_scan_loop();
  testing::Mock::VerifyAndClearExpectations(&driver);
}

TEST_F(KeyPress, PressEqualPlusReleaseBeforePress) {
  TestDriver driver;
  InSequence s;

  press_key(0, 1); // KC_EQL
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQL)));
  run_one_scan_loop();
  testing::Mock::VerifyAndClearExpectations(&driver);

  release_key(0, 1); // KQ_EQL
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
  run_one_scan_loop();
  testing::Mock::VerifyAndClearExpectations(&driver);

  press_key(1, 1); // KC_PLUS
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_EQL)));
  run_one_scan_loop();
  testing::Mock::VerifyAndClearExpectations(&driver);

  release_key(1, 1); // KC_PLUS
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
  run_one_scan_loop();
  testing::Mock::VerifyAndClearExpectations(&driver);
}

TEST_F(KeyPress, PressEqualPlusDontReleaseBeforePress) {
  TestDriver driver;
  InSequence s;

  press_key(0, 1); // KC_EQL
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQL)));
  run_one_scan_loop();
  testing::Mock::VerifyAndClearExpectations(&driver);

  press_key(1, 1); // KC_PLUS
  // BUG: The sequence is a bit strange, but it works, the end result is that
  // KC_PLUS is sent
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_EQL)));
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_EQL)));
  run_one_scan_loop();
  testing::Mock::VerifyAndClearExpectations(&driver);

  release_key(0, 1); //KC_EQL
  // I guess it's fine to still report shift here
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
  run_one_scan_loop();
  testing::Mock::VerifyAndClearExpectations(&driver);

  release_key(1, 1); // KC_PLUS
  // This report is not needed
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
  run_one_scan_loop();
  testing::Mock::VerifyAndClearExpectations(&driver);
}