]> src.twobees.de Git - dotfiles.git/blob - stow/oh-my-zsh/.oh-my-zsh/plugins/gitfast/git-prompt.sh
...
[dotfiles.git] / stow / oh-my-zsh / .oh-my-zsh / plugins / gitfast / 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 # By default, __git_ps1 will compare HEAD to your SVN upstream if it can
70 # find one, or @{upstream} otherwise.  Once you have set
71 # GIT_PS1_SHOWUPSTREAM, you can override it on a per-repository basis by
72 # setting the bash.showUpstream config variable.
73 #
74 # You can change the separator between the branch name and the above
75 # state symbols by setting GIT_PS1_STATESEPARATOR. The default separator
76 # is SP.
77 #
78 # When there is an in-progress operation such as a merge, rebase,
79 # revert, cherry-pick, or bisect, the prompt will include information
80 # related to the operation, often in the form "|<OPERATION-NAME>".
81 #
82 # When the repository has a sparse-checkout, a notification of the form
83 # "|SPARSE" will be included in the prompt.  This can be shortened to a
84 # single '?' character by setting GIT_PS1_COMPRESSSPARSESTATE, or omitted
85 # by setting GIT_PS1_OMITSPARSESTATE.
86 #
87 # If you would like to see more information about the identity of
88 # commits checked out as a detached HEAD, set GIT_PS1_DESCRIBE_STYLE
89 # to one of these values:
90 #
91 #     contains      relative to newer annotated tag (v1.6.3.2~35)
92 #     branch        relative to newer tag or branch (master~4)
93 #     describe      relative to older annotated tag (v1.6.3.1-13-gdd42c2f)
94 #     tag           relative to any older tag (v1.6.3.1-13-gdd42c2f)
95 #     default       exactly matching tag
96 #
97 # If you would like a colored hint about the current dirty state, set
98 # GIT_PS1_SHOWCOLORHINTS to a nonempty value. The colors are based on
99 # the colored output of "git status -sb" and are available only when
100 # using __git_ps1 for PROMPT_COMMAND or precmd in Bash,
101 # but always available in Zsh.
102 #
103 # If you would like __git_ps1 to do nothing in the case when the current
104 # directory is set up to be ignored by git, then set
105 # GIT_PS1_HIDE_IF_PWD_IGNORED to a nonempty value. Override this on the
106 # repository level by setting bash.hideIfPwdIgnored to "false".
107
108 # check whether printf supports -v
109 __git_printf_supports_v=
110 printf -v __git_printf_supports_v -- '%s' yes >/dev/null 2>&1
111
112 # stores the divergence from upstream in $p
113 # used by GIT_PS1_SHOWUPSTREAM
114 __git_ps1_show_upstream ()
115 {
116         local key value
117         local svn_remote svn_url_pattern count n
118         local upstream_type=git legacy="" verbose="" name=""
119
120         svn_remote=()
121         # get some config options from git-config
122         local output="$(git config -z --get-regexp '^(svn-remote\..*\.url|bash\.showupstream)$' 2>/dev/null | tr '\0\n' '\n ')"
123         while read -r key value; do
124                 case "$key" in
125                 bash.showupstream)
126                         GIT_PS1_SHOWUPSTREAM="$value"
127                         if [[ -z "${GIT_PS1_SHOWUPSTREAM}" ]]; then
128                                 p=""
129                                 return
130                         fi
131                         ;;
132                 svn-remote.*.url)
133                         svn_remote[$((${#svn_remote[@]} + 1))]="$value"
134                         svn_url_pattern="$svn_url_pattern\\|$value"
135                         upstream_type=svn+git # default upstream type is SVN if available, else git
136                         ;;
137                 esac
138         done <<< "$output"
139
140         # parse configuration values
141         local option
142         for option in ${GIT_PS1_SHOWUPSTREAM}; do
143                 case "$option" in
144                 git|svn) upstream_type="$option" ;;
145                 verbose) verbose=1 ;;
146                 legacy)  legacy=1  ;;
147                 name)    name=1 ;;
148                 esac
149         done
150
151         # Find our upstream type
152         case "$upstream_type" in
153         git)    upstream_type="@{upstream}" ;;
154         svn*)
155                 # get the upstream from the "git-svn-id: ..." in a commit message
156                 # (git-svn uses essentially the same procedure internally)
157                 local -a svn_upstream
158                 svn_upstream=($(git log --first-parent -1 \
159                                         --grep="^git-svn-id: \(${svn_url_pattern#??}\)" 2>/dev/null))
160                 if [[ 0 -ne ${#svn_upstream[@]} ]]; then
161                         svn_upstream=${svn_upstream[${#svn_upstream[@]} - 2]}
162                         svn_upstream=${svn_upstream%@*}
163                         local n_stop="${#svn_remote[@]}"
164                         for ((n=1; n <= n_stop; n++)); do
165                                 svn_upstream=${svn_upstream#${svn_remote[$n]}}
166                         done
167
168                         if [[ -z "$svn_upstream" ]]; then
169                                 # default branch name for checkouts with no layout:
170                                 upstream_type=${GIT_SVN_ID:-git-svn}
171                         else
172                                 upstream_type=${svn_upstream#/}
173                         fi
174                 elif [[ "svn+git" = "$upstream_type" ]]; then
175                         upstream_type="@{upstream}"
176                 fi
177                 ;;
178         esac
179
180         # Find how many commits we are ahead/behind our upstream
181         if [[ -z "$legacy" ]]; then
182                 count="$(git rev-list --count --left-right \
183                                 "$upstream_type"...HEAD 2>/dev/null)"
184         else
185                 # produce equivalent output to --count for older versions of git
186                 local commits
187                 if commits="$(git rev-list --left-right "$upstream_type"...HEAD 2>/dev/null)"
188                 then
189                         local commit behind=0 ahead=0
190                         for commit in $commits
191                         do
192                                 case "$commit" in
193                                 "<"*) ((behind++)) ;;
194                                 *)    ((ahead++))  ;;
195                                 esac
196                         done
197                         count="$behind  $ahead"
198                 else
199                         count=""
200                 fi
201         fi
202
203         # calculate the result
204         if [[ -z "$verbose" ]]; then
205                 case "$count" in
206                 "") # no upstream
207                         p="" ;;
208                 "0      0") # equal to upstream
209                         p="=" ;;
210                 "0      "*) # ahead of upstream
211                         p=">" ;;
212                 *"      0") # behind upstream
213                         p="<" ;;
214                 *)          # diverged from upstream
215                         p="<>" ;;
216                 esac
217         else # verbose, set upstream instead of p
218                 case "$count" in
219                 "") # no upstream
220                         upstream="" ;;
221                 "0      0") # equal to upstream
222                         upstream="|u=" ;;
223                 "0      "*) # ahead of upstream
224                         upstream="|u+${count#0  }" ;;
225                 *"      0") # behind upstream
226                         upstream="|u-${count%   0}" ;;
227                 *)          # diverged from upstream
228                         upstream="|u+${count#*  }-${count%      *}" ;;
229                 esac
230                 if [[ -n "$count" && -n "$name" ]]; then
231                         __git_ps1_upstream_name=$(git rev-parse \
232                                 --abbrev-ref "$upstream_type" 2>/dev/null)
233                         if [ $pcmode = yes ] && [ $ps1_expanded = yes ]; then
234                                 upstream="$upstream \${__git_ps1_upstream_name}"
235                         else
236                                 upstream="$upstream ${__git_ps1_upstream_name}"
237                                 # not needed anymore; keep user's
238                                 # environment clean
239                                 unset __git_ps1_upstream_name
240                         fi
241                 fi
242         fi
243
244 }
245
246 # Helper function that is meant to be called from __git_ps1.  It
247 # injects color codes into the appropriate gitstring variables used
248 # to build a gitstring. Colored variables are responsible for clearing
249 # their own color.
250 __git_ps1_colorize_gitstring ()
251 {
252         if [[ -n ${ZSH_VERSION-} ]]; then
253                 local c_red='%F{red}'
254                 local c_green='%F{green}'
255                 local c_lblue='%F{blue}'
256                 local c_clear='%f'
257         else
258                 # Using \[ and \] around colors is necessary to prevent
259                 # issues with command line editing/browsing/completion!
260                 local c_red='\[\e[31m\]'
261                 local c_green='\[\e[32m\]'
262                 local c_lblue='\[\e[1;34m\]'
263                 local c_clear='\[\e[0m\]'
264         fi
265         local bad_color=$c_red
266         local ok_color=$c_green
267         local flags_color="$c_lblue"
268
269         local branch_color=""
270         if [ $detached = no ]; then
271                 branch_color="$ok_color"
272         else
273                 branch_color="$bad_color"
274         fi
275         if [ -n "$c" ]; then
276                 c="$branch_color$c$c_clear"
277         fi
278         b="$branch_color$b$c_clear"
279
280         if [ -n "$w" ]; then
281                 w="$bad_color$w$c_clear"
282         fi
283         if [ -n "$i" ]; then
284                 i="$ok_color$i$c_clear"
285         fi
286         if [ -n "$s" ]; then
287                 s="$flags_color$s$c_clear"
288         fi
289         if [ -n "$u" ]; then
290                 u="$bad_color$u$c_clear"
291         fi
292 }
293
294 # Helper function to read the first line of a file into a variable.
295 # __git_eread requires 2 arguments, the file path and the name of the
296 # variable, in that order.
297 __git_eread ()
298 {
299         test -r "$1" && IFS=$'\r\n' read "$2" <"$1"
300 }
301
302 # see if a cherry-pick or revert is in progress, if the user has committed a
303 # conflict resolution with 'git commit' in the middle of a sequence of picks or
304 # reverts then CHERRY_PICK_HEAD/REVERT_HEAD will not exist so we have to read
305 # the todo file.
306 __git_sequencer_status ()
307 {
308         local todo
309         if test -f "$g/CHERRY_PICK_HEAD"
310         then
311                 r="|CHERRY-PICKING"
312                 return 0;
313         elif test -f "$g/REVERT_HEAD"
314         then
315                 r="|REVERTING"
316                 return 0;
317         elif __git_eread "$g/sequencer/todo" todo
318         then
319                 case "$todo" in
320                 p[\ \   ]|pick[\ \      ]*)
321                         r="|CHERRY-PICKING"
322                         return 0
323                 ;;
324                 revert[\ \      ]*)
325                         r="|REVERTING"
326                         return 0
327                 ;;
328                 esac
329         fi
330         return 1
331 }
332
333 # __git_ps1 accepts 0 or 1 arguments (i.e., format string)
334 # when called from PS1 using command substitution
335 # in this mode it prints text to add to bash PS1 prompt (includes branch name)
336 #
337 # __git_ps1 requires 2 or 3 arguments when called from PROMPT_COMMAND (pc)
338 # in that case it _sets_ PS1. The arguments are parts of a PS1 string.
339 # when two arguments are given, the first is prepended and the second appended
340 # to the state string when assigned to PS1.
341 # The optional third parameter will be used as printf format string to further
342 # customize the output of the git-status string.
343 # In this mode you can request colored hints using GIT_PS1_SHOWCOLORHINTS=true
344 __git_ps1 ()
345 {
346         # preserve exit status
347         local exit=$?
348         local pcmode=no
349         local detached=no
350         local ps1pc_start='\u@\h:\w '
351         local ps1pc_end='\$ '
352         local printf_format=' (%s)'
353
354         case "$#" in
355                 2|3)    pcmode=yes
356                         ps1pc_start="$1"
357                         ps1pc_end="$2"
358                         printf_format="${3:-$printf_format}"
359                         # set PS1 to a plain prompt so that we can
360                         # simply return early if the prompt should not
361                         # be decorated
362                         PS1="$ps1pc_start$ps1pc_end"
363                 ;;
364                 0|1)    printf_format="${1:-$printf_format}"
365                 ;;
366                 *)      return $exit
367                 ;;
368         esac
369
370         # ps1_expanded:  This variable is set to 'yes' if the shell
371         # subjects the value of PS1 to parameter expansion:
372         #
373         #   * bash does unless the promptvars option is disabled
374         #   * zsh does not unless the PROMPT_SUBST option is set
375         #   * POSIX shells always do
376         #
377         # If the shell would expand the contents of PS1 when drawing
378         # the prompt, a raw ref name must not be included in PS1.
379         # This protects the user from arbitrary code execution via
380         # specially crafted ref names.  For example, a ref named
381         # 'refs/heads/$(IFS=_;cmd=sudo_rm_-rf_/;$cmd)' might cause the
382         # shell to execute 'sudo rm -rf /' when the prompt is drawn.
383         #
384         # Instead, the ref name should be placed in a separate global
385         # variable (in the __git_ps1_* namespace to avoid colliding
386         # with the user's environment) and that variable should be
387         # referenced from PS1.  For example:
388         #
389         #     __git_ps1_foo=$(do_something_to_get_ref_name)
390         #     PS1="...stuff...\${__git_ps1_foo}...stuff..."
391         #
392         # If the shell does not expand the contents of PS1, the raw
393         # ref name must be included in PS1.
394         #
395         # The value of this variable is only relevant when in pcmode.
396         #
397         # Assume that the shell follows the POSIX specification and
398         # expands PS1 unless determined otherwise.  (This is more
399         # likely to be correct if the user has a non-bash, non-zsh
400         # shell and safer than the alternative if the assumption is
401         # incorrect.)
402         #
403         local ps1_expanded=yes
404         [ -z "${ZSH_VERSION-}" ] || [[ -o PROMPT_SUBST ]] || ps1_expanded=no
405         [ -z "${BASH_VERSION-}" ] || shopt -q promptvars || ps1_expanded=no
406
407         local repo_info rev_parse_exit_code
408         repo_info="$(git rev-parse --git-dir --is-inside-git-dir \
409                 --is-bare-repository --is-inside-work-tree \
410                 --short HEAD 2>/dev/null)"
411         rev_parse_exit_code="$?"
412
413         if [ -z "$repo_info" ]; then
414                 return $exit
415         fi
416
417         local short_sha=""
418         if [ "$rev_parse_exit_code" = "0" ]; then
419                 short_sha="${repo_info##*$'\n'}"
420                 repo_info="${repo_info%$'\n'*}"
421         fi
422         local inside_worktree="${repo_info##*$'\n'}"
423         repo_info="${repo_info%$'\n'*}"
424         local bare_repo="${repo_info##*$'\n'}"
425         repo_info="${repo_info%$'\n'*}"
426         local inside_gitdir="${repo_info##*$'\n'}"
427         local g="${repo_info%$'\n'*}"
428
429         if [ "true" = "$inside_worktree" ] &&
430            [ -n "${GIT_PS1_HIDE_IF_PWD_IGNORED-}" ] &&
431            [ "$(git config --bool bash.hideIfPwdIgnored)" != "false" ] &&
432            git check-ignore -q .
433         then
434                 return $exit
435         fi
436
437         local sparse=""
438         if [ -z "${GIT_PS1_COMPRESSSPARSESTATE-}" ] &&
439            [ -z "${GIT_PS1_OMITSPARSESTATE-}" ] &&
440            [ "$(git config --bool core.sparseCheckout)" = "true" ]; then
441                 sparse="|SPARSE"
442         fi
443
444         local r=""
445         local b=""
446         local step=""
447         local total=""
448         if [ -d "$g/rebase-merge" ]; then
449                 __git_eread "$g/rebase-merge/head-name" b
450                 __git_eread "$g/rebase-merge/msgnum" step
451                 __git_eread "$g/rebase-merge/end" total
452                 r="|REBASE"
453         else
454                 if [ -d "$g/rebase-apply" ]; then
455                         __git_eread "$g/rebase-apply/next" step
456                         __git_eread "$g/rebase-apply/last" total
457                         if [ -f "$g/rebase-apply/rebasing" ]; then
458                                 __git_eread "$g/rebase-apply/head-name" b
459                                 r="|REBASE"
460                         elif [ -f "$g/rebase-apply/applying" ]; then
461                                 r="|AM"
462                         else
463                                 r="|AM/REBASE"
464                         fi
465                 elif [ -f "$g/MERGE_HEAD" ]; then
466                         r="|MERGING"
467                 elif __git_sequencer_status; then
468                         :
469                 elif [ -f "$g/BISECT_LOG" ]; then
470                         r="|BISECTING"
471                 fi
472
473                 if [ -n "$b" ]; then
474                         :
475                 elif [ -h "$g/HEAD" ]; then
476                         # symlink symbolic ref
477                         b="$(git symbolic-ref HEAD 2>/dev/null)"
478                 else
479                         local head=""
480                         if ! __git_eread "$g/HEAD" head; then
481                                 return $exit
482                         fi
483                         # is it a symbolic ref?
484                         b="${head#ref: }"
485                         if [ "$head" = "$b" ]; then
486                                 detached=yes
487                                 b="$(
488                                 case "${GIT_PS1_DESCRIBE_STYLE-}" in
489                                 (contains)
490                                         git describe --contains HEAD ;;
491                                 (branch)
492                                         git describe --contains --all HEAD ;;
493                                 (tag)
494                                         git describe --tags HEAD ;;
495                                 (describe)
496                                         git describe HEAD ;;
497                                 (* | default)
498                                         git describe --tags --exact-match HEAD ;;
499                                 esac 2>/dev/null)" ||
500
501                                 b="$short_sha..."
502                                 b="($b)"
503                         fi
504                 fi
505         fi
506
507         if [ -n "$step" ] && [ -n "$total" ]; then
508                 r="$r $step/$total"
509         fi
510
511         local w=""
512         local i=""
513         local s=""
514         local u=""
515         local h=""
516         local c=""
517         local p="" # short version of upstream state indicator
518         local upstream="" # verbose version of upstream state indicator
519
520         if [ "true" = "$inside_gitdir" ]; then
521                 if [ "true" = "$bare_repo" ]; then
522                         c="BARE:"
523                 else
524                         b="GIT_DIR!"
525                 fi
526         elif [ "true" = "$inside_worktree" ]; then
527                 if [ -n "${GIT_PS1_SHOWDIRTYSTATE-}" ] &&
528                    [ "$(git config --bool bash.showDirtyState)" != "false" ]
529                 then
530                         git diff --no-ext-diff --quiet || w="*"
531                         git diff --no-ext-diff --cached --quiet || i="+"
532                         if [ -z "$short_sha" ] && [ -z "$i" ]; then
533                                 i="#"
534                         fi
535                 fi
536                 if [ -n "${GIT_PS1_SHOWSTASHSTATE-}" ] &&
537                    git rev-parse --verify --quiet refs/stash >/dev/null
538                 then
539                         s="$"
540                 fi
541
542                 if [ -n "${GIT_PS1_SHOWUNTRACKEDFILES-}" ] &&
543                    [ "$(git config --bool bash.showUntrackedFiles)" != "false" ] &&
544                    git ls-files --others --exclude-standard --directory --no-empty-directory --error-unmatch -- ':/*' >/dev/null 2>/dev/null
545                 then
546                         u="%${ZSH_VERSION+%}"
547                 fi
548
549                 if [ -n "${GIT_PS1_COMPRESSSPARSESTATE-}" ] &&
550                    [ "$(git config --bool core.sparseCheckout)" = "true" ]; then
551                         h="?"
552                 fi
553
554                 if [ -n "${GIT_PS1_SHOWUPSTREAM-}" ]; then
555                         __git_ps1_show_upstream
556                 fi
557         fi
558
559         local z="${GIT_PS1_STATESEPARATOR-" "}"
560
561         b=${b##refs/heads/}
562         if [ $pcmode = yes ] && [ $ps1_expanded = yes ]; then
563                 __git_ps1_branch_name=$b
564                 b="\${__git_ps1_branch_name}"
565         fi
566
567         # NO color option unless in PROMPT_COMMAND mode or it's Zsh
568         if [ -n "${GIT_PS1_SHOWCOLORHINTS-}" ]; then
569                 if [ $pcmode = yes ] || [ -n "${ZSH_VERSION-}" ]; then
570                         __git_ps1_colorize_gitstring
571                 fi
572         fi
573
574         local f="$h$w$i$s$u$p"
575         local gitstring="$c$b${f:+$z$f}${sparse}$r${upstream}"
576
577         if [ $pcmode = yes ]; then
578                 if [ "${__git_printf_supports_v-}" != yes ]; then
579                         gitstring=$(printf -- "$printf_format" "$gitstring")
580                 else
581                         printf -v gitstring -- "$printf_format" "$gitstring"
582                 fi
583                 PS1="$ps1pc_start$gitstring$ps1pc_end"
584         else
585                 printf -- "$printf_format" "$gitstring"
586         fi
587
588         return $exit
589 }