make __git_ps1 accept a third parameter in pcmode

The optional third parameter when __git_ps1 is used in
PROMPT_COMMAND mode as format string for printf to further
customize the way the git status string is embedded in the
user's PS1 prompt.

Signed-off-by: Simon Oosthoek <s.oosthoek@xs4all.nl>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Simon Oosthoek 2012-12-26 20:15:05 +01:00 committed by Junio C Hamano
parent de29a7ac0e
commit 126b59692b

View File

@ -24,6 +24,8 @@
# will show username, at-sign, host, colon, cwd, then # will show username, at-sign, host, colon, cwd, then
# various status string, followed by dollar and SP, as # various status string, followed by dollar and SP, as
# your prompt. # your prompt.
# Optionally, you can supply a third argument with a printf
# format string to finetune the output of the branch status
# #
# The argument to __git_ps1 will be displayed only if you are currently # The argument to __git_ps1 will be displayed only if you are currently
# in a git repository. The %s token will be the name of the current # in a git repository. The %s token will be the name of the current
@ -213,10 +215,12 @@ __git_ps1_show_upstream ()
# when called from PS1 using command substitution # when called from PS1 using command substitution
# in this mode it prints text to add to bash PS1 prompt (includes branch name) # in this mode it prints text to add to bash PS1 prompt (includes branch name)
# #
# __git_ps1 requires 2 arguments when called from PROMPT_COMMAND (pc) # __git_ps1 requires 2 or 3 arguments when called from PROMPT_COMMAND (pc)
# in that case it _sets_ PS1. The arguments are parts of a PS1 string. # in that case it _sets_ PS1. The arguments are parts of a PS1 string.
# when both arguments are given, the first is prepended and the second appended # when two arguments are given, the first is prepended and the second appended
# to the state string when assigned to PS1. # to the state string when assigned to PS1.
# The optional third parameter will be used as printf format string to further
# customize the output of the git-status string.
# In this mode you can request colored hints using GIT_PS1_SHOWCOLORHINTS=true # In this mode you can request colored hints using GIT_PS1_SHOWCOLORHINTS=true
__git_ps1 () __git_ps1 ()
{ {
@ -227,9 +231,10 @@ __git_ps1 ()
local printf_format=' (%s)' local printf_format=' (%s)'
case "$#" in case "$#" in
2) pcmode=yes 2|3) pcmode=yes
ps1pc_start="$1" ps1pc_start="$1"
ps1pc_end="$2" ps1pc_end="$2"
printf_format="${3:-$printf_format}"
;; ;;
0|1) printf_format="${1:-$printf_format}" 0|1) printf_format="${1:-$printf_format}"
;; ;;
@ -330,6 +335,7 @@ __git_ps1 ()
local f="$w$i$s$u" local f="$w$i$s$u"
if [ $pcmode = yes ]; then if [ $pcmode = yes ]; then
local gitstring=
if [ -n "${GIT_PS1_SHOWCOLORHINTS-}" ]; then if [ -n "${GIT_PS1_SHOWCOLORHINTS-}" ]; then
local c_red='\e[31m' local c_red='\e[31m'
local c_green='\e[32m' local c_green='\e[32m'
@ -347,29 +353,31 @@ __git_ps1 ()
branch_color="$bad_color" branch_color="$bad_color"
fi fi
# Setting PS1 directly with \[ and \] around colors # Setting gitstring directly with \[ and \] around colors
# is necessary to prevent wrapping issues! # is necessary to prevent wrapping issues!
PS1="$ps1pc_start (\[$branch_color\]$branchstring\[$c_clear\]" gitstring="\[$branch_color\]$branchstring\[$c_clear\]"
if [ -n "$w$i$s$u$r$p" ]; then if [ -n "$w$i$s$u$r$p" ]; then
PS1="$PS1 " gitstring="$gitstring "
fi fi
if [ "$w" = "*" ]; then if [ "$w" = "*" ]; then
PS1="$PS1\[$bad_color\]$w" gitstring="$gitstring\[$bad_color\]$w"
fi fi
if [ -n "$i" ]; then if [ -n "$i" ]; then
PS1="$PS1\[$ok_color\]$i" gitstring="$gitstring\[$ok_color\]$i"
fi fi
if [ -n "$s" ]; then if [ -n "$s" ]; then
PS1="$PS1\[$flags_color\]$s" gitstring="$gitstring\[$flags_color\]$s"
fi fi
if [ -n "$u" ]; then if [ -n "$u" ]; then
PS1="$PS1\[$bad_color\]$u" gitstring="$gitstring\[$bad_color\]$u"
fi fi
PS1="$PS1\[$c_clear\]$r$p)$ps1pc_end" gitstring="$gitstring\[$c_clear\]$r$p"
else else
PS1="$ps1pc_start ($c${b##refs/heads/}${f:+ $f}$r$p)$ps1pc_end" gitstring="$c${b##refs/heads/}${f:+ $f}$r$p"
fi fi
gitstring=$(printf -- "$printf_format" "$gitstring")
PS1="$ps1pc_start$gitstring$ps1pc_end"
else else
# NO color option unless in PROMPT_COMMAND mode # NO color option unless in PROMPT_COMMAND mode
printf -- "$printf_format" "$c${b##refs/heads/}${f:+ $f}$r$p" printf -- "$printf_format" "$c${b##refs/heads/}${f:+ $f}$r$p"