Merge pull request #12740 from rouault/completion_not_last_term

Bash completion: fix completion of intermediate term

Author: rouault

apps/gdal.cpp

@@ -149,6 +149,35 @@ MAIN_START(argc, argv)
             EQUAL(argv[argc - 1], "last_word_is_complete=true");
         if (STARTS_WITH(argv[argc - 1], "last_word_is_complete="))
             --argc;
+        else if (argc >= 2 && STARTS_WITH(argv[argc - 2], "prev=") &&
+                 STARTS_WITH(argv[argc - 1], "cur="))
+        {
+            const char *pszPrevVal = argv[argc - 2] + strlen("prev=");
+            const char *pszCurVal = argv[argc - 1] + strlen("cur=");
+            std::string osCurVal;
+            const bool bIsPrevValEqual = (strcmp(pszPrevVal, "=") == 0);
+            if (bIsPrevValEqual)
+            {
+                osCurVal = std::string("=").append(pszCurVal);
+                pszCurVal = osCurVal.c_str();
+            }
+            int iMatch = 0;
+            for (int i = 3; i < argc - 1; ++i)
+            {
+                if (bIsPrevValEqual ? (strstr(argv[i], pszCurVal) != nullptr)
+                                    : (strcmp(argv[i], pszCurVal) == 0))
+                {
+                    if (iMatch == 0)
+                        iMatch = i;
+                    else
+                        iMatch = -1;
+                }
+            }
+            if (iMatch > 0)
+                argc = iMatch + 1;
+            else
+                argc -= 2;
+        }
 
         // Process lines like "gdal completion gdal raster last_word_is_complete=true|false"
         EmitCompletion(std::move(alg),

autotest/utilities/test_gdal.py

@@ -297,6 +297,16 @@ def test_gdal_completion_co(gdal_path):
     assert "1" in out
     assert "9" in out
 
+    out = gdaltest.runexternal(
+        f"{gdal_path} completion gdal raster convert --of CO in.tif out.tif prev=of cur=CO"
+    ).split(" ")
+    assert "COG" in out
+
+    out = gdaltest.runexternal(
+        f"{gdal_path} completion gdal raster convert --of=CO in.tif out.tif prev== cur=CO"
+    ).split(" ")
+    assert "COG" in out
+
     out = gdaltest.runexternal(
         f"{gdal_path} completion gdal raster convert --of COG --co="
     ).split(" ")

scripts/completionFinder.py

@@ -291,7 +291,9 @@ def main(argv):
     outFile = argv[1]
     of = open(outFile, "w")
     of.write("# shellcheck shell=bash disable=SC2148\n")
-    of.write("# File auto-generated by completionFinder.py, do not modify manually\n")
+    of.write(
+        "# WARNING: File auto-generated by completionFinder.py, do not modify manually\n"
+    )
     of.write(
         """
 
@@ -307,12 +309,36 @@ def main(argv):
   bashcompinit
 fi
 
+HAS_GET_COMP_WORDS_BY_REF=no
+if [ "$CURRENT_SHELL" = "bash" ]; then
+  function_exists() {
+      declare -f -F "$1" > /dev/null
+      return $?
+  }
+
+  # Checks that bash-completion is recent enough
+  if function_exists _get_comp_words_by_ref; then
+    HAS_GET_COMP_WORDS_BY_REF=yes;
+  fi
+fi
+
 _gdal()
 {
   COMPREPLY=()
   cur="${COMP_WORDS[$COMP_CWORD]}"
 
-  choices=$(gdal completion ${COMP_LINE})
+  if test "$HAS_GET_COMP_WORDS_BY_REF" = "yes"; then
+    local cur prev
+    _get_comp_words_by_ref cur prev
+    if test "$cur" = ""; then
+      extra="last_word_is_complete=true"
+    else
+      extra="prev=${prev} cur=${cur}"
+    fi
+    choices=$(gdal completion ${COMP_LINE} ${extra})
+  else
+    choices=$(gdal completion ${COMP_LINE})
+  fi
   if [ "$CURRENT_SHELL" = "bash" ]; then
     if [[ "$cur" == "=" ]]; then
       mapfile -t COMPREPLY < <(compgen -W "$choices" --)

scripts/gdal-bash-completion.sh

@@ -1,5 +1,6 @@
 # shellcheck shell=bash disable=SC2148
-# File auto-generated by completionFinder.py, do not modify manually
+# WARNING: File auto-generated by completionFinder.py, do not modify manually
+
 
 if ! ps -p $$ >/dev/null 2>/dev/null; then
   # For busybox
@@ -13,12 +14,36 @@ if [ "$CURRENT_SHELL" = "zsh" ]; then
   bashcompinit
 fi
 
+HAS_GET_COMP_WORDS_BY_REF=no
+if [ "$CURRENT_SHELL" = "bash" ]; then
+  function_exists() {
+      declare -f -F "$1" > /dev/null
+      return $?
+  }
+
+  # Checks that bash-completion is recent enough
+  if function_exists _get_comp_words_by_ref; then
+    HAS_GET_COMP_WORDS_BY_REF=yes;
+  fi
+fi
+
 _gdal()
 {
   COMPREPLY=()
   cur="${COMP_WORDS[$COMP_CWORD]}"
 
-  choices=$(gdal completion ${COMP_LINE})
+  if test "$HAS_GET_COMP_WORDS_BY_REF" = "yes"; then
+    local cur prev
+    _get_comp_words_by_ref cur prev
+    if test "$cur" = ""; then
+      extra="last_word_is_complete=true"
+    else
+      extra="prev=${prev} cur=${cur}"
+    fi
+    choices=$(gdal completion ${COMP_LINE} ${extra})
+  else
+    choices=$(gdal completion ${COMP_LINE})
+  fi
   if [ "$CURRENT_SHELL" = "bash" ]; then
     if [[ "$cur" == "=" ]]; then
       mapfile -t COMPREPLY < <(compgen -W "$choices" --)