keyboards/xd75/keymaps/colinta/keymap.c

   1 /* Copyright 2017 Colin T.A. Gray
   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 "xd75.h"
  17
  18 #ifdef IS_COLINTA
  19 #include "secrets.h"
  20 #else
  21 #define SENDSTRING_MM0 ""
  22 #define SENDSTRING_MM1 ""
  23 #define SENDSTRING_MM2 ""
  24 #endif
  25
  26 // layers:
  27 // - colemak,
  28 // - record-mode (adds stop buttons)
  29 // - qwerty
  30 // - fn (recording, changing layers)
  31 #define LAYER_COLEMAK 0
  32 #define LAYER_RECORD 1
  33 #define LAYER_QWERTY 2
  34 #define LAYER_FN 3
  35
  36 // custom keys:
  37 // - goto layer keys
  38 #define GOTO_FN TT(LAYER_FN)
  39 #define GOTO_CM TO(LAYER_COLEMAK)
  40 #define GOTO_QW TO(LAYER_QWERTY)
  41 // - sticky keys, aka one-shot
  42 #define OSCTL OSM(MOD_LCTL)
  43 #define OSALT OSM(MOD_LALT)
  44 #define OSSFT OSM(MOD_LSFT)
  45 #define OSGUI OSM(MOD_LGUI)
  46 // "MMENU" is a macro for "CMD+SPC" (aka Spotlight/Alfred)
  47 #define MMENU LGUI(KC_SPC)
  48 #define _____ KC_TRNS
  49 #define MM_0 DYN_MACRO_PLAY1
  50 #define MM_1 DYN_MACRO_PLAY2
  51
  52 // tap-hold settings
  53 #define LONGPRESS_DELAY 250
  54 #define TH_EVENTS_COUNT 13
  55
  56 enum my_keycods {
  57     TH_M0 = SAFE_RANGE,
  58     TH_M1,
  59     TH_M2,
  60     TH_F1,
  61     TH_F2,
  62     TH_F3,
  63     TH_F4,
  64     TH_F5,
  65     TH_F6,
  66     TH_F7,
  67     TH_F8,
  68     TH_F9,
  69     TH_F10,
  70     TH_LAST,
  71     MM_2,
  72     DM_CLEAR,
  73     DYNAMIC_MACRO_RANGE,
  74 };
  75
  76 #include "dynamic_macro.h"
  77
  78 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  79
  80 /* COLEMAK
  81  * .--------------------------------------------------------------------------------------------------------------------------------------.
  82  * | ESC    | 1      | 2      | 3      | 4      | 5      | M(0)   | M(1)   | DEL    | 6      | 7      | 8      | 9      | 0      | -      |
  83  * |--------+-/F1----+-/F2----+-/F3----+-/F4----+-/F5----+--------+--------+--------+-/F6----+-/F7----+-/F8----+-/F9----+-/F10---+--------|
  84  * | TAB    | Q      | W      | F      | P      | G      | M(2)   |  (FN)  | BKSP   | J      | L      | U      | Y      | ;      | =      |
  85  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------+--------|
  86  * | SHIFT  | A      | R      | S      | T      | D      | [      | ]      | ENTER  | H      | N      | E      | I      | O      | '      |
  87  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------------------------+--------|
  88  * | CTRL   | Z      | X      | C      | V      | B      | HOME   | END    | PG UP  | K      | M      | ,      | .      | /      | \      |
  89  * |--------+--------+--------+--------+--------+-----------------+--------+--------+--------+--------+-----------------+--------+--------|
  90  * | VOL-   | PLAY   | VOL+   | ALT    | GUI    |          SPACE           | PG DN  | MENU   | ESC    | LEFT   | DOWN   | UP     | RIGHT  |
  91  * '--/RRND----/MUTE----/FFWD-------------------------------------------------------------------------------------------------------------'
  92  */
  93
  94   [LAYER_COLEMAK] = KEYMAP(
  95     KC_GRV, TH_F1, TH_F2, TH_F3, TH_F4, TH_F5,  MM_0,    MM_1,    KC_DEL,  TH_F6, TH_F7,  TH_F8,   TH_F9,   TH_F10,  KC_MINS,
  96     KC_TAB, KC_Q,  KC_W,  KC_F,  KC_P,  KC_G,   MM_2,    GOTO_FN, KC_BSPC, KC_J,  KC_L,   KC_U,    KC_Y,    KC_SCLN, KC_EQL,
  97     OSCTL,  KC_A,  KC_R,  KC_S,  KC_T,  KC_D,   KC_LBRC, KC_RBRC, KC_ENT,  KC_H,  KC_N,   KC_E,    KC_I,    KC_O,    KC_QUOT,
  98     OSSFT,  KC_Z,  KC_X,  KC_C,  KC_V,  KC_B,   KC_HOME, KC_END,  KC_PGUP, KC_K,  KC_M,   KC_COMM, KC_DOT,  KC_SLSH, KC_BSLS,
  99     TH_M0,  TH_M1,  TH_M2, OSALT, OSGUI, _____ , KC_SPC,  _____ ,  KC_PGDN, MMENU, KC_ESC, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
 100   ),
 101
 102 /* DYN_REC LAYER - recording tap/hold keys is possible, but they will always "tap" (macros don't record holding duration)
 103  * .--------------------------------------------------------------------------------------------------------------------------------------.
 104  * |        |        |        |        |        |        |  STOP  |  STOP  |        |        |        |        |        |        |        |
 105  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------|
 106  * |        |        |        |        |        |        |  STOP  |  STOP  |        |        |        |        |        |        |        |
 107  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------+--------|
 108  * |        |        |        |        |        |        |        |        |        |        |        |        |        |        |        |
 109  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------------------------+--------|
 110  * |        |        |        |        |        |        |        |        |        |        |        |        |        |        |        |
 111  * |--------+--------+--------+--------+--------+-----------------+--------+--------+--------+--------+-----------------+--------+--------|
 112  * |        |        |        |        |        |                          |        |        |        |        |        |        |        |
 113  * '--------------------------------------------------------------------------------------------------------------------------------------'
 114  */
 115
 116   [LAYER_RECORD] = KEYMAP(
 117     _____, _____, _____, _____, _____, _____, DYN_REC_STOP, DYN_REC_STOP, _____, _____, _____, _____, _____, _____, _____,
 118     _____, _____, _____, _____, _____, _____, DYN_REC_STOP, DYN_REC_STOP, _____, _____, _____, _____, _____, _____, _____,
 119     _____, _____, _____, _____, _____, _____,    _____,        _____,     _____, _____, _____, _____, _____, _____, _____,
 120     _____, _____, _____, _____, _____, _____,    _____,        _____,     _____, _____, _____, _____, _____, _____, _____,
 121     _____, _____, _____, _____, _____, _____,    _____,        _____,     _____, _____, _____, _____, _____, _____, _____
 122   ),
 123
 124 /* QWERTY - doesn't support recording of macros, btw.  Falls through to colemak for most keys, but passes through the recording layer, so heads up.
 125  * .--------------------------------------------------------------------------------------------------------------------------------------.
 126  * |        |        |        |        |        |        | M(0)   | M(1)   |        |        |        |        |        |        |        |
 127  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------|
 128  * |        | Q      | W      | E      | R      | T      | M(2)   |  (FN)  |        | Y      | U      | I      | O      | P      |        |
 129  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------+--------|
 130  * | SHIFT  | A      | S      | D      | F      | G      |        |        |        | H      | J      | K      | L      | ;      |        |
 131  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------------------------+--------|
 132  * | CTRL   | Z      | X      | C      | V      | B      |        |        |        | N      | M      |        |        |        |        |
 133  * |--------+--------+--------+--------+--------+-----------------+--------+--------+--------+--------+-----------------+--------+--------|
 134  * |        |        |        | ALT    | GUI    |                          |        |        |        |        |        |        |        |
 135  * '--------------------------------------------------------------------------------------------------------------------------------------'
 136  */
 137
 138   [LAYER_QWERTY] = KEYMAP(
 139     _____,    _____, _____, _____,    _____,    _____,    MM_0,  MM_1,    _____, _____, _____, _____, _____, _____, _____,
 140     _____,    KC_Q,  KC_W,  KC_E,     KC_R,     KC_T,     MM_2,  GOTO_FN, _____, KC_Y,  KC_U, KC_I,  KC_O,  KC_P,    _____,
 141     MOD_LSFT, KC_A,  KC_S,  KC_D,     KC_F,     KC_G,     _____,  _____,  _____, KC_H,  KC_J, KC_K,  KC_L,  KC_SCLN, _____,
 142     MOD_LCTL, KC_Z,  KC_X,  KC_C,     KC_V,     KC_B,     _____,  _____,  _____, KC_N,  KC_M, _____, _____, _____,   _____,
 143     _____,    _____, _____, MOD_LALT, MOD_LGUI, _____, _____,  _____,  _____, _____, _____, _____, _____, _____, _____
 144   ),
 145
 146 /* FN LAYER - change layouts and start recording a macro
 147  * .--------------------------------------------------------------------------------------------------------------------------------------.
 148  * | COLEMAK| QWERTY |        |        |        |        | REC 1  | REC 2  |        |        |        |        |        |        |        |
 149  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------|
 150  * |        |        |        |        |        |        |        | ------ |        |        |        |        |        |        |        |
 151  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------+--------|
 152  * |        |        |        |        |        |        |        |        |        |        |        |        |        |        |        |
 153  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------------------------+--------|
 154  * |        |        |        |        |        |        |        |        |        |        |        |        |        |        |        |
 155  * |--------+--------+--------+--------+--------+-----------------+--------+--------+--------+--------+-----------------+--------+--------|
 156  * |        |        |        |        | RESET  |         DM_CLEAR         |        |        | RESET  |        |        |        |        |
 157  * '--------------------------------------------------------------------------------------------------------------------------------------'
 158  */
 159
 160   [LAYER_FN] = KEYMAP(
 161     GOTO_CM, GOTO_QW, KC_NO, KC_NO, KC_NO, KC_NO, DYN_REC_START1, DYN_REC_START2, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
 162     KC_NO,   KC_NO,   KC_NO, KC_NO, KC_NO, KC_NO,     KC_NO,          KC_NO,      KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
 163     KC_NO,   KC_NO,   KC_NO, KC_NO, KC_NO, KC_NO,     KC_NO,          KC_NO,      KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
 164     KC_NO,   KC_NO,   KC_NO, KC_NO, KC_NO, KC_NO,     KC_NO,          KC_NO,      KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
 165     KC_NO,   KC_NO,   KC_NO, KC_NO, RESET,    KC_NO, DM_CLEAR, KC_NO,             KC_NO, KC_NO, RESET, KC_NO, KC_NO, KC_NO, KC_NO
 166   )
 167 };
 168
 169 typedef struct {
 170     bool is_pressed;
 171     uint16_t timer;
 172     uint16_t kc_tap;
 173     uint16_t kc_hold;
 174 } tap_hold_t;
 175
 176 static tap_hold_t th_events[] = {
 177     { .is_pressed = false, .timer = 0, .kc_tap = KC_VOLD, .kc_hold = KC_MRWD }, // TH_M0
 178     { .is_pressed = false, .timer = 0, .kc_tap = KC_MPLY, .kc_hold = KC_MUTE }, // TH_M1
 179     { .is_pressed = false, .timer = 0, .kc_tap = KC_VOLU, .kc_hold = KC_MFFD }, // TH_M2
 180
 181     { .is_pressed = false, .timer = 0, .kc_tap = KC_1, .kc_hold = KC_F1 }, // TH_F1
 182     { .is_pressed = false, .timer = 0, .kc_tap = KC_2, .kc_hold = KC_F2 }, // TH_F2
 183     { .is_pressed = false, .timer = 0, .kc_tap = KC_3, .kc_hold = KC_F3 }, // TH_F3
 184     { .is_pressed = false, .timer = 0, .kc_tap = KC_4, .kc_hold = KC_F4 }, // TH_F4
 185     { .is_pressed = false, .timer = 0, .kc_tap = KC_5, .kc_hold = KC_F5 }, // TH_F5
 186     { .is_pressed = false, .timer = 0, .kc_tap = KC_6, .kc_hold = KC_F6 }, // TH_F6
 187     { .is_pressed = false, .timer = 0, .kc_tap = KC_7, .kc_hold = KC_F7 }, // TH_F7
 188     { .is_pressed = false, .timer = 0, .kc_tap = KC_8, .kc_hold = KC_F8 }, // TH_F8
 189     { .is_pressed = false, .timer = 0, .kc_tap = KC_9, .kc_hold = KC_F9 }, // TH_F9
 190     { .is_pressed = false, .timer = 0, .kc_tap = KC_0, .kc_hold = KC_F10 } // TH_F10
 191 };
 192
 193 void taphold_tapped(uint8_t index, bool pressed) {
 194     if (index >= TH_EVENTS_COUNT) { return; }
 195
 196     tap_hold_t *th_event = &th_events[index];
 197
 198     if (pressed) {
 199         th_event->timer = timer_read();
 200         th_event->is_pressed = true;
 201     } else if (th_event->is_pressed) {
 202         register_code(th_event->kc_tap);
 203         unregister_code(th_event->kc_tap);
 204         th_event->is_pressed = false;
 205     }
 206 }
 207
 208 void matrix_scan_user() {
 209     for (uint8_t index = 0 ; index < TH_EVENTS_COUNT ; ++index ) {
 210         tap_hold_t *th_event = &th_events[index];
 211         if ( th_event->is_pressed && timer_elapsed(th_event->timer) > LONGPRESS_DELAY) {
 212             register_code(th_event->kc_hold);
 213             unregister_code(th_event->kc_hold);
 214             th_event->is_pressed = false;
 215         }
 216     }
 217 }
 218
 219 // if the dynamic macros haven't been recorded, we send the default macro strings.
 220 bool did_record_m1 = false;
 221 bool did_record_m2 = false;
 222 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 223     bool try_dynamic_macro = true;
 224     if ((keycode == DYN_MACRO_PLAY1 && !did_record_m1) || (keycode == DYN_MACRO_PLAY2 && !did_record_m2)) {
 225         try_dynamic_macro = false;
 226     }
 227     else if (keycode == DM_CLEAR) {
 228         try_dynamic_macro = false;
 229         did_record_m1 = false;
 230         did_record_m2 = false;
 231     }
 232
 233     if (try_dynamic_macro && !process_record_dynamic_macro(keycode, record)) {
 234         if (keycode == DYN_MACRO_PLAY1) {
 235                 did_record_m1 = true;
 236         }
 237
 238         if (keycode == DYN_MACRO_PLAY2) {
 239                 did_record_m2 = true;
 240         }
 241
 242         if (keycode == DYN_REC_START1 || keycode == DYN_REC_START2) {
 243                 layer_move(LAYER_RECORD);
 244         }
 245         else if (keycode == DYN_REC_STOP) {
 246                 layer_move(LAYER_COLEMAK);
 247         }
 248
 249         return false;
 250     }
 251
 252     switch (keycode) {
 253     case DYN_MACRO_PLAY1:
 254         SEND_STRING(SENDSTRING_MM0);
 255         return false;
 256     case DYN_MACRO_PLAY2:
 257         SEND_STRING(SENDSTRING_MM1);
 258         return false;
 259     case MM_2:
 260         SEND_STRING(SENDSTRING_MM2);
 261         return false;
 262     case TH_M0 ... TH_LAST:
 263         taphold_tapped(keycode - TH_M0, record->event.pressed);
 264         return false;
 265     }
 266
 267     return true;
 268 }