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