Merge pull request #990 from scop/refactor/api-and-naming

refactor: more API naming work

Author: akinomyoga

bash_completion

@@ -932,12 +932,17 @@ _comp_get_words()
     ((${#upvars[@]})) && local "${upvars[@]}" && _comp_upvars "${upargs[@]}"
 }
 
-# If the word-to-complete contains a colon (:), left-trim COMPREPLY items with
-# word-to-complete.
-# With a colon in COMP_WORDBREAKS, words containing
-# colons are always completed as entire words if the word to complete contains
-# a colon.  This function fixes this, by removing the colon-containing-prefix
-# from COMPREPLY items.
+# Generate the specified items after left-trimming with the word-to-complete
+# containing a colon (:).  If the word-to-complete does not contain a colon,
+# this generates the specified items without modifications.
+# @param $@     items to generate
+# @var[in] cur  current word to complete
+#
+# @remarks In Bash, with a colon in COMP_WORDBREAKS, words containing colons
+# are always completed as entire words if the word to complete contains a
+# colon.  This function fixes this behavior by removing the
+# colon-containing-prefix from the items.
+#
 # The preferred solution is to remove the colon (:) from COMP_WORDBREAKS in
 # your .bashrc:
 #
@@ -946,22 +951,32 @@ _comp_get_words()
 #
 # See also: Bash FAQ - E13) Why does filename completion misbehave if a colon
 # appears in the filename? - https://tiswww.case.edu/php/chet/bash/FAQ
+#
+# @since 2.12
+_comp_compgen_ltrim_colon()
+{
+    (($#)) || return 0
+    local -a tmp
+    tmp=("$@")
+    if [[ $cur == *:* && $COMP_WORDBREAKS == *:* ]]; then
+        # Remove colon-word prefix from items
+        local colon_word=${cur%"${cur##*:}"}
+        tmp=("${tmp[@]#"$colon_word"}")
+    fi
+    _comp_compgen -R -- -W '"${tmp[@]}"'
+}
+
+# If the word-to-complete contains a colon (:), left-trim COMPREPLY items with
+# word-to-complete.
+#
 # @param $1 current word to complete (cur)
-# @modifies global array $COMPREPLY
+# @var[in,out] COMPREPLY
 #
 # @since 2.12
 _comp_ltrim_colon_completions()
 {
-    local i=${#COMPREPLY[*]}
-    ((i == 0)) && return 0
-    if [[ $1 == *:* && $COMP_WORDBREAKS == *:* ]]; then
-        # Remove colon-word prefix from COMPREPLY items
-        local colon_word=${1%"${1##*:}"}
-        COMPREPLY=("${COMPREPLY[@]}")
-        while ((i-- > 0)); do
-            COMPREPLY[i]=${COMPREPLY[i]#"$colon_word"}
-        done
-    fi
+    ((${#COMPREPLY[@]})) || return 0
+    _comp_compgen -c "$1" ltrim_colon "${COMPREPLY[@]}"
 } # _comp_ltrim_colon_completions()
 
 # This function quotes the argument in a way so that readline dequoting
@@ -1512,27 +1527,26 @@ _comp_compgen_usage()
 
 # This function completes on signal names (minus the SIG prefix)
 # @param $1 prefix
-# TODO:API: rename per conventions
-_signals()
+_comp_compgen_signals()
 {
     local -a sigs
     _comp_compgen -v sigs -c "SIG${cur#"${1-}"}" -- -P "${1-}" -A signal &&
-        COMPREPLY+=("${sigs[@]/#${1-}SIG/${1-}}")
+        _comp_compgen_set "${sigs[@]/#${1-}SIG/${1-}}"
 }
 
 # This function completes on known mac addresses
 #
-# TODO:API: rename per conventions
-_mac_addresses()
+_comp_compgen_mac_addresses()
 {
     local re='\([A-Fa-f0-9]\{2\}:\)\{5\}[A-Fa-f0-9]\{2\}'
     local PATH="$PATH:/sbin:/usr/sbin"
+    local -a addresses
 
     # Local interfaces
     # - ifconfig on Linux: HWaddr or ether
     # - ifconfig on FreeBSD: ether
     # - ip link: link/ether
-    _comp_split -a COMPREPLY "$(
+    _comp_compgen -v addresses split -- "$(
         {
             LC_ALL=C ifconfig -a || ip -c=never link show || ip link show
         } 2>/dev/null | command sed -ne \
@@ -1543,7 +1557,7 @@ _mac_addresses()
     )"
 
     # ARP cache
-    _comp_split -a COMPREPLY "$(
+    _comp_compgen -av addresses split -- "$(
         {
             arp -an || ip -c=never neigh show || ip neigh show
         } 2>/dev/null | command sed -ne \
@@ -1552,18 +1566,15 @@ _mac_addresses()
     )"
 
     # /etc/ethers
-    _comp_split -a COMPREPLY "$(command sed -ne \
+    _comp_compgen -av addresses split -- "$(command sed -ne \
         "s/^[[:space:]]*\($re\)[[:space:]].*/\1/p" /etc/ethers 2>/dev/null)"
 
-    ((${#COMPREPLY[@]})) &&
-        _comp_compgen -- -W '"${COMPREPLY[@]}"'
-    _comp_ltrim_colon_completions "$cur"
+    _comp_compgen_ltrim_colon "${addresses[@]}"
 }
 
 # This function completes on configured network interfaces
 #
-# TODO:API: rename per conventions
-_configured_interfaces()
+_comp_compgen_configured_interfaces()
 {
     local -a files
     if [[ -f /etc/debian_version ]]; then
@@ -1598,8 +1609,7 @@ _configured_interfaces()
 # -6: IPv6 addresses only
 # -a: All addresses
 #
-# TODO:API: rename per conventions
-_ip_addresses()
+_comp_compgen_ip_addresses()
 {
     local n
     case ${1-} in
@@ -1608,13 +1618,19 @@ _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
@@ -1629,11 +1645,11 @@ _kernel_versions()
 # -a: restrict to active interfaces only
 # -w: restrict to wireless interfaces only
 #
-# TODO:API: rename per conventions
-_available_interfaces()
+_comp_compgen_available_interfaces()
 {
     local PATH=$PATH:/sbin
-    local generated=$({
+    local generated
+    _comp_compgen -v generated split -- "$({
         if [[ ${1-} == -w ]]; then
             iwconfig
         elif [[ ${1-} == -a ]]; then
@@ -1642,9 +1658,8 @@ _available_interfaces()
             ifconfig -a || ip -c=never link show || ip link show
         fi
     } 2>/dev/null | awk \
-        '/^[^ \t]/ { if ($1 ~ /^[0-9]+:/) { print $2 } else { print $1 } }')
-    _comp_split -l COMPREPLY "$generated" &&
-        _comp_compgen -- -W '"${COMPREPLY[@]/%[[:punct:]]/}"'
+        '/^[^ \t]/ { if ($1 ~ /^[0-9]+:/) { print $2 } else { print $1 } }')" &&
+        _comp_compgen -R -- -W '"${generated[@]/%[[:punct:]]/}"'
 }
 
 # Echo number of CPUs, falling back to 1 on failure.

bash_completion.d/000_bash_completion_compat.bash

@@ -9,13 +9,14 @@ _comp_deprecate_func 2.12 _command _comp_command
 _comp_deprecate_func 2.12 _root_command _comp_root_command
 _comp_deprecate_func 2.12 _xfunc _comp_xfunc
 _comp_deprecate_func 2.12 _upvars _comp_upvars
-_comp_deprecate_func 2.12 __reassemble_comp_words_by_ref _comp__reassemble_words
-_comp_deprecate_func 2.12 __get_cword_at_cursor_by_ref \
-    _comp__get_cword_at_cursor
 _comp_deprecate_func 2.12 _get_comp_words_by_ref _comp_get_words
 _comp_deprecate_func 2.12 _longopt _comp_longopt
-_comp_deprecate_func 2.12 _split_longopt _comp__split_longopt
 _comp_deprecate_func 2.12 __ltrim_colon_completions _comp_ltrim_colon_completions
+_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_compgen_available_interfaces
+_comp_deprecate_func 2.12 _configured_interfaces _comp_compgen_configured_interfaces
+_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

completions/_nmcli

@@ -54,7 +54,7 @@ _comp_cmd_nmcli()
             return
             ;;
         iface)
-            _available_interfaces
+            _comp_compgen_available_interfaces
             return
             ;;
         bssid)

completions/arp

@@ -9,7 +9,7 @@ _comp_cmd_arp()
     # shellcheck disable=SC2254
     case $prev in
         --device | -${noargopts}i)
-            _available_interfaces -a
+            _comp_compgen_available_interfaces -a
             return
             ;;
         --protocol | -${noargopts}[Ap])

completions/arping

@@ -10,11 +10,11 @@ _comp_cmd_arping()
             return
             ;;
         -*I)
-            _available_interfaces -a
+            _comp_compgen_available_interfaces -a
             return
             ;;
         -*s)
-            _ip_addresses
+            _comp_compgen_ip_addresses
             return
             ;;
     esac

completions/arpspoof

@@ -7,7 +7,7 @@ _comp_cmd_arpspoof()
 
     case $prev in
         -i)
-            _available_interfaces -a
+            _comp_compgen_available_interfaces -a
             return
             ;;
         -t)

completions/brctl

@@ -26,7 +26,7 @@ _comp_cmd_brctl()
         3)
             case $command in
                 addif | delif)
-                    _configured_interfaces
+                    _comp_compgen_configured_interfaces
                     ;;
                 stp)
                     _comp_compgen -- -W 'on off'

completions/curl

@@ -67,7 +67,7 @@ _comp_cmd_curl()
             return
             ;;
         --dns-ipv[46]-addr)
-            _ip_addresses -"${prev:9:1}"
+            _comp_compgen_ip_addresses -"${prev:9:1}"
             return
             ;;
         --dns-servers | --noproxy)
@@ -85,9 +85,9 @@ _comp_cmd_curl()
             return
             ;;
         --ftp-port | -${noargopts}P)
-            _available_interfaces -a
+            _comp_compgen_available_interfaces -a
             _known_hosts_real -- "$cur"
-            _ip_addresses -a
+            _comp_compgen -a ip_addresses -a
             return
             ;;
         --ftp-method)
@@ -99,7 +99,7 @@ _comp_cmd_curl()
             return
             ;;
         --interface)
-            _available_interfaces -a
+            _comp_compgen_available_interfaces -a
             return
             ;;
         --help | -${noargopts}h)

completions/dhclient

@@ -26,7 +26,7 @@ _comp_cmd_dhclient()
     if [[ $cur == -* ]]; then
         _comp_compgen_usage
     else
-        _available_interfaces
+        _comp_compgen_available_interfaces
     fi
 } &&
     complete -F _comp_cmd_dhclient dhclient

completions/dnsspoof

@@ -7,7 +7,7 @@ _comp_cmd_dnsspoof()
 
     case $prev in
         -i)
-            _available_interfaces -a
+            _comp_compgen_available_interfaces -a
             return
             ;;
         -f)