forked from mirrors/qmk_firmware
66 lines
2.1 KiB
C
66 lines
2.1 KiB
C
|
/* Copyright 2021 @daliusd
|
||
|
|
*
|
||
|
|
* 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/>.
|
||
|
|
*/
|
||
|
|
#pragma once
|
||
|
|
|
||
|
|
#include QMK_KEYBOARD_H
|
||
|
|
|
||
|
|
// Represents the four states a oneshot key can be in
|
||
|
|
typedef enum {
|
||
|
|
os_up_unqueued,
|
||
|
|
os_up_queued,
|
||
|
|
os_up_queued_used,
|
||
|
|
os_down_unused,
|
||
|
|
os_down_used,
|
||
|
|
} oneshot_state;
|
||
|
|
|
||
|
|
// Custom oneshot mod implementation that doesn't rely on timers. If a mod is
|
||
|
|
// used while it is held it will be unregistered on keyup as normal, otherwise
|
||
|
|
// it will be queued and only released after the next non-mod keyup.
|
||
|
|
void update_oneshot(
|
||
|
|
oneshot_state *state,
|
||
|
|
uint16_t mod,
|
||
|
|
uint16_t trigger,
|
||
|
|
uint16_t keycode,
|
||
|
|
keyrecord_t *record
|
||
|
|
);
|
||
|
|
|
||
|
|
// Oneshot implementation for layers
|
||
|
|
bool update_oneshot_layer(
|
||
|
|
oneshot_state *state,
|
||
|
|
uint16_t layer,
|
||
|
|
uint16_t trigger,
|
||
|
|
uint16_t keycode,
|
||
|
|
keyrecord_t *record
|
||
|
|
);
|
||
|
|
|
||
|
|
// To be implemented by the consumer. Layers one shot implementation needs to
|
||
|
|
// know which keys are used as oneshot mods
|
||
|
|
bool is_oneshot_mod_key(
|
||
|
|
uint16_t keycode
|
||
|
|
);
|
||
|
|
|
||
|
|
// To be implemented by the consumer. Defines keys to cancel oneshot mods.
|
||
|
|
bool is_oneshot_cancel_key(uint16_t keycode);
|
||
|
|
|
||
|
|
// To be implemented by the consumer. Defines keys to cancel oneshot layers.
|
||
|
|
bool is_oneshot_layer_cancel_key(uint16_t keycode);
|
||
|
|
|
||
|
|
// To be implemented by the consumer. Defines keys to ignore when determining
|
||
|
|
// whether a oneshot mod has been used. Setting this to modifiers and layer
|
||
|
|
// change keys allows stacking multiple oneshot modifiers, and carrying them
|
||
|
|
// between layers.
|
||
|
|
bool is_oneshot_ignored_key(uint16_t keycode);
|