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 QMK_KEYBOARD_H
  70 #ifdef STENO_ENABLE
  71 #include "keymap_steno.h"
  72 #endif
  73
  74 extern keymap_config_t keymap_config;
  75
  76 enum planck_layers {
  77   _BASE = 0
  78  ,_SHIFT
  79  ,_LSHIFT
  80  ,_RSHIFT
  81  ,_PLOVER
  82  ,_NUMBER
  83  ,_SYMBOL
  84  ,_FNCKEY
  85  ,_MOUSE
  86 #ifdef CENTER_TT
  87  ,_TTNUMBER
  88  ,_TTREGEX
  89  ,_TTFNCKEY
  90  ,_TTCURSOR
  91  ,_TTMOUSE
  92 #endif
  93 #ifndef SHIFT_SYMBOLS
  94  ,_NUMSYM
  95  ,_SYMREG
  96 #endif
  97  ,_EDIT
  98  ,_QWERTY
  99  ,_ADJUST
 100  ,_END_LAYERS
 101 };
 102
 103 enum planck_keycodes {
 104   BASE = SAFE_RANGE
 105  ,BASE1
 106  ,BASE2
 107  ,PLOVER
 108  ,PLOEXIT
 109  ,SM_CIRC   // pseudo GUI_T(S(KC_6))                      for shifted key-codes, see process_record_user()
 110  ,SM_DLR    // pseudo SFT_T(S(KC_4))                      for shifted key-codes, see process_record_user()
 111  ,SM_G      // pseudo MT   (MOD_LALT | MOD_LSFT, S(KC_G)) for shifted key-codes, see process_record_user()
 112  ,SM_PERC   // pseudo ALT_T(S(KC_5))                      for shifted key-codes, see process_record_user()
 113  ,SM_LPRN   // pseudo CTL_T(S(KC_9))                      for shifted key-codes, see process_record_user()
 114  ,SL_LEFT   // pseudo LT   (_MOUSE, S(KC_LEFT))           for shifted key-codes, see process_record_user()
 115  ,SP_DEL    // pseudo LT   (_MOUSE, KC_DEL)               for shifted key-codes, see process_record_user()
 116  ,SL_PIPE   // pseudo LT   (_ADJUST, S(KC_BSLS))          for shifted key-codes, see process_record_user()
 117  ,SL_TAB    // pseudo LT   (_FNCKEY, S(KC_TAB))           for shifted key-codes, see process_record_user()
 118 #ifdef CENTER_TT
 119  ,TT_ESC
 120 #endif
 121 #ifdef STENO_ENABLE
 122  ,PS_STNA = STN_A
 123  ,PS_STNO = STN_O
 124  ,PS_STNE = STN_E
 125  ,PS_STNU = STN_U
 126 #else
 127  ,LT_C    = LT (_NUMBER, KC_C)
 128  ,LT_V    = LT (_FNCKEY, KC_V)
 129  ,LT_N    = LT (_EDIT,   KC_N)
 130  ,LT_M    = LT (_SYMBOL, KC_M)
 131 #endif
 132  ,PS_BASE
 133 };
 134
 135 // modifier keys
 136 #define AT_B    ALT_T(KC_B)
 137 #define AT_DOWN ALT_T(KC_DOWN)
 138 #define CT_RGHT CTL_T(KC_RGHT)
 139 #define GT_C    GUI_T(KC_C)
 140 #define GT_UP   GUI_T(KC_UP)
 141 #define MT_E    MT   (MOD_LCTL | MOD_LALT, KC_E)
 142 #define MT_X    MT   (MOD_LALT | MOD_LSFT, KC_X)
 143 #define ST_A    SFT_T(KC_A)
 144 #ifdef HOME_MODS
 145 #define HOME_K  CTL_T(KC_K)
 146 #define HOME_H  GUI_T(KC_H)
 147 #define HOME_E  ALT_T(KC_E)
 148 #define HOME_A  SFT_T(KC_A)
 149 #if defined(BEAKLMU) || defined(BEAKLSP)
 150 #define HOME_T  SFT_T(KC_T)
 151 #define HOME_R  ALT_T(KC_R)
 152 #define HOME_S  GUI_T(KC_S)
 153 #define HOME_W  CTL_T(KC_W)
 154 #else
 155 #define HOME_T  SFT_T(KC_T)
 156 #define HOME_S  ALT_T(KC_S)
 157 #define HOME_N  GUI_T(KC_N)
 158 #define HOME_B  CTL_T(KC_B)
 159 #endif
 160 #else
 161 #define HOME_K  KC_K
 162 #define HOME_H  KC_H
 163 #define HOME_E  KC_E
 164 #define HOME_A  KC_A
 165 #define HOME_T  KC_T
 166 #define HOME_S  KC_S
 167 #define HOME_N  KC_N
 168 #define HOME_B  KC_B
 169 #endif
 170
 171 #define S_DOWN  S    (KC_DOWN)
 172 #define S_LEFT  S    (KC_LEFT)
 173 #define S_RGHT  S    (KC_RGHT)
 174 #define S_TAB   S    (KC_TAB)
 175 #define S_UP    S    (KC_UP)
 176
 177 #include "common/tapdance.h"
 178
 179 // keycodes
 180 #define ___x___ KC_TRNS
 181 #define ___fn__ KC_TRNS
 182 #undef  _______
 183 #define _______ KC_NO
 184
 185 #define COPY    LCTL(KC_C)
 186 #define CUT     LCTL(KC_X)
 187 #define EOT     LCTL(KC_D)
 188 #define NAK     LCTL(KC_U)
 189 #define PASTE   LCTL(KC_V)
 190 #define UNDO    LCTL(KC_Z)
 191 #define TMCOPY  LALT(LCTL(KC_C))
 192 #define TMPASTE LALT(LCTL(KC_V))
 193 #define LT_BSLS LT  (_MOUSE,  KC_BSLS)      // see process_record_user() for extended handling
 194 #define LT_BSPC LT  (_EDIT,   KC_BSPC)
 195 #define SP_LEFT LT  (_EDIT,   KC_LEFT)
 196 #define LT_ESC  LT  (_NUMBER, KC_ESC)
 197 #define LT_LEFT LT  (_SYMBOL, KC_LEFT)      // see process_record_user() for extended handling
 198 #define SP_BSPC LT  (_SYMBOL, KC_BSPC)      // see process_record_user() for extended handling
 199 #define LT_TAB  LT  (_FNCKEY, KC_TAB)
 200 #define LT_INS  LT  (_FNCKEY, KC_INS)
 201 #define LT_ALTG LT  (_FNCKEY, KC_RALT)
 202 #define ADJUST  MO  (_ADJUST)
 203 #define OS_ALT  OSM (MOD_LALT)
 204 #define OS_CTL  OSM (MOD_LCTL)
 205 #define OS_GUI  OSM (MOD_LGUI)
 206 #define OS_SFT  OSM (MOD_LSFT)
 207 #define OS_CALT OSM (MOD_LALT | MOD_LCTL)
 208 #define OS_CGUI OSM (MOD_LGUI | MOD_LCTL)
 209 #define OS_CSFT OSM (MOD_LSFT | MOD_LCTL)
 210 #define OS_SALT OSM (MOD_LALT | MOD_LSFT)
 211 #define OS_SGUI OSM (MOD_LGUI | MOD_LSFT)
 212
 213 #ifdef CENTER_TT
 214 #ifdef BEAKLSP
 215 #define CNTR_TL OSM (MOD_LSFT)
 216 #else
 217 #define CNTR_TL TT  (_TTFNCKEY)
 218 #endif
 219 #define CNTR_TR KC_CAPS
 220 #define CNTR_HL TT  (_TTCURSOR)
 221 #define CNTR_HR TT  (_TTMOUSE)
 222 #define CNTR_BL TT  (_TTNUMBER)
 223 #define CNTR_BR TT  (_TTREGEX)
 224 #else
 225 #define CNTR_TL OSM (MOD_LALT | MOD_LCTL)
 226 #define CNTR_TR OSM (MOD_LGUI | MOD_LCTL)
 227 #define CNTR_HL OSM (MOD_LALT | MOD_LSFT)
 228 #define CNTR_HR OSM (MOD_LGUI | MOD_LSFT)
 229 #define CNTR_BL TD  (_CAPS)
 230 #define CNTR_BR OSM (MOD_LSFT | MOD_LCTL)
 231 #endif
 232
 233 #ifdef THUMB_0
 234 #define LT_EQL  LT  (_ADJUST, KC_EQL)
 235 #else
 236 #define LT_0    LT  (_ADJUST, KC_0)
 237 #endif
 238 #ifndef SHIFT_SYMBOLS
 239 #define LT_A    LT  (_NUMSYM, KC_A)
 240 #define LT_LFTX LT  (_SYMREG, KC_LEFT)
 241 #endif
 242
 243 // ........................................................ Default Alpha Layout
 244
 245 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 246
 247 #include "beakl.h"
 248 #include "colemak.h"
 249 #include "qwerty.h"
 250 #include "common/steno_layout.h"
 251
 252 // ...................................................... Number / Function Keys
 253
 254 #include "common/number_fkey_layout.h"
 255
 256 // ......................................................... Symbol / Navigation
 257
 258 #include "common/symbol_guifn_layout.h"
 259
 260 // ............................................................... Toggle Layers
 261
 262 #ifdef CENTER_TT
 263 #include "common/toggle_layout.h"
 264 #endif
 265
 266 // ......................................................... Short Cuts / Adjust
 267
 268 #include "common/chord_layout.h"
 269
 270 };
 271
 272 // ...................................................................... Sounds
 273
 274 #include "common/sounds.h"
 275
 276 // ........................................................... User Keycode Trap
 277
 278 #include "common/keycode_functions.h"
 279
 280 #define BASE_1  1
 281 #define BASE_2  2
 282 #define BASE_12 3
 283 static uint8_t base_n = 0;
 284
 285 bool process_record_user(uint16_t keycode, keyrecord_t *record)
 286 {
 287   switch (keycode) {
 288     case BASE1:
 289       if (record->event.pressed) {
 290         base_n = base_n | BASE_1;
 291         if (base_n == BASE_12) {
 292           base_layer();
 293         }
 294       }
 295       else {
 296         base_n = base_n & ~BASE_1;
 297       }
 298       return false;
 299     case BASE2:
 300       if (record->event.pressed) {
 301         base_n = base_n | BASE_2;
 302         if (base_n == BASE_12) {
 303           base_layer();
 304         }
 305       }
 306       else {
 307         base_n = base_n & ~BASE_2;
 308       }
 309       return false;
 310     case AT_DOWN:
 311 #ifdef HOME_MODS
 312     case HOME_E:
 313 #if defined(BEAKLMU) || defined(BEAKLSP)
 314     case HOME_R:
 315 #else
 316     case HOME_S:
 317 #endif
 318 #endif
 319       tap_mods(record, KC_LALT);
 320       break;
 321     case CT_RGHT:
 322 #ifdef HOME_MODS
 323     case HOME_K:
 324 #if defined(BEAKLMU) || defined(BEAKLSP)
 325     case HOME_W:
 326 #else
 327     case HOME_B:
 328 #endif
 329 #endif
 330       tap_mods(record, KC_LCTL);
 331       break;
 332     case GT_UP:
 333 #ifdef HOME_MODS
 334     case HOME_H:
 335 #if defined(BEAKLMU) || defined(BEAKLSP)
 336     case HOME_S:
 337 #else
 338     case HOME_N:
 339 #endif
 340 #endif
 341       tap_mods(record, KC_LGUI);
 342       break;
 343 #ifdef HOME_MODS
 344     case HOME_A:
 345     case HOME_T:
 346       tap_mods(record, KC_LSFT);
 347       break;
 348 #endif
 349 #ifdef CENTER_TT
 350     case TT_ESC:
 351       clear_tt();                           // exit TT layer
 352       return false;
 353 #endif
 354     case LT_ESC:
 355 #ifdef CENTER_TT
 356       if (tt_keycode != 0) {
 357         clear_tt();                         // exit TT layer
 358         return false;
 359       }
 360 #endif
 361       tap_layer(record, _NUMBER);
 362       break;
 363     case LT_LEFT:
 364     case SP_BSPC:
 365       tap_layer(record, _SYMBOL);
 366       // LT (_SYMBOL, KC_LEFT) left right combination layer
 367       thumb_layer(record, RIGHT, 0, 0, _SYMBOL, _LSHIFT);
 368       break;
 369     case OS_ALT:
 370       tap_mods(record, KC_LALT);
 371       break;
 372     case OS_CTL:
 373       tap_mods(record, KC_LCTL);
 374       break;
 375     case OS_GUI:
 376       tap_mods(record, KC_LGUI);
 377       break;
 378     case SM_CIRC:
 379       // GUI_T(S(KC_6))
 380       mt_shift(record, KC_LGUI, 0, KC_6);
 381       break;
 382     case SM_DLR:
 383       // SFT_T(S(KC_4))
 384       mt_shift(record, KC_LSFT, 0, KC_4);
 385       break;
 386     case SM_G:
 387       // MT(MOD_LALT | MOD_LSFT, S(KC_G))
 388       mt_shift(record, KC_LALT, KC_LSFT, KC_G);
 389       break;
 390     case SM_LPRN:
 391       // CTL_T(S(KC_9))
 392       mt_shift(record, KC_LCTL, 0, KC_9);
 393       break;
 394     case SM_PERC:
 395       // ALT_T(S(KC_5))
 396       mt_shift(record, KC_LALT, 0, KC_5);
 397       break;
 398     case LT_BSLS:
 399       tap_layer(record, _MOUSE);
 400       // LT (_MOUSE, KC_BSLS) left right combination layer, see #define LT_BSLS
 401       thumb_layer(record, LEFT, 0, 0, _MOUSE, _SYMBOL);
 402       break;
 403     case SL_LEFT:
 404       tap_layer(record, _MOUSE);
 405       // LT (_MOUSE, S(KC_LEFT)) left right combination layer
 406       thumb_layer(record, RIGHT, SHIFT, KC_LEFT, _MOUSE, _LSHIFT);
 407       break;
 408     case SP_DEL:
 409       tap_layer(record, _MOUSE);
 410       // LT (_MOUSE, S(KC_LEFT)) left right combination layer
 411       thumb_layer(record, RIGHT, NOSHIFT, KC_DEL, _MOUSE, _LSHIFT);
 412       break;
 413     case SL_PIPE:
 414       // LT (_ADJUST, S(KC_BSLS)) emulation
 415       lt_shift(record, KC_BSLS, _ADJUST);
 416       break;
 417     case SL_TAB:
 418       // LT (_FNCKEY, S(KC_TAB)) emulation
 419       lt_shift(record, KC_TAB, _FNCKEY);
 420       break;
 421     case TD_ENT:
 422       tap_layer(record, _RSHIFT);
 423       // LT (_RSHIFT, KC_ENT) emulation, see tap dance enter
 424       break;
 425     case TD_SPC:
 426       tap_layer(record, _LSHIFT);
 427       // LT (_LSHIFT, KC_SPC) left right combination layer, see tap dance TD_SPC
 428       thumb_layer(record, LEFT, 0, 0, _LSHIFT, _SYMBOL);
 429       break;
 430 #ifdef CENTER_TT
 431     case CNTR_TL:
 432     case CNTR_TR:
 433     case CNTR_HL:
 434     case CNTR_HR:
 435     case CNTR_BL:
 436     case CNTR_BR:
 437       if (tt_keycode != keycode && tt_keycode != 0) {
 438         clear_tt();                         // return to base layer first if different TT layer selected
 439       }
 440       tt_keycode = keycode;
 441       break;
 442 #endif
 443 // #ifdef STENO_ENABLE
 444 //     case PS_STNA:
 445 //       stn_layer(record, STN_A, _NUMBER);
 446 //       break;
 447 //     case PS_STNO:
 448 //       stn_layer(record, STN_O, _FNCKEY);
 449 //       break;
 450 //     case PS_STNE:
 451 //       stn_layer(record, STN_E, _EDIT);
 452 //       break;
 453 //     case PS_STNU:
 454 //       stn_layer(record, STN_U, _SYMBOL);
 455 //       break;
 456 // #endif
 457     case PS_BASE:
 458       if (record->event.pressed) {
 459         base_layer();
 460       }
 461       return false;
 462     case PLOVER:
 463       steno(record);
 464       return false;
 465     case PLOEXIT:
 466       steno_exit(record);
 467       return false;
 468   }
 469   return true;
 470 }
 471
 472 #include "common/init.h"