* lisp/vc/vc-svn.el (vc-svn-diff): Use `diff-command' instead of the
[emacs.git] / lisp / xt-mouse.el
blob66542578d769d3ac24a41c0e4ce113b88b7c00c9
1 ;;; xt-mouse.el --- support the mouse when emacs run in an xterm
3 ;; Copyright (C) 1994, 2000-2011 Free Software Foundation, Inc.
5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
6 ;; Keywords: mouse, terminals
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Enable mouse support when running inside an xterm.
27 ;; This is actually useful when you are running X11 locally, but is
28 ;; working on remote machine over a modem line or through a gateway.
30 ;; It works by translating xterm escape codes into generic emacs mouse
31 ;; events so it should work with any package that uses the mouse.
33 ;; You don't have to turn off xterm mode to use the normal xterm mouse
34 ;; functionality, it is still available by holding down the SHIFT key
35 ;; when you press the mouse button.
37 ;;; Todo:
39 ;; Support multi-click -- somehow.
41 ;;; Code:
43 (defvar xterm-mouse-debug-buffer nil)
45 (defvar xterm-mouse-last)
47 ;; Mouse events symbols must have an 'event-kind property with
48 ;; the value 'mouse-click.
49 (dolist (event-type '(mouse-1 mouse-2 mouse-3
50 M-down-mouse-1 M-down-mouse-2 M-down-mouse-3))
51 (put event-type 'event-kind 'mouse-click))
53 (defun xterm-mouse-translate (event)
54 "Read a click and release event from XTerm."
55 (save-excursion
56 (save-window-excursion
57 (deactivate-mark)
58 (let* ((xterm-mouse-last)
59 (down (xterm-mouse-event))
60 (down-command (nth 0 down))
61 (down-data (nth 1 down))
62 (down-where (nth 1 down-data))
63 (down-binding (key-binding (if (symbolp down-where)
64 (vector down-where down-command)
65 (vector down-command))))
66 (is-click (string-match "^mouse" (symbol-name (car down)))))
68 (unless is-click
69 (unless (and (eq (read-char) ?\e)
70 (eq (read-char) ?\[)
71 (eq (read-char) ?M))
72 (error "Unexpected escape sequence from XTerm")))
74 (let* ((click (if is-click down (xterm-mouse-event)))
75 ;; (click-command (nth 0 click))
76 (click-data (nth 1 click))
77 (click-where (nth 1 click-data)))
78 (if (memq down-binding '(nil ignore))
79 (if (and (symbolp click-where)
80 (consp click-where))
81 (vector (list click-where click-data) click)
82 (vector click))
83 (setq unread-command-events
84 (if (eq down-where click-where)
85 (list click)
86 (list
87 ;; Cheat `mouse-drag-region' with move event.
88 (list 'mouse-movement click-data)
89 ;; Generate a drag event.
90 (if (symbolp down-where)
92 (list (intern (format "drag-mouse-%d"
93 (+ 1 xterm-mouse-last)))
94 down-data click-data)))))
95 (if xterm-mouse-debug-buffer
96 (print unread-command-events xterm-mouse-debug-buffer))
97 (if (and (symbolp down-where)
98 (consp down-where))
99 (vector (list down-where down-data) down)
100 (vector down))))))))
102 ;; These two variables have been converted to terminal parameters.
104 ;;(defvar xterm-mouse-x 0
105 ;; "Position of last xterm mouse event relative to the frame.")
107 ;;(defvar xterm-mouse-y 0
108 ;; "Position of last xterm mouse event relative to the frame.")
110 (defvar xt-mouse-epoch nil)
112 ;; Indicator for the xterm-mouse mode.
114 (defun xterm-mouse-position-function (pos)
115 "Bound to `mouse-position-function' in XTerm mouse mode."
116 (when (terminal-parameter nil 'xterm-mouse-x)
117 (setcdr pos (cons (terminal-parameter nil 'xterm-mouse-x)
118 (terminal-parameter nil 'xterm-mouse-y))))
119 pos)
121 ;; read xterm sequences above ascii 127 (#x7f)
122 (defun xterm-mouse-event-read ()
123 (let ((c (read-char)))
124 (if (> c #x3FFF80)
125 (+ 128 (- c #x3FFF80))
126 c)))
128 (defun xterm-mouse-truncate-wrap (f)
129 "Truncate with wrap-around."
130 (condition-case nil
131 ;; First try the built-in truncate, in case there's no overflow.
132 (truncate f)
133 ;; In case of overflow, do wraparound by hand.
134 (range-error
135 ;; In our case, we wrap around every 3 days or so, so if we assume
136 ;; a maximum of 65536 wraparounds, we're safe for a couple years.
137 ;; Using a power of 2 makes rounding errors less likely.
138 (let* ((maxwrap (* 65536 2048))
139 (dbig (truncate (/ f maxwrap)))
140 (fdiff (- f (* 1.0 maxwrap dbig))))
141 (+ (truncate fdiff) (* maxwrap dbig))))))
143 (defun xterm-mouse-event ()
144 "Convert XTerm mouse event to Emacs mouse event."
145 (let* ((type (- (xterm-mouse-event-read) #o40))
146 (x (- (xterm-mouse-event-read) #o40 1))
147 (y (- (xterm-mouse-event-read) #o40 1))
148 ;; Emulate timestamp information. This is accurate enough
149 ;; for default value of mouse-1-click-follows-link (450msec).
150 (timestamp (xterm-mouse-truncate-wrap
151 (* 1000
152 (- (float-time)
153 (or xt-mouse-epoch
154 (setq xt-mouse-epoch (float-time)))))))
155 (mouse (intern
156 ;; For buttons > 3, the release-event looks
157 ;; differently (see xc/programs/xterm/button.c,
158 ;; function EditorButton), and there seems to come in
159 ;; a release-event only, no down-event.
160 (cond ((>= type 64)
161 (format "mouse-%d" (- type 60)))
162 ((memq type '(8 9 10))
163 (setq xterm-mouse-last type)
164 (format "M-down-mouse-%d" (- type 7)))
165 ((= type 11)
166 (format "mouse-%d" (- xterm-mouse-last 7)))
167 ((= type 3)
168 ;; For buttons > 5 xterm only reports a
169 ;; button-release event. Avoid error by mapping
170 ;; them all to mouse-1.
171 (format "mouse-%d" (+ 1 (or xterm-mouse-last 0))))
173 (setq xterm-mouse-last type)
174 (format "down-mouse-%d" (+ 1 type))))))
175 (w (window-at x y))
176 (ltrb (window-edges w))
177 (left (nth 0 ltrb))
178 (top (nth 1 ltrb)))
180 (set-terminal-parameter nil 'xterm-mouse-x x)
181 (set-terminal-parameter nil 'xterm-mouse-y y)
182 (setq
183 last-input-event
184 (list mouse
185 (let ((event (if w
186 (posn-at-x-y (- x left) (- y top) w t)
187 (append (list nil 'menu-bar)
188 (nthcdr 2 (posn-at-x-y x y))))))
189 (setcar (nthcdr 3 event) timestamp)
190 event)))))
192 ;;;###autoload
193 (define-minor-mode xterm-mouse-mode
194 "Toggle XTerm mouse mode.
195 With prefix arg, turn XTerm mouse mode on if arg is positive, otherwise turn
196 it off.
198 Turn it on to use Emacs mouse commands, and off to use xterm mouse commands.
199 This works in terminal emulators compatible with xterm. It only
200 works for simple uses of the mouse. Basically, only non-modified
201 single clicks are supported. When turned on, the normal xterm
202 mouse functionality for such clicks is still available by holding
203 down the SHIFT key while pressing the mouse button."
204 :global t :group 'mouse
205 (let ((do-hook (if xterm-mouse-mode 'add-hook 'remove-hook)))
206 (funcall do-hook 'terminal-init-xterm-hook
207 'turn-on-xterm-mouse-tracking-on-terminal)
208 (funcall do-hook 'delete-terminal-functions
209 'turn-off-xterm-mouse-tracking-on-terminal)
210 (funcall do-hook 'suspend-tty-functions
211 'turn-off-xterm-mouse-tracking-on-terminal)
212 (funcall do-hook 'resume-tty-functions
213 'turn-on-xterm-mouse-tracking-on-terminal)
214 (funcall do-hook 'suspend-hook 'turn-off-xterm-mouse-tracking)
215 (funcall do-hook 'suspend-resume-hook 'turn-on-xterm-mouse-tracking)
216 (funcall do-hook 'kill-emacs-hook 'turn-off-xterm-mouse-tracking))
217 (if xterm-mouse-mode
218 ;; Turn it on
219 (progn
220 (setq mouse-position-function #'xterm-mouse-position-function)
221 (turn-on-xterm-mouse-tracking))
222 ;; Turn it off
223 (turn-off-xterm-mouse-tracking 'force)
224 (setq mouse-position-function nil)))
226 (defun turn-on-xterm-mouse-tracking ()
227 "Enable Emacs mouse tracking in xterm."
228 (dolist (terminal (terminal-list))
229 (turn-on-xterm-mouse-tracking-on-terminal terminal)))
231 (defun turn-off-xterm-mouse-tracking (&optional force)
232 "Disable Emacs mouse tracking in xterm."
233 (dolist (terminal (terminal-list))
234 (turn-off-xterm-mouse-tracking-on-terminal terminal)))
236 (defun turn-on-xterm-mouse-tracking-on-terminal (&optional terminal)
237 "Enable xterm mouse tracking on TERMINAL."
238 (when (and xterm-mouse-mode (eq t (terminal-live-p terminal))
239 ;; Avoid the initial terminal which is not a termcap device.
240 ;; FIXME: is there more elegant way to detect the initial terminal?
241 (not (string= (terminal-name terminal) "initial_terminal")))
242 (unless (terminal-parameter terminal 'xterm-mouse-mode)
243 ;; Simulate selecting a terminal by selecting one of its frames ;-(
244 (with-selected-frame (car (frames-on-display-list terminal))
245 (define-key input-decode-map "\e[M" 'xterm-mouse-translate))
246 (set-terminal-parameter terminal 'xterm-mouse-mode t))
247 (send-string-to-terminal "\e[?1000h" terminal)))
249 (defun turn-off-xterm-mouse-tracking-on-terminal (terminal)
250 "Disable xterm mouse tracking on TERMINAL."
251 ;; Only send the disable command to those terminals to which we've already
252 ;; sent the enable command.
253 (when (and (terminal-parameter terminal 'xterm-mouse-mode)
254 (eq t (terminal-live-p terminal))
255 ;; Avoid the initial terminal which is not a termcap device.
256 ;; FIXME: is there more elegant way to detect the initial terminal?
257 (not (string= (terminal-name terminal) "initial_terminal")))
258 ;; We could remove the key-binding and unset the `xterm-mouse-mode'
259 ;; terminal parameter, but it seems less harmful to send this escape
260 ;; command too many times (or to catch an unintended key sequence), than
261 ;; to send it too few times (or to fail to let xterm-mouse events
262 ;; pass by untranslated).
263 (send-string-to-terminal "\e[?1000l" terminal)))
265 (provide 'xt-mouse)
267 ;;; xt-mouse.el ends here