[PATCH v4 0/1] MR8573: cmd: tab completion: Treat most delimiters as literals if user specified quotes.

[Joe Souza (＠JoeS209)]

Fix tab completion for commands like:
```
cd "[2025] Tax Documents"
```
while still allowing tab completion for commands like:
```
copy file1+file2 file3
```
to work.

Without this change, tab completion for cd "[2025] Tax Documents" yields cd "[2025][2025] Tax Documents".  Completed text is inserted into the incorrect location due to the closing ']' which was erroneously interpreted as a delimiter before this change.

--
  v4: cmd: tab completion: Treat most delimiters as literals if user specified quotes.
 
https://gitlab.winehq.org/wine/wine/-/merge_requests/8573

[PATCH v4 1/1] cmd: tab completion: Treat most delimiters as literals if user specified quotes.

[Joe Souza]

From: Joe Souza <jsouza(a)yahoo.com>

---
 programs/cmd/wcmdmain.c | 118 +++++++++++++++++++++++++---------------
 1 file changed, 73 insertions(+), 45 deletions(-)

diff --git a/programs/cmd/wcmdmain.c b/programs/cmd/wcmdmain.c
index fbec86a481a..dd4e0b99428 100644
--- a/programs/cmd/wcmdmain.c
+++ b/programs/cmd/wcmdmain.c
@@ -137,49 +137,52 @@ static void build_search_string(WCHAR *inputBuffer, int len, SEARCH_CONTEXT *sc)
 
     sc->searchstr[0] = L'\0';
 
-    /* If inputBuffer ends in one of our delimiters then use that as the search
-     * pos (i.e. a wildcard search).
-     * Otherwise, parse the buffer to find the last parameter in the buffer,
-     * where tab was pressed.
+    /* Handle spaces in directory names.  Need to quote paths if they contain spaces.
+     * Also, there can be multiple quoted paths on a command line, so find the current
+     * one.
      */
-    if (len && wcschr(PATH_SEPARATION_DELIMS, inputBuffer[len-1])) {
-        cc = len;
-    } else {
-        /* Handle spaces in directory names.  Need to quote paths if they contain spaces.
-         * Also, there can be multiple quoted paths on a command line, so find the current
-         * one.
-         */
-        do {
-            last_param = param;
-            if (stripped_copy) {
-                wcsncpy_s(last_stripped_copy, ARRAY_SIZE(last_stripped_copy), stripped_copy, _TRUNCATE);
-            }
-            stripped_copy = WCMD_parameter_with_delims(inputBuffer, nn++, ¶m, FALSE, FALSE, PATH_SEPARATION_DELIMS);
-        } while (param);
-
-        if (last_param) {
-            cc = last_param - inputBuffer;
+    do {
+        last_param = param;
+        if (stripped_copy) {
+            wcsncpy_s(last_stripped_copy, ARRAY_SIZE(last_stripped_copy), stripped_copy, _TRUNCATE);
         }
+        stripped_copy = WCMD_parameter_with_delims(inputBuffer, nn++, ¶m, FALSE, FALSE, PATH_SEPARATION_DELIMS);
+    } while (param);
 
-        if (inputBuffer[cc] == L'\"') {
-            sc->user_specified_quotes = TRUE;
-            sc->have_quotes = TRUE;
-            cc++;
-        }
+    if (last_param) {
+        cc = last_param - inputBuffer;
+    }
 
-        if (last_stripped_copy[0]) {
-            /* We used the stripped version of the path for the search string, and also use
-             * it to replace the user's text in case and only if we find a match.
-             * It's legal to have quotes in strange places in the path, and WCMD_parameter
-             * removes them for us.
-             */
-            wcsncpy_s(sc->searchstr, ARRAY_SIZE(sc->searchstr), last_stripped_copy, _TRUNCATE);
-            if (wcschr(sc->searchstr, L'?') || wcschr(sc->searchstr, L'*')) {
-                need_wildcard = FALSE;
-            }
+    if (inputBuffer[cc] == L'\"') {
+        sc->user_specified_quotes = TRUE;
+        sc->have_quotes = TRUE;
+        cc++;
+    }
+
+    if (last_stripped_copy[0]) {
+        /* We used the stripped version of the path for the search string, and also use
+         * it to replace the user's text in case and only if we find a match.
+         * It's legal to have quotes in strange places in the path, and WCMD_parameter
+         * removes them for us.
+         */
+        wcsncpy_s(sc->searchstr, ARRAY_SIZE(sc->searchstr), last_stripped_copy, _TRUNCATE);
+        if (wcschr(sc->searchstr, L'?') || wcschr(sc->searchstr, L'*')) {
+            need_wildcard = FALSE;
         }
     }
 
+    /* If the user specified quotes then we treat delimiters in the path as literals and ignore them.
+     * Otherwise if inputBuffer ends in one of our delimiters then override the parsing above and use
+     * that as the search pos (i.e. a wildcard search).
+     * We do this after the parsing because the parsing is needed to determine if the user specified
+     * quotes on the current path that is subject to tab completion.
+     */
+    if (!sc->user_specified_quotes && len && wcschr(PATH_SEPARATION_DELIMS, inputBuffer[len-1])) {
+        cc = len;
+        sc->searchstr[0] = L'\0';
+        need_wildcard = TRUE;
+    }
+
     sc->search_pos = cc;
     if (need_wildcard) {
         wcsncat_s(sc->searchstr, ARRAY_SIZE(sc->searchstr), L"*", _TRUNCATE);
@@ -193,12 +196,25 @@ static void find_insert_pos(const WCHAR *inputBuffer, int len, SEARCH_CONTEXT *s
     /* Handle paths here.  Find last '\\' or other delimiter.
      * If not found then insert pos is the same as search pos.
      */
-    while (cc > sc->search_pos && !wcschr(INTRA_PATH_DELIMS, inputBuffer[cc])) {
-        cc--;
-    }
+    if (sc->user_specified_quotes) {
+        /* If the user specified quotes then treat the usual delimiters as literals
+         * and ignore them.
+         */
+        while (cc > sc->search_pos && inputBuffer[cc] != L'\\') {
+            cc--;
+        }
 
-    if (inputBuffer[cc] == L'\"' || wcschr(INTRA_PATH_DELIMS, inputBuffer[cc])) {
-        cc++;
+        if (inputBuffer[cc] == L'\"' || inputBuffer[cc] == L'\\') {
+            cc++;
+        }
+    } else {
+        while (cc > sc->search_pos && !wcschr(INTRA_PATH_DELIMS, inputBuffer[cc])) {
+            cc--;
+        }
+
+        if (inputBuffer[cc] == L'\"' || wcschr(INTRA_PATH_DELIMS, inputBuffer[cc])) {
+            cc++;
+        }
     }
 
     sc->insert_pos = cc;
@@ -257,6 +273,18 @@ static void get_next_matching_directory_entry(SEARCH_CONTEXT *sc, BOOL reverse)
     }
 }
 
+static BOOL has_delimiters(WCHAR *path, const WCHAR *delims)
+{
+    BOOL ret = FALSE;
+    int cc = 0;
+
+    while (path[cc] && !ret) {
+        ret = wcschr(delims, path[cc++]) ? TRUE : FALSE;
+    }
+
+    return ret;
+}
+
 static void update_input_buffer(WCHAR *inputBuffer, const DWORD inputBufferLength, SEARCH_CONTEXT *sc)
 {
     BOOL needQuotes = FALSE;
@@ -266,19 +294,19 @@ static void update_input_buffer(WCHAR *inputBuffer, const DWORD inputBufferLengt
     /* We have found the insert position for the results.  Terminate the string here. */
     inputBuffer[sc->insert_pos] = L'\0';
 
-    /* If there are no spaces in the path then we can remove quotes when appending
+    /* If there are no spaces or delimiters in the path then we can remove quotes when appending
      * the search result, unless the search result itself requires them.
      */
-    if (sc->have_quotes && !sc->user_specified_quotes && !wcschr(&inputBuffer[sc->search_pos], L' ')) {
+    if (sc->have_quotes && !sc->user_specified_quotes && !has_delimiters(&inputBuffer[sc->search_pos], PATH_SEPARATION_DELIMS)) {
         TRACE("removeQuotes = TRUE\n");
         removeQuotes = TRUE;
     }
 
     /* Online documentation states that paths or filenames should be quoted if they are long
      * file names or contain spaces.  In practice, modern Windows seems to quote paths/files
-     * only if they contain spaces.
+     * only if they contain spaces or delimiters.
      */
-    needQuotes = wcschr(sc->fd[sc->current_entry].cFileName, L' ') ? TRUE : FALSE;
+    needQuotes = has_delimiters(sc->fd[sc->current_entry].cFileName, PATH_SEPARATION_DELIMS);
     len = lstrlenW(inputBuffer);
     /* Remove starting quotes, if able. */
     if (removeQuotes && !needQuotes) {
-- 
GitLab

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