Merge pull request #20 from ldidry/master

Liquidprompt for bash AND zsh

README.md

@@ -1,7 +1,8 @@
 Liquid prompt -- A useful adaptive Bash prompt
 ==============================================
 
-Liquid prompt is a smart prompt for the "Bourne-Again" Unix shell (bash).
+Liquid prompt is a smart prompt for the "Bourne-Again" Unix shell (bash) and for
+Zsh.
 
 The basic idea of the liquid prompt is to nicely display useful informations on
 the shell prompt, only when they are needed. It adds carefuly chosen colors to
@@ -9,6 +10,7 @@ draw your attention on what differs from the normal context. Thus, you will
 notice what changes, when it changes, because you do not become accommodated to
 informations that are always displayed in the same way.
 
+You can use it with either bash and zsh.
 
 ## FEATURES
 
@@ -65,7 +67,7 @@ any prompt and use a single mark sign (`$ ` for user and `# ` for root) with the
 
 Include the file in your bash configuration, for example in your `.bashrc`:
 
-`source liquidprompt.bash`
+`source liquidprompt`
 
 Copy the `liquidpromptrc-dist` file in your home directory as
 `~/.config/liquidpromptrc` or `~/.liquidpromptrc` and edit it according to your

liquidprompt

@@ -1,8 +1,7 @@
-#!/bin/bash
 
 ################################################################################
 # LIQUID PROMPT
-# An intelligent and non intrusive prompt for bash
+# An intelligent and non intrusive prompt for bash and zsh
 ################################################################################
 
 
@@ -33,11 +32,14 @@
 # François Schmidts <fschmidts@olfeo.com>       # Simpler SSH_IP acquiring method.
 # Thomas Debesse <thomas.debesse@gmail.com>     # Fix columns use.
 # Florian Le Frioux <florian@lefrioux.fr>       # Use ± mark when root in VCS dir.
+# Luc Didry <luc@fiat-tux.fr>                   # Zsh port
 
 
 # See the README.md file for a summary of features.
 
+WORKING_SHELL=$(ps -p $$ | tail -n1 | awk '{print $NF}')
 
+if [[ "$WORKING_SHELL" == "bash" ]]; then
     # Check for recent enough version of bash.
     [[ -z "$BASH_VERSION" || -z "$PS1" || -z "$TERM" ]] && return;
 
@@ -48,6 +50,17 @@ if [[ $bmajor -lt 3 ]] || [[ $bmajor -eq 3 && $bminor -lt 2 ]]; then
     fi
     unset bash bmajor bminor
 
+     OPENESCAPE="\["
+    CLOSEESCAPE="\]"
+     USERSYMBOL="\u"
+     HOSTSYMBOL="\h"
+elif [[ "$WORKING_SHELL" == "zsh" ]]; then
+     OPENESCAPE="%{"
+    CLOSEESCAPE="%}"
+     USERSYMBOL="%n"
+     HOSTSYMBOL="%m"
+fi
+
 
 #################
 # CONFIGURATION #
@@ -96,61 +109,61 @@ esac
 # Colors declarations
 if [[ "$OS" == "FreeBSD" ]] ; then
 
-    BLACK="\[$(tput AF 0)\]"
+    BLACK="${OPENESCAPE}$(tput AF 0)${CLOSEESCAPE}"
-    BOLD_GRAY="\[$(tput md ; tput AF 0)\]"
+    BOLD_GRAY="${OPENESCAPE}$(tput md ; tput AF 0)${CLOSEESCAPE}"
-    WHITE="\[$(tput AF 7)\]"
+    WHITE="${OPENESCAPE}$(tput AF 7)${CLOSEESCAPE}"
-    BOLD_WHITE="\[$(tput md ; tput AF 7)\]"
+    BOLD_WHITE="${OPENESCAPE}$(tput md ; tput AF 7)${CLOSEESCAPE}"
 
-    RED="\[$(tput AF 1)\]"
+    RED="${OPENESCAPE}$(tput AF 1)${CLOSEESCAPE}"
-    BOLD_RED="\[$(tput md ; tput AF 1)\]"
+    BOLD_RED="${OPENESCAPE}$(tput md ; tput AF 1)${CLOSEESCAPE}"
-    WARN_RED="\[$(tput AF 0 ; tput setab 1)\]"
+    WARN_RED="${OPENESCAPE}$(tput AF 0 ; tput setab 1)${CLOSEESCAPE}"
-    CRIT_RED="\[$(tput md; tput AF 7 ; tput setab 1)\]"
+    CRIT_RED="${OPENESCAPE}$(tput md; tput AF 7 ; tput setab 1)${CLOSEESCAPE}"
 
-    GREEN="\[$(tput AF 2)\]"
+    GREEN="${OPENESCAPE}$(tput AF 2)${CLOSEESCAPE}"
-    BOLD_GREEN="\[$(tput md ; tput AF 2)\]"
+    BOLD_GREEN="${OPENESCAPE}$(tput md ; tput AF 2)${CLOSEESCAPE}"
 
-    YELLOW="\[$(tput AF 3)\]"
+    YELLOW="${OPENESCAPE}$(tput AF 3)${CLOSEESCAPE}"
-    BOLD_YELLOW="\[$(tput md ; tput AF 3)\]"
+    BOLD_YELLOW="${OPENESCAPE}$(tput md ; tput AF 3)${CLOSEESCAPE}"
 
-    BLUE="\[$(tput AF 4)\]"
+    BLUE="${OPENESCAPE}$(tput AF 4)${CLOSEESCAPE}"
-    BOLD_BLUE="\[$(tput md ; tput AF 4)\]"
+    BOLD_BLUE="${OPENESCAPE}$(tput md ; tput AF 4)${CLOSEESCAPE}"
 
-    PURPLE="\[$(tput AF 5)\]"
+    PURPLE="${OPENESCAPE}$(tput AF 5)${CLOSEESCAPE}"
-    PINK="\[$(tput md ; tput AF 5)\]"
+    PINK="${OPENESCAPE}$(tput md ; tput AF 5)${CLOSEESCAPE}"
 
-    CYAN="\[$(tput AF 6)\]"
+    CYAN="${OPENESCAPE}$(tput AF 6)${CLOSEESCAPE}"
-    BOLD_CYAN="\[$(tput md ; tput AF 6)\]"
+    BOLD_CYAN="${OPENESCAPE}$(tput md ; tput AF 6)${CLOSEESCAPE}"
 
-    NO_COL="\[$(tput me)\]"
+    NO_COL="${OPENESCAPE}$(tput me)${CLOSEESCAPE}"
 
 else
     # default to Linux
-    BLACK="\[$(tput setaf 0)\]"
+    BLACK="${OPENESCAPE}$(tput setaf 0)${CLOSEESCAPE}"
-    BOLD_GRAY="\[$(tput bold ; tput setaf 0)\]"
+    BOLD_GRAY="${OPENESCAPE}$(tput bold ; tput setaf 0)${CLOSEESCAPE}"
-    WHITE="\[$(tput setaf 7)\]"
+    WHITE="${OPENESCAPE}$(tput setaf 7)${CLOSEESCAPE}"
-    BOLD_WHITE="\[$(tput bold ; tput setaf 7)\]"
+    BOLD_WHITE="${OPENESCAPE}$(tput bold ; tput setaf 7)${CLOSEESCAPE}"
 
-    RED="\[$(tput setaf 1)\]"
+    RED="${OPENESCAPE}$(tput setaf 1)${CLOSEESCAPE}"
-    BOLD_RED="\[$(tput bold ; tput setaf 1)\]"
+    BOLD_RED="${OPENESCAPE}$(tput bold ; tput setaf 1)${CLOSEESCAPE}"
-    WARN_RED="\[$(tput setaf 0 ; tput setab 1)\]"
+    WARN_RED="${OPENESCAPE}$(tput setaf 0 ; tput setab 1)${CLOSEESCAPE}"
-    CRIT_RED="\[$(tput bold; tput setaf 7 ; tput setab 1)\]"
+    CRIT_RED="${OPENESCAPE}$(tput bold; tput setaf 7 ; tput setab 1)${CLOSEESCAPE}"
 
-    GREEN="\[$(tput setaf 2)\]"
+    GREEN="${OPENESCAPE}$(tput setaf 2)${CLOSEESCAPE}"
-    BOLD_GREEN="\[$(tput bold ; tput setaf 2)\]"
+    BOLD_GREEN="${OPENESCAPE}$(tput bold ; tput setaf 2)${CLOSEESCAPE}"
 
-    YELLOW="\[$(tput setaf 3)\]"
+    YELLOW="${OPENESCAPE}$(tput setaf 3)${CLOSEESCAPE}"
-    BOLD_YELLOW="\[$(tput bold ; tput setaf 3)\]"
+    BOLD_YELLOW="${OPENESCAPE}$(tput bold ; tput setaf 3)${CLOSEESCAPE}"
 
-    BLUE="\[$(tput setaf 4)\]"
+    BLUE="${OPENESCAPE}$(tput setaf 4)${CLOSEESCAPE}"
-    BOLD_BLUE="\[$(tput bold ; tput setaf 4)\]"
+    BOLD_BLUE="${OPENESCAPE}$(tput bold ; tput setaf 4)${CLOSEESCAPE}"
 
-    PURPLE="\[$(tput setaf 5)\]"
+    PURPLE="${OPENESCAPE}$(tput setaf 5)${CLOSEESCAPE}"
-    PINK="\[$(tput bold ; tput setaf 5)\]"
+    PINK="${OPENESCAPE}$(tput bold ; tput setaf 5)${CLOSEESCAPE}"
 
-    CYAN="\[$(tput setaf 6)\]"
+    CYAN="${OPENESCAPE}$(tput setaf 6)${CLOSEESCAPE}"
-    BOLD_CYAN="\[$(tput bold ; tput setaf 6)\]"
+    BOLD_CYAN="${OPENESCAPE}$(tput bold ; tput setaf 6)${CLOSEESCAPE}"
 
-    NO_COL="\[$(tput sgr0)\]"
+    NO_COL="${OPENESCAPE}$(tput sgr0)${CLOSEESCAPE}"
 
 fi
 
@@ -167,7 +180,7 @@ fi
 # get cpu number
 __cpunum_Linux()
 {
-    grep -c ^[Pp]rocessor /proc/cpuinfo
+    grep -c '^[Pp]rocessor' /proc/cpuinfo
 }
 
 __cpunum_FreeBSD()
@@ -225,12 +238,12 @@ __user()
     if [[ "$EUID" -ne "0" ]] ; then
         # if user is not login user
         if [[ ${USER} != "$(logname 2>/dev/null)" ]]; then
-            user="${FG}\u${NO_COL}"
+            user="${FG}${USERSYMBOL}${NO_COL}"
         else
-            user="\u"
+            user="${USERSYMBOL}"
         fi
     else
-        user="${BOLD_YELLOW}\u${NO_COL}"
+        user="${BOLD_YELLOW}${USERSYMBOL}${NO_COL}"
     fi
 
     echo -ne $user
@@ -249,11 +262,11 @@ __connection()
     # Are we in an SSH connexion?
     SSH_FLAG=0
     SSH_IP=${SSH_CLIENT%% *}
-    if [[ $SSH_IP ]] ; then
+    if [[ ! -z $SSH_IP ]] ; then
       SSH_FLAG=1
     fi
     SSH2_IP=$(echo $SSH2_CLIENT | awk '{ print $1 }')
-    if [[ $SSH2_IP ]] ; then
+    if [[ ! -z $SSH2_IP ]] ; then
       SSH_FLAG=1
     fi
 
@@ -282,14 +295,14 @@ __host_color()
         if [[ $LP_HOSTNAME_ALWAYS == 0 ]] ; then
             ret="${ret}" # no hostname if local
         else
-            ret="${ret}@\h"
+            ret="${ret}@${HOSTSYMBOL}"
         fi
     elif [[ "$conn" == "ssh" ]] ; then
-        ret="${ret}@${BOLD_CYAN}\h"
+        ret="${ret}@${BOLD_CYAN}${HOSTSYMBOL}"
     elif [[ "$conn" == "tel" ]] ; then
-        ret="${ret}@${WARN_RED}\h"
+        ret="${ret}@${WARN_RED}${HOSTSYMBOL}"
     else
-        ret="${ret}@\h"
+        ret="${ret}@${HOSTSYMBOL}"
     fi
 
     echo -ne "${ret}${NO_COL}"
@@ -303,7 +316,7 @@ __proxy()
     fi
 }
 
-# BASH function that shortens
+# BASH/ZSH function that shortens
 # a very long path for display by removing
 # the left most parts and replacing them
 # with a leading ...
@@ -319,20 +332,24 @@ __shorten_path()
 {
     # the character that will replace the part of the path that is masked
     local mask=" … "
-    # index of the directory to keep from the root (starts at 0)
+    # index of the directory to keep from the root (starts at 0 whith bash, 1 with zsh)
     local keep=$((LP_PATH_KEEP-1))
+    if [[ "$WORKING_SHELL" == "zsh" ]]; then
+       keep=$LP_PATH_KEEP
+    fi
 
     local len_percent=$2
 
-    local p=$(echo "$1" | sed -e "s|$HOME|~|")
     local len="${#p}"
 
     local max_len=$((${COLUMNS:-80}*$len_percent/100))
     local mask_len="${#mask}"
     local slashes=0
 
+    if [[ "$WORKING_SHELL" == "bash" ]]; then
         if [[ "$len" -gt "$max_len" ]]
         then
+            local p=$(echo "$1" | sed -e "s|$HOME|~|")
             # finds all the '/' in
             # the path and stores their
             # positions
@@ -390,6 +407,9 @@ __shorten_path()
         else
             echo "$p"
         fi
+    elif [[ "$WORKING_SHELL" == "zsh" ]]; then
+        echo "%-${keep}~%${max_len}<${mask}<%~%<<"
+    fi
 }
 
 # Display a ":"
@@ -634,7 +654,10 @@ __battery_color()
             ret="${ret}${CRIT_RED}"
         fi
 
+        if [[ "$WORKING_SHELL" == "bash" ]]; then
             echo -ne "${ret}${bat}%${NO_COL}"
+        elif [[ "$WORKING_SHELL" == "zsh" ]]; then
+            echo -ne "${ret}${bat}%%${NO_COL}"
         fi
 }
 
@@ -695,7 +718,10 @@ __smart_mark()
         COL=${BOLD_RED}
     fi
 
-    local mark="\\\$"
+    local mark="\$"
+    if [[ "$WORKING_SHELL" == "zsh" ]]; then
+        mark="%(!.#.$)"
+    fi
     if   [[ ! -z $(__git_branch) ]] ; then
         mark="±"
     elif [[ ! -z $(__hg_branch)  ]]  ; then
@@ -799,9 +825,19 @@ prompt_on()
     # if liquidprompt has not been already set
     if [[ -z "$LP_LIQUIDPROMPT" ]] ; then
         LP_OLD_PS1="$PS1"
+        if [[ "$WORKING_SHELL" == "bash" ]]; then
             LP_OLD_PROMPT_COMMAND="$PROMPT_COMMAND"
+        elif [[ "$WORKING_SHELL" == "zsh" ]]; then
+            LP_OLD_PROMPT_COMMAND="$precmd"
         fi
+    fi
+    if [[ "$WORKING_SHELL" == "bash" ]]; then
         PROMPT_COMMAND=__set_bash_prompt
+    elif [[ "$WORKING_SHELL" == "zsh" ]]; then
+        function precmd {
+            __set_bash_prompt
+        }
+    fi
 
     # Keep in mind that LP has been sourced
     # (to avoid recursive prompt command).
@@ -812,14 +848,22 @@ prompt_on()
 prompt_off()
 {
     PS1=$LP_OLD_PS1
+    if [[ "$WORKING_SHELL" == "bash" ]]; then
         PROMPT_COMMAND=$LP_OLD_PROMPT_COMMAND
+    elif [[ "$WORKING_SHELL" == "zsh" ]]; then
+        precmd=$LP_OLD_PROMPT_COMMAND
+    fi
 }
 
 # Use an empty prompt: just the \$ mark
 prompt_OFF()
 {
     PS1="\$ "
+    if [[ "$WORKING_SHELL" == "bash" ]]; then
         PROMPT_COMMAND=$LP_OLD_PROMPT_COMMAND
+    elif [[ "$WORKING_SHELL" == "zsh" ]]; then
+        precmd=$LP_OLD_PROMPT_COMMAND
+    fi
 }
 
 # By default, sourcing liquidprompt.bash will activate the liquid prompt