vi-mode.plugin.zsh 4.53 KB
Newer Older
1
2
3
4
5
6
# Control whether to force a redraw on each mode change.
#
# Resetting the prompt on every mode change can cause lag when switching modes.
# This is especially true if the prompt does things like checking git status.
#
# Set to "true" to force the prompt to reset on each mode change.
7
# Unset or set to any other value to do the opposite.
8
#
9
# The default is not to reset, unless we're showing the mode in RPS1.
10
typeset -g VI_MODE_RESET_PROMPT_ON_MODE_CHANGE
11
12
13
14
15
16
# Control whether to change the cursor style on mode change.
#
# Set to "true" to change the cursor on each mode change.
# Unset or set to any other value to do the opposite.
typeset -g VI_MODE_SET_CURSOR

17
18
19
typeset -g VI_KEYMAP=main

function _vi-mode-set-cursor-shape-for-keymap() {
20
21
  [[ "$VI_MODE_SET_CURSOR" = true ]] || return

22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
  # https://vt100.net/docs/vt510-rm/DECSCUSR
  local _shape=0
  case "${1:-${VI_KEYMAP:-main}}" in
    main)    _shape=6 ;; # vi insert: line
    viins)   _shape=6 ;; # vi insert: line
    isearch) _shape=6 ;; # inc search: line
    command) _shape=6 ;; # read a command name
    vicmd)   _shape=2 ;; # vi cmd: block
    visual)  _shape=2 ;; # vi visual mode: block
    viopp)   _shape=0 ;; # vi operation pending: blinking block
    *)       _shape=0 ;;
  esac
  printf $'\e[%d q' "${_shape}"
}

37
38
# Updates editor information when the keymap changes.
function zle-keymap-select() {
39
  # update keymap variable for the prompt
40
  typeset -g VI_KEYMAP=$KEYMAP
41

42
  if [[ "${VI_MODE_RESET_PROMPT_ON_MODE_CHANGE:-}" = true ]]; then
43
44
45
46
    zle reset-prompt
    zle -R
  fi
  _vi-mode-set-cursor-shape-for-keymap "${VI_KEYMAP}"
47
48
}
zle -N zle-keymap-select
49

50
51
52
# These "echoti" statements were originally set in lib/key-bindings.zsh
# Not sure the best way to extend without overriding.
function zle-line-init() {
53
54
  local prev_vi_keymap
  prev_vi_keymap="${VI_KEYMAP:-}"
55
  typeset -g VI_KEYMAP=main
56
  [[ "$prev_vi_keymap" != 'main' ]] && [[ "${VI_MODE_RESET_PROMPT_ON_MODE_CHANGE:-}" = true ]] && zle reset-prompt
57
58
  (( ! ${+terminfo[smkx]} )) || echoti smkx
  _vi-mode-set-cursor-shape-for-keymap "${VI_KEYMAP}"
59
}
60
zle -N zle-line-init
61

62
function zle-line-finish() {
63
  typeset -g VI_KEYMAP=main
64
65
66
67
  (( ! ${+terminfo[rmkx]} )) || echoti rmkx
  _vi-mode-set-cursor-shape-for-keymap default
}
zle -N zle-line-finish
68
69
70

bindkey -v

71
72
73
74
75
# allow vv to edit the command line (standard behaviour)
autoload -Uz edit-command-line
zle -N edit-command-line
bindkey -M vicmd 'vv' edit-command-line

76
77
78
79
# allow ctrl-p, ctrl-n for navigate history (standard behaviour)
bindkey '^P' up-history
bindkey '^N' down-history

80
81
82
83
84
# allow ctrl-h, ctrl-w, ctrl-? for char and word deletion (standard behaviour)
bindkey '^?' backward-delete-char
bindkey '^h' backward-delete-char
bindkey '^w' backward-kill-word

85
# allow ctrl-r and ctrl-s to search the history
86
bindkey '^r' history-incremental-search-backward
87
bindkey '^s' history-incremental-search-forward
88
89
90
91
92

# allow ctrl-a and ctrl-e to move to beginning/end of line
bindkey '^a' beginning-of-line
bindkey '^e' end-of-line

93
94
95
96
97
98
99
100
101
102
103
104
105
106
function wrap_clipboard_widgets() {
  # NB: Assume we are the first wrapper and that we only wrap native widgets
  # See zsh-autosuggestions.zsh for a more generic and more robust wrapper
  local verb="$1"
  shift

  local widget
  local wrapped_name
  for widget in "$@"; do
    wrapped_name="_zsh-vi-${verb}-${widget}"
    if [ "${verb}" = copy ]; then
      eval "
        function ${wrapped_name}() {
          zle .${widget}
107
          printf %s \"\${CUTBUFFER}\" | clipcopy 2>/dev/null || true
108
109
110
111
112
        }
      "
    else
      eval "
        function ${wrapped_name}() {
113
          CUTBUFFER=\"\$(clippaste 2>/dev/null || echo \$CUTBUFFER)\"
114
115
116
117
118
119
          zle .${widget}
        }
      "
    fi
    zle -N "${widget}" "${wrapped_name}"
  done
120
121
}

122
123
124
125
wrap_clipboard_widgets copy vi-yank vi-yank-eol vi-backward-kill-word vi-change-whole-line vi-delete
wrap_clipboard_widgets paste vi-put-{before,after}
unfunction wrap_clipboard_widgets

126
# if mode indicator wasn't setup by theme, define default
127
if [[ -z "$MODE_INDICATOR" ]]; then
128
  MODE_INDICATOR='%B%F{red}<%b<<%f'
129
130
131
fi

function vi_mode_prompt_info() {
132
133
134
135
136
137
138
  # If we're using the prompt to display mode info, and we haven't explicitly
  # disabled "reset prompt on mode change", then set it here.
  #
  # We do that here instead of the `if` statement below because the user may
  # set RPS1/RPROMPT to something else in their custom config.
  : "${VI_MODE_RESET_PROMPT_ON_MODE_CHANGE:=true}"

139
  echo "${${VI_KEYMAP/vicmd/$MODE_INDICATOR}/(main|viins)/}"
140
141
142
}

# define right prompt, if it wasn't defined by a theme
143
if [[ -z "$RPS1" && -z "$RPROMPT" ]]; then
144
145
  RPS1='$(vi_mode_prompt_info)'
fi