cf6f1e69a4a1edeb8bcfe947824294286fa2443d
[profile.git] / .profile.d / ps1.bashrc
1 #!bash Coloured prompts.
2 # To use, add a call to __ps1 in your .bash_profile file.
3 #
4 # The prompt comprises multiple parts, some of which may be hidden by unsetting 
5 # shell variables or using the ``prompt'' function.
6 #
7 # The first part of the prompt is user@host where host is highlighted in 
8 # green if the last command exited 0 or in red otherwise.
9 # This part will be shown only if __ps1_user is 1.  By default it is 1.
10 # The success and failure colours can be changed by modifying 
11 # $PROMPT_OK_COLOUR and $PROMPT_FAILURE_COLOUR respectively.
12 #
13 # The second part of the prompt is taken from git-completion.bashrc.
14 # It is shown only if __ps1_git is 1.  By default it is 0.
15 #
16 # The third part of the prompt is taken from p4-completion.bashrc.
17 # It is shown only if __ps1_p4 is 1.  By default it is 0.
18 #
19 # The fourth part of the prompt is taken from svn-completion.bashrc.
20 # It is shown only if __ps1_svn is 1.  By default it is 0.
21 #
22 # The fifth part of the prompt is the exit status of the last command.
23 # This part will be shown only if __ps1_user is set and the exit status is 
24 # non-zero.
25
26 # The final part of the prompt is the (full) working directory and $ string.
27 #
28 # Colouring is performed by the __ps1_col() and __ps1_ret() functions.
29 # We redirect stderr to /dev/null when calling these functions to prevent 
30 # bash complaining about not knowing them when you su to another user, 
31 # retaining PS1 but not the function definitions.
32 #
33 # Note that $? is passed as an argument to - and is returned from - all 
34 # functions.  As $? is set following any shell activity it is only guaranteed 
35 # to represent the return code of the last command at the beginning of __ps1().
36 # By passing between subsequent functions we ensure that it is available for 
37 # __ps1_ret().
38 #
39
40 # Pick a colour based on the terminal capabilities.
41 # OK: dark green.
42 # Failed: dark red.
43 # Git: royal blue.
44 # P4: yellow.
45 # SVN: magenta.
46 case $(tput colors) in
47   256)
48     export PROMPT_OK_COLOUR="1;38;5;34"
49     export PROMPT_FAILED_COLOUR="1;38;5;160"
50     export GIT_COLOUR="0;38;5;33"
51     export SVN_COLOUR="0;38;5;127"
52     export P4_COLOUR="0;38;5;142"
53   ;;
54
55   88)
56     export PROMPT_OK_COLOUR="1;38;5;24"
57     export PROMPT_FAILED_COLOUR="1;38;5;48"
58     export GIT_COLOUR="0;38;5;23"
59     export SVN_COLOUR="0;38;5;49"
60     export P4_COLOUR="0;38;5;56"
61   ;;
62
63   *)
64     export PROMPT_OK_COLOUR="1;32"
65     export PROMPT_FAILED_COLOUR="1;31"
66     export GIT_COLOUR="0;36"
67     export SVN_COLOUR="0;35"
68     export P4_COLOUR="0;33"
69   ;;
70 esac
71
72 function __ps1() {
73   # Default __ps1_user to 1.
74   [ -z "$__ps1_user" ] && __ps1_user=1
75
76   export PS1='$(__ps1_user $? \u@)\[\033[$(__ps1_col $? 2>/dev/null)m\]$(__ps1_user $? \h)\[\033[$(__ps1_colour_escape $GIT_COLOUR)m\]$(__ps1_git $? 2>/dev/null)\[\033[0m\]\[\033[$(__ps1_colour_escape $P4_COLOUR)m\]$(__ps1_p4 $? 2>/dev/null)\[\033[0m\]\[\033[$(__ps1_colour_escape $SVN_COLOUR)m\]$(__ps1_svn $? 2>/dev/null)\[\033[0m\]$(__ps1_ret $? 2>/dev/null):\w\$ '
77   return 0
78 }
79
80 # iTerm doesn't like it if you set bold and colour at the same time.
81 function __ps1_colour_escape() {
82   local bold="${1%%;*}"
83   local colour="${1#*;}"
84
85   echo -en "${bold}m\033[$colour"
86 }
87
88 function __ps1_col() {
89   [ $1 -gt 0 ] && __ps1_colour_escape "$PROMPT_FAILED_COLOUR" || __ps1_colour_escape "$PROMPT_OK_COLOUR"
90   return $1
91 }
92
93 function __ps1_ret() {
94   [ "$__ps1_user" = "1" ] || return $1
95   [ $1 -gt 0 ] && echo -n " ($1)"
96   return $1
97 }
98
99 function __ps1_user() {
100   local ret=$1; shift
101   [ "$__ps1_user" = "1" ] || return $ret
102   echo -n ${1+"$@"}
103   return $ret
104 }
105
106 function __ps1_git() {
107   [ "$__ps1_git" = "1" ] || return $1
108   if [ "$__ps1_user" = "1" ]; then
109     __git_ps1 ' %s'
110   else
111     __git_ps1 '%s'
112   fi
113   return $1
114 }
115
116 function __ps1_p4() {
117   [ "$__ps1_p4" = "1" ] || return $1
118   if [ "$__ps1_user" = "1" -o "$__ps1_git" = "1" ]; then
119     __p4_ps1 ' %s'
120   else
121     __p4_ps1 '%s'
122   fi
123   return $1
124 }
125
126 function __ps1_svn() {
127   [ "$__ps1_svn" = "1" ] || return $1
128   if [ "$__ps1_user" = "1" -o "$__ps1_git" = "1" -o "$__ps1_p4" = "1" ]; then
129     __svn_ps1 ' %s'
130   else
131     __svn_ps1 '%s'
132   fi
133   return $1
134 }
135
136 function prompt() {
137   local blurb="Usage: prompt hide|show <what>"
138
139   if [ $# -lt 2 ]; then
140     echo >&2 "$blurb"
141     return 1
142   fi
143
144   action="$1"
145   if [ ! "$action" = "hide" -a ! "$action" = "show" ]; then
146     echo >&2 "$blurb"
147     return 1
148   fi
149   if [ "$action" = "hide" ]; then
150     action=0
151   else
152     action=1
153   fi
154
155   what="$(echo $2 | env LANG= LC_ALL= LC_CTYPE= tr '[:upper:]' '[:lower:]')"
156   eval __ps1_$what=$action
157 }