Merge branch 'mf/submodule-summary-with-correct-repository'
[git] / contrib / completion / git-completion.bash
1 # bash/zsh completion support for core Git.
2 #
3 # Copyright (C) 2006,2007 Shawn O. Pearce <spearce@spearce.org>
4 # Conceptually based on gitcompletion (http://gitweb.hawaga.org.uk/).
5 # Distributed under the GNU General Public License, version 2.0.
6 #
7 # The contained completion routines provide support for completing:
8 #
9 #    *) local and remote branch names
10 #    *) local and remote tag names
11 #    *) .git/remotes file names
12 #    *) git 'subcommands'
13 #    *) git email aliases for git-send-email
14 #    *) tree paths within 'ref:path/to/file' expressions
15 #    *) file paths within current working directory and index
16 #    *) common --long-options
17 #
18 # To use these routines:
19 #
20 #    1) Copy this file to somewhere (e.g. ~/.git-completion.bash).
21 #    2) Add the following line to your .bashrc/.zshrc:
22 #        source ~/.git-completion.bash
23 #    3) Consider changing your PS1 to also show the current branch,
24 #       see git-prompt.sh for details.
25 #
26 # If you use complex aliases of form '!f() { ... }; f', you can use the null
27 # command ':' as the first command in the function body to declare the desired
28 # completion style.  For example '!f() { : git commit ; ... }; f' will
29 # tell the completion to use commit completion.  This also works with aliases
30 # of form "!sh -c '...'".  For example, "!sh -c ': git commit ; ... '".
31 #
32 # Compatible with bash 3.2.57.
33 #
34 # You can set the following environment variables to influence the behavior of
35 # the completion routines:
36 #
37 #   GIT_COMPLETION_CHECKOUT_NO_GUESS
38 #
39 #     When set to "1", do not include "DWIM" suggestions in git-checkout
40 #     and git-switch completion (e.g., completing "foo" when "origin/foo"
41 #     exists).
42 #
43 #   GIT_COMPLETION_SHOW_ALL
44 #
45 #     When set to "1" suggest all options, including options which are
46 #     typically hidden (e.g. '--allow-empty' for 'git commit').
47
48 case "$COMP_WORDBREAKS" in
49 *:*) : great ;;
50 *)   COMP_WORDBREAKS="$COMP_WORDBREAKS:"
51 esac
52
53 # Discovers the path to the git repository taking any '--git-dir=<path>' and
54 # '-C <path>' options into account and stores it in the $__git_repo_path
55 # variable.
56 __git_find_repo_path ()
57 {
58         if [ -n "${__git_repo_path-}" ]; then
59                 # we already know where it is
60                 return
61         fi
62
63         if [ -n "${__git_C_args-}" ]; then
64                 __git_repo_path="$(git "${__git_C_args[@]}" \
65                         ${__git_dir:+--git-dir="$__git_dir"} \
66                         rev-parse --absolute-git-dir 2>/dev/null)"
67         elif [ -n "${__git_dir-}" ]; then
68                 test -d "$__git_dir" &&
69                 __git_repo_path="$__git_dir"
70         elif [ -n "${GIT_DIR-}" ]; then
71                 test -d "${GIT_DIR-}" &&
72                 __git_repo_path="$GIT_DIR"
73         elif [ -d .git ]; then
74                 __git_repo_path=.git
75         else
76                 __git_repo_path="$(git rev-parse --git-dir 2>/dev/null)"
77         fi
78 }
79
80 # Deprecated: use __git_find_repo_path() and $__git_repo_path instead
81 # __gitdir accepts 0 or 1 arguments (i.e., location)
82 # returns location of .git repo
83 __gitdir ()
84 {
85         if [ -z "${1-}" ]; then
86                 __git_find_repo_path || return 1
87                 echo "$__git_repo_path"
88         elif [ -d "$1/.git" ]; then
89                 echo "$1/.git"
90         else
91                 echo "$1"
92         fi
93 }
94
95 # Runs git with all the options given as argument, respecting any
96 # '--git-dir=<path>' and '-C <path>' options present on the command line
97 __git ()
98 {
99         git ${__git_C_args:+"${__git_C_args[@]}"} \
100                 ${__git_dir:+--git-dir="$__git_dir"} "$@" 2>/dev/null
101 }
102
103 # Removes backslash escaping, single quotes and double quotes from a word,
104 # stores the result in the variable $dequoted_word.
105 # 1: The word to dequote.
106 __git_dequote ()
107 {
108         local rest="$1" len ch
109
110         dequoted_word=""
111
112         while test -n "$rest"; do
113                 len=${#dequoted_word}
114                 dequoted_word="$dequoted_word${rest%%[\\\'\"]*}"
115                 rest="${rest:$((${#dequoted_word}-$len))}"
116
117                 case "${rest:0:1}" in
118                 \\)
119                         ch="${rest:1:1}"
120                         case "$ch" in
121                         $'\n')
122                                 ;;
123                         *)
124                                 dequoted_word="$dequoted_word$ch"
125                                 ;;
126                         esac
127                         rest="${rest:2}"
128                         ;;
129                 \')
130                         rest="${rest:1}"
131                         len=${#dequoted_word}
132                         dequoted_word="$dequoted_word${rest%%\'*}"
133                         rest="${rest:$((${#dequoted_word}-$len+1))}"
134                         ;;
135                 \")
136                         rest="${rest:1}"
137                         while test -n "$rest" ; do
138                                 len=${#dequoted_word}
139                                 dequoted_word="$dequoted_word${rest%%[\\\"]*}"
140                                 rest="${rest:$((${#dequoted_word}-$len))}"
141                                 case "${rest:0:1}" in
142                                 \\)
143                                         ch="${rest:1:1}"
144                                         case "$ch" in
145                                         \"|\\|\$|\`)
146                                                 dequoted_word="$dequoted_word$ch"
147                                                 ;;
148                                         $'\n')
149                                                 ;;
150                                         *)
151                                                 dequoted_word="$dequoted_word\\$ch"
152                                                 ;;
153                                         esac
154                                         rest="${rest:2}"
155                                         ;;
156                                 \")
157                                         rest="${rest:1}"
158                                         break
159                                         ;;
160                                 esac
161                         done
162                         ;;
163                 esac
164         done
165 }
166
167 # The following function is based on code from:
168 #
169 #   bash_completion - programmable completion functions for bash 3.2+
170 #
171 #   Copyright © 2006-2008, Ian Macdonald <ian@caliban.org>
172 #             © 2009-2010, Bash Completion Maintainers
173 #                     <bash-completion-devel@lists.alioth.debian.org>
174 #
175 #   This program is free software; you can redistribute it and/or modify
176 #   it under the terms of the GNU General Public License as published by
177 #   the Free Software Foundation; either version 2, or (at your option)
178 #   any later version.
179 #
180 #   This program is distributed in the hope that it will be useful,
181 #   but WITHOUT ANY WARRANTY; without even the implied warranty of
182 #   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
183 #   GNU General Public License for more details.
184 #
185 #   You should have received a copy of the GNU General Public License
186 #   along with this program; if not, see <http://www.gnu.org/licenses/>.
187 #
188 #   The latest version of this software can be obtained here:
189 #
190 #   http://bash-completion.alioth.debian.org/
191 #
192 #   RELEASE: 2.x
193
194 # This function can be used to access a tokenized list of words
195 # on the command line:
196 #
197 #       __git_reassemble_comp_words_by_ref '=:'
198 #       if test "${words_[cword_-1]}" = -w
199 #       then
200 #               ...
201 #       fi
202 #
203 # The argument should be a collection of characters from the list of
204 # word completion separators (COMP_WORDBREAKS) to treat as ordinary
205 # characters.
206 #
207 # This is roughly equivalent to going back in time and setting
208 # COMP_WORDBREAKS to exclude those characters.  The intent is to
209 # make option types like --date=<type> and <rev>:<path> easy to
210 # recognize by treating each shell word as a single token.
211 #
212 # It is best not to set COMP_WORDBREAKS directly because the value is
213 # shared with other completion scripts.  By the time the completion
214 # function gets called, COMP_WORDS has already been populated so local
215 # changes to COMP_WORDBREAKS have no effect.
216 #
217 # Output: words_, cword_, cur_.
218
219 __git_reassemble_comp_words_by_ref()
220 {
221         local exclude i j first
222         # Which word separators to exclude?
223         exclude="${1//[^$COMP_WORDBREAKS]}"
224         cword_=$COMP_CWORD
225         if [ -z "$exclude" ]; then
226                 words_=("${COMP_WORDS[@]}")
227                 return
228         fi
229         # List of word completion separators has shrunk;
230         # re-assemble words to complete.
231         for ((i=0, j=0; i < ${#COMP_WORDS[@]}; i++, j++)); do
232                 # Append each nonempty word consisting of just
233                 # word separator characters to the current word.
234                 first=t
235                 while
236                         [ $i -gt 0 ] &&
237                         [ -n "${COMP_WORDS[$i]}" ] &&
238                         # word consists of excluded word separators
239                         [ "${COMP_WORDS[$i]//[^$exclude]}" = "${COMP_WORDS[$i]}" ]
240                 do
241                         # Attach to the previous token,
242                         # unless the previous token is the command name.
243                         if [ $j -ge 2 ] && [ -n "$first" ]; then
244                                 ((j--))
245                         fi
246                         first=
247                         words_[$j]=${words_[j]}${COMP_WORDS[i]}
248                         if [ $i = $COMP_CWORD ]; then
249                                 cword_=$j
250                         fi
251                         if (($i < ${#COMP_WORDS[@]} - 1)); then
252                                 ((i++))
253                         else
254                                 # Done.
255                                 return
256                         fi
257                 done
258                 words_[$j]=${words_[j]}${COMP_WORDS[i]}
259                 if [ $i = $COMP_CWORD ]; then
260                         cword_=$j
261                 fi
262         done
263 }
264
265 if ! type _get_comp_words_by_ref >/dev/null 2>&1; then
266 _get_comp_words_by_ref ()
267 {
268         local exclude cur_ words_ cword_
269         if [ "$1" = "-n" ]; then
270                 exclude=$2
271                 shift 2
272         fi
273         __git_reassemble_comp_words_by_ref "$exclude"
274         cur_=${words_[cword_]}
275         while [ $# -gt 0 ]; do
276                 case "$1" in
277                 cur)
278                         cur=$cur_
279                         ;;
280                 prev)
281                         prev=${words_[$cword_-1]}
282                         ;;
283                 words)
284                         words=("${words_[@]}")
285                         ;;
286                 cword)
287                         cword=$cword_
288                         ;;
289                 esac
290                 shift
291         done
292 }
293 fi
294
295 # Fills the COMPREPLY array with prefiltered words without any additional
296 # processing.
297 # Callers must take care of providing only words that match the current word
298 # to be completed and adding any prefix and/or suffix (trailing space!), if
299 # necessary.
300 # 1: List of newline-separated matching completion words, complete with
301 #    prefix and suffix.
302 __gitcomp_direct ()
303 {
304         local IFS=$'\n'
305
306         COMPREPLY=($1)
307 }
308
309 # Similar to __gitcomp_direct, but appends to COMPREPLY instead.
310 # Callers must take care of providing only words that match the current word
311 # to be completed and adding any prefix and/or suffix (trailing space!), if
312 # necessary.
313 # 1: List of newline-separated matching completion words, complete with
314 #    prefix and suffix.
315 __gitcomp_direct_append ()
316 {
317         local IFS=$'\n'
318
319         COMPREPLY+=($1)
320 }
321
322 __gitcompappend ()
323 {
324         local x i=${#COMPREPLY[@]}
325         for x in $1; do
326                 if [[ "$x" == "$3"* ]]; then
327                         COMPREPLY[i++]="$2$x$4"
328                 fi
329         done
330 }
331
332 __gitcompadd ()
333 {
334         COMPREPLY=()
335         __gitcompappend "$@"
336 }
337
338 # Generates completion reply, appending a space to possible completion words,
339 # if necessary.
340 # It accepts 1 to 4 arguments:
341 # 1: List of possible completion words.
342 # 2: A prefix to be added to each possible completion word (optional).
343 # 3: Generate possible completion matches for this word (optional).
344 # 4: A suffix to be appended to each possible completion word (optional).
345 __gitcomp ()
346 {
347         local cur_="${3-$cur}"
348
349         case "$cur_" in
350         --*=)
351                 ;;
352         --no-*)
353                 local c i=0 IFS=$' \t\n'
354                 for c in $1; do
355                         if [[ $c == "--" ]]; then
356                                 continue
357                         fi
358                         c="$c${4-}"
359                         if [[ $c == "$cur_"* ]]; then
360                                 case $c in
361                                 --*=|*.) ;;
362                                 *) c="$c " ;;
363                                 esac
364                                 COMPREPLY[i++]="${2-}$c"
365                         fi
366                 done
367                 ;;
368         *)
369                 local c i=0 IFS=$' \t\n'
370                 for c in $1; do
371                         if [[ $c == "--" ]]; then
372                                 c="--no-...${4-}"
373                                 if [[ $c == "$cur_"* ]]; then
374                                         COMPREPLY[i++]="${2-}$c "
375                                 fi
376                                 break
377                         fi
378                         c="$c${4-}"
379                         if [[ $c == "$cur_"* ]]; then
380                                 case $c in
381                                 *=|*.) ;;
382                                 *) c="$c " ;;
383                                 esac
384                                 COMPREPLY[i++]="${2-}$c"
385                         fi
386                 done
387                 ;;
388         esac
389 }
390
391 # Clear the variables caching builtins' options when (re-)sourcing
392 # the completion script.
393 if [[ -n ${ZSH_VERSION-} ]]; then
394         unset ${(M)${(k)parameters[@]}:#__gitcomp_builtin_*} 2>/dev/null
395 else
396         unset $(compgen -v __gitcomp_builtin_)
397 fi
398
399 # This function is equivalent to
400 #
401 #    __gitcomp "$(git xxx --git-completion-helper) ..."
402 #
403 # except that the output is cached. Accept 1-3 arguments:
404 # 1: the git command to execute, this is also the cache key
405 # 2: extra options to be added on top (e.g. negative forms)
406 # 3: options to be excluded
407 __gitcomp_builtin ()
408 {
409         # spaces must be replaced with underscore for multi-word
410         # commands, e.g. "git remote add" becomes remote_add.
411         local cmd="$1"
412         local incl="${2-}"
413         local excl="${3-}"
414
415         local var=__gitcomp_builtin_"${cmd/-/_}"
416         local options
417         eval "options=\${$var-}"
418
419         local completion_helper
420         if [ "$GIT_COMPLETION_SHOW_ALL" = "1" ]; then
421                 completion_helper="--git-completion-helper-all"
422         else
423                 completion_helper="--git-completion-helper"
424         fi
425
426         if [ -z "$options" ]; then
427                 # leading and trailing spaces are significant to make
428                 # option removal work correctly.
429                 options=" $incl $(__git ${cmd/_/ } $completion_helper) " || return
430
431                 for i in $excl; do
432                         options="${options/ $i / }"
433                 done
434                 eval "$var=\"$options\""
435         fi
436
437         __gitcomp "$options"
438 }
439
440 # Variation of __gitcomp_nl () that appends to the existing list of
441 # completion candidates, COMPREPLY.
442 __gitcomp_nl_append ()
443 {
444         local IFS=$'\n'
445         __gitcompappend "$1" "${2-}" "${3-$cur}" "${4- }"
446 }
447
448 # Generates completion reply from newline-separated possible completion words
449 # by appending a space to all of them.
450 # It accepts 1 to 4 arguments:
451 # 1: List of possible completion words, separated by a single newline.
452 # 2: A prefix to be added to each possible completion word (optional).
453 # 3: Generate possible completion matches for this word (optional).
454 # 4: A suffix to be appended to each possible completion word instead of
455 #    the default space (optional).  If specified but empty, nothing is
456 #    appended.
457 __gitcomp_nl ()
458 {
459         COMPREPLY=()
460         __gitcomp_nl_append "$@"
461 }
462
463 # Fills the COMPREPLY array with prefiltered paths without any additional
464 # processing.
465 # Callers must take care of providing only paths that match the current path
466 # to be completed and adding any prefix path components, if necessary.
467 # 1: List of newline-separated matching paths, complete with all prefix
468 #    path components.
469 __gitcomp_file_direct ()
470 {
471         local IFS=$'\n'
472
473         COMPREPLY=($1)
474
475         # use a hack to enable file mode in bash < 4
476         compopt -o filenames +o nospace 2>/dev/null ||
477         compgen -f /non-existing-dir/ >/dev/null ||
478         true
479 }
480
481 # Generates completion reply with compgen from newline-separated possible
482 # completion filenames.
483 # It accepts 1 to 3 arguments:
484 # 1: List of possible completion filenames, separated by a single newline.
485 # 2: A directory prefix to be added to each possible completion filename
486 #    (optional).
487 # 3: Generate possible completion matches for this word (optional).
488 __gitcomp_file ()
489 {
490         local IFS=$'\n'
491
492         # XXX does not work when the directory prefix contains a tilde,
493         # since tilde expansion is not applied.
494         # This means that COMPREPLY will be empty and Bash default
495         # completion will be used.
496         __gitcompadd "$1" "${2-}" "${3-$cur}" ""
497
498         # use a hack to enable file mode in bash < 4
499         compopt -o filenames +o nospace 2>/dev/null ||
500         compgen -f /non-existing-dir/ >/dev/null ||
501         true
502 }
503
504 # Execute 'git ls-files', unless the --committable option is specified, in
505 # which case it runs 'git diff-index' to find out the files that can be
506 # committed.  It return paths relative to the directory specified in the first
507 # argument, and using the options specified in the second argument.
508 __git_ls_files_helper ()
509 {
510         if [ "$2" == "--committable" ]; then
511                 __git -C "$1" -c core.quotePath=false diff-index \
512                         --name-only --relative HEAD -- "${3//\\/\\\\}*"
513         else
514                 # NOTE: $2 is not quoted in order to support multiple options
515                 __git -C "$1" -c core.quotePath=false ls-files \
516                         --exclude-standard $2 -- "${3//\\/\\\\}*"
517         fi
518 }
519
520
521 # __git_index_files accepts 1 or 2 arguments:
522 # 1: Options to pass to ls-files (required).
523 # 2: A directory path (optional).
524 #    If provided, only files within the specified directory are listed.
525 #    Sub directories are never recursed.  Path must have a trailing
526 #    slash.
527 # 3: List only paths matching this path component (optional).
528 __git_index_files ()
529 {
530         local root="$2" match="$3"
531
532         __git_ls_files_helper "$root" "$1" "${match:-?}" |
533         awk -F / -v pfx="${2//\\/\\\\}" '{
534                 paths[$1] = 1
535         }
536         END {
537                 for (p in paths) {
538                         if (substr(p, 1, 1) != "\"") {
539                                 # No special characters, easy!
540                                 print pfx p
541                                 continue
542                         }
543
544                         # The path is quoted.
545                         p = dequote(p)
546                         if (p == "")
547                                 continue
548
549                         # Even when a directory name itself does not contain
550                         # any special characters, it will still be quoted if
551                         # any of its (stripped) trailing path components do.
552                         # Because of this we may have seen the same directory
553                         # both quoted and unquoted.
554                         if (p in paths)
555                                 # We have seen the same directory unquoted,
556                                 # skip it.
557                                 continue
558                         else
559                                 print pfx p
560                 }
561         }
562         function dequote(p,    bs_idx, out, esc, esc_idx, dec) {
563                 # Skip opening double quote.
564                 p = substr(p, 2)
565
566                 # Interpret backslash escape sequences.
567                 while ((bs_idx = index(p, "\\")) != 0) {
568                         out = out substr(p, 1, bs_idx - 1)
569                         esc = substr(p, bs_idx + 1, 1)
570                         p = substr(p, bs_idx + 2)
571
572                         if ((esc_idx = index("abtvfr\"\\", esc)) != 0) {
573                                 # C-style one-character escape sequence.
574                                 out = out substr("\a\b\t\v\f\r\"\\",
575                                                  esc_idx, 1)
576                         } else if (esc == "n") {
577                                 # Uh-oh, a newline character.
578                                 # We cannot reliably put a pathname
579                                 # containing a newline into COMPREPLY,
580                                 # and the newline would create a mess.
581                                 # Skip this path.
582                                 return ""
583                         } else {
584                                 # Must be a \nnn octal value, then.
585                                 dec = esc             * 64 + \
586                                       substr(p, 1, 1) * 8  + \
587                                       substr(p, 2, 1)
588                                 out = out sprintf("%c", dec)
589                                 p = substr(p, 3)
590                         }
591                 }
592                 # Drop closing double quote, if there is one.
593                 # (There is not any if this is a directory, as it was
594                 # already stripped with the trailing path components.)
595                 if (substr(p, length(p), 1) == "\"")
596                         out = out substr(p, 1, length(p) - 1)
597                 else
598                         out = out p
599
600                 return out
601         }'
602 }
603
604 # __git_complete_index_file requires 1 argument:
605 # 1: the options to pass to ls-file
606 #
607 # The exception is --committable, which finds the files appropriate commit.
608 __git_complete_index_file ()
609 {
610         local dequoted_word pfx="" cur_
611
612         __git_dequote "$cur"
613
614         case "$dequoted_word" in
615         ?*/*)
616                 pfx="${dequoted_word%/*}/"
617                 cur_="${dequoted_word##*/}"
618                 ;;
619         *)
620                 cur_="$dequoted_word"
621         esac
622
623         __gitcomp_file_direct "$(__git_index_files "$1" "$pfx" "$cur_")"
624 }
625
626 # Lists branches from the local repository.
627 # 1: A prefix to be added to each listed branch (optional).
628 # 2: List only branches matching this word (optional; list all branches if
629 #    unset or empty).
630 # 3: A suffix to be appended to each listed branch (optional).
631 __git_heads ()
632 {
633         local pfx="${1-}" cur_="${2-}" sfx="${3-}"
634
635         __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
636                         "refs/heads/$cur_*" "refs/heads/$cur_*/**"
637 }
638
639 # Lists branches from remote repositories.
640 # 1: A prefix to be added to each listed branch (optional).
641 # 2: List only branches matching this word (optional; list all branches if
642 #    unset or empty).
643 # 3: A suffix to be appended to each listed branch (optional).
644 __git_remote_heads ()
645 {
646         local pfx="${1-}" cur_="${2-}" sfx="${3-}"
647
648         __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
649                         "refs/remotes/$cur_*" "refs/remotes/$cur_*/**"
650 }
651
652 # Lists tags from the local repository.
653 # Accepts the same positional parameters as __git_heads() above.
654 __git_tags ()
655 {
656         local pfx="${1-}" cur_="${2-}" sfx="${3-}"
657
658         __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
659                         "refs/tags/$cur_*" "refs/tags/$cur_*/**"
660 }
661
662 # List unique branches from refs/remotes used for 'git checkout' and 'git
663 # switch' tracking DWIMery.
664 # 1: A prefix to be added to each listed branch (optional)
665 # 2: List only branches matching this word (optional; list all branches if
666 #    unset or empty).
667 # 3: A suffix to be appended to each listed branch (optional).
668 __git_dwim_remote_heads ()
669 {
670         local pfx="${1-}" cur_="${2-}" sfx="${3-}"
671         local fer_pfx="${pfx//\%/%%}" # "escape" for-each-ref format specifiers
672
673         # employ the heuristic used by git checkout and git switch
674         # Try to find a remote branch that cur_es the completion word
675         # but only output if the branch name is unique
676         __git for-each-ref --format="$fer_pfx%(refname:strip=3)$sfx" \
677                 --sort="refname:strip=3" \
678                 "refs/remotes/*/$cur_*" "refs/remotes/*/$cur_*/**" | \
679         uniq -u
680 }
681
682 # Lists refs from the local (by default) or from a remote repository.
683 # It accepts 0, 1 or 2 arguments:
684 # 1: The remote to list refs from (optional; ignored, if set but empty).
685 #    Can be the name of a configured remote, a path, or a URL.
686 # 2: In addition to local refs, list unique branches from refs/remotes/ for
687 #    'git checkout's tracking DWIMery (optional; ignored, if set but empty).
688 # 3: A prefix to be added to each listed ref (optional).
689 # 4: List only refs matching this word (optional; list all refs if unset or
690 #    empty).
691 # 5: A suffix to be appended to each listed ref (optional; ignored, if set
692 #    but empty).
693 #
694 # Use __git_complete_refs() instead.
695 __git_refs ()
696 {
697         local i hash dir track="${2-}"
698         local list_refs_from=path remote="${1-}"
699         local format refs
700         local pfx="${3-}" cur_="${4-$cur}" sfx="${5-}"
701         local match="${4-}"
702         local fer_pfx="${pfx//\%/%%}" # "escape" for-each-ref format specifiers
703
704         __git_find_repo_path
705         dir="$__git_repo_path"
706
707         if [ -z "$remote" ]; then
708                 if [ -z "$dir" ]; then
709                         return
710                 fi
711         else
712                 if __git_is_configured_remote "$remote"; then
713                         # configured remote takes precedence over a
714                         # local directory with the same name
715                         list_refs_from=remote
716                 elif [ -d "$remote/.git" ]; then
717                         dir="$remote/.git"
718                 elif [ -d "$remote" ]; then
719                         dir="$remote"
720                 else
721                         list_refs_from=url
722                 fi
723         fi
724
725         if [ "$list_refs_from" = path ]; then
726                 if [[ "$cur_" == ^* ]]; then
727                         pfx="$pfx^"
728                         fer_pfx="$fer_pfx^"
729                         cur_=${cur_#^}
730                         match=${match#^}
731                 fi
732                 case "$cur_" in
733                 refs|refs/*)
734                         format="refname"
735                         refs=("$match*" "$match*/**")
736                         track=""
737                         ;;
738                 *)
739                         for i in HEAD FETCH_HEAD ORIG_HEAD MERGE_HEAD REBASE_HEAD; do
740                                 case "$i" in
741                                 $match*)
742                                         if [ -e "$dir/$i" ]; then
743                                                 echo "$pfx$i$sfx"
744                                         fi
745                                         ;;
746                                 esac
747                         done
748                         format="refname:strip=2"
749                         refs=("refs/tags/$match*" "refs/tags/$match*/**"
750                                 "refs/heads/$match*" "refs/heads/$match*/**"
751                                 "refs/remotes/$match*" "refs/remotes/$match*/**")
752                         ;;
753                 esac
754                 __git_dir="$dir" __git for-each-ref --format="$fer_pfx%($format)$sfx" \
755                         "${refs[@]}"
756                 if [ -n "$track" ]; then
757                         __git_dwim_remote_heads "$pfx" "$match" "$sfx"
758                 fi
759                 return
760         fi
761         case "$cur_" in
762         refs|refs/*)
763                 __git ls-remote "$remote" "$match*" | \
764                 while read -r hash i; do
765                         case "$i" in
766                         *^{}) ;;
767                         *) echo "$pfx$i$sfx" ;;
768                         esac
769                 done
770                 ;;
771         *)
772                 if [ "$list_refs_from" = remote ]; then
773                         case "HEAD" in
774                         $match*)        echo "${pfx}HEAD$sfx" ;;
775                         esac
776                         __git for-each-ref --format="$fer_pfx%(refname:strip=3)$sfx" \
777                                 "refs/remotes/$remote/$match*" \
778                                 "refs/remotes/$remote/$match*/**"
779                 else
780                         local query_symref
781                         case "HEAD" in
782                         $match*)        query_symref="HEAD" ;;
783                         esac
784                         __git ls-remote "$remote" $query_symref \
785                                 "refs/tags/$match*" "refs/heads/$match*" \
786                                 "refs/remotes/$match*" |
787                         while read -r hash i; do
788                                 case "$i" in
789                                 *^{})   ;;
790                                 refs/*) echo "$pfx${i#refs/*/}$sfx" ;;
791                                 *)      echo "$pfx$i$sfx" ;;  # symbolic refs
792                                 esac
793                         done
794                 fi
795                 ;;
796         esac
797 }
798
799 # Completes refs, short and long, local and remote, symbolic and pseudo.
800 #
801 # Usage: __git_complete_refs [<option>]...
802 # --remote=<remote>: The remote to list refs from, can be the name of a
803 #                    configured remote, a path, or a URL.
804 # --dwim: List unique remote branches for 'git switch's tracking DWIMery.
805 # --pfx=<prefix>: A prefix to be added to each ref.
806 # --cur=<word>: The current ref to be completed.  Defaults to the current
807 #               word to be completed.
808 # --sfx=<suffix>: A suffix to be appended to each ref instead of the default
809 #                 space.
810 # --mode=<mode>: What set of refs to complete, one of 'refs' (the default) to
811 #                complete all refs, 'heads' to complete only branches, or
812 #                'remote-heads' to complete only remote branches. Note that
813 #                --remote is only compatible with --mode=refs.
814 __git_complete_refs ()
815 {
816         local remote= dwim= pfx= cur_="$cur" sfx=" " mode="refs"
817
818         while test $# != 0; do
819                 case "$1" in
820                 --remote=*)     remote="${1##--remote=}" ;;
821                 --dwim)         dwim="yes" ;;
822                 # --track is an old spelling of --dwim
823                 --track)        dwim="yes" ;;
824                 --pfx=*)        pfx="${1##--pfx=}" ;;
825                 --cur=*)        cur_="${1##--cur=}" ;;
826                 --sfx=*)        sfx="${1##--sfx=}" ;;
827                 --mode=*)       mode="${1##--mode=}" ;;
828                 *)              return 1 ;;
829                 esac
830                 shift
831         done
832
833         # complete references based on the specified mode
834         case "$mode" in
835                 refs)
836                         __gitcomp_direct "$(__git_refs "$remote" "" "$pfx" "$cur_" "$sfx")" ;;
837                 heads)
838                         __gitcomp_direct "$(__git_heads "$pfx" "$cur_" "$sfx")" ;;
839                 remote-heads)
840                         __gitcomp_direct "$(__git_remote_heads "$pfx" "$cur_" "$sfx")" ;;
841                 *)
842                         return 1 ;;
843         esac
844
845         # Append DWIM remote branch names if requested
846         if [ "$dwim" = "yes" ]; then
847                 __gitcomp_direct_append "$(__git_dwim_remote_heads "$pfx" "$cur_" "$sfx")"
848         fi
849 }
850
851 # __git_refs2 requires 1 argument (to pass to __git_refs)
852 # Deprecated: use __git_complete_fetch_refspecs() instead.
853 __git_refs2 ()
854 {
855         local i
856         for i in $(__git_refs "$1"); do
857                 echo "$i:$i"
858         done
859 }
860
861 # Completes refspecs for fetching from a remote repository.
862 # 1: The remote repository.
863 # 2: A prefix to be added to each listed refspec (optional).
864 # 3: The ref to be completed as a refspec instead of the current word to be
865 #    completed (optional)
866 # 4: A suffix to be appended to each listed refspec instead of the default
867 #    space (optional).
868 __git_complete_fetch_refspecs ()
869 {
870         local i remote="$1" pfx="${2-}" cur_="${3-$cur}" sfx="${4- }"
871
872         __gitcomp_direct "$(
873                 for i in $(__git_refs "$remote" "" "" "$cur_") ; do
874                         echo "$pfx$i:$i$sfx"
875                 done
876                 )"
877 }
878
879 # __git_refs_remotes requires 1 argument (to pass to ls-remote)
880 __git_refs_remotes ()
881 {
882         local i hash
883         __git ls-remote "$1" 'refs/heads/*' | \
884         while read -r hash i; do
885                 echo "$i:refs/remotes/$1/${i#refs/heads/}"
886         done
887 }
888
889 __git_remotes ()
890 {
891         __git_find_repo_path
892         test -d "$__git_repo_path/remotes" && ls -1 "$__git_repo_path/remotes"
893         __git remote
894 }
895
896 # Returns true if $1 matches the name of a configured remote, false otherwise.
897 __git_is_configured_remote ()
898 {
899         local remote
900         for remote in $(__git_remotes); do
901                 if [ "$remote" = "$1" ]; then
902                         return 0
903                 fi
904         done
905         return 1
906 }
907
908 __git_list_merge_strategies ()
909 {
910         LANG=C LC_ALL=C git merge -s help 2>&1 |
911         sed -n -e '/[Aa]vailable strategies are: /,/^$/{
912                 s/\.$//
913                 s/.*://
914                 s/^[    ]*//
915                 s/[     ]*$//
916                 p
917         }'
918 }
919
920 __git_merge_strategies=
921 # 'git merge -s help' (and thus detection of the merge strategy
922 # list) fails, unfortunately, if run outside of any git working
923 # tree.  __git_merge_strategies is set to the empty string in
924 # that case, and the detection will be repeated the next time it
925 # is needed.
926 __git_compute_merge_strategies ()
927 {
928         test -n "$__git_merge_strategies" ||
929         __git_merge_strategies=$(__git_list_merge_strategies)
930 }
931
932 __git_merge_strategy_options="ours theirs subtree subtree= patience
933         histogram diff-algorithm= ignore-space-change ignore-all-space
934         ignore-space-at-eol renormalize no-renormalize no-renames
935         find-renames find-renames= rename-threshold="
936
937 __git_complete_revlist_file ()
938 {
939         local dequoted_word pfx ls ref cur_="$cur"
940         case "$cur_" in
941         *..?*:*)
942                 return
943                 ;;
944         ?*:*)
945                 ref="${cur_%%:*}"
946                 cur_="${cur_#*:}"
947
948                 __git_dequote "$cur_"
949
950                 case "$dequoted_word" in
951                 ?*/*)
952                         pfx="${dequoted_word%/*}"
953                         cur_="${dequoted_word##*/}"
954                         ls="$ref:$pfx"
955                         pfx="$pfx/"
956                         ;;
957                 *)
958                         cur_="$dequoted_word"
959                         ls="$ref"
960                         ;;
961                 esac
962
963                 case "$COMP_WORDBREAKS" in
964                 *:*) : great ;;
965                 *)   pfx="$ref:$pfx" ;;
966                 esac
967
968                 __gitcomp_file "$(__git ls-tree "$ls" \
969                                 | sed 's/^.*    //
970                                        s/$//')" \
971                         "$pfx" "$cur_"
972                 ;;
973         *...*)
974                 pfx="${cur_%...*}..."
975                 cur_="${cur_#*...}"
976                 __git_complete_refs --pfx="$pfx" --cur="$cur_"
977                 ;;
978         *..*)
979                 pfx="${cur_%..*}.."
980                 cur_="${cur_#*..}"
981                 __git_complete_refs --pfx="$pfx" --cur="$cur_"
982                 ;;
983         *)
984                 __git_complete_refs
985                 ;;
986         esac
987 }
988
989 __git_complete_file ()
990 {
991         __git_complete_revlist_file
992 }
993
994 __git_complete_revlist ()
995 {
996         __git_complete_revlist_file
997 }
998
999 __git_complete_remote_or_refspec ()
1000 {
1001         local cur_="$cur" cmd="${words[1]}"
1002         local i c=2 remote="" pfx="" lhs=1 no_complete_refspec=0
1003         if [ "$cmd" = "remote" ]; then
1004                 ((c++))
1005         fi
1006         while [ $c -lt $cword ]; do
1007                 i="${words[c]}"
1008                 case "$i" in
1009                 --mirror) [ "$cmd" = "push" ] && no_complete_refspec=1 ;;
1010                 -d|--delete) [ "$cmd" = "push" ] && lhs=0 ;;
1011                 --all)
1012                         case "$cmd" in
1013                         push) no_complete_refspec=1 ;;
1014                         fetch)
1015                                 return
1016                                 ;;
1017                         *) ;;
1018                         esac
1019                         ;;
1020                 --multiple) no_complete_refspec=1; break ;;
1021                 -*) ;;
1022                 *) remote="$i"; break ;;
1023                 esac
1024                 ((c++))
1025         done
1026         if [ -z "$remote" ]; then
1027                 __gitcomp_nl "$(__git_remotes)"
1028                 return
1029         fi
1030         if [ $no_complete_refspec = 1 ]; then
1031                 return
1032         fi
1033         [ "$remote" = "." ] && remote=
1034         case "$cur_" in
1035         *:*)
1036                 case "$COMP_WORDBREAKS" in
1037                 *:*) : great ;;
1038                 *)   pfx="${cur_%%:*}:" ;;
1039                 esac
1040                 cur_="${cur_#*:}"
1041                 lhs=0
1042                 ;;
1043         +*)
1044                 pfx="+"
1045                 cur_="${cur_#+}"
1046                 ;;
1047         esac
1048         case "$cmd" in
1049         fetch)
1050                 if [ $lhs = 1 ]; then
1051                         __git_complete_fetch_refspecs "$remote" "$pfx" "$cur_"
1052                 else
1053                         __git_complete_refs --pfx="$pfx" --cur="$cur_"
1054                 fi
1055                 ;;
1056         pull|remote)
1057                 if [ $lhs = 1 ]; then
1058                         __git_complete_refs --remote="$remote" --pfx="$pfx" --cur="$cur_"
1059                 else
1060                         __git_complete_refs --pfx="$pfx" --cur="$cur_"
1061                 fi
1062                 ;;
1063         push)
1064                 if [ $lhs = 1 ]; then
1065                         __git_complete_refs --pfx="$pfx" --cur="$cur_"
1066                 else
1067                         __git_complete_refs --remote="$remote" --pfx="$pfx" --cur="$cur_"
1068                 fi
1069                 ;;
1070         esac
1071 }
1072
1073 __git_complete_strategy ()
1074 {
1075         __git_compute_merge_strategies
1076         case "$prev" in
1077         -s|--strategy)
1078                 __gitcomp "$__git_merge_strategies"
1079                 return 0
1080                 ;;
1081         -X)
1082                 __gitcomp "$__git_merge_strategy_options"
1083                 return 0
1084                 ;;
1085         esac
1086         case "$cur" in
1087         --strategy=*)
1088                 __gitcomp "$__git_merge_strategies" "" "${cur##--strategy=}"
1089                 return 0
1090                 ;;
1091         --strategy-option=*)
1092                 __gitcomp "$__git_merge_strategy_options" "" "${cur##--strategy-option=}"
1093                 return 0
1094                 ;;
1095         esac
1096         return 1
1097 }
1098
1099 __git_all_commands=
1100 __git_compute_all_commands ()
1101 {
1102         test -n "$__git_all_commands" ||
1103         __git_all_commands=$(__git --list-cmds=main,others,alias,nohelpers)
1104 }
1105
1106 # Lists all set config variables starting with the given section prefix,
1107 # with the prefix removed.
1108 __git_get_config_variables ()
1109 {
1110         local section="$1" i IFS=$'\n'
1111         for i in $(__git config --name-only --get-regexp "^$section\..*"); do
1112                 echo "${i#$section.}"
1113         done
1114 }
1115
1116 __git_pretty_aliases ()
1117 {
1118         __git_get_config_variables "pretty"
1119 }
1120
1121 # __git_aliased_command requires 1 argument
1122 __git_aliased_command ()
1123 {
1124         local word cmdline=$(__git config --get "alias.$1")
1125         for word in $cmdline; do
1126                 case "$word" in
1127                 \!gitk|gitk)
1128                         echo "gitk"
1129                         return
1130                         ;;
1131                 \!*)    : shell command alias ;;
1132                 -*)     : option ;;
1133                 *=*)    : setting env ;;
1134                 git)    : git itself ;;
1135                 \(\))   : skip parens of shell function definition ;;
1136                 {)      : skip start of shell helper function ;;
1137                 :)      : skip null command ;;
1138                 \'*)    : skip opening quote after sh -c ;;
1139                 *)
1140                         echo "$word"
1141                         return
1142                 esac
1143         done
1144 }
1145
1146 # Check whether one of the given words is present on the command line,
1147 # and print the first word found.
1148 #
1149 # Usage: __git_find_on_cmdline [<option>]... "<wordlist>"
1150 # --show-idx: Optionally show the index of the found word in the $words array.
1151 __git_find_on_cmdline ()
1152 {
1153         local word c=1 show_idx
1154
1155         while test $# -gt 1; do
1156                 case "$1" in
1157                 --show-idx)     show_idx=y ;;
1158                 *)              return 1 ;;
1159                 esac
1160                 shift
1161         done
1162         local wordlist="$1"
1163
1164         while [ $c -lt $cword ]; do
1165                 for word in $wordlist; do
1166                         if [ "$word" = "${words[c]}" ]; then
1167                                 if [ -n "${show_idx-}" ]; then
1168                                         echo "$c $word"
1169                                 else
1170                                         echo "$word"
1171                                 fi
1172                                 return
1173                         fi
1174                 done
1175                 ((c++))
1176         done
1177 }
1178
1179 # Similar to __git_find_on_cmdline, except that it loops backwards and thus
1180 # prints the *last* word found. Useful for finding which of two options that
1181 # supersede each other came last, such as "--guess" and "--no-guess".
1182 #
1183 # Usage: __git_find_last_on_cmdline [<option>]... "<wordlist>"
1184 # --show-idx: Optionally show the index of the found word in the $words array.
1185 __git_find_last_on_cmdline ()
1186 {
1187         local word c=$cword show_idx
1188
1189         while test $# -gt 1; do
1190                 case "$1" in
1191                 --show-idx)     show_idx=y ;;
1192                 *)              return 1 ;;
1193                 esac
1194                 shift
1195         done
1196         local wordlist="$1"
1197
1198         while [ $c -gt 1 ]; do
1199                 ((c--))
1200                 for word in $wordlist; do
1201                         if [ "$word" = "${words[c]}" ]; then
1202                                 if [ -n "$show_idx" ]; then
1203                                         echo "$c $word"
1204                                 else
1205                                         echo "$word"
1206                                 fi
1207                                 return
1208                         fi
1209                 done
1210         done
1211 }
1212
1213 # Echo the value of an option set on the command line or config
1214 #
1215 # $1: short option name
1216 # $2: long option name including =
1217 # $3: list of possible values
1218 # $4: config string (optional)
1219 #
1220 # example:
1221 # result="$(__git_get_option_value "-d" "--do-something=" \
1222 #     "yes no" "core.doSomething")"
1223 #
1224 # result is then either empty (no option set) or "yes" or "no"
1225 #
1226 # __git_get_option_value requires 3 arguments
1227 __git_get_option_value ()
1228 {
1229         local c short_opt long_opt val
1230         local result= values config_key word
1231
1232         short_opt="$1"
1233         long_opt="$2"
1234         values="$3"
1235         config_key="$4"
1236
1237         ((c = $cword - 1))
1238         while [ $c -ge 0 ]; do
1239                 word="${words[c]}"
1240                 for val in $values; do
1241                         if [ "$short_opt$val" = "$word" ] ||
1242                            [ "$long_opt$val"  = "$word" ]; then
1243                                 result="$val"
1244                                 break 2
1245                         fi
1246                 done
1247                 ((c--))
1248         done
1249
1250         if [ -n "$config_key" ] && [ -z "$result" ]; then
1251                 result="$(__git config "$config_key")"
1252         fi
1253
1254         echo "$result"
1255 }
1256
1257 __git_has_doubledash ()
1258 {
1259         local c=1
1260         while [ $c -lt $cword ]; do
1261                 if [ "--" = "${words[c]}" ]; then
1262                         return 0
1263                 fi
1264                 ((c++))
1265         done
1266         return 1
1267 }
1268
1269 # Try to count non option arguments passed on the command line for the
1270 # specified git command.
1271 # When options are used, it is necessary to use the special -- option to
1272 # tell the implementation were non option arguments begin.
1273 # XXX this can not be improved, since options can appear everywhere, as
1274 # an example:
1275 #       git mv x -n y
1276 #
1277 # __git_count_arguments requires 1 argument: the git command executed.
1278 __git_count_arguments ()
1279 {
1280         local word i c=0
1281
1282         # Skip "git" (first argument)
1283         for ((i=1; i < ${#words[@]}; i++)); do
1284                 word="${words[i]}"
1285
1286                 case "$word" in
1287                         --)
1288                                 # Good; we can assume that the following are only non
1289                                 # option arguments.
1290                                 ((c = 0))
1291                                 ;;
1292                         "$1")
1293                                 # Skip the specified git command and discard git
1294                                 # main options
1295                                 ((c = 0))
1296                                 ;;
1297                         ?*)
1298                                 ((c++))
1299                                 ;;
1300                 esac
1301         done
1302
1303         printf "%d" $c
1304 }
1305
1306 __git_whitespacelist="nowarn warn error error-all fix"
1307 __git_patchformat="mbox stgit stgit-series hg mboxrd"
1308 __git_showcurrentpatch="diff raw"
1309 __git_am_inprogress_options="--skip --continue --resolved --abort --quit --show-current-patch"
1310
1311 _git_am ()
1312 {
1313         __git_find_repo_path
1314         if [ -d "$__git_repo_path"/rebase-apply ]; then
1315                 __gitcomp "$__git_am_inprogress_options"
1316                 return
1317         fi
1318         case "$cur" in
1319         --whitespace=*)
1320                 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1321                 return
1322                 ;;
1323         --patch-format=*)
1324                 __gitcomp "$__git_patchformat" "" "${cur##--patch-format=}"
1325                 return
1326                 ;;
1327         --show-current-patch=*)
1328                 __gitcomp "$__git_showcurrentpatch" "" "${cur##--show-current-patch=}"
1329                 return
1330                 ;;
1331         --*)
1332                 __gitcomp_builtin am "" \
1333                         "$__git_am_inprogress_options"
1334                 return
1335         esac
1336 }
1337
1338 _git_apply ()
1339 {
1340         case "$cur" in
1341         --whitespace=*)
1342                 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1343                 return
1344                 ;;
1345         --*)
1346                 __gitcomp_builtin apply
1347                 return
1348         esac
1349 }
1350
1351 _git_add ()
1352 {
1353         case "$cur" in
1354         --chmod=*)
1355                 __gitcomp "+x -x" "" "${cur##--chmod=}"
1356                 return
1357                 ;;
1358         --*)
1359                 __gitcomp_builtin add
1360                 return
1361         esac
1362
1363         local complete_opt="--others --modified --directory --no-empty-directory"
1364         if test -n "$(__git_find_on_cmdline "-u --update")"
1365         then
1366                 complete_opt="--modified"
1367         fi
1368         __git_complete_index_file "$complete_opt"
1369 }
1370
1371 _git_archive ()
1372 {
1373         case "$cur" in
1374         --format=*)
1375                 __gitcomp "$(git archive --list)" "" "${cur##--format=}"
1376                 return
1377                 ;;
1378         --remote=*)
1379                 __gitcomp_nl "$(__git_remotes)" "" "${cur##--remote=}"
1380                 return
1381                 ;;
1382         --*)
1383                 __gitcomp_builtin archive "--format= --list --verbose --prefix= --worktree-attributes"
1384                 return
1385                 ;;
1386         esac
1387         __git_complete_file
1388 }
1389
1390 _git_bisect ()
1391 {
1392         __git_has_doubledash && return
1393
1394         local subcommands="start bad good skip reset visualize replay log run"
1395         local subcommand="$(__git_find_on_cmdline "$subcommands")"
1396         if [ -z "$subcommand" ]; then
1397                 __git_find_repo_path
1398                 if [ -f "$__git_repo_path"/BISECT_START ]; then
1399                         __gitcomp "$subcommands"
1400                 else
1401                         __gitcomp "replay start"
1402                 fi
1403                 return
1404         fi
1405
1406         case "$subcommand" in
1407         bad|good|reset|skip|start)
1408                 __git_complete_refs
1409                 ;;
1410         *)
1411                 ;;
1412         esac
1413 }
1414
1415 __git_ref_fieldlist="refname objecttype objectsize objectname upstream push HEAD symref"
1416
1417 _git_branch ()
1418 {
1419         local i c=1 only_local_ref="n" has_r="n"
1420
1421         while [ $c -lt $cword ]; do
1422                 i="${words[c]}"
1423                 case "$i" in
1424                 -d|--delete|-m|--move)  only_local_ref="y" ;;
1425                 -r|--remotes)           has_r="y" ;;
1426                 esac
1427                 ((c++))
1428         done
1429
1430         case "$cur" in
1431         --set-upstream-to=*)
1432                 __git_complete_refs --cur="${cur##--set-upstream-to=}"
1433                 ;;
1434         --*)
1435                 __gitcomp_builtin branch
1436                 ;;
1437         *)
1438                 if [ $only_local_ref = "y" -a $has_r = "n" ]; then
1439                         __gitcomp_direct "$(__git_heads "" "$cur" " ")"
1440                 else
1441                         __git_complete_refs
1442                 fi
1443                 ;;
1444         esac
1445 }
1446
1447 _git_bundle ()
1448 {
1449         local cmd="${words[2]}"
1450         case "$cword" in
1451         2)
1452                 __gitcomp "create list-heads verify unbundle"
1453                 ;;
1454         3)
1455                 # looking for a file
1456                 ;;
1457         *)
1458                 case "$cmd" in
1459                         create)
1460                                 __git_complete_revlist
1461                         ;;
1462                 esac
1463                 ;;
1464         esac
1465 }
1466
1467 # Helper function to decide whether or not we should enable DWIM logic for
1468 # git-switch and git-checkout.
1469 #
1470 # To decide between the following rules in priority order
1471 # 1) the last provided of "--guess" or "--no-guess" explicitly enable or
1472 #    disable completion of DWIM logic respectively.
1473 # 2) If the --no-track option is provided, take this as a hint to disable the
1474 #    DWIM completion logic
1475 # 3) If GIT_COMPLETION_CHECKOUT_NO_GUESS is set, disable the DWIM completion
1476 #    logic, as requested by the user.
1477 # 4) Enable DWIM logic otherwise.
1478 #
1479 __git_checkout_default_dwim_mode ()
1480 {
1481         local last_option dwim_opt="--dwim"
1482
1483         if [ "${GIT_COMPLETION_CHECKOUT_NO_GUESS-}" = "1" ]; then
1484                 dwim_opt=""
1485         fi
1486
1487         # --no-track disables DWIM, but with lower priority than
1488         # --guess/--no-guess
1489         if [ -n "$(__git_find_on_cmdline "--no-track")" ]; then
1490                 dwim_opt=""
1491         fi
1492
1493         # Find the last provided --guess or --no-guess
1494         last_option="$(__git_find_last_on_cmdline "--guess --no-guess")"
1495         case "$last_option" in
1496                 --guess)
1497                         dwim_opt="--dwim"
1498                         ;;
1499                 --no-guess)
1500                         dwim_opt=""
1501                         ;;
1502         esac
1503
1504         echo "$dwim_opt"
1505 }
1506
1507 _git_checkout ()
1508 {
1509         __git_has_doubledash && return
1510
1511         case "$cur" in
1512         --conflict=*)
1513                 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
1514                 ;;
1515         --*)
1516                 __gitcomp_builtin checkout
1517                 ;;
1518         *)
1519                 local dwim_opt="$(__git_checkout_default_dwim_mode)"
1520                 local prevword prevword="${words[cword-1]}"
1521
1522                 case "$prevword" in
1523                         -b|-B|--orphan)
1524                                 # Complete local branches (and DWIM branch
1525                                 # remote branch names) for an option argument
1526                                 # specifying a new branch name. This is for
1527                                 # convenience, assuming new branches are
1528                                 # possibly based on pre-existing branch names.
1529                                 __git_complete_refs $dwim_opt --mode="heads"
1530                                 return
1531                                 ;;
1532                         *)
1533                                 ;;
1534                 esac
1535
1536                 # At this point, we've already handled special completion for
1537                 # the arguments to -b/-B, and --orphan. There are 3 main
1538                 # things left we can possibly complete:
1539                 # 1) a start-point for -b/-B, -d/--detach, or --orphan
1540                 # 2) a remote head, for --track
1541                 # 3) an arbitrary reference, possibly including DWIM names
1542                 #
1543
1544                 if [ -n "$(__git_find_on_cmdline "-b -B -d --detach --orphan")" ]; then
1545                         __git_complete_refs --mode="refs"
1546                 elif [ -n "$(__git_find_on_cmdline "--track")" ]; then
1547                         __git_complete_refs --mode="remote-heads"
1548                 else
1549                         __git_complete_refs $dwim_opt --mode="refs"
1550                 fi
1551                 ;;
1552         esac
1553 }
1554
1555 __git_sequencer_inprogress_options="--continue --quit --abort --skip"
1556
1557 __git_cherry_pick_inprogress_options=$__git_sequencer_inprogress_options
1558
1559 _git_cherry_pick ()
1560 {
1561         __git_find_repo_path
1562         if [ -f "$__git_repo_path"/CHERRY_PICK_HEAD ]; then
1563                 __gitcomp "$__git_cherry_pick_inprogress_options"
1564                 return
1565         fi
1566
1567         __git_complete_strategy && return
1568
1569         case "$cur" in
1570         --*)
1571                 __gitcomp_builtin cherry-pick "" \
1572                         "$__git_cherry_pick_inprogress_options"
1573                 ;;
1574         *)
1575                 __git_complete_refs
1576                 ;;
1577         esac
1578 }
1579
1580 _git_clean ()
1581 {
1582         case "$cur" in
1583         --*)
1584                 __gitcomp_builtin clean
1585                 return
1586                 ;;
1587         esac
1588
1589         # XXX should we check for -x option ?
1590         __git_complete_index_file "--others --directory"
1591 }
1592
1593 _git_clone ()
1594 {
1595         case "$prev" in
1596         -c|--config)
1597                 __git_complete_config_variable_name_and_value
1598                 return
1599                 ;;
1600         esac
1601         case "$cur" in
1602         --config=*)
1603                 __git_complete_config_variable_name_and_value \
1604                         --cur="${cur##--config=}"
1605                 return
1606                 ;;
1607         --*)
1608                 __gitcomp_builtin clone
1609                 return
1610                 ;;
1611         esac
1612 }
1613
1614 __git_untracked_file_modes="all no normal"
1615
1616 _git_commit ()
1617 {
1618         case "$prev" in
1619         -c|-C)
1620                 __git_complete_refs
1621                 return
1622                 ;;
1623         esac
1624
1625         case "$cur" in
1626         --cleanup=*)
1627                 __gitcomp "default scissors strip verbatim whitespace
1628                         " "" "${cur##--cleanup=}"
1629                 return
1630                 ;;
1631         --reuse-message=*|--reedit-message=*|\
1632         --fixup=*|--squash=*)
1633                 __git_complete_refs --cur="${cur#*=}"
1634                 return
1635                 ;;
1636         --untracked-files=*)
1637                 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
1638                 return
1639                 ;;
1640         --*)
1641                 __gitcomp_builtin commit
1642                 return
1643         esac
1644
1645         if __git rev-parse --verify --quiet HEAD >/dev/null; then
1646                 __git_complete_index_file "--committable"
1647         else
1648                 # This is the first commit
1649                 __git_complete_index_file "--cached"
1650         fi
1651 }
1652
1653 _git_describe ()
1654 {
1655         case "$cur" in
1656         --*)
1657                 __gitcomp_builtin describe
1658                 return
1659         esac
1660         __git_complete_refs
1661 }
1662
1663 __git_diff_algorithms="myers minimal patience histogram"
1664
1665 __git_diff_submodule_formats="diff log short"
1666
1667 __git_color_moved_opts="no default plain blocks zebra dimmed-zebra"
1668
1669 __git_color_moved_ws_opts="no ignore-space-at-eol ignore-space-change
1670                         ignore-all-space allow-indentation-change"
1671
1672 __git_diff_common_options="--stat --numstat --shortstat --summary
1673                         --patch-with-stat --name-only --name-status --color
1674                         --no-color --color-words --no-renames --check
1675                         --color-moved --color-moved= --no-color-moved
1676                         --color-moved-ws= --no-color-moved-ws
1677                         --full-index --binary --abbrev --diff-filter=
1678                         --find-copies-harder --ignore-cr-at-eol
1679                         --text --ignore-space-at-eol --ignore-space-change
1680                         --ignore-all-space --ignore-blank-lines --exit-code
1681                         --quiet --ext-diff --no-ext-diff
1682                         --no-prefix --src-prefix= --dst-prefix=
1683                         --inter-hunk-context=
1684                         --patience --histogram --minimal
1685                         --raw --word-diff --word-diff-regex=
1686                         --dirstat --dirstat= --dirstat-by-file
1687                         --dirstat-by-file= --cumulative
1688                         --diff-algorithm=
1689                         --submodule --submodule= --ignore-submodules
1690                         --indent-heuristic --no-indent-heuristic
1691                         --textconv --no-textconv
1692 "
1693
1694 _git_diff ()
1695 {
1696         __git_has_doubledash && return
1697
1698         case "$cur" in
1699         --diff-algorithm=*)
1700                 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
1701                 return
1702                 ;;
1703         --submodule=*)
1704                 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
1705                 return
1706                 ;;
1707         --color-moved=*)
1708                 __gitcomp "$__git_color_moved_opts" "" "${cur##--color-moved=}"
1709                 return
1710                 ;;
1711         --color-moved-ws=*)
1712                 __gitcomp "$__git_color_moved_ws_opts" "" "${cur##--color-moved-ws=}"
1713                 return
1714                 ;;
1715         --*)
1716                 __gitcomp "--cached --staged --pickaxe-all --pickaxe-regex
1717                         --base --ours --theirs --no-index
1718                         $__git_diff_common_options
1719                         "
1720                 return
1721                 ;;
1722         esac
1723         __git_complete_revlist_file
1724 }
1725
1726 __git_mergetools_common="diffuse diffmerge ecmerge emerge kdiff3 meld opendiff
1727                         tkdiff vimdiff nvimdiff gvimdiff xxdiff araxis p4merge
1728                         bc codecompare smerge
1729 "
1730
1731 _git_difftool ()
1732 {
1733         __git_has_doubledash && return
1734
1735         case "$cur" in
1736         --tool=*)
1737                 __gitcomp "$__git_mergetools_common kompare" "" "${cur##--tool=}"
1738                 return
1739                 ;;
1740         --*)
1741                 __gitcomp_builtin difftool "$__git_diff_common_options
1742                                         --base --cached --ours --theirs
1743                                         --pickaxe-all --pickaxe-regex
1744                                         --relative --staged
1745                                         "
1746                 return
1747                 ;;
1748         esac
1749         __git_complete_revlist_file
1750 }
1751
1752 __git_fetch_recurse_submodules="yes on-demand no"
1753
1754 _git_fetch ()
1755 {
1756         case "$cur" in
1757         --recurse-submodules=*)
1758                 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
1759                 return
1760                 ;;
1761         --filter=*)
1762                 __gitcomp "blob:none blob:limit= sparse:oid=" "" "${cur##--filter=}"
1763                 return
1764                 ;;
1765         --*)
1766                 __gitcomp_builtin fetch
1767                 return
1768                 ;;
1769         esac
1770         __git_complete_remote_or_refspec
1771 }
1772
1773 __git_format_patch_extra_options="
1774         --full-index --not --all --no-prefix --src-prefix=
1775         --dst-prefix= --notes
1776 "
1777
1778 _git_format_patch ()
1779 {
1780         case "$cur" in
1781         --thread=*)
1782                 __gitcomp "
1783                         deep shallow
1784                         " "" "${cur##--thread=}"
1785                 return
1786                 ;;
1787         --*)
1788                 __gitcomp_builtin format-patch "$__git_format_patch_extra_options"
1789                 return
1790                 ;;
1791         esac
1792         __git_complete_revlist
1793 }
1794
1795 _git_fsck ()
1796 {
1797         case "$cur" in
1798         --*)
1799                 __gitcomp_builtin fsck
1800                 return
1801                 ;;
1802         esac
1803 }
1804
1805 _git_gitk ()
1806 {
1807         _gitk
1808 }
1809
1810 # Lists matching symbol names from a tag (as in ctags) file.
1811 # 1: List symbol names matching this word.
1812 # 2: The tag file to list symbol names from.
1813 # 3: A prefix to be added to each listed symbol name (optional).
1814 # 4: A suffix to be appended to each listed symbol name (optional).
1815 __git_match_ctag () {
1816         awk -v pfx="${3-}" -v sfx="${4-}" "
1817                 /^${1//\//\\/}/ { print pfx \$1 sfx }
1818                 " "$2"
1819 }
1820
1821 # Complete symbol names from a tag file.
1822 # Usage: __git_complete_symbol [<option>]...
1823 # --tags=<file>: The tag file to list symbol names from instead of the
1824 #                default "tags".
1825 # --pfx=<prefix>: A prefix to be added to each symbol name.
1826 # --cur=<word>: The current symbol name to be completed.  Defaults to
1827 #               the current word to be completed.
1828 # --sfx=<suffix>: A suffix to be appended to each symbol name instead
1829 #                 of the default space.
1830 __git_complete_symbol () {
1831         local tags=tags pfx="" cur_="${cur-}" sfx=" "
1832
1833         while test $# != 0; do
1834                 case "$1" in
1835                 --tags=*)       tags="${1##--tags=}" ;;
1836                 --pfx=*)        pfx="${1##--pfx=}" ;;
1837                 --cur=*)        cur_="${1##--cur=}" ;;
1838                 --sfx=*)        sfx="${1##--sfx=}" ;;
1839                 *)              return 1 ;;
1840                 esac
1841                 shift
1842         done
1843
1844         if test -r "$tags"; then
1845                 __gitcomp_direct "$(__git_match_ctag "$cur_" "$tags" "$pfx" "$sfx")"
1846         fi
1847 }
1848
1849 _git_grep ()
1850 {
1851         __git_has_doubledash && return
1852
1853         case "$cur" in
1854         --*)
1855                 __gitcomp_builtin grep
1856                 return
1857                 ;;
1858         esac
1859
1860         case "$cword,$prev" in
1861         2,*|*,-*)
1862                 __git_complete_symbol && return
1863                 ;;
1864         esac
1865
1866         __git_complete_refs
1867 }
1868
1869 _git_help ()
1870 {
1871         case "$cur" in
1872         --*)
1873                 __gitcomp_builtin help
1874                 return
1875                 ;;
1876         esac
1877         if test -n "$GIT_TESTING_ALL_COMMAND_LIST"
1878         then
1879                 __gitcomp "$GIT_TESTING_ALL_COMMAND_LIST $(__git --list-cmds=alias,list-guide) gitk"
1880         else
1881                 __gitcomp "$(__git --list-cmds=main,nohelpers,alias,list-guide) gitk"
1882         fi
1883 }
1884
1885 _git_init ()
1886 {
1887         case "$cur" in
1888         --shared=*)
1889                 __gitcomp "
1890                         false true umask group all world everybody
1891                         " "" "${cur##--shared=}"
1892                 return
1893                 ;;
1894         --*)
1895                 __gitcomp_builtin init
1896                 return
1897                 ;;
1898         esac
1899 }
1900
1901 _git_ls_files ()
1902 {
1903         case "$cur" in
1904         --*)
1905                 __gitcomp_builtin ls-files
1906                 return
1907                 ;;
1908         esac
1909
1910         # XXX ignore options like --modified and always suggest all cached
1911         # files.
1912         __git_complete_index_file "--cached"
1913 }
1914
1915 _git_ls_remote ()
1916 {
1917         case "$cur" in
1918         --*)
1919                 __gitcomp_builtin ls-remote
1920                 return
1921                 ;;
1922         esac
1923         __gitcomp_nl "$(__git_remotes)"
1924 }
1925
1926 _git_ls_tree ()
1927 {
1928         case "$cur" in
1929         --*)
1930                 __gitcomp_builtin ls-tree
1931                 return
1932                 ;;
1933         esac
1934
1935         __git_complete_file
1936 }
1937
1938 # Options that go well for log, shortlog and gitk
1939 __git_log_common_options="
1940         --not --all
1941         --branches --tags --remotes
1942         --first-parent --merges --no-merges
1943         --max-count=
1944         --max-age= --since= --after=
1945         --min-age= --until= --before=
1946         --min-parents= --max-parents=
1947         --no-min-parents --no-max-parents
1948 "
1949 # Options that go well for log and gitk (not shortlog)
1950 __git_log_gitk_options="
1951         --dense --sparse --full-history
1952         --simplify-merges --simplify-by-decoration
1953         --left-right --notes --no-notes
1954 "
1955 # Options that go well for log and shortlog (not gitk)
1956 __git_log_shortlog_options="
1957         --author= --committer= --grep=
1958         --all-match --invert-grep
1959 "
1960
1961 __git_log_pretty_formats="oneline short medium full fuller reference email raw format: tformat: mboxrd"
1962 __git_log_date_formats="relative iso8601 iso8601-strict rfc2822 short local default raw unix format:"
1963
1964 _git_log ()
1965 {
1966         __git_has_doubledash && return
1967         __git_find_repo_path
1968
1969         local merge=""
1970         if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
1971                 merge="--merge"
1972         fi
1973         case "$prev,$cur" in
1974         -L,:*:*)
1975                 return  # fall back to Bash filename completion
1976                 ;;
1977         -L,:*)
1978                 __git_complete_symbol --cur="${cur#:}" --sfx=":"
1979                 return
1980                 ;;
1981         -G,*|-S,*)
1982                 __git_complete_symbol
1983                 return
1984                 ;;
1985         esac
1986         case "$cur" in
1987         --pretty=*|--format=*)
1988                 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
1989                         " "" "${cur#*=}"
1990                 return
1991                 ;;
1992         --date=*)
1993                 __gitcomp "$__git_log_date_formats" "" "${cur##--date=}"
1994                 return
1995                 ;;
1996         --decorate=*)
1997                 __gitcomp "full short no" "" "${cur##--decorate=}"
1998                 return
1999                 ;;
2000         --diff-algorithm=*)
2001                 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
2002                 return
2003                 ;;
2004         --submodule=*)
2005                 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
2006                 return
2007                 ;;
2008         --no-walk=*)
2009                 __gitcomp "sorted unsorted" "" "${cur##--no-walk=}"
2010                 return
2011                 ;;
2012         --*)
2013                 __gitcomp "
2014                         $__git_log_common_options
2015                         $__git_log_shortlog_options
2016                         $__git_log_gitk_options
2017                         --root --topo-order --date-order --reverse
2018                         --follow --full-diff
2019                         --abbrev-commit --no-abbrev-commit --abbrev=
2020                         --relative-date --date=
2021                         --pretty= --format= --oneline
2022                         --show-signature
2023                         --cherry-mark
2024                         --cherry-pick
2025                         --graph
2026                         --decorate --decorate= --no-decorate
2027                         --walk-reflogs
2028                         --no-walk --no-walk= --do-walk
2029                         --parents --children
2030                         --expand-tabs --expand-tabs= --no-expand-tabs
2031                         --patch
2032                         $merge
2033                         $__git_diff_common_options
2034                         --pickaxe-all --pickaxe-regex
2035                         --patch --no-patch
2036                         "
2037                 return
2038                 ;;
2039         -L:*:*)
2040                 return  # fall back to Bash filename completion
2041                 ;;
2042         -L:*)
2043                 __git_complete_symbol --cur="${cur#-L:}" --sfx=":"
2044                 return
2045                 ;;
2046         -G*)
2047                 __git_complete_symbol --pfx="-G" --cur="${cur#-G}"
2048                 return
2049                 ;;
2050         -S*)
2051                 __git_complete_symbol --pfx="-S" --cur="${cur#-S}"
2052                 return
2053                 ;;
2054         esac
2055         __git_complete_revlist
2056 }
2057
2058 _git_merge ()
2059 {
2060         __git_complete_strategy && return
2061
2062         case "$cur" in
2063         --*)
2064                 __gitcomp_builtin merge
2065                 return
2066         esac
2067         __git_complete_refs
2068 }
2069
2070 _git_mergetool ()
2071 {
2072         case "$cur" in
2073         --tool=*)
2074                 __gitcomp "$__git_mergetools_common tortoisemerge" "" "${cur##--tool=}"
2075                 return
2076                 ;;
2077         --*)
2078                 __gitcomp "--tool= --prompt --no-prompt --gui --no-gui"
2079                 return
2080                 ;;
2081         esac
2082 }
2083
2084 _git_merge_base ()
2085 {
2086         case "$cur" in
2087         --*)
2088                 __gitcomp_builtin merge-base
2089                 return
2090                 ;;
2091         esac
2092         __git_complete_refs
2093 }
2094
2095 _git_mv ()
2096 {
2097         case "$cur" in
2098         --*)
2099                 __gitcomp_builtin mv
2100                 return
2101                 ;;
2102         esac
2103
2104         if [ $(__git_count_arguments "mv") -gt 0 ]; then
2105                 # We need to show both cached and untracked files (including
2106                 # empty directories) since this may not be the last argument.
2107                 __git_complete_index_file "--cached --others --directory"
2108         else
2109                 __git_complete_index_file "--cached"
2110         fi
2111 }
2112
2113 _git_notes ()
2114 {
2115         local subcommands='add append copy edit get-ref list merge prune remove show'
2116         local subcommand="$(__git_find_on_cmdline "$subcommands")"
2117
2118         case "$subcommand,$cur" in
2119         ,--*)
2120                 __gitcomp_builtin notes
2121                 ;;
2122         ,*)
2123                 case "$prev" in
2124                 --ref)
2125                         __git_complete_refs
2126                         ;;
2127                 *)
2128                         __gitcomp "$subcommands --ref"
2129                         ;;
2130                 esac
2131                 ;;
2132         *,--reuse-message=*|*,--reedit-message=*)
2133                 __git_complete_refs --cur="${cur#*=}"
2134                 ;;
2135         *,--*)
2136                 __gitcomp_builtin notes_$subcommand
2137                 ;;
2138         prune,*|get-ref,*)
2139                 # this command does not take a ref, do not complete it
2140                 ;;
2141         *)
2142                 case "$prev" in
2143                 -m|-F)
2144                         ;;
2145                 *)
2146                         __git_complete_refs
2147                         ;;
2148                 esac
2149                 ;;
2150         esac
2151 }
2152
2153 _git_pull ()
2154 {
2155         __git_complete_strategy && return
2156
2157         case "$cur" in
2158         --recurse-submodules=*)
2159                 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
2160                 return
2161                 ;;
2162         --*)
2163                 __gitcomp_builtin pull
2164
2165                 return
2166                 ;;
2167         esac
2168         __git_complete_remote_or_refspec
2169 }
2170
2171 __git_push_recurse_submodules="check on-demand only"
2172
2173 __git_complete_force_with_lease ()
2174 {
2175         local cur_=$1
2176
2177         case "$cur_" in
2178         --*=)
2179                 ;;
2180         *:*)
2181                 __git_complete_refs --cur="${cur_#*:}"
2182                 ;;
2183         *)
2184                 __git_complete_refs --cur="$cur_"
2185                 ;;
2186         esac
2187 }
2188
2189 _git_push ()
2190 {
2191         case "$prev" in
2192         --repo)
2193                 __gitcomp_nl "$(__git_remotes)"
2194                 return
2195                 ;;
2196         --recurse-submodules)
2197                 __gitcomp "$__git_push_recurse_submodules"
2198                 return
2199                 ;;
2200         esac
2201         case "$cur" in
2202         --repo=*)
2203                 __gitcomp_nl "$(__git_remotes)" "" "${cur##--repo=}"
2204                 return
2205                 ;;
2206         --recurse-submodules=*)
2207                 __gitcomp "$__git_push_recurse_submodules" "" "${cur##--recurse-submodules=}"
2208                 return
2209                 ;;
2210         --force-with-lease=*)
2211                 __git_complete_force_with_lease "${cur##--force-with-lease=}"
2212                 return
2213                 ;;
2214         --*)
2215                 __gitcomp_builtin push
2216                 return
2217                 ;;
2218         esac
2219         __git_complete_remote_or_refspec
2220 }
2221
2222 _git_range_diff ()
2223 {
2224         case "$cur" in
2225         --*)
2226                 __gitcomp "
2227                         --creation-factor= --no-dual-color
2228                         $__git_diff_common_options
2229                 "
2230                 return
2231                 ;;
2232         esac
2233         __git_complete_revlist
2234 }
2235
2236 __git_rebase_inprogress_options="--continue --skip --abort --quit --show-current-patch"
2237 __git_rebase_interactive_inprogress_options="$__git_rebase_inprogress_options --edit-todo"
2238
2239 _git_rebase ()
2240 {
2241         __git_find_repo_path
2242         if [ -f "$__git_repo_path"/rebase-merge/interactive ]; then
2243                 __gitcomp "$__git_rebase_interactive_inprogress_options"
2244                 return
2245         elif [ -d "$__git_repo_path"/rebase-apply ] || \
2246              [ -d "$__git_repo_path"/rebase-merge ]; then
2247                 __gitcomp "$__git_rebase_inprogress_options"
2248                 return
2249         fi
2250         __git_complete_strategy && return
2251         case "$cur" in
2252         --whitespace=*)
2253                 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
2254                 return
2255                 ;;
2256         --onto=*)
2257                 __git_complete_refs --cur="${cur##--onto=}"
2258                 return
2259                 ;;
2260         --*)
2261                 __gitcomp_builtin rebase "" \
2262                         "$__git_rebase_interactive_inprogress_options"
2263
2264                 return
2265         esac
2266         __git_complete_refs
2267 }
2268
2269 _git_reflog ()
2270 {
2271         local subcommands="show delete expire"
2272         local subcommand="$(__git_find_on_cmdline "$subcommands")"
2273
2274         if [ -z "$subcommand" ]; then
2275                 __gitcomp "$subcommands"
2276         else
2277                 __git_complete_refs
2278         fi
2279 }
2280
2281 __git_send_email_confirm_options="always never auto cc compose"
2282 __git_send_email_suppresscc_options="author self cc bodycc sob cccmd body all"
2283
2284 _git_send_email ()
2285 {
2286         case "$prev" in
2287         --to|--cc|--bcc|--from)
2288                 __gitcomp "$(__git send-email --dump-aliases)"
2289                 return
2290                 ;;
2291         esac
2292
2293         case "$cur" in
2294         --confirm=*)
2295                 __gitcomp "
2296                         $__git_send_email_confirm_options
2297                         " "" "${cur##--confirm=}"
2298                 return
2299                 ;;
2300         --suppress-cc=*)
2301                 __gitcomp "
2302                         $__git_send_email_suppresscc_options
2303                         " "" "${cur##--suppress-cc=}"
2304
2305                 return
2306                 ;;
2307         --smtp-encryption=*)
2308                 __gitcomp "ssl tls" "" "${cur##--smtp-encryption=}"
2309                 return
2310                 ;;
2311         --thread=*)
2312                 __gitcomp "
2313                         deep shallow
2314                         " "" "${cur##--thread=}"
2315                 return
2316                 ;;
2317         --to=*|--cc=*|--bcc=*|--from=*)
2318                 __gitcomp "$(__git send-email --dump-aliases)" "" "${cur#--*=}"
2319                 return
2320                 ;;
2321         --*)
2322                 __gitcomp_builtin send-email "--annotate --bcc --cc --cc-cmd --chain-reply-to
2323                         --compose --confirm= --dry-run --envelope-sender
2324                         --from --identity
2325                         --in-reply-to --no-chain-reply-to --no-signed-off-by-cc
2326                         --no-suppress-from --no-thread --quiet --reply-to
2327                         --signed-off-by-cc --smtp-pass --smtp-server
2328                         --smtp-server-port --smtp-encryption= --smtp-user
2329                         --subject --suppress-cc= --suppress-from --thread --to
2330                         --validate --no-validate
2331                         $__git_format_patch_extra_options"
2332                 return
2333                 ;;
2334         esac
2335         __git_complete_revlist
2336 }
2337
2338 _git_stage ()
2339 {
2340         _git_add
2341 }
2342
2343 _git_status ()
2344 {
2345         local complete_opt
2346         local untracked_state
2347
2348         case "$cur" in
2349         --ignore-submodules=*)
2350                 __gitcomp "none untracked dirty all" "" "${cur##--ignore-submodules=}"
2351                 return
2352                 ;;
2353         --untracked-files=*)
2354                 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
2355                 return
2356                 ;;
2357         --column=*)
2358                 __gitcomp "
2359                         always never auto column row plain dense nodense
2360                         " "" "${cur##--column=}"
2361                 return
2362                 ;;
2363         --*)
2364                 __gitcomp_builtin status
2365                 return
2366                 ;;
2367         esac
2368
2369         untracked_state="$(__git_get_option_value "-u" "--untracked-files=" \
2370                 "$__git_untracked_file_modes" "status.showUntrackedFiles")"
2371
2372         case "$untracked_state" in
2373         no)
2374                 # --ignored option does not matter
2375                 complete_opt=
2376                 ;;
2377         all|normal|*)
2378                 complete_opt="--cached --directory --no-empty-directory --others"
2379
2380                 if [ -n "$(__git_find_on_cmdline "--ignored")" ]; then
2381                         complete_opt="$complete_opt --ignored --exclude=*"
2382                 fi
2383                 ;;
2384         esac
2385
2386         __git_complete_index_file "$complete_opt"
2387 }
2388
2389 _git_switch ()
2390 {
2391         case "$cur" in
2392         --conflict=*)
2393                 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2394                 ;;
2395         --*)
2396                 __gitcomp_builtin switch
2397                 ;;
2398         *)
2399                 local dwim_opt="$(__git_checkout_default_dwim_mode)"
2400                 local prevword prevword="${words[cword-1]}"
2401
2402                 case "$prevword" in
2403                         -c|-C|--orphan)
2404                                 # Complete local branches (and DWIM branch
2405                                 # remote branch names) for an option argument
2406                                 # specifying a new branch name. This is for
2407                                 # convenience, assuming new branches are
2408                                 # possibly based on pre-existing branch names.
2409                                 __git_complete_refs $dwim_opt --mode="heads"
2410                                 return
2411                                 ;;
2412                         *)
2413                                 ;;
2414                 esac
2415
2416                 # Unlike in git checkout, git switch --orphan does not take
2417                 # a start point. Thus we really have nothing to complete after
2418                 # the branch name.
2419                 if [ -n "$(__git_find_on_cmdline "--orphan")" ]; then
2420                         return
2421                 fi
2422
2423                 # At this point, we've already handled special completion for
2424                 # -c/-C, and --orphan. There are 3 main things left to
2425                 # complete:
2426                 # 1) a start-point for -c/-C or -d/--detach
2427                 # 2) a remote head, for --track
2428                 # 3) a branch name, possibly including DWIM remote branches
2429
2430                 if [ -n "$(__git_find_on_cmdline "-c -C -d --detach")" ]; then
2431                         __git_complete_refs --mode="refs"
2432                 elif [ -n "$(__git_find_on_cmdline "--track")" ]; then
2433                         __git_complete_refs --mode="remote-heads"
2434                 else
2435                         __git_complete_refs $dwim_opt --mode="heads"
2436                 fi
2437                 ;;
2438         esac
2439 }
2440
2441 __git_config_get_set_variables ()
2442 {
2443         local prevword word config_file= c=$cword
2444         while [ $c -gt 1 ]; do
2445                 word="${words[c]}"
2446                 case "$word" in
2447                 --system|--global|--local|--file=*)
2448                         config_file="$word"
2449                         break
2450                         ;;
2451                 -f|--file)
2452                         config_file="$word $prevword"
2453                         break
2454                         ;;
2455                 esac
2456                 prevword=$word
2457                 c=$((--c))
2458         done
2459
2460         __git config $config_file --name-only --list
2461 }
2462
2463 __git_config_vars=
2464 __git_compute_config_vars ()
2465 {
2466         test -n "$__git_config_vars" ||
2467         __git_config_vars="$(git help --config-for-completion | sort -u)"
2468 }
2469
2470 # Completes possible values of various configuration variables.
2471 #
2472 # Usage: __git_complete_config_variable_value [<option>]...
2473 # --varname=<word>: The name of the configuration variable whose value is
2474 #                   to be completed.  Defaults to the previous word on the
2475 #                   command line.
2476 # --cur=<word>: The current value to be completed.  Defaults to the current
2477 #               word to be completed.
2478 __git_complete_config_variable_value ()
2479 {
2480         local varname="$prev" cur_="$cur"
2481
2482         while test $# != 0; do
2483                 case "$1" in
2484                 --varname=*)    varname="${1##--varname=}" ;;
2485                 --cur=*)        cur_="${1##--cur=}" ;;
2486                 *)              return 1 ;;
2487                 esac
2488                 shift
2489         done
2490
2491         if [ "${BASH_VERSINFO[0]:-0}" -ge 4 ]; then
2492                 varname="${varname,,}"
2493         else
2494                 varname="$(echo "$varname" |tr A-Z a-z)"
2495         fi
2496
2497         case "$varname" in
2498         branch.*.remote|branch.*.pushremote)
2499                 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2500                 return
2501                 ;;
2502         branch.*.merge)
2503                 __git_complete_refs --cur="$cur_"
2504                 return
2505                 ;;
2506         branch.*.rebase)
2507                 __gitcomp "false true merges preserve interactive" "" "$cur_"
2508                 return
2509                 ;;
2510         remote.pushdefault)
2511                 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2512                 return
2513                 ;;
2514         remote.*.fetch)
2515                 local remote="${varname#remote.}"
2516                 remote="${remote%.fetch}"
2517                 if [ -z "$cur_" ]; then
2518                         __gitcomp_nl "refs/heads/" "" "" ""
2519                         return
2520                 fi
2521                 __gitcomp_nl "$(__git_refs_remotes "$remote")" "" "$cur_"
2522                 return
2523                 ;;
2524         remote.*.push)
2525                 local remote="${varname#remote.}"
2526                 remote="${remote%.push}"
2527                 __gitcomp_nl "$(__git for-each-ref \
2528                         --format='%(refname):%(refname)' refs/heads)" "" "$cur_"
2529                 return
2530                 ;;
2531         pull.twohead|pull.octopus)
2532                 __git_compute_merge_strategies
2533                 __gitcomp "$__git_merge_strategies" "" "$cur_"
2534                 return
2535                 ;;
2536         color.pager)
2537                 __gitcomp "false true" "" "$cur_"
2538                 return
2539                 ;;
2540         color.*.*)
2541                 __gitcomp "
2542                         normal black red green yellow blue magenta cyan white
2543                         bold dim ul blink reverse
2544                         " "" "$cur_"
2545                 return
2546                 ;;
2547         color.*)
2548                 __gitcomp "false true always never auto" "" "$cur_"
2549                 return
2550                 ;;
2551         diff.submodule)
2552                 __gitcomp "$__git_diff_submodule_formats" "" "$cur_"
2553                 return
2554                 ;;
2555         help.format)
2556                 __gitcomp "man info web html" "" "$cur_"
2557                 return
2558                 ;;
2559         log.date)
2560                 __gitcomp "$__git_log_date_formats" "" "$cur_"
2561                 return
2562                 ;;
2563         sendemail.aliasfiletype)
2564                 __gitcomp "mutt mailrc pine elm gnus" "" "$cur_"
2565                 return
2566                 ;;
2567         sendemail.confirm)
2568                 __gitcomp "$__git_send_email_confirm_options" "" "$cur_"
2569                 return
2570                 ;;
2571         sendemail.suppresscc)
2572                 __gitcomp "$__git_send_email_suppresscc_options" "" "$cur_"
2573                 return
2574                 ;;
2575         sendemail.transferencoding)
2576                 __gitcomp "7bit 8bit quoted-printable base64" "" "$cur_"
2577                 return
2578                 ;;
2579         *.*)
2580                 return
2581                 ;;
2582         esac
2583 }
2584
2585 # Completes configuration sections, subsections, variable names.
2586 #
2587 # Usage: __git_complete_config_variable_name [<option>]...
2588 # --cur=<word>: The current configuration section/variable name to be
2589 #               completed.  Defaults to the current word to be completed.
2590 # --sfx=<suffix>: A suffix to be appended to each fully completed
2591 #                 configuration variable name (but not to sections or
2592 #                 subsections) instead of the default space.
2593 __git_complete_config_variable_name ()
2594 {
2595         local cur_="$cur" sfx
2596
2597         while test $# != 0; do
2598                 case "$1" in
2599                 --cur=*)        cur_="${1##--cur=}" ;;
2600                 --sfx=*)        sfx="${1##--sfx=}" ;;
2601                 *)              return 1 ;;
2602                 esac
2603                 shift
2604         done
2605
2606         case "$cur_" in
2607         branch.*.*)
2608                 local pfx="${cur_%.*}."
2609                 cur_="${cur_##*.}"
2610                 __gitcomp "remote pushRemote merge mergeOptions rebase" "$pfx" "$cur_" "$sfx"
2611                 return
2612                 ;;
2613         branch.*)
2614                 local pfx="${cur%.*}."
2615                 cur_="${cur#*.}"
2616                 __gitcomp_direct "$(__git_heads "$pfx" "$cur_" ".")"
2617                 __gitcomp_nl_append $'autoSetupMerge\nautoSetupRebase\n' "$pfx" "$cur_" "$sfx"
2618                 return
2619                 ;;
2620         guitool.*.*)
2621                 local pfx="${cur_%.*}."
2622                 cur_="${cur_##*.}"
2623                 __gitcomp "
2624                         argPrompt cmd confirm needsFile noConsole noRescan
2625                         prompt revPrompt revUnmerged title
2626                         " "$pfx" "$cur_" "$sfx"
2627                 return
2628                 ;;
2629         difftool.*.*)
2630                 local pfx="${cur_%.*}."
2631                 cur_="${cur_##*.}"
2632                 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2633                 return
2634                 ;;
2635         man.*.*)
2636                 local pfx="${cur_%.*}."
2637                 cur_="${cur_##*.}"
2638                 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2639                 return
2640                 ;;
2641         mergetool.*.*)
2642                 local pfx="${cur_%.*}."
2643                 cur_="${cur_##*.}"
2644                 __gitcomp "cmd path trustExitCode" "$pfx" "$cur_" "$sfx"
2645                 return
2646                 ;;
2647         pager.*)
2648                 local pfx="${cur_%.*}."
2649                 cur_="${cur_#*.}"
2650                 __git_compute_all_commands
2651                 __gitcomp_nl "$__git_all_commands" "$pfx" "$cur_" "$sfx"
2652                 return
2653                 ;;
2654         remote.*.*)
2655                 local pfx="${cur_%.*}."
2656                 cur_="${cur_##*.}"
2657                 __gitcomp "
2658                         url proxy fetch push mirror skipDefaultUpdate
2659                         receivepack uploadpack tagOpt pushurl
2660                         " "$pfx" "$cur_" "$sfx"
2661                 return
2662                 ;;
2663         remote.*)
2664                 local pfx="${cur_%.*}."
2665                 cur_="${cur_#*.}"
2666                 __gitcomp_nl "$(__git_remotes)" "$pfx" "$cur_" "."
2667                 __gitcomp_nl_append "pushDefault" "$pfx" "$cur_" "$sfx"
2668                 return
2669                 ;;
2670         url.*.*)
2671                 local pfx="${cur_%.*}."
2672                 cur_="${cur_##*.}"
2673                 __gitcomp "insteadOf pushInsteadOf" "$pfx" "$cur_" "$sfx"
2674                 return
2675                 ;;
2676         *.*)
2677                 __git_compute_config_vars
2678                 __gitcomp "$__git_config_vars" "" "$cur_" "$sfx"
2679                 ;;
2680         *)
2681                 __git_compute_config_vars
2682                 __gitcomp "$(echo "$__git_config_vars" |
2683                                 awk -F . '{
2684                                         sections[$1] = 1
2685                                 }
2686                                 END {
2687                                         for (s in sections)
2688                                                 print s "."
2689                                 }
2690                                 ')" "" "$cur_"
2691                 ;;
2692         esac
2693 }
2694
2695 # Completes '='-separated configuration sections/variable names and values
2696 # for 'git -c section.name=value'.
2697 #
2698 # Usage: __git_complete_config_variable_name_and_value [<option>]...
2699 # --cur=<word>: The current configuration section/variable name/value to be
2700 #               completed. Defaults to the current word to be completed.
2701 __git_complete_config_variable_name_and_value ()
2702 {
2703         local cur_="$cur"
2704
2705         while test $# != 0; do
2706                 case "$1" in
2707                 --cur=*)        cur_="${1##--cur=}" ;;
2708                 *)              return 1 ;;
2709                 esac
2710                 shift
2711         done
2712
2713         case "$cur_" in
2714         *=*)
2715                 __git_complete_config_variable_value \
2716                         --varname="${cur_%%=*}" --cur="${cur_#*=}"
2717                 ;;
2718         *)
2719                 __git_complete_config_variable_name --cur="$cur_" --sfx='='
2720                 ;;
2721         esac
2722 }
2723
2724 _git_config ()
2725 {
2726         case "$prev" in
2727         --get|--get-all|--unset|--unset-all)
2728                 __gitcomp_nl "$(__git_config_get_set_variables)"
2729                 return
2730                 ;;
2731         *.*)
2732                 __git_complete_config_variable_value
2733                 return
2734                 ;;
2735         esac
2736         case "$cur" in
2737         --*)
2738                 __gitcomp_builtin config
2739                 ;;
2740         *)
2741                 __git_complete_config_variable_name
2742                 ;;
2743         esac
2744 }
2745
2746 _git_remote ()
2747 {
2748         local subcommands="
2749                 add rename remove set-head set-branches
2750                 get-url set-url show prune update
2751                 "
2752         local subcommand="$(__git_find_on_cmdline "$subcommands")"
2753         if [ -z "$subcommand" ]; then
2754                 case "$cur" in
2755                 --*)
2756                         __gitcomp_builtin remote
2757                         ;;
2758                 *)
2759                         __gitcomp "$subcommands"
2760                         ;;
2761                 esac
2762                 return
2763         fi
2764
2765         case "$subcommand,$cur" in
2766         add,--*)
2767                 __gitcomp_builtin remote_add
2768                 ;;
2769         add,*)
2770                 ;;
2771         set-head,--*)
2772                 __gitcomp_builtin remote_set-head
2773                 ;;
2774         set-branches,--*)
2775                 __gitcomp_builtin remote_set-branches
2776                 ;;
2777         set-head,*|set-branches,*)
2778                 __git_complete_remote_or_refspec
2779                 ;;
2780         update,--*)
2781                 __gitcomp_builtin remote_update
2782                 ;;
2783         update,*)
2784                 __gitcomp "$(__git_remotes) $(__git_get_config_variables "remotes")"
2785                 ;;
2786         set-url,--*)
2787                 __gitcomp_builtin remote_set-url
2788                 ;;
2789         get-url,--*)
2790                 __gitcomp_builtin remote_get-url
2791                 ;;
2792         prune,--*)
2793                 __gitcomp_builtin remote_prune
2794                 ;;
2795         *)
2796                 __gitcomp_nl "$(__git_remotes)"
2797                 ;;
2798         esac
2799 }
2800
2801 _git_replace ()
2802 {
2803         case "$cur" in
2804         --format=*)
2805                 __gitcomp "short medium long" "" "${cur##--format=}"
2806                 return
2807                 ;;
2808         --*)
2809                 __gitcomp_builtin replace
2810                 return
2811                 ;;
2812         esac
2813         __git_complete_refs
2814 }
2815
2816 _git_rerere ()
2817 {
2818         local subcommands="clear forget diff remaining status gc"
2819         local subcommand="$(__git_find_on_cmdline "$subcommands")"
2820         if test -z "$subcommand"
2821         then
2822                 __gitcomp "$subcommands"
2823                 return
2824         fi
2825 }
2826
2827 _git_reset ()
2828 {
2829         __git_has_doubledash && return
2830
2831         case "$cur" in
2832         --*)
2833                 __gitcomp_builtin reset
2834                 return
2835                 ;;
2836         esac
2837         __git_complete_refs
2838 }
2839
2840 _git_restore ()
2841 {
2842         case "$cur" in
2843         --conflict=*)
2844                 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2845                 ;;
2846         --source=*)
2847                 __git_complete_refs --cur="${cur##--source=}"
2848                 ;;
2849         --*)
2850                 __gitcomp_builtin restore
2851                 ;;
2852         esac
2853 }
2854
2855 __git_revert_inprogress_options=$__git_sequencer_inprogress_options
2856
2857 _git_revert ()
2858 {
2859         __git_find_repo_path
2860         if [ -f "$__git_repo_path"/REVERT_HEAD ]; then
2861                 __gitcomp "$__git_revert_inprogress_options"
2862                 return
2863         fi
2864         __git_complete_strategy && return
2865         case "$cur" in
2866         --*)
2867                 __gitcomp_builtin revert "" \
2868                         "$__git_revert_inprogress_options"
2869                 return
2870                 ;;
2871         esac
2872         __git_complete_refs
2873 }
2874
2875 _git_rm ()
2876 {
2877         case "$cur" in
2878         --*)
2879                 __gitcomp_builtin rm
2880                 return
2881                 ;;
2882         esac
2883
2884         __git_complete_index_file "--cached"
2885 }
2886
2887 _git_shortlog ()
2888 {
2889         __git_has_doubledash && return
2890
2891         case "$cur" in
2892         --*)
2893                 __gitcomp "
2894                         $__git_log_common_options
2895                         $__git_log_shortlog_options
2896                         --numbered --summary --email
2897                         "
2898                 return
2899                 ;;
2900         esac
2901         __git_complete_revlist
2902 }
2903
2904 _git_show ()
2905 {
2906         __git_has_doubledash && return
2907
2908         case "$cur" in
2909         --pretty=*|--format=*)
2910                 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
2911                         " "" "${cur#*=}"
2912                 return
2913                 ;;
2914         --diff-algorithm=*)
2915                 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
2916                 return
2917                 ;;
2918         --submodule=*)
2919                 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
2920                 return
2921                 ;;
2922         --color-moved=*)
2923                 __gitcomp "$__git_color_moved_opts" "" "${cur##--color-moved=}"
2924                 return
2925                 ;;
2926         --color-moved-ws=*)
2927                 __gitcomp "$__git_color_moved_ws_opts" "" "${cur##--color-moved-ws=}"
2928                 return
2929                 ;;
2930         --*)
2931                 __gitcomp "--pretty= --format= --abbrev-commit --no-abbrev-commit
2932                         --oneline --show-signature --patch
2933                         --expand-tabs --expand-tabs= --no-expand-tabs
2934                         $__git_diff_common_options
2935                         "
2936                 return
2937                 ;;
2938         esac
2939         __git_complete_revlist_file
2940 }
2941
2942 _git_show_branch ()
2943 {
2944         case "$cur" in
2945         --*)
2946                 __gitcomp_builtin show-branch
2947                 return
2948                 ;;
2949         esac
2950         __git_complete_revlist
2951 }
2952
2953 _git_sparse_checkout ()
2954 {
2955         local subcommands="list init set disable"
2956         local subcommand="$(__git_find_on_cmdline "$subcommands")"
2957         if [ -z "$subcommand" ]; then
2958                 __gitcomp "$subcommands"
2959                 return
2960         fi
2961
2962         case "$subcommand,$cur" in
2963         init,--*)
2964                 __gitcomp "--cone"
2965                 ;;
2966         set,--*)
2967                 __gitcomp "--stdin"
2968                 ;;
2969         *)
2970                 ;;
2971         esac
2972 }
2973
2974 _git_stash ()
2975 {
2976         local save_opts='--all --keep-index --no-keep-index --quiet --patch --include-untracked'
2977         local subcommands='push list show apply clear drop pop create branch'
2978         local subcommand="$(__git_find_on_cmdline "$subcommands save")"
2979         if [ -z "$subcommand" -a -n "$(__git_find_on_cmdline "-p")" ]; then
2980                 subcommand="push"
2981         fi
2982         if [ -z "$subcommand" ]; then
2983                 case "$cur" in
2984                 --*)
2985                         __gitcomp "$save_opts"
2986                         ;;
2987                 sa*)
2988                         if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2989                                 __gitcomp "save"
2990                         fi
2991                         ;;
2992                 *)
2993                         if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2994                                 __gitcomp "$subcommands"
2995                         fi
2996                         ;;
2997                 esac
2998         else
2999                 case "$subcommand,$cur" in
3000                 push,--*)
3001                         __gitcomp "$save_opts --message"
3002                         ;;
3003                 save,--*)
3004                         __gitcomp "$save_opts"
3005                         ;;
3006                 apply,--*|pop,--*)
3007                         __gitcomp "--index --quiet"
3008                         ;;
3009                 drop,--*)
3010                         __gitcomp "--quiet"
3011                         ;;
3012                 list,--*)
3013                         __gitcomp "--name-status --oneline --patch-with-stat"
3014                         ;;
3015                 show,--*|branch,--*)
3016                         ;;
3017                 branch,*)
3018                         if [ $cword -eq 3 ]; then
3019                                 __git_complete_refs
3020                         else
3021                                 __gitcomp_nl "$(__git stash list \
3022                                                 | sed -n -e 's/:.*//p')"
3023                         fi
3024                         ;;
3025                 show,*|apply,*|drop,*|pop,*)
3026                         __gitcomp_nl "$(__git stash list \
3027                                         | sed -n -e 's/:.*//p')"
3028                         ;;
3029                 *)
3030                         ;;
3031                 esac
3032         fi
3033 }
3034
3035 _git_submodule ()
3036 {
3037         __git_has_doubledash && return
3038
3039         local subcommands="add status init deinit update set-branch set-url summary foreach sync absorbgitdirs"
3040         local subcommand="$(__git_find_on_cmdline "$subcommands")"
3041         if [ -z "$subcommand" ]; then
3042                 case "$cur" in
3043                 --*)
3044                         __gitcomp "--quiet"
3045                         ;;
3046                 *)
3047                         __gitcomp "$subcommands"
3048                         ;;
3049                 esac
3050                 return
3051         fi
3052
3053         case "$subcommand,$cur" in
3054         add,--*)
3055                 __gitcomp "--branch --force --name --reference --depth"
3056                 ;;
3057         status,--*)
3058                 __gitcomp "--cached --recursive"
3059                 ;;
3060         deinit,--*)
3061                 __gitcomp "--force --all"
3062                 ;;
3063         update,--*)
3064                 __gitcomp "
3065                         --init --remote --no-fetch
3066                         --recommend-shallow --no-recommend-shallow
3067                         --force --rebase --merge --reference --depth --recursive --jobs
3068                 "
3069                 ;;
3070         set-branch,--*)
3071                 __gitcomp "--default --branch"
3072                 ;;
3073         summary,--*)
3074                 __gitcomp "--cached --files --summary-limit"
3075                 ;;
3076         foreach,--*|sync,--*)
3077                 __gitcomp "--recursive"
3078                 ;;
3079         *)
3080                 ;;
3081         esac
3082 }
3083
3084 _git_svn ()
3085 {
3086         local subcommands="
3087                 init fetch clone rebase dcommit log find-rev
3088                 set-tree commit-diff info create-ignore propget
3089                 proplist show-ignore show-externals branch tag blame
3090                 migrate mkdirs reset gc
3091                 "
3092         local subcommand="$(__git_find_on_cmdline "$subcommands")"
3093         if [ -z "$subcommand" ]; then
3094                 __gitcomp "$subcommands"
3095         else
3096                 local remote_opts="--username= --config-dir= --no-auth-cache"
3097                 local fc_opts="
3098                         --follow-parent --authors-file= --repack=
3099                         --no-metadata --use-svm-props --use-svnsync-props
3100                         --log-window-size= --no-checkout --quiet
3101                         --repack-flags --use-log-author --localtime
3102                         --add-author-from
3103                         --recursive
3104                         --ignore-paths= --include-paths= $remote_opts
3105                         "
3106                 local init_opts="
3107                         --template= --shared= --trunk= --tags=
3108                         --branches= --stdlayout --minimize-url
3109                         --no-metadata --use-svm-props --use-svnsync-props
3110                         --rewrite-root= --prefix= $remote_opts
3111                         "
3112                 local cmt_opts="
3113                         --edit --rmdir --find-copies-harder --copy-similarity=
3114                         "
3115
3116                 case "$subcommand,$cur" in
3117                 fetch,--*)
3118                         __gitcomp "--revision= --fetch-all $fc_opts"
3119                         ;;
3120                 clone,--*)
3121                         __gitcomp "--revision= $fc_opts $init_opts"
3122                         ;;
3123                 init,--*)
3124                         __gitcomp "$init_opts"
3125                         ;;
3126                 dcommit,--*)
3127                         __gitcomp "
3128                                 --merge --strategy= --verbose --dry-run
3129                                 --fetch-all --no-rebase --commit-url
3130                                 --revision --interactive $cmt_opts $fc_opts
3131                                 "
3132                         ;;
3133                 set-tree,--*)
3134                         __gitcomp "--stdin $cmt_opts $fc_opts"
3135                         ;;
3136                 create-ignore,--*|propget,--*|proplist,--*|show-ignore,--*|\
3137                 show-externals,--*|mkdirs,--*)
3138                         __gitcomp "--revision="
3139                         ;;
3140                 log,--*)
3141                         __gitcomp "
3142                                 --limit= --revision= --verbose --incremental
3143                                 --oneline --show-commit --non-recursive
3144                                 --authors-file= --color
3145                                 "
3146                         ;;
3147                 rebase,--*)
3148                         __gitcomp "
3149                                 --merge --verbose --strategy= --local
3150                                 --fetch-all --dry-run $fc_opts
3151                                 "
3152                         ;;
3153                 commit-diff,--*)
3154                         __gitcomp "--message= --file= --revision= $cmt_opts"
3155                         ;;
3156                 info,--*)
3157                         __gitcomp "--url"
3158                         ;;
3159                 branch,--*)
3160                         __gitcomp "--dry-run --message --tag"
3161                         ;;
3162                 tag,--*)
3163                         __gitcomp "--dry-run --message"
3164                         ;;
3165                 blame,--*)
3166                         __gitcomp "--git-format"
3167                         ;;
3168                 migrate,--*)
3169                         __gitcomp "
3170                                 --config-dir= --ignore-paths= --minimize
3171                                 --no-auth-cache --username=
3172                                 "
3173                         ;;
3174                 reset,--*)
3175                         __gitcomp "--revision= --parent"
3176                         ;;
3177                 *)
3178                         ;;
3179                 esac
3180         fi
3181 }
3182
3183 _git_tag ()
3184 {
3185         local i c=1 f=0
3186         while [ $c -lt $cword ]; do
3187                 i="${words[c]}"
3188                 case "$i" in
3189                 -d|--delete|-v|--verify)
3190                         __gitcomp_direct "$(__git_tags "" "$cur" " ")"
3191                         return
3192                         ;;
3193                 -f)
3194                         f=1
3195                         ;;
3196                 esac
3197                 ((c++))
3198         done
3199
3200         case "$prev" in
3201         -m|-F)
3202                 ;;
3203         -*|tag)
3204                 if [ $f = 1 ]; then
3205                         __gitcomp_direct "$(__git_tags "" "$cur" " ")"
3206                 fi
3207                 ;;
3208         *)
3209                 __git_complete_refs
3210                 ;;
3211         esac
3212
3213         case "$cur" in
3214         --*)
3215                 __gitcomp_builtin tag
3216                 ;;
3217         esac
3218 }
3219
3220 _git_whatchanged ()
3221 {
3222         _git_log
3223 }
3224
3225 __git_complete_worktree_paths ()
3226 {
3227         local IFS=$'\n'
3228         __gitcomp_nl "$(git worktree list --porcelain |
3229                 # Skip the first entry: it's the path of the main worktree,
3230                 # which can't be moved, removed, locked, etc.
3231                 sed -n -e '2,$ s/^worktree //p')"
3232 }
3233
3234 _git_worktree ()
3235 {
3236         local subcommands="add list lock move prune remove unlock"
3237         local subcommand subcommand_idx
3238
3239         subcommand="$(__git_find_on_cmdline --show-idx "$subcommands")"
3240         subcommand_idx="${subcommand% *}"
3241         subcommand="${subcommand#* }"
3242
3243         case "$subcommand,$cur" in
3244         ,*)
3245                 __gitcomp "$subcommands"
3246                 ;;
3247         *,--*)
3248                 __gitcomp_builtin worktree_$subcommand
3249                 ;;
3250         add,*)  # usage: git worktree add [<options>] <path> [<commit-ish>]
3251                 # Here we are not completing an --option, it's either the
3252                 # path or a ref.
3253                 case "$prev" in
3254                 -b|-B)  # Complete refs for branch to be created/reseted.
3255                         __git_complete_refs
3256                         ;;
3257                 -*)     # The previous word is an -o|--option without an
3258                         # unstuck argument: have to complete the path for
3259                         # the new worktree, so don't list anything, but let
3260                         # Bash fall back to filename completion.
3261                         ;;
3262                 *)      # The previous word is not an --option, so it must
3263                         # be either the 'add' subcommand, the unstuck
3264                         # argument of an option (e.g. branch for -b|-B), or
3265                         # the path for the new worktree.
3266                         if [ $cword -eq $((subcommand_idx+1)) ]; then
3267                                 # Right after the 'add' subcommand: have to
3268                                 # complete the path, so fall back to Bash
3269                                 # filename completion.
3270                                 :
3271                         else
3272                                 case "${words[cword-2]}" in
3273                                 -b|-B)  # After '-b <branch>': have to
3274                                         # complete the path, so fall back
3275                                         # to Bash filename completion.
3276                                         ;;
3277                                 *)      # After the path: have to complete
3278                                         # the ref to be checked out.
3279                                         __git_complete_refs
3280                                         ;;
3281                                 esac
3282                         fi
3283                         ;;
3284                 esac
3285                 ;;
3286         lock,*|remove,*|unlock,*)
3287                 __git_complete_worktree_paths
3288                 ;;
3289         move,*)
3290                 if [ $cword -eq $((subcommand_idx+1)) ]; then
3291                         # The first parameter must be an existing working
3292                         # tree to be moved.
3293                         __git_complete_worktree_paths
3294                 else
3295                         # The second parameter is the destination: it could
3296                         # be any path, so don't list anything, but let Bash
3297                         # fall back to filename completion.
3298                         :
3299                 fi
3300                 ;;
3301         esac
3302 }
3303
3304 __git_complete_common () {
3305         local command="$1"
3306
3307         case "$cur" in
3308         --*)
3309                 __gitcomp_builtin "$command"
3310                 ;;
3311         esac
3312 }
3313
3314 __git_cmds_with_parseopt_helper=
3315 __git_support_parseopt_helper () {
3316         test -n "$__git_cmds_with_parseopt_helper" ||
3317                 __git_cmds_with_parseopt_helper="$(__git --list-cmds=parseopt)"
3318
3319         case " $__git_cmds_with_parseopt_helper " in
3320         *" $1 "*)
3321                 return 0
3322                 ;;
3323         *)
3324                 return 1
3325                 ;;
3326         esac
3327 }
3328
3329 __git_complete_command () {
3330         local command="$1"
3331         local completion_func="_git_${command//-/_}"
3332         if ! declare -f $completion_func >/dev/null 2>/dev/null &&
3333                 declare -f _completion_loader >/dev/null 2>/dev/null
3334         then
3335                 _completion_loader "git-$command"
3336         fi
3337         if declare -f $completion_func >/dev/null 2>/dev/null
3338         then
3339                 $completion_func
3340                 return 0
3341         elif __git_support_parseopt_helper "$command"
3342         then
3343                 __git_complete_common "$command"
3344                 return 0
3345         else
3346                 return 1
3347         fi
3348 }
3349
3350 __git_main ()
3351 {
3352         local i c=1 command __git_dir __git_repo_path
3353         local __git_C_args C_args_count=0
3354
3355         while [ $c -lt $cword ]; do
3356                 i="${words[c]}"
3357                 case "$i" in
3358                 --git-dir=*) __git_dir="${i#--git-dir=}" ;;
3359                 --git-dir)   ((c++)) ; __git_dir="${words[c]}" ;;
3360                 --bare)      __git_dir="." ;;
3361                 --help) command="help"; break ;;
3362                 -c|--work-tree|--namespace) ((c++)) ;;
3363                 -C)     __git_C_args[C_args_count++]=-C
3364                         ((c++))
3365                         __git_C_args[C_args_count++]="${words[c]}"
3366                         ;;
3367                 -*) ;;
3368                 *) command="$i"; break ;;
3369                 esac
3370                 ((c++))
3371         done
3372
3373         if [ -z "${command-}" ]; then
3374                 case "$prev" in
3375                 --git-dir|-C|--work-tree)
3376                         # these need a path argument, let's fall back to
3377                         # Bash filename completion
3378                         return
3379                         ;;
3380                 -c)
3381                         __git_complete_config_variable_name_and_value
3382                         return
3383                         ;;
3384                 --namespace)
3385                         # we don't support completing these options' arguments
3386                         return
3387                         ;;
3388                 esac
3389                 case "$cur" in
3390                 --*)   __gitcomp "
3391                         --paginate
3392                         --no-pager
3393                         --git-dir=
3394                         --bare
3395                         --version
3396                         --exec-path
3397                         --exec-path=
3398                         --html-path
3399                         --man-path
3400                         --info-path
3401                         --work-tree=
3402                         --namespace=
3403                         --no-replace-objects
3404                         --help
3405                         "
3406                         ;;
3407                 *)
3408                         if test -n "${GIT_TESTING_PORCELAIN_COMMAND_LIST-}"
3409                         then
3410                                 __gitcomp "$GIT_TESTING_PORCELAIN_COMMAND_LIST"
3411                         else
3412                                 __gitcomp "$(__git --list-cmds=list-mainporcelain,others,nohelpers,alias,list-complete,config)"
3413                         fi
3414                         ;;
3415                 esac
3416                 return
3417         fi
3418
3419         __git_complete_command "$command" && return
3420
3421         local expansion=$(__git_aliased_command "$command")
3422         if [ -n "$expansion" ]; then
3423                 words[1]=$expansion
3424                 __git_complete_command "$expansion"
3425         fi
3426 }
3427
3428 __gitk_main ()
3429 {
3430         __git_has_doubledash && return
3431
3432         local __git_repo_path
3433         __git_find_repo_path
3434
3435         local merge=""
3436         if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
3437                 merge="--merge"
3438         fi
3439         case "$cur" in
3440         --*)
3441                 __gitcomp "
3442                         $__git_log_common_options
3443                         $__git_log_gitk_options
3444                         $merge
3445                         "
3446                 return
3447                 ;;
3448         esac
3449         __git_complete_revlist
3450 }
3451
3452 if [[ -n ${ZSH_VERSION-} ]] &&
3453    # Don't define these functions when sourced from 'git-completion.zsh',
3454    # it has its own implementations.
3455    [[ -z ${GIT_SOURCING_ZSH_COMPLETION-} ]]; then
3456         echo "WARNING: this script is deprecated, please see git-completion.zsh" 1>&2
3457
3458         autoload -U +X compinit && compinit
3459
3460         __gitcomp ()
3461         {
3462                 emulate -L zsh
3463
3464                 local cur_="${3-$cur}"
3465
3466                 case "$cur_" in
3467                 --*=)
3468                         ;;
3469                 *)
3470                         local c IFS=$' \t\n'
3471                         local -a array
3472                         for c in ${=1}; do
3473                                 c="$c${4-}"
3474                                 case $c in
3475                                 --*=*|*.) ;;
3476                                 *) c="$c " ;;
3477                                 esac
3478                                 array[${#array[@]}+1]="$c"
3479                         done
3480                         compset -P '*[=:]'
3481                         compadd -Q -S '' -p "${2-}" -a -- array && _ret=0
3482                         ;;
3483                 esac
3484         }
3485
3486         __gitcomp_direct ()
3487         {
3488                 emulate -L zsh
3489
3490                 local IFS=$'\n'
3491                 compset -P '*[=:]'
3492                 compadd -Q -- ${=1} && _ret=0
3493         }
3494
3495         __gitcomp_nl ()
3496         {
3497                 emulate -L zsh
3498
3499                 local IFS=$'\n'
3500                 compset -P '*[=:]'
3501                 compadd -Q -S "${4- }" -p "${2-}" -- ${=1} && _ret=0
3502         }
3503
3504         __gitcomp_file_direct ()
3505         {
3506                 emulate -L zsh
3507
3508                 local IFS=$'\n'
3509                 compset -P '*[=:]'
3510                 compadd -f -- ${=1} && _ret=0
3511         }
3512
3513         __gitcomp_file ()
3514         {
3515                 emulate -L zsh
3516
3517                 local IFS=$'\n'
3518                 compset -P '*[=:]'
3519                 compadd -p "${2-}" -f -- ${=1} && _ret=0
3520         }
3521
3522         _git ()
3523         {
3524                 local _ret=1 cur cword prev
3525                 cur=${words[CURRENT]}
3526                 prev=${words[CURRENT-1]}
3527                 let cword=CURRENT-1
3528                 emulate ksh -c __${service}_main
3529                 let _ret && _default && _ret=0
3530                 return _ret
3531         }
3532
3533         compdef _git git gitk
3534         return
3535 fi
3536
3537 __git_func_wrap ()
3538 {
3539         local cur words cword prev
3540         _get_comp_words_by_ref -n =: cur words cword prev
3541         $1
3542 }
3543
3544 # Setup completion for certain functions defined above by setting common
3545 # variables and workarounds.
3546 # This is NOT a public function; use at your own risk.
3547 __git_complete ()
3548 {
3549         local wrapper="__git_wrap${2}"
3550         eval "$wrapper () { __git_func_wrap $2 ; }"
3551         complete -o bashdefault -o default -o nospace -F $wrapper $1 2>/dev/null \
3552                 || complete -o default -o nospace -F $wrapper $1
3553 }
3554
3555 # wrapper for backwards compatibility
3556 _git ()
3557 {
3558         __git_wrap__git_main
3559 }
3560
3561 # wrapper for backwards compatibility
3562 _gitk ()
3563 {
3564         __git_wrap__gitk_main
3565 }
3566
3567 __git_complete git __git_main
3568 __git_complete gitk __gitk_main
3569
3570 # The following are necessary only for Cygwin, and only are needed
3571 # when the user has tab-completed the executable name and consequently
3572 # included the '.exe' suffix.
3573 #
3574 if [ Cygwin = "$(uname -o 2>/dev/null)" ]; then
3575 __git_complete git.exe __git_main
3576 fi