keyboards/planck/keymaps/fabian/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
  17 #include "planck.h"
  18 #include "action_layer.h"
  19
  20 extern keymap_config_t keymap_config;
  21
  22 enum custom_layers {
  23   _QWERTY,
  24   _COLEMAK,
  25   _DVORAK,
  26   _LOWER,
  27   _RAISE,
  28   _PLOVER,
  29   _ADJUST
  30 };
  31
  32 enum custom_keycodes {
  33   QWERTY = SAFE_RANGE,
  34   COLEMAK,
  35   DVORAK,
  36   PLOVER,
  37   LOWER,
  38   RAISE,
  39   BACKLIT,
  40   EXT_PLV
  41 };
  42
  43 #define XXXXXXX KC_NO
  44 #define _______ KC_TRNS
  45
  46 #define CTL_ESC CTL_T(KC_ESC)  // Tap for Escape, hold for Control
  47 #define HPR_TAB ALL_T(KC_TAB)  // Tap for Tab, hold for Hyper (Super+Ctrl+Alt+Shift)
  48 #define MEH_GRV MEH_T(KC_GRV)  // Tap for Backtick, hold for Meh (Ctrl+Alt+Shift)
  49 #define SFT_BSP SFT_T(KC_BSPC) // Tap for Backspace, hold for Shift
  50 #define SFT_ENT SFT_T(KC_ENT)  // Tap for Enter, hold for Shift
  51 #define SFT_SPC SFT_T(KC_SPC)  // Tap for Space, hold for Shift
  52 #define UMLAUT  RALT(KC_U)     // Combine Alt and U
  53
  54 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  55
  56 /* Qwerty
  57  * ,-----------------------------------------------------------------------------------.
  58  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  59  * |------+------+------+------+------+-------------+------+------+------+------+------|
  60  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  61  * |------+------+------+------+------+------|------+------+------+------+------+------|
  62  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  63  * |------+------+------+------+------+------+------+------+------+------+------+------|
  64  * | Ctrl | Meh  | Alt  | GUI  |Lower |Space | Tab  |Raise | GUI  |AltGr | Umlt | Ctrl |
  65  * `-----------------------------------------------------------------------------------'
  66  */
  67 [_QWERTY] = {
  68   {HPR_TAB, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  69   {CTL_ESC, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  70   {SFT_BSP, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SFT_ENT},
  71   {KC_LCTL, MEH_GRV, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  HPR_TAB, RAISE,   KC_RGUI, KC_RALT, UMLAUT,  KC_RCTL}
  72 },
  73
  74 /* Colemak
  75  * ,-----------------------------------------------------------------------------------.
  76  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  77  * |------+------+------+------+------+-------------+------+------+------+------+------|
  78  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  79  * |------+------+------+------+------+------|------+------+------+------+------+------|
  80  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
  81  * |------+------+------+------+------+------+------+------+------+------+------+------|
  82  * | Ctrl | Meh  | Alt  | GUI  |Lower |Space | Tab  |Raise | GUI  |AltGr | Umlt | Ctrl |
  83  * `-----------------------------------------------------------------------------------'
  84  */
  85 [_COLEMAK] = {
  86   {HPR_TAB, KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
  87   {CTL_ESC, KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
  88   {SFT_BSP, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SFT_ENT},
  89   {KC_LCTL, MEH_GRV, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  HPR_TAB, RAISE,   KC_RGUI, KC_RALT, UMLAUT,  KC_RCTL}
  90 },
  91
  92 /* Dvorak
  93  * ,-----------------------------------------------------------------------------------.
  94  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
  95  * |------+------+------+------+------+-------------+------+------+------+------+------|
  96  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
  97  * |------+------+------+------+------+------|------+------+------+------+------+------|
  98  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
  99  * |------+------+------+------+------+------+------+------+------+------+------+------|
 100  * | Ctrl | Meh  | Alt  | GUI  |Lower |Space | Tab  |Raise | GUI  |AltGr | Umlt | Ctrl |
 101  * `-----------------------------------------------------------------------------------'
 102  */
 103 [_DVORAK] = {
 104   {HPR_TAB, KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
 105   {CTL_ESC, KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
 106   {SFT_BSP, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    SFT_ENT},
 107   {KC_LCTL, MEH_GRV, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  HPR_TAB, RAISE,   KC_RGUI, KC_RALT, UMLAUT,  KC_RCTL}
 108 },
 109
 110 /* Lower
 111  * ,-----------------------------------------------------------------------------------.
 112  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 113  * |------+------+------+------+------+-------------+------+------+------+------+------|
 114  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 115  * |------+------+------+------+------+------|------+------+------+------+------+------|
 116  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 | MS L | MS D |MS U  | MS R |MS Btn|
 117  * |------+------+------+------+------+------+------+------+------+------+------+------|
 118  * |      |      |      |      |      |      |      |      | Next | Vol- | Vol+ | Play |
 119  * `-----------------------------------------------------------------------------------'
 120  */
 121 [_LOWER] = {
 122   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
 123   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
 124   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_MS_L, KC_MS_D, KC_MS_U, KC_MS_R, KC_BTN1},
 125   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 126 },
 127
 128 /* Raise
 129  * ,-----------------------------------------------------------------------------------.
 130  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 131  * |------+------+------+------+------+-------------+------+------+------+------+------|
 132  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  | }   |
 133  * |------+------+------+------+------+------|------+------+------+------+------+------|
 134  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 | Left | Down |  Up  | Rght |MS_BN2|
 135  * |------+------+------+------+------+------+------+------+------+------+------+------|
 136  * |      |      |      |      |      |      |      |      | Next | Vol- | Vol+ | Play |
 137  * `-----------------------------------------------------------------------------------'
 138  */
 139 [_RAISE] = {
 140   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 141   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 142   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, KC_BTN2},
 143   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 144 },
 145
 146 /* Plover layer (http://opensteno.org)
 147  * ,-----------------------------------------------------------------------------------.
 148  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 149  * |------+------+------+------+------+-------------+------+------+------+------+------|
 150  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 151  * |------+------+------+------+------+------|------+------+------+------+------+------|
 152  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 153  * |------+------+------+------+------+------+------+------+------+------+------+------|
 154  * | Exit |      |      |   A  |   O  |      |      |   E  |   U  |      |      |      |
 155  * `-----------------------------------------------------------------------------------'
 156  */
 157
 158 [_PLOVER] = {
 159   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 160   {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 161   {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 162   {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 163 },
 164
 165 /* Adjust (Lower + Raise)
 166  * ,-----------------------------------------------------------------------------------.
 167  * |      | Reset|      |      |      |      |      |      |      |      | Reset|  Del |
 168  * |------+------+------+------+------+-------------+------+------+------+------+------|
 169  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 170  * |------+------+------+------+------+------|------+------+------+------+------+------|
 171  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 172  * |------+------+------+------+------+------+------+------+------+------+------+------|
 173  * |      |      |      |      |      |      |      |      |      |      |      |      |
 174  * `-----------------------------------------------------------------------------------'
 175  */
 176 [_ADJUST] = {
 177   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, RESET,   KC_DEL },
 178   {_______, _______, MU_MOD,  AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______},
 179   {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 180   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 181 }
 182
 183
 184 };
 185
 186 #ifdef AUDIO_ENABLE
 187   float plover_song[][2]     = SONG(PLOVER_SOUND);
 188   float plover_gb_song[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 189 #endif
 190
 191 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 192   switch (keycode) {
 193     case QWERTY:
 194       if (record->event.pressed) {
 195         set_single_persistent_default_layer(_QWERTY);
 196       }
 197       return false;
 198       break;
 199     case COLEMAK:
 200       if (record->event.pressed) {
 201         set_single_persistent_default_layer(_COLEMAK);
 202       }
 203       return false;
 204       break;
 205     case DVORAK:
 206       if (record->event.pressed) {
 207         set_single_persistent_default_layer(_DVORAK);
 208       }
 209       return false;
 210       break;
 211     case LOWER:
 212       if (record->event.pressed) {
 213         layer_on(_LOWER);
 214         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 215       } else {
 216         layer_off(_LOWER);
 217         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 218       }
 219       return false;
 220       break;
 221     case RAISE:
 222       if (record->event.pressed) {
 223         layer_on(_RAISE);
 224         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 225       } else {
 226         layer_off(_RAISE);
 227         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 228       }
 229       return false;
 230       break;
 231     case BACKLIT:
 232       if (record->event.pressed) {
 233         register_code(KC_RSFT);
 234         #ifdef BACKLIGHT_ENABLE
 235           backlight_step();
 236         #endif
 237       } else {
 238         unregister_code(KC_RSFT);
 239       }
 240       return false;
 241       break;
 242     case PLOVER:
 243       if (record->event.pressed) {
 244         #ifdef AUDIO_ENABLE
 245           stop_all_notes();
 246           PLAY_SONG(plover_song);
 247         #endif
 248         layer_off(_RAISE);
 249         layer_off(_LOWER);
 250         layer_off(_ADJUST);
 251         layer_on(_PLOVER);
 252         if (!eeconfig_is_enabled()) {
 253             eeconfig_init();
 254         }
 255         keymap_config.raw = eeconfig_read_keymap();
 256         keymap_config.nkro = 1;
 257         eeconfig_update_keymap(keymap_config.raw);
 258       }
 259       return false;
 260       break;
 261     case EXT_PLV:
 262       if (record->event.pressed) {
 263         #ifdef AUDIO_ENABLE
 264           PLAY_SONG(plover_gb_song);
 265         #endif
 266         layer_off(_PLOVER);
 267       }
 268       return false;
 269       break;
 270   }
 271   return true;
 272 }