keyboard/qmk-keychron-q3-colemak-dh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Enhancement] Decouple autocorrect logic (#21116)

Browse Source
This commit is contained in:
Pablo Martínez 2023-06-04 03:11:54 +02:00 committed by GitHub
parent 220dad26d0
commit edaf665414
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
quantum/process_keycode/process_autocorrect.c
View File

@ -57,7 +57,7 @@ void autocorrect_toggle(void) {
} }
/** /**
* @brief handler for determining if autocorrect should process keypress * @brief handler for user to override whether autocorrect should process this keypress
* *
* @param keycode Keycode registered by matrix press, per keymap * @param keycode Keycode registered by matrix press, per keymap
* @param record keyrecord_t structure * @param record keyrecord_t structure
@ -67,6 +67,23 @@ void autocorrect_toggle(void) {
* @return false Stop processing and escape from autocorrect. * @return false Stop processing and escape from autocorrect.
*/ */
__attribute__((weak)) bool process_autocorrect_user(uint16_t *keycode, keyrecord_t *record, uint8_t *typo_buffer_size, uint8_t *mods) { __attribute__((weak)) bool process_autocorrect_user(uint16_t *keycode, keyrecord_t *record, uint8_t *typo_buffer_size, uint8_t *mods) {
return process_autocorrect_default_handler(keycode, record, typo_buffer_size, mods);
}
/**
* @brief fallback handler for determining if autocorrect should process this keypress
* can be used by user callback to get the basic keycode being "wrapped"
*
* NOTE: These values may have been edited by user callback before getting here
*
* @param keycode Keycode registered by matrix press, per keymap
* @param record keyrecord_t structure
* @param typo_buffer_size passed along to allow resetting of autocorrect buffer
* @param mods allow processing of mod status
* @return true Allow autocorection
* @return false Stop processing and escape from autocorrect.
*/
bool process_autocorrect_default_handler(uint16_t *keycode, keyrecord_t *record, uint8_t *typo_buffer_size, uint8_t *mods) {
// See quantum_keycodes.h for reference on these matched ranges. // See quantum_keycodes.h for reference on these matched ranges.
switch (*keycode) { switch (*keycode) {
// Exclude these keycodes from processing. // Exclude these keycodes from processing.

1
quantum/process_keycode/process_autocorrect.h
View File

@ -9,6 +9,7 @@
bool process_autocorrect(uint16_t keycode, keyrecord_t *record); bool process_autocorrect(uint16_t keycode, keyrecord_t *record);
bool process_autocorrect_user(uint16_t *keycode, keyrecord_t *record, uint8_t *typo_buffer_size, uint8_t *mods); bool process_autocorrect_user(uint16_t *keycode, keyrecord_t *record, uint8_t *typo_buffer_size, uint8_t *mods);
bool process_autocorrect_default_handler(uint16_t *keycode, keyrecord_t *record, uint8_t *typo_buffer_size, uint8_t *mods);
bool apply_autocorrect(uint8_t backspaces, const char *str); bool apply_autocorrect(uint8_t backspaces, const char *str);
bool autocorrect_is_enabled(void); bool autocorrect_is_enabled(void);