qmk_keymaps/keyboards/crkbd/keymaps/sajenim/keymap.c

375 lines
15 KiB
C
Raw Normal View History

2023-01-16 23:02:14 +08:00
/* Copyright 2022 @ sajenim (https://github.com/sajenim)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
2023-01-06 02:03:52 +08:00
2023-01-16 23:02:14 +08:00
#include QMK_KEYBOARD_H
2024-03-14 23:25:39 +08:00
// Combo dictionary management
2023-02-19 17:51:22 +08:00
#include "g/keymap_combo.h"
2023-02-03 22:03:06 +08:00
2024-03-14 23:25:39 +08:00
// Awesome features created by getreuer
#include "features/sentence_case.h"
#include "features/achordion.h"
#include "features/select_word.h"
// https://github.com/getreuer/qmk-keymap/tree/main/features
// Our super useful layers, why we run qmk exclusively.
enum layers {
CANARY, // This layout is the result of collaboration between many of the top layout creators from the AKL community.
NAV, // Inspired by the colemak communities extend layer, Brings navigation and editing to the home position.
NUM, // Contains our numpad and function keys.
SYM, // Contains our symbols.
MOD, // Contains keyboard related modifications (and FKEYs :eyeroll:).
};
// Our custom keycodes
enum custom_keycodes {
SC_TOGG = SAFE_RANGE,
SELWORD,
};
2024-03-19 17:59:07 +08:00
// This keymap uses Magic Canary, it is inspired by Ikcelaks' Magic Sturdy layout.
// The magic key is triggered with the fn combo. Currently only SFB are considered.
// https://github.com/Ikcelaks/keyboard_layouts
2024-03-14 23:25:39 +08:00
// This keymap uses home row mods. In addition to mods, I have home row
// layer-tap keys for the SYM layer. The key arrangement is a variation on
2024-03-19 17:56:53 +08:00
// "GASC-order" home row mods:
2024-03-14 23:25:39 +08:00
//
// Left hand Right hand
// +-------+-------+-------+-------+ +-------+-------+-------+-------+
2024-03-19 17:56:53 +08:00
// | Gui | Alt | Shift | Ctrl | | Ctrl | Shift | Alt | Gui |
2024-03-14 23:25:39 +08:00
// +-------+-------+-------+-------+ +-------+-------+-------+-------+
2024-03-19 17:56:53 +08:00
// | Sym | | Sym |
// +-------+ +-------+
2024-03-14 23:25:39 +08:00
// Left hand home row mods for CANARY layer.
2024-03-19 17:56:53 +08:00
#define HRM_C LGUI_T(KC_C)
2024-03-14 23:25:39 +08:00
#define HRM_R LALT_T(KC_R)
2024-03-19 17:56:53 +08:00
#define HRM_S LSFT_T(KC_S)
#define HRM_T LCTL_T(KC_T)
2024-03-14 23:25:39 +08:00
// Right hand home row mods for CANARY layer.
2024-03-19 17:56:53 +08:00
#define HRM_N RCTL_T(KC_N)
#define HRM_E RSFT_T(KC_E)
2024-03-14 23:25:39 +08:00
#define HRM_I RALT_T(KC_I)
2024-03-19 17:56:53 +08:00
#define HRM_A RGUI_T(KC_A)
2024-03-14 23:25:39 +08:00
// Bottom row home row mods for CANARY layer.
2024-03-19 17:56:53 +08:00
#define HRM_D LT(SYM, KC_D)
#define HRM_H LT(SYM, KC_H)
2024-03-14 23:25:39 +08:00
// Oneshot mods are available on our navigation and numbers layer.
// This allows easy chords with typical window manager and terminal
// bindings. Oneshot mods persist through layer changes.
// Left hand one shot keys.
#define OS_LCTL OSM(MOD_LCTL)
#define OS_LSFT OSM(MOD_LSFT)
#define OS_LALT OSM(MOD_LALT)
#define OS_LGUI OSM(MOD_LGUI)
// Right hand one shot keys.
#define OS_RCTL OSM(MOD_RCTL)
#define OS_RSFT OSM(MOD_RSFT)
#define OS_RALT OSM(MOD_RALT)
#define OS_RGUI OSM(MOD_RGUI)
2023-02-03 22:03:06 +08:00
2024-03-14 23:25:39 +08:00
// Dual role thumb keys allow us to save space on our keymap
// by having different functions in each the tap and hold slots.
2024-03-19 17:56:53 +08:00
// Excluded from bilateral combinations.
2024-03-14 23:25:39 +08:00
#define SPC_NAV LT(NAV, KC_SPC)
#define ENT_NUM LT(NUM, KC_ENT)
// Shortcuts
#define CK_UNDO LCTL(KC_Z) // Undo
#define CK_CUT LCTL(KC_X) // Cut
#define CK_COPY LCTL(KC_C) // Copy
#define CK_PSTE LCTL(KC_V) // Paste
#define WZ_CMOD LCTL(LSFT(KC_X)) // Wezterm activate copy mode.
#define WZ_PSTE LCTL(LSFT(KC_V)) // Wezterm paste from clipboard.
//Keymaps
2023-01-06 02:03:52 +08:00
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
2024-03-14 23:25:39 +08:00
[CANARY] = LAYOUT_split_3x6_3(
2023-01-16 23:02:14 +08:00
//,-----------------------------------------------------. ,-----------------------------------------------------.
2024-03-14 23:25:39 +08:00
KC_ESC, KC_W, KC_L, KC_Y, KC_P, KC_B, KC_Z, KC_F, KC_O, KC_U, KC_QUOT, KC_BSPC,
2023-01-16 23:02:14 +08:00
//|--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
2024-03-14 23:25:39 +08:00
KC_TAB, HRM_C, HRM_R, HRM_S, HRM_T, KC_G, KC_M, HRM_N, HRM_E, HRM_I, HRM_A, KC_SCLN,
2023-01-16 23:02:14 +08:00
//|--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
2024-03-19 17:56:53 +08:00
OS_LSFT, KC_Q, KC_J, KC_V, HRM_D, KC_K, KC_X, HRM_H, KC_SLSH, KC_COMM, KC_DOT, OS_RSFT,
2023-01-16 23:02:14 +08:00
//|--------+--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------+--------|
2024-03-19 17:56:53 +08:00
OS_LGUI, KC_BSPC, SPC_NAV, ENT_NUM, QK_REP, OS_RALT
//`--------------------------' `--------------------------'
),
2024-03-14 23:25:39 +08:00
[NAV] = LAYOUT_split_3x6_3(
//,-----------------------------------------------------. ,-----------------------------------------------------.
2024-03-14 23:25:39 +08:00
XXXXXXX, XXXXXXX, KC_MPLY, KC_MPRV, KC_MNXT, KC_VOLU, KC_PGUP, KC_HOME, KC_UP, KC_END, KC_DEL, XXXXXXX,
//|--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
2024-03-19 17:56:53 +08:00
XXXXXXX, OS_LGUI, OS_LALT, OS_LSFT, OS_LCTL, KC_VOLD, KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, KC_BSPC, XXXXXXX,
//|--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
2024-03-14 23:25:39 +08:00
XXXXXXX, CK_UNDO, CK_CUT, CK_COPY, CK_PSTE, XXXXXXX, XXXXXXX, WZ_CMOD, WZ_PSTE, XXXXXXX, KC_ENT, XXXXXXX,
//|--------+--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------+--------|
2024-03-14 23:25:39 +08:00
XXXXXXX, XXXXXXX, _______, _______, _______, XXXXXXX
2024-02-05 11:07:53 +08:00
//`--------------------------' `--------------------------'
),
2024-02-05 11:06:30 +08:00
2024-03-14 23:25:39 +08:00
[NUM] = LAYOUT_split_3x6_3(
2023-01-16 23:02:14 +08:00
//,-----------------------------------------------------. ,-----------------------------------------------------.
2024-03-14 23:25:39 +08:00
XXXXXXX, KC_DEL, KC_7, KC_8, KC_9, XXXXXXX, XXXXXXX, KC_PLUS, XXXXXXX, KC_MINS, XXXXXXX, XXXXXXX,
2023-01-16 23:02:14 +08:00
//|--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
2024-03-19 17:56:53 +08:00
XXXXXXX, KC_BSPC, KC_4, KC_5, KC_6, XXXXXXX, XXXXXXX, OS_RCTL, OS_RSFT, OS_RALT, OS_RGUI, XXXXXXX,
2023-01-16 23:02:14 +08:00
//|--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
2024-03-20 08:44:17 +08:00
XXXXXXX, KC_ENT, KC_1, KC_2, KC_3, XXXXXXX, XXXXXXX, KC_ASTR, XXXXXXX, KC_SLSH, KC_DOT, XXXXXXX,
2023-01-16 23:02:14 +08:00
//|--------+--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------+--------|
2024-03-14 23:25:39 +08:00
XXXXXXX, _______, KC_0, _______, XXXXXXX, XXXXXXX
2023-01-16 23:02:14 +08:00
//`--------------------------' `--------------------------'
),
2024-03-14 23:25:39 +08:00
[SYM] = LAYOUT_split_3x6_3(
2023-01-16 23:02:14 +08:00
//,-----------------------------------------------------. ,-----------------------------------------------------.
2024-02-05 11:06:59 +08:00
KC_GRV, XXXXXXX, KC_LABK, KC_DLR, KC_RABK, XXXXXXX, XXXXXXX, KC_LBRC, KC_UNDS, KC_RBRC, XXXXXXX, _______,
2023-01-16 23:02:14 +08:00
//|--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
2023-03-30 12:41:27 +08:00
KC_MINS, KC_BSLS, KC_LPRN, KC_DQUO, KC_RPRN, KC_HASH, KC_PERC, KC_LCBR, KC_EQL, KC_RCBR, KC_PIPE, KC_SCLN,
2023-01-16 23:02:14 +08:00
//|--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
2024-02-08 22:49:01 +08:00
XXXXXXX, XXXXXXX, KC_COLN, KC_ASTR, KC_PLUS, XXXXXXX, XXXXXXX, KC_AMPR, KC_CIRC, KC_TILD, _______, XXXXXXX,
2023-01-16 23:02:14 +08:00
//|--------+--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------+--------|
2024-03-14 23:25:39 +08:00
XXXXXXX, _______, XXXXXXX, XXXXXXX, _______, XXXXXXX
2023-01-16 23:02:14 +08:00
//`--------------------------' `--------------------------'
),
2023-01-06 02:03:52 +08:00
2024-03-14 23:25:39 +08:00
[MOD] = LAYOUT_split_3x6_3(
2023-01-16 23:02:14 +08:00
//,-----------------------------------------------------. ,-----------------------------------------------------.
2024-02-05 11:07:53 +08:00
KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,
2023-01-16 23:02:14 +08:00
//|--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
2024-03-14 23:25:39 +08:00
QK_BOOT, RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI, XXXXXXX, XXXXXXX, CM_TOGG, AS_TOGG, XXXXXXX, XXXXXXX, KC_SLEP,
2023-01-16 23:02:14 +08:00
//|--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------|
2024-03-14 23:25:39 +08:00
QK_MAKE, RGB_MOD, RGB_HUD, RGB_SAD, RGB_VAD, XXXXXXX, XXXXXXX, SC_TOGG, AC_TOGG, XXXXXXX, XXXXXXX, KC_WAKE,
2023-01-16 23:02:14 +08:00
//|--------+--------+--------+--------+--------+--------+--------| |--------+--------+--------+--------+--------+--------+--------|
2024-03-14 23:25:39 +08:00
XXXXXXX, XXXXXXX, _______, _______, XXXXXXX, XXXXXXX
2023-01-16 23:02:14 +08:00
//`--------------------------' `--------------------------'
),
};
2023-01-06 02:03:52 +08:00
2024-03-19 17:56:53 +08:00
// Bilateral combination exceptions
bool achordion_chord(uint16_t tap_hold_keycode, keyrecord_t* tap_hold_record, uint16_t other_keycode, keyrecord_t* other_record) {
switch (tap_hold_keycode) {
// Excempt layer taps on thumbs.
case SPC_NAV:
case ENT_NUM:
return true;
break;
}
// Otherwise follow opposite hands rule.
return achordion_opposite_hands(tap_hold_record, other_record);
2023-01-06 02:03:52 +08:00
}
2024-03-19 17:59:07 +08:00
bool remember_last_key_user(uint16_t keycode, keyrecord_t* record, uint8_t* remembered_mods) {
// Forget Shift on letter keys when Shift or AltGr are the only mods.
switch (keycode) {
case KC_A ... KC_Z:
if ((*remembered_mods & ~(MOD_MASK_SHIFT | MOD_BIT(KC_RALT))) == 0) {
*remembered_mods &= ~MOD_MASK_SHIFT;
}
break;
}
return true;
}
uint16_t get_alt_repeat_key_keycode_user(uint16_t keycode, uint8_t mods) {
switch (keycode) {
// Minimize SFB on canary layout
case HRM_R: return KC_L;
case KC_V: return KC_Y;
case HRM_S: return KC_Y;
case KC_Y: return KC_S;
case KC_P: return KC_T;
case HRM_I: return KC_U;
case KC_U: return KC_I;
case KC_O: return KC_E;
case HRM_E: return KC_O;
// vim optimisations
2024-03-20 08:44:25 +08:00
case KC_W: return KC_Q; // write quit
case HRM_C: return KC_W; // change word
case HRM_D: return KC_W; // delete word
2024-03-19 17:59:07 +08:00
}
return KC_TRNS;
}
2024-03-14 23:25:39 +08:00
bool process_record_user(uint16_t keycode, keyrecord_t* record) {
if (!process_sentence_case(keycode, record)) { return false; }
if (!process_achordion(keycode, record)) { return false; }
if (!process_select_word(keycode, record, SELWORD)) { return false; }
2024-03-19 17:59:07 +08:00
2024-03-14 23:25:39 +08:00
if (record->event.pressed) {
2024-03-19 17:59:07 +08:00
int rep_count = get_repeat_key_count();
// Define the behaviour of our custom keycodes.
2024-03-14 23:25:39 +08:00
switch (keycode) {
case SC_TOGG: // Toggle sentence case on/off.
sentence_case_toggle();
return false;
2024-03-19 17:59:07 +08:00
}
if (rep_count > 0) {
// Repeat key overrides.
switch (keycode) {
// Minimize SFB on canary layout
case HRM_N: SEND_STRING(/*n*/"f"); return false;
}
2024-03-14 23:25:39 +08:00
}
}
return true;
}
2024-02-05 11:08:00 +08:00
2024-03-14 23:25:39 +08:00
void matrix_scan_user(void) {
achordion_task();
}
2024-03-19 17:59:27 +08:00
// Layer change
layer_state_t layer_state_set_user(layer_state_t state) {
// Activate MOD layer
state = update_tri_layer_state(state, NAV, NUM, MOD);
return state;
}
2024-03-14 23:25:39 +08:00
#ifdef OLED_ENABLE
// Declare screen rotation for each half
oled_rotation_t oled_init_user(oled_rotation_t rotation) {
if (is_keyboard_master()) {
return OLED_ROTATION_270;
} else {
return OLED_ROTATION_180;
}
return rotation;
}
// Setup the master screen
void oled_render_master(void) {
// Layer Status
switch (get_highest_layer(layer_state)) {
case CANARY:
oled_write(" BAS ", false);
break;
case NAV:
oled_write(" NAV ", false);
break;
case NUM:
oled_write(" NUM ", false);
break;
case SYM:
oled_write(" SYM ", false);
break;
case MOD:
oled_write(" MOD ", false);
break;
default:
oled_write(" UND ", false);
}
// Mod Status
uint8_t this_mod = get_mods();
uint8_t this_osm = get_oneshot_mods();
oled_write("-----", false);
if ((this_mod | this_osm) & MOD_MASK_GUI) {
oled_write("gui:*", false);
} else {
oled_write("gui:.", false);
}
if ((this_mod | this_osm) & MOD_MASK_ALT) {
oled_write("alt:*", false);
} else {
oled_write("alt:.", false);
}
if ((this_mod | this_osm) & MOD_MASK_SHIFT) {
oled_write("sft:*", false);
} else {
oled_write("sft:.", false);
}
if ((this_mod | this_osm) & MOD_MASK_CTRL) {
oled_write("ctl:*", false);
} else {
oled_write("ctl:.", false);
}
// Feature Status
oled_write("-----", false);
bool autoshift_enabled = get_autoshift_state();
if (autoshift_enabled) {
oled_write("as: *", false);
} else {
oled_write("as: .", false);
}
bool autocorrect_enabled = autocorrect_is_enabled();
if (autocorrect_enabled) {
oled_write("ac: *", false);
} else {
oled_write("ac: .", false);
}
bool combo_enabled = is_combo_enabled();
if (combo_enabled) {
oled_write("cm: *", false);
} else {
oled_write("cm: .", false);
}
bool sentence_case_enabled = is_sentence_case_on();
if (sentence_case_enabled) {
oled_write("sc: *", false);
} else {
oled_write("sc: .", false);
}
// WPM Status
char wpm_str[4];
sprintf(wpm_str, "%03d", get_current_wpm());
oled_set_cursor(1, 14);
oled_write_ln(wpm_str, false);
oled_write(" wpm", false);
}
// Corne keyboard logo
void oled_render_logo(void) {
static const char PROGMEM crkbd_logo[] = {
0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f, 0x90, 0x91, 0x92, 0x93, 0x94,
0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa7, 0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad, 0xae, 0xaf, 0xb0, 0xb1, 0xb2, 0xb3, 0xb4,
0xc0, 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7, 0xc8, 0xc9, 0xca, 0xcb, 0xcc, 0xcd, 0xce, 0xcf, 0xd0, 0xd1, 0xd2, 0xd3, 0xd4,
0};
oled_write_P(crkbd_logo, false);
}
2023-02-03 22:03:06 +08:00
2024-03-14 23:25:39 +08:00
// Render our screens
bool oled_task_user(void) {
if (is_keyboard_master()) {
oled_render_master();
} else {
oled_render_logo();
}
return false;
2023-02-03 22:03:06 +08:00
}
2024-03-14 23:25:39 +08:00
#endif
2023-08-15 07:39:18 +08:00
2024-03-14 23:25:39 +08:00
/* vim: set foldmarker=#ifdef,#endif: */
/* vim: set foldmethod=marker: */