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