Skip to content

Commit

Permalink
BR Layout
Browse files Browse the repository at this point in the history
  • Loading branch information
Michell Eduardo do Amaral Rosa committed May 17, 2024
1 parent a17c506 commit 6998da7
Show file tree
Hide file tree
Showing 7 changed files with 256 additions and 22 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "lib/getreuer"]
path = lib/getreuer
url = https://github.com/michellrosa/qmk-keymap.git
36 changes: 35 additions & 1 deletion keyboards/xiudi/xd60/rev3/keymaps/michellrosa/custom_keycodes.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,46 @@

// clang-format off

// Shift on Hold, Enter on Tap
#define FK_SENT SC_SENT // SFT_T(KC_ENT)

#define FKBR_QUOT KC_QUOT // '"
#define FKBR_LBRC KC_LBRC // [{
#define FKBR_RBRC KC_RBRC // ]}
#define FKBR_BSLS KC_BSLS // \|
#define FKBR_SCLN KC_SLSH // ;:

// #define FKBR_6 KC_6 // 6¨
#define FKBR_ACUT ALGR(KC_QUOT) // ´`
#define FKBR_CCED ALGR(KC_COMM) // çÇ
#define FKBR_TILD LSFT(KC_GRV) // ~^
// Shifted versions:
#define FKBR_6_S SAGR(KC_QUOT) // 6¨ // TODO only when BR layer is active.
#define FKBR_ACUT_S KC_GRV // ´`
#define FKBR_CCED_S SAGR(KC_COMM) // çÇ
#define FKBR_TILD_S LSFT(KC_6) // ~^

// RALT(kc) ROPT(kc), ALGR(kc) Hold Right Alt (AltGr) and press kc
// RSA(kc) SAGR(kc) Hold Right Shift and Right Alt (AltGr) and press kc

#include "features/custom_shift_keys.h"

// const custom_shift_key_t fk_custom_shift_keys[] = {
// {FKBR_6, FKBR_6_S}, // Shift 6 is ¨ (FKBR_6)
// {FKBR_ACUT, FKBR_ACUT_S}, // Shift ´ is ` (FKBR_ACUT)
// //{FKBR_CCED, FKBR_CCED_S}, // Shift ç is Ç (FKBR_CCED)
// {FKBR_TILD, FKBR_TILD_S}, // Shift ~ is ^ (FKBR_TILD)
// };
// uint8_t NUM_CUSTOM_SHIFT_KEYS = sizeof(fk_custom_shift_keys) / sizeof(custom_shift_key_t);

/// Custom keycodes
enum userspace_custom_keycodes {
enum custom_keycodes {
CUSTOM_KEYCODE_START = SAFE_RANGE,

#include "custom_mouse_keycodes"

FKBR_6,

CUSTOM_KEYCODE_END
};

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
// Copyright 2021-2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
* @file custom_shift_keys.c
* @brief Custom Shift Keys implementation
*
* For full documentation, see
* <https://getreuer.info/posts/keyboards/custom-shift-keys>
*/

#include "custom_shift_keys.h"

#if !defined(IS_QK_MOD_TAP)
// Attempt to detect out-of-date QMK installation, which would fail with
// implicit-function-declaration errors in the code below.
#error "custom_shift_keys: QMK version is too old to build. Please update QMK."
#else

bool process_custom_shift_keys(uint16_t keycode, keyrecord_t *record) {
static uint16_t registered_keycode = KC_NO;

// If a custom shift key is registered, then this event is either releasing
// it or manipulating another key at the same time. Either way, we release
// the currently registered key.
if (registered_keycode != KC_NO) {
unregister_code16(registered_keycode);
registered_keycode = KC_NO;
}

if (record->event.pressed) { // Press event.
const uint8_t saved_mods = get_mods();
#ifndef NO_ACTION_ONESHOT
const uint8_t mods = saved_mods | get_weak_mods() | get_oneshot_mods();
#else
const uint8_t mods = saved_mods | get_weak_mods();
#endif // NO_ACTION_ONESHOT
if ((mods & MOD_MASK_SHIFT) != 0 // Shift is held.
#if CUSTOM_SHIFT_KEYS_NEGMODS != 0
// Nothing in CUSTOM_SHIFT_KEYS_NEGMODS is held.
&& (mods & (CUSTOM_SHIFT_KEYS_NEGMODS)) == 0
#endif // CUSTOM_SHIFT_KEYS_NEGMODS != 0
) {
// Continue default handling if this is a tap-hold key being held.
if ((IS_QK_MOD_TAP(keycode) || IS_QK_LAYER_TAP(keycode)) &&
record->tap.count == 0) {
return true;
}

// Search for a custom shift key whose keycode is `keycode`.
for (int i = 0; i < NUM_CUSTOM_SHIFT_KEYS; ++i) {
if (keycode == custom_shift_keys[i].keycode) {
registered_keycode = custom_shift_keys[i].shifted_keycode;
if (IS_QK_MODS(registered_keycode) && // Should keycode be shifted?
(QK_MODS_GET_MODS(registered_keycode) & MOD_LSFT) != 0) {
register_code16(registered_keycode); // If so, press it directly.
} else {
// Otherwise cancel shift mods, press the key, and restore mods.
del_weak_mods(MOD_MASK_SHIFT);
#ifndef NO_ACTION_ONESHOT
del_oneshot_mods(MOD_MASK_SHIFT);
#endif // NO_ACTION_ONESHOT
unregister_mods(MOD_MASK_SHIFT);
register_code16(registered_keycode);
set_mods(saved_mods);
}
return false;
}
}
}
}

return true; // Continue with default handling.
}

#endif // version check
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
// Copyright 2021-2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
* @file custom_shift_keys.h
* @brief Custom shift keys: customize what keycode is produced when shifted.
*
* Overview
* --------
*
* This library implements custom shift keys, keys where you can customize
* what keycode is produced when shifted.
*
* Step 1: In your keymap.c, define a table of custom shift keys like
*
* #include "features/custom_shift_keys.h"
*
* const custom_shift_key_t custom_shift_keys[] = {
* {KC_DOT , KC_QUES}, // Shift . is ?
* {KC_COMM, KC_EXLM}, // Shift , is !
* {KC_MINS, KC_EQL }, // Shift - is =
* {KC_COLN, KC_SCLN}, // Shift : is ;
* };
*
* Each row defines one key. The first field is the keycode as it appears in
* your layout and determines what is typed normally. The second entry is what
* you want the key to type when shifted.
*
* Step 2: Handle custom shift keys from your `process_record_user` function as
*
* bool process_record_user(uint16_t keycode, keyrecord_t* record) {
* if (!process_custom_shift_keys(keycode, record)) { return false; }
* // Your macros ...
*
* return true;
* }
*
* Step 3: add `features/custom_shift_keys.c` to your rules.mk as
*
* SRC += features/custom_shift_keys.c
*
*
* For full documentation, see
* <https://getreuer.info/posts/keyboards/custom-shift-keys>
*/

#pragma once

#include "quantum.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
* Custom shift key entry. The `keycode` field is the keycode as it appears in
* your layout and determines what is typed normally. The `shifted_keycode` is
* what you want the key to type when shifted.
*/
typedef struct {
uint16_t keycode;
uint16_t shifted_keycode;
} custom_shift_key_t;

/** Table of custom shift keys. */
extern const custom_shift_key_t custom_shift_keys[];
/** Number of entries in the `custom_shift_keys` table. */
extern uint8_t NUM_CUSTOM_SHIFT_KEYS;

/**
* Handler function for custom shift keys.
*
* In keymap.c, call this function from your `process_record_user` function as
*
* #include "features/custom_shift_keys.h"
*
* bool process_record_user(uint16_t keycode, keyrecord_t* record) {
* if (!process_custom_shift_keys(keycode, record)) { return false; }
* // Your macros ...
*
* return true;
* }
*/
bool process_custom_shift_keys(uint16_t keycode, keyrecord_t *record);

#ifdef __cplusplus
}
#endif
51 changes: 30 additions & 21 deletions keyboards/xiudi/xd60/rev3/keymaps/michellrosa/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,7 @@
#include "custom_mouse_keymap.h"
#include "faker_layout.h"
#include "mouse_manipulation.h"
#include "keymap_brazilian_abnt2.h"

// Shift on Hold, Enter on Tap
#define FK_SENT SC_SENT // SFT_T(KC_ENT)
// #include "keymap_brazilian_abnt2.h"

enum keyboard_layers {
_USL = 0, // Base Layer Ansii
Expand All @@ -18,39 +15,37 @@ enum keyboard_layers {

#define _BL _USL

#define FK_BR_QUOT _______ // TODO '"
#define FK_BR_6 _______ // TODO 6¨
#define FK_BR_ACUT _______ // TODO ´`
#define FK_BR_LBRC KC_RBRC // [{
#define FK_BR_RBRC KC_BSLS // ]}
#define FK_BR_CCED _______ // TODO çÇ
#define FK_BR_TILD _______ // TODO ~^
#define FK_BR_BSLS KC_BSLS // \|
#define FK_BR_SCLN KC_SLSH // ;:
const custom_shift_key_t custom_shift_keys[] = {
{FKBR_6, FKBR_6_S}, // Shift 6 is ¨
{FKBR_ACUT, FKBR_ACUT_S}, // Shift ´ is `
//{FKBR_CCED, FKBR_CCED_S}, // Shift ç is Ç
{FKBR_TILD, FKBR_TILD_S}, // Shift ~ is ^
};
uint8_t NUM_CUSTOM_SHIFT_KEYS = sizeof(custom_shift_keys) / sizeof(custom_shift_key_t);

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
#if 0
[_USL] = LAYOUT_faker(
KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_DEL, KC_BSPC,
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS,
CW_TOGG, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, KC_ENT,
KC_LSFT, FK_SENT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_INS,
KC_LSFT, SC_SENT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_INS,
KC_LCTL, KC_LGUI, KC_LALT, LT(_FL, KC_SPC), LT(_FL, KC_SPC), KC_RALT, KC_APP, KC_RCTL, KC_RGUI
),
#else
[_USL] = LAYOUT_60_ansi_split_bs_rshift_space(
KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_DEL, KC_BSPC,
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS,
CW_TOGG, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, KC_ENT,
KC_LSFT, FK_SENT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, XXXXXXX, KC_RSFT, KC_INS,
KC_LSFT, SC_SENT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, XXXXXXX, KC_RSFT, KC_INS,
KC_LCTL, KC_LGUI, KC_LALT, LT(_FL, KC_SPC), LT(_FL, KC_SPC), XXXXXXX, KC_RALT, KC_APP, XXXXXXX, KC_RCTL, KC_RGUI
),
#endif
[_BRL] = LAYOUT_60_ansi_split_bs_rshift_space(
KC_ESC, _______, _______, _______, _______, _______, BR_6, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, BR_ACUT, BR_LBRC, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, BR_CCED, BR_TILD, BR_RBRC, _______,
_______, FK_SENT, _______, _______, _______, _______, _______, _______, _______, _______, _______, BR_SCLN, _______, _______, _______,
FKBR_QUOT, _______, _______, _______, _______, _______, FKBR_6, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, FKBR_ACUT, FKBR_LBRC, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, FKBR_CCED, FKBR_TILD, FKBR_RBRC, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, FKBR_SCLN, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
),
[_FL] = LAYOUT_faker(
Expand All @@ -74,16 +69,30 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

void keyboard_post_init_user(void) {
rgblight_disable_noeeprom();
// Customise these values to desired behaviour
#ifdef CONSOLE_ENABLE
debug_enable=true;
//debug_matrix=true;
//debug_keyboard=true;
//debug_mouse=true;
#endif
}

bool process_record_user(uint16_t keycode, keyrecord_t *record) {
if (layer_state_is(_ML)) { // Restrict processing for layer 2 active.
if (layer_state_is(_ML)) { // Restrict processing for layer _ML active.
return process_record_user_mouse_manipulation(keycode, record);
}
if (!process_custom_shift_keys(keycode, record)) { return false; }

switch (keycode) {
case FKBR_6:
if (record->event.pressed) {
register_code(KC_6);
} else {
unregister_code(KC_6);
}
// return false;
break;
}

return true; // Process keycodes normally
}
1 change: 1 addition & 0 deletions keyboards/xiudi/xd60/rev3/keymaps/michellrosa/rules.mk
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ MOUSEKEY_ENABLE = no
BACKLIGHT_ENABLE = no

SRC += mouse_manipulation.c
SRC += features/custom_shift_keys.c

CONSOLE_ENABLE = yes

Expand Down
1 change: 1 addition & 0 deletions lib/getreuer
Submodule getreuer added at 534e9e

0 comments on commit 6998da7

Please sign in to comment.