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