Merge pull request #978 from scop/feat/no-empty-cmd

scop · web-flow · commit 77074a91d89a · 2023-06-03T08:21:46.000+03:00
feat: no empty command completion if `no_empty_cmd_completion` is on
diff --git a/bash_completion b/bash_completion
@@ -2596,8 +2596,7 @@ _comp_command_offset()
     _comp_get_words cur
 
     if ((COMP_CWORD == 0)); then
-        compopt -o filenames
-        _comp_compgen -- -d -c
+        _comp_compgen_commands
     else
         _comp_dequote "${COMP_WORDS[0]}" || ret=${COMP_WORDS[0]}
         local cmd=$ret compcmd=$ret
@@ -2717,6 +2716,19 @@ _complete_as_root()
     [[ $EUID -eq 0 || ${root_command-} ]]
 }
 
+# Complete on available commands, subject to `no_empty_cmd_completion`.
+# @return True (0) if one or more completions are generated, or otherwise False
+# (1).  Note that it returns 1 even when the completion generation is canceled
+# by `shopt -s no_empty_cmd_completion`.
+#
+# @since 2.12
+_comp_compgen_commands()
+{
+    [[ ! ${cur-} ]] && shopt -q no_empty_cmd_completion && return 1
+    # -o filenames for e.g. spaces in paths to and in command names
+    _comp_compgen -- -c -o plusdirs && compopt -o filenames
+}
+
 # @since 2.12
 _comp_longopt()
 {
diff --git a/completions/_su b/completions/_su
@@ -19,8 +19,7 @@ _comp_cmd_su()
             return
             ;;
         -c | --command | --session-command)
-            compopt -o filenames
-            _comp_compgen -- -d -c
+            _comp_compgen_commands
             return
             ;;
     esac
diff --git a/completions/_svn b/completions/_svn
@@ -38,8 +38,7 @@ _comp_cmd_svn()
                 return
                 ;;
             --editor-cmd | --diff-cmd | --diff3-cmd)
-                compopt -o filenames
-                _comp_compgen -- -c
+                _comp_compgen_commands
                 return
                 ;;
         esac
diff --git a/completions/cpio b/completions/cpio
@@ -22,8 +22,7 @@ _comp_cmd_cpio()
             return
             ;;
         --rsh-command)
-            compopt -o filenames
-            _comp_compgen -- -c
+            _comp_compgen_commands
             return
             ;;
     esac
diff --git a/completions/dpkg b/completions/dpkg
@@ -130,7 +130,7 @@ _comp_cmd_dpkg()
             return
             ;;
         --status-logger)
-            _comp_compgen -- -c
+            _comp_compgen_commands
             return
             ;;
         --verify-format)
diff --git a/completions/fio b/completions/fio
@@ -74,8 +74,7 @@ _comp_cmd_fio()
             return
             ;;
         --trigger | --trigger-remote)
-            compopt -o filenames
-            _comp_compgen -- -c
+            _comp_compgen_commands
             return
             ;;
         --aux-path)
@@ -88,7 +87,7 @@ _comp_cmd_fio()
             return
             ;;
         --exec_postrun | --exec_prerun)
-            _comp_compgen -- -c
+            _comp_compgen_commands
             return
             ;;
         --uid)
diff --git a/completions/firefox b/completions/firefox
@@ -33,7 +33,7 @@ _comp_cmd_firefox()
             return
             ;;
         --debugger | -d)
-            _comp_compgen -- -c
+            _comp_compgen_commands
             return
             ;;
     esac
diff --git a/completions/gdb b/completions/gdb
@@ -20,7 +20,7 @@ _comp_cmd_gdb()
         if _comp_looks_like_path "$cur"; then
             # compgen -c works as expected if $cur contains any slashes.
             local PATH="$PATH:."
-            _comp_compgen -- -d -c
+            _comp_compgen_commands
         else
             # otherwise compgen -c contains Bash's built-in commands,
             # functions and aliases. Thus we need to retrieve the program
diff --git a/completions/man b/completions/man
@@ -29,8 +29,7 @@ _comp_cmd_man()
             return
             ;;
         --pager | -${noargopts}P)
-            compopt -o filenames
-            _comp_compgen -- -c
+            _comp_compgen_commands
             return
             ;;
         --preprocessor | -${noargopts}p)
diff --git a/completions/mr b/completions/mr
@@ -55,7 +55,7 @@ _comp_cmd_mr()
                 return
                 ;;
             run)
-                _comp_compgen -- -c
+                _comp_compgen_commands
                 return
                 ;;
             *)
diff --git a/completions/mussh b/completions/mussh
@@ -39,7 +39,7 @@ _comp_cmd_mussh()
             ;;
         -c)
             compopt -o filenames
-            _comp_compgen -a -- -c
+            _comp_compgen -a commands
             return
             ;;
     esac
diff --git a/completions/mypy b/completions/mypy
@@ -25,7 +25,7 @@ _comp_cmd_mypy()
             return
             ;;
         --python-executable)
-            _comp_compgen -c "${cur:-py}" -- -c
+            _comp_compgen -c "${cur:-py}" commands
             return
             ;;
         --*-dir | --*-report)
diff --git a/completions/perlcritic b/completions/perlcritic
@@ -31,8 +31,7 @@ _comp_cmd_perlcritic()
             return
             ;;
         --pager)
-            compopt -o filenames
-            _comp_compgen -- -c
+            _comp_compgen_commands
             return
             ;;
     esac
diff --git a/completions/protoc b/completions/protoc
@@ -18,10 +18,7 @@ _comp_cmd_protoc()
             return
             ;;
         --plugin)
-            if [[ $cur != *=* ]]; then
-                compopt -o filenames
-                _comp_compgen -- -c
-            fi
+            [[ $cur == *=* ]] || _comp_compgen_commands
             return
             ;;
         --proto_path | --*_out)
diff --git a/completions/querybts b/completions/querybts
@@ -17,8 +17,7 @@ _comp_cmd_querybts()
             return
             ;;
         --mbox-reader-cmd)
-            compopt -o filenames
-            _comp_compgen -- -c
+            _comp_compgen_commands
             return
             ;;
     esac
diff --git a/completions/reportbug b/completions/reportbug
@@ -37,8 +37,7 @@ _comp_cmd_reportbug()
             return
             ;;
         --editor | --mua | --mbox-reader-cmd | -${noargopts}e)
-            compopt -o filenames
-            _comp_compgen -- -c
+            _comp_compgen_commands
             return
             ;;
         --from-buildd)
diff --git a/completions/rpm b/completions/rpm
@@ -89,8 +89,7 @@ _comp_cmd_rpm()
             return
             ;;
         --pipe)
-            compopt -o filenames
-            _comp_compgen -- -c
+            _comp_compgen_commands
             return
             ;;
         --rcfile)
diff --git a/completions/sqlite3 b/completions/sqlite3
@@ -17,8 +17,7 @@ _comp_cmd_sqlite3()
             return
             ;;
         -cmd)
-            compopt -o filenames
-            _comp_compgen -- -c
+            _comp_compgen_commands
             return
             ;;
     esac
diff --git a/completions/ssh b/completions/ssh
@@ -196,7 +196,7 @@ _comp_cmd_ssh__suboption()
             _known_hosts_real -a ${configfile:+-F "$configfile"} -- "$cur"
             ;;
         proxycommand | remotecommand | localcommand)
-            _comp_compgen -- -c
+            _comp_compgen_commands
             ;;
         pubkeyacceptedalgorithms | pubkeyacceptedkeytypes)
             _comp_compgen_split -- "$(_comp_cmd_ssh__query "$1" key)"
@@ -371,7 +371,7 @@ _comp_cmd_ssh()
         _count_args "=" "-*[BbcDeLpRWEFSIiJlmOoQw]"
         if ((args > 1)); then
             compopt -o filenames
-            _comp_compgen -a -- -c
+            _comp_compgen -a commands
         else
             _known_hosts_real ${ipvx-} -a ${configfile:+-F "$configfile"} \
                 -- "$cur"
@@ -424,8 +424,7 @@ _comp_cmd_sftp()
             return
             ;;
         -*S)
-            compopt -o filenames
-            _comp_compgen -- -c
+            _comp_compgen_commands
             return
             ;;
         -*4*)
@@ -574,8 +573,8 @@ _comp_cmd_scp()
             return
             ;;
         -*S)
-            compopt +o nospace -o filenames
-            _comp_compgen -- -c
+            compopt +o nospace
+            _comp_compgen_commands
             return
             ;;
         -*4*)
diff --git a/completions/ssh-keygen b/completions/ssh-keygen
@@ -78,7 +78,7 @@ _comp_cmd_ssh_keygen()
                 case $cur in
                     force-command=*)
                         compopt -o filenames
-                        _comp_compgen -c "${cur#*=}" -- -c
+                        _comp_compgen -c "${cur#*=}" commands
                         ;;
                     checkpoint=* | challenge=* | write-attestation=*)
                         _comp_compgen -c "${cur#*=}" filedir
diff --git a/completions/strace b/completions/strace
@@ -90,7 +90,7 @@ _comp_cmd_strace()
         if [[ $cur == -* ]]; then
             _comp_compgen_help -- -h
         else
-            _comp_compgen -- -c
+            _comp_compgen_commands
         fi
     fi
 } &&
diff --git a/completions/tar b/completions/tar
@@ -560,8 +560,7 @@ _comp_cmd_tar__gnu()
             --to-command | --info-script | --new-volume-script | \
                 --rmt-command | --rsh-command | --use-compress-program | \
                 -${noargopts}[FI])
-                compopt -o filenames
-                _comp_compgen -- -c
+                _comp_compgen_commands
                 break
                 ;;
             --atime-preserve)
diff --git a/completions/tcpdump b/completions/tcpdump
@@ -26,8 +26,7 @@ _comp_cmd_tcpdump()
             return
             ;;
         -${noargopts}z)
-            compopt -o filenames
-            _comp_compgen -- -c
+            _comp_compgen_commands
             return
             ;;
         --relinquish-privileges | -${noargopts}Z)
diff --git a/completions/valgrind b/completions/valgrind
@@ -81,8 +81,7 @@ _comp_cmd_valgrind()
                     return
                     ;;
                 \<command\>)
-                    compopt -o filenames
-                    _comp_compgen -- -c
+                    _comp_compgen_commands
                     return
                     ;;
                 \<+([0-9])..+([0-9])\>)
diff --git a/completions/vpnc b/completions/vpnc
@@ -53,8 +53,7 @@ _vpnc()
             return
             ;;
         --password-helper)
-            compopt -o filenames
-            _comp_compgen -- -c
+            _comp_compgen_commands
             return
             ;;
     esac
diff --git a/doc/configuration.md b/doc/configuration.md
@@ -137,3 +137,13 @@ to have completion for their contents, so the default is unset.
 
 Available since version 2.12.
 Deprecated alias: `COMP_TAR_INTERNAL_PATHS`
+
+## Shell options
+
+### `no_empty_cmd_completion`
+
+If on, completions producing command names do not do anything if the command to
+be completed is empty. This can be useful on systems where generating the
+entire list of commands takes a long time.
+
+Available since version 2.12.
diff --git a/test/t/unit/Makefile.am b/test/t/unit/Makefile.am
@@ -2,6 +2,7 @@ EXTRA_DIST = \
 	test_unit_abspath.py \
 	test_unit_command_offset.py \
 	test_unit_compgen.py \
+	test_unit_compgen_commands.py \
 	test_unit_count_args.py \
 	test_unit_delimited.py \
 	test_unit_deprecate_func.py \
diff --git a/test/t/unit/test_unit_compgen_commands.py b/test/t/unit/test_unit_compgen_commands.py
@@ -0,0 +1,47 @@
+import pytest
+
+from conftest import assert_bash_exec, assert_complete, bash_env_saved
+
+
+@pytest.mark.bashcomp(cmd=None, ignore_env=r"^\+COMPREPLY=")
+class TestUtilCompgenCommands:
+    @pytest.fixture(scope="class")
+    def functions(self, request, bash):
+        assert_bash_exec(
+            bash,
+            r"_comp_compgen_commands__test() {"
+            r"    local COMPREPLY=() cur=${1-};"
+            r"    _comp_compgen_commands;"
+            r'    printf "%s\n" "${COMPREPLY[@]-}";'
+            r"}",
+        )
+        assert_bash_exec(
+            bash,
+            "_comp_cmd_ccc() {"
+            "    local cur;"
+            "    _comp_get_words cur;"
+            "     unset -v COMPREPLY;"
+            "    _comp_compgen_commands;"
+            "}; complete -F _comp_cmd_ccc ccc",
+        )
+
+    def test_basic(self, bash, functions):
+        output = assert_bash_exec(
+            bash, "_comp_compgen_commands__test sh", want_output=True
+        )
+        assert output.strip()
+
+    @pytest.mark.parametrize(
+        "shopt_no_empty,result_empty", ((True, True), (False, False))
+    )
+    def test_empty(self, bash, functions, shopt_no_empty, result_empty):
+        with bash_env_saved(bash) as bash_env:
+            bash_env.shopt("no_empty_cmd_completion", shopt_no_empty)
+            output = assert_bash_exec(
+                bash, "_comp_compgen_commands__test", want_output=True
+            )
+        assert (output.strip() == "") == result_empty
+
+    def test_spaces(self, bash, functions):
+        completion = assert_complete(bash, "ccc shared/default/bar")
+        assert completion == r"\ bar.d/"
