summaryrefslogtreecommitdiff
path: root/common/action.c
blob: d5040479e8faa38ab1feacb9a51cca0f3a9970e6 (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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
#include "host.h"
#include "timer.h"
#include "keymap.h"
#include "keycode.h"
#include "keyboard.h"
#include "mousekey.h"
#include "command.h"
#include "util.h"
#include "debug.h"
#include "action.h"


static void process(keyevent_t event);
static void register_code(uint8_t code);
static void unregister_code(uint8_t code);
static void add_mods(uint8_t mods);
static void del_mods(uint8_t mods);
static void set_mods(uint8_t mods);
static void clear_keyboard(void);
static void clear_keyboard_but_mods(void);
static bool sending_anykey(void);
static void layer_switch(uint8_t new_layer);


/* tap */
#define TAP_TIME    200
static keyevent_t last_event = {};
static uint8_t tap_count = 0;

/* layer */
uint8_t default_layer = 0;
uint8_t current_layer = 0;
static keyrecord_t tapping_key = {};
// time 0 means no event.
#define IS_TAPPING      (tapping_key.event.time != 0)
/* TODO: 
#define IS_TAPPING_KEY(key) (tapping_key.event.time != 0 && KEYEQ(tapping_key.event.key, key))
 */

/* waiting keys buffer */
#define WAITING_KEYS_BUFFER 3
static keyrecord_t waiting_keys[WAITING_KEYS_BUFFER] = {};
// TODO: double buffer?
static keyrecord_t waiting_keys0[WAITING_KEYS_BUFFER] = {};
static keyrecord_t waiting_keys1[WAITING_KEYS_BUFFER] = {};
static uint8_t waiting_keys_head = 0;
static bool waiting_keys_enqueue(keyevent_t event)
{
    debug("waiting_keys["); debug_dec(waiting_keys_head); debug("] = ");
    debug_hex8(event.key.row); debug_hex8(event.key.col); debug("\n"); // TODO event.key.raw
    if (waiting_keys_head < WAITING_KEYS_BUFFER) {
        waiting_keys[waiting_keys_head++] = (keyrecord_t){ .event = event,
                                                           .mods = host_get_mods() };
    } else {
        return true;
    }
}
static void waiting_keys_clear(void)
{
    waiting_keys_head = 0;
}
static bool waiting_keys_has(keypos_t key)
{
    for (uint8_t i = 0; i < waiting_keys_head; i++) {
        if KEYEQ(key, waiting_keys[i].event.key) return true;
    }
    return false;
}
static void waiting_keys_process_in_current_layer(void)
{
    // TODO: in case of including layer key in waiting keys
    for (uint8_t i = 0; i < waiting_keys_head; i++) {
        debug("waiting_keys_process_in_current_layer["); debug_dec(i); debug("]\n");
        // TODO: no need action in waiting_keys? should get_action() in process()?
        process(waiting_keys[i].event);
    }
    waiting_keys_clear();
}


void action_exec(keyevent_t event)
{
    if (IS_TAPPING) {
        /* when tap time elapses or waiting key is released */
        if ((timer_elapsed(tapping_key.event.time) > TAP_TIME) ||
            (!event.pressed && waiting_keys_has(event.key))) {

            // TODO process tapping_key: layer swich, modifier, ...
            // action is needed?
            debug("notap: process tapping_key.\n");
            process(tapping_key.event);

            /* Process waiting keys in new layer */
            waiting_keys_process_in_current_layer();
        }
        /* when tapping key is released within tap time */
        else if (!event.pressed && KEYEQ(event.key, tapping_key.event.key)) {
            /* tap key down */
            debug("tap("); debug_hex8(tap_count); debug(")[tapping_key](register): "); debug_hex8(tapping_key.action.layer.code);  debug("\n");
            register_code(tapping_key.action.layer.code);
            tapping_key = (keyrecord_t){};

            /* process waiting keys */
            waiting_keys_process_in_current_layer();
        }
    }

    // not real event. event just to handle time out of tapping key.
    if (IS_NOEVENT(event)) {
        return;
    }

    /* count up tap when key is up */
    // key: d u d u d
    // tap: 0 1 1 2 2
    // key: u d u d u
    // tap: 0 0 1 1 2
    if (KEYEQ(event.key, last_event.key) && timer_elapsed(last_event.time) <= TAP_TIME) {
        if (!event.pressed) tap_count++;
    } else {
        tap_count = 0;
    }

    /* store key events while tapping */
    if (IS_TAPPING) {
        // TODO: action is needed?
        waiting_keys_enqueue(event);
    } else {
        process(event);
    }

    /* last event */
    last_event = event;
}


static void process(keyevent_t event)
{
    action_t action = keymap_get_action(current_layer, event.key.row, event.key.col);
    debug("action: "); debug_hex16(action.code);
    if (event.pressed) debug("[down]\n"); else debug("[up]\n");

    switch (action.kind.id) {
        /* Key and Mods */
        case ACT_LMODS:
            //               |pressed                          |released
            // --------------+---------------------------------+------------
            // key           |down(key)                        |up(key)
            // mods          |add(mods)                        |del(mods)
            // key with mods |add(mods), down(key), unset(mods)|up(key)
            if (event.pressed) {
                uint8_t tmp_mods = host_get_mods();
                if (action.key.mods) {
                    host_add_mods(action.key.mods);
                    host_send_keyboard_report();
                }
                register_code(action.key.code);
                if (action.key.mods && action.key.code) {
                    host_set_mods(tmp_mods);
                    host_send_keyboard_report();
                }
            } else {
                if (action.key.mods && !action.key.code) {
                    host_del_mods(action.key.mods);
                    host_send_keyboard_report();
                }
                unregister_code(action.key.code);
            }
            break;
        case ACT_RMODS:
            //               |pressed                          |released
            // --------------+---------------------------------+------------
            // key           |down(key)                        |up(key)
            // mods          |add(mods)                        |del(mods)
            // key with mods |add(mods), down(key), unset(mods)|up(key)
            if (event.pressed) {
                uint8_t tmp_mods = host_get_mods();
                if (action.key.mods) {
                    host_add_mods(action.key.mods<<4);
                    host_send_keyboard_report();
                }
                register_code(action.key.code);
                if (action.key.mods && action.key.code) {
                    host_set_mods(tmp_mods);
                    host_send_keyboard_report();
                }
            } else {
                if (action.key.mods && !action.key.code) {
                    host_del_mods(action.key.mods<<4);
                    host_send_keyboard_report();
                }
                unregister_code(action.key.code);
            }
            break;
        case ACT_LMODS_TAP:
            if (event.pressed) {
                if (tap_count == 0) {
                    if (host_has_anykey()) {
                        // This key is a modifier essentially.
                        // Prioritize mods when key jam or rollover
                        add_mods(action.key.mods);
                    } else {
                        if (IS_TAPPING && KEYEQ(tapping_key.event.key, event.key)) {
                            // no tapping
                            add_mods(action.key.mods);
                            tapping_key = (keyrecord_t){};
                        } else {
                            debug("tapping lmods("); debug_hex8(action.key.mods); debug(")\n");
                            tapping_key = (keyrecord_t){
                                .event = event,
                                .action = action,
                                .mods = host_get_mods()
                            };
                        }
                    }
                } else {
                    // pressed after tapping
                    debug("tap("); debug_hex(tap_count); debug(")[lmods](register): "); debug_hex8(action.key.code); debug("\n");
                    register_code(action.key.code);
                }
            } else {
                if (tap_count == 0) {
                    debug("tap(00)[lmods](del_mods): "); debug_hex8(action.key.mods); debug("\n");
                    del_mods(action.key.mods);
                } else if (tap_count == 1) {
                    debug("tap(01)[lmods](del_mods/unregister): "); debug_hex8(action.key.mods); debug(" "); debug_hex8(action.key.code); debug("\n");
                    del_mods(action.key.mods);
                    unregister_code(action.key.code);
                } else {
                    debug("tap("); debug_hex(tap_count); debug(")[lmods](unregister): "); debug_hex8(action.key.code); debug("\n");
                    unregister_code(action.key.code);
                }
            }
            break;
        case ACT_RMODS_TAP:
            if (event.pressed) {
                if (tap_count == 0) {
                    if (host_has_anykey()) {
                        // This key is a modifier essentially.
                        // Prioritize mods when key jam or rollover
                        add_mods(action.key.mods<<4);
                    } else {
                        if (IS_TAPPING && KEYEQ(tapping_key.event.key, event.key)) {
                            // no tapping
                            add_mods(action.key.mods<<4);
                            tapping_key = (keyrecord_t){};
                        } else {
                            debug("tapping rmods("); debug_hex8(action.key.mods); debug(")\n");
                            tapping_key = (keyrecord_t){
                                .event = event,
                                .action = action,
                                .mods = host_get_mods()
                            };
                        }
                    }
                } else {
                    // pressed after tapping
                    debug("tap("); debug_hex(tap_count); debug(")[rmods](register): "); debug_hex8(action.key.code); debug("\n");
                    register_code(action.key.code);
                }
            } else {
                if (tap_count == 0) {
                    debug("tap(00)[rmods](del_mods): "); debug_hex8(action.key.mods); debug("\n");
                    del_mods(action.key.mods<<4);
                } else if (tap_count == 1) {
                    debug("tap(01)[rmods](del_mods/unregister): "); debug_hex8(action.key.mods); debug(" "); debug_hex8(action.key.code); debug("\n");
                    del_mods(action.key.mods<<4);
                    unregister_code(action.key.code);
                } else {
                    debug("tap("); debug_hex(tap_count); debug(")[rmods](unregister): "); debug_hex8(action.key.code); debug("\n");
                    unregister_code(action.key.code);
                }
            }
            break;

        /* other HID usage */
        case ACT_USAGE:
#ifdef EXTRAKEY_ENABLE
            switch (action.usage.page) {
                case ACTION_USAGE_PAGE_SYSTEM:
                    if (event.pressed) {
                        host_system_send(action.usage.code);
                    } else {
                        host_system_send(0);
                    }
                    break;
                case ACTION_USAGE_PAGE_CONSUMER:
                    if (event.pressed) {
                        host_consumer_send(action.usage.code);
                    } else {
                        host_consumer_send(0);
                    }
                    break;
            }
#endif
            break;

        /* Mouse key */
        case ACT_MOUSEKEY:
#ifdef MOUSEKEY_ENABLE
            if (event.pressed) {
                mousekey_on(action.key.code);
                mousekey_send();
            } else {
                mousekey_off(action.key.code);
                mousekey_send();
            }
#endif
            break;

        /* Layer key */
        case ACT_LAYER_PRESSED:
            // layer action when pressed
            switch (action.layer.code) {
                case 0x00:
                    if (event.pressed) {
                        layer_switch(action.layer.opt);
                    }
                    break;
                case 0xF0:
                    // TODO: tap toggle
                    break;
                case 0xFF:
                    if (event.pressed) {
                        default_layer = action.layer.opt;
                        layer_switch(default_layer);
                    }
                    break;
                default:
                    // with tap key
                    if (event.pressed) {
                        if (tap_count == 0) {
                            if (host_has_anykey()) {
                                // This key is a normal key than a leyar key essentially.
                                // Prioritize 'tap key' when key jam or rollover
                                register_code(action.layer.code);
                            } else {
                                if (IS_TAPPING && KEYEQ(tapping_key.event.key, event.key)) {
                                    layer_switch(action.layer.opt);
                                    tapping_key = (keyrecord_t){};
                                } else {
                                    debug("tapping layer("); debug_hex8(action.layer.opt); debug(")\n");
                                    tapping_key = (keyrecord_t){
                                        .event = event,
                                        .action = action,
                                        .mods = host_get_mods()
                                    };
                                }
                            }
                        } else if (tap_count > 0) {
                            // pressed after tapping
                            debug("tap[layer](register): "); debug_hex(tap_count); debug("\n");
                            register_code(action.layer.code);
                        }
                    } else {
                        // released after tapping
                        debug("tap[layer](unregister): "); debug_hex(tap_count); debug("\n");
                        unregister_code(action.layer.code);
                    }
                    break;
            }
            break;
        case ACT_LAYER_RELEASED:
            switch (action.layer.code) {
                case 0x00:
                    if (!event.pressed) {
                        layer_switch(action.layer.opt);
                    }
                    break;
                case 0xF0:
                    // Ignored. LAYER_RELEASED with tap toggle is invalid action.
                    break;
                case 0xFF:
                    if (!event.pressed) {
                        default_layer = action.layer.opt;
                        layer_switch(default_layer);
                    }
                    break;
                default:
                    // Ignored. LAYER_RELEASED with tap key is invalid action.
                    break;
            }
            break;
        case ACT_LAYER_BIT:
            switch (action.layer.code) {
                case 0x00:
                    if (event.pressed) {
                        layer_switch(current_layer | action.layer.opt);
                    } else {
                        layer_switch(current_layer & ~action.layer.opt);
                    }
                    break;
                case 0xF0:
                    // TODO: tap toggle
                    break;
                case 0xFF:
                    // change default layer
                    if (event.pressed) {
                        default_layer = current_layer | action.layer.opt;
                        layer_switch(default_layer);
                    } else {
                        default_layer = current_layer & ~action.layer.opt;
                        layer_switch(default_layer);
                    }
                    break;
                default:
                    // TODO: see ACT_LAYER_PRESSED code
                    // with tap key
                    if (event.pressed) {
                        if (tap_count == 0) {
                            if (host_has_anykey()) {
                                register_code(action.layer.code);
                            } else {
                                tapping_key = (keyrecord_t){
                                    .event = event,
                                    .action = action,
                                    .mods = keyboard_report->mods
                                };
                            }
                        } else if (tap_count > 0) {
                            debug("tap[layer_bit](register): "); debug_hex(tap_count); debug("\n");
                            register_code(action.layer.code);
                        }
                    } else {
                        if (tap_count == 0) {
                            // no tap
                            layer_switch(current_layer & ~action.layer.opt);
                        } else if (tap_count == 1) {
                            // tap
                            register_code(action.layer.code);
                        }
                        unregister_code(action.layer.code);
                    }
                    break;
            }
        case ACT_LAYER_EXT:
            switch (action.layer.opt) {
                case 0x00:
                    // set default layer when pressed
                    switch (action.layer.code) {
                        case 0x00:
                            if (event.pressed) {
                                layer_switch(default_layer);
                            }
                            break;
                        case 0xF0:
                            // TODO: tap toggle
                            break;
                        case 0xFF:
                            if (event.pressed) {
                                default_layer = current_layer;
                                layer_switch(default_layer);
                            }
                            break;
                        default:
                            // TODO: tap key
                            break;
                    }
                    break;
                case 0x01:
                    // set default layer when released
                    switch (action.layer.code) {
                        case 0x00:
                            if (!event.pressed) {
                                layer_switch(default_layer);
                            }
                            break;
                        case 0xFF:
                            if (!event.pressed) {
                                default_layer = current_layer;
                                layer_switch(default_layer);
                            }
                            break;
                        case 0xF0:
                        default:
                            // Ignore tap.
                            if (!event.pressed) {
                                layer_switch(default_layer);
                            }
                            break;
                    }
                    break;
            }
            break;

        /* Extentions */
        case ACT_MACRO:
        case ACT_COMMAND:
        case ACT_FUNCTION:
        default:
            break;
    }
}

static void register_code(uint8_t code)
{
    if (code == KC_NO) {
        return;
    }
    else if IS_KEY(code) {
        // TODO: should push command_proc out of this block?
        if (!command_proc(code)) {
            host_add_key(code);
            host_send_keyboard_report();
        }
    }
    else if IS_MOD(code) {
        host_add_mods(MOD_BIT(code));
        host_send_keyboard_report();
    }
}

static void unregister_code(uint8_t code)
{
    if IS_KEY(code) {
        host_del_key(code);
        host_send_keyboard_report();
    }
    else if IS_MOD(code) {
        host_del_mods(MOD_BIT(code));
        host_send_keyboard_report();
    }
}

static void add_mods(uint8_t mods)
{
    if (mods) {
        host_add_mods(mods);
        host_send_keyboard_report();
    }
}

static void del_mods(uint8_t mods)
{
    if (mods) {
        host_del_mods(mods);
        host_send_keyboard_report();
    }
}

static void set_mods(uint8_t mods)
{
    host_set_mods(mods);
    host_send_keyboard_report();
}

static void clear_keyboard(void)
{
    host_clear_mods();
    clear_keyboard_but_mods();
}

static void clear_keyboard_but_mods(void)
{
    host_clear_keys();
    host_send_keyboard_report();
#ifdef MOUSEKEY_ENABLE
    mousekey_clear();
    mousekey_send();
#endif
#ifdef EXTRAKEY_ENABLE
    host_system_send(0);
    host_consumer_send(0);
#endif
}

static bool sending_anykey(void)
{
    return (host_has_anykey() || host_mouse_in_use() ||
            host_last_sysytem_report() || host_last_consumer_report());
}

static void layer_switch(uint8_t new_layer)
{
    if (current_layer != new_layer) {
        debug("Layer Switch: "); debug_hex(current_layer);
        debug(" -> "); debug_hex(new_layer); debug("\n");

        current_layer = new_layer;
        clear_keyboard_but_mods(); // To avoid stuck keys
        // TODO: update mods with full scan of matrix? if modifier changes between layers
    }
}