refactor(_comp_quote_compgen): store result in ret

Author: akinomyoga

bash_completion

@@ -139,7 +139,7 @@ _comp_quote()
 quote_readline()
 {
     local ret
-    _comp_quote_compgen "$1" ret
+    _comp_quote_compgen "$1"
     printf %s "$ret"
 } # quote_readline()
 
@@ -624,7 +624,7 @@ __ltrim_colon_completions()
 
 # This function quotes the argument in a way so that readline dequoting
 # results in the original argument.  This is necessary for at least
-# `compgen' which requires its arguments quoted/escaped:
+# `compgen` which requires its arguments quoted/escaped:
 #
 #     $ ls "a'b/"
 #     c
@@ -635,25 +635,25 @@ __ltrim_colon_completions()
 # See also:
 # - https://lists.gnu.org/archive/html/bug-bash/2009-03/msg00155.html
 # - https://www.mail-archive.com/[email protected]/msg01944.html
-# @param $1  Argument to quote
-# @param $2  Name of variable to return result to
+# @param $1      Argument to quote
+# @var[out] ret  Quoted result is stored in this variable
+# shellcheck disable=SC2178 # The assignment is not intended for the global "ret"
 _comp_quote_compgen()
 {
     if [[ $1 == \'* ]]; then
         # Leave out first character
-        printf -v "$2" %s "${1:1}"
+        ret=${1:1}
     else
-        printf -v "$2" %q "$1"
+        printf -v ret %q "$1"
 
         # If result becomes quoted like this: $'string', re-evaluate in order
         # to drop the additional quoting.  See also:
         # https://www.mail-archive.com/[email protected]/msg01942.html
-        if [[ ${!2} == \$\'*\' ]]; then
-            local value=${!2:2:-1} # Strip beginning $' and ending '.
-            value=${value//'%'/%%} # Escape % for printf format.
+        if [[ $ret == \$\'*\' ]]; then
+            local value=${ret:2:-1} # Strip beginning $' and ending '.
+            value=${value//'%'/%%}  # Escape % for printf format.
             # shellcheck disable=SC2059
-            printf -v value "$value" # Decode escape sequences of \....
-            local "$2" && _comp_upvars -v "$2" "$value"
+            printf -v ret "$value" # Decode escape sequences of \....
         fi
     fi
 } # _comp_quote_compgen()
@@ -681,8 +681,9 @@ _filedir()
         $reset
         IFS=$'\n'
     else
-        local quoted
-        _comp_quote_compgen "${cur-}" quoted
+        local ret
+        _comp_quote_compgen "${cur-}"
+        local quoted=$ret
 
         # 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,7 +13,6 @@ _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
@@ -35,6 +34,19 @@ quote()
     printf "'%s'" "$quoted"
 }
 
+# This function is the same as `_comp_quote_compgen`, but receives the second
+# argument specifying the variable name to store the result.
+# @param $1  Argument to quote
+# @param $2  Name of variable to return result to
+# @deprecated Use `_comp_quote_compgen "$1"` instead.  Note that
+# `_comp_quote_compgen` stores the result in a fixed variable `ret`.
+_quote_readline_by_ref()
+{
+    [[ $2 == ret ]] || local ret
+    _comp_quote_compgen "$1"
+    [[ $2 == ret ]] || printf -v "$2" %s "$ret"
+}
+
 # This function shell-dequotes the argument
 # @deprecated Use `_comp_dequote' instead.  Note that `_comp_dequote` stores
 #   the results in the array `ret` instead of writing them to stdout.