keyboards/planck/keymaps/sdothum/keymap.c

   1 // This is the canonical layout file for the Quantum project. If you want to add another keyboard,
   2 // this is the style you want to emulate.
   3 //
   4 // To flash planck firmware
   5 // ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
   6 //   Reset keyboard or press hw reset button on base (hole)
   7 //
   8 //   cd qmk_firmware/keyboards/planck
   9 //   sudo make KEYMAP=sdothum dfu
  10 //
  11 //   sudo make clean          (good practice before flashing)
  12 //   sudo make KEYMAP=sdothum (to compile check)
  13 //
  14 // Package requirements (for arch linux)
  15 // ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
  16 //   avr-gcc-atmel
  17 //   avr-libc-atmel
  18 //   dfu-programmer
  19 //
  20 // Notes
  21 // ▔▔▔▔▔
  22 //   ** E R G O   W I D E   S P L I T ** Layout
  23 //
  24 //   Autocompletion tap dance key pairs (),[],{} are available from the
  25 //   number/symbol layer, as well as, numerous (un)shift key values
  26 //
  27 //   The navigation pad provides a single hand right thumb activated cluster
  28 //   with left hand modifiers
  29 //
  30 //   #define PRIVATE_STRING includes private_string.h, a user defined code
  31 //   block for the PRIV tap dance e.g. SEND_STRING("secret messape"),
  32 //   see function private()
  33 //
  34 // Modifier clusters
  35 // ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
  36 //   The num and sym keys together access the navigation pad layer
  37 //
  38 //   ,-----------------------------------------------------------------------------------.
  39 //   | Ctrl |  GUI |  Alt |  Esc | Space|  Tab | Bksp |  Ent | Left | Down |  Up  | Right|
  40 //   `-----------------------------------------------------------------------------------'
  41 //
  42 // Hint
  43 // ▔▔▔▔
  44 //   For sculpted keycaps such as Cherry or OEM profile, reverse the Alt, Num,
  45 //   Shift, Shift, Nav, Sym keycaps for more ergonomic thumb orientation and
  46 //   actuation
  47 //
  48 // Code
  49 // ▔▔▔▔
  50 //   This source is shamelessly based on the "default" planck layout
  51 //
  52 //   #ifdef/#endif block structures are not indented, as syntax highlighting
  53 //   in vim is sufficient for identification
  54 //
  55 //   c++ commenting style is used throughout
  56 //
  57 // Change history
  58 // ▔▔▔▔▔▔▔▔▔▔▔▔▔▔
  59 //   See http://thedarnedestthing.com/planck%20constant
  60 //   See http://thedarnedestthing.com/planck%20done
  61
  62
  63
  64 //                === N O T E ===
  65 //
  66 // sudo CPATH=<keymap.c directory>/common make ...
  67
  68
  69 #include "config.h"
  70 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
  71 #include "planck.h"
  72 #include "action_layer.h"
  73 #ifdef STENO_ENABLE
  74 #include "keymap_steno.h"
  75 #endif
  76 #ifdef AUDIO_ENABLE
  77 #include "audio.h"
  78 #endif
  79 #include "eeconfig.h"
  80
  81 extern keymap_config_t keymap_config;
  82
  83 enum planck_layers {
  84   _BASE = 0
  85  ,_SHIFT
  86  ,_LSHIFT
  87  ,_RSHIFT
  88  ,_PLOVER
  89  ,_NUMBER
  90  ,_SYMBOL
  91  ,_FNCKEY
  92  ,_MOUSE
  93 #ifdef CENTER_TT
  94  ,_TTNUMBER
  95  ,_TTREGEX
  96  ,_TTFNCKEY
  97  ,_TTCURSOR
  98  ,_TTMOUSE
  99 #endif
 100 #ifndef SHIFT_SYMBOLS
 101  ,_NUMSYM
 102  ,_SYMREG
 103 #endif
 104  ,_EDIT
 105  ,_QWERTY
 106  ,_ADJUST
 107  ,_END_LAYERS
 108 };
 109
 110 enum planck_keycodes {
 111   BASE = SAFE_RANGE
 112  ,BASE1
 113  ,BASE2
 114  ,PLOVER
 115  ,PLOEXIT
 116  ,SM_CIRC   // pseudo GUI_T(S(KC_6))                      for shifted key-codes, see process_record_user()
 117  ,SM_DLR    // pseudo SFT_T(S(KC_4))                      for shifted key-codes, see process_record_user()
 118  ,SM_G      // pseudo MT   (MOD_LALT | MOD_LSFT, S(KC_G)) for shifted key-codes, see process_record_user()
 119  ,SM_PERC   // pseudo ALT_T(S(KC_5))                      for shifted key-codes, see process_record_user()
 120  ,SM_LPRN   // pseudo CTL_T(S(KC_9))                      for shifted key-codes, see process_record_user()
 121  ,SL_LEFT   // pseudo LT   (_MOUSE, S(KC_LEFT))           for shifted key-codes, see process_record_user()
 122  ,SP_DEL    // pseudo LT   (_MOUSE, KC_DEL)               for shifted key-codes, see process_record_user()
 123  ,SL_PIPE   // pseudo LT   (_ADJUST, S(KC_BSLS))          for shifted key-codes, see process_record_user()
 124  ,SL_TAB    // pseudo LT   (_FNCKEY, S(KC_TAB))           for shifted key-codes, see process_record_user()
 125 #ifdef CENTER_TT
 126  ,TT_ESC
 127 #endif
 128 #ifdef STENO_ENABLE
 129  ,PS_STNA = STN_A
 130  ,PS_STNO = STN_O
 131  ,PS_STNE = STN_E
 132  ,PS_STNU = STN_U
 133 #else
 134  ,LT_C    = LT (_NUMBER, KC_C)
 135  ,LT_V    = LT (_FNCKEY, KC_V)
 136  ,LT_N    = LT (_EDIT,   KC_N)
 137  ,LT_M    = LT (_SYMBOL, KC_M)
 138 #endif
 139  ,PS_BASE
 140 };
 141
 142 // modifier keys
 143 #define AT_B    ALT_T(KC_B)
 144 #define AT_DOWN ALT_T(KC_DOWN)
 145 #define CT_RGHT CTL_T(KC_RGHT)
 146 #define GT_C    GUI_T(KC_C)
 147 #define GT_UP   GUI_T(KC_UP)
 148 #define MT_E    MT   (MOD_LCTL | MOD_LALT, KC_E)
 149 #define MT_X    MT   (MOD_LALT | MOD_LSFT, KC_X)
 150 #define ST_A    SFT_T(KC_A)
 151 #ifdef HOME_MODS
 152 #define HOME_K  CTL_T(KC_K)
 153 #define HOME_H  GUI_T(KC_H)
 154 #define HOME_E  ALT_T(KC_E)
 155 #define HOME_A  SFT_T(KC_A)
 156 #if defined(BEAKLMU) || defined(BEAKLSP)
 157 #define HOME_T  SFT_T(KC_T)
 158 #define HOME_R  ALT_T(KC_R)
 159 #define HOME_S  GUI_T(KC_S)
 160 #define HOME_W  CTL_T(KC_W)
 161 #else
 162 #define HOME_T  SFT_T(KC_T)
 163 #define HOME_S  ALT_T(KC_S)
 164 #define HOME_N  GUI_T(KC_N)
 165 #define HOME_B  CTL_T(KC_B)
 166 #endif
 167 #else
 168 #define HOME_K  KC_K
 169 #define HOME_H  KC_H
 170 #define HOME_E  KC_E
 171 #define HOME_A  KC_A
 172 #define HOME_T  KC_T
 173 #define HOME_S  KC_S
 174 #define HOME_N  KC_N
 175 #define HOME_B  KC_B
 176 #endif
 177
 178 #define S_DOWN  S    (KC_DOWN)
 179 #define S_LEFT  S    (KC_LEFT)
 180 #define S_RGHT  S    (KC_RGHT)
 181 #define S_TAB   S    (KC_TAB)
 182 #define S_UP    S    (KC_UP)
 183
 184 #include "tapdance.h"
 185
 186 // keycodes
 187 #define ___x___ KC_TRNS
 188 #define ___fn__ KC_TRNS
 189 #ifdef _______
 190 #undef _______
 191 #endif
 192 #define _______ KC_NO
 193
 194 #define COPY    LCTL(KC_C)
 195 #define CUT     LCTL(KC_X)
 196 #define EOT     LCTL(KC_D)
 197 #define NAK     LCTL(KC_U)
 198 #define PASTE   LCTL(KC_V)
 199 #define UNDO    LCTL(KC_Z)
 200 #define TMCOPY  LALT(LCTL(KC_C))
 201 #define TMPASTE LALT(LCTL(KC_V))
 202 #define LT_BSLS LT  (_MOUSE,  KC_BSLS)      // see process_record_user() for extended handling
 203 #define LT_BSPC LT  (_EDIT,   KC_BSPC)
 204 #define SP_LEFT LT  (_EDIT,   KC_LEFT)
 205 #define LT_ESC  LT  (_NUMBER, KC_ESC)
 206 #define LT_LEFT LT  (_SYMBOL, KC_LEFT)      // see process_record_user() for extended handling
 207 #define SP_BSPC LT  (_SYMBOL, KC_BSPC)      // see process_record_user() for extended handling
 208 #define LT_TAB  LT  (_FNCKEY, KC_TAB)
 209 #define LT_INS  LT  (_FNCKEY, KC_INS)
 210 #define LT_ALTG LT  (_FNCKEY, KC_RALT)
 211 #define ADJUST  MO  (_ADJUST)
 212 #define OS_ALT  OSM (MOD_LALT)
 213 #define OS_CTL  OSM (MOD_LCTL)
 214 #define OS_GUI  OSM (MOD_LGUI)
 215 #define OS_SFT  OSM (MOD_LSFT)
 216 #define OS_CALT OSM (MOD_LALT | MOD_LCTL)
 217 #define OS_CGUI OSM (MOD_LGUI | MOD_LCTL)
 218 #define OS_CSFT OSM (MOD_LSFT | MOD_LCTL)
 219 #define OS_SALT OSM (MOD_LALT | MOD_LSFT)
 220 #define OS_SGUI OSM (MOD_LGUI | MOD_LSFT)
 221
 222 #ifdef CENTER_TT
 223 #ifdef BEAKLSP
 224 #define CNTR_TL OSM (MOD_LSFT)
 225 #else
 226 #define CNTR_TL TT  (_TTFNCKEY)
 227 #endif
 228 #define CNTR_TR KC_CAPS
 229 #define CNTR_HL TT  (_TTCURSOR)
 230 #define CNTR_HR TT  (_TTMOUSE)
 231 #define CNTR_BL TT  (_TTNUMBER)
 232 #define CNTR_BR TT  (_TTREGEX)
 233 #else
 234 #define CNTR_TL OSM (MOD_LALT | MOD_LCTL)
 235 #define CNTR_TR OSM (MOD_LGUI | MOD_LCTL)
 236 #define CNTR_HL OSM (MOD_LALT | MOD_LSFT)
 237 #define CNTR_HR OSM (MOD_LGUI | MOD_LSFT)
 238 #define CNTR_BL TD  (_CAPS)
 239 #define CNTR_BR OSM (MOD_LSFT | MOD_LCTL)
 240 #endif
 241
 242 #ifdef THUMB_0
 243 #define LT_EQL  LT  (_ADJUST, KC_EQL)
 244 #else
 245 #define LT_0    LT  (_ADJUST, KC_0)
 246 #endif
 247 #ifndef SHIFT_SYMBOLS
 248 #define LT_A    LT  (_NUMSYM, KC_A)
 249 #define LT_LFTX LT  (_SYMREG, KC_LEFT)
 250 #endif
 251
 252 // ........................................................ Default Alpha Layout
 253
 254 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 255
 256 #include "beakl.h"
 257 #include "colemak.h"
 258 #include "qwerty.h"
 259 #include "steno_layout.h"
 260
 261 // ...................................................... Number / Function Keys
 262
 263 #include "number_fkey_layout.h"
 264
 265 // ......................................................... Symbol / Navigation
 266
 267 #include "symbol_guifn_layout.h"
 268
 269 // ............................................................... Toggle Layers
 270
 271 #ifdef CENTER_TT
 272 #include "toggle_layout.h"
 273 #endif
 274
 275 // ......................................................... Short Cuts / Adjust
 276
 277 #include "chord_layout.h"
 278
 279 };
 280
 281 // ...................................................................... Sounds
 282
 283 #include "sounds.h"
 284
 285 // ........................................................... User Keycode Trap
 286
 287 #include "keycode_functions.h"
 288
 289 #define BASE_1  1
 290 #define BASE_2  2
 291 #define BASE_12 3
 292 static uint8_t base_n = 0;
 293
 294 bool process_record_user(uint16_t keycode, keyrecord_t *record)
 295 {
 296   switch (keycode) {
 297     case BASE1:
 298       if (record->event.pressed) {
 299         base_n = base_n | BASE_1;
 300         if (base_n == BASE_12) {
 301           base_layer();
 302         }
 303       }
 304       else {
 305         base_n = base_n & ~BASE_1;
 306       }
 307       return false;
 308     case BASE2:
 309       if (record->event.pressed) {
 310         base_n = base_n | BASE_2;
 311         if (base_n == BASE_12) {
 312           base_layer();
 313         }
 314       }
 315       else {
 316         base_n = base_n & ~BASE_2;
 317       }
 318       return false;
 319     case AT_DOWN:
 320 #ifdef HOME_MODS
 321     case HOME_E:
 322 #if defined(BEAKLMU) || defined(BEAKLSP)
 323     case HOME_R:
 324 #else
 325     case HOME_S:
 326 #endif
 327 #endif
 328       tap_mods(record, KC_LALT);
 329       break;
 330     case CT_RGHT:
 331 #ifdef HOME_MODS
 332     case HOME_K:
 333 #if defined(BEAKLMU) || defined(BEAKLSP)
 334     case HOME_W:
 335 #else
 336     case HOME_B:
 337 #endif
 338 #endif
 339       tap_mods(record, KC_LCTL);
 340       break;
 341     case GT_UP:
 342 #ifdef HOME_MODS
 343     case HOME_H:
 344 #if defined(BEAKLMU) || defined(BEAKLSP)
 345     case HOME_S:
 346 #else
 347     case HOME_N:
 348 #endif
 349 #endif
 350       tap_mods(record, KC_LGUI);
 351       break;
 352 #ifdef HOME_MODS
 353     case HOME_A:
 354     case HOME_T:
 355       tap_mods(record, KC_LSFT);
 356       break;
 357 #endif
 358 #ifdef CENTER_TT
 359     case TT_ESC:
 360       clear_tt();                           // exit TT layer
 361       return false;
 362 #endif
 363     case LT_ESC:
 364 #ifdef CENTER_TT
 365       if (tt_keycode != 0) {
 366         clear_tt();                         // exit TT layer
 367         return false;
 368       }
 369 #endif
 370       tap_layer(record, _NUMBER);
 371       break;
 372     case LT_LEFT:
 373     case SP_BSPC:
 374       tap_layer(record, _SYMBOL);
 375       // LT (_SYMBOL, KC_LEFT) left right combination layer
 376       thumb_layer(record, RIGHT, 0, 0, _SYMBOL, _LSHIFT);
 377       break;
 378     case OS_ALT:
 379       tap_mods(record, KC_LALT);
 380       break;
 381     case OS_CTL:
 382       tap_mods(record, KC_LCTL);
 383       break;
 384     case OS_GUI:
 385       tap_mods(record, KC_LGUI);
 386       break;
 387     case SM_CIRC:
 388       // GUI_T(S(KC_6))
 389       mt_shift(record, KC_LGUI, 0, KC_6);
 390       break;
 391     case SM_DLR:
 392       // SFT_T(S(KC_4))
 393       mt_shift(record, KC_LSFT, 0, KC_4);
 394       break;
 395     case SM_G:
 396       // MT(MOD_LALT | MOD_LSFT, S(KC_G))
 397       mt_shift(record, KC_LALT, KC_LSFT, KC_G);
 398       break;
 399     case SM_LPRN:
 400       // CTL_T(S(KC_9))
 401       mt_shift(record, KC_LCTL, 0, KC_9);
 402       break;
 403     case SM_PERC:
 404       // ALT_T(S(KC_5))
 405       mt_shift(record, KC_LALT, 0, KC_5);
 406       break;
 407     case LT_BSLS:
 408       tap_layer(record, _MOUSE);
 409       // LT (_MOUSE, KC_BSLS) left right combination layer, see #define LT_BSLS
 410       thumb_layer(record, LEFT, 0, 0, _MOUSE, _SYMBOL);
 411       break;
 412     case SL_LEFT:
 413       tap_layer(record, _MOUSE);
 414       // LT (_MOUSE, S(KC_LEFT)) left right combination layer
 415       thumb_layer(record, RIGHT, SHIFT, KC_LEFT, _MOUSE, _LSHIFT);
 416       break;
 417     case SP_DEL:
 418       tap_layer(record, _MOUSE);
 419       // LT (_MOUSE, S(KC_LEFT)) left right combination layer
 420       thumb_layer(record, RIGHT, NOSHIFT, KC_DEL, _MOUSE, _LSHIFT);
 421       break;
 422     case SL_PIPE:
 423       // LT (_ADJUST, S(KC_BSLS)) emulation
 424       lt_shift(record, KC_BSLS, _ADJUST);
 425       break;
 426     case SL_TAB:
 427       // LT (_FNCKEY, S(KC_TAB)) emulation
 428       lt_shift(record, KC_TAB, _FNCKEY);
 429       break;
 430     case TD_ENT:
 431       tap_layer(record, _RSHIFT);
 432       // LT (_RSHIFT, KC_ENT) emulation, see tap dance enter
 433       break;
 434     case TD_SPC:
 435       tap_layer(record, _LSHIFT);
 436       // LT (_LSHIFT, KC_SPC) left right combination layer, see tap dance TD_SPC
 437       thumb_layer(record, LEFT, 0, 0, _LSHIFT, _SYMBOL);
 438       break;
 439 #ifdef CENTER_TT
 440     case CNTR_TL:
 441     case CNTR_TR:
 442     case CNTR_HL:
 443     case CNTR_HR:
 444     case CNTR_BL:
 445     case CNTR_BR:
 446       if (tt_keycode != keycode && tt_keycode != 0) {
 447         clear_tt();                         // return to base layer first if different TT layer selected
 448       }
 449       tt_keycode = keycode;
 450       break;
 451 #endif
 452 // #ifdef STENO_ENABLE
 453 //     case PS_STNA:
 454 //       stn_layer(record, STN_A, _NUMBER);
 455 //       break;
 456 //     case PS_STNO:
 457 //       stn_layer(record, STN_O, _FNCKEY);
 458 //       break;
 459 //     case PS_STNE:
 460 //       stn_layer(record, STN_E, _EDIT);
 461 //       break;
 462 //     case PS_STNU:
 463 //       stn_layer(record, STN_U, _SYMBOL);
 464 //       break;
 465 // #endif
 466     case PS_BASE:
 467       if (record->event.pressed) {
 468         base_layer();
 469       }
 470       return false;
 471     case PLOVER:
 472       steno(record);
 473       return false;
 474     case PLOEXIT:
 475       steno_exit(record);
 476       return false;
 477   }
 478   return true;
 479 }
 480
 481 #include "init.h"