forked from forks/qmk_firmware
7060cb7b26
* Refactor steno into STENO_ENABLE_[ALL|GEMINI|BOLT]
* Update stenography documentation
* STENO_ENABLE_TXBOLT → STENO_ENABLE_BOLT
TXBOLT is a better name but BOLT is more consistent with the
pre-existing TX Bolt related constants, which all drop the "TX " prefix
* Comments
* STENO_ENABLE_[GEMINI|BOLT|ALL] → STENO_PROTOCOL = [geminipr|txbolt|all]
* Add note on lacking V-USB support
* Clear chord at the end of the switch(mode){send_steno_chord} block
* Return true if NOEVENT
* update_chord_xxx → add_xxx_key_to_chord
* Enable the defines for all the protocols if STENO_PROTOCOL = all
* Mention how to use `steno_set_mode`
* Set the default steno protocol to "all"
This is done so that existing keymaps invoking `steno_set_mode` don't
all suddenly break
* Add data driver equivalents for stenography feature
* Document format of serial steno packets
(Thanks dnaq)
* Add missing comma
40 lines
1.1 KiB
C
40 lines
1.1 KiB
C
/* 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/>.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "quantum.h"
|
|
|
|
#define BOLT_STROKE_SIZE 4
|
|
#define GEMINI_STROKE_SIZE 6
|
|
|
|
#ifdef STENO_ENABLE_GEMINI
|
|
# define MAX_STROKE_SIZE GEMINI_STROKE_SIZE
|
|
#else
|
|
# define MAX_STROKE_SIZE BOLT_STROKE_SIZE
|
|
#endif
|
|
|
|
typedef enum {
|
|
STENO_MODE_GEMINI,
|
|
STENO_MODE_BOLT,
|
|
} steno_mode_t;
|
|
|
|
bool process_steno(uint16_t keycode, keyrecord_t *record);
|
|
#ifdef STENO_ENABLE_ALL
|
|
void steno_init(void);
|
|
void steno_set_mode(steno_mode_t mode);
|
|
#endif // STENO_ENABLE_ALL
|