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 #undef  _______
 190 #define _______ KC_NO
 191
 192 #define COPY    LCTL(KC_C)
 193 #define CUT     LCTL(KC_X)
 194 #define EOT     LCTL(KC_D)
 195 #define NAK     LCTL(KC_U)
 196 #define PASTE   LCTL(KC_V)
 197 #define UNDO    LCTL(KC_Z)
 198 #define TMCOPY  LALT(LCTL(KC_C))
 199 #define TMPASTE LALT(LCTL(KC_V))
 200 #define LT_BSLS LT  (_MOUSE,  KC_BSLS)      // see process_record_user() for extended handling
 201 #define LT_BSPC LT  (_EDIT,   KC_BSPC)
 202 #define SP_LEFT LT  (_EDIT,   KC_LEFT)
 203 #define LT_ESC  LT  (_NUMBER, KC_ESC)
 204 #define LT_LEFT LT  (_SYMBOL, KC_LEFT)      // see process_record_user() for extended handling
 205 #define SP_BSPC LT  (_SYMBOL, KC_BSPC)      // see process_record_user() for extended handling
 206 #define LT_TAB  LT  (_FNCKEY, KC_TAB)
 207 #define LT_INS  LT  (_FNCKEY, KC_INS)
 208 #define LT_ALTG LT  (_FNCKEY, KC_RALT)
 209 #define ADJUST  MO  (_ADJUST)
 210 #define OS_ALT  OSM (MOD_LALT)
 211 #define OS_CTL  OSM (MOD_LCTL)
 212 #define OS_GUI  OSM (MOD_LGUI)
 213 #define OS_SFT  OSM (MOD_LSFT)
 214 #define OS_CALT OSM (MOD_LALT | MOD_LCTL)
 215 #define OS_CGUI OSM (MOD_LGUI | MOD_LCTL)
 216 #define OS_CSFT OSM (MOD_LSFT | MOD_LCTL)
 217 #define OS_SALT OSM (MOD_LALT | MOD_LSFT)
 218 #define OS_SGUI OSM (MOD_LGUI | MOD_LSFT)
 219
 220 #ifdef CENTER_TT
 221 #ifdef BEAKLSP
 222 #define CNTR_TL OSM (MOD_LSFT)
 223 #else
 224 #define CNTR_TL TT  (_TTFNCKEY)
 225 #endif
 226 #define CNTR_TR KC_CAPS
 227 #define CNTR_HL TT  (_TTCURSOR)
 228 #define CNTR_HR TT  (_TTMOUSE)
 229 #define CNTR_BL TT  (_TTNUMBER)
 230 #define CNTR_BR TT  (_TTREGEX)
 231 #else
 232 #define CNTR_TL OSM (MOD_LALT | MOD_LCTL)
 233 #define CNTR_TR OSM (MOD_LGUI | MOD_LCTL)
 234 #define CNTR_HL OSM (MOD_LALT | MOD_LSFT)
 235 #define CNTR_HR OSM (MOD_LGUI | MOD_LSFT)
 236 #define CNTR_BL TD  (_CAPS)
 237 #define CNTR_BR OSM (MOD_LSFT | MOD_LCTL)
 238 #endif
 239
 240 #ifdef THUMB_0
 241 #define LT_EQL  LT  (_ADJUST, KC_EQL)
 242 #else
 243 #define LT_0    LT  (_ADJUST, KC_0)
 244 #endif
 245 #ifndef SHIFT_SYMBOLS
 246 #define LT_A    LT  (_NUMSYM, KC_A)
 247 #define LT_LFTX LT  (_SYMREG, KC_LEFT)
 248 #endif
 249
 250 // ........................................................ Default Alpha Layout
 251
 252 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 253
 254 #include "beakl.h"
 255 #include "colemak.h"
 256 #include "qwerty.h"
 257 #include "steno_layout.h"
 258
 259 // ...................................................... Number / Function Keys
 260
 261 #include "number_fkey_layout.h"
 262
 263 // ......................................................... Symbol / Navigation
 264
 265 #include "symbol_guifn_layout.h"
 266
 267 // ............................................................... Toggle Layers
 268
 269 #ifdef CENTER_TT
 270 #include "toggle_layout.h"
 271 #endif
 272
 273 // ......................................................... Short Cuts / Adjust
 274
 275 #include "chord_layout.h"
 276
 277 };
 278
 279 // ...................................................................... Sounds
 280
 281 #include "sounds.h"
 282
 283 // ........................................................... User Keycode Trap
 284
 285 #include "keycode_functions.h"
 286
 287 #define BASE_1  1
 288 #define BASE_2  2
 289 #define BASE_12 3
 290 static uint8_t base_n = 0;
 291
 292 bool process_record_user(uint16_t keycode, keyrecord_t *record)
 293 {
 294   switch (keycode) {
 295     case BASE1:
 296       if (record->event.pressed) {
 297         base_n = base_n | BASE_1;
 298         if (base_n == BASE_12) {
 299           base_layer();
 300         }
 301       }
 302       else {
 303         base_n = base_n & ~BASE_1;
 304       }
 305       return false;
 306     case BASE2:
 307       if (record->event.pressed) {
 308         base_n = base_n | BASE_2;
 309         if (base_n == BASE_12) {
 310           base_layer();
 311         }
 312       }
 313       else {
 314         base_n = base_n & ~BASE_2;
 315       }
 316       return false;
 317     case AT_DOWN:
 318 #ifdef HOME_MODS
 319     case HOME_E:
 320 #if defined(BEAKLMU) || defined(BEAKLSP)
 321     case HOME_R:
 322 #else
 323     case HOME_S:
 324 #endif
 325 #endif
 326       tap_mods(record, KC_LALT);
 327       break;
 328     case CT_RGHT:
 329 #ifdef HOME_MODS
 330     case HOME_K:
 331 #if defined(BEAKLMU) || defined(BEAKLSP)
 332     case HOME_W:
 333 #else
 334     case HOME_B:
 335 #endif
 336 #endif
 337       tap_mods(record, KC_LCTL);
 338       break;
 339     case GT_UP:
 340 #ifdef HOME_MODS
 341     case HOME_H:
 342 #if defined(BEAKLMU) || defined(BEAKLSP)
 343     case HOME_S:
 344 #else
 345     case HOME_N:
 346 #endif
 347 #endif
 348       tap_mods(record, KC_LGUI);
 349       break;
 350 #ifdef HOME_MODS
 351     case HOME_A:
 352     case HOME_T:
 353       tap_mods(record, KC_LSFT);
 354       break;
 355 #endif
 356 #ifdef CENTER_TT
 357     case TT_ESC:
 358       clear_tt();                           // exit TT layer
 359       return false;
 360 #endif
 361     case LT_ESC:
 362 #ifdef CENTER_TT
 363       if (tt_keycode != 0) {
 364         clear_tt();                         // exit TT layer
 365         return false;
 366       }
 367 #endif
 368       tap_layer(record, _NUMBER);
 369       break;
 370     case LT_LEFT:
 371     case SP_BSPC:
 372       tap_layer(record, _SYMBOL);
 373       // LT (_SYMBOL, KC_LEFT) left right combination layer
 374       thumb_layer(record, RIGHT, 0, 0, _SYMBOL, _LSHIFT);
 375       break;
 376     case OS_ALT:
 377       tap_mods(record, KC_LALT);
 378       break;
 379     case OS_CTL:
 380       tap_mods(record, KC_LCTL);
 381       break;
 382     case OS_GUI:
 383       tap_mods(record, KC_LGUI);
 384       break;
 385     case SM_CIRC:
 386       // GUI_T(S(KC_6))
 387       mt_shift(record, KC_LGUI, 0, KC_6);
 388       break;
 389     case SM_DLR:
 390       // SFT_T(S(KC_4))
 391       mt_shift(record, KC_LSFT, 0, KC_4);
 392       break;
 393     case SM_G:
 394       // MT(MOD_LALT | MOD_LSFT, S(KC_G))
 395       mt_shift(record, KC_LALT, KC_LSFT, KC_G);
 396       break;
 397     case SM_LPRN:
 398       // CTL_T(S(KC_9))
 399       mt_shift(record, KC_LCTL, 0, KC_9);
 400       break;
 401     case SM_PERC:
 402       // ALT_T(S(KC_5))
 403       mt_shift(record, KC_LALT, 0, KC_5);
 404       break;
 405     case LT_BSLS:
 406       tap_layer(record, _MOUSE);
 407       // LT (_MOUSE, KC_BSLS) left right combination layer, see #define LT_BSLS
 408       thumb_layer(record, LEFT, 0, 0, _MOUSE, _SYMBOL);
 409       break;
 410     case SL_LEFT:
 411       tap_layer(record, _MOUSE);
 412       // LT (_MOUSE, S(KC_LEFT)) left right combination layer
 413       thumb_layer(record, RIGHT, SHIFT, KC_LEFT, _MOUSE, _LSHIFT);
 414       break;
 415     case SP_DEL:
 416       tap_layer(record, _MOUSE);
 417       // LT (_MOUSE, S(KC_LEFT)) left right combination layer
 418       thumb_layer(record, RIGHT, NOSHIFT, KC_DEL, _MOUSE, _LSHIFT);
 419       break;
 420     case SL_PIPE:
 421       // LT (_ADJUST, S(KC_BSLS)) emulation
 422       lt_shift(record, KC_BSLS, _ADJUST);
 423       break;
 424     case SL_TAB:
 425       // LT (_FNCKEY, S(KC_TAB)) emulation
 426       lt_shift(record, KC_TAB, _FNCKEY);
 427       break;
 428     case TD_ENT:
 429       tap_layer(record, _RSHIFT);
 430       // LT (_RSHIFT, KC_ENT) emulation, see tap dance enter
 431       break;
 432     case TD_SPC:
 433       tap_layer(record, _LSHIFT);
 434       // LT (_LSHIFT, KC_SPC) left right combination layer, see tap dance TD_SPC
 435       thumb_layer(record, LEFT, 0, 0, _LSHIFT, _SYMBOL);
 436       break;
 437 #ifdef CENTER_TT
 438     case CNTR_TL:
 439     case CNTR_TR:
 440     case CNTR_HL:
 441     case CNTR_HR:
 442     case CNTR_BL:
 443     case CNTR_BR:
 444       if (tt_keycode != keycode && tt_keycode != 0) {
 445         clear_tt();                         // return to base layer first if different TT layer selected
 446       }
 447       tt_keycode = keycode;
 448       break;
 449 #endif
 450 // #ifdef STENO_ENABLE
 451 //     case PS_STNA:
 452 //       stn_layer(record, STN_A, _NUMBER);
 453 //       break;
 454 //     case PS_STNO:
 455 //       stn_layer(record, STN_O, _FNCKEY);
 456 //       break;
 457 //     case PS_STNE:
 458 //       stn_layer(record, STN_E, _EDIT);
 459 //       break;
 460 //     case PS_STNU:
 461 //       stn_layer(record, STN_U, _SYMBOL);
 462 //       break;
 463 // #endif
 464     case PS_BASE:
 465       if (record->event.pressed) {
 466         base_layer();
 467       }
 468       return false;
 469     case PLOVER:
 470       steno(record);
 471       return false;
 472     case PLOEXIT:
 473       steno_exit(record);
 474       return false;
 475   }
 476   return true;
 477 }
 478
 479 #include "init.h"