keyboards/planck/keymaps/grahampheath/keymap.c

   1 /* Copyright 2015-2017 Jack Humbert
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16 #include "planck.h"
  17 #include "action_layer.h"
  18 #include "action_code.h"
  19
  20 extern keymap_config_t keymap_config;
  21
  22 enum planck_layers {
  23   _QWERTY,
  24   _COLEMAK,
  25   _DVORAK,
  26   _LOWER,
  27   _RAISE,
  28   _EMOJI,
  29   _PLOVER,
  30   _ADJUST
  31 };
  32
  33 enum planck_keycodes {
  34   QWERTY = SAFE_RANGE,
  35   COLEMAK,
  36   DVORAK,
  37   PLOVER,
  38   LOWER,
  39   RAISE,
  40   BACKLIT,
  41   EXT_PLV,
  42   TOUNGE,
  43   JOY,
  44   FROWN,
  45   HEART,
  46   THMBUP,
  47   THMBDN,
  48   SHRUG,
  49   WINK,
  50   GRIN,
  51   LLAP,
  52   CRY,
  53   SHIT,
  54   FLIP,
  55   FNGLEFT,
  56   ABOVE,
  57   FNGRIGHT,
  58   CONFUSED
  59 };
  60
  61
  62 #define KC_X0 MT(MOD_LCTL, KC_ESC)  // Hold for Left Ctrl, Tap for ESC
  63 #define KC_X1 MT(MOD_RSFT, KC_ENT)  // Hold for Right Shift, Tap for Enter
  64 #define KC_X2 MT(MOD_RSFT, LGUI(KC_ENT))  // Send Command Enter
  65 #define KC_MOUS TT(_EMOJI)  // Hold for Mouse Layer, or tap 5 times.
  66 #define KC_QS LGUI(KC_SPC)  // Send Command + Space (for QuickSilver).
  67 #define KC_TABR LGUI(KC_RCBR)  // Send Command + } (for tab changing).
  68 #define KC_TABL LGUI(KC_LCBR)  // Send Command + { (for tab changing).
  69 #define HYPR_0 HYPR(KC_TILD)  // Send Hyper + ~.
  70 #define HYPR_1 HYPR(KC_EXLM)  // Send Hyper + !.
  71 #define HYPR_2 HYPR(KC_AT)  // Send Hyper + @.
  72
  73
  74 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  75 /* Qwerty
  76  * ,-----------------------------------------------------------------------------------.
  77  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  78  * |------+------+------+------+------+-------------+------+------+------+------+------|
  79  * | Esc* |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  80  * |------+------+------+------+------+------|------+------+------+------+------+------|
  81  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Shift*|
  82  * |------+------+------+------+------+------+------+------+------+------+------+------|
  83  * | GUI  | Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  84  * `-----------------------------------------------------------------------------------'
  85  * - Right Shift: Tap for Enter, hold for shift.
  86  * - Escape: Tap for Esc, hold for Ctrl.
  87  */
  88 [_QWERTY] = {
  89   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  90   {KC_X0,   KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  91   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_X1  },
  92   {KC_MOUS, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  93 },
  94
  95 /* Colemak
  96  * ,-----------------------------------------------------------------------------------.
  97  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  98  * |------+------+------+------+------+-------------+------+------+------+------+------|
  99  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
 100  * |------+------+------+------+------+------|------+------+------+------+------+------|
 101  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
 102  * |------+------+------+------+------+------+------+------+------+------+------+------|
 103  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
 104  * `-----------------------------------------------------------------------------------'
 105  */
 106 [_COLEMAK] = {
 107   {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
 108   {KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
 109   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
 110   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
 111 },
 112
 113 /* Dvorak
 114  * ,-----------------------------------------------------------------------------------.
 115  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
 116  * |------+------+------+------+------+-------------+------+------+------+------+------|
 117  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
 118  * |------+------+------+------+------+------|------+------+------+------+------+------|
 119  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
 120  * |------+------+------+------+------+------+------+------+------+------+------+------|
 121  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
 122  * `-----------------------------------------------------------------------------------'
 123  */
 124 [_DVORAK] = {
 125   {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
 126   {KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
 127   {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT },
 128   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
 129 },
 130
 131
 132 /* Emoji Layer
 133  *
 134  *                ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
 135  *                │HYPR0│     │ ;-) │     │     │ :-P │     │     │:'-( │FLIP │     │     │
 136  *                ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
 137  *                │HYPR1│  👆 │SHRUG│     │ :-( │     │ <3  │ :-) │     │LLAP │     │     │
 138  *                ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
 139  *                │HYPR2│     │     │     | :-\ │     │     │ :-D │ SHIT│     │     │     │
 140  *                ├─────┼─────┼─────┼─────┼─────┼─────┴─────┼─────┼─────┼─────┼─────┼─────┤
 141  *                │     │     │     │     │Brig-│   Sleep   │Brig+│ 👈  │ 👎  |  👍 │ 👉 │
 142  *                └─────┴─────┴─────┴─────┴─────┴───────────┴─────┴─────┴─────┴─────┴─────┘
 143  */
 144 [_EMOJI] = {
 145   {HYPR_0,  _______, WINK,    _______, _______,  TOUNGE,  _______, _______, CRY,     FLIP,    _______, _______},
 146   {HYPR_1,  ABOVE,   SHRUG,   _______, FROWN,    _______, HEART,   JOY,     _______, LLAP,    _______, _______},
 147   {HYPR_2,  _______, _______, _______, CONFUSED, _______, _______, GRIN,    SHIT,    _______, _______, _______},
 148   {_______, _______, _______, _______, KC_SLCK,  KC_SLEP, KC_SLEP, KC_PAUS, FNGLEFT, THMBDN,  THMBUP,  FNGRIGHT}
 149 },
 150
 151
 152 /* Lower
 153  * ,-----------------------------------------------------------------------------------.
 154  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 155  * |------+------+------+------+------+-------------+------+------+------+------+------|
 156  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 157  * |------+------+------+------+------+------|------+------+------+------+------+------|
 158  * | Shft |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | |      |      |      |
 159  * |------+------+------+------+------+------+------+------+------+------+------+------|
 160  * |      |      |      |      |      |             |      |Tab-L |  👎  |  👍  |Tab-R |
 161  * `-----------------------------------------------------------------------------------'
 162  */
 163 [_LOWER] = {
 164   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR,    KC_ASTR,    KC_LPRN, KC_RPRN, KC_BSPC},
 165   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS,    KC_PLUS,    KC_LCBR, KC_RCBR, KC_PIPE},
 166   {KC_LSFT, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  S(KC_NUHS), S(KC_NUBS), _______, _______, _______},
 167   {_______, _______, _______, _______, _______, KC_QS,   KC_QS,   _______,    KC_TABL,    THMBDN,  THMBUP, KC_TABR}
 168 },
 169
 170 /* Raise
 171  * ,-----------------------------------------------------------------------------------.
 172  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 173  * |------+------+------+------+------+-------------+------+------+------+------+------|
 174  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 175  * |------+------+------+------+------+------|------+------+------+------+------+------|
 176  * | Shft |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |      |  Up  |CTLENT|
 177  * |------+------+------+------+------+------+------+------+------+------+------+------|
 178  * |      |      |      |      |      |             |      |      | Left | Down | Right|
 179  * `-----------------------------------------------------------------------------------'
 180  */
 181 [_RAISE] = {
 182   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,     KC_9,    KC_0,    KC_BSPC},
 183   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,   KC_LBRC, KC_RBRC, KC_BSLS},
 184   {KC_LSFT, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS,  _______,  KC_UP,   KC_X2},
 185   {_______, _______, _______, _______, _______, _______, _______, _______, _______,  KC_LEFT, KC_DOWN, KC_RGHT}
 186 },
 187
 188 /* Plover layer (http://opensteno.org)
 189  * ,-----------------------------------------------------------------------------------.
 190  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 191  * |------+------+------+------+------+-------------+------+------+------+------+------|
 192  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 193  * |------+------+------+------+------+------|------+------+------+------+------+------|
 194  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 195  * |------+------+------+------+------+------+------+------+------+------+------+------|
 196  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 197  * `-----------------------------------------------------------------------------------'
 198  */
 199 [_PLOVER] = {
 200   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 201   {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 202   {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 203   {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 204 },
 205
 206 /* Adjust (Lower + Raise)
 207  * ,-----------------------------------------------------------------------------------.
 208  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 209  * |------+------+------+------+------+-------------+------+------+------+------+------|
 210  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 211  * |------+------+------+------+------+------|------+------+------+------+------+------|
 212  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 213  * |------+------+------+------+------+------+------+------+------+------+------+------|
 214  * |Brite |      |      |      |      |             |      |      |      |      |      |
 215  * `-----------------------------------------------------------------------------------'
 216  */
 217 [_ADJUST] = {
 218   {_______, RESET,   DEBUG,   _______, _______, _______, _______, TERM_ON, TERM_OFF,_______, _______, KC_DEL },
 219   {_______, _______, MU_MOD,  AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______},
 220   {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 221   {BACKLIT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 222 }
 223
 224
 225 };
 226
 227 #ifdef AUDIO_ENABLE
 228   float plover_song[][2]     = SONG(PLOVER_SOUND);
 229   float plover_gb_song[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 230 #endif
 231
 232 #ifdef BACKLIGHT_ENABLE
 233   bool has_layer_changed = true;
 234
 235   void matrix_scan_user(void) {
 236     uint8_t layer = biton32(layer_state);
 237     static uint8_t old_layer = 0;
 238
 239     if (old_layer != layer) {
 240       has_layer_changed = true;
 241       old_layer = layer;
 242     }
 243
 244     if (has_layer_changed) {
 245       has_layer_changed = false;
 246
 247       switch (layer) {
 248         case _LOWER:
 249           backlight_set(1);
 250         break;
 251         case _QWERTY:
 252           backlight_set(2);
 253         break;
 254         case _RAISE:
 255           backlight_set(3);
 256         break;
 257         case _ADJUST:
 258           backlight_set(4);
 259         break;
 260       }
 261     }
 262   };
 263 #endif
 264
 265 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 266   switch (keycode) {
 267     case QWERTY:
 268       if (record->event.pressed) {
 269         print("mode just switched to qwerty and this is a huge string\n");
 270         set_single_persistent_default_layer(_QWERTY);
 271       }
 272       return false;
 273       break;
 274     case COLEMAK:
 275       if (record->event.pressed) {
 276         set_single_persistent_default_layer(_COLEMAK);
 277       }
 278       return false;
 279       break;
 280     case DVORAK:
 281       if (record->event.pressed) {
 282         set_single_persistent_default_layer(_DVORAK);
 283       }
 284       return false;
 285       break;
 286     case LOWER:
 287       if (record->event.pressed) {
 288         layer_on(_LOWER);
 289         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 290       } else {
 291         layer_off(_LOWER);
 292         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 293       }
 294       return false;
 295       break;
 296     case RAISE:
 297       if (record->event.pressed) {
 298         layer_on(_RAISE);
 299         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 300       } else {
 301         layer_off(_RAISE);
 302         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 303       }
 304       return false;
 305       break;
 306     case BACKLIT:
 307       if (record->event.pressed) {
 308         register_code(KC_RSFT);
 309         #ifdef BACKLIGHT_ENABLE
 310           backlight_step();
 311         #endif
 312       } else {
 313         unregister_code(KC_RSFT);
 314       }
 315       return false;
 316       break;
 317     case PLOVER:
 318       if (record->event.pressed) {
 319         #ifdef AUDIO_ENABLE
 320           stop_all_notes();
 321           PLAY_SONG(plover_song);
 322         #endif
 323         layer_off(_RAISE);
 324         layer_off(_LOWER);
 325         layer_off(_ADJUST);
 326         layer_off(_EMOJI);
 327         layer_on(_PLOVER);
 328         if (!eeconfig_is_enabled()) {
 329             eeconfig_init();
 330         }
 331         keymap_config.raw = eeconfig_read_keymap();
 332         keymap_config.nkro = 1;
 333         eeconfig_update_keymap(keymap_config.raw);
 334       }
 335       return false;
 336       break;
 337     case EXT_PLV:
 338       if (record->event.pressed) {
 339         #ifdef AUDIO_ENABLE
 340           PLAY_SONG(plover_gb_song);
 341         #endif
 342         layer_off(_PLOVER);
 343       }
 344       return false;
 345       break;
 346     case FLIP:
 347       if (record->event.pressed) {
 348         SEND_STRING("&fliptable;");
 349       }
 350       return false;
 351       break;
 352     case CONFUSED:
 353       if (record->event.pressed) {
 354         SEND_STRING(":-\\");
 355       }
 356       return false;
 357       break;
 358     case SHIT:
 359       if (record->event.pressed) {
 360         SEND_STRING("&shit; ");
 361       }
 362       return false;
 363       break;
 364     case CRY:
 365       if (record->event.pressed) {
 366         SEND_STRING(":'-( ");
 367       }
 368       return false;
 369       break;
 370     case LLAP:
 371       if (record->event.pressed) {
 372         SEND_STRING("&llap; ");
 373       }
 374       return false;
 375       break;
 376     case GRIN:
 377       if (record->event.pressed) {
 378         SEND_STRING(":-D ");
 379       }
 380       return false;
 381       break;
 382     case TOUNGE:
 383       if (record->event.pressed) {
 384         SEND_STRING(":-P ");
 385       }
 386       return false;
 387       break;
 388     case JOY:
 389       if (record->event.pressed) {
 390         SEND_STRING(":-) ");
 391       }
 392       return false;
 393       break;
 394     case FROWN:
 395       if (record->event.pressed) {
 396         SEND_STRING(":-( ");
 397       }
 398       return false;
 399       break;
 400     case HEART:
 401       if (record->event.pressed) {
 402         SEND_STRING("<3 ");
 403       }
 404       return false;
 405       break;
 406     case SHRUG:
 407       if (record->event.pressed) {
 408         SEND_STRING("&shrug; ");
 409       }
 410       return false;
 411       break;
 412     case THMBUP:
 413       if (record->event.pressed) {
 414         SEND_STRING("&thumbup; ");
 415       }
 416       return false;
 417       break;
 418     case THMBDN:
 419       if (record->event.pressed) {
 420         SEND_STRING("&thumbdown; ");
 421       }
 422       return false;
 423       break;
 424     case FNGLEFT:
 425       if (record->event.pressed) {
 426         SEND_STRING("&fingerleft; ");
 427       }
 428       return false;
 429       break;
 430     case FNGRIGHT:
 431       if (record->event.pressed) {
 432         SEND_STRING("&fingerright; ");
 433       }
 434       return false;
 435       break;
 436     case WINK:
 437       if (record->event.pressed) {
 438         SEND_STRING(";-) ");
 439       }
 440       return false;
 441       break;
 442     case ABOVE:
 443       if (record->event.pressed) {
 444         SEND_STRING("&above; ");
 445       }
 446       return false;
 447       break;
 448   }
 449   return true;
 450 }