keyboards/planck/keymaps/jirgn/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 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
  18 #include "planck.h"
  19 #include "action_layer.h"
  20
  21 extern keymap_config_t keymap_config;
  22
  23 enum planck_layers {
  24   _QWERTY,
  25   _LOWER,
  26   _RAISE,
  27   _PLOVER,
  28   _ADJUST,
  29   _NAVIGATION
  30 };
  31
  32 enum planck_keycodes {
  33   QWERTY = SAFE_RANGE,
  34   PLOVER,
  35   LOWER,
  36   RAISE,
  37   EXT_PLV
  38 };
  39
  40 // keycode aliases
  41 #define _______ KC_TRNS
  42 #define ___x___ KC_NO
  43 #define KC_EUR LALT(S(KC_2))
  44 #define KC_SEC LALT(KC_6)
  45 #define CTL_DEL CTL_T(KC_DEL)
  46 #define NAV_SCLN LT(_NAVIGATION, KC_SCLN)
  47 #define NAV_A LT(_NAVIGATION, KC_A)
  48
  49 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  50
  51 /*              Qwerty
  52  *              ,-----------------------------------------------------------------------------------.
  53  *              | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  54  *              |------+------+------+------+------+-------------+------+------+------+------+------|
  55  * Tab for Esc--| Ctrl | A Nav|   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  | ; Nav| Ctrl |--Tab for "
  56  *              |------+------+------+------+------+------|------+------+------+------+------+------|
  57  *              | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  | Shift|--Tab for Enter
  58  *              |------+------+------+------+------+------+------+------+------+------+------+------|
  59  *              |      | Hyper| Alt  | Super| Lower|    Space    | Raise| Super| ALt  | Hyper|      |
  60  *              `-----------------------------------------------------------------------------------'
  61  */
  62 [_QWERTY] = {
  63   {KC_TAB,        KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,     KC_BSPC},
  64   {CTL_T(KC_ESC), NAV_A,   KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    NAV_SCLN, KC_QUOT},
  65   {KC_LSFT,       KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,  SFT_T(KC_ENT)},
  66   {___x___,       KC_HYPR, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LGUI, KC_LALT, KC_HYPR,  ___x___}
  67 },
  68
  69 /*              Lower
  70  *              ,-----------------------------------------------------------------------------------.
  71  *              |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
  72  *              |------+------+------+------+------+-------------+------+------+------+------+------|
  73  * Tab to Del---| Ctrl |  ¡   |  ™   |  €   |  ¢   |  ∞   |  §   |   _  |   +  |   {  |   }  |  |   |
  74  *              |------+------+------+------+------+------|------+------+------+------+------+------|
  75  *              |      |      |      |      |      |      |      |ISO ~ |ISO | |      |      |      |
  76  *              |------+------+------+------+------+------+------+------+------+------+------+------|
  77  *              |      |      |      |      |      |             |      |      |      |      |      |
  78  *              `-----------------------------------------------------------------------------------'
  79  */
  80 [_LOWER] = {
  81   {KC_TILD, S(KC_1),    S(KC_2),    S(KC_3), S(KC_4),    S(KC_5),    S(KC_6),    S(KC_7),    S(KC_8),    S(KC_9), S(KC_0), KC_BSPC},
  82   {CTL_DEL, LALT(KC_1), LALT(KC_2), KC_EUR,  LALT(KC_4), LALT(KC_5), LALT(KC_6), KC_UNDS,    KC_PLUS,    KC_LCBR, KC_RCBR, KC_PIPE},
  83   {_______, ___x___,    ___x___,    ___x___, ___x___,    ___x___,    ___x___,    S(KC_NUHS), S(KC_NUBS), _______, _______, _______},
  84   {_______, _______,    _______,    _______, _______,    _______,    _______,    _______,    _______,    _______, _______, _______}
  85 },
  86
  87 /*              Raise
  88  *              ,-----------------------------------------------------------------------------------.
  89  *              |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
  90  *              |------+------+------+------+------+-------------+------+------+------+------+------|
  91  * Tab to Del---| Ctrl |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
  92  *              |------+------+------+------+------+------|------+------+------+------+------+------|
  93  *              |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |      |      |      |
  94  *              |------+------+------+------+------+------+------+------+------+------+------+------|
  95  *              |      |      |      |      |      |             |      |      |      |      |      |
  96  *              `-----------------------------------------------------------------------------------'
  97  */
  98 [_RAISE] = {
  99   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 100   {CTL_DEL, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 101   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, _______, _______, _______},
 102   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 103 },
 104
 105 /*              Navigation
 106  *              ,-----------------------------------------------------------------------------------.
 107  *              |      |      |      |      |      |      |      |      |      |      |      |      |
 108  *              |------+------+------+------+------+-------------+------+------+------+------+------|
 109  *              |      |      | HOME | PGUP | PGDN | END  | LEFT | DOWN | UP   | RIGHT|      |      |
 110  *              |------+------+------+------+------+------|------+------+------+------+------+------|
 111  *              |      |      |      |      |      |      |      |      |      |      |      |      |
 112  *              |------+------+------+------+------+------+------+------+------+------+------+------|
 113  *              |      |      |      |      |      |             |      |      |      |      |      |
 114  *              `-----------------------------------------------------------------------------------'
 115  */
 116 [_NAVIGATION] = {
 117   {___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___,  ___x___, ___x___},
 118   {_______, _______, KC_HOME, KC_PGUP, KC_PGDN, KC_END , KC_LEFT, KC_DOWN, KC_UP  , KC_RIGHT, _______, ___x___},
 119   {_______, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___, ___x___,  ___x___, _______},
 120   {___x___, _______, _______, _______, ___x___, ___x___, ___x___, ___x___, _______, _______,  _______, ___x___}
 121 },
 122
 123 /*              Plover layer (http://opensteno.org)
 124  *              ,-----------------------------------------------------------------------------------.
 125  *              |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 126  *              |------+------+------+------+------+-------------+------+------+------+------+------|
 127  *              |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 128  *              |------+------+------+------+------+------|------+------+------+------+------+------|
 129  *              |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 130  *              |------+------+------+------+------+------+------+------+------+------+------+------|
 131  *              | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 132  *              `-----------------------------------------------------------------------------------'
 133  */
 134
 135 [_PLOVER] = {
 136   {KC_1,    KC_1,    KC_1,    KC_1, KC_1, KC_1,    KC_1,    KC_1, KC_1, KC_1,    KC_1,    KC_1   },
 137   {___x___, KC_Q,    KC_W,    KC_E, KC_R, KC_T,    KC_Y,    KC_U, KC_I, KC_O,    KC_P,    KC_LBRC},
 138   {___x___, KC_A,    KC_S,    KC_D, KC_F, KC_G,    KC_H,    KC_J, KC_K, KC_L,    KC_SCLN, KC_QUOT},
 139   {EXT_PLV, ___x___, ___x___, KC_C, KC_V, ___x___, ___x___, KC_N, KC_M, ___x___, ___x___, ___x___}
 140 },
 141
 142 /*              Adjust (Lower + Raise)
 143  *              ,-----------------------------------------------------------------------------------.
 144  *              |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 145  *              |------+------+------+------+------+-------------+------+------+------+------+------|
 146  *              |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Plover|      |      |      |
 147  *              |------+------+------+------+------+------|------+------+------+------+------+------|
 148  *              |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 149  *              |------+------+------+------+------+------+------+------+------+------+------+------|
 150  *              |      |      |      |      |      |             |      |      |      |      |      |
 151  *              `-----------------------------------------------------------------------------------'
 152  */
 153 [_ADJUST] = {
 154   {_______, RESET,   DEBUG,   _______, _______, _______, _______, TERM_ON, TERM_OFF,_______, _______, KC_DEL },
 155   {_______, _______, MU_MOD,  AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  PLOVER,  _______, _______, _______},
 156   {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 157   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 158 }
 159
 160
 161 };
 162
 163 #ifdef AUDIO_ENABLE
 164   float plover_song[][2]     = SONG(PLOVER_SOUND);
 165   float plover_gb_song[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 166 #endif
 167
 168 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 169   switch (keycode) {
 170     case QWERTY:
 171       if (record->event.pressed) {
 172         print("mode just switched to qwerty and this is a huge string\n");
 173         set_single_persistent_default_layer(_QWERTY);
 174       }
 175       return false; break;
 176     case LOWER:
 177       if (record->event.pressed) {
 178         layer_on(_LOWER);
 179         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 180       } else {
 181         layer_off(_LOWER);
 182         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 183       }
 184       return false; break;
 185     case RAISE:
 186       if (record->event.pressed) {
 187         layer_on(_RAISE);
 188         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 189       } else {
 190         layer_off(_RAISE);
 191         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 192       }
 193       return false; break;
 194     case PLOVER:
 195       if (record->event.pressed) {
 196         #ifdef AUDIO_ENABLE
 197           stop_all_notes();
 198           PLAY_SONG(plover_song);
 199         #endif
 200         layer_off(_RAISE);
 201         layer_off(_LOWER);
 202         layer_off(_ADJUST);
 203         layer_on(_PLOVER);
 204         if (!eeconfig_is_enabled()) {
 205             eeconfig_init();
 206         }
 207         keymap_config.raw = eeconfig_read_keymap();
 208         keymap_config.nkro = 1;
 209         eeconfig_update_keymap(keymap_config.raw);
 210       }
 211       return false; break;
 212     case EXT_PLV:
 213       if (record->event.pressed) {
 214         #ifdef AUDIO_ENABLE
 215           PLAY_SONG(plover_gb_song);
 216         #endif
 217         layer_off(_PLOVER);
 218       }
 219       return false; break;
 220   }
 221   return true;
 222 }