Add pointer about the problems regarding tg depend rm to README
[topgit.git] / contrib / tg-completion.bash
blob0ee233c4781b1fe8d3a84772c59373e30ed2f06f
2 # bash completion support for TopGit.
4 # Copyright (C) 2008 Jonas Fonseca <fonseca@diku.dk>
5 # Copyright (C) 2006,2007 Shawn O. Pearce <spearce@spearce.org>
6 # Based git's git-completion.sh: http://repo.or.cz/w/git/fastimport.git
7 # Conceptually based on gitcompletion (http://gitweb.hawaga.org.uk/).
8 # Distributed under the GNU General Public License, version 2.0.
10 # To use these routines:
12 # 1) Copy this file to somewhere (e.g. ~/.tg-completion.sh).
13 # 2) Source it from your ~/.bashrc.
15 # Note: Make sure the tg script is in your PATH before you source this
16 # script, so it can properly setup cached values.
18 case "$COMP_WORDBREAKS" in
19 *:*) : great ;;
20 *) COMP_WORDBREAKS="$COMP_WORDBREAKS:"
21 esac
23 ### {{{ Utilities
25 __tgdir ()
27 if [ -z "$1" ]; then
28 if [ -n "$__tg_dir" ]; then
29 echo "$__tg_dir"
30 elif [ -d .git ]; then
31 echo .git
32 else
33 git rev-parse --git-dir 2>/dev/null
35 elif [ -d "$1/.git" ]; then
36 echo "$1/.git"
37 else
38 echo "$1"
42 __tgcomp_1 ()
44 local c IFS=' '$'\t'$'\n'
45 for c in $1; do
46 case "$c$2" in
47 --*=*) printf %s$'\n' "$c$2" ;;
48 *.) printf %s$'\n' "$c$2" ;;
49 *) printf %s$'\n' "$c$2 " ;;
50 esac
51 done
54 __tgcomp ()
56 local cur="${COMP_WORDS[COMP_CWORD]}"
57 if [ $# -gt 2 ]; then
58 cur="$3"
60 case "$cur" in
61 --*=)
62 COMPREPLY=()
65 local IFS=$'\n'
66 COMPREPLY=($(compgen -P "$2" \
67 -W "$(__tgcomp_1 "$1" "$4")" \
68 -- "$cur"))
70 esac
73 __tg_heads ()
75 local cmd i is_hash=y dir="$(__tgdir "$1")"
76 if [ -d "$dir" ]; then
77 git --git-dir="$dir" for-each-ref --format='%(refname:short)' \
78 refs/heads
79 return
81 for i in $(git ls-remote "$1" 2>/dev/null); do
82 case "$is_hash,$i" in
83 y,*) is_hash=n ;;
84 n,*^{}) is_hash=y ;;
85 n,refs/heads/*) is_hash=y; echo "${i#refs/heads/}" ;;
86 n,*) is_hash=y; echo "$i" ;;
87 esac
88 done
91 __tg_refs ()
93 local cmd i is_hash=y dir="$(__tgdir "$1")"
94 if [ -d "$dir" ]; then
95 if [ -e "$dir/HEAD" ]; then echo HEAD; fi
96 git --git-dir="$dir" for-each-ref --format='%(refname:short)' \
97 refs/tags refs/heads refs/remotes
98 return
100 for i in $(git ls-remote "$dir" 2>/dev/null); do
101 case "$is_hash,$i" in
102 y,*) is_hash=n ;;
103 n,*^{}) is_hash=y ;;
104 n,refs/tags/*) is_hash=y; echo "${i#refs/tags/}" ;;
105 n,refs/heads/*) is_hash=y; echo "${i#refs/heads/}" ;;
106 n,refs/remotes/*) is_hash=y; echo "${i#refs/remotes/}" ;;
107 n,*) is_hash=y; echo "$i" ;;
108 esac
109 done
112 __tg_refs2 ()
114 local i
115 for i in $(__tg_refs "$1"); do
116 echo "$i:$i"
117 done
120 __tg_refs_remotes ()
122 local cmd i is_hash=y
123 for i in $(git ls-remote "$1" 2>/dev/null); do
124 case "$is_hash,$i" in
125 n,refs/heads/*)
126 is_hash=y
127 echo "$i:refs/remotes/$1/${i#refs/heads/}"
129 y,*) is_hash=n ;;
130 n,*^{}) is_hash=y ;;
131 n,refs/tags/*) is_hash=y;;
132 n,*) is_hash=y; ;;
133 esac
134 done
137 __tg_remotes ()
139 local i ngoff IFS=$'\n' d="$(__tgdir)"
140 shopt -q nullglob || ngoff=1
141 shopt -s nullglob
142 for i in "$d/remotes"/*; do
143 echo ${i#$d/remotes/}
144 done
145 [ "$ngoff" ] && shopt -u nullglob
146 for i in $(git --git-dir="$d" config --list); do
147 case "$i" in
148 remote.*.url=*)
149 i="${i#remote.}"
150 echo "${i/.url=*/}"
152 esac
153 done
156 __tg_find_subcommand ()
158 local word subcommand c=1
160 while [ $c -lt $COMP_CWORD ]; do
161 word="${COMP_WORDS[c]}"
162 for subcommand in $1; do
163 if [ "$subcommand" = "$word" ]; then
164 echo "$subcommand"
165 return
167 done
168 c=$((++c))
169 done
172 __tg_complete_revlist ()
174 local pfx cur="${COMP_WORDS[COMP_CWORD]}"
175 case "$cur" in
176 *...*)
177 pfx="${cur%...*}..."
178 cur="${cur#*...}"
179 __tgcomp "$(__tg_refs)" "$pfx" "$cur"
181 *..*)
182 pfx="${cur%..*}.."
183 cur="${cur#*..}"
184 __tgcomp "$(__tg_refs)" "$pfx" "$cur"
187 __tgcomp "$(__tg_refs)"
189 esac
192 __tg_topics ()
194 tg summary -t
197 __tg_commands ()
199 if [ -n "$__tg_all_commandlist" ]; then
200 echo "$__tg_all_commandlist"
201 return
203 local i IFS=" "$'\n'
204 for i in $(tg help | sed -n 's/^Usage:.*(\(.*\)).*/\1/p' | tr '|' ' ')
206 case $i in
207 *--*) : helper pattern;;
208 *) echo $i;;
209 esac
210 done
212 __tg_all_commandlist=
213 __tg_all_commandlist="$(__tg_commands 2>/dev/null)"
215 __tg_complete_arg ()
217 if [ $COMP_CWORD -gt 2 ] && [ "${COMP_WORDS[$COMP_CWORD - 1]}" = "$1" ]; then
218 return 0
220 return 1
223 ### }}}
224 ### {{{ Commands
226 _tg_create ()
228 local cmd="$1"
229 local cur="${COMP_WORDS[COMP_CWORD]}"
231 # Name must be the first arg after the create command
232 if [ $((cmd + 1)) = $COMP_CWORD ]; then
233 __tgcomp "$(__tg_topics)"
234 return
237 __tg_complete_arg "-r" && {
238 __tgcomp "$(__tg_remotes)"
239 return
242 case "$cur" in
244 __tgcomp "
249 __tgcomp "$(__tg_refs)"
250 esac
253 _tg_delete ()
255 local cur="${COMP_WORDS[COMP_CWORD]}"
257 case "$cur" in
259 __tgcomp "
264 __tgcomp "$(__tg_topics)"
265 esac
268 _tg_depend ()
270 local subcommands="add"
271 local subcommand="$(__git_find_subcommand "$subcommands")"
272 if [ -z "$subcommand" ]; then
273 __tgcomp "$subcommands"
274 return
277 case "$subcommand" in
278 add)
279 __tgcomp "$(__tg_refs)"
280 esac
283 _tg_export ()
285 local cur="${COMP_WORDS[COMP_CWORD]}"
287 __tg_complete_arg "--collapse" && {
288 __tgcomp "$(__tg_heads)"
289 return
292 __tg_complete_arg "--quilt" && {
293 return
296 case "$cur" in
298 __tgcomp "
299 --collapse
300 --quilt
302 esac
305 _tg_help ()
307 local cur="${COMP_WORDS[COMP_CWORD]}"
308 case "$cur" in
310 COMPREPLY=()
311 return
313 esac
314 __tgcomp "$(__tg_commands)"
317 _tg_import ()
319 local cur="${COMP_WORDS[COMP_CWORD]}"
321 __tg_complete_arg "-p" && {
322 COMPREPLY=()
323 return
326 case "$cur" in
328 __tgcomp "
333 __tg_complete_revlist
334 esac
337 _tg_info ()
339 local cur="${COMP_WORDS[COMP_CWORD]}"
341 case "$cur" in
343 __tgcomp "$(__tg_topics)"
344 esac
347 _tg_mail ()
349 local cur="${COMP_WORDS[COMP_CWORD]}"
351 case "$cur" in
353 __tgcomp "$(__tg_topics)"
354 esac
357 _tg_patch ()
359 local cur="${COMP_WORDS[COMP_CWORD]}"
361 case "$cur" in
363 __tgcomp "
369 __tgcomp "$(__tg_topics)"
370 esac
373 _tg_push ()
375 local cur="${COMP_WORDS[COMP_CWORD]}"
377 __tg_complete_arg "-r" && {
378 __tgcomp "$(__tg_remotes)"
379 return
382 case "$cur" in
384 __tgcomp "
385 --no-deps
386 --dry-run
387 --tgish-only
392 __tgcomp "$(__tg_topics)"
393 esac
396 _tg_remote ()
398 local cur="${COMP_WORDS[COMP_CWORD]}"
400 case "$cur" in
402 __tgcomp "
403 --populate
407 __tgcomp "$(__tg_remotes)"
408 esac
411 _tg_summary ()
413 local cur="${COMP_WORDS[COMP_CWORD]}"
415 case "$cur" in
417 __tgcomp "
418 --graphviz
421 esac
424 _tg_update ()
426 COMPREPLY=()
429 ### }}}
430 ### {{{ tg completion
432 _tg ()
434 local i c=1 command __tg_dir
436 while [ $c -lt $COMP_CWORD ]; do
437 i="${COMP_WORDS[c]}"
438 case "$i" in
439 -r)
440 c=$((++c))
441 if [ $c -lt $COMP_CWORD ]; then
442 __tgcomp "$(__tg_remotes)"
443 return
446 -h|--help) command="help"; break ;;
447 *) command="$i"; break ;;
448 esac
449 c=$((++c))
450 done
452 if [ -z "$command" ]; then
453 case "${COMP_WORDS[COMP_CWORD]}" in
454 -*) __tgcomp "
457 --help
460 *) __tgcomp "$(__tg_commands)" ;;
461 esac
462 return
465 case "$command" in
466 create) _tg_create "$c" ;;
467 delete) _tg_delete ;;
468 depend) _tg_depend ;;
469 export) _tg_export ;;
470 help) _tg_help ;;
471 import) _tg_import ;;
472 info) _tg_info ;;
473 mail) _tg_mail ;;
474 patch) _tg_patch ;;
475 push) _tg_push ;;
476 remote) _tg_remote ;;
477 summary) _tg_summary ;;
478 update) _tg_update ;;
479 *) COMPREPLY=() ;;
480 esac
483 ### }}}
485 complete -o default -o nospace -F _tg tg
487 # The following are necessary only for Cygwin, and only are needed
488 # when the user has tab-completed the executable name and consequently
489 # included the '.exe' suffix.
491 if [ Cygwin = "$(uname -o 2>/dev/null)" ]; then
492 complete -o default -o nospace -F _tg tg.exe