A new show_key kitten

Fixes #3556

kittens/show_key/kitty_mode.py

@@ -2,16 +2,13 @@
 # vim:fileencoding=utf-8
 # License: GPL v3 Copyright: 2018, Kovid Goyal <kovid at kovidgoyal.net>
 
-import sys
-from typing import List
-
 from kitty.key_encoding import (
     ALT, CAPS_LOCK, CTRL, HYPER, META, NUM_LOCK, PRESS, RELEASE, REPEAT, SHIFT,
     SUPER, KeyEvent, encode_key_event
 )
 
-from ..tui.handler import Handler
-from ..tui.loop import Loop
+from kittens.tui.handler import Handler
+from kittens.tui.loop import Loop
 
 
 class KeysHandler(Handler):
@@ -69,12 +66,8 @@ class KeysHandler(Handler):
         self.quit_loop(0)
 
 
-def main(args: List[str]) -> None:
+def main() -> None:
     loop = Loop()
     handler = KeysHandler()
     loop.loop(handler)
     raise SystemExit(loop.return_code)
-
-
-if __name__ == '__main__':
-    main(sys.argv)

kittens/show_key/main.py

@@ -0,0 +1,81 @@
+#!/usr/bin/env python
+# vim:fileencoding=utf-8
+# License: GPLv3 Copyright: 2021, Kovid Goyal <kovid at kovidgoyal.net>
+
+
+import os
+import sys
+from typing import List
+
+from kitty.cli import parse_args
+from kitty.cli_stub import ShowKeyCLIOptions
+from kittens.tui.operations import raw_mode, styled
+
+ctrl_keys = '@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_'
+
+
+def print_key(raw: bytearray) -> None:
+    unix = ''
+    for ch in raw:
+        if ch < len(ctrl_keys):
+            unix += '^' + ctrl_keys[ch]
+        elif ch == 127:
+            unix += '^?'
+        else:
+            unix += chr(ch)
+    print(unix + '\t\t', end='')
+    for ch in raw:
+        x = chr(ch).encode('ascii')
+        print(styled(repr(x)[2:-1], fg='yellow'), end='')
+    print(end='\r\n', flush=True)
+
+
+def read_keys() -> None:
+    fd = sys.stdin.fileno()
+    while True:
+        try:
+            raw = bytearray(os.read(fd, 64))
+        except OSError as err:
+            print(err, file=sys.stderr, flush=True)
+            break
+        if not raw:
+            break
+        print_key(raw)
+        if len(raw) == 1 and raw[0] == 4:
+            break
+
+
+def legacy_main() -> None:
+    print('Press any keys - Ctrl-D will terminate this program', end='\r\n', flush=True)
+    print(styled('UNIX', italic=True, fg='green'), styled('send_text', italic=True, fg='green'), sep='\t\t', end='\r\n')
+
+    with raw_mode():
+        read_keys()
+
+
+OPTIONS = r'''
+--key-mode -m
+default=normal
+type=choices
+choices=normal,application,kitty,unchanged
+The keyboard mode to use when showing keys. "normal" mode is with DECCKM reset and "application" mode is with
+DECCKM set. "kitty" is the full kitty extended keyboard protocol.
+'''.format
+
+
+def main(args: List[str]) -> None:
+    cli_opts, items = parse_args(args[1:], OPTIONS, '', '', 'kitty +kitten clipboard', result_class=ShowKeyCLIOptions)
+    if cli_opts.key_mode == 'kitty':
+        from .kitty_mode import main as kitty_main
+        return kitty_main()
+    if cli_opts.key_mode != 'unchanged':
+        print(end='\x1b[?1' + ('l' if cli_opts.key_mode == 'normal' else 'h'), flush=True)
+    try:
+        return legacy_main()
+    finally:
+        if cli_opts.key_mode != 'unchanged':
+            print(end='\x1b[?1l', flush=True)
+
+
+if __name__ == '__main__':
+    main(sys.argv)