refactor: simplify function names of the _comp_get_comp_words family

* rename `_comp_get{_comp => }_words{_by_ref => }`
* rename `_comp__reassemble{_comp => }_words{_by_ref => }`
* rename `_comp__get_cword_at_cursor{_by_ref => }`

Author: akinomyoga

bash_completion

@@ -394,7 +394,7 @@ _comp_looks_like_path()
 # @param $2 words  Name of variable to return words to
 # @param $3 cword  Name of variable to return cword to
 #
-_comp__reassemble_comp_words_by_ref()
+_comp__reassemble_words()
 {
     local exclude i j line ref
     # Exclude word separator characters?
@@ -454,7 +454,7 @@ _comp__reassemble_comp_words_by_ref()
             printf -v "$2[i]" %s "${COMP_WORDS[i]}"
         done
     fi
-} # _comp__reassemble_comp_words_by_ref()
+} # _comp__reassemble_words()
 
 # @param $1 exclude  Characters out of $COMP_WORDBREAKS which should NOT be
 #     considered word breaks. This is useful for things like scp where
@@ -463,11 +463,11 @@ _comp__reassemble_comp_words_by_ref()
 # @param $2 words  Name of variable to return words to
 # @param $3 cword  Name of variable to return cword to
 # @param $4 cur  Name of variable to return current word to complete to
-# @see _comp__reassemble_comp_words_by_ref()
-_comp__get_cword_at_cursor_by_ref()
+# @see _comp__reassemble_words()
+_comp__get_cword_at_cursor()
 {
     local cword words=()
-    _comp__reassemble_comp_words_by_ref "$1" words cword
+    _comp__reassemble_words "$1" words cword
 
     local i cur="" index=$COMP_POINT lead=${COMP_LINE:0:COMP_POINT}
     # Cursor not at position 0 and not led by just space(s)?
@@ -508,7 +508,7 @@ _comp__get_cword_at_cursor_by_ref()
 # (For example, if the line is "ls foobar",
 # and the cursor is here -------->   ^
 # Also one is able to cross over possible wordbreak characters.
-# Usage: _comp_get_comp_words_by_ref [OPTIONS] [VARNAMES]
+# Usage: _comp_get_words [OPTIONS] [VARNAMES]
 # Available VARNAMES:
 #     cur         Return cur via $cur
 #     prev        Return prev via $prev
@@ -527,9 +527,9 @@ _comp__get_cword_at_cursor_by_ref()
 #
 # Example usage:
 #
-#    $ _comp_get_comp_words_by_ref -n : cur prev
+#    $ _comp_get_words -n : cur prev
 #
-_comp_get_comp_words_by_ref()
+_comp_get_words()
 {
     local exclude flag i OPTIND=1
     local cur cword words=()
@@ -564,7 +564,7 @@ _comp_get_comp_words_by_ref()
         ((OPTIND += 1))
     done
 
-    _comp__get_cword_at_cursor_by_ref "${exclude-}" words cword cur
+    _comp__get_cword_at_cursor "${exclude-}" words cword cur
 
     [[ -v vcur ]] && {
         upvars+=("$vcur")
@@ -895,7 +895,7 @@ _comp_variable_assignments()
 # cur, prev, words, and cword are local, ditto split if you use -s.
 #
 # Options:
-#     -n EXCLUDE  Passed to _comp_get_comp_words_by_ref -n with redirection chars
+#     -n EXCLUDE  Passed to _comp_get_words -n with redirection chars
 #     -e XSPEC    Passed to _filedir as first arg for stderr redirections
 #     -o XSPEC    Passed to _filedir as first arg for other output redirections
 #     -i XSPEC    Passed to _filedir as first arg for stdin redirections
@@ -943,7 +943,7 @@ _comp_initialize()
 
     COMPREPLY=()
     local redir='@(?(+([0-9])|{[a-zA-Z_]*([a-zA-Z_0-9])})@(>?([>|&])|<?([>&])|<<?([-<]))|&>?(>))'
-    _comp_get_comp_words_by_ref -n "$exclude<>&" cur prev words cword
+    _comp_get_words -n "$exclude<>&" cur prev words cword
 
     # Complete variable names.
     _variables && return 1
@@ -1682,7 +1682,7 @@ _realcommand()
 
 # This function returns the first argument, excluding options
 # @param $1 chars  Characters out of $COMP_WORDBREAKS which should
-#     NOT be considered word breaks. See _comp__reassemble_comp_words_by_ref.
+#     NOT be considered word breaks. See _comp__reassemble_words.
 _get_first_arg()
 {
     local i
@@ -1698,13 +1698,13 @@ _get_first_arg()
 
 # This function counts the number of args, excluding options
 # @param $1 chars  Characters out of $COMP_WORDBREAKS which should
-#     NOT be considered word breaks. See _comp__reassemble_comp_words_by_ref.
+#     NOT be considered word breaks. See _comp__reassemble_words.
 # @param $2 glob   Options whose following argument should not be counted
 # @param $3 glob   Options that should be counted as args
 _count_args()
 {
     local i cword words
-    _comp__reassemble_comp_words_by_ref "${1-}" words cword
+    _comp__reassemble_words "${1-}" words cword
 
     args=1
     for ((i = 1; i < cword; i++)); do
@@ -2163,7 +2163,7 @@ _comp_command_offset()
 
     COMPREPLY=()
     local cur
-    _comp_get_comp_words_by_ref cur
+    _comp_get_words cur
 
     if ((COMP_CWORD == 0)); then
         local IFS=$'\n'

bash_completion.d/000_bash_completion_compat

@@ -10,9 +10,9 @@ _comp_deprecate_func _command _comp_command
 _comp_deprecate_func _root_command _comp_root_command
 _comp_deprecate_func _xfunc _comp_xfunc
 _comp_deprecate_func _upvars _comp_upvars
-_comp_deprecate_func __reassemble_comp_words_by_ref _comp__reassemble_comp_words_by_ref
-_comp_deprecate_func __get_cword_at_cursor_by_ref _comp__get_cword_at_cursor_by_ref
-_comp_deprecate_func _get_comp_words_by_ref _comp_get_comp_words_by_ref
+_comp_deprecate_func __reassemble_comp_words_by_ref _comp__reassemble_words
+_comp_deprecate_func __get_cword_at_cursor_by_ref _comp__get_cword_at_cursor
+_comp_deprecate_func _get_comp_words_by_ref _comp_get_words
 
 # Backwards compatibility for compat completions that use have().
 # @deprecated should no longer be used; generally not needed with dynamically
@@ -83,13 +83,13 @@ _upvar()
 #     current word (default is 0, previous is 1), respecting the exclusions
 #     given at $1.  For example, `_get_cword "=:" 1' returns the word left of
 #     the current word, respecting the exclusions "=:".
-# @deprecated  Use `_comp_get_comp_words_by_ref cur' instead
-# @see _comp_get_comp_words_by_ref()
+# @deprecated  Use `_comp_get_words cur' instead
+# @see _comp_get_words()
 _get_cword()
 {
     local LC_CTYPE=C
     local cword words
-    _comp__reassemble_comp_words_by_ref "${1-}" words cword
+    _comp__reassemble_words "${1-}" words cword
 
     # return previous word offset by $2
     if [[ ${2-} && ${2//[^0-9]/} ]]; then
@@ -134,8 +134,8 @@ _get_cword()
 # This is a good alternative to `prev=${COMP_WORDS[COMP_CWORD-1]}' because bash4
 # will properly return the previous word with respect to any given exclusions to
 # COMP_WORDBREAKS.
-# @deprecated  Use `_comp_get_comp_words_by_ref cur prev' instead
-# @see _comp_get_comp_words_by_ref()
+# @deprecated  Use `_comp_get_words cur prev' instead
+# @see _comp_get_words()
 #
 _get_pword()
 {

completions/ssh

@@ -218,7 +218,7 @@ _comp_xfunc_ssh_suboption_check()
 {
     # Get prev and cur words without splitting on =
     local cur prev
-    _comp_get_comp_words_by_ref -n := cur prev
+    _comp_get_words -n := cur prev
     if [[ $cur == *=* && $prev == -*o ]]; then
         _ssh_suboption "$cur" "${1-}"
         return $?

test/t/test_umount.py

@@ -19,7 +19,7 @@ def dummy_mnt(self, request, bash):
         assert_bash_exec(
             bash,
             "_mnt_completion() { "
-            "local cur prev;_comp_get_comp_words_by_ref cur prev; "
+            "local cur prev;_comp_get_words cur prev; "
             '_comp_cmd_umount__linux_fstab "$prev" < mount/test-fstab; '
             "} && complete -F _mnt_completion _mnt",
         )

test/t/unit/Makefile.am

@@ -8,7 +8,7 @@ EXTRA_DIST = \
 	test_unit_expand_tilde_by_ref.py \
 	test_unit_filedir.py \
 	test_unit_find_unique_completion_pair.py \
-	test_unit_get_comp_words_by_ref.py \
+	test_unit_get_words.py \
 	test_unit_get_cword.py \
 	test_unit_initialize.py \
 	test_unit_ip_addresses.py \

test/t/unit/test_unit_filedir.py

@@ -15,18 +15,18 @@ class TestUnitFiledir:
     def functions(self, request, bash):
         assert_bash_exec(
             bash,
-            "_f() { local cur;_comp_get_comp_words_by_ref cur; unset -v COMPREPLY; _filedir; }; "
+            "_f() { local cur;_comp_get_words cur; unset -v COMPREPLY; _filedir; }; "
             "complete -F _f f; "
             "complete -F _f -o filenames f2",
         )
         assert_bash_exec(
             bash,
-            "_g() { local cur;_comp_get_comp_words_by_ref cur; unset -v COMPREPLY; _filedir e1; }; "
+            "_g() { local cur;_comp_get_words cur; unset -v COMPREPLY; _filedir e1; }; "
             "complete -F _g g",
         )
         assert_bash_exec(
             bash,
-            "_fd() { local cur;_comp_get_comp_words_by_ref cur; unset -v COMPREPLY; _filedir -d; };"
+            "_fd() { local cur;_comp_get_words cur; unset -v COMPREPLY; _filedir -d; };"
             "complete -F _fd fd",
         )
 

…/unit/test_unit_get_comp_words_by_ref.py test/t/unit/test_unit_get_words.pytest/t/unit/test_unit_get_comp_words_by_ref.py renamed to test/t/unit/test_unit_get_words.py test/t/unit/test_unit_get_comp_words_by_ref.py renamed to test/t/unit/test_unit_get_words.py

@@ -11,7 +11,7 @@ class TestUnitGetCompWordsByRef(TestUnitBase):
     def _test(self, bash, *args, **kwargs):
         assert_bash_exec(bash, "unset cur prev")
         output = self._test_unit(
-            "_comp_get_comp_words_by_ref %s cur prev; echo $cur,${prev-}",
+            "_comp_get_words %s cur prev; echo $cur,${prev-}",
             bash,
             *args,
             **kwargs,
@@ -22,7 +22,7 @@ def test_1(self, bash):
         assert_bash_exec(
             bash,
             "COMP_WORDS=() COMP_CWORD= COMP_POINT= COMP_LINE= "
-            "_comp_get_comp_words_by_ref cur >/dev/null",
+            "_comp_get_words cur >/dev/null",
         )
 
     def test_2(self, bash):
@@ -134,9 +134,9 @@ def test_22(self, bash):
     def test_23(self, bash):
         """a -n|
 
-        This test makes sure `_comp_get_comp_words_by_ref' doesn't use
-        `echo' to return its value, because -n might be interpreted by
-        `echo' and thus would not be returned.
+        This test makes sure `_comp_get_words' doesn't use `echo' to
+        return its value, because -n might be interpreted by `echo'
+        and thus would not be returned.
         """
         output = self._test(bash, "(a -n)", 1, "a -n", 4)
         assert output == "-n,a"
@@ -175,7 +175,7 @@ def test_30(self, bash):
         """a b| to all vars"""
         assert_bash_exec(bash, "unset words cword cur prev")
         output = self._test_unit(
-            "_comp_get_comp_words_by_ref words cword cur prev%s; "
+            "_comp_get_words words cword cur prev%s; "
             'echo "${words[@]}",$cword,$cur,$prev',
             bash,
             "(a b)",
@@ -189,7 +189,7 @@ def test_31(self, bash):
         """a b| to alternate vars"""
         assert_bash_exec(bash, "unset words2 cword2 cur2 prev2")
         output = self._test_unit(
-            "_comp_get_comp_words_by_ref -w words2 -i cword2 -c cur2 -p prev2%s; "
+            "_comp_get_words -w words2 -i cword2 -c cur2 -p prev2%s; "
             'echo $cur2,$prev2,"${words2[@]}",$cword2',
             bash,
             "(a b)",
@@ -204,7 +204,7 @@ def test_32(self, bash):
         """a b : c| with wordbreaks -= :"""
         assert_bash_exec(bash, "unset words")
         output = self._test_unit(
-            '_comp_get_comp_words_by_ref -n : words%s; echo "${words[@]}"',
+            '_comp_get_words -n : words%s; echo "${words[@]}"',
             bash,
             "(a b : c)",
             3,
@@ -217,7 +217,7 @@ def test_33(self, bash):
         """a b: c| with wordbreaks -= :"""
         assert_bash_exec(bash, "unset words")
         output = self._test_unit(
-            '_comp_get_comp_words_by_ref -n : words%s; echo "${words[@]}"',
+            '_comp_get_words -n : words%s; echo "${words[@]}"',
             bash,
             "(a b : c)",
             3,
@@ -230,7 +230,7 @@ def test_34(self, bash):
         """a b :c| with wordbreaks -= :"""
         assert_bash_exec(bash, "unset words")
         output = self._test_unit(
-            '_comp_get_comp_words_by_ref -n : words%s; echo "${words[@]}"',
+            '_comp_get_words -n : words%s; echo "${words[@]}"',
             bash,
             "(a b : c)",
             3,
@@ -243,7 +243,7 @@ def test_35(self, bash):
         r"""a b\ :c| with wordbreaks -= :"""
         assert_bash_exec(bash, "unset words")
         output = self._test_unit(
-            '_comp_get_comp_words_by_ref -n : words%s; echo "${words[@]}"',
+            '_comp_get_words -n : words%s; echo "${words[@]}"',
             bash,
             "(a 'b ' : c)",
             3,
@@ -255,6 +255,6 @@ def test_35(self, bash):
     def test_unknown_arg_error(self, bash):
         with pytest.raises(AssertionError) as ex:
             _ = assert_bash_exec(
-                bash, "_comp_get_comp_words_by_ref dummy", want_output=True
+                bash, "_comp_get_words dummy", want_output=True
             )
         ex.match("dummy.* unknown argument")

test/t/unit/test_unit_ip_addresses.py

@@ -9,19 +9,19 @@ class TestUnitIpAddresses:
     def functions(self, request, bash):
         assert_bash_exec(
             bash,
-            "_ia() { local cur;_comp_get_comp_words_by_ref cur;"
+            "_ia() { local cur;_comp_get_words cur;"
             "unset -v COMPREPLY;_ip_addresses; }",
         )
         assert_bash_exec(bash, "complete -F _ia ia")
         assert_bash_exec(
             bash,
-            "_iaa() { local cur;_comp_get_comp_words_by_ref cur;"
+            "_iaa() { local cur;_comp_get_words cur;"
             "unset -v COMPREPLY;_ip_addresses -a; }",
         )
         assert_bash_exec(bash, "complete -F _iaa iaa")
         assert_bash_exec(
             bash,
-            " _ia6() { local cur;_comp_get_comp_words_by_ref cur;"
+            " _ia6() { local cur;_comp_get_words cur;"
             "unset -v COMPREPLY;_ip_addresses -6; }",
         )
         assert_bash_exec(bash, "complete -F _ia6 ia6")