Merge branch 'sp/doc-info-attributes'
[git] / contrib / completion / git-prompt.sh
1 # bash/zsh git prompt support
2 #
3 # Copyright (C) 2006,2007 Shawn O. Pearce <spearce@spearce.org>
4 # Distributed under the GNU General Public License, version 2.0.
5 #
6 # This script allows you to see repository status in your prompt.
7 #
8 # To enable:
9 #
10 #    1) Copy this file to somewhere (e.g. ~/.git-prompt.sh).
11 #    2) Add the following line to your .bashrc/.zshrc:
12 #        source ~/.git-prompt.sh
13 #    3a) Change your PS1 to call __git_ps1 as
14 #        command-substitution:
15 #        Bash: PS1='[\u@\h \W$(__git_ps1 " (%s)")]\$ '
16 #        ZSH:  setopt PROMPT_SUBST ; PS1='[%n@%m %c$(__git_ps1 " (%s)")]\$ '
17 #        the optional argument will be used as format string.
18 #    3b) Alternatively, for a slightly faster prompt, __git_ps1 can
19 #        be used for PROMPT_COMMAND in Bash or for precmd() in Zsh
20 #        with two parameters, <pre> and <post>, which are strings
21 #        you would put in $PS1 before and after the status string
22 #        generated by the git-prompt machinery.  e.g.
23 #        Bash: PROMPT_COMMAND='__git_ps1 "\u@\h:\w" "\\\$ "'
24 #          will show username, at-sign, host, colon, cwd, then
25 #          various status string, followed by dollar and SP, as
26 #          your prompt.
27 #        ZSH:  precmd () { __git_ps1 "%n" ":%~$ " "|%s" }
28 #          will show username, pipe, then various status string,
29 #          followed by colon, cwd, dollar and SP, as your prompt.
30 #        Optionally, you can supply a third argument with a printf
31 #        format string to finetune the output of the branch status
32 #
33 # The repository status will be displayed only if you are currently in a
34 # git repository. The %s token is the placeholder for the shown status.
35 #
36 # The prompt status always includes the current branch name.
37 #
38 # In addition, if you set GIT_PS1_SHOWDIRTYSTATE to a nonempty value,
39 # unstaged (*) and staged (+) changes will be shown next to the branch
40 # name.  You can configure this per-repository with the
41 # bash.showDirtyState variable, which defaults to true once
42 # GIT_PS1_SHOWDIRTYSTATE is enabled.
43 #
44 # You can also see if currently something is stashed, by setting
45 # GIT_PS1_SHOWSTASHSTATE to a nonempty value. If something is stashed,
46 # then a '$' will be shown next to the branch name.
47 #
48 # If you would like to see if there're untracked files, then you can set
49 # GIT_PS1_SHOWUNTRACKEDFILES to a nonempty value. If there're untracked
50 # files, then a '%' will be shown next to the branch name.  You can
51 # configure this per-repository with the bash.showUntrackedFiles
52 # variable, which defaults to true once GIT_PS1_SHOWUNTRACKEDFILES is
53 # enabled.
54 #
55 # If you would like to see the difference between HEAD and its upstream,
56 # set GIT_PS1_SHOWUPSTREAM="auto".  A "<" indicates you are behind, ">"
57 # indicates you are ahead, "<>" indicates you have diverged and "="
58 # indicates that there is no difference. You can further control
59 # behaviour by setting GIT_PS1_SHOWUPSTREAM to a space-separated list
60 # of values:
61 #
62 #     verbose       show number of commits ahead/behind (+/-) upstream
63 #     name          if verbose, then also show the upstream abbrev name
64 #     legacy        don't use the '--count' option available in recent
65 #                   versions of git-rev-list
66 #     git           always compare HEAD to @{upstream}
67 #     svn           always compare HEAD to your SVN upstream
68 #
69 # You can change the separator between the branch name and the above
70 # state symbols by setting GIT_PS1_STATESEPARATOR. The default separator
71 # is SP.
72 #
73 # By default, __git_ps1 will compare HEAD to your SVN upstream if it can
74 # find one, or @{upstream} otherwise.  Once you have set
75 # GIT_PS1_SHOWUPSTREAM, you can override it on a per-repository basis by
76 # setting the bash.showUpstream config variable.
77 #
78 # If you would like to see more information about the identity of
79 # commits checked out as a detached HEAD, set GIT_PS1_DESCRIBE_STYLE
80 # to one of these values:
81 #
82 #     contains      relative to newer annotated tag (v1.6.3.2~35)
83 #     branch        relative to newer tag or branch (master~4)
84 #     describe      relative to older annotated tag (v1.6.3.1-13-gdd42c2f)
85 #     tag           relative to any older tag (v1.6.3.1-13-gdd42c2f)
86 #     default       exactly matching tag
87 #
88 # If you would like a colored hint about the current dirty state, set
89 # GIT_PS1_SHOWCOLORHINTS to a nonempty value. The colors are based on
90 # the colored output of "git status -sb" and are available only when
91 # using __git_ps1 for PROMPT_COMMAND or precmd.
92 #
93 # If you would like __git_ps1 to do nothing in the case when the current
94 # directory is set up to be ignored by git, then set
95 # GIT_PS1_HIDE_IF_PWD_IGNORED to a nonempty value. Override this on the
96 # repository level by setting bash.hideIfPwdIgnored to "false".
97
98 # check whether printf supports -v
99 __git_printf_supports_v=
100 printf -v __git_printf_supports_v -- '%s' yes >/dev/null 2>&1
101
102 # stores the divergence from upstream in $p
103 # used by GIT_PS1_SHOWUPSTREAM
104 __git_ps1_show_upstream ()
105 {
106         local key value
107         local svn_remote svn_url_pattern count n
108         local upstream=git legacy="" verbose="" name=""
109
110         svn_remote=()
111         # get some config options from git-config
112         local output="$(git config -z --get-regexp '^(svn-remote\..*\.url|bash\.showupstream)$' 2>/dev/null | tr '\0\n' '\n ')"
113         while read -r key value; do
114                 case "$key" in
115                 bash.showupstream)
116                         GIT_PS1_SHOWUPSTREAM="$value"
117                         if [[ -z "${GIT_PS1_SHOWUPSTREAM}" ]]; then
118                                 p=""
119                                 return
120                         fi
121                         ;;
122                 svn-remote.*.url)
123                         svn_remote[$((${#svn_remote[@]} + 1))]="$value"
124                         svn_url_pattern="$svn_url_pattern\\|$value"
125                         upstream=svn+git # default upstream is SVN if available, else git
126                         ;;
127                 esac
128         done <<< "$output"
129
130         # parse configuration values
131         for option in ${GIT_PS1_SHOWUPSTREAM}; do
132                 case "$option" in
133                 git|svn) upstream="$option" ;;
134                 verbose) verbose=1 ;;
135                 legacy)  legacy=1  ;;
136                 name)    name=1 ;;
137                 esac
138         done
139
140         # Find our upstream
141         case "$upstream" in
142         git)    upstream="@{upstream}" ;;
143         svn*)
144                 # get the upstream from the "git-svn-id: ..." in a commit message
145                 # (git-svn uses essentially the same procedure internally)
146                 local -a svn_upstream
147                 svn_upstream=($(git log --first-parent -1 \
148                                         --grep="^git-svn-id: \(${svn_url_pattern#??}\)" 2>/dev/null))
149                 if [[ 0 -ne ${#svn_upstream[@]} ]]; then
150                         svn_upstream=${svn_upstream[${#svn_upstream[@]} - 2]}
151                         svn_upstream=${svn_upstream%@*}
152                         local n_stop="${#svn_remote[@]}"
153                         for ((n=1; n <= n_stop; n++)); do
154                                 svn_upstream=${svn_upstream#${svn_remote[$n]}}
155                         done
156
157                         if [[ -z "$svn_upstream" ]]; then
158                                 # default branch name for checkouts with no layout:
159                                 upstream=${GIT_SVN_ID:-git-svn}
160                         else
161                                 upstream=${svn_upstream#/}
162                         fi
163                 elif [[ "svn+git" = "$upstream" ]]; then
164                         upstream="@{upstream}"
165                 fi
166                 ;;
167         esac
168
169         # Find how many commits we are ahead/behind our upstream
170         if [[ -z "$legacy" ]]; then
171                 count="$(git rev-list --count --left-right \
172                                 "$upstream"...HEAD 2>/dev/null)"
173         else
174                 # produce equivalent output to --count for older versions of git
175                 local commits
176                 if commits="$(git rev-list --left-right "$upstream"...HEAD 2>/dev/null)"
177                 then
178                         local commit behind=0 ahead=0
179                         for commit in $commits
180                         do
181                                 case "$commit" in
182                                 "<"*) ((behind++)) ;;
183                                 *)    ((ahead++))  ;;
184                                 esac
185                         done
186                         count="$behind  $ahead"
187                 else
188                         count=""
189                 fi
190         fi
191
192         # calculate the result
193         if [[ -z "$verbose" ]]; then
194                 case "$count" in
195                 "") # no upstream
196                         p="" ;;
197                 "0      0") # equal to upstream
198                         p="=" ;;
199                 "0      "*) # ahead of upstream
200                         p=">" ;;
201                 *"      0") # behind upstream
202                         p="<" ;;
203                 *)          # diverged from upstream
204                         p="<>" ;;
205                 esac
206         else
207                 case "$count" in
208                 "") # no upstream
209                         p="" ;;
210                 "0      0") # equal to upstream
211                         p=" u=" ;;
212                 "0      "*) # ahead of upstream
213                         p=" u+${count#0 }" ;;
214                 *"      0") # behind upstream
215                         p=" u-${count%  0}" ;;
216                 *)          # diverged from upstream
217                         p=" u+${count#* }-${count%      *}" ;;
218                 esac
219                 if [[ -n "$count" && -n "$name" ]]; then
220                         __git_ps1_upstream_name=$(git rev-parse \
221                                 --abbrev-ref "$upstream" 2>/dev/null)
222                         if [ $pcmode = yes ] && [ $ps1_expanded = yes ]; then
223                                 p="$p \${__git_ps1_upstream_name}"
224                         else
225                                 p="$p ${__git_ps1_upstream_name}"
226                                 # not needed anymore; keep user's
227                                 # environment clean
228                                 unset __git_ps1_upstream_name
229                         fi
230                 fi
231         fi
232
233 }
234
235 # Helper function that is meant to be called from __git_ps1.  It
236 # injects color codes into the appropriate gitstring variables used
237 # to build a gitstring.
238 __git_ps1_colorize_gitstring ()
239 {
240         if [[ -n ${ZSH_VERSION-} ]]; then
241                 local c_red='%F{red}'
242                 local c_green='%F{green}'
243                 local c_lblue='%F{blue}'
244                 local c_clear='%f'
245         else
246                 # Using \[ and \] around colors is necessary to prevent
247                 # issues with command line editing/browsing/completion!
248                 local c_red='\[\e[31m\]'
249                 local c_green='\[\e[32m\]'
250                 local c_lblue='\[\e[1;34m\]'
251                 local c_clear='\[\e[0m\]'
252         fi
253         local bad_color=$c_red
254         local ok_color=$c_green
255         local flags_color="$c_lblue"
256
257         local branch_color=""
258         if [ $detached = no ]; then
259                 branch_color="$ok_color"
260         else
261                 branch_color="$bad_color"
262         fi
263         c="$branch_color$c"
264
265         z="$c_clear$z"
266         if [ "$w" = "*" ]; then
267                 w="$bad_color$w"
268         fi
269         if [ -n "$i" ]; then
270                 i="$ok_color$i"
271         fi
272         if [ -n "$s" ]; then
273                 s="$flags_color$s"
274         fi
275         if [ -n "$u" ]; then
276                 u="$bad_color$u"
277         fi
278         r="$c_clear$r"
279 }
280
281 __git_eread ()
282 {
283         local f="$1"
284         shift
285         test -r "$f" && read "$@" <"$f"
286 }
287
288 # __git_ps1 accepts 0 or 1 arguments (i.e., format string)
289 # when called from PS1 using command substitution
290 # in this mode it prints text to add to bash PS1 prompt (includes branch name)
291 #
292 # __git_ps1 requires 2 or 3 arguments when called from PROMPT_COMMAND (pc)
293 # in that case it _sets_ PS1. The arguments are parts of a PS1 string.
294 # when two arguments are given, the first is prepended and the second appended
295 # to the state string when assigned to PS1.
296 # The optional third parameter will be used as printf format string to further
297 # customize the output of the git-status string.
298 # In this mode you can request colored hints using GIT_PS1_SHOWCOLORHINTS=true
299 __git_ps1 ()
300 {
301         # preserve exit status
302         local exit=$?
303         local pcmode=no
304         local detached=no
305         local ps1pc_start='\u@\h:\w '
306         local ps1pc_end='\$ '
307         local printf_format=' (%s)'
308
309         case "$#" in
310                 2|3)    pcmode=yes
311                         ps1pc_start="$1"
312                         ps1pc_end="$2"
313                         printf_format="${3:-$printf_format}"
314                         # set PS1 to a plain prompt so that we can
315                         # simply return early if the prompt should not
316                         # be decorated
317                         PS1="$ps1pc_start$ps1pc_end"
318                 ;;
319                 0|1)    printf_format="${1:-$printf_format}"
320                 ;;
321                 *)      return $exit
322                 ;;
323         esac
324
325         # ps1_expanded:  This variable is set to 'yes' if the shell
326         # subjects the value of PS1 to parameter expansion:
327         #
328         #   * bash does unless the promptvars option is disabled
329         #   * zsh does not unless the PROMPT_SUBST option is set
330         #   * POSIX shells always do
331         #
332         # If the shell would expand the contents of PS1 when drawing
333         # the prompt, a raw ref name must not be included in PS1.
334         # This protects the user from arbitrary code execution via
335         # specially crafted ref names.  For example, a ref named
336         # 'refs/heads/$(IFS=_;cmd=sudo_rm_-rf_/;$cmd)' might cause the
337         # shell to execute 'sudo rm -rf /' when the prompt is drawn.
338         #
339         # Instead, the ref name should be placed in a separate global
340         # variable (in the __git_ps1_* namespace to avoid colliding
341         # with the user's environment) and that variable should be
342         # referenced from PS1.  For example:
343         #
344         #     __git_ps1_foo=$(do_something_to_get_ref_name)
345         #     PS1="...stuff...\${__git_ps1_foo}...stuff..."
346         #
347         # If the shell does not expand the contents of PS1, the raw
348         # ref name must be included in PS1.
349         #
350         # The value of this variable is only relevant when in pcmode.
351         #
352         # Assume that the shell follows the POSIX specification and
353         # expands PS1 unless determined otherwise.  (This is more
354         # likely to be correct if the user has a non-bash, non-zsh
355         # shell and safer than the alternative if the assumption is
356         # incorrect.)
357         #
358         local ps1_expanded=yes
359         [ -z "${ZSH_VERSION-}" ] || [[ -o PROMPT_SUBST ]] || ps1_expanded=no
360         [ -z "${BASH_VERSION-}" ] || shopt -q promptvars || ps1_expanded=no
361
362         local repo_info rev_parse_exit_code
363         repo_info="$(git rev-parse --git-dir --is-inside-git-dir \
364                 --is-bare-repository --is-inside-work-tree \
365                 --short HEAD 2>/dev/null)"
366         rev_parse_exit_code="$?"
367
368         if [ -z "$repo_info" ]; then
369                 return $exit
370         fi
371
372         local short_sha=""
373         if [ "$rev_parse_exit_code" = "0" ]; then
374                 short_sha="${repo_info##*$'\n'}"
375                 repo_info="${repo_info%$'\n'*}"
376         fi
377         local inside_worktree="${repo_info##*$'\n'}"
378         repo_info="${repo_info%$'\n'*}"
379         local bare_repo="${repo_info##*$'\n'}"
380         repo_info="${repo_info%$'\n'*}"
381         local inside_gitdir="${repo_info##*$'\n'}"
382         local g="${repo_info%$'\n'*}"
383
384         if [ "true" = "$inside_worktree" ] &&
385            [ -n "${GIT_PS1_HIDE_IF_PWD_IGNORED-}" ] &&
386            [ "$(git config --bool bash.hideIfPwdIgnored)" != "false" ] &&
387            git check-ignore -q .
388         then
389                 return $exit
390         fi
391
392         local r=""
393         local b=""
394         local step=""
395         local total=""
396         if [ -d "$g/rebase-merge" ]; then
397                 __git_eread "$g/rebase-merge/head-name" b
398                 __git_eread "$g/rebase-merge/msgnum" step
399                 __git_eread "$g/rebase-merge/end" total
400                 if [ -f "$g/rebase-merge/interactive" ]; then
401                         r="|REBASE-i"
402                 else
403                         r="|REBASE-m"
404                 fi
405         else
406                 if [ -d "$g/rebase-apply" ]; then
407                         __git_eread "$g/rebase-apply/next" step
408                         __git_eread "$g/rebase-apply/last" total
409                         if [ -f "$g/rebase-apply/rebasing" ]; then
410                                 __git_eread "$g/rebase-apply/head-name" b
411                                 r="|REBASE"
412                         elif [ -f "$g/rebase-apply/applying" ]; then
413                                 r="|AM"
414                         else
415                                 r="|AM/REBASE"
416                         fi
417                 elif [ -f "$g/MERGE_HEAD" ]; then
418                         r="|MERGING"
419                 elif [ -f "$g/CHERRY_PICK_HEAD" ]; then
420                         r="|CHERRY-PICKING"
421                 elif [ -f "$g/REVERT_HEAD" ]; then
422                         r="|REVERTING"
423                 elif [ -f "$g/BISECT_LOG" ]; then
424                         r="|BISECTING"
425                 fi
426
427                 if [ -n "$b" ]; then
428                         :
429                 elif [ -h "$g/HEAD" ]; then
430                         # symlink symbolic ref
431                         b="$(git symbolic-ref HEAD 2>/dev/null)"
432                 else
433                         local head=""
434                         if ! __git_eread "$g/HEAD" head; then
435                                 return $exit
436                         fi
437                         # is it a symbolic ref?
438                         b="${head#ref: }"
439                         if [ "$head" = "$b" ]; then
440                                 detached=yes
441                                 b="$(
442                                 case "${GIT_PS1_DESCRIBE_STYLE-}" in
443                                 (contains)
444                                         git describe --contains HEAD ;;
445                                 (branch)
446                                         git describe --contains --all HEAD ;;
447                                 (tag)
448                                         git describe --tags HEAD ;;
449                                 (describe)
450                                         git describe HEAD ;;
451                                 (* | default)
452                                         git describe --tags --exact-match HEAD ;;
453                                 esac 2>/dev/null)" ||
454
455                                 b="$short_sha..."
456                                 b="($b)"
457                         fi
458                 fi
459         fi
460
461         if [ -n "$step" ] && [ -n "$total" ]; then
462                 r="$r $step/$total"
463         fi
464
465         local w=""
466         local i=""
467         local s=""
468         local u=""
469         local c=""
470         local p=""
471
472         if [ "true" = "$inside_gitdir" ]; then
473                 if [ "true" = "$bare_repo" ]; then
474                         c="BARE:"
475                 else
476                         b="GIT_DIR!"
477                 fi
478         elif [ "true" = "$inside_worktree" ]; then
479                 if [ -n "${GIT_PS1_SHOWDIRTYSTATE-}" ] &&
480                    [ "$(git config --bool bash.showDirtyState)" != "false" ]
481                 then
482                         git diff --no-ext-diff --quiet || w="*"
483                         git diff --no-ext-diff --cached --quiet || i="+"
484                         if [ -z "$short_sha" ] && [ -z "$i" ]; then
485                                 i="#"
486                         fi
487                 fi
488                 if [ -n "${GIT_PS1_SHOWSTASHSTATE-}" ] &&
489                    git rev-parse --verify --quiet refs/stash >/dev/null
490                 then
491                         s="$"
492                 fi
493
494                 if [ -n "${GIT_PS1_SHOWUNTRACKEDFILES-}" ] &&
495                    [ "$(git config --bool bash.showUntrackedFiles)" != "false" ] &&
496                    git ls-files --others --exclude-standard --directory --no-empty-directory --error-unmatch -- ':/*' >/dev/null 2>/dev/null
497                 then
498                         u="%${ZSH_VERSION+%}"
499                 fi
500
501                 if [ -n "${GIT_PS1_SHOWUPSTREAM-}" ]; then
502                         __git_ps1_show_upstream
503                 fi
504         fi
505
506         local z="${GIT_PS1_STATESEPARATOR-" "}"
507
508         # NO color option unless in PROMPT_COMMAND mode
509         if [ $pcmode = yes ] && [ -n "${GIT_PS1_SHOWCOLORHINTS-}" ]; then
510                 __git_ps1_colorize_gitstring
511         fi
512
513         b=${b##refs/heads/}
514         if [ $pcmode = yes ] && [ $ps1_expanded = yes ]; then
515                 __git_ps1_branch_name=$b
516                 b="\${__git_ps1_branch_name}"
517         fi
518
519         local f="$w$i$s$u"
520         local gitstring="$c$b${f:+$z$f}$r$p"
521
522         if [ $pcmode = yes ]; then
523                 if [ "${__git_printf_supports_v-}" != yes ]; then
524                         gitstring=$(printf -- "$printf_format" "$gitstring")
525                 else
526                         printf -v gitstring -- "$printf_format" "$gitstring"
527                 fi
528                 PS1="$ps1pc_start$gitstring$ps1pc_end"
529         else
530                 printf -- "$printf_format" "$gitstring"
531         fi
532
533         return $exit
534 }