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