Merge pull request #5 from tomoemon/keymap

キーコード自体を最初に入れ替える Keymap 対応

Author: tomoemon

src/browser/eventHandler.ts

@@ -4,24 +4,37 @@ import { VirtualKey, VirtualKeys } from "../core/virtualKey";
 
 /**
  * @param target addEventListener,removeEventListener を持つ Window object のような型
- * @param handler キー入力を受け取るハンドラ
+ * @param keyEventHandler キー操作に関するイベントハンドラ
+ * @param options.handleKeyDown キーが押されたときにkeyEventHandlerを呼び出す(default: true)
+ * @param options.handleKeyUp キーが離されたときにkeyEventHandlerを呼び出す(default: false)
+ * @param options.keyMap 入力されたキーを別のキーへ置換するマッピング (default: {})
  * @returns イベントハンドラを解除する関数を返す
  */
 export function activate(
   target: EventTarget,
-  onKeyDown?: (evt: InputEvent) => void,
-  onKeyUp?: (evt: InputEvent) => void,
+  keyEventHandler: (evt: InputEvent) => void,
+  options?: {
+    handleKeyDown?: boolean;
+    handleKeyUp?: boolean;
+    keyMap?: Map<VirtualKey, VirtualKey>,
+  }
 ) {
+  const {
+    handleKeyDown = true,
+    handleKeyUp = false,
+    keyMap = new Map<VirtualKey, VirtualKey>()
+  } = options ?? {};
   const keyboardState = new KeyboardState();
   const keyDownEventHandler = (evt: Event) => {
     const keyStroke = toInputKeyStrokeFromKeyboardEvent(
       "keydown",
-      evt as KeyboardEvent
+      evt as KeyboardEvent,
+      keyMap,
     );
     keyboardState.keydown(keyStroke.key);
-    if (onKeyDown) {
-      const now = new Date();
-      onKeyDown(
+    const now = new Date();
+    if (handleKeyDown) {
+      keyEventHandler(
         new InputEvent(
           keyStroke,
           // キー入力ごとのその時点での KeyboardState を渡す
@@ -34,12 +47,13 @@ export function activate(
   const keyUpEventHandler = (evt: Event) => {
     const keyStroke = toInputKeyStrokeFromKeyboardEvent(
       "keyup",
-      evt as KeyboardEvent
+      evt as KeyboardEvent,
+      keyMap,
     );
     keyboardState.keyup(keyStroke.key);
-    if (onKeyUp) {
+    if (handleKeyUp) {
       const now = new Date();
-      onKeyUp(
+      keyEventHandler(
         new InputEvent(
           keyStroke,
           // キー入力ごとのその時点での KeyboardState を渡す
@@ -59,10 +73,12 @@ export function activate(
 
 function toInputKeyStrokeFromKeyboardEvent(
   evtType: KeyEventType,
-  evt: KeyboardEvent
+  evt: KeyboardEvent,
+  keyMap: Map<VirtualKey, VirtualKey>
 ): InputStroke {
   const vkey = toVirtualKeyFromEventCode(evt.code);
-  return new InputStroke(vkey, evtType);
+  const replaced = keyMap.get(vkey) ?? vkey;
+  return new InputStroke(replaced, evtType);
 }
 
 function toVirtualKeyFromEventCode(code: string): VirtualKey {

src/impl/alphaNumericRule.test.ts

@@ -1,9 +1,9 @@
 import { expect, test } from "vitest";
-import { getAlphaNumericRuleByLayout } from "./alphaNumericRule";
+import { newAlphaNumericRuleByLayout } from "./alphaNumericRule";
 import { loadPresetKeyboardLayoutQwertyJis } from "./defaultKeyboardLayout";
 
 test("import alphaNumericRule", () => {
-  const alphaNumericRule = getAlphaNumericRuleByLayout(
+  const alphaNumericRule = newAlphaNumericRuleByLayout(
     loadPresetKeyboardLayoutQwertyJis()
   );
   expect(alphaNumericRule.entries.length).toBe(96);

src/impl/alphaNumericRule.ts

@@ -1,22 +1,17 @@
 import { KeyboardLayout } from "../core/keyboardLayout";
 import { Rule, RuleEntry } from "../core/rule";
-import { setDefaultFunc } from "../utils/map";
 import { defaultAlphaNumericNormalize } from "./charNormalizer";
 
-const alphaNumericRuleByLayout = new Map<string, Rule>();
-
-export function getAlphaNumericRuleByLayout(
+export function newAlphaNumericRuleByLayout(
   layout: KeyboardLayout
 ): Rule {
-  return setDefaultFunc(alphaNumericRuleByLayout, layout.name, () => {
-    const entries = Array.from(layout.mapping).map(
-      ([key, stroke]) => new RuleEntry([stroke], key, [], false)
-    );
-    return new Rule(
-      "alpha-numeric",
-      entries,
-      layout.modifierGroup,
-      defaultAlphaNumericNormalize
-    );
-  });
+  const entries = Array.from(layout.mapping).map(
+    ([key, stroke]) => new RuleEntry([stroke], key, [], false)
+  );
+  return new Rule(
+    "alpha-numeric",
+    entries,
+    layout.modifierGroup,
+    defaultAlphaNumericNormalize
+  );
 }

src/impl/defaultRules.ts

@@ -4,27 +4,27 @@ import nicola from "../assets/rules/nicola.json";
 import { KeyboardLayout } from "../core/keyboardLayout";
 import { Rule } from "../core/rule";
 import { mergeRule } from "../core/ruleMerger";
-import { getAlphaNumericRuleByLayout } from "./alphaNumericRule";
+import { newAlphaNumericRuleByLayout } from "./alphaNumericRule";
 import { loadJsonRule } from "./jsonRuleLoader";
 import { loadMozcRule } from "./mozcRuleLoader";
 
 export function loadPresetRuleRoman(layout: KeyboardLayout): Rule {
   return mergeRule(
     loadMozcRule("roman", roman, layout),
-    getAlphaNumericRuleByLayout(layout)
+    newAlphaNumericRuleByLayout(layout)
   )
 }
 
 export function loadPresetRuleJisKana(layout: KeyboardLayout): Rule {
   return mergeRule(
     loadJsonRule("jis-kana", jis_kana),
-    getAlphaNumericRuleByLayout(layout)
+    newAlphaNumericRuleByLayout(layout)
   )
 }
 
 export function loadPresetRuleNicola(layout: KeyboardLayout): Rule {
   return mergeRule(
     loadJsonRule("nicola", nicola),
-    getAlphaNumericRuleByLayout(layout)
+    newAlphaNumericRuleByLayout(layout)
   )
 }

src/index.ts

@@ -23,6 +23,7 @@ export { InputResult } from "./core/automaton";
 export { KeyboardGuide, type KeyRect, type KeyTop } from "./impl/keyboardGuide";
 
 export { detectKeyboardLayout } from "./browser/osKeyboardLayout";
+export * from "./impl/alphaNumericRule";
 export * from "./impl/defaultKeyboardLayout";
 export { loadJsonKeyboardLayout } from "./impl/keyboardLayoutLoader";
 

設計ノート.md

@@ -262,6 +262,19 @@ aliasKey という仕様もあったが、これも同様の理由でなしに
 modifierGroup に関しても、入力ルールのエントリ内で使わない場合でも、Shift 等の定義をいちいち記載しておく必要があったが（ここに定義している modifier の中で、各エントリで使われない modifier が unnecesaryModifier の扱いになり、押してはいけない修飾キーになる）、Shift, Control, Alt(Meta) は基本的に modifier として扱って問題ないと思われるため、デフォルトで定義された状態にする。追加で modifierGroup を定義したい場合のみ、json に記載させる。
 → と考えていたが、暗黙的なルールはできるだけない方が後から理解しやすいので、明示する形式に変更する。また、グループに名前をつけて管理する方法も多少 easy にするだけで、仕様の複雑化につながるので、なしにする。
 
+# Keyboard Layout の概念の整理
+
+202502 現在の KeyboardLayout はキーコードから英数記号文字への対応表を意味している
+これとは別で、キーコード自体を入れ替えるような、キーコード to キーコードの対応表も考えられる
+
+後者を KeyMap として、emiel.activate 時に渡す
+eventHandler でブラウザから渡されるキーコードを内部のキーコードに変換しているが、そこからさらに KeyMap を使って変換するようにする。ブラウザから渡されるキーコードから直接変換するものを KeyMap とすることも考えられるが、OS やブラウザの違いによって同じ位置にあるキーでも異なるキーコードが渡されることがあるため、最初にまず emiel 用のキーコードに変換した方が KeyMap が扱いやすくなると考えた。
+
+用途としては、例えば backspace キーや space キー、shift キー等も含めたキーの入れ替えを行う配列で使えそう。
+
+また、前者の名前を KeyCharMap とするような案はあるが、
+OS のキーボード設定等は KeyboardLayout という名前なので、それに対応する概念として、名前は維持する
+
 # 参考資料
 
 Microsoft キーボード入力の概要（真ん中以下にスキャンコード表がある）