common/action.c

   1 /*
   2 Copyright 2012,2013 Jun Wako <wakojun@gmail.com>
   3
   4 This program is free software: you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation, either version 2 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17 #include "host.h"
  18 #include "timer.h"
  19 #include "keymap.h"
  20 #include "keycode.h"
  21 #include "keyboard.h"
  22 #include "mousekey.h"
  23 #include "command.h"
  24 #include "util.h"
  25 #include "debug.h"
  26 #include "action.h"
  27
  28
  29 static void process_action(keyrecord_t *record);
  30 static bool process_tapping(keyrecord_t *record);
  31 static void waiting_buffer_scan_tap(void);
  32
  33 static void debug_event(keyevent_t event);
  34 static void debug_record(keyrecord_t record);
  35 static void debug_action(action_t action);
  36 static void debug_tapping_key(void);
  37 static void debug_waiting_buffer(void);
  38
  39
  40 /*
  41  * Tapping
  42  */
  43 /* period of tapping(ms) */
  44 #ifndef TAPPING_TERM
  45 #define TAPPING_TERM    200
  46 #endif
  47
  48 /* tap count needed for toggling a feature */
  49 #ifndef TAPPING_TOGGLE
  50 #define TAPPING_TOGGLE  5
  51 #endif
  52
  53 /* stores a key event of current tap. */
  54 static keyrecord_t tapping_key = {};
  55
  56 #define IS_TAPPING()            !IS_NOEVENT(tapping_key.event)
  57 #define IS_TAPPING_PRESSED()    (IS_TAPPING() && tapping_key.event.pressed)
  58 #define IS_TAPPING_RELEASED()   (IS_TAPPING() && !tapping_key.event.pressed)
  59 #define IS_TAPPING_KEY(k)       (IS_TAPPING() && KEYEQ(tapping_key.event.key, (k)))
  60 #define WITHIN_TAPPING_TERM(e)  (TIMER_DIFF_16(e.time, tapping_key.event.time) < TAPPING_TERM)
  61
  62
  63 /*
  64  * Waiting buffer
  65  *
  66  * stores key events waiting for settling current tap.
  67  */
  68 #define WAITING_BUFFER_SIZE 8
  69 static keyrecord_t waiting_buffer[WAITING_BUFFER_SIZE] = {};
  70
  71 /* point to empty cell to enq */
  72 static uint8_t waiting_buffer_head = 0;
  73
  74 /* point to the oldest data cell to deq */
  75 static uint8_t waiting_buffer_tail = 0;
  76
  77 static bool waiting_buffer_enq(keyrecord_t record)
  78 {
  79     if (IS_NOEVENT(record.event)) {
  80         return true;
  81     }
  82
  83     if ((waiting_buffer_head + 1) % WAITING_BUFFER_SIZE == waiting_buffer_tail) {
  84         debug("waiting_buffer_enq: Over flow.\n");
  85         return false;
  86     }
  87
  88     waiting_buffer[waiting_buffer_head] = record;
  89     waiting_buffer_head = (waiting_buffer_head + 1) % WAITING_BUFFER_SIZE;
  90
  91     debug("waiting_buffer_enq: "); debug_waiting_buffer();
  92     return true;
  93 }
  94
  95 static void waiting_buffer_clear(void)
  96 {
  97     waiting_buffer_head = 0;
  98     waiting_buffer_tail = 0;
  99 }
 100
 101 #if TAPPING_TERM >= 500
 102 static bool waiting_buffer_typed(keyevent_t event)
 103 {
 104     for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
 105         if (KEYEQ(event.key, waiting_buffer[i].event.key) && event.pressed !=  waiting_buffer[i].event.pressed) {
 106             return true;
 107         }
 108     }
 109     return false;
 110 }
 111 #endif
 112
 113 static bool waiting_buffer_has_anykey_pressed(void)
 114 {
 115     for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
 116         if (waiting_buffer[i].event.pressed) return true;
 117     }
 118     return false;
 119 }
 120
 121
 122 /* Oneshot modifier
 123  *
 124  * Problem: Want to capitalize like 'The' but the result tends to be 'THe'.
 125  * Solution: Oneshot modifier have its effect on only one key coming next.
 126  *           Tap Shift, then type 't', 'h' and 'e'. Not need to hold Shift key.
 127  *
 128  *  Hold:       works as normal modifier.
 129  *  Tap:        one shot modifier.
 130  *  2 Tap:      cancel one shot modifier.
 131  *  5-Tap:      toggles enable/disable oneshot feature.
 132  */
 133 static struct {
 134     uint8_t mods;
 135     uint8_t time;
 136     bool    ready;
 137     bool    disabled;
 138 }   oneshot_state;
 139
 140 static void oneshot_start(uint8_t mods, uint16_t time)
 141 {
 142     oneshot_state.mods = mods;
 143     oneshot_state.time = time;
 144     oneshot_state.ready = true;
 145 }
 146
 147 static void oneshot_cancel(void)
 148 {
 149     oneshot_state.mods = 0;
 150     oneshot_state.time = 0;
 151     oneshot_state.ready = false;
 152 }
 153
 154 static void oneshot_toggle(void)
 155 {
 156     oneshot_state.disabled = !oneshot_state.disabled;
 157 }
 158
 159
 160
 161 void action_exec(keyevent_t event)
 162 {
 163     if (!IS_NOEVENT(event)) {
 164         debug("\n---- action_exec: start -----\n");
 165         debug("EVENT: "); debug_event(event); debug("\n");
 166     }
 167
 168     keyrecord_t record = { .event = event };
 169
 170     // pre-process on tapping
 171     if (process_tapping(&record)) {
 172         if (!IS_NOEVENT(record.event)) {
 173             debug("processed: "); debug_record(record); debug("\n");
 174         }
 175     } else {
 176         // enqueue
 177         if (!waiting_buffer_enq(record)) {
 178             // clear all in case of overflow.
 179             debug("OVERFLOW: CLEAR ALL STATES\n");
 180             clear_keyboard();
 181             waiting_buffer_clear();
 182             tapping_key = (keyrecord_t){};
 183         }
 184     }
 185
 186     // process waiting_buffer
 187     if (!IS_NOEVENT(event) && waiting_buffer_head != waiting_buffer_tail) {
 188         debug("---- action_exec: process waiting_buffer -----\n");
 189     }
 190
 191     for (; waiting_buffer_tail != waiting_buffer_head; waiting_buffer_tail = (waiting_buffer_tail + 1) % WAITING_BUFFER_SIZE) {
 192         if (process_tapping(&waiting_buffer[waiting_buffer_tail])) {
 193             debug("processed: waiting_buffer["); debug_dec(waiting_buffer_tail); debug("] = ");
 194             debug_record(waiting_buffer[waiting_buffer_tail]); debug("\n\n");
 195         } else {
 196             break;
 197         }
 198     }
 199     if (!IS_NOEVENT(event)) {
 200         debug("\n");
 201     }
 202 }
 203
 204 static void process_action(keyrecord_t *record)
 205 {
 206     keyevent_t event = record->event;
 207     uint8_t tap_count = record->tap_count;
 208
 209     if (IS_NOEVENT(event)) { return; }
 210
 211     action_t action = keymap_get_action(current_layer, event.key.pos.row, event.key.pos.col);
 212     //debug("action: "); debug_hex16(action.code); if (event.pressed) debug("d\n"); else debug("u\n");
 213     debug("ACTION: "); debug_action(action); debug("\n");
 214
 215     switch (action.kind.id) {
 216         /* Key and Mods */
 217         case ACT_LMODS:
 218         case ACT_RMODS:
 219             {
 220                 uint8_t mods = (action.kind.id == ACT_LMODS) ?  action.key.mods :
 221                                                                 action.key.mods<<4;
 222                 if (event.pressed) {
 223                     uint8_t tmp_mods = host_get_mods();
 224                     if (mods) {
 225                         host_add_mods(mods);
 226                         host_send_keyboard_report();
 227                     }
 228                     register_code(action.key.code);
 229                     if (mods && action.key.code) {
 230                         host_set_mods(tmp_mods);
 231                         host_send_keyboard_report();
 232                     }
 233                 } else {
 234                     if (mods && !action.key.code) {
 235                         host_del_mods(mods);
 236                         host_send_keyboard_report();
 237                     }
 238                     unregister_code(action.key.code);
 239                 }
 240             }
 241             break;
 242         case ACT_LMODS_TAP:
 243         case ACT_RMODS_TAP:
 244             {
 245                 uint8_t mods = (action.kind.id == ACT_LMODS_TAP) ?  action.key.mods :
 246                                                                     action.key.mods<<4;
 247                 switch (action.layer.code) {
 248                     case 0x00:
 249                         // Oneshot modifier
 250                         if (event.pressed) {
 251                             if (tap_count == 0) {
 252                                 debug("MODS_TAP: Oneshot: add_mods\n");
 253                                 add_mods(mods);
 254                             }
 255                             else if (tap_count == 1) {
 256                                 debug("MODS_TAP: Oneshot: start\n");
 257                                 oneshot_start(mods, event.time);
 258                             }
 259                             else if (tap_count == 5) {
 260                                 debug("MODS_TAP: Oneshot: toggle\n");
 261                                 oneshot_toggle();
 262                             }
 263                             else {
 264                                 debug("MODS_TAP: Oneshot: cancel&add_mods\n");
 265                                 // double tap cancels oneshot and works as normal modifier.
 266                                 oneshot_cancel();
 267                                 add_mods(mods);
 268                             }
 269                         } else {
 270                             if (tap_count == 0) {
 271                                 debug("MODS_TAP: Oneshot: cancel/del_mods\n");
 272                                 // cancel oneshot by holding.
 273                                 oneshot_cancel();
 274                                 del_mods(mods);
 275                             }
 276                             else if (tap_count == 1) {
 277                                 debug("MODS_TAP: Oneshot: del_mods\n");
 278                                 // retain Oneshot
 279                                 del_mods(mods);
 280                             }
 281                             else {
 282                                 debug("MODS_TAP: Oneshot: del_mods\n");
 283                                 // cancel Mods
 284                                 del_mods(mods);
 285                             }
 286                         }
 287                         break;
 288                     default:
 289                         if (event.pressed) {
 290                             if (tap_count > 0) {
 291                                 if (waiting_buffer_has_anykey_pressed()) {
 292                                     debug("MODS_TAP: Tap: Cancel: add_mods\n");
 293                                     // ad hoc: set 0 to cancel tap
 294                                     record->tap_count = 0;
 295                                     add_mods(mods);
 296                                 } else {
 297                                     debug("MODS_TAP: Tap: register_code\n");
 298                                     register_code(action.key.code);
 299                                 }
 300                             } else {
 301                                 debug("MODS_TAP: No tap: add_mods\n");
 302                                 add_mods(mods);
 303                             }
 304                         } else {
 305                             if (tap_count > 0) {
 306                                 debug("MODS_TAP: Tap: unregister_code\n");
 307                                 unregister_code(action.key.code);
 308                             } else {
 309                                 debug("MODS_TAP: No tap: add_mods\n");
 310                                 del_mods(mods);
 311                             }
 312                         }
 313                         break;
 314                 }
 315             }
 316             break;
 317
 318         /* other HID usage */
 319         case ACT_USAGE:
 320 #ifdef EXTRAKEY_ENABLE
 321             switch (action.usage.page) {
 322                 case ACTION_USAGE_PAGE_SYSTEM:
 323                     if (event.pressed) {
 324                         host_system_send(action.usage.code);
 325                     } else {
 326                         host_system_send(0);
 327                     }
 328                     break;
 329                 case ACTION_USAGE_PAGE_CONSUMER:
 330                     if (event.pressed) {
 331                         host_consumer_send(action.usage.code);
 332                     } else {
 333                         host_consumer_send(0);
 334                     }
 335                     break;
 336             }
 337 #endif
 338             break;
 339
 340         /* Mouse key */
 341         case ACT_MOUSEKEY:
 342 #ifdef MOUSEKEY_ENABLE
 343             if (event.pressed) {
 344                 mousekey_on(action.key.code);
 345                 mousekey_send();
 346             } else {
 347                 mousekey_off(action.key.code);
 348                 mousekey_send();
 349             }
 350 #endif
 351             break;
 352
 353         /* Layer key */
 354         case ACT_LAYER_PRESSED:
 355             // layer action when pressed
 356             switch (action.layer.code) {
 357                 case 0x00:
 358                     if (event.pressed) {
 359                         layer_switch(action.layer.opt);
 360                     }
 361                     break;
 362                 case 0xF0:
 363                     // tap toggle
 364                     if (event.pressed) {
 365                         if (tap_count < TAPPING_TOGGLE) {
 366                             layer_switch(action.layer.opt);
 367                         }
 368                     } else {
 369                         if (tap_count >= TAPPING_TOGGLE) {
 370                             debug("LAYER_PRESSED: tap toggle.\n");
 371                             layer_switch(action.layer.opt);
 372                         }
 373                     }
 374                     break;
 375                 case 0xFF:
 376                     // change default layer
 377                     if (event.pressed) {
 378                         default_layer = action.layer.opt;
 379                         layer_switch(default_layer);
 380                     }
 381                     break;
 382                 default:
 383                     // with tap key
 384                     if (event.pressed) {
 385                        if (tap_count > 0) {
 386                             debug("LAYER_PRESSED: Tap: register_code\n");
 387                             register_code(action.layer.code);
 388                        } else {
 389                             debug("LAYER_PRESSED: No tap: layer_switch\n");
 390                             layer_switch(action.layer.opt);
 391                        }
 392                     } else {
 393                         if (tap_count > 0) {
 394                             debug("LAYER_PRESSED: Tap: unregister_code\n");
 395                             unregister_code(action.layer.code);
 396                         } else {
 397                             debug("LAYER_PRESSED: No tap: NO ACTION\n");
 398                         }
 399                     }
 400                     break;
 401             }
 402             break;
 403         case ACT_LAYER_RELEASED:
 404             switch (action.layer.code) {
 405                 case 0x00:
 406                     if (!event.pressed) {
 407                         layer_switch(action.layer.opt);
 408                     }
 409                     break;
 410                 case 0xF0:
 411                     // tap toggle
 412                     if (event.pressed) {
 413                         if (tap_count >= TAPPING_TOGGLE) {
 414                             debug("LAYER_RELEASED: tap toggle.\n");
 415                             layer_switch(action.layer.opt);
 416                         }
 417                     } else {
 418                         if (tap_count < TAPPING_TOGGLE) {
 419                             layer_switch(action.layer.opt);
 420                         }
 421                     }
 422                     break;
 423                 case 0xFF:
 424                     // change default layer
 425                     if (!event.pressed) {
 426                         default_layer = action.layer.opt;
 427                         layer_switch(default_layer);
 428                     }
 429                     break;
 430                 default:
 431                     // with tap key
 432                     if (event.pressed) {
 433                        if (tap_count > 0) {
 434                             debug("LAYER_RELEASED: Tap: register_code\n");
 435                             register_code(action.layer.code);
 436                        } else {
 437                             debug("LAYER_RELEASED: No tap: NO ACTION\n");
 438                        }
 439                     } else {
 440                         if (tap_count > 0) {
 441                             debug("LAYER_RELEASED: Tap: unregister_code\n");
 442                             unregister_code(action.layer.code);
 443                         } else {
 444                             debug("LAYER_RELEASED: No tap: layer_switch\n");
 445                             layer_switch(action.layer.opt);
 446                         }
 447                     }
 448                     break;
 449             }
 450             break;
 451         case ACT_LAYER_BIT:
 452             switch (action.layer.code) {
 453                 case 0x00:
 454                     if (event.pressed) {
 455                         layer_switch(current_layer | action.layer.opt);
 456                     } else {
 457                         layer_switch(current_layer & ~action.layer.opt);
 458                     }
 459                     break;
 460                 case 0xF0:
 461                     // tap toggle
 462                     if (event.pressed) {
 463                         if (tap_count < TAPPING_TOGGLE) {
 464                             debug("LAYER_BIT: tap toggle(press).\n");
 465                             layer_switch(current_layer | action.layer.opt);
 466                         }
 467                     } else {
 468                         if (tap_count < TAPPING_TOGGLE) {
 469                             debug("LAYER_BIT: tap toggle(release).\n");
 470                             layer_switch(current_layer & ~action.layer.opt);
 471                         } else {
 472                             debug("LAYER_BIT: tap toggle.\n");
 473                             layer_switch(current_layer | action.layer.opt);
 474                         }
 475                     }
 476                     break;
 477                 case 0xFF:
 478                     // change default layer
 479                     if (event.pressed) {
 480                         default_layer = current_layer | action.layer.opt;
 481                         layer_switch(default_layer);
 482                     } else {
 483                         default_layer = current_layer & ~action.layer.opt;
 484                         layer_switch(default_layer);
 485                     }
 486                     break;
 487                 default:
 488                     // with tap key
 489                     if (event.pressed) {
 490                         if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
 491                             debug("LAYER_BIT: Tap: register_code\n");
 492                             register_code(action.layer.code);
 493                         } else {
 494                             debug("LAYER_BIT: No tap: layer_switch(bit on)\n");
 495                             layer_switch(current_layer | action.layer.opt);
 496                         }
 497                     } else {
 498                         if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
 499                             debug("LAYER_BIT: Tap: unregister_code\n");
 500                             unregister_code(action.layer.code);
 501                         } else {
 502                             debug("LAYER_BIT: No tap: layer_switch(bit off)\n");
 503                             layer_switch(current_layer & ~action.layer.opt);
 504                         }
 505                     }
 506                     break;
 507             }
 508             break;
 509         case ACT_LAYER_EXT:
 510             switch (action.layer.opt) {
 511                 case 0x00:
 512                     // set default layer when pressed
 513                     switch (action.layer.code) {
 514                         case 0x00:
 515                             if (event.pressed) {
 516                                 layer_switch(default_layer);
 517                             }
 518                             break;
 519                         case 0xF0:
 520                             // tap toggle
 521                             if (event.pressed) {
 522                                 if (tap_count < TAPPING_TOGGLE) {
 523                                     layer_switch(default_layer);
 524                                 }
 525                             } else {
 526                                 if (tap_count >= TAPPING_TOGGLE) {
 527                                     debug("LAYER_EXT_PRESSED: tap toggle.\n");
 528                                     layer_switch(default_layer);
 529                                 }
 530                             }
 531                             break;
 532                         case 0xFF:
 533                             // change default layer
 534                             if (event.pressed) {
 535                                 default_layer = current_layer;
 536                                 layer_switch(default_layer);
 537                             }
 538                             break;
 539                         default:
 540                             // with tap key
 541                             if (event.pressed) {
 542                                if (tap_count > 0) {
 543                                     debug("LAYER_EXT_PRESSED: Tap: register_code\n");
 544                                     register_code(action.layer.code);
 545                                } else {
 546                                     debug("LAYER_EXT_PRESSED: No tap: layer_switch\n");
 547                                     layer_switch(default_layer);
 548                                }
 549                             } else {
 550                                 if (tap_count > 0) {
 551                                     debug("LAYER_EXT_PRESSED: Tap: unregister_code\n");
 552                                     unregister_code(action.layer.code);
 553                                 } else {
 554                                     debug("LAYER_EXT_PRESSED: No tap: NO ACTION\n");
 555                                 }
 556                             }
 557                             break;
 558                     }
 559                     break;
 560                 case 0x01:
 561                     // set default layer when released
 562                     switch (action.layer.code) {
 563                         case 0x00:
 564                             if (!event.pressed) {
 565                                 layer_switch(default_layer);
 566                             }
 567                             break;
 568                         case 0xF0:
 569                             // tap toggle
 570                             if (event.pressed) {
 571                                 if (tap_count >= TAPPING_TOGGLE) {
 572                                     debug("LAYER_EXT_RELEASED: tap toggle.\n");
 573                                     layer_switch(default_layer);
 574                                 }
 575                             } else {
 576                                 if (tap_count < TAPPING_TOGGLE) {
 577                                     layer_switch(default_layer);
 578                                 }
 579                             }
 580                             break;
 581                         case 0xFF:
 582                             // change default layer
 583                             if (!event.pressed) {
 584                                 default_layer = current_layer;
 585                                 layer_switch(default_layer);
 586                             }
 587                             break;
 588                         default:
 589                             // with tap key
 590                             if (event.pressed) {
 591                                if (tap_count > 0) {
 592                                     debug("LAYER_EXT_RELEASED: Tap: register_code\n");
 593                                     register_code(action.layer.code);
 594                                } else {
 595                                     debug("LAYER_EXT_RELEASED: No tap: NO ACTION\n");
 596                                }
 597                             } else {
 598                                 if (tap_count > 0) {
 599                                     debug("LAYER_EXT_RELEASED: Tap: unregister_code\n");
 600                                     unregister_code(action.layer.code);
 601                                 } else {
 602                                     debug("LAYER_EXT_RELEASED: No tap: layer_switch\n");
 603                                     layer_switch(default_layer);
 604                                 }
 605                             }
 606                             break;
 607                     }
 608                     break;
 609             }
 610             break;
 611
 612         /* Extentions */
 613         case ACT_MACRO:
 614             break;
 615         case ACT_COMMAND:
 616             break;
 617         case ACT_FUNCTION:
 618             // TODO
 619             action_call_function(event, action.func.id);
 620             break;
 621         default:
 622             break;
 623     }
 624 }
 625
 626 /* Tapping
 627  *
 628  * Rule: Tap key is typed(pressed and released) within TAPPING_TERM.
 629  *       (without interfering by typing other key)
 630  */
 631 /* return true when key event is processed or consumed. */
 632 static bool process_tapping(keyrecord_t *keyp)
 633 {
 634     keyevent_t event = keyp->event;
 635
 636     // if tapping
 637     if (IS_TAPPING_PRESSED()) {
 638         if (WITHIN_TAPPING_TERM(event)) {
 639             if (tapping_key.tap_count == 0) {
 640                 if (IS_TAPPING_KEY(event.key) && !event.pressed) {
 641                     // first tap!
 642                     debug("Tapping: First tap(0->1).\n");
 643                     tapping_key.tap_count = 1;
 644                     debug_tapping_key();
 645                     process_action(&tapping_key);
 646
 647                     // enqueue
 648                     keyp->tap_count = tapping_key.tap_count;
 649                     return false;
 650                 }
 651 #if TAPPING_TERM >= 500
 652                 /* This can prevent from typing some tap keys in a row at a time. */
 653                 else if (!event.pressed && waiting_buffer_typed(event)) {
 654                     // other key typed. not tap.
 655                     debug("Tapping: End. No tap. Interfered by typing key\n");
 656                     process_action(&tapping_key);
 657                     tapping_key = (keyrecord_t){};
 658                     debug_tapping_key();
 659
 660                     // enqueue
 661                     return false;
 662                 }
 663 #endif
 664                 else {
 665                     // other key events shall be enq'd till tapping state settles.
 666                     return false;
 667                 }
 668             }
 669             // tap_count > 0
 670             else {
 671                 if (IS_TAPPING_KEY(event.key) && !event.pressed) {
 672                     debug("Tapping: Tap release("); debug_dec(tapping_key.tap_count); debug(")\n");
 673                     keyp->tap_count = tapping_key.tap_count;
 674                     process_action(keyp);
 675                     tapping_key = *keyp;
 676                     debug_tapping_key();
 677                     return true;
 678                 }
 679                 else if (is_tap_key(keyp->event.key) && event.pressed) {
 680                     if (tapping_key.tap_count > 1) {
 681                         debug("Tapping: Start new tap with releasing last tap(>1).\n");
 682                         // unregister key
 683                         process_action(&(keyrecord_t){
 684                                 .tap_count = tapping_key.tap_count,
 685                                 .event.key = tapping_key.event.key,
 686                                 .event.time = event.time,
 687                                 .event.pressed = false
 688                         });
 689                     } else {
 690                         debug("Tapping: Start while last tap(1).\n");
 691                     }
 692                     tapping_key = *keyp;
 693                     waiting_buffer_scan_tap();
 694                     debug_tapping_key();
 695                     return true;
 696                 }
 697                 else {
 698                     if (!IS_NOEVENT(keyp->event)) {
 699                         debug("Tapping: key event while last tap(>0).\n");
 700                     }
 701                     process_action(keyp);
 702                     return true;
 703                 }
 704             }
 705         }
 706         // after TAPPING_TERM
 707         else {
 708             if (tapping_key.tap_count == 0) {
 709                 debug("Tapping: End. Timeout. Not tap(0): ");
 710                 debug_event(event); debug("\n");
 711                 process_action(&tapping_key);
 712                 tapping_key = (keyrecord_t){};
 713                 debug_tapping_key();
 714                 return false;
 715             }  else {
 716                 if (IS_TAPPING_KEY(event.key) && !event.pressed) {
 717                     debug("Tapping: End. last timeout tap release(>0).");
 718                     keyp->tap_count = tapping_key.tap_count;
 719                     process_action(keyp);
 720                     tapping_key = (keyrecord_t){};
 721                     return true;
 722                 }
 723                 else if (is_tap_key(keyp->event.key) && event.pressed) {
 724                     if (tapping_key.tap_count > 1) {
 725                         debug("Tapping: Start new tap with releasing last timeout tap(>1).\n");
 726                         // unregister key
 727                         process_action(&(keyrecord_t){
 728                                 .tap_count = tapping_key.tap_count,
 729                                 .event.key = tapping_key.event.key,
 730                                 .event.time = event.time,
 731                                 .event.pressed = false
 732                         });
 733                     } else {
 734                         debug("Tapping: Start while last timeout tap(1).\n");
 735                     }
 736                     tapping_key = *keyp;
 737                     waiting_buffer_scan_tap();
 738                     debug_tapping_key();
 739                     return true;
 740                 }
 741                 else {
 742                     if (!IS_NOEVENT(keyp->event)) {
 743                         debug("Tapping: key event while last timeout tap(>0).\n");
 744                     }
 745                     process_action(keyp);
 746                     return true;
 747                 }
 748             }
 749         }
 750     } else if (IS_TAPPING_RELEASED()) {
 751         if (WITHIN_TAPPING_TERM(event)) {
 752             if (tapping_key.tap_count > 0 && IS_TAPPING_KEY(event.key) && event.pressed) {
 753                 // sequential tap.
 754                 keyp->tap_count = tapping_key.tap_count + 1;
 755                 debug("Tapping: Tap press("); debug_dec(keyp->tap_count); debug(")\n");
 756                 process_action(keyp);
 757                 tapping_key = *keyp;
 758                 debug_tapping_key();
 759                 return true;
 760             } else if (event.pressed && is_tap_key(event.key)) {
 761                 // Sequential tap can be interfered with other tap key.
 762                 debug("Tapping: Start with interfering other tap.\n");
 763                 tapping_key = *keyp;
 764                 waiting_buffer_scan_tap();
 765                 debug_tapping_key();
 766                 return true;
 767             } else {
 768                 if (!IS_NOEVENT(keyp->event)) debug("Tapping: other key just after tap.\n");
 769                 process_action(keyp);
 770                 return true;
 771             }
 772         } else {
 773             // timeout. no sequential tap.
 774             debug("Tapping: End(Timeout after releasing last tap): ");
 775             debug_event(event); debug("\n");
 776             tapping_key = (keyrecord_t){};
 777             debug_tapping_key();
 778             process_action(keyp);
 779             return true;
 780         }
 781     }
 782     // not tapping satate
 783     else {
 784         if (event.pressed && is_tap_key(event.key)) {
 785             debug("Tapping: Start(Press tap key).\n");
 786             tapping_key = *keyp;
 787             waiting_buffer_scan_tap();
 788             debug_tapping_key();
 789             return true;
 790         } else {
 791             process_action(keyp);
 792             return true;
 793         }
 794     }
 795 }
 796
 797 /* scan buffer for tapping */
 798 static void waiting_buffer_scan_tap(void)
 799 {
 800     // tapping already is settled
 801     if (tapping_key.tap_count > 0) return;
 802     // invalid state: tapping_key released && tap_count == 0
 803     if (!tapping_key.event.pressed) return;
 804
 805     for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
 806         if (IS_TAPPING_KEY(waiting_buffer[i].event.key) &&
 807                 !waiting_buffer[i].event.pressed &&
 808                 WITHIN_TAPPING_TERM(waiting_buffer[i].event)) {
 809             tapping_key.tap_count = 1;
 810             waiting_buffer[i].tap_count = 1;
 811             process_action(&tapping_key);
 812
 813             debug("waiting_buffer_scan_tap: found at ["); debug_dec(i); debug("]\n");
 814             debug_waiting_buffer();
 815             return;
 816         }
 817     }
 818 }
 819
 820
 821
 822 /*
 823  * Utilities for actions.
 824  */
 825 void register_code(uint8_t code)
 826 {
 827     if (code == KC_NO) {
 828         return;
 829     }
 830     else if IS_KEY(code) {
 831         // TODO: should push command_proc out of this block?
 832         if (command_proc(code)) return;
 833
 834         if (oneshot_state.mods && oneshot_state.ready && !oneshot_state.disabled) {
 835             uint8_t tmp_mods = host_get_mods();
 836             host_add_mods(oneshot_state.mods);
 837             host_add_key(code);
 838             host_send_keyboard_report();
 839
 840             host_set_mods(tmp_mods);
 841             oneshot_state.ready = false;
 842         } else {
 843             host_add_key(code);
 844             host_send_keyboard_report();
 845         }
 846     }
 847     else if IS_MOD(code) {
 848         host_add_mods(MOD_BIT(code));
 849         host_send_keyboard_report();
 850     }
 851 }
 852
 853 void unregister_code(uint8_t code)
 854 {
 855     if IS_KEY(code) {
 856         host_del_key(code);
 857         host_send_keyboard_report();
 858     }
 859     else if IS_MOD(code) {
 860         host_del_mods(MOD_BIT(code));
 861         host_send_keyboard_report();
 862     }
 863 }
 864
 865 void add_mods(uint8_t mods)
 866 {
 867     if (mods) {
 868         host_add_mods(mods);
 869         host_send_keyboard_report();
 870     }
 871 }
 872
 873 void del_mods(uint8_t mods)
 874 {
 875     if (mods) {
 876         host_del_mods(mods);
 877         host_send_keyboard_report();
 878     }
 879 }
 880
 881 void set_mods(uint8_t mods)
 882 {
 883     host_set_mods(mods);
 884     host_send_keyboard_report();
 885 }
 886
 887 void clear_keyboard(void)
 888 {
 889     host_clear_mods();
 890     clear_keyboard_but_mods();
 891 }
 892
 893 void clear_keyboard_but_mods(void)
 894 {
 895     host_clear_keys();
 896     host_send_keyboard_report();
 897 #ifdef MOUSEKEY_ENABLE
 898     mousekey_clear();
 899     mousekey_send();
 900 #endif
 901 #ifdef EXTRAKEY_ENABLE
 902     host_system_send(0);
 903     host_consumer_send(0);
 904 #endif
 905 }
 906
 907 bool sending_anykey(void)
 908 {
 909     return (host_has_anykey() || host_mouse_in_use() ||
 910             host_last_sysytem_report() || host_last_consumer_report());
 911 }
 912
 913 void layer_switch(uint8_t new_layer)
 914 {
 915     if (current_layer != new_layer) {
 916         debug("Layer Switch: "); debug_hex(current_layer);
 917         debug(" -> "); debug_hex(new_layer); debug("\n");
 918
 919         current_layer = new_layer;
 920         clear_keyboard_but_mods(); // To avoid stuck keys
 921         // NOTE: update mods with full scan of matrix? if modifier changes between layers
 922     }
 923 }
 924
 925 bool is_tap_key(key_t key)
 926 {
 927     action_t action = keymap_get_action(current_layer, key.pos.row, key.pos.col);
 928     switch (action.kind.id) {
 929         case ACT_LMODS_TAP:
 930         case ACT_RMODS_TAP:
 931             return true;
 932         case ACT_LAYER_PRESSED:
 933         case ACT_LAYER_BIT:
 934             switch (action.layer.code) {
 935                 case 0x00:
 936                 case 0xF1 ... 0xFF:
 937                     return false;
 938                 case 0xF0:
 939                 default:
 940                     return true;
 941             }
 942             return false;
 943         case ACT_FUNCTION:
 944             if (action.func.opt & 0x1) {
 945                 return true;
 946             }
 947             return false;
 948     }
 949     return false;
 950 }
 951
 952
 953 /*
 954  * debug print
 955  */
 956 static void debug_event(keyevent_t event)
 957 {
 958     debug_hex16(event.key.raw);
 959     if (event.pressed) debug("d("); else debug("u(");
 960     debug_dec(event.time); debug(")");
 961 }
 962 static void debug_record(keyrecord_t record)
 963 {
 964     debug_event(record.event); debug(":"); debug_dec(record.tap_count);
 965 }
 966 static void debug_action(action_t action)
 967 {
 968     switch (action.kind.id) {
 969         case ACT_LMODS:             debug("ACT_LMODS");             break;
 970         case ACT_RMODS:             debug("ACT_RMODS");             break;
 971         case ACT_LMODS_TAP:         debug("ACT_LMODS_TAP");         break;
 972         case ACT_RMODS_TAP:         debug("ACT_RMODS_TAP");         break;
 973         case ACT_USAGE:             debug("ACT_USAGE");             break;
 974         case ACT_MOUSEKEY:          debug("ACT_MOUSEKEY");          break;
 975         case ACT_LAYER_PRESSED:     debug("ACT_LAYER_PRESSED");     break;
 976         case ACT_LAYER_RELEASED:    debug("ACT_LAYER_RELEASED");    break;
 977         case ACT_LAYER_BIT:         debug("ACT_LAYER_BIT");         break;
 978         case ACT_LAYER_EXT:         debug("ACT_LAYER_EXT");         break;
 979         case ACT_MACRO:             debug("ACT_MACRO");             break;
 980         case ACT_COMMAND:           debug("ACT_COMMAND");           break;
 981         case ACT_FUNCTION:          debug("ACT_FUNCTION");          break;
 982         default:                    debug("UNKNOWN");               break;
 983     }
 984     debug("[");
 985     debug_hex4(action.kind.param>>8);
 986     debug(":");
 987     debug_hex8(action.kind.param & 0xff);
 988     debug("]");
 989 }
 990 static void debug_tapping_key(void)
 991 {
 992     debug("TAPPING_KEY="); debug_record(tapping_key); debug("\n");
 993 }
 994 static void debug_waiting_buffer(void)
 995 {
 996     debug("{ ");
 997     for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
 998         debug("["); debug_dec(i); debug("]="); debug_record(waiting_buffer[i]); debug(" ");
 999     }
1000     debug("}\n");
1001 }