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