summaryrefslogtreecommitdiffstats
path: root/users/drashna
diff options
context:
space:
mode:
Diffstat (limited to 'users/drashna')
-rw-r--r--users/drashna/autocorrect_data.h5
-rw-r--r--users/drashna/callbacks.c3
-rw-r--r--users/drashna/callbacks.h3
-rw-r--r--users/drashna/config.h14
-rw-r--r--users/drashna/keyrecords/autocorrection/autocorrection.c292
-rw-r--r--users/drashna/keyrecords/autocorrection/autocorrection.h9
-rwxr-xr-xusers/drashna/keyrecords/autocorrection/make_autocorrection_data.py186
-rw-r--r--users/drashna/keyrecords/caps_word.c139
-rw-r--r--users/drashna/keyrecords/caps_word.h85
-rw-r--r--users/drashna/keyrecords/keycodes.md5
-rw-r--r--users/drashna/keyrecords/process_records.c72
-rw-r--r--users/drashna/keyrecords/process_records.h11
-rw-r--r--users/drashna/keyrecords/secrets.md17
-rw-r--r--users/drashna/keyrecords/unicode.c21
-rw-r--r--users/drashna/keyrecords/unicode.h16
-rw-r--r--users/drashna/oled/oled_stuff.c135
-rw-r--r--users/drashna/oled/oled_stuff.h9
-rw-r--r--users/drashna/oled/sh110x.c19
-rw-r--r--users/drashna/pointing/pointing.c4
-rw-r--r--users/drashna/rgb/rgb_matrix_stuff.c3
-rw-r--r--users/drashna/rules.mk12
-rw-r--r--users/drashna/split/transport_sync.c3
-rw-r--r--users/drashna/split/transport_sync.h13
-rw-r--r--users/drashna/template.c15
-rw-r--r--users/drashna/template.h4
25 files changed, 510 insertions, 585 deletions
diff --git a/users/drashna/autocorrect_data.h b/users/drashna/autocorrect_data.h
new file mode 100644
index 0000000000..bcb5858aa8
--- /dev/null
+++ b/users/drashna/autocorrect_data.h
@@ -0,0 +1,5 @@
+#if __has_include("../qmk_secrets/autocorrection_data.h")
+# include "../qmk_secrets/autocorrection_data.h"
+#else
+# include "autocorrect_data_default.h"
+#endif
diff --git a/users/drashna/callbacks.c b/users/drashna/callbacks.c
index c11a381dee..0ceb1aebe5 100644
--- a/users/drashna/callbacks.c
+++ b/users/drashna/callbacks.c
@@ -87,6 +87,9 @@ void suspend_power_down_user(void) {
__attribute__((weak)) void suspend_wakeup_init_keymap(void) {}
void suspend_wakeup_init_user(void) {
+#ifdef OLED_ENABLE
+ oled_timer_reset();
+#endif
suspend_wakeup_init_keymap();
}
diff --git a/users/drashna/callbacks.h b/users/drashna/callbacks.h
index 5fe5f6a808..f6ac6b88de 100644
--- a/users/drashna/callbacks.h
+++ b/users/drashna/callbacks.h
@@ -23,6 +23,3 @@ void matrix_init_unicode(void);
#ifdef SPLIT_KEYBOARD
void matrix_slave_scan_keymap(void);
#endif
-#ifdef CAPS_WORD_ENABLE
-# include "keyrecords/caps_word.h"
-#endif
diff --git a/users/drashna/config.h b/users/drashna/config.h
index 4551c3504f..4a34f5d66a 100644
--- a/users/drashna/config.h
+++ b/users/drashna/config.h
@@ -37,9 +37,9 @@
// # define WPM_LAUNCH_CONTROL
// # define WPM_ALLOW_COUNT_REGRESSOIN
// # define WPM_UNFILTERED
-# define WPM_SAMPLE_SECONDS 6
+# define WPM_SAMPLE_SECONDS 10
# define WPM_SAMPLE_PERIODS 50
-# define WPM_ESTIMATED_WORD_SIZE 6
+# define WPM_ESTIMATED_WORD_SIZE 5
#endif
#ifdef AUDIO_ENABLE
@@ -291,6 +291,12 @@
# ifndef OLED_BRIGHTNESS
# define OLED_BRIGHTNESS 50
# endif
-# undef OLED_UPDATE_INTERVAL
-# define OLED_UPDATE_INTERVAL 100
+# if !defined(STM32F4XX)
+# undef OLED_UPDATE_INTERVAL
+# define OLED_UPDATE_INTERVAL 75
+# endif
#endif
+
+#define ENABLE_COMPILE_KEYCODE
+
+#define BOTH_SHIFTS_TURNS_ON_CAPS_WORD
diff --git a/users/drashna/keyrecords/autocorrection/autocorrection.c b/users/drashna/keyrecords/autocorrection/autocorrection.c
index c7e938a341..682d6fd49c 100644
--- a/users/drashna/keyrecords/autocorrection/autocorrection.c
+++ b/users/drashna/keyrecords/autocorrection/autocorrection.c
@@ -10,6 +10,13 @@
# pragma GCC push_options
# pragma GCC optimize("O0")
# include "autocorrection_data.h"
+# ifndef AUTOCORRECTION_MIN_LENGTH
+# define AUTOCORRECTION_MIN_LENGTH AUTOCORRECT_MIN_LENGTH
+# endif
+# ifndef AUTOCORRECTION_MAX_LENGTH
+# define AUTOCORRECTION_MAX_LENGTH AUTOCORRECT_MAX_LENGTH
+# endif
+# define autocorrection_data autocorrect_data
# if AUTOCORRECTION_MIN_LENGTH < 4
# error Minimum Length is too short and may cause overflows
# endif
@@ -17,6 +24,138 @@
# error Dictionary size excees maximum size permitted
# endif
+static uint8_t typo_buffer[AUTOCORRECT_MAX_LENGTH] = {KC_SPC};
+static uint8_t typo_buffer_size = 1;
+
+/**
+ * @brief function for querying the enabled state of autocorrect
+ *
+ * @return true if enabled
+ * @return false if disabled
+ */
+bool autocorrect_is_enabled(void) {
+ return userspace_config.autocorrection;
+}
+
+/**
+ * @brief Enables autocorrect and saves state to eeprom
+ *
+ */
+void autocorrect_enable(void) {
+ userspace_config.autocorrection = true;
+ eeconfig_update_user(userspace_config.raw);
+}
+
+/**
+ * @brief Disables autocorrect and saves state to eeprom
+ *
+ */
+void autocorrect_disable(void) {
+ userspace_config.autocorrection = false;
+ typo_buffer_size = 0;
+ eeconfig_update_user(userspace_config.raw);
+}
+
+/**
+ * @brief Toggles autocorrect's status and save state to eeprom
+ *
+ */
+void autocorrect_toggle(void) {
+ userspace_config.autocorrection = !userspace_config.autocorrection;
+ typo_buffer_size = 0;
+ eeconfig_update_user(userspace_config.raw);
+}
+
+/**
+ * @brief handler for determining if autocorrect should process keypress
+ *
+ * @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.
+ */
+__attribute__((weak)) bool process_autocorrect_user(uint16_t *keycode, keyrecord_t *record, uint8_t *typo_buffer_size, uint8_t *mods) {
+ // See quantum_keycodes.h for reference on these matched ranges.
+ switch (*keycode) {
+ // Exclude these keycodes from processing.
+ case KC_LSFT:
+ case KC_RSFT:
+ case KC_CAPS:
+ case QK_TO ... QK_ONE_SHOT_LAYER_MAX:
+ case QK_LAYER_TAP_TOGGLE ... QK_LAYER_MOD_MAX:
+ case QK_ONE_SHOT_MOD ... QK_ONE_SHOT_MOD_MAX:
+ return false;
+
+ // Mask for base keycode from shifted keys.
+ case QK_LSFT ... QK_LSFT + 255:
+ case QK_RSFT ... QK_RSFT + 255:
+ if (*keycode >= QK_LSFT && *keycode <= (QK_LSFT + 255)) {
+ *mods |= MOD_LSFT;
+ } else {
+ *mods |= MOD_RSFT;
+ }
+ *keycode &= 0xFF; // Get the basic keycode.
+ return true;
+#ifndef NO_ACTION_TAPPING
+ // Exclude tap-hold keys when they are held down
+ // and mask for base keycode when they are tapped.
+ case QK_LAYER_TAP ... QK_LAYER_TAP_MAX:
+# ifdef NO_ACTION_LAYER
+ // Exclude Layer Tap, if layers are disabled
+ // but action tapping is still enabled.
+ return false;
+# endif
+ case QK_MOD_TAP ... QK_MOD_TAP_MAX:
+ // Exclude hold keycode
+ if (!record->tap.count) {
+ return false;
+ }
+ *keycode &= 0xFF;
+ break;
+#else
+ case QK_MOD_TAP ... QK_MOD_TAP_MAX:
+ case QK_LAYER_TAP ... QK_LAYER_TAP_MAX:
+ // Exclude if disabled
+ return false;
+#endif
+ // Exclude swap hands keys when they are held down
+ // and mask for base keycode when they are tapped.
+ case QK_SWAP_HANDS ... QK_SWAP_HANDS_MAX:
+#ifdef SWAP_HANDS_ENABLE
+ if (*keycode >= 0x56F0 || !record->tap.count) {
+ return false;
+ }
+ *keycode &= 0xFF;
+ break;
+#else
+ // Exclude if disabled
+ return false;
+#endif
+ }
+
+ // Disable autocorrect while a mod other than shift is active.
+ if ((*mods & ~MOD_MASK_SHIFT) != 0) {
+ *typo_buffer_size = 0;
+ return false;
+ }
+
+ return true;
+}
+
+/**
+ * @brief handling for when autocorrection has been triggered
+ *
+ * @param backspaces number of characters to remove
+ * @param str pointer to PROGMEM string to replace mistyped seletion with
+ * @return true apply correction
+ * @return false user handled replacement
+ */
+__attribute__((weak)) bool apply_autocorrect(uint8_t backspaces, const char *str) {
+ return true;
+}
+
/**
* @brief Process handler for autocorrect feature
*
@@ -25,131 +164,124 @@
* @return true Continue processing keycodes, and send to host
* @return false Stop processing keycodes, and don't send to host
*/
-bool process_autocorrection(uint16_t keycode, keyrecord_t* record) {
- static uint8_t typo_buffer[AUTOCORRECTION_MAX_LENGTH] = {KC_SPC};
- static uint8_t typo_buffer_size = 1;
+bool process_autocorrection(uint16_t keycode, keyrecord_t *record) {
+ uint8_t mods = get_mods();
+#ifndef NO_ACTION_ONESHOT
+ mods |= get_oneshot_mods();
+#endif
- if (keycode == AUTO_CTN) {
- if (record->event.pressed) {
- typo_buffer_size = 0;
- userspace_config.autocorrection ^= 1;
- eeconfig_update_user(userspace_config.raw);
+ if ((keycode >= AUTOCORRECT_ON && keycode <= AUTOCORRECT_TOGGLE) && record->event.pressed) {
+ if (keycode == AUTOCORRECT_ON) {
+ autocorrect_enable();
+ } else if (keycode == AUTOCORRECT_OFF) {
+ autocorrect_disable();
+ } else if (keycode == AUTOCORRECT_TOGGLE) {
+ autocorrect_toggle();
+ } else {
+ return true;
}
+
return false;
}
- if (!userspace_config.autocorrection) {
+ if (!autocorrect_is_enabled()) {
typo_buffer_size = 0;
return true;
}
+ if (!record->event.pressed) {
+ return true;
+ }
+
+ // autocorrect keycode verification and extraction
+ if (!process_autocorrect_user(&keycode, record, &typo_buffer_size, &mods)) {
+ return true;
+ }
+
+ // keycode buffer check
switch (keycode) {
- case KC_LSFT:
- case KC_RSFT:
- return true;
-# ifndef NO_ACTION_TAPPING
- case QK_MOD_TAP ... QK_MOD_TAP_MAX:
- if (((keycode >> 8) & 0xF) == MOD_LSFT) {
- return true;
- }
-# ifndef NO_ACTION_LAYER
- case QK_LAYER_TAP ... QK_LAYER_TAP_MAX:
-# endif
- if (record->event.pressed || !record->tap.count) {
- return true;
- }
- keycode &= 0xFF;
+ case KC_A ... KC_Z:
+ // process normally
break;
-# endif
-# ifdef SWAP_HANDS_ENABLE
- case QK_SWAP_HANDS ... QK_SWAP_HANDS_MAX:
- if (keycode >= 0x56F0 || record->event.pressed || !record->tap.count) {
- return true;
- }
- keycode &= 0xFF;
+ case KC_1 ... KC_0:
+ case KC_TAB ... KC_SEMICOLON:
+ case KC_GRAVE ... KC_SLASH:
+ // Set a word boundary if space, period, digit, etc. is pressed.
+ keycode = KC_SPC;
break;
-# endif
-# ifndef NO_ACTION_ONESHOT
- case QK_ONE_SHOT_MOD ... QK_ONE_SHOT_MOD_MAX:
- if ((keycode & 0xF) == MOD_LSFT) {
- return true;
- }
-# endif
- default:
- // Disable autocorrection while a mod other than shift is active.
- if (((get_mods() | get_oneshot_mods()) & ~MOD_MASK_SHIFT) != 0) {
- typo_buffer_size = 0;
- return true;
- }
- if (!record->event.pressed) {
- return true;
- }
- }
-
- // Subtract buffer for Backspace key, reset for other non-alpha.
- if (!(KC_A <= keycode && keycode <= KC_Z)) {
- if (keycode == KC_BSPC) {
+ case KC_ENTER:
+ // Behave more conservatively for the enter key. Reset, so that enter
+ // can't be used on a word ending.
+ typo_buffer_size = 0;
+ keycode = KC_SPC;
+ break;
+ case KC_BSPC:
// Remove last character from the buffer.
if (typo_buffer_size > 0) {
--typo_buffer_size;
}
return true;
- } else if (KC_1 <= keycode && keycode <= KC_SLSH && keycode != KC_ESC) {
- // Set a word boundary if space, period, digit, etc. is pressed.
- // Behave more conservatively for the enter key. Reset, so that enter
- // can't be used on a word ending.
- if (keycode == KC_ENT || (keycode == KC_MINUS && (get_mods() | get_oneshot_mods()) & MOD_MASK_SHIFT)) {
- typo_buffer_size = 0;
+ case KC_QUOTE:
+ // Treat " (shifted ') as a word boundary.
+ if ((mods & MOD_MASK_SHIFT) != 0) {
+ keycode = KC_SPC;
}
- keycode = KC_SPC;
- } else {
+ break;
+ default:
// Clear state if some other non-alpha key is pressed.
typo_buffer_size = 0;
return true;
- }
}
// Rotate oldest character if buffer is full.
- if (typo_buffer_size >= AUTOCORRECTION_MAX_LENGTH) {
- memmove(typo_buffer, typo_buffer + 1, AUTOCORRECTION_MAX_LENGTH - 1);
- typo_buffer_size = AUTOCORRECTION_MAX_LENGTH - 1;
+ if (typo_buffer_size >= AUTOCORRECT_MAX_LENGTH) {
+ memmove(typo_buffer, typo_buffer + 1, AUTOCORRECT_MAX_LENGTH - 1);
+ typo_buffer_size = AUTOCORRECT_MAX_LENGTH - 1;
}
// Append `keycode` to buffer.
typo_buffer[typo_buffer_size++] = keycode;
// Return if buffer is smaller than the shortest word.
- if (typo_buffer_size < AUTOCORRECTION_MIN_LENGTH) {
+ if (typo_buffer_size < AUTOCORRECT_MIN_LENGTH) {
return true;
}
- // Check for typo in buffer using a trie stored in `autocorrection_data`.
+ // Check for typo in buffer using a trie stored in `autocorrect_data`.
uint16_t state = 0;
- uint8_t code = pgm_read_byte(autocorrection_data + state);
- for (uint8_t i = typo_buffer_size - 1; i >= 0; --i) {
+ uint8_t code = pgm_read_byte(autocorrect_data + state);
+ for (int8_t i = typo_buffer_size - 1; i >= 0; --i) {
uint8_t const key_i = typo_buffer[i];
- if (code & 64) { // Check for match in node with multiple children.
+ if (code & 64) { // Check for match in node with multiple children.
code &= 63;
- for (; code != key_i; code = pgm_read_byte(autocorrection_data + (state += 3))) {
+ for (; code != key_i; code = pgm_read_byte(autocorrect_data + (state += 3))) {
if (!code) return true;
}
// Follow link to child node.
- state = (pgm_read_byte(autocorrection_data + state + 1) | pgm_read_byte(autocorrection_data + state + 2) << 8);
+ state = (pgm_read_byte(autocorrect_data + state + 1) | pgm_read_byte(autocorrect_data + state + 2) << 8);
// Check for match in node with single child.
} else if (code != key_i) {
return true;
- } else if (!(code = pgm_read_byte(autocorrection_data + (++state)))) {
+ } else if (!(code = pgm_read_byte(autocorrect_data + (++state)))) {
++state;
}
- code = pgm_read_byte(autocorrection_data + state);
+ // Stop if `state` becomes an invalid index. This should not normally
+ // happen, it is a safeguard in case of a bug, data corruption, etc.
+ if (state >= DICTIONARY_SIZE) {
+ return true;
+ }
+
+ code = pgm_read_byte(autocorrect_data + state);
- if (code & 128) { // A typo was found! Apply autocorrection.
- const uint8_t backspaces = code & 63;
- for (uint8_t i = 0; i < backspaces; ++i) {
- tap_code(KC_BSPC);
+ if (code & 128) { // A typo was found! Apply autocorrect.
+ const uint8_t backspaces = (code & 63) + !record->event.pressed;
+ if (apply_autocorrect(backspaces, (char const *)(autocorrect_data + state + 1))) {
+ for (uint8_t i = 0; i < backspaces; ++i) {
+ tap_code(KC_BSPC);
+ }
+ send_string_P((char const *)(autocorrect_data + state + 1));
}
- send_string_P((char const*)(autocorrection_data + state + 1));
if (keycode == KC_SPC) {
typo_buffer[0] = KC_SPC;
@@ -166,5 +298,7 @@ bool process_autocorrection(uint16_t keycode, keyrecord_t* record) {
# pragma GCC pop_options
#else
# pragma message "Warning!!! Autocorrect is not corretly setup!"
-bool process_autocorrection(uint16_t keycode, keyrecord_t* record) { return true; }
+bool process_autocorrection(uint16_t keycode, keyrecord_t* record) {
+ return true;
+}
#endif
diff --git a/users/drashna/keyrecords/autocorrection/autocorrection.h b/users/drashna/keyrecords/autocorrection/autocorrection.h
index cea93159ae..8946b91f1f 100644
--- a/users/drashna/keyrecords/autocorrection/autocorrection.h
+++ b/users/drashna/keyrecords/autocorrection/autocorrection.h
@@ -7,4 +7,11 @@
#include "drashna.h"
-bool process_autocorrection(uint16_t keycode, keyrecord_t* record);
+bool process_autocorrection(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 apply_autocorrect(uint8_t backspaces, const char *str);
+
+bool autocorrect_is_enabled(void);
+void autocorrect_enable(void);
+void autocorrect_disable(void);
+void autocorrect_toggle(void);
diff --git a/users/drashna/keyrecords/autocorrection/make_autocorrection_data.py b/users/drashna/keyrecords/autocorrection/make_autocorrection_data.py
index 54fd9ba594..0dd9b78b9c 100755
--- a/users/drashna/keyrecords/autocorrection/make_autocorrection_data.py
+++ b/users/drashna/keyrecords/autocorrection/make_autocorrection_data.py
@@ -1,4 +1,4 @@
-# Copyright 2021 Google LLC
+# 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.
@@ -29,6 +29,7 @@ Each line of the dict file defines one typo and its correction with the syntax
Example:
:thier -> their
+ dosen't -> doesn't
fitler -> filter
lenght -> length
ouput -> output
@@ -42,7 +43,7 @@ https://getreuer.info/posts/keyboards/autocorrection
import sys
import textwrap
-from typing import Any, Dict, List, Tuple
+from typing import Any, Dict, Iterator, List, Tuple
try:
from english_words import english_words_lower_alpha_set as CORRECT_WORDS
@@ -51,85 +52,67 @@ except ImportError:
'correctly spelled word. To check for this, install the english_words '
'package and rerun this script:\n\n pip install english_words\n')
# Use a minimal word list as a fallback.
- CORRECT_WORDS = ('information', 'available', 'international', 'language',
- 'loosest', 'reference', 'wealthier', 'entertainment',
- 'association', 'provides', 'technology', 'statehood')
+ CORRECT_WORDS = ('apparent', 'association', 'available', 'classification',
+ 'effect', 'entertainment', 'fantastic', 'information',
+ 'integrate', 'international', 'language', 'loosest',
+ 'manual', 'nothing', 'provides', 'reference', 'statehood',
+ 'technology', 'virtually', 'wealthier', 'wonderful')
KC_A = 4
KC_SPC = 0x2c
+KC_QUOT = 0x34
+
+TYPO_CHARS = dict(
+ [
+ ("'", KC_QUOT),
+ (':', KC_SPC), # "Word break" character.
+ ] +
+ # Characters a-z.
+ [(chr(c), c + KC_A - ord('a')) for c in range(ord('a'), ord('z') + 1)]
+)
+
def parse_file(file_name: str) -> List[Tuple[str, str]]:
"""Parses autocorrections dictionary file.
Each line of the file defines one typo and its correction with the syntax
"typo -> correction". Blank lines or lines starting with '#' are ignored. The
- function validates that typos only have characters a-z and that typos are not
- substrings of other typos, otherwise the longer typo would never trigger.
+ function validates that typos only have characters in TYPO_CHARS, that
+ typos are not substrings of other typos, and checking that typos don't trigger
+ on CORRECT_WORDS.
Args:
file_name: String, path of the autocorrections dictionary.
Returns:
List of (typo, correction) tuples.
"""
-
+ correct_words = ('information', 'available', 'international', 'language', 'loosest', 'reference', 'wealthier', 'entertainment', 'association', 'provides', 'technology', 'statehood')
autocorrections = []
typos = set()
- line_number = 0
- for line in open(file_name, 'rt'):
- line_number += 1
- line = line.strip()
- if line and line[0] != '#':
- # Parse syntax "typo -> correction", using strip to ignore indenting.
- tokens = [token.strip() for token in line.split('->', 1)]
- if len(tokens) != 2 or not tokens[0]:
- print(f'Error:{line_number}: Invalid syntax: "{line}"')
+ for line_number, typo, correction in parse_file_lines(file_name):
+ if typo in typos:
+ print(f'Warning:{line_number}: Ignoring duplicate typo: "{typo}"')
+ continue
+
+ # Check that `typo` is valid.
+ if not(all([c in TYPO_CHARS for c in typo])):
+ print(f'Error:{line_number}: Typo "{typo}" has '
+ 'characters other than ' + ''.join(TYPO_CHARS.keys()))
+ sys.exit(1)
+ for other_typo in typos:
+ if typo in other_typo or other_typo in typo:
+ print(f'Error:{line_number}: Typos may not be substrings of one '
+ f'another, otherwise the longer typo would never trigger: '
+ f'"{typo}" vs. "{other_typo}".')
sys.exit(1)
+ if len(typo) < 5:
+ print(f'Warning:{line_number}: It is suggested that typos are at '
+ f'least 5 characters long to avoid false triggers: "{typo}"')
- typo, correction = tokens
- typo = typo.lower() # Force typos to lowercase.
- typo = typo.replace(' ', ':')
-
- if typo in typos:
- print(f'Warning:{line_number}: Ignoring duplicate typo: "{typo}"')
- continue
+ check_typo_against_dictionary(typo, line_number, correct_words)
- # Check that `typo` is valid.
- if not(all([ord('a') <= ord(c) <= ord('z') or c == ':' for c in typo])):
- print(f'Error:{line_number}: Typo "{typo}" has '
- 'characters other than a-z and :.')
- sys.exit(1)
- for other_typo in typos:
- if typo in other_typo or other_typo in typo:
- print(f'Error:{line_number}: Typos may not be substrings of one '
- f'another, otherwise the longer typo would never trigger: '
- f'"{typo}" vs. "{other_typo}".')
- sys.exit(1)
- if len(typo) < 5:
- print(f'Warning:{line_number}: It is suggested that typos are at '
- f'least 5 characters long to avoid false triggers: "{typo}"')
-
- if typo.startswith(':') and typo.endswith(':'):
- if typo[1:-1] in CORRECT_WORDS:
- print(f'Warning:{line_number}: Typo "{typo}" is a correctly spelled '
- 'dictionary word.')
- elif typo.startswith(':') and not typo.endswith(':'):
- for word in CORRECT_WORDS:
- if word.startswith(typo[1:]):
- print(f'Warning:{line_number}: Typo "{typo}" would falsely trigger '
- f'on correctly spelled word "{word}".')
- elif not typo.startswith(':') and typo.endswith(':'):
- for word in CORRECT_WORDS:
- if word.endswith(typo[:-1]):
- print(f'Warning:{line_number}: Typo "{typo}" would falsely trigger '
- f'on correctly spelled word "{word}".')
- elif not typo.startswith(':') and not typo.endswith(':'):
- for word in CORRECT_WORDS:
- if typo in word:
- print(f'Warning:{line_number}: Typo "{typo}" would falsely trigger '
- f'on correctly spelled word "{word}".')
-
- autocorrections.append((typo, correction))
- typos.add(typo)
+ autocorrections.append((typo, correction))
+ typos.add(typo)
return autocorrections
@@ -152,6 +135,47 @@ def make_trie(autocorrections: List[Tuple[str, str]]) -> Dict[str, Any]:
return trie
+def parse_file_lines(file_name: str) -> Iterator[Tuple[int, str, str]]:
+ """Parses lines read from `file_name` into typo-correction pairs."""
+
+ line_number = 0
+ for line in open(file_name, 'rt'):
+ line_number += 1
+ line = line.strip()
+ if line and line[0] != '#':
+ # Parse syntax "typo -> correction", using strip to ignore indenting.
+ tokens = [token.strip() for token in line.split('->', 1)]
+ if len(tokens) != 2 or not tokens[0]:
+ print(f'Error:{line_number}: Invalid syntax: "{line}"')
+ sys.exit(1)
+
+ typo, correction = tokens
+ typo = typo.lower() # Force typos to lowercase.
+ typo = typo.replace(' ', ':')
+
+ yield line_number, typo, correction
+
+
+def check_typo_against_dictionary(typo: str, line_number: int, correct_words) -> None:
+ """Checks `typo` against English dictionary words."""
+
+ if typo.startswith(':') and typo.endswith(':'):
+ if typo[1:-1] in correct_words:
+ print(f'Warning:{line_number}: Typo "{typo}" is a correctly spelled dictionary word.')
+ elif typo.startswith(':') and not typo.endswith(':'):
+ for word in correct_words:
+ if word.startswith(typo[1:]):
+ print(f'Warning:{line_number}: Typo "{typo}" would falsely trigger on correctly spelled word "{word}".')
+ elif not typo.startswith(':') and typo.endswith(':'):
+ for word in correct_words:
+ if word.endswith(typo[:-1]):
+ print(f'Warning:{line_number}: Typo "{typo}" would falsely trigger on correctly spelled word "{word}".')
+ elif not typo.startswith(':') and not typo.endswith(':'):
+ for word in correct_words:
+ if typo in word:
+ print(f'Warning:{line_number}: Typo "{typo}" would falsely trigger on correctly spelled word "{word}".')
+
+
def serialize_trie(autocorrections: List[Tuple[str, str]],
trie: Dict[str, Any]) -> List[int]:
"""Serializes trie and correction data in a form readable by the C code.
@@ -165,7 +189,7 @@ def serialize_trie(autocorrections: List[Tuple[str, str]],
table = []
# Traverse trie in depth first order.
- def traverse(trie_node):
+ def traverse(trie_node: Dict[str, Any]) -> Dict[str, Any]:
if 'LEAF' in trie_node: # Handle a leaf trie node.
typo, correction = trie_node['LEAF']
word_boundary_ending = typo[-1] == ':'
@@ -200,37 +224,35 @@ def serialize_trie(autocorrections: List[Tuple[str, str]],
traverse(trie)
- def serialize(e):
- def kc_code(c):
- if ord('a') <= ord(c) <= ord('z'):
- return ord(c) - ord('a') + KC_A
- elif c == ':':
- return KC_SPC
- else:
- raise ValueError(f'Invalid character: {c}')
-
- encode_link = lambda link: [link['byte_offset'] & 255,
- link['byte_offset'] >> 8]
-
+ def serialize(e: Dict[str, Any]) -> List[int]:
if not e['links']: # Handle a leaf table entry.
return e['data']
elif len(e['links']) == 1: # Handle a chain table entry.
- return list(map(kc_code, e['chars'])) + [0] #+ encode_link(e['links'][0]))
+ return [TYPO_CHARS[c] for c in e['chars']] + [0]
else: # Handle a branch table entry.
data = []
for c, link in zip(e['chars'], e['links']):
- data += [kc_code(c) | (0 if data else 64)] + encode_link(link)
+ data += [TYPO_CHARS[c] | (0 if data else 64)] + encode_link(link)
return data + [0]
byte_offset = 0
for e in table: # To encode links, first compute byte offset of each entry.
e['byte_offset'] = byte_offset
byte_offset += len(serialize(e))
- assert 0 <= byte_offset <= 0xffff
return [b for e in table for b in serialize(e)] # Serialize final table.
+def encode_link(link: Dict[str, Any]) -> List[int]:
+ """Encodes a node link as two bytes."""
+ byte_offset = link['byte_offset']
+ if not (0 <= byte_offset <= 0xffff):
+ print('Error: The autocorrection table is too large, a node link exceeds '
+ '64KB limit. Try reducing the autocorrection dict to fewer entries.')
+ sys.exit(1)
+ return [byte_offset & 255, byte_offset >> 8]
+
+
def write_generated_code(autocorrections: List[Tuple[str, str]],
data: List[int],
file_name: str) -> None:
@@ -242,7 +264,10 @@ def write_generated_code(autocorrections: List[Tuple[str, str]],
file_name: String, path of the output C file.
"""
assert all(0 <= b <= 255 for b in data)
- typo_len = lambda e: len(e[0])
+
+ def typo_len(e: Tuple[str, str]) -> int:
+ return len(e[0])
+
min_typo = min(autocorrections, key=typo_len)[0]
max_typo = max(autocorrections, key=typo_len)[0]
generated_code = ''.join([
@@ -252,9 +277,8 @@ def write_generated_code(autocorrections: List[Tuple[str, str]],
for typo, correction in autocorrections)),
f'\n#define AUTOCORRECTION_MIN_LENGTH {len(min_typo)} // "{min_typo}"\n',
f'#define AUTOCORRECTION_MAX_LENGTH {len(max_typo)} // "{max_typo}"\n\n',
- f'#define DICTIONARY_SIZE {len(data)}\n\n',
- textwrap.fill('static const uint8_t autocorrection_data[DICTIONARY_SIZE] PROGMEM = {%s};' % (
- ', '.join(map(str, data))), width=120, subsequent_indent=' '),
+ textwrap.fill('static const uint8_t autocorrection_data[%d] PROGMEM = {%s};' % (
+ len(data), ', '.join(map(str, data))), width=80, subsequent_indent=' '),
'\n\n'])
with open(file_name, 'wt') as f:
diff --git a/users/drashna/keyrecords/caps_word.c b/users/drashna/keyrecords/caps_word.c
deleted file mode 100644
index a152b2387b..0000000000
--- a/users/drashna/keyrecords/caps_word.c
+++ /dev/null
@@ -1,139 +0,0 @@
-#include "caps_word.h"
-
-static bool caps_word_active = false;
-
-#if CAPS_WORD_IDLE_TIMEOUT > 0
-# if CAPS_WORD_IDLE_TIMEOUT < 100 || CAPS_WORD_IDLE_TIMEOUT > 30000
-// Constrain timeout to a sensible range. With the 16-bit timer, the longest
-// representable timeout is 32768 ms, rounded here to 30000 ms = half a minute.
-# error "caps_word: CAPS_WORD_IDLE_TIMEOUT must be between 100 and 30000 ms"
-# endif
-
-static uint16_t idle_timer = 0;
-
-void caps_word_task(void) {
- if (caps_word_active && timer_expired(timer_read(), idle_timer)) {
- caps_word_set(false);
- }
-}
-#endif // CAPS_WORD_IDLE_TIMEOUT > 0
-
-bool process_caps_word(uint16_t keycode, keyrecord_t* record) {
-#ifndef NO_ACTION_ONESHOT
- const uint8_t mods = get_mods() | get_oneshot_mods();
-#else
- const uint8_t mods = get_mods();
-#endif // NO_ACTION_ONESHOT
-
- if (!caps_word_active) {
- // Pressing both shift keys at the same time enables caps word.
- if ((mods & MOD_MASK_SHIFT) == MOD_MASK_SHIFT) {
- caps_word_set(true); // Activate Caps Word.
- return false;
- }
- return true;
- } else {
-#if CAPS_WORD_IDLE_TIMEOUT > 0
- idle_timer = record->event.time + CAPS_WORD_IDLE_TIMEOUT;
-#endif // CAPS_WORD_IDLE_TIMEOUT > 0
- }
-
- if (!record->event.pressed) {
- return true;
- }
-
- if (!(mods & ~MOD_MASK_SHIFT)) {
- switch (keycode) {
- // Ignore MO, TO, TG, TT, and OSL layer switch keys.
- case QK_MOMENTARY ... QK_MOMENTARY_MAX:
- case QK_TO ... QK_TO_MAX:
- case QK_TOGGLE_LAYER ... QK_TOGGLE_LAYER_MAX:
- case QK_LAYER_TAP_TOGGLE ... QK_LAYER_TAP_TOGGLE_MAX:
- case QK_ONE_SHOT_LAYER ... QK_ONE_SHOT_LAYER_MAX:
- return true;
-
-#ifndef NO_ACTION_TAPPING
- case QK_MOD_TAP ... QK_MOD_TAP_MAX:
- if (record->tap.count == 0) {
- // Deactivate if a mod becomes