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