quantum/process_keycode/process_steno.c

   1 /* Copyright 2017 Joseph Wasson
   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 #include "process_steno.h"
  17 #include "quantum_keycodes.h"
  18 #include "eeprom.h"
  19 #include "keymap_steno.h"
  20 #include "virtser.h"
  21
  22 // TxBolt Codes
  23 #define TXB_NUL 0
  24 #define TXB_S_L 0b00000001
  25 #define TXB_T_L 0b00000010
  26 #define TXB_K_L 0b00000100
  27 #define TXB_P_L 0b00001000
  28 #define TXB_W_L 0b00010000
  29 #define TXB_H_L 0b00100000
  30 #define TXB_R_L 0b01000001
  31 #define TXB_A_L 0b01000010
  32 #define TXB_O_L 0b01000100
  33 #define TXB_STR 0b01001000
  34 #define TXB_E_R 0b01010000
  35 #define TXB_U_R 0b01100000
  36 #define TXB_F_R 0b10000001
  37 #define TXB_R_R 0b10000010
  38 #define TXB_P_R 0b10000100
  39 #define TXB_B_R 0b10001000
  40 #define TXB_L_R 0b10010000
  41 #define TXB_G_R 0b10100000
  42 #define TXB_T_R 0b11000001
  43 #define TXB_S_R 0b11000010
  44 #define TXB_D_R 0b11000100
  45 #define TXB_Z_R 0b11001000
  46 #define TXB_NUM 0b11010000
  47
  48 #define TXB_GRP0 0b00000000
  49 #define TXB_GRP1 0b01000000
  50 #define TXB_GRP2 0b10000000
  51 #define TXB_GRP3 0b11000000
  52 #define TXB_GRPMASK 0b11000000
  53
  54 #define TXB_GET_GROUP(code) ((code & TXB_GRPMASK) >> 6)
  55
  56 #define BOLT_STATE_SIZE 4
  57 #define GEMINI_STATE_SIZE 6
  58 #define MAX_STATE_SIZE GEMINI_STATE_SIZE
  59
  60 uint8_t state[MAX_STATE_SIZE] = {0};
  61 uint8_t pressed = 0;
  62 steno_mode_t mode;
  63
  64 uint8_t boltmap[64] = {
  65   TXB_NUL, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM,
  66   TXB_S_L, TXB_S_L, TXB_T_L, TXB_K_L, TXB_P_L, TXB_W_L, TXB_H_L,
  67   TXB_R_L, TXB_A_L, TXB_O_L, TXB_STR, TXB_STR, TXB_NUL, TXB_NUL,
  68   TXB_NUL, TXB_STR, TXB_STR, TXB_E_R, TXB_U_R, TXB_F_R, TXB_R_R,
  69   TXB_P_R, TXB_B_R, TXB_L_R, TXB_G_R, TXB_T_R, TXB_S_R, TXB_D_R,
  70   TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_Z_R
  71 };
  72
  73 void steno_clear_state(void) {
  74   __builtin_memset(state, 0, sizeof(state));
  75 }
  76
  77 void steno_init() {
  78   if (!eeconfig_is_enabled()) {
  79     eeconfig_init();
  80   }
  81   mode = eeprom_read_byte(EECONFIG_STENOMODE);
  82 }
  83
  84 void steno_set_mode(steno_mode_t new_mode) {
  85   steno_clear_state();
  86   mode = new_mode;
  87   eeprom_update_byte(EECONFIG_STENOMODE, mode);
  88 }
  89
  90 void send_steno_state(uint8_t size, bool send_empty) {
  91   for (uint8_t i = 0; i < size; ++i) {
  92     if (state[i] || send_empty) {
  93       virtser_send(state[i]);
  94     }
  95   }
  96   steno_clear_state();
  97 }
  98
  99 bool update_state_bolt(uint8_t key) {
 100   uint8_t boltcode = boltmap[key];
 101   state[TXB_GET_GROUP(boltcode)] |= boltcode;
 102   return false;
 103 }
 104
 105 bool send_state_bolt(void) {
 106   send_steno_state(BOLT_STATE_SIZE, false);
 107   virtser_send(0); // terminating byte
 108   return false;
 109 }
 110
 111 bool update_state_gemini(uint8_t key) {
 112   state[key / 7] |= 1 << (6 - (key % 7));
 113   return false;
 114 }
 115
 116 bool send_state_gemini(void) {
 117   state[0] |= 0x80; // Indicate start of packet
 118   send_steno_state(GEMINI_STATE_SIZE, true);
 119   return false;
 120 }
 121
 122 bool process_steno(uint16_t keycode, keyrecord_t *record) {
 123   switch (keycode) {
 124     case QK_STENO_BOLT:
 125       if (IS_PRESSED(record->event)) {
 126         steno_set_mode(STENO_MODE_BOLT);
 127       }
 128       return false;
 129
 130     case QK_STENO_GEMINI:
 131       if (IS_PRESSED(record->event)) {
 132         steno_set_mode(STENO_MODE_GEMINI);
 133       }
 134       return false;
 135
 136     case STN__MIN...STN__MAX:
 137       if (IS_PRESSED(record->event)) {
 138         uint8_t key = keycode - QK_STENO;
 139         ++pressed;
 140         switch(mode) {
 141           case STENO_MODE_BOLT:
 142             return update_state_bolt(key);
 143           case STENO_MODE_GEMINI:
 144             return update_state_gemini(key);
 145           default:
 146             return false;
 147         }
 148       } else {
 149         --pressed;
 150         if (pressed <= 0) {
 151           pressed = 0;
 152           switch(mode) {
 153             case STENO_MODE_BOLT:
 154               return send_state_bolt();
 155             case STENO_MODE_GEMINI:
 156               return send_state_gemini();
 157             default:
 158               return false;
 159           }
 160         }
 161       }
 162
 163   }
 164   return true;
 165 }