iterm2: Update shell integration to version 2

diff --git a/plugins/iterm2/iterm2.zshrc b/plugins/iterm2/iterm2.zshrc
index ffbc2aa02c008d9f7f974199280627c355da3f98..00414e376c5748d46ce23bceef8779bde53cadb5 100644 (file)
--- a/plugins/iterm2/iterm2.zshrc
+++ b/plugins/iterm2/iterm2.zshrc
@@ -3,13 +3,15 @@
 
 [[ "$TERM" != "screen" && "$TERM" != "screen-256color" ]] || return
 
+ITERM2_SHOULD_DECORATE_PROMPT="1"
+
 # Indicates start of command output. Runs just before command executes.
 iterm2_before_cmd_executes() {
-       printf "\033]133;C\007"
+       printf "\033]133;C;\007"
 }
 
 iterm2_set_user_var() {
-       printf "\033]1337;SetUserVar=%s=%s\007" "$1" $(printf "%s" "$2" | base64)
+       printf "\033]1337;SetUserVar=%s=%s\007" "$1" "$(printf "%s" "$2" | base64)"
 }
 
 # Users can write their own version of this method. It should call
@@ -17,8 +19,12 @@ iterm2_set_user_var() {
 # e.g., iterm2_set_user_var currentDirectory $PWD
 # Accessible in iTerm2 (in a badge now, elsewhere in the future) as
 # \(user.currentDirectory).
-iterm2_print_user_vars() {
-}
+whence -v iterm2_print_user_vars > /dev/null 2>&1
+if [[ $? -ne 0 ]]; then
+       iterm2_print_user_vars() {
+               :
+       }
+fi
 
 iterm2_print_state_data() {
        printf "\033]1337;RemoteHost=%s@%s\007" "$USER" "$iterm2_hostname"
@@ -28,7 +34,7 @@ iterm2_print_state_data() {
 
 # Report return code of command; runs after command finishes but before prompt
 iterm2_after_cmd_executes() {
-       printf "\033]133;D;$?\007"
+       printf "\033]133;D;%s\007" "$STATUS"
        iterm2_print_state_data
 }
 
@@ -42,30 +48,81 @@ iterm2_prompt_end() {
        printf "\033]133;B\007"
 }
 
+# There are three possible paths in life.
+#
+# 1) A command is entered at the prompt and you press return.
+#    The following steps happen:
+#    * iterm2_preexec is invoked
+#      * PS1 is set to ITERM2_PRECMD_PS1
+#      * ITERM2_SHOULD_DECORATE_PROMPT is set to 1
+#    * The command executes (possibly reading or modifying PS1)
+#    * iterm2_precmd is invoked
+#      * ITERM2_PRECMD_PS1 is set to PS1 (as modified by command execution)
+#      * PS1 gets our escape sequences added to it
+#    * zsh displays your prompt
+#    * You start entering a command
+#
+# 2) You press ^C while entering a command at the prompt.
+#    The following steps happen:
+#    * (iterm2_preexec is NOT invoked)
+#    * iterm2_precmd is invoked
+#      * iterm2_before_cmd_executes is called since we detected that iterm2_preexec was not run
+#      * (ITERM2_PRECMD_PS1 and PS1 are not messed with, since PS1 already has our escape
+#        sequences and ITERM2_PRECMD_PS1 already has PS1's original value)
+#    * zsh displays your prompt
+#    * You start entering a command
+#
+# 3) A new shell is born.
+#    * PS1 has some initial value, either zsh's default or a value set before this script is sourced.
+#    * iterm2_precmd is invoked
+#      * ITERM2_SHOULD_DECORATE_PROMPT is initialized to 1
+#      * ITERM2_PRECMD_PS1 is set to the initial value of PS1
+#      * PS1 gets our escape sequences added to it
+#    * Your prompt is shown and you may begin entering a command.
+#
+# Invariants:
+# * ITERM2_SHOULD_DECORATE_PROMPT is 1 during and just after command execution, and "" while the prompt is
+#   shown and until you enter a command and press return.
+# * PS1 does not have our escape sequences during command execution
+# * After the command executes but before a new one begins, PS1 has escape sequences and
+#   ITERM2_PRECMD_PS1 has PS1's original value.
+iterm2_decorate_prompt() {
+       # This should be a raw PS1 without iTerm2's stuff. It could be changed during command
+       # execution.
+       ITERM2_PRECMD_PS1="$PS1"
+       ITERM2_SHOULD_DECORATE_PROMPT=""
+
+       # Add our escape sequences just before the prompt is shown.
+       PS1="%{$(iterm2_prompt_start)%}$PS1%{$(iterm2_prompt_end)%}"
+}
+
 iterm2_precmd() {
-       iterm2_after_cmd_executes
+       local STATUS="$?"
+       if [ -z "$ITERM2_SHOULD_DECORATE_PROMPT" ]; then
+               # You pressed ^C while entering a command (iterm2_preexec did not run)
+               iterm2_before_cmd_executes
+       fi
 
-       # The user or another precmd may have changed PS1 (e.g., powerline-shell).
-       # Ensure that our escape sequences are added back in.
-       if [[ "$ITERM2_SAVED_PS1" != "$PS1" ]]; then
-               PS1="%{$(iterm2_prompt_start)%}$PS1%{$(iterm2_prompt_end)%}"
-               ITERM2_SAVED_PS1="$PS1"
+       iterm2_after_cmd_executes "$STATUS"
+
+       if [ -n "$ITERM2_SHOULD_DECORATE_PROMPT" ]; then
+               iterm2_decorate_prompt
        fi
 }
 
+# This is not run if you press ^C while entering a command.
 iterm2_preexec() {
-       PS1="$ITERM2_SAVED_PS1"
+       # Set PS1 back to its raw value prior to executing the command.
+       PS1="$ITERM2_PRECMD_PS1"
+       ITERM2_SHOULD_DECORATE_PROMPT="1"
        iterm2_before_cmd_executes
 }
 
 # If hostname -f is slow on your system, set iterm2_hostname prior to sourcing this script.
 [[ -z "$iterm2_hostname" ]] && iterm2_hostname=`hostname -f`
 
-[[ -z $precmd_functions ]] && precmd_functions=()
 precmd_functions+=(iterm2_precmd)
-
-[[ -z $preexec_functions ]] && preexec_functions=()
 preexec_functions+=(iterm2_preexec)
 
 iterm2_print_state_data
-printf "\033]1337;ShellIntegrationVersion=1\007"
+printf "\033]1337;ShellIntegrationVersion=2;shell=zsh\007"