cleanup

Author: jonathanslenders

src/prompt_toolkit/input/win32.py

@@ -81,7 +81,7 @@ def __init__(self, stdin: TextIO | None = None) -> None:
         self._use_virtual_terminal_input = _is_win_vt100_input_enabled()
 
         if self._use_virtual_terminal_input:
-            self.console_input_reader = Vt100InputReader()
+            self.console_input_reader = Vt100ConsoleInputReader()
         else:
             self.console_input_reader = ConsoleInputReader()
 
@@ -135,88 +135,6 @@ def handle(self) -> HANDLE:
         return self.console_input_reader.handle
 
 
-class Vt100InputReader:
-    def __init__(self) -> None:
-        self._fdcon = None
-
-        self._buffer: list[KeyPress] = []  # Buffer to collect the Key objects.
-        self._vt100_parser = Vt100Parser(
-            lambda key_press: self._buffer.append(key_press)
-        )
-
-        # When stdin is a tty, use that handle, otherwise, create a handle from
-        # CONIN$.
-        self.handle: HANDLE
-        if sys.stdin.isatty():
-            self.handle = HANDLE(windll.kernel32.GetStdHandle(STD_INPUT_HANDLE))
-        else:
-            self._fdcon = os.open("CONIN$", os.O_RDWR | os.O_BINARY)
-            self.handle = HANDLE(msvcrt.get_osfhandle(self._fdcon))
-
-    def close(self) -> None:
-        "Close fdcon."
-        if self._fdcon is not None:
-            os.close(self._fdcon)
-
-    def read(self) -> Iterable[KeyPress]:
-        """
-        Return a list of `KeyPress` instances. It won't return anything when
-        there was nothing to read.  (This function doesn't block.)
-
-        http://msdn.microsoft.com/en-us/library/windows/desktop/ms684961(v=vs.85).aspx
-        """
-        max_count = 2048  # Max events to read at the same time.
-
-        read = DWORD(0)
-        arrtype = INPUT_RECORD * max_count
-        input_records = arrtype()
-
-        # Check whether there is some input to read. `ReadConsoleInputW` would
-        # block otherwise.
-        # (Actually, the event loop is responsible to make sure that this
-        # function is only called when there is something to read, but for some
-        # reason this happened in the asyncio_win32 loop, and it's better to be
-        # safe anyway.)
-        if not wait_for_handles([self.handle], timeout=0):
-            return
-
-        # Get next batch of input event.
-        windll.kernel32.ReadConsoleInputW(
-            self.handle, pointer(input_records), max_count, pointer(read)
-        )
-
-        # First, get all the keys from the input buffer, in order to determine
-        # whether we should consider this a paste event or not.
-        for key_data in self._get_keys(read, input_records):
-            self._vt100_parser.feed(key_data)
-
-        # Return result.
-        result = self._buffer
-        self._buffer = []
-        return result
-
-    def _get_keys(
-        self, read: DWORD, input_records: Array[INPUT_RECORD]
-    ) -> Iterator[str]:
-        """
-        Generator that yields `KeyPress` objects from the input records.
-        """
-        for i in range(read.value):
-            ir = input_records[i]
-
-            # Get the right EventType from the EVENT_RECORD.
-            # (For some reason the Windows console application 'cmder'
-            # [http://gooseberrycreative.com/cmder/] can return '0' for
-            # ir.EventType. -- Just ignore that.)
-            if ir.EventType in EventTypes:
-                ev = getattr(ir.Event, EventTypes[ir.EventType])
-
-                # Process if this is a key event. (We also have mouse, menu and
-                # focus events.)
-                if isinstance(ev, KEY_EVENT_RECORD) and ev.KeyDown:
-                    yield ev.uChar.UnicodeChar
-
-
 class ConsoleInputReader:
     """
     :param recognize_paste: When True, try to discover paste actions and turn
@@ -648,6 +566,102 @@ def _handle_mouse(self, ev: MOUSE_EVENT_RECORD) -> list[KeyPress]:
         return [KeyPress(Keys.WindowsMouseEvent, data)]
 
 
+class Vt100ConsoleInputReader:
+    """
+    Similar to `ConsoleInputReader`, but for usage when
+    `ENABLE_VIRTUAL_TERMINAL_INPUT` is enabled. This assumes that Windows sends
+    us the right vt100 escape sequences and we parse those with our vt100
+    parser.
+
+    (Using this instead of `ConsoleInputReader` results in the "data" attribute
+    from the `KeyPress` instances to be more correct in edge cases, because
+    this responds to for instance the terminal being in application cursor keys
+    mode.)
+    """
+
+    def __init__(self) -> None:
+        self._fdcon = None
+
+        self._buffer: list[KeyPress] = []  # Buffer to collect the Key objects.
+        self._vt100_parser = Vt100Parser(
+            lambda key_press: self._buffer.append(key_press)
+        )
+
+        # When stdin is a tty, use that handle, otherwise, create a handle from
+        # CONIN$.
+        self.handle: HANDLE
+        if sys.stdin.isatty():
+            self.handle = HANDLE(windll.kernel32.GetStdHandle(STD_INPUT_HANDLE))
+        else:
+            self._fdcon = os.open("CONIN$", os.O_RDWR | os.O_BINARY)
+            self.handle = HANDLE(msvcrt.get_osfhandle(self._fdcon))
+
+    def close(self) -> None:
+        "Close fdcon."
+        if self._fdcon is not None:
+            os.close(self._fdcon)
+
+    def read(self) -> Iterable[KeyPress]:
+        """
+        Return a list of `KeyPress` instances. It won't return anything when
+        there was nothing to read.  (This function doesn't block.)
+
+        http://msdn.microsoft.com/en-us/library/windows/desktop/ms684961(v=vs.85).aspx
+        """
+        max_count = 2048  # Max events to read at the same time.
+
+        read = DWORD(0)
+        arrtype = INPUT_RECORD * max_count
+        input_records = arrtype()
+
+        # Check whether there is some input to read. `ReadConsoleInputW` would
+        # block otherwise.
+        # (Actually, the event loop is responsible to make sure that this
+        # function is only called when there is something to read, but for some
+        # reason this happened in the asyncio_win32 loop, and it's better to be
+        # safe anyway.)
+        if not wait_for_handles([self.handle], timeout=0):
+            return
+
+        # Get next batch of input event.
+        windll.kernel32.ReadConsoleInputW(
+            self.handle, pointer(input_records), max_count, pointer(read)
+        )
+
+        # First, get all the keys from the input buffer, in order to determine
+        # whether we should consider this a paste event or not.
+        for key_data in self._get_keys(read, input_records):
+            self._vt100_parser.feed(key_data)
+
+        # Return result.
+        result = self._buffer
+        self._buffer = []
+        return result
+
+    def _get_keys(
+        self, read: DWORD, input_records: Array[INPUT_RECORD]
+    ) -> Iterator[str]:
+        """
+        Generator that yields `KeyPress` objects from the input records.
+        """
+        for i in range(read.value):
+            ir = input_records[i]
+
+            # Get the right EventType from the EVENT_RECORD.
+            # (For some reason the Windows console application 'cmder'
+            # [http://gooseberrycreative.com/cmder/] can return '0' for
+            # ir.EventType. -- Just ignore that.)
+            if ir.EventType in EventTypes:
+                ev = getattr(ir.Event, EventTypes[ir.EventType])
+
+                # Process if this is a key event. (We also have mouse, menu and
+                # focus events.)
+                if isinstance(ev, KEY_EVENT_RECORD) and ev.KeyDown:
+                    u_char = ev.uChar.UnicodeChar
+                    if u_char != "\x00":
+                        yield u_char
+
+
 class _Win32Handles:
     """
     Utility to keep track of which handles are connectod to which callbacks.