1 /* -*- Mode:C; c-basic-offset:2; tab-width:2; indent-tabs-mode:nil; evil-indent-convert-tabs:t; -*- */
3 #include QMK_KEYBOARD_H
5 #include "action_layer.h"
9 * See `readme.md` for notes on each define.
12 /* Personal preference (enable by passing EXTRAFLAGS=... to make). */
13 /* #define CFQ_USE_MOMENTARY_LAYER_KEYS */
15 #define CFQ_USE_DYNAMIC_MACRO
17 #if !defined(CFQ_USER_KEY0)
18 # define CFQ_USER_KEY0 KC_BSPC
20 #if !defined(CFQ_USER_KEY1)
21 # define CFQ_USER_KEY1 CFQ_KC_FN1
23 #if !defined(CFQ_USER_KEY2)
24 # define CFQ_USER_KEY2 KC_LT
26 #if !defined(CFQ_USER_KEY3)
27 # define CFQ_USER_KEY3 KC_GT
29 #if !defined(CFQ_USER_KEY4)
30 # define CFQ_USER_KEY4 KC_BSPC
32 #if !defined(CFQ_USER_KEY5)
33 # define CFQ_USER_KEY5 KC_DELT
35 #if !defined(CFQ_USER_KEY6)
36 # define CFQ_USER_KEY6 KC_CAPS
38 #if !defined(CFQ_USER_KEY7)
39 # define CFQ_USER_KEY7 CFQ_KC_FN3
100 #define CFQ_WORD_T ""
103 #define CFQ_WORD_U ""
106 #define CFQ_WORD_V ""
109 #define CFQ_WORD_W ""
112 #define CFQ_WORD_X ""
115 #define CFQ_WORD_Y ""
118 #define CFQ_WORD_Z ""
121 static const char *cfq_word_lut[26] = {
122 CFQ_WORD_A, CFQ_WORD_B, CFQ_WORD_C, CFQ_WORD_D, CFQ_WORD_E, CFQ_WORD_F,
123 CFQ_WORD_G, CFQ_WORD_H, CFQ_WORD_I, CFQ_WORD_J, CFQ_WORD_K, CFQ_WORD_L,
124 CFQ_WORD_M, CFQ_WORD_N, CFQ_WORD_O, CFQ_WORD_P, CFQ_WORD_Q, CFQ_WORD_R,
125 CFQ_WORD_S, CFQ_WORD_T, CFQ_WORD_U, CFQ_WORD_V, CFQ_WORD_W, CFQ_WORD_X,
126 CFQ_WORD_Y, CFQ_WORD_Z,
129 #define BASE 0 /* default layer */
130 #define SYMB 1 /* symbols */
131 #define MDIA 2 /* media keys */
132 #define WORD 3 /* experimental keys */
134 enum custom_keycodes {
135 PLACEHOLDER = SAFE_RANGE, /* can always be here */
151 /* allow user defined words for each character:
152 * use CFQ_WORD_[A-Z] defines. */
153 M_WORD_A, M_WORD_B, M_WORD_C, M_WORD_D, M_WORD_E, M_WORD_F,
154 M_WORD_G, M_WORD_H, M_WORD_I, M_WORD_J, M_WORD_K, M_WORD_L,
155 M_WORD_M, M_WORD_N, M_WORD_O, M_WORD_P, M_WORD_Q, M_WORD_R,
156 M_WORD_S, M_WORD_T, M_WORD_U, M_WORD_V, M_WORD_W, M_WORD_X,
159 #ifdef CFQ_USE_DYNAMIC_MACRO
164 #ifdef CFQ_USE_DYNAMIC_MACRO
165 #include "dynamic_macro.h"
168 #ifdef CFQ_USE_MOMENTARY_LAYER_KEYS
169 #define CFQ_KC_FN1 MO(1)
170 #define CFQ_KC_FN2 MO(2)
171 #define CFQ_KC_FN3 MO(3)
173 #define CFQ_KC_FN1 KC_FN1
174 #define CFQ_KC_FN2 KC_FN2
175 #define CFQ_KC_FN3 KC_FN3
178 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
179 /* Keymap 0: Basic layer
180 * ,--------------------------------------------------. ,--------------------------------------------------.
181 * | Grave | ! | @ | # | $ | % | { | | } | ^ | & | * | - | = | BSpace |
182 * |--------+------+------+------+------+------+------| |------+------+------+------+------+------+--------|
183 * | Tab | Q | W | E | R | T | ( | | ) | Y | U | I | O | P | \ |
184 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
185 * | Esc | A | S | D | F | G |------| |------| H | J | K | L | ; | ' |
186 * |--------+------+------+------+------+------| [ | | ] |------+------+------+------+------+--------|
187 * | LShift | Z | X | C | V | B | | | | N | M | , | . | / | RShift |
188 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
189 * | LCtl |Super | Alt | ~L1 |Space | | Left | Down | Up |Right | Ins |
190 * `----------------------------------' `----------------------------------'
191 * ,-------------. ,-------------.
192 * | < | > | | Home | End |
193 * ,------+------+------| |------+------+------.
194 * | | |CapsLk| | PgUp | | |
195 * |BSpace| Del |------| |------| ~L2 |Space |
196 * | | | ~L3 | | PgDn | | |
197 * `--------------------' `--------------------'
199 * Optional overrides: see CFQ_USER_KEY# defines.
201 * ,--------------------------------------------------. ,--------------------------------------------------.
202 * | | | | | | | | | | | | | | | USR0 |
203 * |--------+------+------+------+------+------+------| |------+------+------+------+------+------+--------|
204 * | | | | | | | | | | | | | | | |
205 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
206 * | | | | | | |------| |------| | | | | | |
207 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
208 * | | | | | | | | | | | | | | | |
209 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
210 * | | | | USR1 | | | | | | | |
211 * `----------------------------------' `----------------------------------'
212 * ,-------------. ,-------------.
213 * | USR2 | USR3 | | | |
214 * ,------+------+------| |------+------+------.
215 * | | | USR6 | | | | |
216 * | USR4 | USR5 |------| |------| | |
217 * | | | USR7 | | | | |
218 * `--------------------' `--------------------'
221 /* If it accepts an argument (i.e, is a function), it doesn't need KC_.
222 * Otherwise, it needs KC_* */
223 [BASE] = LAYOUT_ergodox( /* layer 0 : default */
225 KC_GRV, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_LCBR,
226 KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_LPRN,
227 KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G,
228 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_LBRC,
229 KC_LCTL, KC_LGUI, KC_LALT, CFQ_USER_KEY1, KC_SPC,
230 CFQ_USER_KEY2, CFQ_USER_KEY3,
232 CFQ_USER_KEY4, CFQ_USER_KEY5, CFQ_USER_KEY7,
234 KC_RCBR, KC_CIRC, KC_AMPR, KC_ASTR,KC_MINS, KC_EQL, CFQ_USER_KEY0,
235 KC_RPRN, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSLS,
236 KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
237 KC_RBRC, KC_N, KC_M, KC_COMM,KC_DOT, KC_SLSH, KC_RSFT,
238 KC_LEFT, KC_DOWN,KC_UP, KC_RGHT, KC_INS,
241 KC_PGDN, CFQ_KC_FN2, KC_ENT
242 ),/* Keymap 1: KeyPad, Macro Record
244 * ,--------------------------------------------------. ,--------------------------------------------------.
245 * | | | | | | | {} | | }{ | |NumLck| / | * | - | |
246 * |--------+------+------+------+------+------+------| |------+------+------+------+------+------+--------|
247 * | | | | | | => | () | | )( | <= | 7 | 8 | 9 | + | |
248 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
249 * | | | | | | -> |------| |------| <- | 4 | 5 | 6 | + | |
250 * |--------+------+------+------+------+------| [] | | ][ |------+------+------+------+------+--------|
251 * | | | | | | <> | | | | >< | 1 | 2 | 3 | Enter| |
252 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
253 * | | | | | | | 0 | | . | Enter| |
254 * `----------------------------------' `----------------------------------'
255 * ,-------------. ,--------------.
256 * |Start1|Start2| | | |
257 * ,------+------+------| |------+-------+------.
258 * | | | Stop | | | | |
259 * |Play1 |Play2 |------| |------| | |
261 * `--------------------' `---------------------'
264 [SYMB] = LAYOUT_ergodox(
266 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M_BRACKET_IN_CBR,
267 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M_ARROW_REQL, M_BRACKET_IN_PRN,
268 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M_ARROW_RMINUS,
269 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M_BRACKET_IN_ANG, M_BRACKET_IN_BRC,
270 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
271 #ifdef CFQ_USE_DYNAMIC_MACRO
272 DYN_REC_START1, DYN_REC_START2,
274 DYN_MACRO_PLAY1, DYN_MACRO_PLAY2, KC_TRNS,
278 KC_TRNS, KC_TRNS, KC_TRNS,
281 M_BRACKET_OUT_CBR, KC_TRNS, KC_NLCK, KC_KP_SLASH, KC_KP_ASTERISK, KC_KP_MINUS, KC_TRNS,
282 M_BRACKET_OUT_PRN, M_ARROW_LEQL, KC_KP_7, KC_KP_8, KC_KP_9, KC_KP_PLUS, KC_TRNS,
283 M_ARROW_LMINUS, KC_KP_4, KC_KP_5, KC_KP_6, KC_KP_PLUS, KC_TRNS,
284 M_BRACKET_OUT_BRC, M_BRACKET_OUT_ANG, KC_KP_1, KC_KP_2, KC_KP_3, KC_KP_ENTER, KC_TRNS,
285 KC_KP_0, KC_TRNS, KC_KP_DOT, KC_KP_ENTER, KC_TRNS,
288 KC_TRNS, KC_TRNS, KC_TRNS
290 /* Keymap 2: F-Keys, media and mouse keys
292 * ,--------------------------------------------------. ,--------------------------------------------------.
293 * | | | | | | | | | | | | | | | |
294 * |--------+------+------+------+------+------+------| |------+------+------+------+------+------+--------|
295 * | | | | MsUp | | |MWhlUp| | | | | | | | |
296 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
297 * | | |MsLeft|MsDown|MsRght| |------| |------| Left | Down | Up |Right | | |
298 * |--------+------+------+------+------+------|MWhlDn| | |------+------+------+------+------+--------|
299 * | | | Rclk | Mclk | Lclk | | | | | | | | | | |
300 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
301 * | | | | | | | | | | | |
302 * `----------------------------------' `----------------------------------'
303 * ,-------------. ,-------------.
304 * | MRwd | MFwd | | MPrv | MNxt |
305 * ,------+------+------| |------+------+------.
306 * | | | | |VolUp | | |
307 * | Mute | |------| |------| | Play |
308 * | | | | |VolDn | | |
309 * `--------------------' `--------------------'
311 /* MEDIA AND MOUSE */
312 [MDIA] = LAYOUT_ergodox(
314 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
315 KC_TRNS, KC_TRNS, KC_TRNS, KC_MS_U, KC_TRNS, KC_TRNS, KC_WH_U,
316 KC_TRNS, KC_TRNS, KC_MS_L, KC_MS_D, KC_MS_R, KC_TRNS,
317 KC_TRNS, KC_TRNS, KC_BTN2, KC_BTN3, KC_BTN1, KC_TRNS, KC_WH_D,
318 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
321 KC_MUTE, KC_TRNS, KC_TRNS,
323 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
324 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
325 KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_TRNS, KC_TRNS,
326 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
327 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
330 KC_VOLD, KC_TRNS, KC_MPLY
332 /* Keymap 3: Entire Words (one for each key)
334 * ,--------------------------------------------------. ,--------------------------------------------------.
335 * | | F1 | F2 | F3 | F4 | F5 | F11 | | F12 | F6 | F7 | F8 | F9 | F10 | |
336 * |--------+------+------+------+------+------+------| |------+------+------+------+------+------+--------|
337 * | | Q | W | E | R | T | | | | Y | U | I | O | P | |
338 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
339 * | | A | S | D | F | G |------| |------| H | J | K | L | | |
340 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
341 * | | Z | X | C | V | B | | | | N | M | | | | |
342 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
343 * | | | | | | | | | | | |
344 * `----------------------------------' `----------------------------------'
345 * ,-------------. ,-------------.
347 * ,------+------+------| |------+------+------.
349 * | | |------| |------| | |
351 * `--------------------' `--------------------'
355 [WORD] = LAYOUT_ergodox(
357 KC_TRNS, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F11,
358 KC_TRNS, M_WORD_Q, M_WORD_W, M_WORD_E, M_WORD_R, M_WORD_T, KC_TRNS,
359 KC_TRNS, M_WORD_A, M_WORD_S, M_WORD_D, M_WORD_F, M_WORD_G,
360 KC_TRNS, M_WORD_Z, M_WORD_X, M_WORD_C, M_WORD_V, M_WORD_B, KC_TRNS,
361 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
364 KC_TRNS, KC_TRNS, KC_TRNS,
366 KC_F12, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_TRNS,
367 KC_TRNS, M_WORD_Y, M_WORD_U, M_WORD_I, M_WORD_O, M_WORD_P, KC_TRNS,
368 M_WORD_H, M_WORD_J, M_WORD_K, M_WORD_L, KC_TRNS, KC_TRNS,
369 KC_TRNS, M_WORD_N, M_WORD_M, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
370 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
373 KC_TRNS, KC_TRNS, KC_TRNS
377 const uint16_t PROGMEM fn_actions[] = {
378 [1] = ACTION_LAYER_TAP_TOGGLE(SYMB), /* FN1 - Momentary Layer 1 (Symbols) */
379 [2] = ACTION_LAYER_TAP_TOGGLE(MDIA), /* FN2 - Momentary Layer 2 (Media) */
380 [3] = ACTION_LAYER_TAP_TOGGLE(WORD), /* FN3 - Momentary Layer 3 (Words) */
383 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
384 #ifdef CFQ_USE_DYNAMIC_MACRO
385 if (!process_record_dynamic_macro(keycode, record)) {
390 /* dynamically generate these. */
392 if (record->event.pressed) {
393 #ifdef RGBLIGHT_ENABLE
399 case M_BRACKET_IN_CBR: /* {} */
400 if (record->event.pressed) {
401 SEND_STRING("{}" SS_TAP(X_LEFT));
405 case M_BRACKET_IN_PRN: /* () */
406 if (record->event.pressed) {
407 SEND_STRING("()" SS_TAP(X_LEFT));
411 case M_BRACKET_IN_BRC: /* [] */
412 if (record->event.pressed) {
413 SEND_STRING("[]" SS_TAP(X_LEFT));
417 case M_BRACKET_IN_ANG: /* <> */
418 if (record->event.pressed) {
419 SEND_STRING("<>" SS_TAP(X_LEFT));
423 case M_BRACKET_OUT_CBR: /* }{ */
424 if (record->event.pressed) {
425 SEND_STRING("}{" SS_TAP(X_LEFT));
429 case M_BRACKET_OUT_PRN: /* )( */
430 if (record->event.pressed) {
431 SEND_STRING(")(" SS_TAP(X_LEFT));
435 case M_BRACKET_OUT_BRC: /* ][ */
436 if (record->event.pressed) {
437 SEND_STRING("][" SS_TAP(X_LEFT));
441 case M_BRACKET_OUT_ANG: /* >< */
442 if (record->event.pressed) {
443 SEND_STRING("><" SS_TAP(X_LEFT));
447 case M_ARROW_LMINUS: /* <- */
448 if (record->event.pressed) {
453 case M_ARROW_RMINUS: /* -> */
454 if (record->event.pressed) {
459 case M_ARROW_LEQL: /* <= */
460 if (record->event.pressed) {
465 case M_ARROW_REQL: /* => */
466 if (record->event.pressed) {
471 case KC_LSHIFT: /* '' */
472 if (record->event.pressed && (keyboard_report->mods & (MOD_BIT(KC_RSFT)))) {
474 SEND_STRING("''" SS_TAP(X_LEFT) SS_DOWN(X_RSHIFT) SS_DOWN(X_LSHIFT));
478 case KC_RSHIFT: /* "" */
479 if (record->event.pressed && (keyboard_report->mods & (MOD_BIT(KC_LSFT)))) {
481 SEND_STRING("\x22\x22" SS_TAP(X_LEFT) SS_DOWN(X_LSHIFT) SS_DOWN(X_RSHIFT));
486 case M_WORD_A...M_WORD_Z:
488 const char *word = cfq_word_lut[keycode - M_WORD_A];
489 if (record->event.pressed) {
502 /* Runs just one time when the keyboard initializes. */
503 void matrix_init_user(void) {
507 /* Runs constantly in the background, in a loop. */
508 void matrix_scan_user(void) {
510 uint8_t layer = biton32(layer_state);
512 ergodox_board_led_off();
513 ergodox_right_led_1_off();
514 ergodox_right_led_2_off();
515 ergodox_right_led_3_off();
518 ergodox_right_led_1_on();
521 ergodox_right_led_2_on();
524 ergodox_right_led_3_on();