2017-07-27 20:56:50 +02:00
|
|
|
/* 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/>.
|
|
|
|
|
*/
|
2017-07-26 23:41:39 +02:00
|
|
|
#ifndef PROCESS_STENO_H
|
|
|
|
|
#define PROCESS_STENO_H
|
|
|
|
|
|
|
|
|
|
#include "quantum.h"
|
|
|
|
|
|
|
|
|
|
#if defined(STENO_ENABLE) && !defined(VIRTSER_ENABLE)
|
|
|
|
|
#error "must have virtser enabled to use steno"
|
|
|
|
|
#endif
|
|
|
|
|
|
2017-07-27 06:51:41 +02:00
|
|
|
typedef enum { STENO_MODE_BOLT, STENO_MODE_GEMINI } steno_mode_t;
|
|
|
|
|
|
2017-07-26 23:41:39 +02:00
|
|
|
bool process_steno(uint16_t keycode, keyrecord_t *record);
|
2017-07-27 06:51:41 +02:00
|
|
|
void steno_init(void);
|
|
|
|
|
void steno_set_mode(steno_mode_t mode);
|
Improve state/chord handling and clean up namespace
Some values that can never, ever, change were held in local
variables, rather than in PROGMEM. Fixed.
Change "pressed" to a signed int so the test for < 0 makes
sense, and to avoid possible weird failure modes in the
case where a key release comes in when pressed is already
zero. (Shouldn't happen, sure, but computers are weird.)
A lot of things in process_steno had external linkage for no
particular reason. They've been marked static. Stuff still
builds.
Distinguish between currently-held keys and keys that have
been held, and expose these values through a nicely-named API
so other code could, say, check on the current set of steno
chording in order to make displays. Also in passing fix up the
"state" value having external linkage so it could clash with
other people's variable declarations.
The API also provides hooks for key processing and steno chord
events, so you can monitor those events without having to
run in matrix_scan_user and recheck the values directly. Also
document these.
There is no path through processing a key that doesn't
end with a return false, so the nested return foo() are
gone and we just return false.
2017-11-18 16:38:15 +01:00
|
|
|
uint8_t *steno_get_state(void);
|
|
|
|
|
uint8_t *steno_get_chord(void);
|
2017-07-26 23:41:39 +02:00
|
|
|
|
Improve state/chord handling and clean up namespace
Some values that can never, ever, change were held in local
variables, rather than in PROGMEM. Fixed.
Change "pressed" to a signed int so the test for < 0 makes
sense, and to avoid possible weird failure modes in the
case where a key release comes in when pressed is already
zero. (Shouldn't happen, sure, but computers are weird.)
A lot of things in process_steno had external linkage for no
particular reason. They've been marked static. Stuff still
builds.
Distinguish between currently-held keys and keys that have
been held, and expose these values through a nicely-named API
so other code could, say, check on the current set of steno
chording in order to make displays. Also in passing fix up the
"state" value having external linkage so it could clash with
other people's variable declarations.
The API also provides hooks for key processing and steno chord
events, so you can monitor those events without having to
run in matrix_scan_user and recheck the values directly. Also
document these.
There is no path through processing a key that doesn't
end with a return false, so the nested return foo() are
gone and we just return false.
2017-11-18 16:38:15 +01:00
|
|
|
#endif
|
