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 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 == TAPPING_TOGGLE) {
 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.val);
 360                     }
 361 //TODO: this is ok?
 362                     else {
 363                         layer_switch(default_layer);
 364                     }
 365                     break;
 366                 case 0xF0:
 367                     // tap toggle
 368                     if (event.pressed) {
 369                         if (tap_count < TAPPING_TOGGLE) {
 370                             layer_switch(action.layer.val);
 371                         }
 372                     } else {
 373                         if (tap_count >= TAPPING_TOGGLE) {
 374                             debug("LAYER_PRESSED: tap toggle.\n");
 375                             layer_switch(action.layer.val);
 376                         }
 377                     }
 378                     break;
 379                 case 0xFF:
 380                     // change default layer
 381                     if (event.pressed) {
 382                         default_layer = action.layer.val;
 383                         layer_switch(default_layer);
 384                     }
 385                     break;
 386                 default:
 387                     // with tap key
 388                     if (event.pressed) {
 389                        if (tap_count > 0) {
 390                             debug("LAYER_PRESSED: Tap: register_code\n");
 391                             register_code(action.layer.code);
 392                        } else {
 393                             debug("LAYER_PRESSED: No tap: layer_switch\n");
 394                             layer_switch(action.layer.val);
 395                        }
 396                     } else {
 397                         if (tap_count > 0) {
 398                             debug("LAYER_PRESSED: Tap: unregister_code\n");
 399                             unregister_code(action.layer.code);
 400                         } else {
 401                             //debug("LAYER_PRESSED: No tap: NO ACTION\n");
 402 //TODO: this is ok?
 403                             debug("LAYER_PRESSED: No tap: return to default layer\n");
 404                             layer_switch(default_layer);
 405                         }
 406                     }
 407                     break;
 408             }
 409             break;
 410         case ACT_LAYER_RELEASED:
 411             switch (action.layer.code) {
 412                 case 0x00:
 413                     if (!event.pressed) {
 414                         layer_switch(action.layer.val);
 415                     }
 416                     break;
 417                 case 0xF0:
 418                     // tap toggle
 419                     if (event.pressed) {
 420                         if (tap_count >= TAPPING_TOGGLE) {
 421                             debug("LAYER_RELEASED: tap toggle.\n");
 422                             layer_switch(action.layer.val);
 423                         }
 424                     } else {
 425                         if (tap_count < TAPPING_TOGGLE) {
 426                             layer_switch(action.layer.val);
 427                         }
 428                     }
 429                     break;
 430                 case 0xFF:
 431                     // change default layer
 432                     if (!event.pressed) {
 433                         default_layer = action.layer.val;
 434                         layer_switch(default_layer);
 435                     }
 436                     break;
 437                 default:
 438                     // with tap key
 439                     if (event.pressed) {
 440                        if (tap_count > 0) {
 441                             debug("LAYER_RELEASED: Tap: register_code\n");
 442                             register_code(action.layer.code);
 443                        } else {
 444                             debug("LAYER_RELEASED: No tap: NO ACTION\n");
 445                        }
 446                     } else {
 447                         if (tap_count > 0) {
 448                             debug("LAYER_RELEASED: Tap: unregister_code\n");
 449                             unregister_code(action.layer.code);
 450                         } else {
 451                             debug("LAYER_RELEASED: No tap: layer_switch\n");
 452                             layer_switch(action.layer.val);
 453                         }
 454                     }
 455                     break;
 456             }
 457             break;
 458         case ACT_LAYER_BIT:
 459             switch (action.layer.code) {
 460                 case 0x00:
 461                     if (event.pressed) {
 462                         layer_switch(current_layer ^ action.layer.val);
 463                     } else {
 464                         layer_switch(current_layer ^ action.layer.val);
 465                     }
 466                     break;
 467                 case 0xF0:
 468                     // tap toggle
 469                     if (event.pressed) {
 470                         if (tap_count < TAPPING_TOGGLE) {
 471                             debug("LAYER_BIT: tap toggle(press).\n");
 472                             layer_switch(current_layer ^ action.layer.val);
 473                         }
 474                     } else {
 475                         if (tap_count <= TAPPING_TOGGLE) {
 476                             debug("LAYER_BIT: tap toggle(release).\n");
 477                             layer_switch(current_layer ^ action.layer.val);
 478                         }
 479                     }
 480                     break;
 481                 case 0xFF:
 482                     // change default layer
 483                     if (event.pressed) {
 484                         default_layer = current_layer ^ action.layer.val;
 485                         layer_switch(default_layer);
 486                     } else {
 487                         default_layer = current_layer ^ action.layer.val;
 488                         layer_switch(default_layer);
 489                     }
 490                     break;
 491                 default:
 492                     // with tap key
 493                     if (event.pressed) {
 494                         if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
 495                             debug("LAYER_BIT: Tap: register_code\n");
 496                             register_code(action.layer.code);
 497                         } else {
 498                             debug("LAYER_BIT: No tap: layer_switch(bit on)\n");
 499                             layer_switch(current_layer ^ action.layer.val);
 500                         }
 501                     } else {
 502                         if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
 503                             debug("LAYER_BIT: Tap: unregister_code\n");
 504                             unregister_code(action.layer.code);
 505                         } else {
 506                             debug("LAYER_BIT: No tap: layer_switch(bit off)\n");
 507                             layer_switch(current_layer ^ action.layer.val);
 508                         }
 509                     }
 510                     break;
 511             }
 512             break;
 513         case ACT_LAYER_EXT:
 514             switch (action.layer.val) {
 515                 case 0x00:
 516                     // set default layer when pressed
 517                     switch (action.layer.code) {
 518                         case 0x00:
 519                             if (event.pressed) {
 520                                 layer_switch(default_layer);
 521                             }
 522                             break;
 523                         case 0xF0:
 524                             // tap toggle
 525                             if (event.pressed) {
 526                                 if (tap_count < TAPPING_TOGGLE) {
 527                                     layer_switch(default_layer);
 528                                 }
 529                             } else {
 530                                 if (tap_count >= TAPPING_TOGGLE) {
 531                                     debug("LAYER_EXT_PRESSED: tap toggle.\n");
 532                                     layer_switch(default_layer);
 533                                 }
 534                             }
 535                             break;
 536                         case 0xFF:
 537                             // change default layer
 538                             if (event.pressed) {
 539                                 default_layer = current_layer;
 540                                 layer_switch(default_layer);
 541                             }
 542                             break;
 543                         default:
 544                             // with tap key
 545                             if (event.pressed) {
 546                                if (tap_count > 0) {
 547                                     debug("LAYER_EXT_PRESSED: Tap: register_code\n");
 548                                     register_code(action.layer.code);
 549                                } else {
 550                                     debug("LAYER_EXT_PRESSED: No tap: layer_switch\n");
 551                                     layer_switch(default_layer);
 552                                }
 553                             } else {
 554                                 if (tap_count > 0) {
 555                                     debug("LAYER_EXT_PRESSED: Tap: unregister_code\n");
 556                                     unregister_code(action.layer.code);
 557                                 } else {
 558                                     debug("LAYER_EXT_PRESSED: No tap: NO ACTION\n");
 559                                 }
 560                             }
 561                             break;
 562                     }
 563                     break;
 564                 case 0x01:
 565                     // set default layer when released
 566                     switch (action.layer.code) {
 567                         case 0x00:
 568                             if (!event.pressed) {
 569                                 layer_switch(default_layer);
 570                             }
 571                             break;
 572                         case 0xF0:
 573                             // tap toggle
 574                             if (event.pressed) {
 575                                 if (tap_count >= TAPPING_TOGGLE) {
 576                                     debug("LAYER_EXT_RELEASED: tap toggle.\n");
 577                                     layer_switch(default_layer);
 578                                 }
 579                             } else {
 580                                 if (tap_count < TAPPING_TOGGLE) {
 581                                     layer_switch(default_layer);
 582                                 }
 583                             }
 584                             break;
 585                         case 0xFF:
 586                             // change default layer
 587                             if (!event.pressed) {
 588                                 default_layer = current_layer;
 589                                 layer_switch(default_layer);
 590                             }
 591                             break;
 592                         default:
 593                             // with tap key
 594                             if (event.pressed) {
 595                                if (tap_count > 0) {
 596                                     debug("LAYER_EXT_RELEASED: Tap: register_code\n");
 597                                     register_code(action.layer.code);
 598                                } else {
 599                                     debug("LAYER_EXT_RELEASED: No tap: NO ACTION\n");
 600                                }
 601                             } else {
 602                                 if (tap_count > 0) {
 603                                     debug("LAYER_EXT_RELEASED: Tap: unregister_code\n");
 604                                     unregister_code(action.layer.code);
 605                                 } else {
 606                                     debug("LAYER_EXT_RELEASED: No tap: layer_switch\n");
 607                                     layer_switch(default_layer);
 608                                 }
 609                             }
 610                             break;
 611                     }
 612                     break;
 613             }
 614             break;
 615
 616         /* Extentions */
 617         case ACT_MACRO:
 618             break;
 619         case ACT_COMMAND:
 620             break;
 621         case ACT_FUNCTION:
 622             // TODO
 623             keymap_call_function(record, action.func.id, action.func.opt);
 624             break;
 625         default:
 626             break;
 627     }
 628 }
 629
 630 /* Tapping
 631  *
 632  * Rule: Tap key is typed(pressed and released) within TAPPING_TERM.
 633  *       (without interfering by typing other key)
 634  */
 635 /* return true when key event is processed or consumed. */
 636 static bool process_tapping(keyrecord_t *keyp)
 637 {
 638     keyevent_t event = keyp->event;
 639
 640     // if tapping
 641     if (IS_TAPPING_PRESSED()) {
 642         if (WITHIN_TAPPING_TERM(event)) {
 643             if (tapping_key.tap_count == 0) {
 644                 if (IS_TAPPING_KEY(event.key) && !event.pressed) {
 645                     // first tap!
 646                     debug("Tapping: First tap(0->1).\n");
 647                     tapping_key.tap_count = 1;
 648                     debug_tapping_key();
 649                     process_action(&tapping_key);
 650
 651                     // enqueue
 652                     keyp->tap_count = tapping_key.tap_count;
 653                     return false;
 654                 }
 655 #if TAPPING_TERM >= 500
 656                 /* This can prevent from typing some tap keys in a row at a time. */
 657                 else if (!event.pressed && waiting_buffer_typed(event)) {
 658                     // other key typed. not tap.
 659                     debug("Tapping: End. No tap. Interfered by typing key\n");
 660                     process_action(&tapping_key);
 661                     tapping_key = (keyrecord_t){};
 662                     debug_tapping_key();
 663
 664                     // enqueue
 665                     return false;
 666                 }
 667 #endif
 668                 else {
 669                     // other key events shall be enq'd till tapping state settles.
 670                     return false;
 671                 }
 672             }
 673             // tap_count > 0
 674             else {
 675                 if (IS_TAPPING_KEY(event.key) && !event.pressed) {
 676                     debug("Tapping: Tap release("); debug_dec(tapping_key.tap_count); debug(")\n");
 677                     keyp->tap_count = tapping_key.tap_count;
 678                     process_action(keyp);
 679                     tapping_key = *keyp;
 680                     debug_tapping_key();
 681                     return true;
 682                 }
 683                 else if (is_tap_key(keyp->event.key) && event.pressed) {
 684                     if (tapping_key.tap_count > 1) {
 685                         debug("Tapping: Start new tap with releasing last tap(>1).\n");
 686                         // unregister key
 687                         process_action(&(keyrecord_t){
 688                                 .tap_count = tapping_key.tap_count,
 689                                 .event.key = tapping_key.event.key,
 690                                 .event.time = event.time,
 691                                 .event.pressed = false
 692                         });
 693                     } else {
 694                         debug("Tapping: Start while last tap(1).\n");
 695                     }
 696                     tapping_key = *keyp;
 697                     waiting_buffer_scan_tap();
 698                     debug_tapping_key();
 699                     return true;
 700                 }
 701                 else {
 702                     if (!IS_NOEVENT(keyp->event)) {
 703                         debug("Tapping: key event while last tap(>0).\n");
 704                     }
 705                     process_action(keyp);
 706                     return true;
 707                 }
 708             }
 709         }
 710         // after TAPPING_TERM
 711         else {
 712             if (tapping_key.tap_count == 0) {
 713                 debug("Tapping: End. Timeout. Not tap(0): ");
 714                 debug_event(event); debug("\n");
 715                 process_action(&tapping_key);
 716                 tapping_key = (keyrecord_t){};
 717                 debug_tapping_key();
 718                 return false;
 719             }  else {
 720                 if (IS_TAPPING_KEY(event.key) && !event.pressed) {
 721                     debug("Tapping: End. last timeout tap release(>0).");
 722                     keyp->tap_count = tapping_key.tap_count;
 723                     process_action(keyp);
 724                     tapping_key = (keyrecord_t){};
 725                     return true;
 726                 }
 727                 else if (is_tap_key(keyp->event.key) && event.pressed) {
 728                     if (tapping_key.tap_count > 1) {
 729                         debug("Tapping: Start new tap with releasing last timeout tap(>1).\n");
 730                         // unregister key
 731                         process_action(&(keyrecord_t){
 732                                 .tap_count = tapping_key.tap_count,
 733                                 .event.key = tapping_key.event.key,
 734                                 .event.time = event.time,
 735                                 .event.pressed = false
 736                         });
 737                     } else {
 738                         debug("Tapping: Start while last timeout tap(1).\n");
 739                     }
 740                     tapping_key = *keyp;
 741                     waiting_buffer_scan_tap();
 742                     debug_tapping_key();
 743                     return true;
 744                 }
 745                 else {
 746                     if (!IS_NOEVENT(keyp->event)) {
 747                         debug("Tapping: key event while last timeout tap(>0).\n");
 748                     }
 749                     process_action(keyp);
 750                     return true;
 751                 }
 752             }
 753         }
 754     } else if (IS_TAPPING_RELEASED()) {
 755         if (WITHIN_TAPPING_TERM(event)) {
 756             if (tapping_key.tap_count > 0 && IS_TAPPING_KEY(event.key) && event.pressed) {
 757                 // sequential tap.
 758                 keyp->tap_count = tapping_key.tap_count + 1;
 759                 debug("Tapping: Tap press("); debug_dec(keyp->tap_count); debug(")\n");
 760                 process_action(keyp);
 761                 tapping_key = *keyp;
 762                 debug_tapping_key();
 763                 return true;
 764             } else if (event.pressed && is_tap_key(event.key)) {
 765                 // Sequential tap can be interfered with other tap key.
 766                 debug("Tapping: Start with interfering other tap.\n");
 767                 tapping_key = *keyp;
 768                 waiting_buffer_scan_tap();
 769                 debug_tapping_key();
 770                 return true;
 771             } else {
 772                 if (!IS_NOEVENT(keyp->event)) debug("Tapping: other key just after tap.\n");
 773                 process_action(keyp);
 774                 return true;
 775             }
 776         } else {
 777             // timeout. no sequential tap.
 778             debug("Tapping: End(Timeout after releasing last tap): ");
 779             debug_event(event); debug("\n");
 780             tapping_key = (keyrecord_t){};
 781             debug_tapping_key();
 782             return false;
 783         }
 784     }
 785     // not tapping satate
 786     else {
 787         if (event.pressed && is_tap_key(event.key)) {
 788             debug("Tapping: Start(Press tap key).\n");
 789             tapping_key = *keyp;
 790             waiting_buffer_scan_tap();
 791             debug_tapping_key();
 792             return true;
 793         } else {
 794             process_action(keyp);
 795             return true;
 796         }
 797     }
 798 }
 799
 800 /* scan buffer for tapping */
 801 static void waiting_buffer_scan_tap(void)
 802 {
 803     // tapping already is settled
 804     if (tapping_key.tap_count > 0) return;
 805     // invalid state: tapping_key released && tap_count == 0
 806     if (!tapping_key.event.pressed) return;
 807
 808     for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
 809         if (IS_TAPPING_KEY(waiting_buffer[i].event.key) &&
 810                 !waiting_buffer[i].event.pressed &&
 811                 WITHIN_TAPPING_TERM(waiting_buffer[i].event)) {
 812             tapping_key.tap_count = 1;
 813             waiting_buffer[i].tap_count = 1;
 814             process_action(&tapping_key);
 815
 816             debug("waiting_buffer_scan_tap: found at ["); debug_dec(i); debug("]\n");
 817             debug_waiting_buffer();
 818             return;
 819         }
 820     }
 821 }
 822
 823
 824
 825 /*
 826  * Utilities for actions.
 827  */
 828 void register_code(uint8_t code)
 829 {
 830     if (code == KC_NO) {
 831         return;
 832     }
 833     else if IS_KEY(code) {
 834         // TODO: should push command_proc out of this block?
 835         if (command_proc(code)) return;
 836
 837         if (oneshot_state.mods && oneshot_state.ready && !oneshot_state.disabled) {
 838             uint8_t tmp_mods = host_get_mods();
 839             host_add_mods(oneshot_state.mods);
 840             host_add_key(code);
 841             host_send_keyboard_report();
 842
 843             host_set_mods(tmp_mods);
 844             oneshot_state.ready = false;
 845         } else {
 846             host_add_key(code);
 847             host_send_keyboard_report();
 848         }
 849     }
 850     else if IS_MOD(code) {
 851         host_add_mods(MOD_BIT(code));
 852         host_send_keyboard_report();
 853     }
 854 }
 855
 856 void unregister_code(uint8_t code)
 857 {
 858     if IS_KEY(code) {
 859         host_del_key(code);
 860         host_send_keyboard_report();
 861     }
 862     else if IS_MOD(code) {
 863         host_del_mods(MOD_BIT(code));
 864         host_send_keyboard_report();
 865     }
 866 }
 867
 868 void add_mods(uint8_t mods)
 869 {
 870     if (mods) {
 871         host_add_mods(mods);
 872         host_send_keyboard_report();
 873     }
 874 }
 875
 876 void del_mods(uint8_t mods)
 877 {
 878     if (mods) {
 879         host_del_mods(mods);
 880         host_send_keyboard_report();
 881     }
 882 }
 883
 884 void set_mods(uint8_t mods)
 885 {
 886     host_set_mods(mods);
 887     host_send_keyboard_report();
 888 }
 889
 890 void clear_keyboard(void)
 891 {
 892     host_clear_mods();
 893     clear_keyboard_but_mods();
 894 }
 895
 896 void clear_keyboard_but_mods(void)
 897 {
 898     host_clear_keys();
 899     host_send_keyboard_report();
 900 #ifdef MOUSEKEY_ENABLE
 901     mousekey_clear();
 902     mousekey_send();
 903 #endif
 904 #ifdef EXTRAKEY_ENABLE
 905     host_system_send(0);
 906     host_consumer_send(0);
 907 #endif
 908 }
 909
 910 bool sending_anykey(void)
 911 {
 912     return (host_has_anykey() || host_mouse_in_use() ||
 913             host_last_sysytem_report() || host_last_consumer_report());
 914 }
 915
 916 void layer_switch(uint8_t new_layer)
 917 {
 918     if (current_layer != new_layer) {
 919         debug("Layer Switch: "); debug_hex(current_layer);
 920         debug(" -> "); debug_hex(new_layer); debug("\n");
 921
 922         current_layer = new_layer;
 923         clear_keyboard_but_mods(); // To avoid stuck keys
 924         // NOTE: update mods with full scan of matrix? if modifier changes between layers
 925     }
 926 }
 927
 928 bool is_tap_key(key_t key)
 929 {
 930     action_t action = keymap_get_action(current_layer, key.pos.row, key.pos.col);
 931     switch (action.kind.id) {
 932         case ACT_LMODS_TAP:
 933         case ACT_RMODS_TAP:
 934             return true;
 935         case ACT_LAYER_PRESSED:
 936         case ACT_LAYER_BIT:
 937             switch (action.layer.code) {
 938                 case 0x00:
 939                 case 0xF1 ... 0xFF:
 940                     return false;
 941                 case 0xF0:
 942                 default:
 943                     return true;
 944             }
 945             return false;
 946         case ACT_FUNCTION:
 947             if (action.func.opt & O_TAP) {
 948                 return true;
 949             }
 950             return false;
 951     }
 952     return false;
 953 }
 954
 955
 956 /*
 957  * debug print
 958  */
 959 static void debug_event(keyevent_t event)
 960 {
 961     debug_hex16(event.key.raw);
 962     if (event.pressed) debug("d("); else debug("u(");
 963     debug_dec(event.time); debug(")");
 964 }
 965 static void debug_record(keyrecord_t record)
 966 {
 967     debug_event(record.event); debug(":"); debug_dec(record.tap_count);
 968 }
 969 static void debug_action(action_t action)
 970 {
 971     switch (action.kind.id) {
 972         case ACT_LMODS:             debug("ACT_LMODS");             break;
 973         case ACT_RMODS:             debug("ACT_RMODS");             break;
 974         case ACT_LMODS_TAP:         debug("ACT_LMODS_TAP");         break;
 975         case ACT_RMODS_TAP:         debug("ACT_RMODS_TAP");         break;
 976         case ACT_USAGE:             debug("ACT_USAGE");             break;
 977         case ACT_MOUSEKEY:          debug("ACT_MOUSEKEY");          break;
 978         case ACT_LAYER_PRESSED:     debug("ACT_LAYER_PRESSED");     break;
 979         case ACT_LAYER_RELEASED:    debug("ACT_LAYER_RELEASED");    break;
 980         case ACT_LAYER_BIT:         debug("ACT_LAYER_BIT");         break;
 981         case ACT_LAYER_EXT:         debug("ACT_LAYER_EXT");         break;
 982         case ACT_MACRO:             debug("ACT_MACRO");             break;
 983         case ACT_COMMAND:           debug("ACT_COMMAND");           break;
 984         case ACT_FUNCTION:          debug("ACT_FUNCTION");          break;
 985         default:                    debug("UNKNOWN");               break;
 986     }
 987     debug("[");
 988     debug_hex4(action.kind.param>>8);
 989     debug(":");
 990     debug_hex8(action.kind.param & 0xff);
 991     debug("]");
 992 }
 993 static void debug_tapping_key(void)
 994 {
 995     debug("TAPPING_KEY="); debug_record(tapping_key); debug("\n");
 996 }
 997 static void debug_waiting_buffer(void)
 998 {
 999     debug("{ ");
1000     for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
1001         debug("["); debug_dec(i); debug("]="); debug_record(waiting_buffer[i]); debug(" ");
1002     }
1003     debug("}\n");
1004 }