undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

completion: optimize refs completion

Browse Source 
After a unique command or option is completed, in most cases it is a
good thing to add a trailing a space, but sometimes it doesn't make
sense, e.g. when the completed word is an option taking an argument
('--option=') or a configuration section ('core.').  Therefore the
completion script uses the '-o nospace' option to prevent bash from
automatically appending a space to unique completions, and it has the
__gitcomp() function to add that trailing space only when necessary.
See 72e5e989 (bash: Add space after unique command name is completed.,
2007-02-04), 78d4d6a2 (bash: Support unique completion on git-config.,
2007-02-04), and b3391775 (bash: Support unique completion when
possible., 2007-02-04).

__gitcomp() therefore iterates over all possible completion words it
got as argument, and checks each word whether a trailing space is
necessary or not.  This is ok for commands, options, etc., i.e. when
the number of words is relatively small, but can be noticeably slow
for large number of refs.  However, while options might or might not
need that trailing space, refs are always handled uniformly and always
get that trailing space (or a trailing '.' for 'git config
branch.<head>.').  Since refs listed by __git_refs() & co. are
separated by newline, this allows us some optimizations with
'compgen'.

So, add a specialized variant of __gitcomp() that only deals with
possible completion words separated by a newline and uniformly appends
the trailing space to all words using 'compgen -S " "' (or any other
suffix, if specified), so no iteration over all words is needed.  But
we need to fiddle with IFS, because the default IFS containing a space
would cause the added space suffix to be stripped off when compgen's
output is stored in the COMPREPLY array.  Therefore we use only
newline as IFS, hence the requirement for the newline-separated
possible completion words.

Convert all callsites of __gitcomp() where it's called with refs, i.e.
when it gets the output of either __git_refs(), __git_heads(),
__git_tags(), __git_refs2(), __git_refs_remotes(), or the odd 'git
for-each-ref' somewhere in _git_config().  Also convert callsites
where it gets other uniformly handled newline separated word lists,
i.e. either remotes from __git_remotes(), names of set configuration
variables from __git_config_get_set_variables(), stashes, or commands.

Here are some timing results for dealing with 10000 refs.
Before:

  $ refs="$(__git_refs ~/tmp/git/repo-with-10k-refs/)"
  $ time __gitcomp "$refs"

  real	0m1.134s
  user	0m1.060s
  sys	0m0.130s

After:

  $ time __gitcomp_nl "$refs"

  real	0m0.373s
  user	0m0.360s
  sys	0m0.020s

Signed-off-by: SZEDER Gábor <szeder@ira.uka.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
SZEDER Gábor 2011-10-15 14:57:23 +02:00 committed by Junio C Hamano
parent f674bb8078
commit a31e62629a
1 changed files with 70 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

115
contrib/completion/git-completion.bash
View File

@ -512,6 +512,31 @@ __gitcomp ()
esac esac
} }
# Generates completion reply with compgen from newline-separated possible
# completion words by appending a space to all of them.
# It accepts 1 to 4 arguments:
# 1: List of possible completion words, separated by a single newline.
# 2: A prefix to be added to each possible completion word (optional).
# 3: Generate possible completion matches for this word (optional).
# 4: A suffix to be appended to each possible completion word instead of
# the default space (optional). If specified but empty, nothing is
# appended.
__gitcomp_nl ()
{
local s=$'\n' IFS=' '$'\t'$'\n'
local cur_="$cur" suffix=" "
if [ $# -gt 2 ]; then
cur_="$3"
if [ $# -gt 3 ]; then
suffix="$4"
fi
fi
IFS=$s
COMPREPLY=($(compgen -P "${2-}" -S "$suffix" -W "$1" -- "$cur_"))
}
# __git_heads accepts 0 or 1 arguments (to pass to __gitdir) # __git_heads accepts 0 or 1 arguments (to pass to __gitdir)
__git_heads () __git_heads ()
{ {
@ -716,15 +741,15 @@ __git_complete_revlist_file ()
*...*) *...*)
pfx="${cur_%...*}..." pfx="${cur_%...*}..."
cur_="${cur_#*...}" cur_="${cur_#*...}"
__gitcomp "$(__git_refs)" "$pfx" "$cur_" __gitcomp_nl "$(__git_refs)" "$pfx" "$cur_"
;; ;;
*..*) *..*)
pfx="${cur_%..*}.." pfx="${cur_%..*}.."
cur_="${cur_#*..}" cur_="${cur_#*..}"
__gitcomp "$(__git_refs)" "$pfx" "$cur_" __gitcomp_nl "$(__git_refs)" "$pfx" "$cur_"
;; ;;
*) *)
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
;; ;;
esac esac
} }
@ -764,7 +789,7 @@ __git_complete_remote_or_refspec ()
c=$((++c)) c=$((++c))
done done
if [ -z "$remote" ]; then if [ -z "$remote" ]; then
__gitcomp "$(__git_remotes)" __gitcomp_nl "$(__git_remotes)"
return return
fi fi
if [ $no_complete_refspec = 1 ]; then if [ $no_complete_refspec = 1 ]; then
@ -789,23 +814,23 @@ __git_complete_remote_or_refspec ()
case "$cmd" in case "$cmd" in
fetch) fetch)
if [ $lhs = 1 ]; then if [ $lhs = 1 ]; then
__gitcomp "$(__git_refs2 "$remote")" "$pfx" "$cur_" __gitcomp_nl "$(__git_refs2 "$remote")" "$pfx" "$cur_"
else else
__gitcomp "$(__git_refs)" "$pfx" "$cur_" __gitcomp_nl "$(__git_refs)" "$pfx" "$cur_"
fi fi
;; ;;
pull) pull)
if [ $lhs = 1 ]; then if [ $lhs = 1 ]; then
__gitcomp "$(__git_refs "$remote")" "$pfx" "$cur_" __gitcomp_nl "$(__git_refs "$remote")" "$pfx" "$cur_"
else else
__gitcomp "$(__git_refs)" "$pfx" "$cur_" __gitcomp_nl "$(__git_refs)" "$pfx" "$cur_"
fi fi
;; ;;
push) push)
if [ $lhs = 1 ]; then if [ $lhs = 1 ]; then
__gitcomp "$(__git_refs)" "$pfx" "$cur_" __gitcomp_nl "$(__git_refs)" "$pfx" "$cur_"
else else
__gitcomp "$(__git_refs "$remote")" "$pfx" "$cur_" __gitcomp_nl "$(__git_refs "$remote")" "$pfx" "$cur_"
fi fi
;; ;;
esac esac
@ -1084,7 +1109,7 @@ _git_archive ()
return return
;; ;;
--remote=*) --remote=*)
__gitcomp "$(__git_remotes)" "" "${cur##--remote=}" __gitcomp_nl "$(__git_remotes)" "" "${cur##--remote=}"
return return
;; ;;
--*) --*)
@ -1115,7 +1140,7 @@ _git_bisect ()
case "$subcommand" in case "$subcommand" in
bad|good|reset|skip|start) bad|good|reset|skip|start)
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
;; ;;
*) *)
COMPREPLY=() COMPREPLY=()
@ -1146,9 +1171,9 @@ _git_branch ()
;; ;;
*) *)
if [ $only_local_ref = "y" -a $has_r = "n" ]; then if [ $only_local_ref = "y" -a $has_r = "n" ]; then
__gitcomp "$(__git_heads)" __gitcomp_nl "$(__git_heads)"
else else
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
fi fi
;; ;;
esac esac
@ -1195,7 +1220,7 @@ _git_checkout ()
if [ -n "$(__git_find_on_cmdline "$flags")" ]; then if [ -n "$(__git_find_on_cmdline "$flags")" ]; then
track='' track=''
fi fi
__gitcomp "$(__git_refs '' $track)" __gitcomp_nl "$(__git_refs '' $track)"
;; ;;
esac esac
} }
@ -1212,7 +1237,7 @@ _git_cherry_pick ()
__gitcomp "--edit --no-commit" __gitcomp "--edit --no-commit"
;; ;;
*) *)
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
;; ;;
esac esac
} }
@ -1266,7 +1291,7 @@ _git_commit ()
;; ;;
--reuse-message=*|--reedit-message=*|\ --reuse-message=*|--reedit-message=*|\
--fixup=*|--squash=*) --fixup=*|--squash=*)
__gitcomp "$(__git_refs)" "" "${cur#*=}" __gitcomp_nl "$(__git_refs)" "" "${cur#*=}"
return return
;; ;;
--untracked-files=*) --untracked-files=*)
@ -1297,7 +1322,7 @@ _git_describe ()
" "
return return
esac esac
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
} }
__git_diff_common_options="--stat --numstat --shortstat --summary __git_diff_common_options="--stat --numstat --shortstat --summary
@ -1456,7 +1481,7 @@ _git_grep ()
;; ;;
esac esac
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
} }
_git_help () _git_help ()
@ -1514,7 +1539,7 @@ _git_ls_files ()
_git_ls_remote () _git_ls_remote ()
{ {
__gitcomp "$(__git_remotes)" __gitcomp_nl "$(__git_remotes)"
} }
_git_ls_tree () _git_ls_tree ()
@ -1610,7 +1635,7 @@ _git_merge ()
__gitcomp "$__git_merge_options" __gitcomp "$__git_merge_options"
return return
esac esac
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
} }
_git_mergetool () _git_mergetool ()
@ -1630,7 +1655,7 @@ _git_mergetool ()
_git_merge_base () _git_merge_base ()
{ {
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
} }
_git_mv () _git_mv ()
@ -1661,7 +1686,7 @@ _git_notes ()
,*) ,*)
case "${words[cword-1]}" in case "${words[cword-1]}" in
--ref) --ref)
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
;; ;;
*) *)
__gitcomp "$subcommands --ref" __gitcomp "$subcommands --ref"
@ -1670,7 +1695,7 @@ _git_notes ()
;; ;;
add,--reuse-message=*|append,--reuse-message=*|\ add,--reuse-message=*|append,--reuse-message=*|\
add,--reedit-message=*|append,--reedit-message=*) add,--reedit-message=*|append,--reedit-message=*)
__gitcomp "$(__git_refs)" "" "${cur#*=}" __gitcomp_nl "$(__git_refs)" "" "${cur#*=}"
;; ;;
add,--*|append,--*) add,--*|append,--*)
__gitcomp '--file= --message= --reedit-message= __gitcomp '--file= --message= --reedit-message=
@ -1689,7 +1714,7 @@ _git_notes ()
-m|-F) -m|-F)
;; ;;
*) *)
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
;; ;;
esac esac
;; ;;
@ -1717,12 +1742,12 @@ _git_push ()
{ {
case "$prev" in case "$prev" in
--repo) --repo)
__gitcomp "$(__git_remotes)" __gitcomp_nl "$(__git_remotes)"
return return
esac esac
case "$cur" in case "$cur" in
--repo=*) --repo=*)
__gitcomp "$(__git_remotes)" "" "${cur##--repo=}" __gitcomp_nl "$(__git_remotes)" "" "${cur##--repo=}"
return return
;; ;;
--*) --*)
@ -1760,7 +1785,7 @@ _git_rebase ()
return return
esac esac
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
} }
_git_reflog () _git_reflog ()
@ -1771,7 +1796,7 @@ _git_reflog ()
if [ -z "$subcommand" ]; then if [ -z "$subcommand" ]; then
__gitcomp "$subcommands" __gitcomp "$subcommands"
else else
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
fi fi
} }
@ -1853,23 +1878,23 @@ _git_config ()
{ {
case "$prev" in case "$prev" in
branch.*.remote) branch.*.remote)
__gitcomp "$(__git_remotes)" __gitcomp_nl "$(__git_remotes)"
return return
;; ;;
branch.*.merge) branch.*.merge)
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
return return
;; ;;
remote.*.fetch) remote.*.fetch)
local remote="${prev#remote.}" local remote="${prev#remote.}"
remote="${remote%.fetch}" remote="${remote%.fetch}"
__gitcomp "$(__git_refs_remotes "$remote")" __gitcomp_nl "$(__git_refs_remotes "$remote")"
return return
;; ;;
remote.*.push) remote.*.push)
local remote="${prev#remote.}" local remote="${prev#remote.}"
remote="${remote%.push}" remote="${remote%.push}"
__gitcomp "$(git --git-dir="$(__gitdir)" \ __gitcomp_nl "$(git --git-dir="$(__gitdir)" \
for-each-ref --format='%(refname):%(refname)' \ for-each-ref --format='%(refname):%(refname)' \
refs/heads)" refs/heads)"
return return
@ -1916,7 +1941,7 @@ _git_config ()
return return
;; ;;
--get|--get-all|--unset|--unset-all) --get|--get-all|--unset|--unset-all)
__gitcomp "$(__git_config_get_set_variables)" __gitcomp_nl "$(__git_config_get_set_variables)"
return return
;; ;;
*.*) *.*)
@ -1942,7 +1967,7 @@ _git_config ()
;; ;;
branch.*) branch.*)
local pfx="${cur%.*}." cur_="${cur#*.}" local pfx="${cur%.*}." cur_="${cur#*.}"
__gitcomp "$(__git_heads)" "$pfx" "$cur_" "." __gitcomp_nl "$(__git_heads)" "$pfx" "$cur_" "."
return return
;; ;;
guitool.*.*) guitool.*.*)
@ -1971,7 +1996,7 @@ _git_config ()
pager.*) pager.*)
local pfx="${cur%.*}." cur_="${cur#*.}" local pfx="${cur%.*}." cur_="${cur#*.}"
__git_compute_all_commands __git_compute_all_commands
__gitcomp "$__git_all_commands" "$pfx" "$cur_" __gitcomp_nl "$__git_all_commands" "$pfx" "$cur_"
return return
;; ;;
remote.*.*) remote.*.*)
@ -1984,7 +2009,7 @@ _git_config ()
;; ;;
remote.*) remote.*)
local pfx="${cur%.*}." cur_="${cur#*.}" local pfx="${cur%.*}." cur_="${cur#*.}"
__gitcomp "$(__git_remotes)" "$pfx" "$cur_" "." __gitcomp_nl "$(__git_remotes)" "$pfx" "$cur_" "."
return return
;; ;;
url.*.*) url.*.*)
@ -2285,7 +2310,7 @@ _git_remote ()
case "$subcommand" in case "$subcommand" in
rename|rm|show|prune) rename|rm|show|prune)
__gitcomp "$(__git_remotes)" __gitcomp_nl "$(__git_remotes)"
;; ;;
update) update)
local i c='' IFS=$'\n' local i c='' IFS=$'\n'
@ -2303,7 +2328,7 @@ _git_remote ()
_git_replace () _git_replace ()
{ {
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
} }
_git_reset () _git_reset ()
@ -2316,7 +2341,7 @@ _git_reset ()
return return
;; ;;
esac esac
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
} }
_git_revert () _git_revert ()
@ -2327,7 +2352,7 @@ _git_revert ()
return return
;; ;;
esac esac
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
} }
_git_rm () _git_rm ()
@ -2426,7 +2451,7 @@ _git_stash ()
COMPREPLY=() COMPREPLY=()
;; ;;
show,*|apply,*|drop,*|pop,*|branch,*) show,*|apply,*|drop,*|pop,*|branch,*)
__gitcomp "$(git --git-dir="$(__gitdir)" stash list \ __gitcomp_nl "$(git --git-dir="$(__gitdir)" stash list \
| sed -n -e 's/:.*//p')" | sed -n -e 's/:.*//p')"
;; ;;
*) *)
@ -2560,7 +2585,7 @@ _git_tag ()
i="${words[c]}" i="${words[c]}"
case "$i" in case "$i" in
-d|-v) -d|-v)
__gitcomp "$(__git_tags)" __gitcomp_nl "$(__git_tags)"
return return
;; ;;
-f) -f)
@ -2576,13 +2601,13 @@ _git_tag ()
;; ;;
-*|tag) -*|tag)
if [ $f = 1 ]; then if [ $f = 1 ]; then
__gitcomp "$(__git_tags)" __gitcomp_nl "$(__git_tags)"
else else
COMPREPLY=() COMPREPLY=()
fi fi
;; ;;
*) *)
__gitcomp "$(__git_refs)" __gitcomp_nl "$(__git_refs)"
;; ;;
esac esac
} }