Help wanted: CTRL-G CTRL-H keybinding conflicts with tmux

[wookayin]

Hello! Thanks for the great plugin.

I know this is more related to zsh or zsh keybinding rather than fzf-git per se, but I'm asking for help because many of the users may run into the same problem.

CTRL-G CTRL-H for commit Hashes do not work in my environment, because it conflicts with CTRL-H mappings:

❯❯❯ bindkey    # (excerpt)
"^G" fzm
"^G^H" fzf-git-hashes-widget
"^H" backward-delete-char

I pressed ^G^H within the KEYTIMEOUT limit (40 ms) but in this case the fzf-git widget does not appear. However, ^G H or other keys (e.g., ^G ^S) works fine. In a similar vein, ^G ^E seems conflicting with ^E (end-of-line) but ^G ^E works OK. Any idea why ^G ^H is not working for me?

This SuperUser thread seems relevant, but there is no working solution posted there (KEYTIMEOUT does not work).

zsh: zsh 5.9 (arm-apple-darwin21.3.0)

[wookayin]

Oops; I found that it is not the zsh-bindkey issue, tmux is eating the CTRL-H sequence (outside tmux it works OK). A similar case as #3.

# tmux.conf

is_vim='echo "#{pane_current_command}" | grep -iqE "(^|\/)g?(view|n?vim?)(diff)?$"'
bind -n C-h if-shell "$is_vim" "send-keys C-h" "select-pane -L"
bind -n C-j if-shell "$is_vim" "send-keys C-j" "select-pane -D"
bind -n C-k if-shell "$is_vim" "send-keys C-k" "select-pane -U"
bind -n C-l if-shell "$is_vim" "send-keys C-l" "send-keys C-l"

[wookayin]

One workaround here.

To map a sequence keymap in tmux, one could do the following (e.g. CTRL-G CTRL-H):

# tmux.conf
bind-key -n -T root        C-g switch-client -T ctrl_g_mode
bind-key    -T ctrl_g_mode C-h send-keys C-g C-h

However, its downside is that it will eat all the 'CTRL-g' as a prefix, so other commands like C-g C-b will not be passed through unless explicitly specified. One could either enumerate a complete list of all known keymaps:

bind-key -n -T root C-g switch-client -T ctrl_g_mode
bind-key -T ctrl_g_mode C-B send-keys C-g C-B
bind-key -T ctrl_g_mode C-E send-keys C-g C-E
bind-key -T ctrl_g_mode C-F send-keys C-g C-F
bind-key -T ctrl_g_mode C-H send-keys C-g C-H
bind-key -T ctrl_g_mode C-R send-keys C-g C-R 
bind-key -T ctrl_g_mode C-S send-keys C-g C-S
bind-key -T ctrl_g_mode C-T send-keys C-g C-T
bind-key -T ctrl_g_mode b send-keys C-g b 
bind-key -T ctrl_g_mode e send-keys C-g e
bind-key -T ctrl_g_mode f send-keys C-g f 
bind-key -T ctrl_g_mode h send-keys C-g h
bind-key -T ctrl_g_mode r send-keys C-g r
bind-key -T ctrl_g_mode s send-keys C-g s
bind-key -T ctrl_g_mode t send-keys C-g t       

or do some clever scripting as follows.

(1) in your zshrc, we export an environment variable so that TMUX can fetch all the zsh keybindings prefixed with ^g:

+# Export all the known keymaps with prefix CTRL-g so it can be mapped in tmux
+export FZF_GIT_BINDKEYS=$(bindkey -p '^g')

(2) in tmux.conf: Add a run-shell line

 # vim-tmux-navigator
 bind -n C-h if-shell "$is_vim" "send-keys C-h" "select-pane -L"  
 bind -n C-j if-shell "$is_vim" "send-keys C-j" "select-pane -D"
 bind -n C-k if-shell "$is_vim" "send-keys C-k" "select-pane -U"
 bind -n C-l if-shell "$is_vim" "send-keys C-l" "send-keys C-l"

+run-shell '~/.tmux/fzf-git-tmux.sh'

(3) ~/.tmux/fzf-git-tmux.sh:

#!/bin/zsh

# Define <CTRL-G ...> keymaps to make fzf-git-tmux work.
# see ~/.zshrc for export of $FZF_GIT_BINDKEYS

tmux bind-key -n -T root C-g send-keys C-g \; switch-client -T ctrl_g_mode

for i in $(echo $FZF_GIT_BINDKEYS); do
    if [[ "$i" =~ "\"\^G([^\"]+)" ]]; then
        local key=${match[1]/\^/C-}
        tmux bind-key -T ctrl_g_mode "$key" send-keys C-g "$key"
    fi
done

return 0;

What this script does is:

• Read all the bindkey prefixed with CTRL-g (bindkey -p ^g) from $FZF_GIT_BINDKEYS
• Parse each line (e.g., "^G^H" fzf-git-hashes-widget) to extract key character that follows ^G (e.g. ^H)
• Run tmux bind-key with a proper conversion, e.g. send-keys C-g C-H

The $FZF_GIT_BINDKEYS variable are read and processed only when tmux initializes (or reloads the config) from the "parent zsh shell", so tmux bindkeys can go out of sync when keymaps in zshrc change, but this should be practically of no problem if we don't change the setting frequently.

But one downside is CTRL-G is remapped everywhere, so any key other sequence that would follow CTRL-G will be eaten (e.g. if you have a keymappings with CTRL-G in vim)

[zachtheyek]

btw, for those that instead wish to modify the fzf-git.sh key bindings directly (rather than their tmux bindings):

1. look for __fzf_git_init() in the shell script (should be near the bottom)

### IF YOU'RE ON BASH:

if [[ -n "${BASH_VERSION:-}" ]]; then
  __fzf_git_init() {
    bind -m emacs-standard '"\er":  redraw-current-line'
    bind -m emacs-standard '"\C-z": vi-editing-mode'
    bind -m vi-command     '"\C-z": emacs-editing-mode'
    bind -m vi-insert      '"\C-z": emacs-editing-mode'

    local o c
    for o in "$@"; do
      c=${o:0:1}
      bind -m emacs-standard '"\C-g\C-'$c'": " \C-u \C-a\C-k`_fzf_git_'$o'`\e\C-e\C-y\C-a\C-y\ey\C-h\C-e\er \C-h"'
      bind -m vi-command     '"\C-g\C-'$c'": "\C-z\C-g\C-'$c'\C-z"'
      bind -m vi-insert      '"\C-g\C-'$c'": "\C-z\C-g\C-'$c'\C-z"'
      bind -m emacs-standard '"\C-g'$c'":    " \C-u \C-a\C-k`_fzf_git_'$o'`\e\C-e\C-y\C-a\C-y\ey\C-h\C-e\er \C-h"'
      bind -m vi-command     '"\C-g'$c'":    "\C-z\C-g'$c'\C-z"'
      bind -m vi-insert      '"\C-g'$c'":    "\C-z\C-g'$c'\C-z"'
    done
  }


### AND IF YOU'RE ON ZSH:

elif [[ -n "${ZSH_VERSION:-}" ]]; then
  __fzf_git_join() {
    local item
    while read item; do
      echo -n "${(q)item} "
    done
  }

  __fzf_git_init() {
    local m o
    for o in "$@"; do
      eval "fzf-git-$o-widget() { local result=\$(_fzf_git_$o | __fzf_git_join); zle reset-prompt; LBUFFER+=\$result }"
      eval "zle -N fzf-git-$o-widget"
      for m in emacs vicmd viins; do
        eval "bindkey -M $m '^g^${o[1]}' fzf-git-$o-widget"
        eval "bindkey -M $m '^x${o[1]}' fzf-git-$o-widget"
      done
    done
  }
fi

2. then, just look for where the bindings are defined (\C-g etc. on bash, ^g^${o[1]} on zsh), and change it to whatever u want.

   • for reference, i'm using zsh, so i changed my bindings from ctrl-g ctrl-[key] to ctrl-x [key] like so:

      for m in emacs vicmd viins; do
        # eval "bindkey -M $m '^g^${o[1]}' fzf-git-$o-widget"
        eval "bindkey -M $m '^x${o[1]}' fzf-git-$o-widget"
      done

haven't had any issues since. hope this helps!

@junegunn maybe this is worth noting in the README?