2017-03-29 06:20:36 +08:00
|
|
|
/* Copyright 2016-2017 Jack Humbert
|
|
|
|
|
*
|
|
|
|
|
* 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/>.
|
|
|
|
|
*/
|
|
|
|
|
|
2016-05-15 12:27:32 +08:00
|
|
|
#include "quantum.h"
|
2019-01-10 11:04:01 +08:00
|
|
|
|
2017-02-01 23:30:06 +08:00
|
|
|
#ifdef PROTOCOL_LUFA
|
2019-08-31 02:19:03 +08:00
|
|
|
# include "outputselect.h"
|
2017-02-01 20:37:52 +08:00
|
|
|
#endif
|
2016-05-15 12:27:32 +08:00
|
|
|
|
2019-10-18 00:48:58 +08:00
|
|
|
#ifdef BACKLIGHT_ENABLE
|
|
|
|
|
# include "backlight.h"
|
2019-11-05 14:59:13 +08:00
|
|
|
extern backlight_config_t backlight_config;
|
2019-10-18 00:48:58 +08:00
|
|
|
#endif
|
2017-02-19 13:11:55 +08:00
|
|
|
|
2017-02-13 15:55:35 +08:00
|
|
|
#ifdef FAUXCLICKY_ENABLE
|
2019-08-31 02:19:03 +08:00
|
|
|
# include "fauxclicky.h"
|
2017-02-13 15:55:35 +08:00
|
|
|
#endif
|
2017-02-13 00:29:42 +08:00
|
|
|
|
2018-02-09 04:07:46 +08:00
|
|
|
#ifdef API_ENABLE
|
2019-08-31 02:19:03 +08:00
|
|
|
# include "api.h"
|
2018-02-09 04:07:46 +08:00
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#ifdef MIDI_ENABLE
|
2019-08-31 02:19:03 +08:00
|
|
|
# include "process_midi.h"
|
2018-02-09 04:07:46 +08:00
|
|
|
#endif
|
|
|
|
|
|
2019-02-21 23:22:46 +08:00
|
|
|
#ifdef VELOCIKEY_ENABLE
|
2019-08-31 02:19:03 +08:00
|
|
|
# include "velocikey.h"
|
2019-02-21 23:22:46 +08:00
|
|
|
#endif
|
|
|
|
|
|
2019-02-17 10:39:30 +08:00
|
|
|
#ifdef HAPTIC_ENABLE
|
2019-08-31 02:19:03 +08:00
|
|
|
# include "haptic.h"
|
2019-02-17 10:39:30 +08:00
|
|
|
#endif
|
2018-10-27 04:19:23 +08:00
|
|
|
|
|
|
|
|
#ifdef ENCODER_ENABLE
|
2019-08-31 02:19:03 +08:00
|
|
|
# include "encoder.h"
|
2018-10-27 04:19:23 +08:00
|
|
|
#endif
|
|
|
|
|
|
2017-07-21 11:57:11 +08:00
|
|
|
#ifdef AUDIO_ENABLE
|
2019-08-31 02:19:03 +08:00
|
|
|
# ifndef GOODBYE_SONG
|
|
|
|
|
# define GOODBYE_SONG SONG(GOODBYE_SOUND)
|
|
|
|
|
# endif
|
|
|
|
|
float goodbye_song[][2] = GOODBYE_SONG;
|
|
|
|
|
# ifdef DEFAULT_LAYER_SONGS
|
|
|
|
|
float default_layer_songs[][16][2] = DEFAULT_LAYER_SONGS;
|
|
|
|
|
# endif
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
static void do_code16(uint16_t code, void (*f)(uint8_t)) {
|
|
|
|
|
switch (code) {
|
|
|
|
|
case QK_MODS ... QK_MODS_MAX:
|
|
|
|
|
break;
|
|
|
|
|
default:
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
2019-10-16 07:02:09 +08:00
|
|
|
uint8_t mods_to_send = 0;
|
2019-08-31 02:19:03 +08:00
|
|
|
|
2019-11-05 14:59:13 +08:00
|
|
|
if (code & QK_RMODS_MIN) { // Right mod flag is set
|
2019-10-16 07:02:09 +08:00
|
|
|
if (code & QK_LCTL) mods_to_send |= MOD_BIT(KC_RCTL);
|
|
|
|
|
if (code & QK_LSFT) mods_to_send |= MOD_BIT(KC_RSFT);
|
|
|
|
|
if (code & QK_LALT) mods_to_send |= MOD_BIT(KC_RALT);
|
|
|
|
|
if (code & QK_LGUI) mods_to_send |= MOD_BIT(KC_RGUI);
|
|
|
|
|
} else {
|
|
|
|
|
if (code & QK_LCTL) mods_to_send |= MOD_BIT(KC_LCTL);
|
|
|
|
|
if (code & QK_LSFT) mods_to_send |= MOD_BIT(KC_LSFT);
|
|
|
|
|
if (code & QK_LALT) mods_to_send |= MOD_BIT(KC_LALT);
|
|
|
|
|
if (code & QK_LGUI) mods_to_send |= MOD_BIT(KC_LGUI);
|
|
|
|
|
}
|
2017-01-21 15:01:55 +08:00
|
|
|
|
2019-10-16 07:02:09 +08:00
|
|
|
f(mods_to_send);
|
2017-01-21 15:01:55 +08:00
|
|
|
}
|
|
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
void register_code16(uint16_t code) {
|
|
|
|
|
if (IS_MOD(code) || code == KC_NO) {
|
2019-10-16 07:02:09 +08:00
|
|
|
do_code16(code, register_mods);
|
2019-08-31 02:19:03 +08:00
|
|
|
} else {
|
2019-10-16 07:02:09 +08:00
|
|
|
do_code16(code, register_weak_mods);
|
2019-08-31 02:19:03 +08:00
|
|
|
}
|
|
|
|
|
register_code(code);
|
2016-08-18 17:29:53 +08:00
|
|
|
}
|
|
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
void unregister_code16(uint16_t code) {
|
|
|
|
|
unregister_code(code);
|
|
|
|
|
if (IS_MOD(code) || code == KC_NO) {
|
2019-10-16 07:02:09 +08:00
|
|
|
do_code16(code, unregister_mods);
|
2019-08-31 02:19:03 +08:00
|
|
|
} else {
|
2019-10-16 07:02:09 +08:00
|
|
|
do_code16(code, unregister_weak_mods);
|
2019-08-31 02:19:03 +08:00
|
|
|
}
|
2016-08-18 17:29:53 +08:00
|
|
|
}
|
|
|
|
|
|
2018-12-15 01:01:58 +08:00
|
|
|
void tap_code16(uint16_t code) {
|
2019-08-31 02:19:03 +08:00
|
|
|
register_code16(code);
|
|
|
|
|
#if TAP_CODE_DELAY > 0
|
2018-12-15 01:01:58 +08:00
|
|
|
wait_ms(TAP_CODE_DELAY);
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
|
|
|
|
unregister_code16(code);
|
2018-12-15 01:01:58 +08:00
|
|
|
}
|
|
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
__attribute__((weak)) bool process_action_kb(keyrecord_t *record) { return true; }
|
2016-05-15 12:27:32 +08:00
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
__attribute__((weak)) bool process_record_kb(uint16_t keycode, keyrecord_t *record) { return process_record_user(keycode, record); }
|
2016-05-29 03:22:30 +08:00
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
__attribute__((weak)) bool process_record_user(uint16_t keycode, keyrecord_t *record) { return true; }
|
2016-05-29 03:22:30 +08:00
|
|
|
|
2016-07-13 22:38:02 +08:00
|
|
|
void reset_keyboard(void) {
|
2019-08-31 02:19:03 +08:00
|
|
|
clear_keyboard();
|
2017-12-11 00:54:36 +08:00
|
|
|
#if defined(MIDI_ENABLE) && defined(MIDI_BASIC)
|
2019-08-31 02:19:03 +08:00
|
|
|
process_midi_all_notes_off();
|
2018-01-19 05:02:32 +08:00
|
|
|
#endif
|
2018-07-30 12:24:42 +08:00
|
|
|
#ifdef AUDIO_ENABLE
|
2019-08-31 02:19:03 +08:00
|
|
|
# ifndef NO_MUSIC_MODE
|
2018-07-30 12:24:42 +08:00
|
|
|
music_all_notes_off();
|
2019-08-31 02:19:03 +08:00
|
|
|
# endif
|
|
|
|
|
uint16_t timer_start = timer_read();
|
|
|
|
|
PLAY_SONG(goodbye_song);
|
|
|
|
|
shutdown_user();
|
|
|
|
|
while (timer_elapsed(timer_start) < 250) wait_ms(1);
|
|
|
|
|
stop_all_notes();
|
2017-07-21 11:57:11 +08:00
|
|
|
#else
|
2019-08-31 02:19:03 +08:00
|
|
|
shutdown_user();
|
|
|
|
|
wait_ms(250);
|
2017-07-21 11:57:11 +08:00
|
|
|
#endif
|
2019-02-17 10:39:30 +08:00
|
|
|
#ifdef HAPTIC_ENABLE
|
2019-08-31 02:19:03 +08:00
|
|
|
haptic_shutdown();
|
2019-02-17 10:39:30 +08:00
|
|
|
#endif
|
2017-11-28 12:08:21 +08:00
|
|
|
// this is also done later in bootloader.c - not sure if it's neccesary here
|
|
|
|
|
#ifdef BOOTLOADER_CATERINA
|
2019-08-31 02:19:03 +08:00
|
|
|
*(uint16_t *)0x0800 = 0x7777; // these two are a-star-specific
|
2016-07-13 22:38:02 +08:00
|
|
|
#endif
|
2019-08-31 02:19:03 +08:00
|
|
|
bootloader_jump();
|
2016-07-13 22:38:02 +08:00
|
|
|
}
|
|
|
|
|
|
2019-04-06 03:47:25 +08:00
|
|
|
/* Convert record into usable keycode via the contained event. */
|
2019-08-31 02:19:03 +08:00
|
|
|
uint16_t get_record_keycode(keyrecord_t *record) { return get_event_keycode(record->event); }
|
2019-04-06 03:47:25 +08:00
|
|
|
|
|
|
|
|
/* Convert event into usable keycode. Checks the layer cache to ensure that it
|
|
|
|
|
* retains the correct keycode after a layer change, if the key is still pressed.
|
|
|
|
|
*/
|
|
|
|
|
uint16_t get_event_keycode(keyevent_t event) {
|
2019-08-31 02:19:03 +08:00
|
|
|
#if !defined(NO_ACTION_LAYER) && !defined(STRICT_LAYER_RELEASE)
|
2016-08-18 07:34:05 +08:00
|
|
|
/* TODO: Use store_or_get_action() or a similar function. */
|
|
|
|
|
if (!disable_action_cache) {
|
2019-08-31 02:19:03 +08:00
|
|
|
uint8_t layer;
|
|
|
|
|
|
|
|
|
|
if (event.pressed) {
|
|
|
|
|
layer = layer_switch_get_layer(event.key);
|
|
|
|
|
update_source_layers_cache(event.key, layer);
|
|
|
|
|
} else {
|
|
|
|
|
layer = read_source_layers_cache(event.key);
|
|
|
|
|
}
|
|
|
|
|
return keymap_key_to_keycode(layer, event.key);
|
2016-08-18 07:34:05 +08:00
|
|
|
} else
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
|
|
|
|
return keymap_key_to_keycode(layer_switch_get_layer(event.key), event.key);
|
2019-04-06 03:47:25 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/* Main keycode processing function. Hands off handling to other functions,
|
|
|
|
|
* then processes internal Quantum keycodes, then processes ACTIONs.
|
|
|
|
|
*/
|
|
|
|
|
bool process_record_quantum(keyrecord_t *record) {
|
|
|
|
|
uint16_t keycode = get_record_keycode(record);
|
2016-05-15 12:27:32 +08:00
|
|
|
|
2016-05-15 12:47:25 +08:00
|
|
|
// This is how you use actions here
|
|
|
|
|
// if (keycode == KC_LEAD) {
|
|
|
|
|
// action_t action;
|
|
|
|
|
// action.code = ACTION_DEFAULT_LAYER_SET(0);
|
|
|
|
|
// process_action(record, action);
|
|
|
|
|
// return false;
|
|
|
|
|
// }
|
|
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
#ifdef VELOCIKEY_ENABLE
|
|
|
|
|
if (velocikey_enabled() && record->event.pressed) {
|
|
|
|
|
velocikey_accelerate();
|
|
|
|
|
}
|
|
|
|
|
#endif
|
2019-02-21 23:22:46 +08:00
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
#ifdef TAP_DANCE_ENABLE
|
2018-02-05 02:45:19 +08:00
|
|
|
preprocess_tap_dance(keycode, record);
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
2016-09-07 12:19:01 +08:00
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
if (!(
|
|
|
|
|
#if defined(KEY_LOCK_ENABLE)
|
|
|
|
|
// Must run first to be able to mask key_up events.
|
|
|
|
|
process_key_lock(&keycode, record) &&
|
|
|
|
|
#endif
|
2019-11-05 14:59:13 +08:00
|
|
|
#if defined(DYNAMIC_MACRO_ENABLE) && !defined(DYNAMIC_MACRO_USER_CALL)
|
|
|
|
|
// Must run asap to ensure all keypresses are recorded.
|
|
|
|
|
process_dynamic_macro(keycode, record) &&
|
|
|
|
|
#endif
|
2019-08-31 02:19:03 +08:00
|
|
|
#if defined(AUDIO_ENABLE) && defined(AUDIO_CLICKY)
|
|
|
|
|
process_clicky(keycode, record) &&
|
|
|
|
|
#endif // AUDIO_CLICKY
|
|
|
|
|
#ifdef HAPTIC_ENABLE
|
|
|
|
|
process_haptic(keycode, record) &&
|
|
|
|
|
#endif // HAPTIC_ENABLE
|
|
|
|
|
#if defined(RGB_MATRIX_ENABLE)
|
|
|
|
|
process_rgb_matrix(keycode, record) &&
|
|
|
|
|
#endif
|
|
|
|
|
process_record_kb(keycode, record) &&
|
|
|
|
|
#if defined(MIDI_ENABLE) && defined(MIDI_ADVANCED)
|
|
|
|
|
process_midi(keycode, record) &&
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef AUDIO_ENABLE
|
|
|
|
|
process_audio(keycode, record) &&
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef STENO_ENABLE
|
|
|
|
|
process_steno(keycode, record) &&
|
|
|
|
|
#endif
|
|
|
|
|
#if (defined(AUDIO_ENABLE) || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))) && !defined(NO_MUSIC_MODE)
|
|
|
|
|
process_music(keycode, record) &&
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef TAP_DANCE_ENABLE
|
|
|
|
|
process_tap_dance(keycode, record) &&
|
|
|
|
|
#endif
|
|
|
|
|
#if defined(UNICODE_ENABLE) || defined(UNICODEMAP_ENABLE) || defined(UCIS_ENABLE)
|
|
|
|
|
process_unicode_common(keycode, record) &&
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef LEADER_ENABLE
|
|
|
|
|
process_leader(keycode, record) &&
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef COMBO_ENABLE
|
|
|
|
|
process_combo(keycode, record) &&
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef PRINTING_ENABLE
|
|
|
|
|
process_printer(keycode, record) &&
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef AUTO_SHIFT_ENABLE
|
|
|
|
|
process_auto_shift(keycode, record) &&
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef TERMINAL_ENABLE
|
|
|
|
|
process_terminal(keycode, record) &&
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef SPACE_CADET_ENABLE
|
|
|
|
|
process_space_cadet(keycode, record) &&
|
2019-12-04 03:48:55 +08:00
|
|
|
#endif
|
|
|
|
|
#ifdef MAGIC_KEYCODE_ENABLE
|
|
|
|
|
process_magic(keycode, record) &&
|
2019-12-17 04:27:53 +08:00
|
|
|
#endif
|
|
|
|
|
#if defined(RGBLIGHT_ENABLE) || defined(RGB_MATRIX_ENABLE)
|
|
|
|
|
process_rgb(keycode, record) &&
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
|
|
|
|
true)) {
|
2016-06-19 02:30:24 +08:00
|
|
|
return false;
|
2019-08-31 02:19:03 +08:00
|
|
|
}
|
2017-12-14 13:20:44 +08:00
|
|
|
|
2019-11-28 06:00:23 +08:00
|
|
|
if (record->event.pressed) {
|
|
|
|
|
switch (keycode) {
|
|
|
|
|
case RESET:
|
2019-08-31 02:19:03 +08:00
|
|
|
reset_keyboard();
|
2019-11-28 06:00:23 +08:00
|
|
|
return false;
|
2019-11-29 05:59:59 +08:00
|
|
|
#ifndef NO_DEBUG
|
2019-11-28 06:00:23 +08:00
|
|
|
case DEBUG:
|
2019-08-31 02:19:03 +08:00
|
|
|
debug_enable ^= 1;
|
|
|
|
|
if (debug_enable) {
|
|
|
|
|
print("DEBUG: enabled.\n");
|
|
|
|
|
} else {
|
|
|
|
|
print("DEBUG: disabled.\n");
|
|
|
|
|
}
|
2019-11-29 05:59:59 +08:00
|
|
|
#endif
|
2019-11-28 06:00:23 +08:00
|
|
|
return false;
|
|
|
|
|
case EEPROM_RESET:
|
2019-08-31 02:19:03 +08:00
|
|
|
eeconfig_init();
|
2019-11-28 06:00:23 +08:00
|
|
|
return false;
|
2019-08-31 02:19:03 +08:00
|
|
|
#ifdef FAUXCLICKY_ENABLE
|
2019-11-28 06:00:23 +08:00
|
|
|
case FC_TOG:
|
2019-08-31 02:19:03 +08:00
|
|
|
FAUXCLICKY_TOGGLE;
|
2019-11-28 06:00:23 +08:00
|
|
|
return false;
|
|
|
|
|
case FC_ON:
|
2019-08-31 02:19:03 +08:00
|
|
|
FAUXCLICKY_ON;
|
2019-11-28 06:00:23 +08:00
|
|
|
return false;
|
|
|
|
|
case FC_OFF:
|
2019-08-31 02:19:03 +08:00
|
|
|
FAUXCLICKY_OFF;
|
2019-11-28 06:00:23 +08:00
|
|
|
return false;
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef VELOCIKEY_ENABLE
|
|
|
|
|
case VLK_TOG:
|
|
|
|
|
velocikey_toggle();
|
|
|
|
|
return false;
|
|
|
|
|
#endif
|
2019-11-29 05:59:59 +08:00
|
|
|
#ifdef BLUETOOTH_ENABLE
|
2019-12-17 04:27:53 +08:00
|
|
|
case OUT_AUTO:
|
2019-11-28 06:00:23 +08:00
|
|
|
set_output(OUTPUT_AUTO);
|
|
|
|
|
return false;
|
2019-12-17 04:27:53 +08:00
|
|
|
case OUT_USB:
|
2019-11-28 06:00:23 +08:00
|
|
|
set_output(OUTPUT_USB);
|
|
|
|
|
return false;
|
2019-12-17 04:27:53 +08:00
|
|
|
case OUT_BT:
|
2019-11-28 06:00:23 +08:00
|
|
|
set_output(OUTPUT_BLUETOOTH);
|
|
|
|
|
return false;
|
2019-12-06 16:27:04 +08:00
|
|
|
#endif
|
|
|
|
|
#if defined(BACKLIGHT_ENABLE) && defined(BACKLIGHT_BREATHING)
|
2019-12-17 04:27:53 +08:00
|
|
|
case BL_BRTG:
|
2019-12-06 16:27:04 +08:00
|
|
|
backlight_toggle_breathing();
|
|
|
|
|
return false;
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
2019-11-28 06:00:23 +08:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// keycodes that depend on both pressed and non-pressed state
|
|
|
|
|
switch (keycode) {
|
2019-08-31 02:19:03 +08:00
|
|
|
case GRAVE_ESC: {
|
2019-11-29 05:59:59 +08:00
|
|
|
/* true if the last press of GRAVE_ESC was shifted (i.e. GUI or SHIFT were pressed), false otherwise.
|
|
|
|
|
* Used to ensure that the correct keycode is released if the key is released.
|
|
|
|
|
*/
|
|
|
|
|
static bool grave_esc_was_shifted = false;
|
|
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
uint8_t shifted = get_mods() & ((MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT) | MOD_BIT(KC_LGUI) | MOD_BIT(KC_RGUI)));
|
2017-08-12 17:57:42 +08:00
|
|
|
|
2017-11-29 06:08:32 +08:00
|
|
|
#ifdef GRAVE_ESC_ALT_OVERRIDE
|
2019-08-31 02:19:03 +08:00
|
|
|
// if ALT is pressed, ESC is always sent
|
|
|
|
|
// this is handy for the cmd+opt+esc shortcut on macOS, among other things.
|
|
|
|
|
if (get_mods() & (MOD_BIT(KC_LALT) | MOD_BIT(KC_RALT))) {
|
|
|
|
|
shifted = 0;
|
|
|
|
|
}
|
2017-11-29 06:08:32 +08:00
|
|
|
#endif
|
|
|
|
|
|
2017-08-12 00:53:08 +08:00
|
|
|
#ifdef GRAVE_ESC_CTRL_OVERRIDE
|
2019-08-31 02:19:03 +08:00
|
|
|
// if CTRL is pressed, ESC is always sent
|
|
|
|
|
// this is handy for the ctrl+shift+esc shortcut on windows, among other things.
|
|
|
|
|
if (get_mods() & (MOD_BIT(KC_LCTL) | MOD_BIT(KC_RCTL))) {
|
|
|
|
|
shifted = 0;
|
|
|
|
|
}
|
2017-11-29 06:08:32 +08:00
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#ifdef GRAVE_ESC_GUI_OVERRIDE
|
2019-08-31 02:19:03 +08:00
|
|
|
// if GUI is pressed, ESC is always sent
|
|
|
|
|
if (get_mods() & (MOD_BIT(KC_LGUI) | MOD_BIT(KC_RGUI))) {
|
|
|
|
|
shifted = 0;
|
|
|
|
|
}
|
2017-11-29 06:08:32 +08:00
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#ifdef GRAVE_ESC_SHIFT_OVERRIDE
|
2019-08-31 02:19:03 +08:00
|
|
|
// if SHIFT is pressed, ESC is always sent
|
|
|
|
|
if (get_mods() & (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT))) {
|
|
|
|
|
shifted = 0;
|
|
|
|
|
}
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
if (record->event.pressed) {
|
|
|
|
|
grave_esc_was_shifted = shifted;
|
|
|
|
|
add_key(shifted ? KC_GRAVE : KC_ESCAPE);
|
|
|
|
|
} else {
|
|
|
|
|
del_key(grave_esc_was_shifted ? KC_GRAVE : KC_ESCAPE);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
send_keyboard_report();
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
}
|
2016-05-15 12:27:32 +08:00
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
return process_action_kb(record);
|
2017-06-30 01:02:38 +08:00
|
|
|
}
|
|
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
__attribute__((weak)) const bool ascii_to_shift_lut[128] PROGMEM = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
|
|
|
|
|
|
|
|
|
0, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 0};
|
|
|
|
|
|
|
|
|
|
__attribute__((weak)) const bool ascii_to_altgr_lut[128] PROGMEM = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
|
|
|
|
|
|
|
|
|
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
|
|
|
|
|
|
|
|
|
|
__attribute__((weak)) const uint8_t ascii_to_keycode_lut[128] PROGMEM = {// NUL SOH STX ETX EOT ENQ ACK BEL
|
|
|
|
|
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
|
|
|
|
|
// BS TAB LF VT FF CR SO SI
|
|
|
|
|
KC_BSPC, KC_TAB, KC_ENT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
|
|
|
|
|
// DLE DC1 DC2 DC3 DC4 NAK SYN ETB
|
|
|
|
|
XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
|
|
|
|
|
// CAN EM SUB ESC FS GS RS US
|
|
|
|
|
XXXXXXX, XXXXXXX, XXXXXXX, KC_ESC, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
|
|
|
|
|
|
|
|
|
|
// ! " # $ % & '
|
|
|
|
|
KC_SPC, KC_1, KC_QUOT, KC_3, KC_4, KC_5, KC_7, KC_QUOT,
|
|
|
|
|
// ( ) * + , - . /
|
|
|
|
|
KC_9, KC_0, KC_8, KC_EQL, KC_COMM, KC_MINS, KC_DOT, KC_SLSH,
|
|
|
|
|
// 0 1 2 3 4 5 6 7
|
|
|
|
|
KC_0, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7,
|
|
|
|
|
// 8 9 : ; < = > ?
|
|
|
|
|
KC_8, KC_9, KC_SCLN, KC_SCLN, KC_COMM, KC_EQL, KC_DOT, KC_SLSH,
|
|
|
|
|
// @ A B C D E F G
|
|
|
|
|
KC_2, KC_A, KC_B, KC_C, KC_D, KC_E, KC_F, KC_G,
|
|
|
|
|
// H I J K L M N O
|
|
|
|
|
KC_H, KC_I, KC_J, KC_K, KC_L, KC_M, KC_N, KC_O,
|
|
|
|
|
// P Q R S T U V W
|
|
|
|
|
KC_P, KC_Q, KC_R, KC_S, KC_T, KC_U, KC_V, KC_W,
|
|
|
|
|
// X Y Z [ \ ] ^ _
|
|
|
|
|
KC_X, KC_Y, KC_Z, KC_LBRC, KC_BSLS, KC_RBRC, KC_6, KC_MINS,
|
|
|
|
|
// ` a b c d e f g
|
|
|
|
|
KC_GRV, KC_A, KC_B, KC_C, KC_D, KC_E, KC_F, KC_G,
|
|
|
|
|
// h i j k l m n o
|
|
|
|
|
KC_H, KC_I, KC_J, KC_K, KC_L, KC_M, KC_N, KC_O,
|
|
|
|
|
// p q r s t u v w
|
|
|
|
|
KC_P, KC_Q, KC_R, KC_S, KC_T, KC_U, KC_V, KC_W,
|
|
|
|
|
// x y z { | } ~ DEL
|
|
|
|
|
KC_X, KC_Y, KC_Z, KC_LBRC, KC_BSLS, KC_RBRC, KC_GRV, KC_DEL};
|
|
|
|
|
|
|
|
|
|
void send_string(const char *str) { send_string_with_delay(str, 0); }
|
|
|
|
|
|
|
|
|
|
void send_string_P(const char *str) { send_string_with_delay_P(str, 0); }
|
2017-09-12 12:43:10 +08:00
|
|
|
|
2017-06-30 01:02:38 +08:00
|
|
|
void send_string_with_delay(const char *str, uint8_t interval) {
|
2017-06-24 17:29:37 +08:00
|
|
|
while (1) {
|
2017-09-12 12:43:10 +08:00
|
|
|
char ascii_code = *str;
|
2017-06-24 17:29:37 +08:00
|
|
|
if (!ascii_code) break;
|
2019-03-30 11:24:13 +08:00
|
|
|
if (ascii_code == SS_TAP_CODE) {
|
2019-08-31 02:19:03 +08:00
|
|
|
// tap
|
|
|
|
|
uint8_t keycode = *(++str);
|
|
|
|
|
register_code(keycode);
|
|
|
|
|
unregister_code(keycode);
|
2019-03-30 11:24:13 +08:00
|
|
|
} else if (ascii_code == SS_DOWN_CODE) {
|
2019-08-31 02:19:03 +08:00
|
|
|
// down
|
|
|
|
|
uint8_t keycode = *(++str);
|
|
|
|
|
register_code(keycode);
|
2019-03-30 11:24:13 +08:00
|
|
|
} else if (ascii_code == SS_UP_CODE) {
|
2019-08-31 02:19:03 +08:00
|
|
|
// up
|
|
|
|
|
uint8_t keycode = *(++str);
|
|
|
|
|
unregister_code(keycode);
|
2017-09-12 12:43:10 +08:00
|
|
|
} else {
|
2019-08-31 02:19:03 +08:00
|
|
|
send_char(ascii_code);
|
2017-06-24 17:29:37 +08:00
|
|
|
}
|
2017-09-12 12:43:10 +08:00
|
|
|
++str;
|
|
|
|
|
// interval
|
2019-08-31 02:19:03 +08:00
|
|
|
{
|
|
|
|
|
uint8_t ms = interval;
|
|
|
|
|
while (ms--) wait_ms(1);
|
|
|
|
|
}
|
2017-09-12 12:43:10 +08:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void send_string_with_delay_P(const char *str, uint8_t interval) {
|
|
|
|
|
while (1) {
|
|
|
|
|
char ascii_code = pgm_read_byte(str);
|
|
|
|
|
if (!ascii_code) break;
|
2019-03-30 11:24:13 +08:00
|
|
|
if (ascii_code == SS_TAP_CODE) {
|
2019-08-31 02:19:03 +08:00
|
|
|
// tap
|
|
|
|
|
uint8_t keycode = pgm_read_byte(++str);
|
|
|
|
|
register_code(keycode);
|
|
|
|
|
unregister_code(keycode);
|
2019-03-30 11:24:13 +08:00
|
|
|
} else if (ascii_code == SS_DOWN_CODE) {
|
2019-08-31 02:19:03 +08:00
|
|
|
// down
|
|
|
|
|
uint8_t keycode = pgm_read_byte(++str);
|
|
|
|
|
register_code(keycode);
|
2019-03-30 11:24:13 +08:00
|
|
|
} else if (ascii_code == SS_UP_CODE) {
|
2019-08-31 02:19:03 +08:00
|
|
|
// up
|
|
|
|
|
uint8_t keycode = pgm_read_byte(++str);
|
|
|
|
|
unregister_code(keycode);
|
2017-09-12 12:43:10 +08:00
|
|
|
} else {
|
2019-08-31 02:19:03 +08:00
|
|
|
send_char(ascii_code);
|
2017-06-24 17:29:37 +08:00
|
|
|
}
|
|
|
|
|
++str;
|
2017-06-30 01:02:38 +08:00
|
|
|
// interval
|
2019-08-31 02:19:03 +08:00
|
|
|
{
|
|
|
|
|
uint8_t ms = interval;
|
|
|
|
|
while (ms--) wait_ms(1);
|
|
|
|
|
}
|
2017-06-24 17:29:37 +08:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-09-12 12:43:10 +08:00
|
|
|
void send_char(char ascii_code) {
|
2019-08-31 02:19:03 +08:00
|
|
|
uint8_t keycode = pgm_read_byte(&ascii_to_keycode_lut[(uint8_t)ascii_code]);
|
|
|
|
|
bool is_shifted = pgm_read_byte(&ascii_to_shift_lut[(uint8_t)ascii_code]);
|
|
|
|
|
bool is_altgred = pgm_read_byte(&ascii_to_altgr_lut[(uint8_t)ascii_code]);
|
|
|
|
|
|
|
|
|
|
if (is_shifted) {
|
|
|
|
|
register_code(KC_LSFT);
|
|
|
|
|
}
|
|
|
|
|
if (is_altgred) {
|
|
|
|
|
register_code(KC_RALT);
|
|
|
|
|
}
|
|
|
|
|
tap_code(keycode);
|
|
|
|
|
if (is_altgred) {
|
|
|
|
|
unregister_code(KC_RALT);
|
|
|
|
|
}
|
|
|
|
|
if (is_shifted) {
|
|
|
|
|
unregister_code(KC_LSFT);
|
|
|
|
|
}
|
2017-09-12 12:43:10 +08:00
|
|
|
}
|
|
|
|
|
|
2017-07-21 11:57:11 +08:00
|
|
|
void set_single_persistent_default_layer(uint8_t default_layer) {
|
2019-08-31 02:19:03 +08:00
|
|
|
#if defined(AUDIO_ENABLE) && defined(DEFAULT_LAYER_SONGS)
|
2017-07-21 11:57:11 +08:00
|
|
|
PLAY_SONG(default_layer_songs[default_layer]);
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
|
|
|
|
eeconfig_update_default_layer(1U << default_layer);
|
|
|
|
|
default_layer_set(1U << default_layer);
|
2017-07-21 11:57:11 +08:00
|
|
|
}
|
|
|
|
|
|
2019-08-22 08:07:49 +08:00
|
|
|
layer_state_t update_tri_layer_state(layer_state_t state, uint8_t layer1, uint8_t layer2, uint8_t layer3) {
|
2019-08-31 02:19:03 +08:00
|
|
|
layer_state_t mask12 = (1UL << layer1) | (1UL << layer2);
|
|
|
|
|
layer_state_t mask3 = 1UL << layer3;
|
|
|
|
|
return (state & mask12) == mask12 ? (state | mask3) : (state & ~mask3);
|
2018-04-27 04:10:03 +08:00
|
|
|
}
|
|
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
void update_tri_layer(uint8_t layer1, uint8_t layer2, uint8_t layer3) { layer_state_set(update_tri_layer_state(layer_state, layer1, layer2, layer3)); }
|
2016-06-02 10:49:55 +08:00
|
|
|
|
2016-06-30 06:29:20 +08:00
|
|
|
void tap_random_base64(void) {
|
2019-08-31 02:19:03 +08:00
|
|
|
#if defined(__AVR_ATmega32U4__)
|
2016-06-30 06:35:29 +08:00
|
|
|
uint8_t key = (TCNT0 + TCNT1 + TCNT3 + TCNT4) % 64;
|
2019-08-31 02:19:03 +08:00
|
|
|
#else
|
2016-06-30 06:35:29 +08:00
|
|
|
uint8_t key = rand() % 64;
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
|
|
|
|
switch (key) {
|
|
|
|
|
case 0 ... 25:
|
|
|
|
|
register_code(KC_LSFT);
|
|
|
|
|
register_code(key + KC_A);
|
|
|
|
|
unregister_code(key + KC_A);
|
|
|
|
|
unregister_code(KC_LSFT);
|
|
|
|
|
break;
|
|
|
|
|
case 26 ... 51:
|
|
|
|
|
register_code(key - 26 + KC_A);
|
|
|
|
|
unregister_code(key - 26 + KC_A);
|
|
|
|
|
break;
|
|
|
|
|
case 52:
|
|
|
|
|
register_code(KC_0);
|
|
|
|
|
unregister_code(KC_0);
|
|
|
|
|
break;
|
|
|
|
|
case 53 ... 61:
|
|
|
|
|
register_code(key - 53 + KC_1);
|
|
|
|
|
unregister_code(key - 53 + KC_1);
|
|
|
|
|
break;
|
|
|
|
|
case 62:
|
|
|
|
|
register_code(KC_LSFT);
|
|
|
|
|
register_code(KC_EQL);
|
|
|
|
|
unregister_code(KC_EQL);
|
|
|
|
|
unregister_code(KC_LSFT);
|
|
|
|
|
break;
|
|
|
|
|
case 63:
|
|
|
|
|
register_code(KC_SLSH);
|
|
|
|
|
unregister_code(KC_SLSH);
|
|
|
|
|
break;
|
|
|
|
|
}
|
2016-06-30 06:29:20 +08:00
|
|
|
}
|
|
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
__attribute__((weak)) void bootmagic_lite(void) {
|
|
|
|
|
// The lite version of TMK's bootmagic based on Wilba.
|
|
|
|
|
// 100% less potential for accidentally making the
|
|
|
|
|
// keyboard do stupid things.
|
2018-10-28 02:53:50 +08:00
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
// We need multiple scans because debouncing can't be turned off.
|
|
|
|
|
matrix_scan();
|
|
|
|
|
#if defined(DEBOUNCING_DELAY) && DEBOUNCING_DELAY > 0
|
2018-10-28 02:53:50 +08:00
|
|
|
wait_ms(DEBOUNCING_DELAY * 2);
|
2019-08-31 02:19:03 +08:00
|
|
|
#elif defined(DEBOUNCE) && DEBOUNCE > 0
|
2018-10-28 02:53:50 +08:00
|
|
|
wait_ms(DEBOUNCE * 2);
|
2019-08-31 02:19:03 +08:00
|
|
|
#else
|
2018-10-28 02:53:50 +08:00
|
|
|
wait_ms(30);
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
|
|
|
|
matrix_scan();
|
|
|
|
|
|
|
|
|
|
// If the Esc and space bar are held down on power up,
|
|
|
|
|
// reset the EEPROM valid state and jump to bootloader.
|
|
|
|
|
// Assumes Esc is at [0,0].
|
|
|
|
|
// This isn't very generalized, but we need something that doesn't
|
|
|
|
|
// rely on user's keymaps in firmware or EEPROM.
|
|
|
|
|
if (matrix_get_row(BOOTMAGIC_LITE_ROW) & (1 << BOOTMAGIC_LITE_COLUMN)) {
|
|
|
|
|
eeconfig_disable();
|
|
|
|
|
// Jump to bootloader.
|
|
|
|
|
bootloader_jump();
|
|
|
|
|
}
|
2018-10-28 02:53:50 +08:00
|
|
|
}
|
|
|
|
|
|
2016-05-15 12:27:32 +08:00
|
|
|
void matrix_init_quantum() {
|
2019-08-31 02:19:03 +08:00
|
|
|
#ifdef BOOTMAGIC_LITE
|
2018-10-28 02:53:50 +08:00
|
|
|
bootmagic_lite();
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
|
|
|
|
if (!eeconfig_is_enabled()) {
|
|
|
|
|
eeconfig_init();
|
|
|
|
|
}
|
|
|
|
|
#ifdef BACKLIGHT_ENABLE
|
|
|
|
|
# ifdef LED_MATRIX_ENABLE
|
|
|
|
|
led_matrix_init();
|
|
|
|
|
# else
|
|
|
|
|
backlight_init_ports();
|
|
|
|
|
# endif
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef AUDIO_ENABLE
|
2017-07-21 11:57:11 +08:00
|
|
|
audio_init();
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
|
|
|
|
#ifdef RGB_MATRIX_ENABLE
|
2018-06-13 11:37:06 +08:00
|
|
|
rgb_matrix_init();
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
|
|
|
|
#ifdef ENCODER_ENABLE
|
2018-10-27 04:19:23 +08:00
|
|
|
encoder_init();
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
|
|
|
|
#if defined(UNICODE_ENABLE) || defined(UNICODEMAP_ENABLE) || defined(UCIS_ENABLE)
|
2018-12-20 00:39:24 +08:00
|
|
|
unicode_input_mode_init();
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
|
|
|
|
#ifdef HAPTIC_ENABLE
|
2019-02-17 10:39:30 +08:00
|
|
|
haptic_init();
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
|
|
|
|
#ifdef OUTPUT_AUTO_ENABLE
|
2019-04-20 04:07:35 +08:00
|
|
|
set_output(OUTPUT_AUTO);
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
2019-09-03 23:34:31 +08:00
|
|
|
#ifdef DIP_SWITCH_ENABLE
|
|
|
|
|
dip_switch_init();
|
|
|
|
|
#endif
|
|
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
matrix_init_kb();
|
2016-05-15 12:27:32 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void matrix_scan_quantum() {
|
2019-08-31 02:19:03 +08:00
|
|
|
#if defined(AUDIO_ENABLE) && !defined(NO_MUSIC_MODE)
|
Moves features to their own files (process_*), adds tap dance feature (#460)
* non-working commit
* working
* subprojects implemented for planck
* pass a subproject variable through to c
* consolidates clueboard revisions
* thanks for letting me know about conflicts..
* turn off audio for yang's
* corrects starting paths for subprojects
* messing around with travis
* semicolon
* travis script
* travis script
* script for travis
* correct directory (probably), amend files to commit
* remove origin before adding
* git pull, correct syntax
* git checkout
* git pull origin branch
* where are we?
* where are we?
* merging
* force things to happen
* adds commit message, adds add
* rebase, no commit message
* rebase branch
* idk!
* try just pull
* fetch - merge
* specify repo branch
* checkout
* goddammit
* merge? idk
* pls
* after all
* don't split up keyboards
* syntax
* adds quick for all-keyboards
* trying out new script
* script update
* lowercase
* all keyboards
* stop replacing compiled.hex automatically
* adds if statement
* skip automated build branches
* forces push to automated build branch
* throw an add in there
* upstream?
* adds AUTOGEN
* ignore all .hex files again
* testing out new repo
* global ident
* generate script, keyboard_keymap.hex
* skip generation for now, print pandoc info, submodule update
* try trusty
* and sudo
* try generate
* updates subprojects to keyboards
* no idea
* updates to keyboards
* cleans up clueboard stuff
* setup to use local readme
* updates cluepad, planck experimental
* remove extra led.c [ci skip]
* audio and midi moved over to separate files
* chording, leader, unicode separated
* consolidate each [skip ci]
* correct include
* quantum: Add a tap dance feature (#451)
* quantum: Add a tap dance feature
With this feature one can specify keys that behave differently, based on
the amount of times they have been tapped, and when interrupted, they
get handled before the interrupter.
To make it clear how this is different from `ACTION_FUNCTION_TAP`, lets
explore a certain setup! We want one key to send `Space` on single tap,
but `Enter` on double-tap.
With `ACTION_FUNCTION_TAP`, it is quite a rain-dance to set this up, and
has the problem that when the sequence is interrupted, the interrupting
key will be send first. Thus, `SPC a` will result in `a SPC` being sent,
if they are typed within `TAPPING_TERM`. With the tap dance feature,
that'll come out as `SPC a`, correctly.
The implementation hooks into two parts of the system, to achieve this:
into `process_record_quantum()`, and the matrix scan. We need the latter
to be able to time out a tap sequence even when a key is not being
pressed, so `SPC` alone will time out and register after `TAPPING_TERM`
time.
But lets start with how to use it, first!
First, you will need `TAP_DANCE_ENABLE=yes` in your `Makefile`, because
the feature is disabled by default. This adds a little less than 1k to
the firmware size. Next, you will want to define some tap-dance keys,
which is easiest to do with the `TD()` macro, that - similar to `F()`,
takes a number, which will later be used as an index into the
`tap_dance_actions` array.
This array specifies what actions shall be taken when a tap-dance key is
in action. Currently, there are two possible options:
* `ACTION_TAP_DANCE_DOUBLE(kc1, kc2)`: Sends the `kc1` keycode when
tapped once, `kc2` otherwise.
* `ACTION_TAP_DANCE_FN(fn)`: Calls the specified function - defined in
the user keymap - with the current state of the tap-dance action.
The first option is enough for a lot of cases, that just want dual
roles. For example, `ACTION_TAP_DANCE(KC_SPC, KC_ENT)` will result in
`Space` being sent on single-tap, `Enter` otherwise.
And that's the bulk of it!
Do note, however, that this implementation does have some consequences:
keys do not register until either they reach the tapping ceiling, or
they time out. This means that if you hold the key, nothing happens, no
repeat, no nothing. It is possible to detect held state, and register an
action then too, but that's not implemented yet. Keys also unregister
immediately after being registered, so you can't even hold the second
tap. This is intentional, to be consistent.
And now, on to the explanation of how it works!
The main entry point is `process_tap_dance()`, called from
`process_record_quantum()`, which is run for every keypress, and our
handler gets to run early. This function checks whether the key pressed
is a tap-dance key. If it is not, and a tap-dance was in action, we
handle that first, and enqueue the newly pressed key. If it is a
tap-dance key, then we check if it is the same as the already active
one (if there's one active, that is). If it is not, we fire off the old
one first, then register the new one. If it was the same, we increment
the counter and the timer.
This means that you have `TAPPING_TERM` time to tap the key again, you
do not have to input all the taps within that timeframe. This allows for
longer tap counts, with minimal impact on responsiveness.
Our next stop is `matrix_scan_tap_dance()`. This handles the timeout of
tap-dance keys.
For the sake of flexibility, tap-dance actions can be either a pair of
keycodes, or a user function. The latter allows one to handle higher tap
counts, or do extra things, like blink the LEDs, fiddle with the
backlighting, and so on. This is accomplished by using an union, and
some clever macros.
In the end, lets see a full example!
```c
enum {
CT_SE = 0,
CT_CLN,
CT_EGG
};
/* Have the above three on the keymap, TD(CT_SE), etc... */
void dance_cln (qk_tap_dance_state_t *state) {
if (state->count == 1) {
register_code (KC_RSFT);
register_code (KC_SCLN);
unregister_code (KC_SCLN);
unregister_code (KC_RSFT);
} else {
register_code (KC_SCLN);
unregister_code (KC_SCLN);
reset_tap_dance (state);
}
}
void dance_egg (qk_tap_dance_state_t *state) {
if (state->count >= 100) {
SEND_STRING ("Safety dance!");
reset_tap_dance (state);
}
}
const qk_tap_dance_action_t tap_dance_actions[] = {
[CT_SE] = ACTION_TAP_DANCE_DOUBLE (KC_SPC, KC_ENT)
,[CT_CLN] = ACTION_TAP_DANCE_FN (dance_cln)
,[CT_EGG] = ACTION_TAP_DANCE_FN (dance_egg)
};
```
This addresses #426.
Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
* hhkb: Fix the build with the new tap-dance feature
Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
* tap_dance: Move process_tap_dance further down
Process the tap dance stuff after midi and audio, because those don't
process keycodes, but row/col positions.
Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
* tap_dance: Use conditionals instead of dummy functions
To be consistent with how the rest of the quantum features are
implemented, use ifdefs instead of dummy functions.
Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
* Merge branch 'master' into quantum-keypress-process
# Conflicts:
# Makefile
# keyboards/planck/rev3/config.h
# keyboards/planck/rev4/config.h
* update build script
2016-06-30 05:49:41 +08:00
|
|
|
matrix_scan_music();
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
2016-05-15 12:51:06 +08:00
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
#ifdef TAP_DANCE_ENABLE
|
Moves features to their own files (process_*), adds tap dance feature (#460)
* non-working commit
* working
* subprojects implemented for planck
* pass a subproject variable through to c
* consolidates clueboard revisions
* thanks for letting me know about conflicts..
* turn off audio for yang's
* corrects starting paths for subprojects
* messing around with travis
* semicolon
* travis script
* travis script
* script for travis
* correct directory (probably), amend files to commit
* remove origin before adding
* git pull, correct syntax
* git checkout
* git pull origin branch
* where are we?
* where are we?
* merging
* force things to happen
* adds commit message, adds add
* rebase, no commit message
* rebase branch
* idk!
* try just pull
* fetch - merge
* specify repo branch
* checkout
* goddammit
* merge? idk
* pls
* after all
* don't split up keyboards
* syntax
* adds quick for all-keyboards
* trying out new script
* script update
* lowercase
* all keyboards
* stop replacing compiled.hex automatically
* adds if statement
* skip automated build branches
* forces push to automated build branch
* throw an add in there
* upstream?
* adds AUTOGEN
* ignore all .hex files again
* testing out new repo
* global ident
* generate script, keyboard_keymap.hex
* skip generation for now, print pandoc info, submodule update
* try trusty
* and sudo
* try generate
* updates subprojects to keyboards
* no idea
* updates to keyboards
* cleans up clueboard stuff
* setup to use local readme
* updates cluepad, planck experimental
* remove extra led.c [ci skip]
* audio and midi moved over to separate files
* chording, leader, unicode separated
* consolidate each [skip ci]
* correct include
* quantum: Add a tap dance feature (#451)
* quantum: Add a tap dance feature
With this feature one can specify keys that behave differently, based on
the amount of times they have been tapped, and when interrupted, they
get handled before the interrupter.
To make it clear how this is different from `ACTION_FUNCTION_TAP`, lets
explore a certain setup! We want one key to send `Space` on single tap,
but `Enter` on double-tap.
With `ACTION_FUNCTION_TAP`, it is quite a rain-dance to set this up, and
has the problem that when the sequence is interrupted, the interrupting
key will be send first. Thus, `SPC a` will result in `a SPC` being sent,
if they are typed within `TAPPING_TERM`. With the tap dance feature,
that'll come out as `SPC a`, correctly.
The implementation hooks into two parts of the system, to achieve this:
into `process_record_quantum()`, and the matrix scan. We need the latter
to be able to time out a tap sequence even when a key is not being
pressed, so `SPC` alone will time out and register after `TAPPING_TERM`
time.
But lets start with how to use it, first!
First, you will need `TAP_DANCE_ENABLE=yes` in your `Makefile`, because
the feature is disabled by default. This adds a little less than 1k to
the firmware size. Next, you will want to define some tap-dance keys,
which is easiest to do with the `TD()` macro, that - similar to `F()`,
takes a number, which will later be used as an index into the
`tap_dance_actions` array.
This array specifies what actions shall be taken when a tap-dance key is
in action. Currently, there are two possible options:
* `ACTION_TAP_DANCE_DOUBLE(kc1, kc2)`: Sends the `kc1` keycode when
tapped once, `kc2` otherwise.
* `ACTION_TAP_DANCE_FN(fn)`: Calls the specified function - defined in
the user keymap - with the current state of the tap-dance action.
The first option is enough for a lot of cases, that just want dual
roles. For example, `ACTION_TAP_DANCE(KC_SPC, KC_ENT)` will result in
`Space` being sent on single-tap, `Enter` otherwise.
And that's the bulk of it!
Do note, however, that this implementation does have some consequences:
keys do not register until either they reach the tapping ceiling, or
they time out. This means that if you hold the key, nothing happens, no
repeat, no nothing. It is possible to detect held state, and register an
action then too, but that's not implemented yet. Keys also unregister
immediately after being registered, so you can't even hold the second
tap. This is intentional, to be consistent.
And now, on to the explanation of how it works!
The main entry point is `process_tap_dance()`, called from
`process_record_quantum()`, which is run for every keypress, and our
handler gets to run early. This function checks whether the key pressed
is a tap-dance key. If it is not, and a tap-dance was in action, we
handle that first, and enqueue the newly pressed key. If it is a
tap-dance key, then we check if it is the same as the already active
one (if there's one active, that is). If it is not, we fire off the old
one first, then register the new one. If it was the same, we increment
the counter and the timer.
This means that you have `TAPPING_TERM` time to tap the key again, you
do not have to input all the taps within that timeframe. This allows for
longer tap counts, with minimal impact on responsiveness.
Our next stop is `matrix_scan_tap_dance()`. This handles the timeout of
tap-dance keys.
For the sake of flexibility, tap-dance actions can be either a pair of
keycodes, or a user function. The latter allows one to handle higher tap
counts, or do extra things, like blink the LEDs, fiddle with the
backlighting, and so on. This is accomplished by using an union, and
some clever macros.
In the end, lets see a full example!
```c
enum {
CT_SE = 0,
CT_CLN,
CT_EGG
};
/* Have the above three on the keymap, TD(CT_SE), etc... */
void dance_cln (qk_tap_dance_state_t *state) {
if (state->count == 1) {
register_code (KC_RSFT);
register_code (KC_SCLN);
unregister_code (KC_SCLN);
unregister_code (KC_RSFT);
} else {
register_code (KC_SCLN);
unregister_code (KC_SCLN);
reset_tap_dance (state);
}
}
void dance_egg (qk_tap_dance_state_t *state) {
if (state->count >= 100) {
SEND_STRING ("Safety dance!");
reset_tap_dance (state);
}
}
const qk_tap_dance_action_t tap_dance_actions[] = {
[CT_SE] = ACTION_TAP_DANCE_DOUBLE (KC_SPC, KC_ENT)
,[CT_CLN] = ACTION_TAP_DANCE_FN (dance_cln)
,[CT_EGG] = ACTION_TAP_DANCE_FN (dance_egg)
};
```
This addresses #426.
Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
* hhkb: Fix the build with the new tap-dance feature
Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
* tap_dance: Move process_tap_dance further down
Process the tap dance stuff after midi and audio, because those don't
process keycodes, but row/col positions.
Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
* tap_dance: Use conditionals instead of dummy functions
To be consistent with how the rest of the quantum features are
implemented, use ifdefs instead of dummy functions.
Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
* Merge branch 'master' into quantum-keypress-process
# Conflicts:
# Makefile
# keyboards/planck/rev3/config.h
# keyboards/planck/rev4/config.h
* update build script
2016-06-30 05:49:41 +08:00
|
|
|
matrix_scan_tap_dance();
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
2016-12-10 22:11:59 +08:00
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
#ifdef COMBO_ENABLE
|
2016-12-10 22:11:59 +08:00
|
|
|
matrix_scan_combo();
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
2016-12-10 22:11:59 +08:00
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
#if defined(BACKLIGHT_ENABLE)
|
|
|
|
|
# if defined(LED_MATRIX_ENABLE)
|
|
|
|
|
led_matrix_task();
|
2019-11-03 05:20:03 +08:00
|
|
|
# elif defined(BACKLIGHT_PIN) || defined(BACKLIGHT_PINS)
|
2019-08-31 02:19:03 +08:00
|
|
|
backlight_task();
|
|
|
|
|
# endif
|
|
|
|
|
#endif
|
2017-02-13 00:29:42 +08:00
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
#ifdef RGB_MATRIX_ENABLE
|
2018-05-09 03:24:18 +08:00
|
|
|
rgb_matrix_task();
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
2018-05-09 03:24:18 +08:00
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
#ifdef ENCODER_ENABLE
|
2018-10-27 04:19:23 +08:00
|
|
|
encoder_read();
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
2018-10-27 04:19:23 +08:00
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
#ifdef HAPTIC_ENABLE
|
2019-02-17 10:39:30 +08:00
|
|
|
haptic_task();
|
2019-08-31 02:19:03 +08:00
|
|
|
#endif
|
2019-02-17 10:39:30 +08:00
|
|
|
|
2019-09-03 23:34:31 +08:00
|
|
|
#ifdef DIP_SWITCH_ENABLE
|
|
|
|
|
dip_switch_read(false);
|
|
|
|
|
#endif
|
|
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
matrix_scan_kb();
|
2016-05-19 11:14:00 +08:00
|
|
|
}
|
2016-06-24 10:18:20 +08:00
|
|
|
|
2018-07-16 01:31:45 +08:00
|
|
|
#ifdef HD44780_ENABLED
|
2019-08-31 02:19:03 +08:00
|
|
|
# include "hd44780.h"
|
2018-07-16 01:31:45 +08:00
|
|
|
#endif
|
|
|
|
|
|
2016-11-22 08:50:55 +08:00
|
|
|
// Functions for spitting out values
|
|
|
|
|
//
|
|
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
void send_dword(uint32_t number) { // this might not actually work
|
2016-11-22 08:50:55 +08:00
|
|
|
uint16_t word = (number >> 16);
|
|
|
|
|
send_word(word);
|
|
|
|
|
send_word(number & 0xFFFFUL);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void send_word(uint16_t number) {
|
|
|
|
|
uint8_t byte = number >> 8;
|
|
|
|
|
send_byte(byte);
|
|
|
|
|
send_byte(number & 0xFF);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void send_byte(uint8_t number) {
|
|
|
|
|
uint8_t nibble = number >> 4;
|
|
|
|
|
send_nibble(nibble);
|
|
|
|
|
send_nibble(number & 0xF);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void send_nibble(uint8_t number) {
|
|
|
|
|
switch (number) {
|
|
|
|
|
case 0:
|
|
|
|
|
register_code(KC_0);
|
|
|
|
|
unregister_code(KC_0);
|
|
|
|
|
break;
|
|
|
|
|
case 1 ... 9:
|
|
|
|
|
register_code(KC_1 + (number - 1));
|
|
|
|
|
unregister_code(KC_1 + (number - 1));
|
|
|
|
|
break;
|
|
|
|
|
case 0xA ... 0xF:
|
|
|
|
|
register_code(KC_A + (number - 0xA));
|
|
|
|
|
unregister_code(KC_A + (number - 0xA));
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
__attribute__((weak)) uint16_t hex_to_keycode(uint8_t hex) {
|
|
|
|
|
hex = hex & 0xF;
|
|
|
|
|
if (hex == 0x0) {
|
|
|
|
|
return KC_0;
|
|
|
|
|
} else if (hex < 0xA) {
|
|
|
|
|
return KC_1 + (hex - 0x1);
|
|
|
|
|
} else {
|
|
|
|
|
return KC_A + (hex - 0xA);
|
|
|
|
|
}
|
2017-02-16 05:36:31 +08:00
|
|
|
}
|
|
|
|
|
|
2016-11-27 04:37:46 +08:00
|
|
|
void api_send_unicode(uint32_t unicode) {
|
|
|
|
|
#ifdef API_ENABLE
|
2016-11-24 09:16:38 +08:00
|
|
|
uint8_t chunk[4];
|
|
|
|
|
dword_to_bytes(unicode, chunk);
|
|
|
|
|
MT_SEND_DATA(DT_UNICODE, chunk, 5);
|
2016-11-27 04:37:46 +08:00
|
|
|
#endif
|
2016-11-24 09:16:38 +08:00
|
|
|
}
|
2016-06-24 10:18:20 +08:00
|
|
|
|
2019-11-06 08:42:16 +08:00
|
|
|
/** \brief Lock LED set callback - keymap/user level
|
|
|
|
|
*
|
|
|
|
|
* \deprecated Use led_update_user() instead.
|
|
|
|
|
*/
|
2019-08-31 02:19:03 +08:00
|
|
|
__attribute__((weak)) void led_set_user(uint8_t usb_led) {}
|
2016-06-24 10:18:20 +08:00
|
|
|
|
2019-11-06 08:42:16 +08:00
|
|
|
/** \brief Lock LED set callback - keyboard level
|
|
|
|
|
*
|
|
|
|
|
* \deprecated Use led_update_kb() instead.
|
|
|
|
|
*/
|
2019-08-31 02:19:03 +08:00
|
|
|
__attribute__((weak)) void led_set_kb(uint8_t usb_led) { led_set_user(usb_led); }
|
2016-06-24 10:18:20 +08:00
|
|
|
|
2019-11-06 08:42:16 +08:00
|
|
|
/** \brief Lock LED update callback - keymap/user level
|
|
|
|
|
*
|
|
|
|
|
* \return True if led_update_kb() should run its own code, false otherwise.
|
|
|
|
|
*/
|
|
|
|
|
__attribute__((weak)) bool led_update_user(led_t led_state) { return true; }
|
|
|
|
|
|
|
|
|
|
/** \brief Lock LED update callback - keyboard level
|
|
|
|
|
*
|
|
|
|
|
* \return Ignored for now.
|
|
|
|
|
*/
|
|
|
|
|
__attribute__((weak)) bool led_update_kb(led_t led_state) { return led_update_user(led_state); }
|
|
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
__attribute__((weak)) void led_init_ports(void) {}
|
2016-06-24 10:18:20 +08:00
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
__attribute__((weak)) void led_set(uint8_t usb_led) {
|
2019-01-29 08:57:56 +08:00
|
|
|
#if defined(BACKLIGHT_CAPS_LOCK) && defined(BACKLIGHT_ENABLE)
|
2019-08-31 02:19:03 +08:00
|
|
|
// Use backlight as Caps Lock indicator
|
|
|
|
|
uint8_t bl_toggle_lvl = 0;
|
|
|
|
|
|
|
|
|
|
if (IS_LED_ON(usb_led, USB_LED_CAPS_LOCK) && !backlight_config.enable) {
|
|
|
|
|
// Turning Caps Lock ON and backlight is disabled in config
|
|
|
|
|
// Toggling backlight to the brightest level
|
|
|
|
|
bl_toggle_lvl = BACKLIGHT_LEVELS;
|
|
|
|
|
} else if (IS_LED_OFF(usb_led, USB_LED_CAPS_LOCK) && backlight_config.enable) {
|
|
|
|
|
// Turning Caps Lock OFF and backlight is enabled in config
|
|
|
|
|
// Toggling backlight and restoring config level
|
|
|
|
|
bl_toggle_lvl = backlight_config.level;
|
|
|
|
|
}
|
2019-01-29 08:57:56 +08:00
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
// Set level without modify backlight_config to keep ability to restore state
|
|
|
|
|
backlight_set(bl_toggle_lvl);
|
2019-01-29 08:57:56 +08:00
|
|
|
#endif
|
|
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
led_set_kb(usb_led);
|
2019-11-17 22:02:26 +08:00
|
|
|
led_update_kb((led_t)usb_led);
|
2016-06-24 10:18:20 +08:00
|
|
|
}
|
|
|
|
|
|
2016-05-24 23:56:53 +08:00
|
|
|
//------------------------------------------------------------------------------
|
2016-06-04 03:48:40 +08:00
|
|
|
// Override these functions in your keymap file to play different tunes on
|
2016-05-24 23:56:53 +08:00
|
|
|
// different events such as startup and bootloader jump
|
|
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
__attribute__((weak)) void startup_user() {}
|
2016-05-24 23:56:53 +08:00
|
|
|
|
2019-08-31 02:19:03 +08:00
|
|
|
__attribute__((weak)) void shutdown_user() {}
|
2016-05-24 23:56:53 +08:00
|
|
|
|
2016-05-25 11:27:59 +08:00
|
|
|
//------------------------------------------------------------------------------
|