summaryrefslogtreecommitdiffstats
path: root/users
diff options
context:
space:
mode:
Diffstat (limited to 'users')
-rw-r--r--users/arkag/arkag.c2
-rw-r--r--users/brandonschlack/rgb_bs.c4
-rw-r--r--users/byungyoonc/saturated_solid_multisplash.h2
-rw-r--r--users/curry/oled.c2
-rw-r--r--users/curry/rgb_matrix_user.c4
-rw-r--r--users/davidkristoffersen/util/functions.c8
-rw-r--r--users/davidkristoffersen/util/functions.h2
-rw-r--r--users/drashna/callbacks.c2
-rw-r--r--users/drashna/drashna.c12
-rw-r--r--users/drashna/keyrecords/autocorrection/autocorrection.c304
-rw-r--r--users/drashna/keyrecords/autocorrection/autocorrection.h17
-rw-r--r--users/drashna/keyrecords/autocorrection/autocorrection_data.h1
-rwxr-xr-xusers/drashna/keyrecords/autocorrection/make_autocorrection_data.py298
-rw-r--r--users/drashna/keyrecords/autocorrection/readme.md301
-rw-r--r--users/drashna/keyrecords/process_records.c6
-rw-r--r--users/drashna/keyrecords/process_records.h3
-rw-r--r--users/drashna/keyrecords/tap_dance.md2
-rw-r--r--users/drashna/keyrecords/tap_dances.c2
-rw-r--r--users/drashna/keyrecords/unicode.c2
-rw-r--r--users/drashna/oled/oled_stuff.c17
-rw-r--r--users/drashna/pointing/pointing.c119
-rw-r--r--users/drashna/pointing/pointing.h2
-rw-r--r--users/drashna/post_config.h4
-rw-r--r--users/drashna/rgb/rgb_matrix_stuff.c4
-rw-r--r--users/drashna/rules.mk10
-rw-r--r--users/drashna/split/transport_sync.c10
-rw-r--r--users/gary/gary.h1
-rw-r--r--users/gourdo1/gourdo1.h3
-rw-r--r--users/jonavin/jonavin.h1
-rw-r--r--users/sigma/sigma.c2
-rw-r--r--users/spidey3/config.h2
-rw-r--r--users/spidey3/layer_rgb.c33
-rw-r--r--users/spidey3/rules.mk2
-rw-r--r--users/spidey3/spidey3.c25
-rw-r--r--users/spidey3/spidey3.h11
-rw-r--r--users/spidey3/spidey3_unicode.c (renamed from users/spidey3/unicode.c)2
-rw-r--r--users/spidey3/spidey3_unicode.h (renamed from users/spidey3/unicode.h)0
-rw-r--r--users/tominabox1/config.h2
-rw-r--r--users/tominabox1/dimple_rgb.c10
-rw-r--r--users/tominabox1/tominabox1.c4
-rw-r--r--users/uqs/uqs.c20
41 files changed, 146 insertions, 1112 deletions
diff --git a/users/arkag/arkag.c b/users/arkag/arkag.c
index da85d4f6d4..00abbf2ae3 100644
--- a/users/arkag/arkag.c
+++ b/users/arkag/arkag.c
@@ -190,7 +190,7 @@ void set_os (uint8_t os, bool update) {
}
switch (os) {
case OS_MAC:
- set_unicode_input_mode(UC_OSX);
+ set_unicode_input_mode(UC_MAC);
underglow = (Color){ 213, 255, 255 };
break;
case OS_WIN:
diff --git a/users/brandonschlack/rgb_bs.c b/users/brandonschlack/rgb_bs.c
index 1abf785b49..6b88503f41 100644
--- a/users/brandonschlack/rgb_bs.c
+++ b/users/brandonschlack/rgb_bs.c
@@ -75,7 +75,7 @@ void rgb_theme_step_reverse(void) {
rgb_theme_color_t get_rgb_theme_color(uint8_t index) {
rgb_theme_t theme = get_rgb_theme();
- size_t rgb_theme_color_max = sizeof theme.colors / sizeof *theme.colors;
+ size_t rgb_theme_color_max = ARRAY_SIZE(theme.colors);
if (index == _ADJUST) {
return default_adjust;
@@ -98,7 +98,7 @@ void rgb_theme_layer(layer_state_t state) {
#ifdef RGB_MATRIX_ENABLE
void rgb_matrix_layer_helper (uint8_t red, uint8_t green, uint8_t blue, uint8_t led_type) {
- for (int i = 0; i < DRIVER_LED_TOTAL; i++) {
+ for (int i = 0; i < RGB_MATRIX_LED_COUNT; i++) {
if (!HAS_ANY_FLAGS(g_led_config.flags[i], led_type)) {
rgb_matrix_set_color( i, red, green, blue );
}
diff --git a/users/byungyoonc/saturated_solid_multisplash.h b/users/byungyoonc/saturated_solid_multisplash.h
index f302348524..c6850a7873 100644
--- a/users/byungyoonc/saturated_solid_multisplash.h
+++ b/users/byungyoonc/saturated_solid_multisplash.h
@@ -43,7 +43,7 @@ static bool saturated_solid_multisplash(effect_params_t* params) {
RGB rgb = rgb_matrix_hsv_to_rgb(hsv);
rgb_matrix_set_color(i, rgb.r, rgb.g, rgb.b);
}
- return led_max < DRIVER_LED_TOTAL;
+ return led_max < RGB_MATRIX_LED_COUNT;
}
# endif // RGB_MATRIX_CUSTOM_EFFECT_IMPLS
diff --git a/users/curry/oled.c b/users/curry/oled.c
index 5a8f0de61d..89112af121 100644
--- a/users/curry/oled.c
+++ b/users/curry/oled.c
@@ -41,7 +41,7 @@ void add_keylog(uint16_t keycode) {
keylog_str[i] = keylog_str[i - 1];
}
- if (keycode < (sizeof(code_to_name) / sizeof(char))) {
+ if (keycode < ARRAY_SIZE(code_to_name)) {
keylog_str[0] = pgm_read_byte(&code_to_name[keycode]);
}
diff --git a/users/curry/rgb_matrix_user.c b/users/curry/rgb_matrix_user.c
index 96f1f1d4f3..053226ab60 100644
--- a/users/curry/rgb_matrix_user.c
+++ b/users/curry/rgb_matrix_user.c
@@ -131,7 +131,7 @@ void rgb_matrix_layer_helper(uint8_t hue, uint8_t sat, uint8_t val, uint8_t mode
uint16_t time = scale16by8(RGBLED_NUM, speed / 8);
hsv.v = scale8(abs8(sin8(time) - 128) * 2, hsv.v);
RGB rgb = hsv_to_rgb(hsv);
- for (uint8_t i = 0; i < DRIVER_LED_TOTAL; i++) {
+ for (uint8_t i = 0; i < RGB_MATRIX_LED_COUNT; i++) {
if (HAS_FLAGS(g_led_config.flags[i], led_type)) {
rgb_matrix_set_color(i, rgb.r, rgb.g, rgb.b);
}
@@ -141,7 +141,7 @@ void rgb_matrix_layer_helper(uint8_t hue, uint8_t sat, uint8_t val, uint8_t mode
default: // Solid Color
{
RGB rgb = hsv_to_rgb(hsv);
- for (uint8_t i = 0; i < DRIVER_LED_TOTAL; i++) {
+ for (uint8_t i = 0; i < RGB_MATRIX_LED_COUNT; i++) {
if (HAS_FLAGS(g_led_config.flags[i], led_type)) {
rgb_matrix_set_color(i, rgb.r, rgb.g, rgb.b);
}
diff --git a/users/davidkristoffersen/util/functions.c b/users/davidkristoffersen/util/functions.c
index 781d8f214d..3ab4ace2d6 100644
--- a/users/davidkristoffersen/util/functions.c
+++ b/users/davidkristoffersen/util/functions.c
@@ -33,14 +33,14 @@ code_set_t EN_SHIFT_CODES [] = {
const shift_code_t SHIFT_CODES [] = {
#ifdef LAYER_NO
{.lang = LAYER_NO,
- .size = ARR_LEN(NO_SHIFT_CODES),
+ .size = ARRAY_SIZE(NO_SHIFT_CODES),
.codes = NO_SHIFT_CODES},
#endif
{.lang = LAYER_EN,
- .size = ARR_LEN(EN_SHIFT_CODES),
+ .size = ARRAY_SIZE(EN_SHIFT_CODES),
.codes = EN_SHIFT_CODES},
};
-const int SHIFT_CODES_SIZE = ARR_LEN(SHIFT_CODES);
+const int SHIFT_CODES_SIZE = ARRAY_SIZE(SHIFT_CODES);
#endif
#ifdef LAYER_NO
@@ -72,7 +72,7 @@ const code_set_t EN2NO_CODES [] = {
{KC_DLR, NO_DLR},
{KC_GRV, NO_GRV}
};
-const int EN2NO_CODES_SIZE = ARR_LEN(EN2NO_CODES);
+const int EN2NO_CODES_SIZE = ARRAY_SIZE(EN2NO_CODES);
#endif
// Check if layer is an active default layer
diff --git a/users/davidkristoffersen/util/functions.h b/users/davidkristoffersen/util/functions.h
index eee1dadc57..5fef010694 100644
--- a/users/davidkristoffersen/util/functions.h
+++ b/users/davidkristoffersen/util/functions.h
@@ -15,8 +15,6 @@
// Return false if test equal false
#define HANDLE_FALSE(bool) if (!bool) return false;
-// Generic array lenght define
-#define ARR_LEN(arr) (sizeof(arr) / sizeof(arr)[0])
// Printf-like functionality for send_string
#define SEND_VAR(str, ...) \
do { \
diff --git a/users/drashna/callbacks.c b/users/drashna/callbacks.c
index 111b5f79d7..40383f124f 100644
--- a/users/drashna/callbacks.c
+++ b/users/drashna/callbacks.c
@@ -49,7 +49,7 @@ void keyboard_post_init_user(void) {
keyboard_post_init_transport_sync();
#endif
#ifdef I2C_SCANNER_ENABLE
- matrix_scan_i2c();
+ keyboard_post_init_i2c();
#endif
keyboard_post_init_keymap();
diff --git a/users/drashna/drashna.c b/users/drashna/drashna.c
index 91f3a06b7c..d63f05b590 100644
--- a/users/drashna/drashna.c
+++ b/users/drashna/drashna.c
@@ -129,3 +129,15 @@ void keyboard_post_init_i2c(void) {
scan_timer = timer_read();
}
#endif
+
+#if defined(AUTOCORRECT_ENABLE) && defined(AUDIO_ENABLE)
+# ifdef USER_SONG_LIST
+float autocorrect_song[][2] = SONG(MARIO_GAMEOVER);
+# else
+float autocorrect_song[][2] = SONG(PLOVER_GOODBYE_SOUND);
+# endif
+bool apply_autocorrect(uint8_t backspaces, const char *str) {
+ PLAY_SONG(autocorrect_song);
+ return true;
+}
+#endif
diff --git a/users/drashna/keyrecords/autocorrection/autocorrection.c b/users/drashna/keyrecords/autocorrection/autocorrection.c
deleted file mode 100644
index 90fdba8f5e..0000000000
--- a/users/drashna/keyrecords/autocorrection/autocorrection.c
+++ /dev/null
@@ -1,304 +0,0 @@
-// Copyright 2021 Google LLC
-// Copyright 2021 @filterpaper
-// SPDX-License-Identifier: Apache-2.0
-// Original source: https://getreuer.info/posts/keyboards/autocorrection
-
-#include "autocorrection.h"
-#include <string.h>
-
-#if __has_include("autocorrection_data.h")
-# 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
-# if DICTIONARY_SIZE > SIZE_MAX
-# 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
- *
- * @param keycode Keycode registered by matrix press, per keymap
- * @param record keyrecord_t structure
- * @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) {
- uint8_t mods = get_mods();
-# ifndef NO_ACTION_ONESHOT
- mods |= get_oneshot_mods();
-# endif
-
- 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 (!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_A ... KC_Z:
- // process normally
- break;
- 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;
- 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;
- case KC_QUOTE:
- // Treat " (shifted ') as a word boundary.
- if ((mods & MOD_MASK_SHIFT) != 0) {
- keycode = KC_SPC;
- }
- 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 >= 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 < AUTOCORRECT_MIN_LENGTH) {
- return true;
- }
-
- // Check for typo in buffer using a trie stored in `autocorrect_data`.
- uint16_t state = 0;
- 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.
- code &= 63;
- 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(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(autocorrect_data + (++state)))) {
- ++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 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));
- }
-
- if (keycode == KC_SPC) {
- typo_buffer[0] = KC_SPC;
- typo_buffer_size = 1;
- return true;
- } else {
- typo_buffer_size = 0;
- return false;
- }
- }
- }
- return true;
-}
-# pragma GCC pop_options
-#else
-# pragma message "Warning!!! Autocorrect is not corretly setup!"
-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
deleted file mode 100644
index 8946b91f1f..0000000000
--- a/users/drashna/keyrecords/autocorrection/autocorrection.h
+++ /dev/null
@@ -1,17 +0,0 @@
-// Copyright 2021 Google LLC
-// Copyright 2021 @filterpaper
-// SPDX-License-Identifier: Apache-2.0
-// Original source: https://getreuer.info/posts/keyboards/autocorrection
-
-#pragma once
-
-#include "drashna.h"
-
-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/autocorrection_data.h b/users/drashna/keyrecords/autocorrection/autocorrection_data.h
deleted file mode 100644
index 90484d3b12..0000000000
--- a/users/drashna/keyrecords/autocorrection/autocorrection_data.h
+++ /dev/null
@@ -1 +0,0 @@
-#include "autocorrect_data.h"
diff --git a/users/drashna/keyrecords/autocorrection/make_autocorrection_data.py b/users/drashna/keyrecords/autocorrection/make_autocorrection_data.py
deleted file mode 100755
index 0dd9b78b9c..0000000000
--- a/users/drashna/keyrecords/autocorrection/make_autocorrection_data.py
+++ /dev/null
@@ -1,298 +0,0 @@
-# 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.
-# You may obtain a copy of the License at
-#
-# https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""Python program to make autocorrection_data.h.
-
-This program reads "autocorrection_dict.txt" and generates a C source file
-"autocorrection_data.h" with a serialized trie embedded as an array. Run this
-program without arguments like
-
-$ python3 make_autocorrection_data.py
-
-Or to read from a different typo dict file, pass it as the first argument like
-
-$ python3 make_autocorrection_data.py dict.txt
-
-Each line of the dict file defines one typo and its correction with the syntax
-"typo -> correction". Blank lines or lines starting with '#' are ignored.
-Example:
-
- :thier -> their
- dosen't -> doesn't
- fitler -> filter
- lenght -> length
- ouput -> output
- widht -> width
-
-See autocorrection_dict_extra.txt for a larger example.
-
-For full documentation, see
-https://getreuer.info/posts/keyboards/autocorrection
-"""
-
-import sys
-import textwrap
-from typing import Any, Dict, Iterator, List, Tuple
-
-try:
- from english_words import english_words_lower_alpha_set as CORRECT_WORDS
-except ImportError:
- print('Autocorrection will falsely trigger when a typo is a substring of a '
- '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 = ('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 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()
- 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}"')
-
- check_typo_against_dictionary(typo, line_number, correct_words)
-
- autocorrections.append((typo, correction))
- typos.add(typo)
-
- return autocorrections
-
-
-def make_trie(autocorrections: List[Tuple[str, str]]) -> Dict[str, Any]:
- """Makes a trie from the the typos, writing in reverse.
-
- Args:
- autocorrections: List of (typo, correction) tuples.
- Returns:
- Dict of dict, representing the trie.
- """
- trie = {}
- for typo, correction in autocorrections:
- node = trie
- for letter in typo[::-1]:
- node = node.setdefault(letter, {})
- node['LEAF'] = (typo, correction)
-
- 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 "{w