[PATCH v36 0/1] MR7400: cmd: Allow any key to continue past DIR /P pauses.

[Joe Souza (＠JoeS209)]

Current code requires entering a newline character in order to continue past DIR /P prompts.  This change allows any key to be pressed instead.

Code to handle this was similar to existing WCMD_pause() so we leveraged that code for this purpose as well.  Key to the fix was the removal of ENABLE_LINE_INPUT from the console flags, and ENABLE_PROCESSED_INPUT was added in order to preserve the ability to abort the operation via Ctrl-C.

--
  v36: cmd: Allow any key to continue past DIR /P pauses.

https://gitlab.winehq.org/wine/wine/-/merge_requests/7400

[PATCH v36 1/1] cmd: Allow any key to continue past DIR /P pauses.

[Joe Souza]

From: Joe Souza

---
 programs/cmd/builtins.c  | 17 ++------
 programs/cmd/directory.c |  6 +--
 programs/cmd/wcmd.h      |  5 ++-
 programs/cmd/wcmdmain.c  | 86 +++++++++++++++++++++++++++++++++++-----
 4 files changed, 84 insertions(+), 30 deletions(-)

diff --git a/programs/cmd/builtins.c b/programs/cmd/builtins.c
index 5e084f9db92..b78ae9d293b 100644
--- a/programs/cmd/builtins.c
+++ b/programs/cmd/builtins.c
@@ -1954,21 +1954,10 @@ RETURN_CODE WCMD_move(void)
 RETURN_CODE WCMD_pause(void)
 {
   RETURN_CODE return_code = NO_ERROR;
-  DWORD oldmode;
-  BOOL have_console;
-  DWORD count;
-  WCHAR key;
-  HANDLE hIn = GetStdHandle(STD_INPUT_HANDLE);
-
-  have_console = GetConsoleMode(hIn, &oldmode);
-  if (have_console)
-      SetConsoleMode(hIn, 0);
-
   WCMD_output_asis(anykey);
-  if (!WCMD_ReadFile(hIn, &key, 1, &count) || !count)
-      return_code = ERROR_INVALID_FUNCTION;
-  if (have_console)
-    SetConsoleMode(hIn, oldmode);
+  return_code = WCMD_wait_for_input(GetStdHandle(STD_INPUT_HANDLE));
+  WCMD_output_asis(L"\r\n");
+
   return return_code;
 }

diff --git a/programs/cmd/directory.c b/programs/cmd/directory.c
index b7c036efd0d..ac4ecfed2e6 100644
--- a/programs/cmd/directory.c
+++ b/programs/cmd/directory.c
@@ -237,8 +237,6 @@ static void WCMD_getfileowner(WCHAR *filename, WCHAR *owner, int ownerlen) {
  *
  * List a single file directory. This function (and those below it) can be called
  * recursively when the /S switch is used.
- *
- * FIXME: Assumes 24-line display for the /P qualifier.
  */

static RETURN_CODE WCMD_list_directory (DIRECTORY_STACK *inputparms, int level, DIRECTORY_STACK **outputparms) {
@@ -305,7 +303,7 @@ static RETURN_CODE WCMD_list_directory (DIRECTORY_STACK *inputparms, int level,

/* Output the results */
     if (!bare) {
-       if (level != 0 && (entry_count > 0)) WCMD_output_asis(L"\r\n");
+       if (level != 0 && (entry_count > 0)) return_code = WCMD_output_asis(L"\r\n");
        if (!recurse || ((entry_count > 0) && done_header==FALSE)) {
            WCMD_output (L"Directory of %1\n\n", real_path);
            done_header = TRUE;
@@ -427,7 +425,7 @@ static RETURN_CODE WCMD_list_directory (DIRECTORY_STACK *inputparms, int level,
         }
       }
      }
-     if (addNewLine) WCMD_output_asis(L"\r\n");
+     if (addNewLine) return_code = WCMD_output_asis(L"\r\n");
      cur_width = 0;

/* Allow command to be aborted if user presses Ctrl-C.
diff --git a/programs/cmd/wcmd.h b/programs/cmd/wcmd.h
index 225ebd44310..d4adc7fd7c8 100644
--- a/programs/cmd/wcmd.h
+++ b/programs/cmd/wcmd.h
@@ -174,8 +174,8 @@ RETURN_CODE WCMD_move (void);
 WCHAR* WINAPIV WCMD_format_string (const WCHAR *format, ...);
 void WINAPIV WCMD_output (const WCHAR *format, ...);
 void WINAPIV WCMD_output_stderr (const WCHAR *format, ...);
-void WCMD_output_asis (const WCHAR *message);
-void WCMD_output_asis_stderr (const WCHAR *message);
+RETURN_CODE WCMD_output_asis (const WCHAR *message);
+RETURN_CODE WCMD_output_asis_stderr (const WCHAR *message);
 RETURN_CODE WCMD_pause(void);
 RETURN_CODE WCMD_popd(void);
 void WCMD_print_error (void);
@@ -210,6 +210,7 @@ void WCMD_HandleTildeModifiers(WCHAR **start, BOOL atExecute);
 WCHAR *WCMD_strip_quotes(WCHAR *cmd);
 WCHAR *WCMD_LoadMessage(UINT id);
 WCHAR *WCMD_strsubstW(WCHAR *start, const WCHAR* next, const WCHAR* insert, int len);
+RETURN_CODE WCMD_wait_for_input(HANDLE hIn);
 BOOL WCMD_ReadFile(const HANDLE hIn, WCHAR *intoBuf, const DWORD maxChars, LPDWORD charsRead);

enum read_parse_line {RPL_SUCCESS, RPL_EOF, RPL_SYNTAXERROR};
diff --git a/programs/cmd/wcmdmain.c b/programs/cmd/wcmdmain.c
index 77f1112be23..35bf4f7e70a 100644
--- a/programs/cmd/wcmdmain.c
+++ b/programs/cmd/wcmdmain.c
@@ -195,8 +195,9 @@ void WCMD_enter_paged_mode(const WCHAR *msg)
   CONSOLE_SCREEN_BUFFER_INFO consoleInfo;

if (GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &consoleInfo)) {
-    max_height = consoleInfo.dwSize.Y;
-    max_width  = consoleInfo.dwSize.X;
+    /* Use console window dimensions, not screen buffer dimensions. */
+    max_height = consoleInfo.srWindow.Bottom - consoleInfo.srWindow.Top + 1;
+    max_width  = consoleInfo.srWindow.Right - consoleInfo.srWindow.Left + 1;
   } else {
     max_height = 25;
     max_width  = 80;
@@ -213,6 +214,67 @@ void WCMD_leave_paged_mode(void)
   pagedMessage = NULL;
 }

+static BOOL has_pending_char_events(HANDLE h)
+{
+    INPUT_RECORD ir;
+    DWORD count;
+    BOOL ret = FALSE;
+
+    while (!ret && GetNumberOfConsoleInputEvents(h, &count) && count)
+    {
+        /* FIXME could be racy if another thread/process gets the input record */
+        if (ReadConsoleInputA(h, &ir, 1, &count) && count)
+            ret = ir.EventType == KEY_EVENT &&
+                ir.Event.KeyEvent.bKeyDown &&
+                ir.Event.KeyEvent.uChar.AsciiChar;
+    }
+    return ret;
+}
+
+/***************************************************************************
+ * WCMD_wait_for_input
+ *
+ * Wait for input from a console/file.
+ * Used by commands like PAUSE and DIR /P that need to wait for user
+ * input before continuing.
+ */
+RETURN_CODE WCMD_wait_for_input(HANDLE hIn)
+{
+    RETURN_CODE return_code;
+    DWORD oldmode;
+    DWORD count;
+    WCHAR key;
+
+    return_code = ERROR_INVALID_FUNCTION;
+    if (GetConsoleMode(hIn, &oldmode))
+    {
+        HANDLE h[2] = {hIn, control_c_event};
+
+        SetConsoleMode(hIn, oldmode & ~ENABLE_LINE_INPUT);
+        FlushConsoleInputBuffer(hIn);
+        while (return_code == ERROR_INVALID_FUNCTION)
+        {
+            switch (WaitForMultipleObjects(2, h, FALSE, INFINITE))
+            {
+            case WAIT_OBJECT_0:
+                if (has_pending_char_events(hIn))
+                    return_code = NO_ERROR;
+                /* will make both hIn no long signaled, and also process the pending input record */
+                FlushConsoleInputBuffer(hIn);
+                break;
+            case WAIT_OBJECT_0 + 1:
+                return_code = STATUS_CONTROL_C_EXIT;
+                break;
+            default: break;
+            }
+        }
+        SetConsoleMode(hIn, oldmode);
+    }
+    else if (WCMD_ReadFile(hIn, &key, 1, &count))
+        return_code = NO_ERROR;
+    return return_code;
+}
+
 /***************************************************************************
  * WCMD_ReadFile
  *
@@ -243,10 +305,9 @@ BOOL WCMD_ReadFile(const HANDLE hIn, WCHAR *intoBuf, const DWORD maxChars, LPDWO
  *
  * Send output to specified handle without formatting e.g. when message contains '%'
  */
-static void WCMD_output_asis_handle (DWORD std_handle, const WCHAR *message) {
-  DWORD count;
+static RETURN_CODE WCMD_output_asis_handle (DWORD std_handle, const WCHAR *message) {
+  RETURN_CODE return_code = NO_ERROR;
   const WCHAR* ptr;
-  WCHAR string[1024];
   HANDLE handle = GetStdHandle(std_handle);

if (paged_mode) {
@@ -262,12 +323,17 @@ static void WCMD_output_asis_handle (DWORD std_handle, const WCHAR *message) {
       if (++line_count >= max_height - 1) {
         line_count = 0;
         WCMD_output_asis_len(pagedMessage, lstrlenW(pagedMessage), handle);
-        WCMD_ReadFile(GetStdHandle(STD_INPUT_HANDLE), string, ARRAY_SIZE(string), &count);
+        return_code = WCMD_wait_for_input(GetStdHandle(STD_INPUT_HANDLE));
+        WCMD_output_asis_len(L"\r\n", 2, handle);
+        if (return_code)
+          break;
       }
     } while (((message = ptr) != NULL) && (*ptr));
   } else {
     WCMD_output_asis_len(message, lstrlenW(message), handle);
   }
+
+  return return_code;
 }

/*******************************************************************
@@ -276,8 +342,8 @@ static void WCMD_output_asis_handle (DWORD std_handle, const WCHAR *message) {
  * Send output to current standard output device, without formatting
  * e.g. when message contains '%'
  */
-void WCMD_output_asis (const WCHAR *message) {
-    WCMD_output_asis_handle(STD_OUTPUT_HANDLE, message);
+RETURN_CODE WCMD_output_asis (const WCHAR *message) {
+    return WCMD_output_asis_handle(STD_OUTPUT_HANDLE, message);
 }

/*******************************************************************
@@ -286,8 +352,8 @@ void WCMD_output_asis (const WCHAR *message) {
  * Send output to current standard error device, without formatting
  * e.g. when message contains '%'
  */
-void WCMD_output_asis_stderr (const WCHAR *message) {
-    WCMD_output_asis_handle(STD_ERROR_HANDLE, message);
+RETURN_CODE WCMD_output_asis_stderr (const WCHAR *message) {
+    return WCMD_output_asis_handle(STD_ERROR_HANDLE, message);
 }

/****************************************************************************