mirror of
https://github.com/openstenoproject/qmk
synced 2024-11-10 10:39:09 +00:00
7e983796e1
* Combo processing improvements. Now it is possible to use ModTap and LayerTap keys as part of combos. Overlapping combos also don't trigger all the combos, just exactly the one that you press. New settings: - COMBO_MUST_HOLD_MODS - COMBO_MOD_TERM - COMBO_TERM_PER_COMBO - COMBO_MUST_HOLD_PER_COMBO - COMBO_STRICT_TIMER - COMBO_NO_TIMER * Remove the size flags from combo_t struct boolean members. This in the end actually saves space as the members are accessed so many times. The amount of operations needed to access the bits uses more memory than setting the size saves. * Fix `process_combo_key_release` not called correctly with tap-only combos * Fix not passing a pointer when NO_ACTION_TAPPING is defined. * Docs for `COMBO_ONLY_FROM_LAYER` * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update quantum/process_keycode/process_combo.c Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Add `EXTRA_SHORT_COMBOS` option. Stuff combo's `disabled` and `active` flags into `state`. Possibly can save some space. * Add more examples and clarify things with dict management system. - Simple examples now has a combo that has modifiers included. - The slightly more advanced examples now are actually more advanced instead of just `tap_code16(<modded-keycode>)`. - Added a note that `COMBO_ACTION`s are not needed anymore as you can just use custom keycodes. - Added a note that the `g/keymap_combo.h` macros use the `process_combo_event` function and that it is not usable in one's keymap afterwards. * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Change "the" combo action example to "email" example. * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Fix sneaky infinite loop with `combo_disable()` No need to call `dump_key_buffer` when disabling combos because the buffer is either being dumped if a combo-key was pressed, or the buffer is empty if a non-combo-key is pressed. * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
81 lines
2.1 KiB
C
81 lines
2.1 KiB
C
/* Copyright 2016 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/>.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "progmem.h"
|
|
#include "quantum.h"
|
|
#include <stdint.h>
|
|
|
|
#ifdef EXTRA_SHORT_COMBOS
|
|
# define MAX_COMBO_LENGTH 6
|
|
#elif defined(EXTRA_EXTRA_LONG_COMBOS)
|
|
# define MAX_COMBO_LENGTH 32
|
|
#elif defined(EXTRA_LONG_COMBOS)
|
|
# define MAX_COMBO_LENGTH 16
|
|
#else
|
|
# define MAX_COMBO_LENGTH 8
|
|
#endif
|
|
|
|
#ifndef COMBO_KEY_BUFFER_LENGTH
|
|
# define COMBO_KEY_BUFFER_LENGTH MAX_COMBO_LENGTH
|
|
#endif
|
|
#ifndef COMBO_BUFFER_LENGTH
|
|
# define COMBO_BUFFER_LENGTH 4
|
|
#endif
|
|
|
|
typedef struct {
|
|
const uint16_t *keys;
|
|
uint16_t keycode;
|
|
#ifdef EXTRA_SHORT_COMBOS
|
|
uint8_t state;
|
|
#else
|
|
bool disabled;
|
|
bool active;
|
|
# if defined(EXTRA_EXTRA_LONG_COMBOS)
|
|
uint32_t state;
|
|
# elif defined(EXTRA_LONG_COMBOS)
|
|
uint16_t state;
|
|
# else
|
|
uint8_t state;
|
|
# endif
|
|
#endif
|
|
} combo_t;
|
|
|
|
#define COMBO(ck, ca) \
|
|
{ .keys = &(ck)[0], .keycode = (ca) }
|
|
#define COMBO_ACTION(ck) \
|
|
{ .keys = &(ck)[0] }
|
|
|
|
#define COMBO_END 0
|
|
#ifndef COMBO_TERM
|
|
# define COMBO_TERM 50
|
|
#endif
|
|
#ifndef COMBO_HOLD_TERM
|
|
# define COMBO_HOLD_TERM TAPPING_TERM
|
|
#endif
|
|
|
|
/* check if keycode is only modifiers */
|
|
#define KEYCODE_IS_MOD(code) (IS_MOD(code) || (code >= QK_MODS && code <= QK_MODS_MAX && !(code & QK_BASIC_MAX)))
|
|
|
|
bool process_combo(uint16_t keycode, keyrecord_t *record);
|
|
void combo_task(void);
|
|
void process_combo_event(uint16_t combo_index, bool pressed);
|
|
|
|
void combo_enable(void);
|
|
void combo_disable(void);
|
|
void combo_toggle(void);
|
|
bool is_combo_enabled(void);
|