summaryrefslogtreecommitdiff
path: root/quantum/debounce/tests/sym_eager_pr_tests.cpp
blob: 9a94807a49f714d5b800c323ab29e83ac51bddf0 (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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
/* Copyright 2021 Simon Arlott
 *
 * 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 "gtest/gtest.h"

#include "debounce_test_common.h"

TEST_F(DebounceTest, OneKeyShort1) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},
        {1, {{0, 1, UP}}, {}},

        {5, {}, {{0, 1, UP}}},
        /* Press key again after 1ms delay (debounce has not yet finished) */
        {6, {{0, 1, DOWN}}, {}},
        {10, {}, {{0, 1, DOWN}}}, /* 5ms after UP at time 5 */
    });
    runEvents();
}

TEST_F(DebounceTest, OneKeyShort2) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},
        {1, {{0, 1, UP}}, {}},

        {5, {}, {{0, 1, UP}}},
        /* Press key again after 2ms delay (debounce has not yet finished) */
        {7, {{0, 1, DOWN}}, {}},
        {10, {}, {{0, 1, DOWN}}}, /* 5ms after UP at time 5 */
    });
    runEvents();
}

TEST_F(DebounceTest, OneKeyShort3) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},
        {1, {{0, 1, UP}}, {}},

        {5, {}, {{0, 1, UP}}},
        /* Press key again after 3ms delay (debounce has not yet finished) */
        {8, {{0, 1, DOWN}}, {}},
        {10, {}, {{0, 1, DOWN}}}, /* 5ms after UP at time 5 */
    });
    runEvents();
}

TEST_F(DebounceTest, OneKeyShort4) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},
        {1, {{0, 1, UP}}, {}},

        {5, {}, {{0, 1, UP}}},
        /* Press key again after 4ms delay (debounce has not yet finished) */
        {9, {{0, 1, DOWN}}, {}},
        {10, {}, {{0, 1, DOWN}}}, /* 5ms after UP at time 5 */
    });
    runEvents();
}

TEST_F(DebounceTest, OneKeyShort5) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},
        {1, {{0, 1, UP}}, {}},

        {5, {}, {{0, 1, UP}}},
        /* Press key again after 5ms delay (debounce has finished) */
        {10, {{0, 1, DOWN}}, {{0, 1, DOWN}}},
    });
    runEvents();
}

TEST_F(DebounceTest, OneKeyShort6) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},
        {1, {{0, 1, UP}}, {}},

        {5, {}, {{0, 1, UP}}},
        /* Press key after after 6ms delay (debounce has finished) */
        {11, {{0, 1, DOWN}}, {{0, 1, DOWN}}},
    });
    runEvents();
}

TEST_F(DebounceTest, OneKeyBouncing1) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},
        {1, {{0, 1, UP}}, {}},
        {2, {{0, 1, DOWN}}, {}},
        {3, {{0, 1, UP}}, {}},
        {4, {{0, 1, DOWN}}, {}},
        {5, {{0, 1, UP}}, {{0, 1, UP}}},
        /* Press key again after 1ms delay (debounce has not yet finished) */
        {6, {{0, 1, DOWN}}, {}},
        {10, {}, {{0, 1, DOWN}}}, /* 5ms after UP at time 5 */
    });
    runEvents();
}

TEST_F(DebounceTest, OneKeyBouncing2) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},
        /* Change twice in the same time period */
        {1, {{0, 1, UP}}, {}},
        {1, {{0, 1, DOWN}}, {}},
        /* Change three times in the same time period */
        {2, {{0, 1, UP}}, {}},
        {2, {{0, 1, DOWN}}, {}},
        {2, {{0, 1, UP}}, {}},
        /* Change three times in the same time period */
        {3, {{0, 1, DOWN}}, {}},
        {3, {{0, 1, UP}}, {}},
        {3, {{0, 1, DOWN}}, {}},
        /* Change twice in the same time period */
        {4, {{0, 1, UP}}, {}},
        {4, {{0, 1, DOWN}}, {}},
        {5, {{0, 1, UP}}, {{0, 1, UP}}},
        /* Press key again after 1ms delay (debounce has not yet finished) */
        {6, {{0, 1, DOWN}}, {}},
        {10, {}, {{0, 1, DOWN}}}, /* 5ms after UP at time 5 */
    });
    runEvents();
}

TEST_F(DebounceTest, OneKeyLong) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},

        {25, {{0, 1, UP}}, {{0, 1, UP}}},

        {50, {{0, 1, DOWN}}, {{0, 1, DOWN}}},
    });
    runEvents();
}

TEST_F(DebounceTest, TwoRowsShort) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},
        {1, {{0, 1, UP}}, {}},
        {2, {{2, 0, DOWN}}, {{2, 0, DOWN}}},
        {3, {{2, 0, UP}}, {}},

        {5, {}, {{0, 1, UP}}},
        /* Press key again after 1ms delay (debounce has not yet finished) */
        {6, {{0, 1, DOWN}}, {}},
        {7, {}, {{2, 0, UP}}},

        /* Press key again after 1ms delay (debounce has not yet finished) */
        {9, {{2, 0, DOWN}}, {}},
        {10, {}, {{0, 1, DOWN}}}, /* 5ms after UP at time 5 */

        {12, {}, {{2, 0, DOWN}}}, /* 5ms after UP at time 7 */
    });
    runEvents();
}

TEST_F(DebounceTest, TwoKeysOverlap) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},
        {1, {{0, 1, UP}}, {}},
        /* Press a second key during the first debounce */
        {2, {{0, 2, DOWN}}, {}},

        /* Key registers as soon as debounce finishes, 5ms after time 0 */
        {5, {}, {{0, 1, UP}, {0, 2, DOWN}}},
        {6, {{0, 1, DOWN}}, {}},

        /* Key registers as soon as debounce finishes, 5ms after time 5 */
        {10, {}, {{0, 1, DOWN}}},
        /* Release both keys */
        {11, {{0, 1, UP}}, {}},
        {12, {{0, 2, UP}}, {}},

        /* Keys register as soon as debounce finishes, 5ms after time 10 */
        {15, {}, {{0, 1, UP}, {0, 2, UP}}},
    });
    runEvents();
}

TEST_F(DebounceTest, TwoKeysSimultaneous1) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}, {0, 2, DOWN}}, {{0, 1, DOWN}, {0, 2, DOWN}}},
        {20, {{0, 1, UP}}, {{0, 1, UP}}},
        {21, {{0, 2, UP}}, {}},

        /* Key registers as soon as debounce finishes, 5ms after time 20 */
        {25, {}, {{0, 2, UP}}},
    });
    runEvents();
}

TEST_F(DebounceTest, TwoKeysSimultaneous2) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}, {0, 2, DOWN}}, {{0, 1, DOWN}, {0, 2, DOWN}}},
        {20, {{0, 1, UP}, {0, 2, UP}}, {{0, 1, UP}, {0, 2, UP}}},
    });
    runEvents();
}

TEST_F(DebounceTest, OneKeyDelayedScan1) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},

        /* Processing is very late but the change will now be accepted */
        {300, {{0, 1, UP}}, {{0, 1, UP}}},
    });
    time_jumps_ = true;
    runEvents();
}

TEST_F(DebounceTest, OneKeyDelayedScan2) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},

        /* Processing is very late but the change will now be accepted even with a 1 scan delay */
        {300, {}, {}},
        {300, {{0, 1, UP}}, {{0, 1, UP}}},
    });
    time_jumps_ = true;
    runEvents();
}

TEST_F(DebounceTest, OneKeyDelayedScan3) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},

        /* Processing is very late but the change will now be accepted even with a 1ms delay */
        {300, {}, {}},
        {301, {{0, 1, UP}}, {{0, 1, UP}}},
    });
    time_jumps_ = true;
    runEvents();
}

TEST_F(DebounceTest, OneKeyDelayedScan4) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},

        /* Processing is a bit late but the change will now be accepted */
        {50, {{0, 1, UP}}, {{0, 1, UP}}},
    });
    time_jumps_ = true;
    runEvents();
}

TEST_F(DebounceTest, OneKeyDelayedScan5) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},

        /* Processing is very late but the change will now be accepted even with a 1 scan delay */
        {50, {}, {}},
        {50, {{0, 1, UP}}, {{0, 1, UP}}},
    });
    time_jumps_ = true;
    runEvents();
}

TEST_F(DebounceTest, OneKeyDelayedScan6) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},

        /* Processing is very late but the change will now be accepted even with a 1ms delay */
        {50, {}, {}},
        {51, {{0, 1, UP}}, {{0, 1, UP}}},
    });
    time_jumps_ = true;
    runEvents();
}

TEST_F(DebounceTest, AsyncTickOneKeyShort1) {
    addEvents({
        /* Time, Inputs, Outputs */
        {0, {{0, 1, DOWN}}, {{0, 1, DOWN}}},
        {1, {{0, 1, UP}}, {}},

        {5, {}, {{0, 1, UP}}},
        /* Press key again after 1ms delay (debounce has not yet finished) */
        {6, {{0, 1, DOWN}}, {}},
        {10, {}, {{0, 1, DOWN}}}, /* 5ms after UP at time 5 */
    });
    /*
     * Debounce implementations should never read the timer more than once per invocation
     */
    async_time_jumps_ = DEBOUNCE;
    runEvents();
}