quantum/process_keycode/process_leader.c

   1 /* Copyright 2016 Jack Humbert
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16
  17 #ifdef LEADER_ENABLE
  18
  19 #include "process_leader.h"
  20 #ifdef __arm__
  21 #   include <string.h>
  22 #endif
  23
  24 #ifndef LEADER_TIMEOUT
  25   #define LEADER_TIMEOUT 300
  26 #endif
  27
  28 __attribute__ ((weak))
  29 void leader_start(void) {}
  30
  31 __attribute__ ((weak))
  32 void leader_end(void) {}
  33
  34 // Leader key stuff
  35 bool leading = false;
  36 uint16_t leader_time = 0;
  37
  38 uint16_t leader_sequence[5] = {0, 0, 0, 0, 0};
  39 uint8_t leader_sequence_size = 0;
  40
  41 void qk_leader_start(void) {
  42   if (leading) { return; }
  43   leader_start();
  44   leading = true;
  45   leader_time = timer_read();
  46   leader_sequence_size = 0;
  47   memset(leader_sequence, 0, sizeof(leader_sequence));
  48 }
  49
  50 bool process_leader(uint16_t keycode, keyrecord_t *record) {
  51   // Leader key set-up
  52   if (record->event.pressed) {
  53     if (leading) {
  54       if (timer_elapsed(leader_time) < LEADER_TIMEOUT) {
  55 #ifndef LEADER_KEY_STRICT_KEY_PROCESSING
  56         if ((keycode >= QK_MOD_TAP && keycode <= QK_MOD_TAP_MAX) || (keycode >= QK_LAYER_TAP && keycode <= QK_LAYER_TAP_MAX)) {
  57           keycode = keycode & 0xFF;
  58         }
  59 #endif // LEADER_KEY_STRICT_KEY_PROCESSING
  60         if ( leader_sequence_size < ( sizeof(leader_sequence) / sizeof(leader_sequence[0]) ) ) {
  61           leader_sequence[leader_sequence_size] = keycode;
  62           leader_sequence_size++;
  63         } else {
  64           leading = false;
  65           leader_end();
  66         }
  67 #ifdef LEADER_PER_KEY_TIMING
  68         leader_time = timer_read();
  69 #endif
  70         return false;
  71       }
  72     } else {
  73       if (keycode == KC_LEAD) {
  74         qk_leader_start();
  75       }
  76     }
  77   }
  78   return true;
  79 }
  80
  81 #endif