Merge branch 'sc/doc-howto-dumb-http' into maint
[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 #     legacy        don't use the '--count' option available in recent
64 #                   versions of git-rev-list
65 #     git           always compare HEAD to @{upstream}
66 #     svn           always compare HEAD to your SVN upstream
67 #
68 # By default, __git_ps1 will compare HEAD to your SVN upstream if it can
69 # find one, or @{upstream} otherwise.  Once you have set
70 # GIT_PS1_SHOWUPSTREAM, you can override it on a per-repository basis by
71 # setting the bash.showUpstream config variable.
72 #
73 # If you would like to see more information about the identity of
74 # commits checked out as a detached HEAD, set GIT_PS1_DESCRIBE_STYLE
75 # to one of these values:
76 #
77 #     contains      relative to newer annotated tag (v1.6.3.2~35)
78 #     branch        relative to newer tag or branch (master~4)
79 #     describe      relative to older annotated tag (v1.6.3.1-13-gdd42c2f)
80 #     default       exactly matching tag
81 #
82 # If you would like a colored hint about the current dirty state, set
83 # GIT_PS1_SHOWCOLORHINTS to a nonempty value. The colors are based on
84 # the colored output of "git status -sb" and are available only when
85 # using __git_ps1 for PROMPT_COMMAND or precmd.
86
87 # check whether printf supports -v
88 __git_printf_supports_v=
89 printf -v __git_printf_supports_v -- '%s' yes >/dev/null 2>&1
90
91 # stores the divergence from upstream in $p
92 # used by GIT_PS1_SHOWUPSTREAM
93 __git_ps1_show_upstream ()
94 {
95         local key value
96         local svn_remote svn_url_pattern count n
97         local upstream=git legacy="" verbose=""
98
99         svn_remote=()
100         # get some config options from git-config
101         local output="$(git config -z --get-regexp '^(svn-remote\..*\.url|bash\.showupstream)$' 2>/dev/null | tr '\0\n' '\n ')"
102         while read -r key value; do
103                 case "$key" in
104                 bash.showupstream)
105                         GIT_PS1_SHOWUPSTREAM="$value"
106                         if [[ -z "${GIT_PS1_SHOWUPSTREAM}" ]]; then
107                                 p=""
108                                 return
109                         fi
110                         ;;
111                 svn-remote.*.url)
112                         svn_remote[$((${#svn_remote[@]} + 1))]="$value"
113                         svn_url_pattern="$svn_url_pattern\\|$value"
114                         upstream=svn+git # default upstream is SVN if available, else git
115                         ;;
116                 esac
117         done <<< "$output"
118
119         # parse configuration values
120         for option in ${GIT_PS1_SHOWUPSTREAM}; do
121                 case "$option" in
122                 git|svn) upstream="$option" ;;
123                 verbose) verbose=1 ;;
124                 legacy)  legacy=1  ;;
125                 esac
126         done
127
128         # Find our upstream
129         case "$upstream" in
130         git)    upstream="@{upstream}" ;;
131         svn*)
132                 # get the upstream from the "git-svn-id: ..." in a commit message
133                 # (git-svn uses essentially the same procedure internally)
134                 local -a svn_upstream
135                 svn_upstream=($(git log --first-parent -1 \
136                                         --grep="^git-svn-id: \(${svn_url_pattern#??}\)" 2>/dev/null))
137                 if [[ 0 -ne ${#svn_upstream[@]} ]]; then
138                         svn_upstream=${svn_upstream[${#svn_upstream[@]} - 2]}
139                         svn_upstream=${svn_upstream%@*}
140                         local n_stop="${#svn_remote[@]}"
141                         for ((n=1; n <= n_stop; n++)); do
142                                 svn_upstream=${svn_upstream#${svn_remote[$n]}}
143                         done
144
145                         if [[ -z "$svn_upstream" ]]; then
146                                 # default branch name for checkouts with no layout:
147                                 upstream=${GIT_SVN_ID:-git-svn}
148                         else
149                                 upstream=${svn_upstream#/}
150                         fi
151                 elif [[ "svn+git" = "$upstream" ]]; then
152                         upstream="@{upstream}"
153                 fi
154                 ;;
155         esac
156
157         # Find how many commits we are ahead/behind our upstream
158         if [[ -z "$legacy" ]]; then
159                 count="$(git rev-list --count --left-right \
160                                 "$upstream"...HEAD 2>/dev/null)"
161         else
162                 # produce equivalent output to --count for older versions of git
163                 local commits
164                 if commits="$(git rev-list --left-right "$upstream"...HEAD 2>/dev/null)"
165                 then
166                         local commit behind=0 ahead=0
167                         for commit in $commits
168                         do
169                                 case "$commit" in
170                                 "<"*) ((behind++)) ;;
171                                 *)    ((ahead++))  ;;
172                                 esac
173                         done
174                         count="$behind  $ahead"
175                 else
176                         count=""
177                 fi
178         fi
179
180         # calculate the result
181         if [[ -z "$verbose" ]]; then
182                 case "$count" in
183                 "") # no upstream
184                         p="" ;;
185                 "0      0") # equal to upstream
186                         p="=" ;;
187                 "0      "*) # ahead of upstream
188                         p=">" ;;
189                 *"      0") # behind upstream
190                         p="<" ;;
191                 *)          # diverged from upstream
192                         p="<>" ;;
193                 esac
194         else
195                 case "$count" in
196                 "") # no upstream
197                         p="" ;;
198                 "0      0") # equal to upstream
199                         p=" u=" ;;
200                 "0      "*) # ahead of upstream
201                         p=" u+${count#0 }" ;;
202                 *"      0") # behind upstream
203                         p=" u-${count%  0}" ;;
204                 *)          # diverged from upstream
205                         p=" u+${count#* }-${count%      *}" ;;
206                 esac
207         fi
208
209 }
210
211 # Helper function that is meant to be called from __git_ps1.  It
212 # injects color codes into the appropriate gitstring variables used
213 # to build a gitstring.
214 __git_ps1_colorize_gitstring ()
215 {
216         if [[ -n ${ZSH_VERSION-} ]]; then
217                 local c_red='%F{red}'
218                 local c_green='%F{green}'
219                 local c_lblue='%F{blue}'
220                 local c_clear='%f'
221         else
222                 # Using \[ and \] around colors is necessary to prevent
223                 # issues with command line editing/browsing/completion!
224                 local c_red='\[\e[31m\]'
225                 local c_green='\[\e[32m\]'
226                 local c_lblue='\[\e[1;34m\]'
227                 local c_clear='\[\e[0m\]'
228         fi
229         local bad_color=$c_red
230         local ok_color=$c_green
231         local flags_color="$c_lblue"
232
233         local branch_color=""
234         if [ $detached = no ]; then
235                 branch_color="$ok_color"
236         else
237                 branch_color="$bad_color"
238         fi
239         c="$branch_color$c"
240
241         z="$c_clear$z"
242         if [ "$w" = "*" ]; then
243                 w="$bad_color$w"
244         fi
245         if [ -n "$i" ]; then
246                 i="$ok_color$i"
247         fi
248         if [ -n "$s" ]; then
249                 s="$flags_color$s"
250         fi
251         if [ -n "$u" ]; then
252                 u="$bad_color$u"
253         fi
254         r="$c_clear$r"
255 }
256
257 # __git_ps1 accepts 0 or 1 arguments (i.e., format string)
258 # when called from PS1 using command substitution
259 # in this mode it prints text to add to bash PS1 prompt (includes branch name)
260 #
261 # __git_ps1 requires 2 or 3 arguments when called from PROMPT_COMMAND (pc)
262 # in that case it _sets_ PS1. The arguments are parts of a PS1 string.
263 # when two arguments are given, the first is prepended and the second appended
264 # to the state string when assigned to PS1.
265 # The optional third parameter will be used as printf format string to further
266 # customize the output of the git-status string.
267 # In this mode you can request colored hints using GIT_PS1_SHOWCOLORHINTS=true
268 __git_ps1 ()
269 {
270         local pcmode=no
271         local detached=no
272         local ps1pc_start='\u@\h:\w '
273         local ps1pc_end='\$ '
274         local printf_format=' (%s)'
275
276         case "$#" in
277                 2|3)    pcmode=yes
278                         ps1pc_start="$1"
279                         ps1pc_end="$2"
280                         printf_format="${3:-$printf_format}"
281                 ;;
282                 0|1)    printf_format="${1:-$printf_format}"
283                 ;;
284                 *)      return
285                 ;;
286         esac
287
288         local repo_info rev_parse_exit_code
289         repo_info="$(git rev-parse --git-dir --is-inside-git-dir \
290                 --is-bare-repository --is-inside-work-tree \
291                 --short HEAD 2>/dev/null)"
292         rev_parse_exit_code="$?"
293
294         if [ -z "$repo_info" ]; then
295                 if [ $pcmode = yes ]; then
296                         #In PC mode PS1 always needs to be set
297                         PS1="$ps1pc_start$ps1pc_end"
298                 fi
299                 return
300         fi
301
302         local short_sha
303         if [ "$rev_parse_exit_code" = "0" ]; then
304                 short_sha="${repo_info##*$'\n'}"
305                 repo_info="${repo_info%$'\n'*}"
306         fi
307         local inside_worktree="${repo_info##*$'\n'}"
308         repo_info="${repo_info%$'\n'*}"
309         local bare_repo="${repo_info##*$'\n'}"
310         repo_info="${repo_info%$'\n'*}"
311         local inside_gitdir="${repo_info##*$'\n'}"
312         local g="${repo_info%$'\n'*}"
313
314         local r=""
315         local b=""
316         local step=""
317         local total=""
318         if [ -d "$g/rebase-merge" ]; then
319                 read b 2>/dev/null <"$g/rebase-merge/head-name"
320                 read step 2>/dev/null <"$g/rebase-merge/msgnum"
321                 read total 2>/dev/null <"$g/rebase-merge/end"
322                 if [ -f "$g/rebase-merge/interactive" ]; then
323                         r="|REBASE-i"
324                 else
325                         r="|REBASE-m"
326                 fi
327         else
328                 if [ -d "$g/rebase-apply" ]; then
329                         read step 2>/dev/null <"$g/rebase-apply/next"
330                         read total 2>/dev/null <"$g/rebase-apply/last"
331                         if [ -f "$g/rebase-apply/rebasing" ]; then
332                                 read b 2>/dev/null <"$g/rebase-apply/head-name"
333                                 r="|REBASE"
334                         elif [ -f "$g/rebase-apply/applying" ]; then
335                                 r="|AM"
336                         else
337                                 r="|AM/REBASE"
338                         fi
339                 elif [ -f "$g/MERGE_HEAD" ]; then
340                         r="|MERGING"
341                 elif [ -f "$g/CHERRY_PICK_HEAD" ]; then
342                         r="|CHERRY-PICKING"
343                 elif [ -f "$g/REVERT_HEAD" ]; then
344                         r="|REVERTING"
345                 elif [ -f "$g/BISECT_LOG" ]; then
346                         r="|BISECTING"
347                 fi
348
349                 if [ -n "$b" ]; then
350                         :
351                 elif [ -h "$g/HEAD" ]; then
352                         # symlink symbolic ref
353                         b="$(git symbolic-ref HEAD 2>/dev/null)"
354                 else
355                         local head=""
356                         if ! read head 2>/dev/null <"$g/HEAD"; then
357                                 if [ $pcmode = yes ]; then
358                                         PS1="$ps1pc_start$ps1pc_end"
359                                 fi
360                                 return
361                         fi
362                         # is it a symbolic ref?
363                         b="${head#ref: }"
364                         if [ "$head" = "$b" ]; then
365                                 detached=yes
366                                 b="$(
367                                 case "${GIT_PS1_DESCRIBE_STYLE-}" in
368                                 (contains)
369                                         git describe --contains HEAD ;;
370                                 (branch)
371                                         git describe --contains --all HEAD ;;
372                                 (describe)
373                                         git describe HEAD ;;
374                                 (* | default)
375                                         git describe --tags --exact-match HEAD ;;
376                                 esac 2>/dev/null)" ||
377
378                                 b="$short_sha..."
379                                 b="($b)"
380                         fi
381                 fi
382         fi
383
384         if [ -n "$step" ] && [ -n "$total" ]; then
385                 r="$r $step/$total"
386         fi
387
388         local w=""
389         local i=""
390         local s=""
391         local u=""
392         local c=""
393         local p=""
394
395         if [ "true" = "$inside_gitdir" ]; then
396                 if [ "true" = "$bare_repo" ]; then
397                         c="BARE:"
398                 else
399                         b="GIT_DIR!"
400                 fi
401         elif [ "true" = "$inside_worktree" ]; then
402                 if [ -n "${GIT_PS1_SHOWDIRTYSTATE-}" ] &&
403                    [ "$(git config --bool bash.showDirtyState)" != "false" ]
404                 then
405                         git diff --no-ext-diff --quiet --exit-code || w="*"
406                         if [ -n "$short_sha" ]; then
407                                 git diff-index --cached --quiet HEAD -- || i="+"
408                         else
409                                 i="#"
410                         fi
411                 fi
412                 if [ -n "${GIT_PS1_SHOWSTASHSTATE-}" ] &&
413                    [ -r "$g/refs/stash" ]; then
414                         s="$"
415                 fi
416
417                 if [ -n "${GIT_PS1_SHOWUNTRACKEDFILES-}" ] &&
418                    [ "$(git config --bool bash.showUntrackedFiles)" != "false" ] &&
419                    git ls-files --others --exclude-standard --error-unmatch -- '*' >/dev/null 2>/dev/null
420                 then
421                         u="%${ZSH_VERSION+%}"
422                 fi
423
424                 if [ -n "${GIT_PS1_SHOWUPSTREAM-}" ]; then
425                         __git_ps1_show_upstream
426                 fi
427         fi
428
429         local z="${GIT_PS1_STATESEPARATOR-" "}"
430
431         # NO color option unless in PROMPT_COMMAND mode
432         if [ $pcmode = yes ] && [ -n "${GIT_PS1_SHOWCOLORHINTS-}" ]; then
433                 __git_ps1_colorize_gitstring
434         fi
435
436         local f="$w$i$s$u"
437         local gitstring="$c${b##refs/heads/}${f:+$z$f}$r$p"
438
439         if [ $pcmode = yes ]; then
440                 if [ "${__git_printf_supports_v-}" != yes ]; then
441                         gitstring=$(printf -- "$printf_format" "$gitstring")
442                 else
443                         printf -v gitstring -- "$printf_format" "$gitstring"
444                 fi
445                 PS1="$ps1pc_start$gitstring$ps1pc_end"
446         else
447                 printf -- "$printf_format" "$gitstring"
448         fi
449 }