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