]> git.donarmstrong.com Git - qmk_firmware.git/blob - users/ericgebhart/ericgebhart.h
Remove more commented out MCUs
[qmk_firmware.git] / users / ericgebhart / ericgebhart.h
1 /*
2   Copyright 2018 Eric Gebhart <e.a.gebhart@gmail.com>
3
4   This program is free software: you can redistribute it and/or modify
5   it under the terms of the GNU General Public License as published by
6   the Free Software Foundation, either version 2 of the License, or
7   (at your option) any later version.
8
9   This program is distributed in the hope that it will be useful,
10   but WITHOUT ANY WARRANTY; without even the implied warranty of
11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12   GNU General Public License for more details.
13
14   You should have received a copy of the GNU General Public License
15   along with this program.  If not, see <http://www.gnu.org/licenses/>.
16 */
17 #include QMK_KEYBOARD_H
18
19 #ifndef ericgebhart
20 #define ericgebhart
21
22 #include "quantum.h"
23 #include "process_keycode/process_tap_dance.h"
24
25
26 void tap(uint16_t keycode);
27 bool process_record_secrets(uint16_t keycode, keyrecord_t *record);
28
29
30 #define EECONFIG_USERSPACE (uint8_t *)19
31
32 typedef union {
33   uint8_t raw;
34   struct {
35     bool     clicky_enable    :1;
36     bool     rgb_layer_change :1;
37     bool     is_overwatch     :1;
38     bool     nuke_switch      :1;
39   };
40 } userspace_config_t;
41
42 #define ___ KC_TRNS
43 #define XXX KC_NO
44
45 // The most portable copy/paste keys (windows (mostly), linux, and some terminal emulators).
46 #define MK_CUT    LSFT(KC_DEL)  // shift + delete
47 #define MK_COPY   LCTL(KC_INS)  // ctrl + insert
48 #define MK_PASTE  LSFT(KC_INS)  // shift + insert
49
50
51 #define DVORAK 0 // dvorak layout (default)
52 #define QWERTY 1
53 #define COLEMAK 2
54 #define WORKMAN 3
55 #define NORMAN 4
56 // bepo layers
57 #define DVORAK_ON_BEPO 6 // dvorak layout (default)
58 #define BEPO 7 // Bepo
59 // non-default layers
60 #define SYMB 8 // symbols and numbers
61 #define SYMB_ON_BEPO 9 // symbols and numbers
62 #define MDIA 10 // mouse knd media eys
63 #define LAYERS 11 // layers and right mousekeys.
64 #define XMONAD 12 // xmonad ie. dvorak.
65 #define XMONAD_FR 13 // xmonad ie. dvorak.
66
67
68 // for the creation of dvorak keys on an Bepo keyboard at the OS layer.
69
70 // so we can create an array of reasonable size
71 // for our translation keys. We have to create a
72 // good range of numbers
73 #define GR(x) (x-SAFE_RANGE)
74
75 uint8_t gr(uint8_t);
76 void send_keycode(uint8_t);
77
78 #define MOD_NONE 0x00
79
80 // indexs for the keycode translation table.
81 #define UNSHIFTED_KEY(key)  key_translations[gr(key)][0][0]
82 #define UNSHIFTED_MODS(key) key_translations[gr(key)][0][1]
83 #define SHIFTED_KEY(key)    key_translations[gr(key)][1][0]
84 #define SHIFTED_MODS(key)   key_translations[gr(key)][1][1]
85
86
87 enum userspace_custom_keycodes {
88   // keep the keycodes using the send_key function close to SAFE_RANGE
89   // so the array of keycodes remains a reasonbale size.
90   DB_1 = SAFE_RANGE,  // can always be here
91   DB_2,
92   DB_3,
93   DB_4,
94   DB_5,
95   DB_6,
96   DB_7,
97   DB_8,
98   DB_9,
99   DB_0,
100   DB_GRV,
101   DB_SCOLON,
102   DB_SLASH,
103   DB_BACKSLASH,
104   DB_EQL,
105   DB_DOT,
106   DB_COMM,
107   DB_QUOT,
108   DB_MINUS,
109   DB_RPRN,
110   DB_LPRN,
111   DB_RBRC,
112   DB_LBRC,
113   // for symbols layer
114   DB_HASH,
115   DB_LCBR,
116   DB_RCBR,
117   DB_PIPE,
118   DB_TILD,
119   DB_CIRC,
120   DB_LESS,
121   DB_GRTR,
122   // End of dvorak on bepo translation keys.
123
124   EPRM,
125   VRSN,
126   KC_DVORAK_ON_BEPO,
127   KC_BEPO,
128   KC_NORMAN,
129   KC_QWERTY,
130   KC_COLEMAK,
131   KC_DVORAK,
132   KC_WORKMAN,
133   KC_MAKE,
134   KC_RESET,
135   KC_RGB_T,
136   KC_SECRET_1,
137   KC_SECRET_2,
138   KC_SECRET_3,
139   KC_SECRET_4,
140   KC_SECRET_5,
141   KC_CCCV
142 };
143
144 #define SFTGUI_T(kc) { MT(MOD_LGUI | MOD_LSFT, kc) }
145 #define SFT_GUI_ESC MT(MOD_LSFT | MOD_LGUI, KC_PGDN)  // shift LGUI or Escape.
146 #define ALT_ENT     ALT_T(KC_ENT)  // Alt or enter
147 #define CTL_SPC     CTL_T(KC_SPC) // ctrl or space
148 #define CTL_BSPC    CTL_T(KC_BSPC) // ctrl or backspace
149 #define ALT_DEL     ALT_T(KC_DEL)  // Alt or delete
150 #define GUI_ESC     GUI_T(KC_ESC)  // Gui or escape
151 #define ALGR_SYMB   ALGR_T(TG(SYMB))  // Alt gre or toggle symbol layer
152
153 #define KC_SFT_T_U   SFT_T(KC_U)
154 #define KC_SFT_T_H   SFT_T(KC_H)
155 #define KC_LT_SYMB_I LT(SYMB, KC_I)
156 #define KC_LT_SYMB_D LT(SYMB, KC_D)
157
158 // for dvorak on bepo
159 #define BP_SFT_T_U   SFT_T(BP_U)
160 #define BP_SFT_T_H   SFT_T(BP_H)
161 #define BP_LT_SYMB_D LT(SYMB, BP_D)
162
163
164 // for bepo on bepo
165 #define BP_SFT_T_T    SFT_T(BP_T)
166 #define BP_LT_SYMB_C  LT(SYMB_ON_BEPO, BP_C)
167 #define BP_LT_SYMB_I  LT(SYMB_ON_BEPO, BP_I)
168 #define BP_SFT_T_E SFT_T(BP_E)
169 #define BP_SFT_T_ECRC SFT_T(BP_ECRC)
170 #define BP_SFT_T_CCED SFT_T(BP_CCED)
171 #define BP_LT_SYMB_COMM LT(SYMB,BP_COMM)
172
173 // OSM keycodes, to keep things clean and easy to change
174 #define KC_MLSF OSM(MOD_LSFT)
175 #define KC_MRSF OSM(MOD_RSFT)
176 #define OS_LGUI OSM(MOD_LGUI)
177 #define OS_RGUI OSM(MOD_RGUI)
178 #define OS_LSFT OSM(MOD_LSFT)
179 #define OS_RSFT OSM(MOD_RSFT)
180 #define OS_LCTL OSM(MOD_LCTL)
181 #define OS_RCTL OSM(MOD_RCTL)
182 #define OS_LALT OSM(MOD_LALT)
183 #define OS_RALT OSM(MOD_RALT)
184 #define ALT_APP ALT_T(KC_APP)
185
186 #define MG_NKRO MAGIC_TOGGLE_NKRO
187
188
189 ////  TAP DANCE
190
191 typedef struct {
192   bool is_press_action;
193     int state;
194 } tdtap;
195
196 enum {
197   SINGLE_TAP = 1,
198   SINGLE_HOLD = 2,
199   DOUBLE_TAP = 3,
200   DOUBLE_HOLD = 4,
201   DOUBLE_SINGLE_TAP = 5, //send two single taps
202   TRIPLE_TAP = 6,
203   TRIPLE_HOLD = 7
204   };
205
206   //Tap Dance Declarations
207   enum {
208     TD_ESC_CAPS = 0,
209     TD_TAB_BKTAB = 1,
210     TD_MDIA_SYMB = 2,
211     TD_HOME_END = 3,
212     TD_XMONAD_ESC = 4,
213     TD_DEF_LAYER_SW = 5,
214     TD_DEF_OS_LAYER_SW = 6,
215     TD_MOUSE_BTNS = 7,
216     TD_DVORAK_BEPO = 8
217   };
218
219
220 // Tap dance
221 #define TAB_BKTAB       TD(TD_TAB_BKTAB)  // Tab or backtab tapdance.
222 #define MDIA_SYMB       TD(TD_MDIA_SYMB)  // MDIA or Symb layer tapdance toggle.
223 #define DEF_LAYER_SW    TD(TD_DEF_LAYER_SW)  // dvorak, dvorak_on_bepo, bepo default layer
224 #define DEF_OS_LAYER_SW TD(TD_DEF_OS_LAYER_SW)  // dvorak, dvorak_on_bepo, bepo default layer
225 #define HOME_END        TD(TD_HOME_END)  // home or end tapdance.
226 #define XMONAD_ESC      TD(TD_XMONAD_ESC)  // Escape, dvorak, media or symb. - tap and hold tap dance. 1-4
227 #define DVORAK_ET_BEPO  TD(TD_DVORAK_BEPO)  // Escape, dvorak, media or symb. - tap and hold tap dance. 1-4
228 #define TDMOUSE_BTNS    TD(TD_MOUSE_BTNS)  // hmmm. 1-5
229
230
231 int on_qwerty(void);
232 int get_xmonad_layer(void);
233 int cur_dance (qk_tap_dance_state_t *state);
234
235 //for the x tap dance. Put it here so it can be used in any keymap
236 void x_finished (qk_tap_dance_state_t *state, void *user_data);
237 void x_reset (qk_tap_dance_state_t *state, void *user_data);
238
239
240 // Blocks for each of the four major keyboard layouts
241 // Organized so we can quickly adapt and modify all of them
242 // at once, rather than for each keyboard, one at a time.
243 // And this allows for much cleaner blocks in the keymaps.
244 // For instance Tap/Hold for Control on all of the layouts
245
246 // NOTE: These are all the same length.  If you do a search/replace
247 //       then you need to add/remove underscores to keep the
248 //       lengths consistent.
249
250 // Since our quirky block definitions are basically a list of comma separated
251 // arguments, we need a wrapper in order for these definitions to be
252 // expanded before being used as arguments to the LAYOUT_xxx macro.
253 #if (!defined(LAYOUT) && defined(KEYMAP))
254 #define LAYOUT KEYMAP
255 #endif
256
257 #define LAYOUT_ergodox_wrapper(...)          LAYOUT_ergodox(__VA_ARGS__)
258 #define LAYOUT_ergodox_pretty_wrapper(...)   LAYOUT_ergodox_pretty(__VA_ARGS__)
259 #define KEYMAP_wrapper(...)                  LAYOUT(__VA_ARGS__)
260 #define LAYOUT_wrapper(...)                  LAYOUT(__VA_ARGS__)
261
262 //Dvorak on a qwerty software layer in the OS
263 #define ___DVORAK_L1___ KC_QUOT, KC_COMM, KC_DOT, KC_P,       KC_Y
264 #define ___DVORAK_L2___ KC_A,    KC_O,    KC_E,   KC_SFT_T_U, KC_LT_SYMB_I
265 #define ___DVORAK_L3___ KC_SCLN, KC_Q,    KC_J,   KC_K,       KC_X
266
267 #define ___DVORAK_R1___ KC_F,         KC_G,       KC_C, KC_R, KC_L
268 #define ___DVORAK_R2___ KC_LT_SYMB_D, KC_SFT_T_H, KC_T, KC_N, KC_S
269 #define ___DVORAK_R3___ KC_B,         KC_M,       KC_W, KC_V, KC_Z
270
271
272 // Dvorak on fr-bepo software layer in the OS.
273 // for dvorak and all the other qwerty like keyboards on bepo
274 #define ___NUMBER_BEPO_L___ DB_1,   DB_2,   DB_3,   DB_4,   DB_5
275 #define ___NUMBER_BEPO_R___ DB_6,   DB_7,   DB_8,   DB_9,   DB_0
276
277 #define ___DVORAK_FR_L1___ DB_QUOT,    DB_COMM,  DB_DOT,  BP_P,        BP_Y
278 #define ___DVORAK_FR_L2___ BP_A,       BP_O,     BP_E,    BP_SFT_T_U,  BP_LT_SYMB_I
279 #define ___DVORAK_FR_L3___ DB_SCOLON,  BP_Q,     BP_J,    BP_K,        BP_X
280
281 #define ___DVORAK_FR_R1___ BP_F,          BP_G,        BP_C,  BP_R,  BP_L
282 #define ___DVORAK_FR_R2___ BP_LT_SYMB_D,  BP_SFT_T_H,  BP_T,  BP_N,  BP_S
283 #define ___DVORAK_FR_R3___ BP_B,          BP_M,        BP_W,  BP_V,  BP_Z
284
285
286 // Bepo on fr-bepo software layer
287 // for bepo on bepo
288 #define ___SYMBOL_BEPO_L___ /* BP_DLR */ BP_DQOT,  BP_LGIL,   BP_RGIL,   BP_LPRN,   BP_RPRN
289 #define ___SYMBOL_BEPO_R___    BP_AT,    BP_PLUS,  BP_MINS,   BP_SLASH,  BP_ASTR /* BP_EQL,  BP_PERC */
290
291 #define ___BEPO_FR_L1___             BP_B,    BP_ECUT, BP_P,   BP_O,        BP_EGRV
292 #define ___BEPO_FR_L2___             BP_A,    BP_U,    BP_I,   BP_SFT_T_E,  BP_LT_SYMB_COMM
293 #define ___BEPO_FR_L3___ /*BP_ECRC*/ BP_AGRV, BP_Y,    BP_X,   BP_DOT,      BP_K
294
295 #define ___BEPO_FR_R1___ /* BP_DCRC*/  BP_V,       BP_D,  BP_L,    BP_J,  BP_Z //,  BP_W
296 #define ___BEPO_FR_R2___ /* BP_C  */   BP_SFT_T_T, BP_S,    BP_R,  BP_N,    BP_M  //BP_CCED
297 #define ___BEPO_FR_R3___               BP_APOS,    BP_Q,    BP_G,  BP_H,    BP_F
298
299 // the bottom rows  for keyboards on bepo.
300 #define ___ERGODOX_BOTTOM_RIGHT_FR___ KC_UP,  KC_DOWN,  DB_BACKSLASH,  LCTL(BP_V),  LCTL(BP_C)
301 #define ___ERGODOX_BOTTOM_LEFT_FR___  LCTL(BP_C),  LCTL(BP_V),  KC_INS,  KC_LEFT, KC_RIGHT
302
303 // Since we have 7 default layouts (QWERTY, DVORAK, COLEMAK and WORKMAN, NORMAN,
304 // 2 of them based on a Bepo software keyboard, ---  DVORAK_ON_BEPO and BEPO),
305 // this allows us to quickly modify the bottom row for all of the layouts
306 // so we don't have to alter it 4 times and hope that we haven't missed
307 // anything
308 #define ___ERGODOX_BOTTOM_LEFT___  LCTL(KC_C),  LCTL(KC_V),  KC_INS,  KC_LEFT, KC_RIGHT
309 #define ___ERGODOX_BOTTOM_RIGHT___ KC_UP,  KC_DOWN,  KC_BSLASH,  LCTL(KC_V),  LCTL(KC_C)
310
311 #define ___ERGODOX_THUMB_LEFT___                \
312   KC_RALT, ALGR_SYMB,                           \
313     HOME_END,                                   \
314     CTL_BSPC, ALT_DEL, XMONAD_ESC
315
316 #define ___ERGODOX_THUMB_RIGHT___               \
317   ALGR_SYMB,  TD_MOUSE_BTNS,                    \
318     KC_PGUP,                                    \
319     KC_PGDN, ALT_ENT, CTL_SPC
320
321 #define ___ERGODOX_TRANS_THUMBS___              \
322   ___, ___,                                     \
323     ___,                                        \
324     ___, ___, ___                               \
325
326 #define ___ERGODOX_TRANS_BOTTOM___              \
327   ___,___,___,___,___
328
329 #define ___ERGODOX_TRANS_6_ROW___               \
330   ___,___,___,___,___,___
331
332
333
334 // Qwerty based layers that I don't really use.
335 #define ___QWERTY_L1___ KC_Q,    KC_W,    KC_E,    KC_R,    KC_T
336 #define ___QWERTY_L2___ KC_A,    KC_S,    KC_D,    KC_F,    KC_G
337 #define ___QWERTY_L3___ KC_Z,    KC_X,    KC_C,    KC_V,    KC_B
338
339 #define ___QWERTY_R1___ KC_Y,    KC_U,    KC_I,    KC_O,    KC_P
340 #define ___QWERTY_R2___ KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN
341 #define ___QWERTY_R3___ KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLASH
342
343
344 #define ___COLEMAK_L1___ KC_Q,    KC_W,    KC_F,    KC_P,    KC_G
345 #define ___COLEMAK_L2___ KC_A,    KC_R,    KC_S,    KC_T,    KC_D
346 #define ___COLEMAK_L3___ KC_Z,    KC_X,    KC_C,    KC_V,    KC_B
347
348 #define ___COLEMAK_R1___ KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN
349 #define ___COLEMAK_R2___ KC_H,    KC_N,    KC_E,    KC_I,    KC_O
350 #define ___COLEMAK_R3___ KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLASH
351
352
353 #define ___COLEMAK_MOD_DH_L1___ KC_Q,    KC_W,    KC_F,    KC_P,    KC_B
354 #define ___COLEMAK_MOD_DH_L2___ KC_A,    KC_R,    KC_S,    KC_T,    KC_G
355 #define ___COLEMAK_MOD_DH_L3___ CTL_T(KC_Z),   KC_X,    KC_C,    KC_D,    KC_V
356
357 #define ___COLEMAK_MOD_DH_R1___ KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN
358 #define ___COLEMAK_MOD_DH_R2___ KC_M,    KC_N,    KC_E,    KC_I,    KC_O
359 #define ___COLEMAK_MOD_DH_R3___ KC_K,    KC_H,    KC_COMM, KC_DOT,  KC_SLASH
360
361
362 #define ___WORKMAN_L1___ KC_Q,  KC_D,    KC_R,   KC_W,     KC_B
363 #define ___WORKMAN_L2___ KC_A,  KC_S,    KC_H,   KC_T,     KC_G
364 #define ___WORKMAN_L3___ KC_Z,  KC_X,    KC_M,   KC_C,     KC_V
365
366 #define ___WORKMAN_R1___ KC_J,  KC_F,    KC_U,    KC_P,    KC_SCLN
367 #define ___WORKMAN_R2___ KC_Y,  KC_N,    KC_E,    KC_O,    KC_I
368 #define ___WORKMAN_R3___ KC_K,  KC_L,    KC_COMM, KC_DOT,  KC_SLASH
369
370
371 #define ___NORMAN_L1___ KC_Q,   KC_W,    KC_D,    KC_F,    KC_K
372 #define ___NORMAN_L2___ KC_A,   KC_S,    KC_E,    KC_T,    KC_G
373 #define ___NORMAN_L3___ KC_Z,   KC_X,    KC_C,    KC_V,    KC_B
374
375 #define ___NORMAN_R1___ KC_J,   KC_U,    KC_R,    KC_L,    KC_SCLN
376 #define ___NORMAN_R2___ KC_Y,   KC_N,    KC_I,    KC_O,    KC_U
377 #define ___NORMAN_R3___ KC_P,   KC_M,    KC_COMM, KC_DOT,  KC_SLASH
378
379
380 //  For the top rows.  Numbers for most things, symbols for Bepo.
381
382 // for everything on qwerty.
383 #define ___NUMBER_L___ KC_1,    KC_2,    KC_3,    KC_4,    KC_5
384 #define ___NUMBER_R___ KC_6,    KC_7,    KC_8,    KC_9,    KC_0
385
386 // function key rows, works for everyone.
387 #define ___FUNC_L___   KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5
388 #define ___FUNC_R___   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10
389
390
391 // Rows for the auxillary layers.
392
393 // The symbol layer is for qwerty.  I need another one for Bepo...
394
395 // the KC_P?  codes don't work for me. I don't use those shifted values anyway.
396 #define ___KEYPAD_1___ KC_7,  KC_8,    KC_9,     KC_PSLS
397 #define ___KEYPAD_2___ KC_4,  KC_5,    KC_6,     KC_PAST
398 #define ___KEYPAD_3___ KC_1,  KC_2,    KC_3,     KC_PMNS
399 #define ___KEYPAD_4___ KC_0,  KC_DOT,  KC_PEQL,  KC_PPLS
400
401 #define ___KEYPAD_1_BP___ DB_7,  DB_8,    DB_9,     BP_SLASH
402 #define ___KEYPAD_2_BP___ DB_4,  DB_5,    DB_6,     BP_ASTR
403 #define ___KEYPAD_3_BP___ DB_1,  DB_2,    DB_3,     DB_MINUS
404 #define ___KEYPAD_4_BP___ DB_0,  DB_DOT,  DB_EQL,   BP_PLUS
405
406 #define ___SYMBOLS_1___  KC_EXLM,  KC_AT,    KC_LCBR,  KC_RCBR,  KC_PIPE
407 #define ___SYMBOLS_2___  KC_HASH,  KC_DLR,   KC_LPRN,  KC_RPRN,  KC_GRV
408 #define ___SYMBOLS_3___  KC_PERC,  KC_CIRC,  KC_LBRC,  KC_RBRC,  KC_TILD
409
410 #define ___SYMBOLS_1_BP___ KC_EXLM,  BP_AT,    DB_LCBR,  DB_RCBR,  DB_PIPE
411 #define ___SYMBOLS_2_BP___ DB_HASH,  BP_DLR,   DB_LPRN,  DB_RPRN,  DB_GRV
412 #define ___SYMBOLS_3_BP___ BP_PERC,  DB_CIRC,  DB_LBRC,  DB_RBRC,  DB_TILD
413
414 #define ___MOUSE_LDUR___      KC_MS_L,  KC_MS_D,  KC_MS_U,  KC_MS_R
415 #define ___MWHEEL_LDUR___     KC_WH_L,  KC_WH_D,  KC_WH_U,  KC_WH_R
416 #define ___MOUSE_BTNS_R___    KC_BTN1,  KC_BTN2,  KC_BTN3,  KC_BTN4,  KC_BTN5
417 #define ___MOUSE_BTNS_L___    KC_BTN5,  KC_BTN4,  KC_BTN3,  KC_BTN2,  KC_BTN1
418 #define ___MOUSE_ACCL_012___  KC_ACL0,  KC_ACL1,  KC_ACL2
419
420 #define ___MUTE_PLAY_STOP___  KC_MUTE,  KC_MPLY,  KC_MSTP
421 #define ___VI_ARROWS___       KC_LEFT,  KC_DOWN,  KC_UP, KC_RIGHT
422
423 #define ___LAYERS_L1___ DF(BEPO), DF(DVORAK_ON_BEPO)
424 #define ___LAYERS_L2___ DF(COLEMAK), DF(DVORAK)
425 #define ___LAYERS_L3___ DF(QWERTY), DF(NORMAN), DF(WORKMAN)
426 #define ___LAYERS_L4___ TO(MDIA), TO(SYMB_ON_BEPO), TO(SYMB)
427
428
429 #endif