aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--common_features.mk7
-rw-r--r--keyboards/nyquist/keymaps/333fred/Makefile2
-rw-r--r--keyboards/nyquist/keymaps/333fred/keymap.c2
-rw-r--r--quantum/process_keycode/process_key_lock.c120
-rw-r--r--quantum/process_keycode/process_key_lock.h24
-rw-r--r--quantum/quantum.c4
-rw-r--r--quantum/quantum.h4
-rw-r--r--quantum/quantum_keycodes.h4
8 files changed, 165 insertions, 2 deletions
diff --git a/common_features.mk b/common_features.mk
index 0adf81afa..f405d5c07 100644
--- a/common_features.mk
+++ b/common_features.mk
@@ -104,6 +104,11 @@ ifeq ($(strip $(TAP_DANCE_ENABLE)), yes)
104 SRC += $(QUANTUM_DIR)/process_keycode/process_tap_dance.c 104 SRC += $(QUANTUM_DIR)/process_keycode/process_tap_dance.c
105endif 105endif
106 106
107ifeq ($(strip $(KEY_LOCK_ENABLE)), yes)
108 OPT_DEFS += -DKEY_LOCK_ENABLE
109 SRC += $(QUANTUM_DIR)/process_keycode/process_key_lock.c
110endif
111
107ifeq ($(strip $(PRINTING_ENABLE)), yes) 112ifeq ($(strip $(PRINTING_ENABLE)), yes)
108 OPT_DEFS += -DPRINTING_ENABLE 113 OPT_DEFS += -DPRINTING_ENABLE
109 SRC += $(QUANTUM_DIR)/process_keycode/process_printer.c 114 SRC += $(QUANTUM_DIR)/process_keycode/process_printer.c
@@ -156,4 +161,4 @@ QUANTUM_SRC:= \
156 161
157ifndef CUSTOM_MATRIX 162ifndef CUSTOM_MATRIX
158 QUANTUM_SRC += $(QUANTUM_DIR)/matrix.c 163 QUANTUM_SRC += $(QUANTUM_DIR)/matrix.c
159endif \ No newline at end of file 164endif
diff --git a/keyboards/nyquist/keymaps/333fred/Makefile b/keyboards/nyquist/keymaps/333fred/Makefile
index 457a3d01d..471eac8b5 100644
--- a/keyboards/nyquist/keymaps/333fred/Makefile
+++ b/keyboards/nyquist/keymaps/333fred/Makefile
@@ -1,3 +1,5 @@
1KEY_LOCK_ENABLE = yes
2
1ifndef QUANTUM_DIR 3ifndef QUANTUM_DIR
2 include ../../../../Makefile 4 include ../../../../Makefile
3endif 5endif
diff --git a/keyboards/nyquist/keymaps/333fred/keymap.c b/keyboards/nyquist/keymaps/333fred/keymap.c
index 07434d93f..20bf29887 100644
--- a/keyboards/nyquist/keymaps/333fred/keymap.c
+++ b/keyboards/nyquist/keymaps/333fred/keymap.c
@@ -39,7 +39,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
39 KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSLASH, \ 39 KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSLASH, \
40 KC_ESC, KC_A, KC_S, KC_D, LT(_VIM, KC_F), KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, \ 40 KC_ESC, KC_A, KC_S, KC_D, LT(_VIM, KC_F), KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, \
41 OSM(MOD_LSFT), LCTL_T(KC_Z), KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, RCTL_T(KC_SLSH), OSM(MOD_RSFT), \ 41 OSM(MOD_LSFT), LCTL_T(KC_Z), KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, RCTL_T(KC_SLSH), OSM(MOD_RSFT), \
42 KC_LCTL, KC_LALT, KC_F4, KC_LGUI, OSL(_LOWER), KC_BSPC, KC_SPC, KC_ENT, KC_RALT, KC_EQL, TG(_GAME), KC_DEL \ 42 KC_LCTL, KC_LALT, KC_F4, KC_LGUI, OSL(_LOWER), KC_BSPC, KC_SPC, KC_ENT, KC_LOCK, KC_EQL, TG(_GAME), KC_DEL \
43), 43),
44 44
45/* Lower 45/* Lower
diff --git a/quantum/process_keycode/process_key_lock.c b/quantum/process_keycode/process_key_lock.c
new file mode 100644
index 000000000..60b0fcd9b
--- /dev/null
+++ b/quantum/process_keycode/process_key_lock.c
@@ -0,0 +1,120 @@
1/* Copyright 2017 Fredric Silberberg
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#include "inttypes.h"
18#include "stdint.h"
19#include "process_key_lock.h"
20
21#define SHIFT(shift) (((uint64_t)1) << (shift))
22#define GET_KEY_ARRAY(code) (((code) < 0x40) ? key_state[0] : \
23 ((code) < 0x80) ? key_state[1] : \
24 ((code) < 0xC0) ? key_state[2] : key_state[3])
25#define GET_CODE_INDEX(code) (((code) < 0x40) ? (code) : \
26 ((code) < 0x80) ? (code) - 0x40 : \
27 ((code) < 0xC0) ? (code) - 0x80 : (code) - 0xC0)
28#define KEY_STATE(code) (GET_KEY_ARRAY(code) & SHIFT(GET_CODE_INDEX(code))) == SHIFT(GET_CODE_INDEX(code))
29#define SET_KEY_ARRAY_STATE(code, val) do { \
30 switch (code) { \
31 case 0x00 ... 0x3F: \
32 key_state[0] = (val); \
33 break; \
34 case 0x40 ... 0x7F: \
35 key_state[1] = (val); \
36 break; \
37 case 0x80 ... 0xBF: \
38 key_state[2] = (val); \
39 break; \
40 case 0xC0 ... 0xFF: \
41 key_state[3] = (val); \
42 break; \
43 } \
44} while(0)
45#define SET_KEY_STATE(code) SET_KEY_ARRAY_STATE(code, (GET_KEY_ARRAY(code) | SHIFT(GET_CODE_INDEX(code))))
46#define UNSET_KEY_STATE(code) SET_KEY_ARRAY_STATE(code, (GET_KEY_ARRAY(code)) & ~(SHIFT(GET_CODE_INDEX(code))))
47#define IS_STANDARD_KEYCODE(code) ((code) <= 0xFF)
48#define print_hex64(num) do { print_hex32((num & 0xFFFFFFFF00000000) >> 32); print_hex32(num & 0x00000000FFFFFFFF); } while (0)
49
50// Locked key state. This is an array of 256 bits, one for each of the standard keys supported qmk.
51uint64_t key_state[4] = { 0x0, 0x0, 0x0, 0x0 };
52bool watching = false;
53
54bool process_key_lock(uint16_t keycode, keyrecord_t *record) {
55 // We start by categorizing the keypress event. In the event of a down
56 // event, there are several possibilities:
57 // 1. The key is not being locked, and we are not watching for new keys.
58 // In this case, we bail immediately. This is the common case for down events.
59 // 2. The key was locked, and we need to unlock it. In this case, we will
60 // reset the state in our map and return false. When the user releases the
61 // key, the up event will no longer be masked and the OS will observe the
62 // released key.
63 // 3. KC_LOCK was just pressed. In this case, we set up the state machine
64 // to watch for the next key down event, and finish processing
65 // 4. The keycode is below 0xFF, and we are watching for new keys. In this case,
66 // we will send the key down event to the os, and set the key_state for that
67 // key to mask the up event.
68 // 5. The keycode is above 0xFF, and we're wathing for new keys. In this case,
69 // the user pressed a key that we cannot "lock", as it's a series of keys,
70 // or a macro invocation, or a layer transition, or a custom-defined key, or
71 // or some other arbitrary code. In this case, we bail immediately, reset
72 // our watch state, and return true.
73 //
74 // In the event of an up event, there are these possibilities:
75 // 1. The key is not being locked. In this case, we return true and bail
76 // immediately. This is the common case.
77 // 2. The key is being locked. In this case, we will mask the up event
78 // by returning false, so the OS never sees that the key was released
79 // until the user pressed the key again.
80 if (record->event.pressed) {
81 // Non-standard keycode, reset and return
82 if (!(IS_STANDARD_KEYCODE(keycode) || keycode == KC_LOCK)) {
83 watching = false;
84 return true;
85 }
86
87 // If we're already watching, turn off the watch.
88 if (keycode == KC_LOCK) {
89 watching = !watching;
90 return false;
91 }
92
93 if (IS_STANDARD_KEYCODE(keycode)) {
94 // We check watching first. This is so that in the following scenario, we continue to
95 // hold the key: KC_LOCK, KC_F, KC_LOCK, KC_F
96 // If we checked in reverse order, we'd end up holding the key pressed after the second
97 // KC_F press is registered, when the user likely meant to hold F
98 if (watching) {
99 watching = false;
100 SET_KEY_STATE(keycode);
101 // Let the standard keymap send the keycode down event. The up event will be masked.
102 return true;
103 }
104
105 if (KEY_STATE(keycode)) {
106 UNSET_KEY_STATE(keycode);
107 // The key is already held, stop this process. The up event will be sent when the user
108 // releases the key.
109 return false;
110 }
111 }
112
113 // Either the key isn't a standard key, or we need to send the down event. Continue standard
114 // processing
115 return true;
116 } else {
117 // Stop processing if it's a standard key and we're masking up.
118 return !(IS_STANDARD_KEYCODE(keycode) && KEY_STATE(keycode));
119 }
120}
diff --git a/quantum/process_keycode/process_key_lock.h b/quantum/process_keycode/process_key_lock.h
new file mode 100644
index 000000000..237e103bc
--- /dev/null
+++ b/quantum/process_keycode/process_key_lock.h
@@ -0,0 +1,24 @@
1/* Copyright 2017 Fredric Silberberg
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#ifndef PROCESS_KEY_LOCK_H
18#define PROCESS_KEY_LOCK_H
19
20#include "quantum.h"
21
22bool process_key_lock(uint16_t keycode, keyrecord_t *record);
23
24#endif // PROCESS_KEY_LOCK_H
diff --git a/quantum/quantum.c b/quantum/quantum.c
index 1f8ce6c46..c71a97bf2 100644
--- a/quantum/quantum.c
+++ b/quantum/quantum.c
@@ -193,6 +193,10 @@ bool process_record_quantum(keyrecord_t *record) {
193 // } 193 // }
194 194
195 if (!( 195 if (!(
196 #if defined(KEY_LOCK_ENABLE)
197 // Must run first to be able to mask key_up events.
198 process_key_lock(keycode, record) &&
199 #endif
196 process_record_kb(keycode, record) && 200 process_record_kb(keycode, record) &&
197 #if defined(MIDI_ENABLE) && defined(MIDI_ADVANCED) 201 #if defined(MIDI_ENABLE) && defined(MIDI_ADVANCED)
198 process_midi(keycode, record) && 202 process_midi(keycode, record) &&
diff --git a/quantum/quantum.h b/quantum/quantum.h
index 453cb43f8..9a6d691a1 100644
--- a/quantum/quantum.h
+++ b/quantum/quantum.h
@@ -99,6 +99,10 @@ extern uint32_t default_layer_state;
99 #include "process_combo.h" 99 #include "process_combo.h"
100#endif 100#endif
101 101
102#ifdef KEY_LOCK_ENABLE
103 #include "process_key_lock.h"
104#endif
105
102#define SEND_STRING(str) send_string(PSTR(str)) 106#define SEND_STRING(str) send_string(PSTR(str))
103extern const bool ascii_to_shift_lut[0x80]; 107extern const bool ascii_to_shift_lut[0x80];
104extern const uint8_t ascii_to_keycode_lut[0x80]; 108extern const uint8_t ascii_to_keycode_lut[0x80];
diff --git a/quantum/quantum_keycodes.h b/quantum/quantum_keycodes.h
index acdb9248d..1bb6706ba 100644
--- a/quantum/quantum_keycodes.h
+++ b/quantum/quantum_keycodes.h
@@ -419,6 +419,10 @@ enum quantum_keycodes {
419 OUT_BT, 419 OUT_BT,
420#endif 420#endif
421 421
422#ifdef KEY_LOCK_ENABLE
423 KC_LOCK,
424#endif
425
422 // always leave at the end 426 // always leave at the end
423 SAFE_RANGE 427 SAFE_RANGE
424}; 428};