feat(keycode): add code property to parse result (#182)

c4spar · Apr 17, 2021 · 366683f · 366683f
1 parent b9eb39b
commit 366683f
Show file tree

Hide file tree

Showing 3 changed files with 122 additions and 1 deletion.
diff --git a/keycode/key_code.ts b/keycode/key_code.ts
@@ -81,6 +81,7 @@ export class KeyCode {
         ctrl: false,
         meta: false,
         shift: false,
+        code: undefined,
       };
 
       if (ch === kEscape && hasNext()) {
@@ -191,6 +192,7 @@ export class KeyCode {
         key.ctrl = !!(modifier & 4);
         key.meta = !!(modifier & 10);
         key.shift = !!(modifier & 1);
+        key.code = code;
 
         // Parse the key itself
         if (code in KeyMap) {

diff --git a/keycode/key_event.ts b/keycode/key_event.ts
@@ -2,6 +2,7 @@
 export interface IKey {
   name?: string;
   sequence?: string;
+  code?: string;
   ctrl: boolean;
   meta: boolean;
   shift: boolean;
@@ -12,6 +13,7 @@ export class KeyEvent {
   protected constructor(
     public readonly name: string | undefined,
     public readonly sequence: string | undefined,
+    public readonly code: string | undefined,
     public readonly ctrl = false,
     public readonly meta = false,
     public readonly shift = false,
@@ -25,6 +27,7 @@ export class KeyEvent {
     return new this(
       key.name,
       key.sequence,
+      key.code,
       key.ctrl,
       key.meta,
       key.shift,

diff --git a/keycode/test/key_code_test.ts b/keycode/test/key_code_test.ts
@@ -11,8 +11,9 @@ import type { IKey, KeyEvent } from "../key_event.ts";
 const ESC = "\x1B";
 
 const defaults = <IKey> {
-  sequence: undefined,
   name: undefined,
+  sequence: undefined,
+  code: undefined,
   ctrl: false,
   meta: false,
   shift: false,
@@ -94,6 +95,7 @@ for (const code of Object.keys(KeyMap)) {
         ...defaults,
         name,
         sequence: ESC + code,
+        code,
       }],
     );
   });
@@ -111,6 +113,7 @@ for (const code of Object.keys(KeyMapShift)) {
         ...defaults,
         name,
         sequence: ESC + code,
+        code,
         shift: true,
       }],
     );
@@ -129,6 +132,7 @@ for (const code of Object.keys(KeyMapCtrl)) {
         ...defaults,
         name,
         sequence: ESC + code,
+        code,
         ctrl: true,
       }],
     );
@@ -155,3 +159,115 @@ Deno.test(`keycode - parse string - abc`, function () {
     }],
   );
 });
+
+Deno.test("keycode - xterm/gnome ESC [ letter (with modifiers)", function () {
+  const keys = KeyCode.parse(
+    "\x1b[2P\x1b[3P\x1b[4P\x1b[5P\x1b[6P\x1b[7P\x1b[8P\x1b[3Q\x1b[8Q\x1b[3R\x1b[8R\x1b[3S\x1b[8S",
+  );
+  assertEquals(keys, [
+    {
+      name: "f1",
+      sequence: "\x1b[2P",
+      code: "[P",
+      shift: true,
+      meta: false,
+      ctrl: false,
+    },
+    {
+      name: "f1",
+      sequence: "\x1b[3P",
+      code: "[P",
+      shift: false,
+      meta: true,
+      ctrl: false,
+    },
+    {
+      name: "f1",
+      sequence: "\x1b[4P",
+      code: "[P",
+      shift: true,
+      meta: true,
+      ctrl: false,
+    },
+    {
+      name: "f1",
+      sequence: "\x1b[5P",
+      code: "[P",
+      shift: false,
+      meta: false,
+      ctrl: true,
+    },
+    {
+      name: "f1",
+      sequence: "\x1b[6P",
+      code: "[P",
+      shift: true,
+      meta: false,
+      ctrl: true,
+    },
+    {
+      name: "f1",
+      sequence: "\x1b[7P",
+      code: "[P",
+      shift: false,
+      meta: true,
+      ctrl: true,
+    },
+    {
+      name: "f1",
+      sequence: "\x1b[8P",
+      code: "[P",
+      shift: true,
+      meta: true,
+      ctrl: true,
+    },
+    {
+      name: "f2",
+      sequence: "\x1b[3Q",
+      code: "[Q",
+      shift: false,
+      meta: true,
+      ctrl: false,
+    },
+    {
+      name: "f2",
+      sequence: "\x1b[8Q",
+      code: "[Q",
+      shift: true,
+      meta: true,
+      ctrl: true,
+    },
+    {
+      name: "f3",
+      sequence: "\x1b[3R",
+      code: "[R",
+      shift: false,
+      meta: true,
+      ctrl: false,
+    },
+    {
+      name: "f3",
+      sequence: "\x1b[8R",
+      code: "[R",
+      shift: true,
+      meta: true,
+      ctrl: true,
+    },
+    {
+      name: "f4",
+      sequence: "\x1b[3S",
+      code: "[S",
+      shift: false,
+      meta: true,
+      ctrl: false,
+    },
+    {
+      name: "f4",
+      sequence: "\x1b[8S",
+      code: "[S",
+      shift: true,
+      meta: true,
+      ctrl: true,
+    },
+  ]);
+});