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 /* Holding right/left or left/right shift for single or double quote pair */
16 /* #define CFQ_USE_SHIFT_QUOTES */
18 #define CFQ_USE_DYNAMIC_MACRO
20 #if !defined(CFQ_USER_KEY0)
21 # define CFQ_USER_KEY0 KC_BSPC
23 #if !defined(CFQ_USER_KEY1)
24 # define CFQ_USER_KEY1 CFQ_KC_FN1
26 #if !defined(CFQ_USER_KEY2)
27 # define CFQ_USER_KEY2 KC_INS
29 #if !defined(CFQ_USER_KEY3)
30 # define CFQ_USER_KEY3 KC_NLCK
32 #if !defined(CFQ_USER_KEY4)
33 # define CFQ_USER_KEY4 KC_BSPC
35 #if !defined(CFQ_USER_KEY5)
36 # define CFQ_USER_KEY5 KC_DELT
38 #if !defined(CFQ_USER_KEY6)
39 # define CFQ_USER_KEY6 KC_CAPS
41 #if !defined(CFQ_USER_KEY7)
42 # define CFQ_USER_KEY7 CFQ_KC_FN3
44 #if !defined(CFQ_USER_KEY8)
45 # define CFQ_USER_KEY8 KC_DEL
100 #define CFQ_WORD_R ""
103 #define CFQ_WORD_S ""
106 #define CFQ_WORD_T ""
109 #define CFQ_WORD_U ""
112 #define CFQ_WORD_V ""
115 #define CFQ_WORD_W ""
118 #define CFQ_WORD_X ""
121 #define CFQ_WORD_Y ""
124 #define CFQ_WORD_Z ""
127 /* lower and title capitals versions (setup at start). */
128 static char *cfq_word_lut[2][26] = {
130 CFQ_WORD_A, CFQ_WORD_B, CFQ_WORD_C, CFQ_WORD_D, CFQ_WORD_E, CFQ_WORD_F,
131 CFQ_WORD_G, CFQ_WORD_H, CFQ_WORD_I, CFQ_WORD_J, CFQ_WORD_K, CFQ_WORD_L,
132 CFQ_WORD_M, CFQ_WORD_N, CFQ_WORD_O, CFQ_WORD_P, CFQ_WORD_Q, CFQ_WORD_R,
133 CFQ_WORD_S, CFQ_WORD_T, CFQ_WORD_U, CFQ_WORD_V, CFQ_WORD_W, CFQ_WORD_X,
134 CFQ_WORD_Y, CFQ_WORD_Z,
139 /* Storage for title-caps strings. */
140 static char cfq_word_lut_title_caps[
141 sizeof(CFQ_WORD_A) + sizeof(CFQ_WORD_B) + sizeof(CFQ_WORD_C) + sizeof(CFQ_WORD_D) +
142 sizeof(CFQ_WORD_E) + sizeof(CFQ_WORD_F) + sizeof(CFQ_WORD_G) + sizeof(CFQ_WORD_H) +
143 sizeof(CFQ_WORD_I) + sizeof(CFQ_WORD_J) + sizeof(CFQ_WORD_K) + sizeof(CFQ_WORD_L) +
144 sizeof(CFQ_WORD_M) + sizeof(CFQ_WORD_N) + sizeof(CFQ_WORD_O) + sizeof(CFQ_WORD_P) +
145 sizeof(CFQ_WORD_Q) + sizeof(CFQ_WORD_R) + sizeof(CFQ_WORD_S) + sizeof(CFQ_WORD_T) +
146 sizeof(CFQ_WORD_U) + sizeof(CFQ_WORD_V) + sizeof(CFQ_WORD_W) + sizeof(CFQ_WORD_X) +
147 sizeof(CFQ_WORD_Y) + sizeof(CFQ_WORD_Z)
150 #define BASE 0 /* default layer */
151 #define SYMB 1 /* symbols */
152 #define MDIA 2 /* media keys */
153 #define WORD 3 /* experimental keys */
155 enum custom_keycodes {
156 PLACEHOLDER = SAFE_RANGE, /* can always be here */
172 /* allow user defined words for each character:
173 * use CFQ_WORD_[A-Z] defines. */
174 M_WORD_A, M_WORD_B, M_WORD_C, M_WORD_D, M_WORD_E, M_WORD_F,
175 M_WORD_G, M_WORD_H, M_WORD_I, M_WORD_J, M_WORD_K, M_WORD_L,
176 M_WORD_M, M_WORD_N, M_WORD_O, M_WORD_P, M_WORD_Q, M_WORD_R,
177 M_WORD_S, M_WORD_T, M_WORD_U, M_WORD_V, M_WORD_W, M_WORD_X,
180 #ifdef CFQ_USE_DYNAMIC_MACRO
185 #ifdef CFQ_USE_DYNAMIC_MACRO
186 #include "dynamic_macro.h"
189 #ifdef CFQ_USE_MOMENTARY_LAYER_KEYS
190 #define CFQ_KC_FN1 MO(1)
191 #define CFQ_KC_FN2 MO(2)
192 #define CFQ_KC_FN3 MO(3)
194 #define CFQ_KC_FN1 KC_FN1
195 #define CFQ_KC_FN2 KC_FN2
196 #define CFQ_KC_FN3 KC_FN3
199 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
200 /* Keymap 0: Basic layer
201 * ,--------------------------------------------------. ,--------------------------------------------------.
202 * | Grave | ! | @ | # | $ | % | { | | } | ^ | & | * | - | = | BSpace |
203 * |--------+------+------+------+------+------+------| |------+------+------+------+------+------+--------|
204 * | Tab | Q | W | E | R | T | ( | | ) | Y | U | I | O | P | \ |
205 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
206 * | Esc | A | S | D | F | G |------| |------| H | J | K | L | ; | ' |
207 * |--------+------+------+------+------+------| [ | | ] |------+------+------+------+------+--------|
208 * | LShift | Z | X | C | V | B | | | | N | M | , | . | / | RShift |
209 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
210 * | LCtl |Super | Alt | ~L1 |Space | | Left | Down | Up |Right | Del |
211 * `----------------------------------' `----------------------------------'
212 * ,-------------. ,-------------.
213 * | Ins |NumClk| | Home | End |
214 * ,------+------+------| |------+------+------.
215 * | | |CapsLk| | PgUp | | |
216 * |BSpace| Del |------| |------| ~L2 |Enter |
217 * | | | ~L3 | | PgDn | | |
218 * `--------------------' `--------------------'
220 * Optional overrides: see CFQ_USER_KEY# defines.
222 * ,--------------------------------------------------. ,--------------------------------------------------.
223 * | | | | | | | | | | | | | | | USR0 |
224 * |--------+------+------+------+------+------+------| |------+------+------+------+------+------+--------|
225 * | | | | | | | | | | | | | | | |
226 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
227 * | | | | | | |------| |------| | | | | | |
228 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
229 * | | | | | | | | | | | | | | | |
230 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
231 * | | | | USR1 | | | | | | | USR8 |
232 * `----------------------------------' `----------------------------------'
233 * ,-------------. ,-------------.
234 * | USR2 | USR3 | | | |
235 * ,------+------+------| |------+------+------.
236 * | | | USR6 | | | | |
237 * | USR4 | USR5 |------| |------| | |
238 * | | | USR7 | | | | |
239 * `--------------------' `--------------------'
242 /* If it accepts an argument (i.e, is a function), it doesn't need KC_.
243 * Otherwise, it needs KC_* */
244 [BASE] = LAYOUT_ergodox( /* layer 0 : default */
246 KC_GRV, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_LCBR,
247 KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_LPRN,
248 KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G,
249 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_LBRC,
250 KC_LCTL, KC_LGUI, KC_LALT, CFQ_USER_KEY1, KC_SPC,
251 CFQ_USER_KEY2, CFQ_USER_KEY3,
253 CFQ_USER_KEY4, CFQ_USER_KEY5, CFQ_USER_KEY7,
255 KC_RCBR, KC_CIRC, KC_AMPR, KC_ASTR,KC_MINS, KC_EQL, CFQ_USER_KEY0,
256 KC_RPRN, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSLS,
257 KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
258 KC_RBRC, KC_N, KC_M, KC_COMM,KC_DOT, KC_SLSH, KC_RSFT,
259 KC_LEFT, KC_DOWN,KC_UP, KC_RGHT, CFQ_USER_KEY8,
262 KC_PGDN, CFQ_KC_FN2, KC_ENT
263 ),/* Keymap 1: KeyPad, Macro Record
265 * ,--------------------------------------------------. ,--------------------------------------------------.
266 * | | | | | | | {} | | }{ | |NumLck| / | * | - | |
267 * |--------+------+------+------+------+------+------| |------+------+------+------+------+------+--------|
268 * | | | | | | => | () | | )( | <= | 7 | 8 | 9 | + | |
269 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
270 * | | | | | | -> |------| |------| <- | 4 | 5 | 6 | + | |
271 * |--------+------+------+------+------+------| [] | | ][ |------+------+------+------+------+--------|
272 * | | | | | | <> | | | | >< | 1 | 2 | 3 | Enter| |
273 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
274 * | | | | | | | 0 | | . | Enter| |
275 * `----------------------------------' `----------------------------------'
276 * ,-------------. ,--------------.
277 * |Start1|Start2| | | |
278 * ,------+------+------| |------+-------+------.
279 * | | | Stop | | | | |
280 * |Play1 |Play2 |------| |------| | |
282 * `--------------------' `---------------------'
285 [SYMB] = LAYOUT_ergodox(
287 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M_BRACKET_IN_CBR,
288 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M_ARROW_REQL, M_BRACKET_IN_PRN,
289 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M_ARROW_RMINUS,
290 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M_BRACKET_IN_ANG, M_BRACKET_IN_BRC,
291 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
292 #ifdef CFQ_USE_DYNAMIC_MACRO
293 DYN_REC_START1, DYN_REC_START2,
295 DYN_MACRO_PLAY1, DYN_MACRO_PLAY2, KC_TRNS,
299 KC_TRNS, KC_TRNS, KC_TRNS,
302 M_BRACKET_OUT_CBR, KC_TRNS, KC_NLCK, KC_KP_SLASH, KC_KP_ASTERISK, KC_KP_MINUS, KC_TRNS,
303 M_BRACKET_OUT_PRN, M_ARROW_LEQL, KC_KP_7, KC_KP_8, KC_KP_9, KC_KP_PLUS, KC_TRNS,
304 M_ARROW_LMINUS, KC_KP_4, KC_KP_5, KC_KP_6, KC_KP_PLUS, KC_TRNS,
305 M_BRACKET_OUT_BRC, M_BRACKET_OUT_ANG, KC_KP_1, KC_KP_2, KC_KP_3, KC_KP_ENTER, KC_TRNS,
306 KC_KP_0, KC_TRNS, KC_KP_DOT, KC_KP_ENTER, KC_TRNS,
309 KC_TRNS, KC_TRNS, KC_TRNS
311 /* Keymap 2: F-Keys, media and mouse keys
313 * ,--------------------------------------------------. ,--------------------------------------------------.
314 * | | | | | | | | | | | | | | | |
315 * |--------+------+------+------+------+------+------| |------+------+------+------+------+------+--------|
316 * | | | | MsUp | | |MWhlUp| | | | | | | | |
317 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
318 * | | |MsLeft|MsDown|MsRght| |------| |------| Left | Down | Up |Right | | |
319 * |--------+------+------+------+------+------|MWhlDn| | |------+------+------+------+------+--------|
320 * | | | Rclk | Mclk | Lclk | | | | | | | | | | |
321 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
322 * | | | | | | | | | | | |
323 * `----------------------------------' `----------------------------------'
324 * ,-------------. ,-------------.
325 * | MRwd | MFwd | | MPrv | MNxt |
326 * ,------+------+------| |------+------+------.
327 * | | | | |VolUp | | |
328 * | Mute | |------| |------| | Play |
329 * | | | | |VolDn | | |
330 * `--------------------' `--------------------'
332 /* MEDIA AND MOUSE */
333 [MDIA] = LAYOUT_ergodox(
335 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
336 KC_TRNS, KC_TRNS, KC_TRNS, KC_MS_U, KC_TRNS, KC_TRNS, KC_WH_U,
337 KC_TRNS, KC_TRNS, KC_MS_L, KC_MS_D, KC_MS_R, KC_TRNS,
338 KC_TRNS, KC_TRNS, KC_BTN2, KC_BTN3, KC_BTN1, KC_TRNS, KC_WH_D,
339 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
342 KC_MUTE, KC_TRNS, KC_TRNS,
344 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
345 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
346 KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_TRNS, KC_TRNS,
347 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
348 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
351 KC_VOLD, KC_TRNS, KC_MPLY
353 /* Keymap 3: Entire Words (one for each key)
355 * ,--------------------------------------------------. ,--------------------------------------------------.
356 * | | F1 | F2 | F3 | F4 | F5 | F11 | | F12 | F6 | F7 | F8 | F9 | F10 | |
357 * |--------+------+------+------+------+------+------| |------+------+------+------+------+------+--------|
358 * | | Q | W | E | R | T | | | | Y | U | I | O | P | |
359 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
360 * | | A | S | D | F | G |------| |------| H | J | K | L | | |
361 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
362 * | | Z | X | C | V | B | | | | N | M | | | | |
363 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
364 * | | | | | | | | | | | |
365 * `----------------------------------' `----------------------------------'
366 * ,-------------. ,-------------.
368 * ,------+------+------| |------+------+------.
370 * | | |------| |------| | |
372 * `--------------------' `--------------------'
376 [WORD] = LAYOUT_ergodox(
378 KC_TRNS, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F11,
379 KC_TRNS, M_WORD_Q, M_WORD_W, M_WORD_E, M_WORD_R, M_WORD_T, KC_TRNS,
380 KC_TRNS, M_WORD_A, M_WORD_S, M_WORD_D, M_WORD_F, M_WORD_G,
381 KC_TRNS, M_WORD_Z, M_WORD_X, M_WORD_C, M_WORD_V, M_WORD_B, KC_TRNS,
382 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
385 KC_TRNS, KC_TRNS, KC_TRNS,
387 KC_F12, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_TRNS,
388 KC_TRNS, M_WORD_Y, M_WORD_U, M_WORD_I, M_WORD_O, M_WORD_P, KC_TRNS,
389 M_WORD_H, M_WORD_J, M_WORD_K, M_WORD_L, KC_TRNS, KC_TRNS,
390 KC_TRNS, M_WORD_N, M_WORD_M, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
391 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
394 KC_TRNS, KC_TRNS, KC_TRNS
398 const uint16_t PROGMEM fn_actions[] = {
399 [1] = ACTION_LAYER_TAP_TOGGLE(SYMB), /* FN1 - Momentary Layer 1 (Symbols) */
400 [2] = ACTION_LAYER_TAP_TOGGLE(MDIA), /* FN2 - Momentary Layer 2 (Media) */
401 [3] = ACTION_LAYER_TAP_TOGGLE(WORD), /* FN3 - Momentary Layer 3 (Words) */
405 #define WITHOUT_MODS(...) \
407 uint8_t _real_mods = get_mods(); \
410 set_mods(_real_mods); \
413 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
414 #ifdef CFQ_USE_DYNAMIC_MACRO
415 if (!process_record_dynamic_macro(keycode, record)) {
420 /* dynamically generate these. */
422 if (record->event.pressed) {
423 #ifdef RGBLIGHT_ENABLE
429 case M_BRACKET_IN_CBR: /* {} */
430 if (record->event.pressed) {
431 SEND_STRING("{}" SS_TAP(X_LEFT));
435 case M_BRACKET_IN_PRN: /* () */
436 if (record->event.pressed) {
437 SEND_STRING("()" SS_TAP(X_LEFT));
441 case M_BRACKET_IN_BRC: /* [] */
442 if (record->event.pressed) {
443 SEND_STRING("[]" SS_TAP(X_LEFT));
447 case M_BRACKET_IN_ANG: /* <> */
448 if (record->event.pressed) {
449 SEND_STRING("<>" SS_TAP(X_LEFT));
453 case M_BRACKET_OUT_CBR: /* }{ */
454 if (record->event.pressed) {
455 SEND_STRING("}{" SS_TAP(X_LEFT));
459 case M_BRACKET_OUT_PRN: /* )( */
460 if (record->event.pressed) {
461 SEND_STRING(")(" SS_TAP(X_LEFT));
465 case M_BRACKET_OUT_BRC: /* ][ */
466 if (record->event.pressed) {
467 SEND_STRING("][" SS_TAP(X_LEFT));
471 case M_BRACKET_OUT_ANG: /* >< */
472 if (record->event.pressed) {
473 SEND_STRING("><" SS_TAP(X_LEFT));
477 case M_ARROW_LMINUS: /* <- */
478 if (record->event.pressed) {
483 case M_ARROW_RMINUS: /* -> */
484 if (record->event.pressed) {
489 case M_ARROW_LEQL: /* <= */
490 if (record->event.pressed) {
495 case M_ARROW_REQL: /* => */
496 if (record->event.pressed) {
501 #ifdef CFQ_USE_SHIFT_QUOTES
502 case KC_LSHIFT: /* '' */
503 if (record->event.pressed && (keyboard_report->mods & (MOD_BIT(KC_RSFT)))) {
505 SEND_STRING("''" SS_TAP(X_LEFT) SS_DOWN(X_RSHIFT) SS_DOWN(X_LSHIFT));
510 case KC_RSHIFT: /* "" */
511 if (record->event.pressed && (keyboard_report->mods & (MOD_BIT(KC_LSFT)))) {
513 SEND_STRING("\x22\x22" SS_TAP(X_LEFT) SS_DOWN(X_LSHIFT) SS_DOWN(X_RSHIFT));
518 #endif /* CFQ_USE_SHIFT_QUOTES */
519 case M_WORD_A...M_WORD_Z:
521 uint8_t shift_index = (keyboard_report->mods & (MOD_BIT(KC_RSFT) | MOD_BIT(KC_LSFT))) ? 1 : 0;
522 const char *word = cfq_word_lut[shift_index][keycode - M_WORD_A];
523 if (record->event.pressed) {
538 /* Runs just one time when the keyboard initializes. */
539 void matrix_init_user(void) {
541 /* Duplicate 'cfq_word_lut[0][...]' into 'cfq_word_lut[1][...]' */
543 char *d = cfq_word_lut_title_caps;
544 for (uint16_t i = 0; i < 26; i++) {
545 char *s = cfq_word_lut[0][i];
546 cfq_word_lut[1][i] = d;
547 while ((*d++ = *s++)) {}
551 for (uint16_t i = 0; i < 26; i++) {
552 char *w = cfq_word_lut[1][i];
553 bool prev_is_alpha = false;
556 bool is_lower = (*w >= 'a' && *w <= 'z');
557 bool is_upper = (*w >= 'A' && *w <= 'Z');
558 if (prev_is_alpha == false && is_lower) {
561 prev_is_alpha = is_lower || is_upper;
568 /* Runs constantly in the background, in a loop. */
569 void matrix_scan_user(void) {
571 uint8_t layer = biton32(layer_state);
573 ergodox_board_led_off();
574 ergodox_right_led_1_off();
575 ergodox_right_led_2_off();
576 ergodox_right_led_3_off();
579 ergodox_right_led_1_on();
582 ergodox_right_led_2_on();
585 ergodox_right_led_3_on();