Add Shift tap to force English for the next word
Pressing and releasing Shift on its own arms literal mode for the next word, so lowercase English can be typed without it being read as Zhuyin; it resets after the word is committed and a second tap cancels it. While typing, a Shift tap flips the buffer like Tab. Forcing before typing is not recorded as a learned correction; flipping is. Mac: listens for flagsChanged events. Windows: Shift key-up via PIME's filterKeyUp/onKeyUp, with a short "英文" tooltip. The tap detection lives in the core (ShiftTapDetector / shift_tap.py) with tests on both sides. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -6,14 +6,16 @@ tests); this file only translates PIME key events and replies.
|
||||
"""
|
||||
import json
|
||||
import os
|
||||
import time
|
||||
|
||||
from keycodes import * # noqa: F401,F403 (VK_* constants, provided by PIME)
|
||||
from textService import TextService
|
||||
|
||||
from .core.classifier import Classifier, LearnedPreferences
|
||||
from .core.engine import BACKSPACE, DOWN, ENTER, ESCAPE, LEFT, RIGHT, TAB, UP, CompositionEngine
|
||||
from .core.engine import BACKSPACE, DOWN, ENTER, ESCAPE, LEFT, RIGHT, SHIFT_TAP, TAB, UP, CompositionEngine
|
||||
from .core.english import EnglishModel
|
||||
from .core.lexicon import Lexicon
|
||||
from .core.shift_tap import ShiftTapDetector
|
||||
|
||||
_HERE = os.path.dirname(os.path.abspath(__file__))
|
||||
_DATA = os.path.join(_HERE, "data")
|
||||
@@ -67,6 +69,7 @@ class AutoZhuyinTextService(TextService):
|
||||
def __init__(self, client):
|
||||
TextService.__init__(self, client)
|
||||
self.engine = CompositionEngine(_shared_classifier())
|
||||
self.shift_tap = ShiftTapDetector()
|
||||
|
||||
# --- lifecycle ---
|
||||
|
||||
@@ -105,6 +108,13 @@ class AutoZhuyinTextService(TextService):
|
||||
return bool(self.engine.keys or self.engine.candidates)
|
||||
|
||||
def filterKeyDown(self, ev):
|
||||
if ev.keyCode == VK_SHIFT: # noqa: F405
|
||||
if ev.isKeyDown(VK_CONTROL) or ev.isKeyDown(VK_MENU): # noqa: F405
|
||||
self.shift_tap.key_pressed()
|
||||
else:
|
||||
self.shift_tap.shift_down(time.monotonic())
|
||||
return False
|
||||
self.shift_tap.key_pressed()
|
||||
# Shortcuts (Ctrl/Alt) go to the app.
|
||||
if ev.isKeyDown(VK_CONTROL) or ev.isKeyDown(VK_MENU): # noqa: F405
|
||||
return False
|
||||
@@ -121,6 +131,21 @@ class AutoZhuyinTextService(TextService):
|
||||
self._update(commit)
|
||||
return handled
|
||||
|
||||
def filterKeyUp(self, ev):
|
||||
# Shift pressed and released alone: next word is English (or flip the current one).
|
||||
if ev.keyCode == VK_SHIFT: # noqa: F405
|
||||
return self.shift_tap.shift_up(time.monotonic())
|
||||
return False
|
||||
|
||||
def onKeyUp(self, ev):
|
||||
if ev.keyCode != VK_SHIFT: # noqa: F405
|
||||
return False
|
||||
self.engine.handle(SHIFT_TAP)
|
||||
self._update(None)
|
||||
if self.engine.english_armed:
|
||||
self.showMessage("英文", 1)
|
||||
return True
|
||||
|
||||
# --- replies ---
|
||||
|
||||
def _update(self, commit):
|
||||
|
||||
@@ -12,7 +12,8 @@ from .lexicon import Converter
|
||||
|
||||
BACKSPACE, ENTER, ESCAPE, TAB = "<backspace>", "<enter>", "<escape>", "<tab>"
|
||||
UP, DOWN, LEFT, RIGHT = "<up>", "<down>", "<left>", "<right>"
|
||||
SPECIAL_KEYS = {BACKSPACE, ENTER, ESCAPE, TAB, UP, DOWN, LEFT, RIGHT}
|
||||
SHIFT_TAP = "<shift-tap>" # Shift pressed and released on its own
|
||||
SPECIAL_KEYS = {BACKSPACE, ENTER, ESCAPE, TAB, UP, DOWN, LEFT, RIGHT, SHIFT_TAP}
|
||||
|
||||
FULLWIDTH = {
|
||||
"<": ",", ">": "。", "?": "?", "!": "!", ":": ":", '"': "「", "(": "(", ")": ")",
|
||||
@@ -33,6 +34,9 @@ class CompositionEngine:
|
||||
self.now = now
|
||||
self.keys = []
|
||||
self.forced_mode = None
|
||||
# True when forced_mode corrects the classifier (learned on commit); False when the
|
||||
# user forced English before typing (Shift tap on an empty buffer).
|
||||
self._forced_is_correction = False
|
||||
self.fixed = {} # zhuyin segment start -> {(syl_start, syl_end): text}
|
||||
self.candidates = []
|
||||
self.candidate_index = 0
|
||||
@@ -102,9 +106,18 @@ class CompositionEngine:
|
||||
|
||||
# --- key handling ---
|
||||
|
||||
@property
|
||||
def english_armed(self):
|
||||
"""True while the user has forced English before typing anything (Shift tap)."""
|
||||
return not self.keys and self.forced_mode == LITERAL
|
||||
|
||||
def _flip(self):
|
||||
self.forced_mode = LITERAL if self.mode == ZHUYIN else ZHUYIN
|
||||
self._forced_is_correction = True
|
||||
|
||||
def wants(self, key):
|
||||
"""Whether handle(key) would consume the key, without changing state."""
|
||||
if self.candidates:
|
||||
if self.candidates or key == SHIFT_TAP:
|
||||
return True
|
||||
if key in SPECIAL_KEYS:
|
||||
return bool(self.keys)
|
||||
@@ -125,7 +138,10 @@ class CompositionEngine:
|
||||
self.keys.pop()
|
||||
self.fixed = {k: v for k, v in self.fixed.items() if k < len(self.keys)}
|
||||
if not self.keys:
|
||||
self.forced_mode = None
|
||||
# A Shift-tap "next word is English" stays armed; a correction is dropped.
|
||||
if self._forced_is_correction:
|
||||
self.forced_mode = None
|
||||
self._forced_is_correction = False
|
||||
self.fixed = {}
|
||||
return CONSUMED
|
||||
if key == ENTER:
|
||||
@@ -138,7 +154,15 @@ class CompositionEngine:
|
||||
if key == TAB:
|
||||
if not self.keys:
|
||||
return PASS
|
||||
self.forced_mode = LITERAL if self.mode == ZHUYIN else ZHUYIN
|
||||
self._flip()
|
||||
return CONSUMED
|
||||
if key == SHIFT_TAP:
|
||||
if not self.keys:
|
||||
# Next word is English, typed as-is. Tap again to cancel.
|
||||
self.forced_mode = None if self.forced_mode == LITERAL else LITERAL
|
||||
self._forced_is_correction = False
|
||||
else:
|
||||
self._flip()
|
||||
return CONSUMED
|
||||
if key == DOWN:
|
||||
if not self.keys:
|
||||
@@ -232,7 +256,7 @@ class CompositionEngine:
|
||||
def _commit(self, segs=None):
|
||||
segs = segs if segs is not None else self.segments
|
||||
text = "".join(self._render(s, True) for s in segs)
|
||||
if self.forced_mode:
|
||||
if self.forced_mode and self._forced_is_correction:
|
||||
self.classifier.learned.record("".join(self.keys), self.forced_mode)
|
||||
self._previous_mode = segs[-1][2] if segs else None
|
||||
self._previous_time = self.now()
|
||||
@@ -245,5 +269,6 @@ class CompositionEngine:
|
||||
def reset(self):
|
||||
self.keys = []
|
||||
self.forced_mode = None
|
||||
self._forced_is_correction = False
|
||||
self.fixed = {}
|
||||
self.candidates = []
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
"""Detects Shift pressed and released on its own. Port of ShiftTapDetector.swift."""
|
||||
|
||||
|
||||
class ShiftTapDetector:
|
||||
max_duration = 0.5
|
||||
|
||||
def __init__(self):
|
||||
self._pressed_at = None
|
||||
self._used = False
|
||||
|
||||
def shift_down(self, time):
|
||||
if self._pressed_at is None: # ignore auto-repeat
|
||||
self._pressed_at = time
|
||||
self._used = False
|
||||
|
||||
def key_pressed(self):
|
||||
"""Any other key while Shift is held: Shift was used as a modifier."""
|
||||
if self._pressed_at is not None:
|
||||
self._used = True
|
||||
|
||||
def shift_up(self, time):
|
||||
"""Returns True when this release completes a Shift tap."""
|
||||
start, self._pressed_at = self._pressed_at, None
|
||||
return start is not None and not self._used and time - start <= self.max_duration
|
||||
@@ -28,7 +28,9 @@
|
||||
Tab 判斷錯了?按 Tab 在中/英之間翻轉,輸入法會記住這次修正
|
||||
↓ 開啟候選字,按數字鍵 1–9 選字
|
||||
Esc 取消組字
|
||||
Shift+字母 強制英文
|
||||
單按 Shift 下一個字強制英文(保持小寫),送出後恢復自動判斷;
|
||||
打到一半時按,同 Tab 整段翻轉。會出現「英文」小提示
|
||||
Shift+字母 打大寫字母(也會強制英文)
|
||||
< > ? ! : 中文語境下自動變成全形 ,。?!:
|
||||
|
||||
注音符號的順序打錯也沒關係,例如 ㄧㄒㄠˇ 會自動變成 ㄒㄧㄠˇ(小)。
|
||||
|
||||
@@ -11,7 +11,8 @@ sys.path.insert(0, os.path.dirname(HERE))
|
||||
|
||||
from autozhuyin.core import bopomofo # noqa: E402
|
||||
from autozhuyin.core.classifier import LITERAL, ZHUYIN, Classifier, LearnedPreferences # noqa: E402
|
||||
from autozhuyin.core.engine import DOWN, ENTER, TAB, CompositionEngine # noqa: E402
|
||||
from autozhuyin.core.engine import DOWN, ENTER, SHIFT_TAP, TAB, BACKSPACE, CompositionEngine # noqa: E402
|
||||
from autozhuyin.core.shift_tap import ShiftTapDetector # noqa: E402
|
||||
from autozhuyin.core.english import EnglishModel # noqa: E402
|
||||
from autozhuyin.core.lexicon import Converter, Lexicon # noqa: E402
|
||||
|
||||
@@ -41,7 +42,7 @@ def make_engine():
|
||||
def type_keys(s, e):
|
||||
out = ""
|
||||
for c in s:
|
||||
key = ENTER if c == "\n" else TAB if c == "\t" else c
|
||||
key = ENTER if c == "\n" else TAB if c == "\t" else SHIFT_TAP if c == "⇧" else c
|
||||
handled, commit = e.handle(key)
|
||||
if commit is not None:
|
||||
out += commit
|
||||
@@ -192,5 +193,46 @@ class MixedSegmentTests(unittest.TestCase):
|
||||
self.assertLess(per_key, 0.05)
|
||||
|
||||
|
||||
class ShiftTapTests(unittest.TestCase):
|
||||
def test_forces_next_word_english_lowercase(self):
|
||||
e = make_engine()
|
||||
self.assertEqual(type_keys("⇧ru ", e), "ru ")
|
||||
self.assertFalse(e.english_armed)
|
||||
self.assertEqual(type_keys("su3cl3\n", e), "你好")
|
||||
|
||||
def test_tap_twice_cancels(self):
|
||||
self.assertEqual(type_keys("⇧⇧su3cl3\n", make_engine()), "你好")
|
||||
|
||||
def test_mid_word_flips_and_learns(self):
|
||||
e = make_engine()
|
||||
type_keys("so", e)
|
||||
e.handle(SHIFT_TAP)
|
||||
self.assertEqual(e.mode, ZHUYIN)
|
||||
type_keys("\n", e)
|
||||
self.assertEqual(e.classifier.learned.weights["so"], 1)
|
||||
|
||||
def test_forcing_before_typing_not_learned(self):
|
||||
e = make_engine()
|
||||
type_keys("⇧hello ", e)
|
||||
self.assertNotIn("hello", e.classifier.learned.weights)
|
||||
|
||||
def test_arming_survives_backspace(self):
|
||||
e = make_engine()
|
||||
type_keys("⇧r", e)
|
||||
e.handle(BACKSPACE)
|
||||
self.assertTrue(e.english_armed)
|
||||
self.assertEqual(type_keys("ru ", e), "ru ")
|
||||
|
||||
def test_detector(self):
|
||||
d = ShiftTapDetector()
|
||||
d.shift_down(0)
|
||||
self.assertTrue(d.shift_up(0.1))
|
||||
d.shift_down(1)
|
||||
d.key_pressed()
|
||||
self.assertFalse(d.shift_up(1.1))
|
||||
d.shift_down(2)
|
||||
self.assertFalse(d.shift_up(3))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
|
||||
@@ -36,6 +36,8 @@ class FakeTextService:
|
||||
def setCandidateList(self, c): self.reply["candidateList"] = c
|
||||
def setCandidateCursor(self, p): self.reply["candidateCursor"] = p
|
||||
|
||||
def showMessage(self, message, duration=3): self.reply["showMessage"] = message
|
||||
|
||||
def setShowCandidates(self, show):
|
||||
self.showCandidates = show
|
||||
self.reply["showCandidates"] = show
|
||||
@@ -51,8 +53,8 @@ VK = {"\n": 0x0D, "\t": 0x09, " ": 0x20, "\b": 0x08, "↓": 0x28}
|
||||
|
||||
class FakeKeyEvent:
|
||||
def __init__(self, ch, shift=False, ctrl=False):
|
||||
self.keyCode = VK.get(ch, ord(ch.upper()) if ch.isalnum() else 0xBA)
|
||||
self.charCode = 0 if ch in ("\n", "\t", "\b", "↓") else ord(ch)
|
||||
self.keyCode = 0x10 if ch == "⇧" else VK.get(ch, ord(ch.upper()) if ch.isalnum() else 0xBA)
|
||||
self.charCode = 0 if ch in ("\n", "\t", "\b", "↓", "⇧") else ord(ch)
|
||||
self.keyStates = [0] * 256
|
||||
if shift:
|
||||
self.keyStates[0x10] = 0x80
|
||||
@@ -74,6 +76,17 @@ def press(svc, ch, **kw):
|
||||
return True, svc.reply
|
||||
|
||||
|
||||
def tap_shift(svc):
|
||||
"""Shift down then up with nothing in between, as PIME delivers it."""
|
||||
svc.reply = {}
|
||||
down = FakeKeyEvent("⇧", shift=True)
|
||||
assert not svc.filterKeyDown(down)
|
||||
up = FakeKeyEvent("⇧")
|
||||
if svc.filterKeyUp(up):
|
||||
svc.onKeyUp(up)
|
||||
return svc.reply
|
||||
|
||||
|
||||
def type_text(svc, text):
|
||||
out = ""
|
||||
for ch in text:
|
||||
@@ -123,5 +136,23 @@ class WrapperTests(unittest.TestCase):
|
||||
self.assertEqual(out + reply.get("commitString", ""), "Hi ")
|
||||
|
||||
|
||||
class ShiftTapWrapperTests(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.svc = AutoZhuyinTextService(client=None)
|
||||
self.svc.onActivate()
|
||||
|
||||
def test_tap_forces_english_lowercase(self):
|
||||
reply = tap_shift(self.svc)
|
||||
self.assertEqual(reply.get("showMessage"), "英文")
|
||||
self.assertEqual(type_text(self.svc, "ru "), "ru ")
|
||||
|
||||
def test_shift_with_letter_is_not_a_tap(self):
|
||||
self.svc.filterKeyDown(FakeKeyEvent("⇧", shift=True))
|
||||
press(self.svc, "H", shift=True)
|
||||
up = FakeKeyEvent("⇧")
|
||||
self.assertFalse(self.svc.filterKeyUp(up))
|
||||
self.assertFalse(self.svc.engine.english_armed)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
|
||||
Reference in New Issue
Block a user