refactor: rename _quote_readline_by_ref => _comp_quote_compgen

Author: akinomyoga

bash_completion

@@ -135,11 +135,11 @@ _comp_quote()
     ret=\'${1//\'/\'\\\'\'}\'
 }
 
-# @see _quote_readline_by_ref()
+# @see _comp_quote_compgen()
 quote_readline()
 {
     local ret
-    _quote_readline_by_ref "$1" ret
+    _comp_quote_compgen "$1" ret
     printf %s "$ret"
 } # quote_readline()
 
@@ -637,7 +637,7 @@ __ltrim_colon_completions()
 # - https://www.mail-archive.com/[email protected]/msg01944.html
 # @param $1  Argument to quote
 # @param $2  Name of variable to return result to
-_quote_readline_by_ref()
+_comp_quote_compgen()
 {
     if [[ $1 == \'* ]]; then
         # Leave out first character
@@ -656,7 +656,7 @@ _quote_readline_by_ref()
             local "$2" && _comp_upvars -v "$2" "$value"
         fi
     fi
-} # _quote_readline_by_ref()
+} # _comp_quote_compgen()
 
 # This function performs file and directory completion. It's better than
 # simply using 'compgen -f', because it honours spaces in filenames.
@@ -682,7 +682,7 @@ _filedir()
         IFS=$'\n'
     else
         local quoted
-        _quote_readline_by_ref "${cur-}" quoted
+        _comp_quote_compgen "${cur-}" quoted
 
         # Munge xspec to contain uppercase version too
         # https://lists.gnu.org/archive/html/bug-bash/2010-09/msg00036.html

bash_completion.d/000_bash_completion_compat.bash

@@ -13,6 +13,7 @@ _comp_deprecate_func _upvars _comp_upvars
 _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
+_comp_deprecate_func _quote_readline_by_ref _comp_quote_compgen
 
 # Backwards compatibility for compat completions that use have().
 # @deprecated should no longer be used; generally not needed with dynamically

test/t/unit/Makefile.am

@@ -21,7 +21,7 @@ EXTRA_DIST = \
 	test_unit_pids.py \
 	test_unit_pnames.py \
 	test_unit_quote.py \
-	test_unit_quote_readline.py \
+	test_unit_quote_compgen.py \
 	test_unit_split.py \
 	test_unit_tilde.py \
 	test_unit_unlocal.py \

test/t/unit/test_unit_quote_readline.py renamed to test/t/unit/test_unit_quote_compgen.py

@@ -6,7 +6,7 @@
 
 
 @pytest.mark.bashcomp(cmd=None, temp_cwd=True)
-class TestUnitQuoteReadline:
+class TestUnitQuoteCompgen:
     def test_exec(self, bash):
         assert_bash_exec(bash, "quote_readline '' >/dev/null")
 
@@ -36,9 +36,9 @@ def test_github_issue_492_1(self, bash):
         Reported at https://github.com/scop/bash-completion/pull/492
 
         Arbitrary commands could be unintendedly executed by
-        _quote_readline_by_ref.  In the following example, the command
-        "touch 1.txt" would be unintendedly created before the fix.  The file
-        "1.txt" should not be created by completion on the following line:
+        _comp_quote_compgen.  In the following example, the command "touch
+        1.txt" would be unintendedly created before the fix.  The file "1.txt"
+        should not be created by completion on the following line:
 
           $ echo '$(touch file.txt)[TAB]
 
@@ -97,10 +97,10 @@ def test_github_issue_526_1(self, bash):
         Ref [2] https://github.com/scop/bash-completion/pull/526
 
         The escape sequences in the local variable of "value" in
-        "_quote_readline_by_ref" needs to be unescaped by passing it to printf
-        as the format string.  This causes a problem in the following case
-        [where the spaces after "alpha\" is a TAB character inserted in the
-        command string by "C-v TAB"]:
+        "_comp_quote_compgen" needs to be unescaped by passing it to printf as
+        the format string.  This causes a problem in the following case [where
+        the spaces after "alpha\" is a TAB character inserted in the command
+        string by "C-v TAB"]:
 
           $ echo alpha\   b[TAB]