Merge pull request #119 from thalesmello/bugfix/merge-fix-upstream

Support Tmux 2.4 mappings

Author: bruno-

.travis.yml

@@ -1,14 +1,24 @@
 # generic packages
 before_install:
   - sudo apt-get update
-  - sudo apt-get install -y git-core expect
+  - sudo apt-get install -y git-core expect gawk
   - sudo apt-get install -y python-software-properties software-properties-common
 
-# install latest Tmux 1.9a
+# install Tmux 2.5
 install:
-  - sudo add-apt-repository -y ppa:pi-rho/dev
-  - sudo apt-get update
-  - sudo apt-get install -y tmux=1.9a-1~ppa1~p
+  - VERSION=2.5
+  - sudo apt-get -y remove tmux
+  - sudo apt-get -y install wget tar libevent-dev libncurses-dev make
+  - wget https://github.com/tmux/tmux/releases/download/${VERSION}/tmux-${VERSION}.tar.gz
+  - tar xf tmux-${VERSION}.tar.gz
+  - rm -f tmux-${VERSION}.tar.gz
+  - cd tmux-${VERSION}
+  - ./configure
+  - make
+  - sudo make install
+  - cd -
+  - sudo rm -rf /usr/local/src/tmux-*
+  - sudo mv tmux-${VERSION} /usr/local/src
 
 # override PS1 and irb prompt, fetch a git repo used for testing
 before_script:

README.md

@@ -2,9 +2,6 @@
 
 [![Build Status](https://travis-ci.org/tmux-plugins/tmux-copycat.png?branch=master)](https://travis-ci.org/tmux-plugins/tmux-copycat)
 
-**NOTE**: the changes in tmux 2.4 broke this plugin. I'm working on a fix. For
-now the plugin works on tmux 2.3.
-
 This plugin enables:
 
 - regex searches

Vagrantfile

@@ -1,15 +1,8 @@
 VAGRANTFILE_API_VERSION = '2'
 
 Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
-
-  config.vm.define :ubuntu do |ubuntu|
+  config.vm.define :ubuntu_two_five do |ubuntu|
     ubuntu.vm.box = 'hashicorp/precise32'
-    ubuntu.vm.provision 'shell', path: 'vagrant_ubuntu_provisioning.sh'
-  end
-
-  config.vm.define :centos do |centos|
-    centos.vm.box = 'chef/centos-6.5'
-    centos.vm.provision 'shell', path: 'vagrant_centos_provisioning.sh'
+    ubuntu.vm.provision 'shell', path: 'vagrant_ubuntu_provisioning_two_five.sh'
   end
-
 end

run-tests

@@ -59,8 +59,7 @@ run_tests_on_vm() {
 }
 
 main() {
-	run_tests_on_vm "ubuntu"
-	run_tests_on_vm "centos"
+	run_tests_on_vm "ubuntu_two_five"
 
 	exit_message "$EXIT_VALUE"
 	exit "$EXIT_VALUE"

scripts/copycat_jump.sh

@@ -114,28 +114,14 @@ _copycat_enter_mode() {
 
 # clears selection from a previous match
 _copycat_exit_select_mode() {
-	if [ "$TMUX_COPY_MODE" == "vi" ]; then
-		# vi mode
-		tmux send-keys Escape
-	else
-		# emacs mode
-		tmux send-keys C-g
-	fi
+	tmux send-keys -X clear-selection
 }
 
 # "manually" go up in the scrollback for a number of lines
 _copycat_manually_go_up() {
 	local line_number="$1"
-	if [ "$TMUX_COPY_MODE" == "vi" ]; then
-		# vi copy mode
-		tmux send-keys "$line_number" k 0
-	else
-		# emacs copy mode
-		for (( c=1; c<="$line_number"; c++ )); do
-			tmux send-keys C-p
-		done
-		tmux send-keys C-a
-	fi
+	tmux send-keys -X -N "$line_number" cursor-up
+	tmux send-keys -X start-of-line
 }
 
 _copycat_create_padding_below_result() {
@@ -156,32 +142,17 @@ _copycat_create_padding_below_result() {
 		return
 	fi
 
-	if [ "$TMUX_COPY_MODE" == "vi" ]; then
-		# vi copy mode
-		tmux send-keys "$padding" j "$padding" k
-	else
-		# emacs copy mode
-		for (( c=1; c<="$padding"; c++ )); do
-			tmux send-keys C-n
-		done
-		for (( c=1; c<="$padding"; c++ )); do
-			tmux send-keys C-p
-		done
-	fi
+	tmux send-keys -X -N "$padding" cursor-down
+	tmux send-keys -X -N "$padding" cursor-up
 }
 
 # performs a jump to go to line
 _copycat_go_to_line_with_jump() {
 	local line_number="$1"
 	# first jumps to the "bottom" in copy mode so that jumps are consistent
-	if [ "$TMUX_COPY_MODE" == "vi" ]; then
-		# vi copy mode
-		tmux send-keys G 0 :
-	else
-		# emacs copy mode
-		tmux send-keys "M->" C-a g
-	fi
-	tmux send-keys "$line_number" C-m
+	tmux send-keys -X history-bottom
+	tmux send-keys -X start-of-line
+	tmux send-keys -X goto-line $line_number
 }
 
 # maximum line number that can be reached via tmux 'jump'
@@ -234,32 +205,16 @@ _copycat_position_to_match_start() {
 	local match_line_position="$1"
 	[ "$match_line_position" -eq "0" ] && return 0
 
-	if [ "$TMUX_COPY_MODE" == "vi" ]; then
-		# vi copy mode
-		tmux send-keys "$match_line_position" l
-	else
-		# emacs copy mode
-		# emacs doesn't have repeat, so we're manually looping :(
-		for (( c=1; c<="$match_line_position"; c++ )); do
-			tmux send-keys C-f
-		done
-	fi
+	tmux send-keys -X -N "$match_line_position" cursor-right
 }
 
 _copycat_select() {
 	local match="$1"
 	local length="${#match}"
+	tmux send-keys -X begin-selection
+	tmux send-keys -X -N "$length" cursor-right
 	if [ "$TMUX_COPY_MODE" == "vi" ]; then
-		# vi copy mode
-		tmux send-keys Space "$length" l h # selection correction for 1 char
-	else
-		# emacs copy mode
-		tmux send-keys C-Space
-		# emacs doesn't have repeat, so we're manually looping :(
-		for (( c=1; c<="$length"; c++ )); do
-			tmux send-keys C-f
-		done
-		# NO selection correction for emacs mode
+		tmux send-keys -X cursor-left # selection correction for 1 char
 	fi
 }
 

scripts/copycat_mode_bindings.sh

@@ -3,20 +3,35 @@
 CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
 source "$CURRENT_DIR/helpers.sh"
+AWK_CMD='awk'
+if command_exists gawk; then
+	AWK_CMD='gawk'
+fi
 
 # Extends a keyboard key.
 # Benefits: tmux won't report errors and everything will work fine even if the
 # script is deleted.
 extend_key() {
 	local key="$1"
 	local script="$2"
+	local cmd
 
-	# 1. 'key' is sent to tmux. This ensures the default key action is done.
+	# 1. 'cmd' or 'key' is sent to tmux. This ensures the default key action is done.
 	# 2. Script is executed.
 	# 3. `true` command ensures an exit status 0 is returned. This ensures a
 	#	 user never gets an error msg - even if the script file from step 2 is
 	#	 deleted.
-	tmux bind-key -n "$key" run-shell "tmux send-keys '$key'; $script; true"
+	# We fetch the current behavior of the 'key' mapping in
+	# variable 'cmd'
+	cmd=$(tmux list-keys -T $(tmux_copy_mode_string) | $AWK_CMD '$4 == "'$key'"' | $AWK_CMD '{ $1=""; $2=""; $3=""; $4=""; sub("  ", " "); print }')
+	# If 'cmd' is already a copycat command, we do nothing
+	if echo "$cmd" | grep -q copycat; then
+		return
+	fi
+	# We save the previous mapping to a file in order to be able to recover
+	# the previous mapping when we unbind
+	tmux list-keys -T $(tmux_copy_mode_string) | $AWK_CMD '$4 == "'$key'"' >> /tmp/copycat_$(whoami)_recover_keys
+	tmux bind-key -T $(tmux_copy_mode_string) "$key" run-shell "tmux $cmd; $script; true"
 }
 
 copycat_cancel_bindings() {

scripts/copycat_mode_quit.sh

@@ -18,8 +18,10 @@ unbind_prev_next_bindings() {
 }
 
 unbind_all_bindings() {
-	unbind_cancel_bindings
-	unbind_prev_next_bindings
+	grep -v copycat </tmp/copycat_$(whoami)_recover_keys | while read key_cmd; do
+		tmux $key_cmd
+	done < /dev/stdin
+	rm /tmp/copycat_$(whoami)_recover_keys
 }
 
 main() {

scripts/helpers.sh

@@ -41,6 +41,14 @@ tmux_copy_mode() {
 	tmux show-option -gwv mode-keys
 }
 
+tmux_copy_mode_string() {
+    if [ $(tmux_copy_mode) == 'vi' ]; then
+	echo copy-mode-vi
+    else
+	echo copy-mode
+    fi
+}
+
 # === copycat mode specific helpers ===
 
 set_copycat_mode() {
@@ -150,11 +158,11 @@ copycat_prev_key() {
 
 # function expected output: 'C-c Enter q'
 copycat_quit_copy_mode_keys() {
-	local commands_that_quit_copy_mode="cancel\|copy-selection\|copy-pipe"
-	local copy_mode="$(tmux_copy_mode)-copy"
-	tmux list-keys -t "$copy_mode" |
+	local commands_that_quit_copy_mode="cancel"
+	local copy_mode="$(tmux_copy_mode_string)"
+	tmux list-keys -T "$copy_mode" |
 		\grep "$commands_that_quit_copy_mode" |
-		$AWK_CMD '{ print $4}' |
+		$AWK_CMD '{ print $4 }' |
 		sort -u |
 		sed 's/C-j//g' |
 		xargs echo

test/helpers/expect_copycat_helpers.exp

@@ -37,7 +37,7 @@ proc tmux_ctrl_t {} {
 
 proc search {text} {
   send "/"
-  sleep 0.2
+  sleep 0.5
   send "$text\r"
   sleep 0.7
 }