xt-mouse.el 6.97 KB
Newer Older
1
;;; xt-mouse.el --- support the mouse when emacs run in an xterm
Erik Naggum's avatar
Erik Naggum committed
2

3
;; Copyright (C) 1994, 2000, 2001, 2002, 2003,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2004, 2005, 2006, 2007 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5

Per Abrahamsen's avatar
Per Abrahamsen committed
6
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
Richard M. Stallman's avatar
Richard M. Stallman committed
7 8
;; Keywords: mouse, terminals

Erik Naggum's avatar
Erik Naggum committed
9 10 11
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
12 13 14
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
Erik Naggum's avatar
Erik Naggum committed
15 16

;; GNU Emacs is distributed in the hope that it will be useful,
Richard M. Stallman's avatar
Richard M. Stallman committed
17 18 19
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.
Erik Naggum's avatar
Erik Naggum committed
20

Richard M. Stallman's avatar
Richard M. Stallman committed
21
;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
22
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
25

Dave Love's avatar
Dave Love committed
26
;;; Commentary:
Richard M. Stallman's avatar
Richard M. Stallman committed
27

28
;; Enable mouse support when running inside an xterm.
Richard M. Stallman's avatar
Richard M. Stallman committed
29 30 31 32 33 34 35

;; This is actually useful when you are running X11 locally, but is
;; working on remote machine over a modem line or through a gateway.

;; It works by translating xterm escape codes into generic emacs mouse
;; events so it should work with any package that uses the mouse.

Richard M. Stallman's avatar
Richard M. Stallman committed
36 37 38 39
;; You don't have to turn off xterm mode to use the normal xterm mouse
;; functionality, it is still available by holding down the SHIFT key
;; when you press the mouse button.

Richard M. Stallman's avatar
Richard M. Stallman committed
40 41 42 43
;;; Todo:

;; Support multi-click -- somehow.

Dave Love's avatar
Dave Love committed
44
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
45

46 47
(defvar xterm-mouse-debug-buffer nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
48 49
(define-key function-key-map "\e[M" 'xterm-mouse-translate)

50 51
(defvar xterm-mouse-last)

52 53
;; Mouse events symbols must have an 'event-kind property with
;; the value 'mouse-click.
54 55
(dolist (event-type '(mouse-1 mouse-2 mouse-3
			      M-down-mouse-1 M-down-mouse-2 M-down-mouse-3))
56 57
  (put event-type 'event-kind 'mouse-click))

Richard M. Stallman's avatar
Richard M. Stallman committed
58
(defun xterm-mouse-translate (event)
Dave Love's avatar
Dave Love committed
59
  "Read a click and release event from XTerm."
Richard M. Stallman's avatar
Richard M. Stallman committed
60 61 62
  (save-excursion
    (save-window-excursion
      (deactivate-mark)
63
      (let* ((xterm-mouse-last)
64 65 66 67 68 69
	     (down (xterm-mouse-event))
	     (down-command (nth 0 down))
	     (down-data (nth 1 down))
	     (down-where (nth 1 down-data))
	     (down-binding (key-binding (if (symbolp down-where)
					    (vector down-where down-command)
70 71
					  (vector down-command))))
	     (is-click (string-match "^mouse" (symbol-name (car down)))))
72

73 74 75 76 77 78 79
	(unless is-click
	  (unless (and (eq (read-char) ?\e)
		       (eq (read-char) ?\[)
		       (eq (read-char) ?M))
	    (error "Unexpected escape sequence from XTerm")))

	(let* ((click (if is-click down (xterm-mouse-event)))
80 81 82 83 84
	       (click-command (nth 0 click))
	       (click-data (nth 1 click))
	       (click-where (nth 1 click-data)))
	  (if (memq down-binding '(nil ignore))
	      (if (and (symbolp click-where)
85
		       (consp click-where))
86 87 88 89 90 91 92 93 94 95 96
		  (vector (list click-where click-data) click)
		(vector click))
	    (setq unread-command-events
		  (if (eq down-where click-where)
		      (list click)
		    (list
		     ;; Cheat `mouse-drag-region' with move event.
		     (list 'mouse-movement click-data)
		     ;; Generate a drag event.
		     (if (symbolp down-where)
			 0
Dave Love's avatar
Dave Love committed
97 98
		       (list (intern (format "drag-mouse-%d"
					     (+ 1 xterm-mouse-last)))
99
			     down-data click-data)))))
100 101
	    (if xterm-mouse-debug-buffer
		(print unread-command-events xterm-mouse-debug-buffer))
102
	    (if (and (symbolp down-where)
103
		     (consp down-where))
104 105 106 107 108 109 110 111 112
		(vector (list down-where down-data) down)
	      (vector down))))))))

(defvar xterm-mouse-x 0
  "Position of last xterm mouse event relative to the frame.")

(defvar xterm-mouse-y 0
  "Position of last xterm mouse event relative to the frame.")

Nick Roberts's avatar
Nick Roberts committed
113 114
(defvar xt-mouse-epoch nil)

115 116
;; Indicator for the xterm-mouse mode.

Dave Love's avatar
Dave Love committed
117 118 119 120
(defun xterm-mouse-position-function (pos)
  "Bound to `mouse-position-function' in XTerm mouse mode."
  (setcdr pos (cons xterm-mouse-x xterm-mouse-y))
  pos)
Richard M. Stallman's avatar
Richard M. Stallman committed
121

122 123 124 125 126 127 128
;; read xterm sequences above ascii 127 (#x7f)
(defun xterm-mouse-event-read ()
  (let ((c (read-char)))
    (if (< c 0)
        (+ c #x8000000 128)
      c)))

Richard M. Stallman's avatar
Richard M. Stallman committed
129
(defun xterm-mouse-event ()
Dave Love's avatar
Dave Love committed
130
  "Convert XTerm mouse event to Emacs mouse event."
131 132 133
  (let* ((type (- (xterm-mouse-event-read) #o40))
	 (x (- (xterm-mouse-event-read) #o40 1))
	 (y (- (xterm-mouse-event-read) #o40 1))
Nick Roberts's avatar
Nick Roberts committed
134 135
	 ;; Emulate timestamp information.  This is accurate enough
	 ;; for default value of mouse-1-click-follows-link (450msec).
Nick Roberts's avatar
Nick Roberts committed
136 137 138 139 140
	 (timestamp (truncate
		     (* 1000
			(- (float-time)
			   (or xt-mouse-epoch
			       (setq xt-mouse-epoch (float-time)))))))
141
	 (mouse (intern
142 143 144 145 146 147
		 ;; For buttons > 3, the release-event looks
		 ;; differently (see xc/programs/xterm/button.c,
		 ;; function EditorButton), and there seems to come in
		 ;; a release-event only, no down-event.
		 (cond ((>= type 64)
			(format "mouse-%d" (- type 60)))
148 149 150 151 152
		       ((memq type '(8 9 10))
			(setq xterm-mouse-last type)
			(format "M-down-mouse-%d" (- type 7)))
		       ((= type 11)
			(format "mouse-%d" (- xterm-mouse-last 7)))
153 154 155 156
		       ((= type 3)
			(format "mouse-%d" (+ 1 xterm-mouse-last)))
		       (t
			(setq xterm-mouse-last type)
157
			(format "down-mouse-%d" (+ 1 type))))))
158 159 160 161 162
	 (w (window-at x y))
         (ltrb (window-edges w))
         (left (nth 0 ltrb))
         (top (nth 1 ltrb)))

163 164
    (setq xterm-mouse-x x
	  xterm-mouse-y y)
165 166
    (setq
     last-input-event
167
     (list mouse
168 169 170
	   (let ((event (if w
			    (posn-at-x-y (- x left) (- y top) w t)
			  (append (list nil 'menu-bar)
171
				  (nthcdr 2 (posn-at-x-y x y))))))
172 173
	     (setcar (nthcdr 3 event) timestamp)
	     event)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
174 175

;;;###autoload
176
(define-minor-mode xterm-mouse-mode
Richard M. Stallman's avatar
Richard M. Stallman committed
177 178 179
  "Toggle XTerm mouse mode.
With prefix arg, turn XTerm mouse mode on iff arg is positive.

180
Turn it on to use Emacs mouse commands, and off to use xterm mouse commands.
181 182 183 184 185 186
This works in terminal emulators compatible with xterm.  It only
works for simple uses of the mouse.  Basically, only non-modified
single clicks are supported.  When turned on, the normal xterm
mouse functionality for such clicks is still available by holding
down the SHIFT key while pressing the mouse button."
  :global t :group 'mouse
187 188 189 190 191 192 193 194
  (if xterm-mouse-mode
      ;; Turn it on
      (unless window-system
	(setq mouse-position-function #'xterm-mouse-position-function)
	(turn-on-xterm-mouse-tracking))
    ;; Turn it off
    (turn-off-xterm-mouse-tracking 'force)
    (setq mouse-position-function nil)))
Richard M. Stallman's avatar
Richard M. Stallman committed
195 196

(defun turn-on-xterm-mouse-tracking ()
Dave Love's avatar
Dave Love committed
197
  "Enable Emacs mouse tracking in xterm."
Richard M. Stallman's avatar
Richard M. Stallman committed
198 199 200
  (if xterm-mouse-mode
      (send-string-to-terminal "\e[?1000h")))

201
(defun turn-off-xterm-mouse-tracking (&optional force)
202
  "Disable Emacs mouse tracking in xterm."
203
  (if (or force xterm-mouse-mode)
Richard M. Stallman's avatar
Richard M. Stallman committed
204 205 206 207 208 209 210 211 212
      (send-string-to-terminal "\e[?1000l")))

;; Restore normal mouse behaviour outside Emacs.
(add-hook 'suspend-hook 'turn-off-xterm-mouse-tracking)
(add-hook 'suspend-resume-hook 'turn-on-xterm-mouse-tracking)
(add-hook 'kill-emacs-hook 'turn-off-xterm-mouse-tracking)

(provide 'xt-mouse)

Miles Bader's avatar
Miles Bader committed
213
;;; arch-tag: 84962d4e-fae9-4c13-a9d7-ef4925a4ac03
Richard M. Stallman's avatar
Richard M. Stallman committed
214
;;; xt-mouse.el ends here