refactor(_comp_ip_addresses): turn into a generator

akinomyoga · akinomyoga · commit d651a8907b57 · 2023-05-31T14:06:43.000+09:00
diff --git a/bash_completion b/bash_completion
@@ -1523,7 +1523,7 @@ _comp_compgen_configured_interfaces()
 # -6: IPv6 addresses only
 # -a: All addresses
 #
-_comp_ip_addresses()
+_comp_compgen_ip_addresses()
 {
     local n
     case ${1-} in
@@ -1532,13 +1532,19 @@ _comp_ip_addresses()
         *) n= ;;
     esac
     local PATH=$PATH:/sbin
-    local addrs=$({
+    local addrs
+    _comp_compgen -v addrs split -- "$({
         LC_ALL=C ifconfig -a || ip -c=never addr show || ip addr show
     } 2>/dev/null |
         command sed -e 's/[[:space:]]addr:/ /' -ne \
-            "s|.*inet${n}[[:space:]]\{1,\}\([^[:space:]/]*\).*|\1|p")
-    _comp_compgen -a -- -W "$addrs"
-    [[ ! $n ]] || _comp_ltrim_colon_completions "$cur"
+            "s|.*inet${n}[[:space:]]\{1,\}\([^[:space:]/]*\).*|\1|p")" ||
+        return
+
+    if [[ ! $n ]]; then
+        _comp_compgen -R -- -W '"${addrs[@]}"'
+    else
+        _comp_compgen_ltrim_colon "${addrs[@]}"
+    fi
 }
 
 # This function completes on available kernels
diff --git a/bash_completion.d/000_bash_completion_compat.bash b/bash_completion.d/000_bash_completion_compat.bash
@@ -16,7 +16,7 @@ _comp_deprecate_func 2.12 _signals _comp_compgen_signals
 _comp_deprecate_func 2.12 _mac_addresses _comp_compgen_mac_addresses
 _comp_deprecate_func 2.12 _available_interfaces _comp_available_interfaces
 _comp_deprecate_func 2.12 _configured_interfaces _comp_compgen_configured_interfaces
-_comp_deprecate_func 2.12 _ip_addresses _comp_ip_addresses
+_comp_deprecate_func 2.12 _ip_addresses _comp_compgen_ip_addresses
 
 # Backwards compatibility for compat completions that use have().
 # @deprecated 1.90 should no longer be used; generally not needed with
diff --git a/completions/arping b/completions/arping
@@ -14,7 +14,7 @@ _comp_cmd_arping()
             return
             ;;
         -*s)
-            _comp_ip_addresses
+            _comp_compgen_ip_addresses
             return
             ;;
     esac
diff --git a/completions/curl b/completions/curl
@@ -67,7 +67,7 @@ _comp_cmd_curl()
             return
             ;;
         --dns-ipv[46]-addr)
-            _comp_ip_addresses -"${prev:9:1}"
+            _comp_compgen_ip_addresses -"${prev:9:1}"
             return
             ;;
         --dns-servers | --noproxy)
@@ -87,7 +87,7 @@ _comp_cmd_curl()
         --ftp-port | -${noargopts}P)
             _comp_available_interfaces -a
             _known_hosts_real -- "$cur"
-            _comp_ip_addresses -a
+            _comp_compgen -a ip_addresses -a
             return
             ;;
         --ftp-method)
diff --git a/completions/hddtemp b/completions/hddtemp
@@ -13,7 +13,7 @@ _comp_cmd_hddtemp()
             return
             ;;
         --listen | -${noargopts}l)
-            _comp_ip_addresses
+            _comp_compgen_ip_addresses
             return
             ;;
         --unit | -${noargopts}u)
diff --git a/completions/iperf b/completions/iperf
@@ -36,7 +36,7 @@ _comp_cmd_iperf()
             ;;
         --bind | -${noargopts}B)
             _comp_available_interfaces -a
-            _comp_ip_addresses -a
+            _comp_compgen -a ip_addresses -a
             return
             ;;
         --bind-dev)
diff --git a/completions/links b/completions/links
@@ -42,11 +42,11 @@ _comp_cmd_links()
             return
             ;;
         -bind-address)
-            _comp_ip_addresses
+            _comp_compgen_ip_addresses
             return
             ;;
         -bind-address-ipv6)
-            _comp_ip_addresses -6
+            _comp_compgen_ip_addresses -6
             return
             ;;
         -async-dns | -download-utime | -aggressive-cache | -only-proxies | \
diff --git a/completions/nc b/completions/nc
@@ -11,9 +11,9 @@ _comp_cmd_nc()
             ;;
         -*s)
             if [[ ${words[*]} == *-6* ]]; then
-                _comp_ip_addresses -6
+                _comp_compgen_ip_addresses -6
             else
-                _comp_ip_addresses
+                _comp_compgen_ip_addresses
             fi
             return
             ;;
diff --git a/completions/ping b/completions/ping
@@ -40,7 +40,7 @@ _comp_cmd_ping()
             ;;
         -*S)
             # Socket sndbuf in Linux, source IP in FreeBSD
-            [[ $OSTYPE == *bsd* ]] && _comp_ip_addresses
+            [[ $OSTYPE == *bsd* ]] && _comp_compgen_ip_addresses
             return
             ;;
         -*T)
diff --git a/completions/ssh b/completions/ssh
@@ -132,7 +132,7 @@ _comp_cmd_ssh__suboption()
             _comp_compgen -- -W 'any inet inet6'
             ;;
         bindaddress)
-            _comp_ip_addresses
+            _comp_compgen_ip_addresses
             ;;
         canonicalizehostname)
             _comp_compgen -- -W 'yes no always'
@@ -304,7 +304,7 @@ _comp_cmd_ssh()
             return
             ;;
         -*b)
-            _comp_ip_addresses
+            _comp_compgen_ip_addresses
             return
             ;;
         -*c)
diff --git a/completions/wget b/completions/wget
@@ -16,7 +16,7 @@ _comp_cmd_wget()
             return
             ;;
         --bind-address)
-            _comp_ip_addresses
+            _comp_compgen_ip_addresses
             return
             ;;
         --domains | --exclude-domains | -${noargopts}D)
diff --git a/test/t/unit/test_unit_ip_addresses.py b/test/t/unit/test_unit_ip_addresses.py
@@ -10,40 +10,40 @@ def functions(self, request, bash):
         assert_bash_exec(
             bash,
             "_ia() { local cur;_comp_get_words cur;"
-            "unset -v COMPREPLY;_comp_ip_addresses; }",
+            "unset -v COMPREPLY;_comp_compgen_ip_addresses; }",
         )
         assert_bash_exec(bash, "complete -F _ia ia")
         assert_bash_exec(
             bash,
             "_iaa() { local cur;_comp_get_words cur;"
-            "unset -v COMPREPLY;_comp_ip_addresses -a; }",
+            "unset -v COMPREPLY;_comp_compgen_ip_addresses -a; }",
         )
         assert_bash_exec(bash, "complete -F _iaa iaa")
         assert_bash_exec(
             bash,
             " _ia6() { local cur;_comp_get_words cur;"
-            "unset -v COMPREPLY;_comp_ip_addresses -6; }",
+            "unset -v COMPREPLY;_comp_compgen_ip_addresses -6; }",
         )
         assert_bash_exec(bash, "complete -F _ia6 ia6")
 
     def test_1(self, bash):
-        assert_bash_exec(bash, "_comp_ip_addresses")
+        assert_bash_exec(bash, "_comp_compgen_ip_addresses")
 
     @pytest.mark.complete("iaa ")
     def test_2(self, functions, completion):
-        """_comp_ip_addresses -a should complete ip addresses."""
+        """_comp_compgen_ip_addresses -a should complete ip addresses."""
         assert completion
         assert all("." in x or ":" in x for x in completion)
 
     @pytest.mark.complete("ia ")
     def test_3(self, functions, completion):
-        """_comp_ip_addresses should complete ipv4 addresses."""
+        """_comp_compgen_ip_addresses should complete ipv4 addresses."""
         assert completion
         assert all("." in x for x in completion)
 
     @pytest.mark.xfail(in_container(), reason="Probably fails in a container")
     @pytest.mark.complete("ia6 ")
     def test_4(self, functions, completion):
-        """_comp_ip_addresses -6 should complete ipv6 addresses."""
+        """_comp_compgen_ip_addresses -6 should complete ipv6 addresses."""
         assert completion
         assert all(":" in x for x in completion)
