keymap.c (15480B)
1 /* Copyright 2017-2019 Nikolaus Wittenstein <nikolaus.wittenstein@gmail.com> 2 * 3 * Permission to use, copy, modify, and/or distribute this software for any 4 * purpose with or without fee is hereby granted, provided that the above 5 * copyright notice and this permission notice appear in all copies. 6 * 7 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH 8 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND 9 * FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, 10 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 11 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR 12 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 13 * PERFORMANCE OF THIS SOFTWARE. 14 */ 15 16 #include QMK_KEYBOARD_H 17 18 #include <stdbool.h> 19 20 /* Datahand features not supported: 21 * * All online reprogramming (user settings using the reset button). 22 * * Program Selection features. 23 * * Macros. 24 * * Direct substitutions. 25 * * L/R Modf. 26 * * Mouse Click Lock (Function Direct Access + Mouse Button key). 27 * * Different mouse movement speeds with the two pointer fingers, and using both pointer fingers to move even faster. 28 * 29 * As far as I know, everything else works. 30 */ 31 32 enum layer { 33 NORMAL, 34 #ifdef DATAHAND_THUMB_RETURN_COMMAND 35 NORMAL_THUMB_RETURN_COMMAND, 36 #endif 37 FUNCTION_MOUSE, 38 FUNCTION_ARROWS, 39 NAS, 40 NAS_NUMLOCK, 41 NAS_TENKEY, 42 NAS_TENKEY_NUMLOCK, 43 44 NUM_LAYERS 45 }; 46 47 enum custom_keycodes { 48 N = SAFE_RANGE, /* Normal */ 49 NS, /* NAS */ 50 NSL, /* NAS Lock */ 51 NLK, /* Numlock */ 52 FN, /* Function mode - needs to be able to switch to mouse or arrow layer */ 53 TK0, /* Ten-key off button */ 54 TK1, /* Ten-key on button */ 55 AR, /* FN arrow mode */ 56 MS, /* FN mouse mode */ 57 DZ, /* Double zero button */ 58 }; 59 60 static bool mouse_enabled = true; 61 static bool tenkey_enabled = false; 62 static bool numlock_enabled = false; 63 static bool nas_locked = false; 64 65 /* Declared weak so that it can easily be overridden. */ 66 __attribute__((weak)) const uint16_t PROGMEM keymaps[NUM_LAYERS][MATRIX_ROWS][MATRIX_COLS] = { 67 [NORMAL] = LAYOUT( 68 KC_Q, KC_W, KC_E, KC_R, KC_U, KC_I, KC_O, KC_P, 69 KC_DEL, KC_A, KC_LBRC, KC_ESC, KC_S, KC_B, KC_GRV, KC_D, KC_T, KC_DQT, KC_F, KC_G, KC_H, KC_J, KC_QUOT, KC_Y, KC_K, KC_COLN, KC_N, KC_L, KC_ENT, KC_RBRC, KC_SCLN, KC_BSLS, 70 KC_Z, KC_X, KC_C, KC_V, KC_M, KC_COMM, KC_DOT, KC_SLSH, 71 KC_ENT, KC_TAB, KC_BSPC, KC_SPC, 72 KC_LSFT, NS, 73 KC_CAPS, NSL, 74 N, KC_LCTL, KC_LALT, FN), 75 76 #ifdef DATAHAND_THUMB_RETURN_COMMAND 77 [NORMAL_THUMB_RETURN_COMMAND] = LAYOUT( 78 _______, _______, _______, _______, _______, _______, _______, _______, 79 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, 80 _______, _______, _______, _______, _______, _______, _______, _______, 81 KC_LCMD, _______, _______, _______, 82 _______, _______, 83 _______, _______, 84 _______, _______, _______, _______), 85 #endif 86 87 [FUNCTION_MOUSE] = LAYOUT( 88 KC_F2, KC_F4, KC_F6, MS_UP, MS_UP, KC_F8, KC_F10, KC_PGUP, 89 _______, KC_NO, KC_SCRL, _______, MS_BTN3, NLK, MS_BTN1, MS, MS_BTN2, MS_LEFT, MS_BTN1, MS_RGHT, MS_LEFT, MS_BTN2, MS_RGHT, KC_END, AR, KC_LSFT, KC_INS, KC_9, KC_ENT, KC_F11, KC_0, KC_F12, 90 KC_F1, KC_F3, KC_F5, MS_DOWN, MS_DOWN, KC_F7, KC_F9, KC_PGDN, 91 _______, _______, _______, _______, 92 _______, _______, 93 _______, _______, 94 _______, _______, _______, _______), 95 [FUNCTION_ARROWS] = LAYOUT( 96 _______, _______, _______, KC_UP, KC_UP, _______, _______, _______, 97 _______, _______, _______, _______, KC_LCTL, _______, _______, _______, _______, KC_LEFT, KC_HOME, KC_RGHT, KC_LEFT, KC_HOME, KC_RGHT, _______, _______, _______, _______, _______, _______, _______, _______, _______, 98 _______, _______, _______, KC_DOWN, KC_DOWN, _______, _______, _______, 99 _______, _______, _______, _______, 100 _______, _______, 101 _______, _______, 102 _______, _______, _______, _______), 103 [NAS] = LAYOUT( 104 KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, 105 _______, KC_1, KC_TILD, _______, KC_2, NLK, KC_LABK, KC_3, KC_RABK, KC_SLSH, KC_4, KC_5, KC_6, KC_7, KC_UNDS, KC_CIRC, KC_8, KC_ENT, KC_SCLN, KC_9, KC_BSLS, TK0, KC_0, TK1, 106 KC_EQL, KC_X, KC_PERC, KC_MINS, KC_PLUS, KC_DOT, KC_SLSH, KC_QUES, 107 _______, _______, _______, _______, 108 _______, _______, 109 _______, _______, 110 _______, _______, _______, _______), 111 [NAS_NUMLOCK] = LAYOUT( 112 _______, _______, _______, _______, _______, KC_PAST, _______, _______, 113 _______, KC_KP_1, _______, _______, KC_KP_2, _______, _______, KC_KP_3, _______, KC_PSLS, KC_KP_4, KC_KP_5, KC_KP_6, KC_KP_7, _______, _______, KC_KP_8, _______, _______, KC_KP_9, KC_PENT, _______, KC_KP_0, _______, 114 KC_PEQL, _______, _______, KC_PMNS, KC_PPLS, _______, KC_PDOT, _______, 115 _______, _______, _______, _______, 116 _______, _______, 117 _______, _______, 118 _______, _______, _______, _______), 119 [NAS_TENKEY] = LAYOUT( 120 _______, _______, _______, KC_UP, KC_7, KC_8, KC_9, KC_ASTR, 121 _______, KC_QUOT, _______, _______, KC_DLR, _______, _______, KC_AMPR, _______, KC_LEFT, KC_HOME, KC_RGHT, KC_0, KC_4, DZ, KC_PLUS, KC_5, KC_MINS, KC_EQL, KC_6, KC_ENT, _______, KC_DOT, _______, 122 KC_LPRN, KC_RPRN, _______, KC_DOWN, KC_1, KC_2, KC_3, KC_SLSH, 123 _______, _______, _______, _______, 124 _______, _______, 125 _______, _______, 126 _______, _______, _______, _______), 127 [NAS_TENKEY_NUMLOCK] = LAYOUT( 128 _______, _______, _______, _______, KC_KP_7, KC_KP_8, KC_KP_9, KC_PAST, 129 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_KP_0, KC_KP_4, _______, KC_PPLS, KC_KP_5, KC_PMNS, KC_PEQL, KC_KP_6, KC_PENT, _______, KC_PDOT, _______, 130 _______, _______, _______, _______, KC_KP_1, KC_KP_2, KC_KP_3, KC_PSLS, 131 _______, _______, _______, _______, 132 _______, _______, 133 _______, _______, 134 _______, _______, _______, _______), 135 }; 136 137 static void lock_led_set(bool on, uint8_t led) { 138 if (on) { 139 LED_LOCK_PORT &= ~led; 140 } else { 141 LED_LOCK_PORT |= led; 142 } 143 } 144 145 static void mode_led_set(uint8_t led) { 146 static const uint8_t ALL_MODE_LEDS = LED_FN | LED_NORMAL | LED_NAS | LED_TENKEY; 147 LED_MODE_PORT |= ALL_MODE_LEDS; 148 LED_MODE_PORT &= ~led; 149 } 150 151 static void layer_set(bool on, uint8_t layer) { 152 if (on) { 153 layer_on(layer); 154 } else { 155 layer_off(layer); 156 } 157 158 if (layer_state_is(NAS) || layer_state_is(NAS_NUMLOCK) || layer_state_is(NAS_TENKEY) || layer_state_is(NAS_TENKEY_NUMLOCK)) { 159 if (tenkey_enabled) { 160 mode_led_set(LED_NAS | LED_TENKEY); 161 } else { 162 mode_led_set(LED_NAS); 163 } 164 } else if (layer_state_is(FUNCTION_MOUSE) || layer_state_is(FUNCTION_ARROWS)) { 165 mode_led_set(LED_FN); 166 } else if (layer_state_is(NORMAL)) { 167 mode_led_set(LED_NORMAL); 168 } 169 } 170 171 static void set_normal(void) { 172 layer_move(NORMAL); 173 174 #ifdef DATAHAND_THUMB_RETURN_COMMAND 175 layer_set(true, NORMAL_THUMB_RETURN_COMMAND); 176 #endif 177 178 /* Then call layer_set to update LEDs. */ 179 layer_set(true, NORMAL); 180 } 181 182 static void set_nas(bool on) { 183 /* Always turn on the base NAS layer so other layers can fall through. */ 184 layer_set(on, NAS); 185 186 layer_set(on && numlock_enabled, NAS_NUMLOCK); 187 layer_set(on && tenkey_enabled, NAS_TENKEY); 188 layer_set(on && tenkey_enabled && numlock_enabled, NAS_TENKEY_NUMLOCK); 189 } 190 191 static void set_tenkey(bool on) { 192 tenkey_enabled = on; 193 194 /* We have to be on the NAS layer in order to be able to toggle TK. 195 * Re-toggle it on so that we move to the right layer (and set the right LED). 196 */ 197 set_nas(true); 198 } 199 200 static void toggle_numlock(void) { 201 numlock_enabled = !numlock_enabled; 202 lock_led_set(numlock_enabled, LED_NUM_LOCK); 203 204 if (layer_state_is(NAS)) { 205 /* If we're already in NAS, re-set it so that we activate the numlock layer. */ 206 set_nas(true); 207 } 208 } 209 210 static void set_function(void) { 211 /* Make sure to turn off NAS if we're entering function */ 212 set_nas(false); 213 214 /* Always turn on the mouse layer so the arrow layer can fall through. */ 215 layer_set(true, FUNCTION_MOUSE); 216 layer_set(!mouse_enabled, FUNCTION_ARROWS); 217 } 218 219 static void set_mouse_enabled(bool on) { 220 mouse_enabled = on; 221 222 /* Re-run set_function to set our layers correctly. */ 223 set_function(); 224 } 225 226 bool process_record_user(uint16_t keycode, keyrecord_t *record) { 227 bool pressed = record->event.pressed; 228 229 switch(keycode) { 230 case N: 231 if (pressed) { 232 set_normal(); 233 } 234 break; 235 236 case NS: 237 if (pressed) { 238 nas_locked = false; 239 } 240 set_nas(pressed); 241 break; 242 243 case NSL: 244 if (pressed) { 245 nas_locked = true; 246 set_nas(true); 247 } 248 break; 249 250 case NLK: 251 if (pressed) { 252 toggle_numlock(); 253 SEND_STRING(SS_DOWN(X_NUM_LOCK)); 254 } else { 255 SEND_STRING(SS_UP(X_NUM_LOCK)); 256 } 257 break; 258 259 case FN: 260 if (pressed) { 261 set_function(); 262 } 263 break; 264 265 case TK0: 266 if (pressed) { 267 set_tenkey(false); 268 } 269 break; 270 271 case TK1: 272 if (pressed) { 273 set_tenkey(true); 274 } 275 break; 276 277 case MS: 278 if (pressed) { 279 set_mouse_enabled(true); 280 } 281 break; 282 283 case AR: 284 if (pressed) { 285 set_mouse_enabled(false); 286 } 287 break; 288 289 case DZ: 290 if (pressed) { 291 SEND_STRING(SS_TAP(X_KP_0) SS_TAP(X_KP_0)); 292 } 293 break; 294 } 295 296 return true; 297 }; 298 299 void matrix_init_user(void) { 300 #ifdef DATAHAND_THUMB_RETURN_COMMAND 301 set_normal(); 302 #endif 303 } 304 305 bool led_update_user(led_t led_state) { 306 lock_led_set(led_state.num_lock, LED_NUM_LOCK); 307 lock_led_set(led_state.caps_lock, LED_CAPS_LOCK); 308 lock_led_set(led_state.scroll_lock, LED_SCROLL_LOCK); 309 return false; 310 }