Merge pull request #946 from scop/refactor/longopt

refactor: longopt functions to new naming

Author: scop

bash_completion

@@ -797,7 +797,7 @@ _filedir()
 # this to be useful.
 # Returns 0 if current option was split, 1 otherwise.
 #
-_split_longopt()
+_comp__split_longopt()
 {
     if [[ $cur == --?*=* ]]; then
         # Cut also backslash before '=' in case it ended up there
@@ -977,7 +977,7 @@ _comp_variable_assignments()
 #     -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
-#     -s          Split long options with _split_longopt, implies -n =
+#     -s          Split long options with _comp__split_longopt, implies -n =
 # @param $1...$3 args Original arguments specified to the completion function.
 #                     The first argument $1 is command name.  The second
 #                     argument $2 is the string before the cursor in the
@@ -1066,7 +1066,7 @@ _comp_initialize()
     ((cword <= 0)) && return 1
     prev=${words[cword - 1]}
 
-    [[ $opt_split ]] && _split_longopt && was_split="set"
+    [[ $opt_split ]] && _comp__split_longopt && was_split="set"
 
     return 0
 }
@@ -2370,7 +2370,7 @@ _complete_as_root()
     [[ $EUID -eq 0 || ${root_command-} ]]
 }
 
-_longopt()
+_comp_longopt()
 {
     local cur prev words cword was_split comp_args
     _comp_initialize -s -- "$@" || return
@@ -2420,7 +2420,8 @@ _longopt()
     fi
 }
 # makeinfo and texi2dvi are defined elsewhere.
-complete -F _longopt a2ps awk base64 bash bc bison cat chroot colordiff cp \
+complete -F _comp_longopt \
+    a2ps awk base64 bash bc bison cat chroot colordiff cp \
     csplit cut date df diff dir du enscript env expand fmt fold gperf \
     grep grub head irb ld ldd less ln ls m4 mkdir mkfifo mknod \
     mv netstat nl nm objcopy objdump od paste pr ptx readelf rm rmdir \

bash_completion.d/000_bash_completion_compat.bash

@@ -12,6 +12,8 @@ _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 _longopt _comp_longopt
+_comp_deprecate_func _split_longopt _comp__split_longopt
 
 # Backwards compatibility for compat completions that use have().
 # @deprecated should no longer be used; generally not needed with dynamically
@@ -188,7 +190,7 @@ _realcommand()
 #     -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
-#     -s          Split long options with _split_longopt, implies -n =
+#     -s          Split long options with _comp__split_longopt, implies -n =
 # @var[out] cur       Reconstructed current word
 # @var[out] prev      Reconstructed previous word
 # @var[out] words     Reconstructed words

completions/_xm

@@ -15,7 +15,7 @@ _comp_cmd_xm()
     local cur prev words cword comp_args
     _comp_initialize -- "$@" || return
 
-    # TODO: _split_longopt
+    # TODO: split longopt
 
     local args command commands options
 

completions/abook

@@ -15,7 +15,7 @@ _comp_cmd_abook()
 
     case $cur in
         -*)
-            _longopt "$@"
+            _comp_longopt "$@"
             return
             ;;
     esac

completions/pyvenv

@@ -14,7 +14,7 @@ _comp_cmd_pyvenv()
     [[ $was_split ]] && return
 
     if [[ $cur == -* ]]; then
-        _longopt "$@"
+        _comp_longopt "$@"
         return
     fi
 

completions/sha256sum

@@ -14,7 +14,7 @@ _comp_cmd_sha256sum()
     [[ $was_split ]] && return
 
     if [[ $cur == -* ]]; then
-        _longopt "$@"
+        _comp_longopt "$@"
         return
     fi
 

doc/styleguide.md

@@ -81,7 +81,7 @@ available in `COMPREPLY`.
 ## `[[ $was_split ]] && return`
 
 Should be used in completions using the `-s` flag of `_comp_initialize`,
-or other similar cases where `_split_longopt` has been invoked, after
+or other similar cases where `_comp__split_longopt` has been invoked, after
 `$prev` has been managed but before `$cur` is considered. If `$cur` of the
 form `--foo=bar` was split into `prev=--foo` and `cur=bar`, and the `$prev`
 block did not process the option argument completion, it makes sense to return

test/t/test_grep.py

@@ -11,7 +11,7 @@ def test_2(self, completion):
         """
         Test --no-*dir isn't restricted to dirs only.
 
-        Not really a grep option, but tests _longopt.
+        Not really a grep option, but tests _comp_longopt.
         """
         assert completion == "foo foo.d/".split()
 

test/t/unit/test_unit_longopt.py

@@ -10,9 +10,9 @@ class TestUnitLongopt:
     @pytest.fixture(scope="class")
     def functions(self, request, bash):
         assert_bash_exec(bash, "_grephelp() { cat _longopt/grep--help.txt; }")
-        assert_bash_exec(bash, "complete -F _longopt _grephelp")
+        assert_bash_exec(bash, "complete -F _comp_longopt _grephelp")
         assert_bash_exec(bash, "_various() { cat _longopt/various.txt; }")
-        assert_bash_exec(bash, "complete -F _longopt _various")
+        assert_bash_exec(bash, "complete -F _comp_longopt _various")
 
     @pytest.mark.complete("_grephelp --")
     def test_1(self, functions, completion):