sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add informative error when illegal character is in user dictionary

Browse Source
This commit is contained in:
James Fitzgerald 2022-07-04 00:07:57 -04:00 committed by xs5871
parent f33e4d1870
commit 3db84528f2
1 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
kmk/modules/text_replacement.py
View File

@ -31,10 +31,13 @@ class Character:
self.key_code = KC.LSHIFT(key_code) if is_shifted else key_code self.key_code = KC.LSHIFT(key_code) if is_shifted else key_code
def __eq__(self, other: any) -> bool: def __eq__(self, other: any) -> bool:
return ( try:
self.key_code.code == other.key_code.code return (
and self.is_shifted == other.is_shifted self.key_code.code == other.key_code.code
) and self.is_shifted == other.is_shifted
)
except AttributeError:
return False
class Phrase: class Phrase:
@ -44,15 +47,22 @@ class Phrase:
self._characters: list[Character] = [] self._characters: list[Character] = []
self._index: int = 0 self._index: int = 0
for char in string: for char in string:
key_code = getattr(KC, char.upper()) try:
shifted = char.isupper() or key_code.has_modifiers == {2} key_code = getattr(KC, char.upper())
self._characters.append(Character(key_code, shifted)) shifted = char.isupper() or key_code.has_modifiers == {2}
self._characters.append(Character(key_code, shifted))
except ValueError:
raise ValueError(f'Invalid character in dictionary: {char}')
def next_character(self) -> None: def next_character(self) -> None:
'''Increment the current index for this phrase''' '''Increment the current index for this phrase'''
if not self.index_at_end(): if not self.index_at_end():
self._index += 1 self._index += 1
def get_character_at_index(self, index: int) -> Character:
'''Returns the character at the given index'''
return self._characters[index]
def get_character_at_current_index(self) -> Character: def get_character_at_current_index(self) -> Character:
'''Returns the character at the current index for this phrase''' '''Returns the character at the current index for this phrase'''
return self._characters[self._index] return self._characters[self._index]
@ -65,7 +75,7 @@ class Phrase:
'''Returns True if the index is at the end of the phrase''' '''Returns True if the index is at the end of the phrase'''
return self._index == len(self._characters) return self._index == len(self._characters)
def character_is_next(self, character) -> bool: def character_is_at_current_index(self, character) -> bool:
'''Returns True if the given character is the next character in the phrase''' '''Returns True if the given character is the next character in the phrase'''
return self.get_character_at_current_index() == character return self.get_character_at_current_index() == character
@ -109,14 +119,14 @@ class TextReplacement(Module):
character = Character(key, self._shifted) character = Character(key, self._shifted)
# run through the dictionary to check for a possible match on each new keypress # run through the dictionary to check for a possible match on each new keypress
for rule in self._rules: for rule in self._rules:
if rule.to_substitute.character_is_next(character): if rule.to_substitute.character_is_at_current_index(character):
rule.to_substitute.next_character() rule.to_substitute.next_character()
else: else:
rule.restart() rule.restart()
# if character is not a match at the current index, # if character is not a match at the current index,
# it could still be a match at the start of the sequence # it could still be a match at the start of the sequence
# so redo the check after resetting the sequence # so redo the check after resetting the sequence
if rule.to_substitute.character_is_next(character): if rule.to_substitute.character_is_at_current_index(character):
rule.to_substitute.next_character() rule.to_substitute.next_character()
# we've matched all of the characters in a phrase to be substituted # we've matched all of the characters in a phrase to be substituted
if rule.to_substitute.index_at_end(): if rule.to_substitute.index_at_end():