+/* Copyright 2017 Joseph Wasson
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
#include "process_steno.h"
#include "quantum_keycodes.h"
+#include "eeprom.h"
#include "keymap_steno.h"
#include "virtser.h"
-
-uint8_t state[4] = {0};
-uint8_t pressed = 0;
-
+#include <string.h>
// TxBolt Codes
#define TXB_NUL 0
#define TXB_GET_GROUP(code) ((code & TXB_GRPMASK) >> 6)
-uint8_t boltmap[64] = {
+#define BOLT_STATE_SIZE 4
+#define GEMINI_STATE_SIZE 6
+#define MAX_STATE_SIZE GEMINI_STATE_SIZE
+
+static uint8_t state[MAX_STATE_SIZE] = {0};
+static uint8_t chord[MAX_STATE_SIZE] = {0};
+static int8_t pressed = 0;
+static steno_mode_t mode;
+
+static const uint8_t boltmap[64] PROGMEM = {
TXB_NUL, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM,
TXB_S_L, TXB_S_L, TXB_T_L, TXB_K_L, TXB_P_L, TXB_W_L, TXB_H_L,
TXB_R_L, TXB_A_L, TXB_O_L, TXB_STR, TXB_STR, TXB_NUL, TXB_NUL,
TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_Z_R
};
-#define BOLTMAP_MASK (sizeof(boltmap) - 1)
+static void steno_clear_state(void) {
+ memset(state, 0, sizeof(state));
+ memset(chord, 0, sizeof(chord));
+}
-void send_steno_state(void) {
- for (uint8_t i = 0; i < 4; ++i) {
- if (state[i]) {
- virtser_send(state[i]);
- state[i] = 0;
+static void send_steno_state(uint8_t size, bool send_empty) {
+ for (uint8_t i = 0; i < size; ++i) {
+ if (chord[i] || send_empty) {
+ virtser_send(chord[i]);
}
}
- virtser_send(0);
}
-bool process_steno(uint16_t keycode, keyrecord_t *record) {
- if(keycode >= QK_STENO && keycode <= QK_STENO_MAX) {
- if(IS_PRESSED(record->event)) {
- uint8_t boltcode = boltmap[keycode & BOLTMAP_MASK];
- ++pressed;
- state[TXB_GET_GROUP(boltcode)] |= boltcode;
- } else {
- --pressed;
- if (pressed <= 0) {
- pressed = 0; // protect against spurious up keys
- send_steno_state();
- }
+void steno_init() {
+ if (!eeconfig_is_enabled()) {
+ eeconfig_init();
+ }
+ mode = eeprom_read_byte(EECONFIG_STENOMODE);
+}
+
+void steno_set_mode(steno_mode_t new_mode) {
+ steno_clear_state();
+ mode = new_mode;
+ eeprom_update_byte(EECONFIG_STENOMODE, mode);
+}
+
+/* override to intercept chords right before they get sent.
+ * return zero to suppress normal sending behavior.
+ */
+__attribute__ ((weak))
+bool send_steno_chord_user(steno_mode_t mode, uint8_t chord[6]) { return true; }
+
+__attribute__ ((weak))
+bool postprocess_steno_user(uint16_t keycode, keyrecord_t *record, steno_mode_t mode, uint8_t chord[6], int8_t pressed) { return true; }
+
+__attribute__ ((weak))
+bool process_steno_user(uint16_t keycode, keyrecord_t *record) { return true; }
+
+static void send_steno_chord(void) {
+ if (send_steno_chord_user(mode, chord)) {
+ switch(mode) {
+ case STENO_MODE_BOLT:
+ send_steno_state(BOLT_STATE_SIZE, false);
+ virtser_send(0); // terminating byte
+ break;
+ case STENO_MODE_GEMINI:
+ chord[0] |= 0x80; // Indicate start of packet
+ send_steno_state(GEMINI_STATE_SIZE, true);
+ break;
}
- return false;
}
+ steno_clear_state();
+}
+
+uint8_t *steno_get_state(void) {
+ return &state[0];
+}
+uint8_t *steno_get_chord(void) {
+ return &chord[0];
+}
+
+static bool update_state_bolt(uint8_t key, bool press) {
+ uint8_t boltcode = pgm_read_byte(boltmap + key);
+ if (press) {
+ state[TXB_GET_GROUP(boltcode)] |= boltcode;
+ chord[TXB_GET_GROUP(boltcode)] |= boltcode;
+ } else {
+ state[TXB_GET_GROUP(boltcode)] &= ~boltcode;
+ }
+ return false;
+}
+
+static bool update_state_gemini(uint8_t key, bool press) {
+ int idx = key / 7;
+ uint8_t bit = 1 << (6 - (key % 7));
+ if (press) {
+ state[idx] |= bit;
+ chord[idx] |= bit;
+ } else {
+ state[idx] &= ~bit;
+ }
+ return false;
+}
+
+bool process_steno(uint16_t keycode, keyrecord_t *record) {
+ switch (keycode) {
+ case QK_STENO_BOLT:
+ if (!process_steno_user(keycode, record)) {
+ return false;
+ }
+ if (IS_PRESSED(record->event)) {
+ steno_set_mode(STENO_MODE_BOLT);
+ }
+ return false;
+
+ case QK_STENO_GEMINI:
+ if (!process_steno_user(keycode, record)) {
+ return false;
+ }
+ if (IS_PRESSED(record->event)) {
+ steno_set_mode(STENO_MODE_GEMINI);
+ }
+ return false;
+
+ case STN__MIN...STN__MAX:
+ if (!process_steno_user(keycode, record)) {
+ return false;
+ }
+ switch(mode) {
+ case STENO_MODE_BOLT:
+ update_state_bolt(keycode - QK_STENO, IS_PRESSED(record->event));
+ case STENO_MODE_GEMINI:
+ update_state_gemini(keycode - QK_STENO, IS_PRESSED(record->event));
+ }
+ // allow postprocessing hooks
+ if (postprocess_steno_user(keycode, record, mode, chord, pressed)) {
+ if (IS_PRESSED(record->event)) {
+ ++pressed;
+ } else {
+ --pressed;
+ if (pressed <= 0) {
+ pressed = 0;
+ send_steno_chord();
+ }
+ }
+ }
+ return false;
+ }
return true;
}
projects / qmk_firmware.git / blobdiff