Mercurial > emacs
annotate lisp/xt-mouse.el @ 44116:1fc0cc0bb3ab
Use `colon' instead of `:' in an index only in the Info version.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Sat, 23 Mar 2002 09:37:39 +0000 |
parents | 42c496dc0b7d |
children | 53a8da1bdd13 |
rev | line source |
---|---|
38436
b174db545cfd
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
38178
diff
changeset
|
1 ;;; xt-mouse.el --- support the mouse when emacs run in an xterm |
14169 | 2 |
38563
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
3 ;; Copyright (C) 1994, 2000, 2001 Free Software Foundation |
13163 | 4 |
17982 | 5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk> |
13163 | 6 ;; Keywords: mouse, terminals |
7 | |
14169 | 8 ;; This file is part of GNU Emacs. |
9 | |
10 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
13163 | 11 ;; it under the terms of the GNU General Public License as published by |
12 ;; the Free Software Foundation; either version 2, or (at your option) | |
13 ;; any later version. | |
14169 | 14 |
15 ;; GNU Emacs is distributed in the hope that it will be useful, | |
13163 | 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. | |
14169 | 19 |
13163 | 20 ;; You should have received a copy of the GNU General Public License |
14169 | 21 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 ;; Boston, MA 02111-1307, USA. | |
13163 | 24 |
27803 | 25 ;;; Commentary: |
13163 | 26 |
14750 | 27 ;; Enable mouse support when running inside an xterm or Linux console. |
13163 | 28 |
29 ;; This is actually useful when you are running X11 locally, but is | |
30 ;; working on remote machine over a modem line or through a gateway. | |
31 | |
32 ;; It works by translating xterm escape codes into generic emacs mouse | |
33 ;; events so it should work with any package that uses the mouse. | |
34 | |
14750 | 35 ;; The xterm mouse escape codes are supposedly also supported by the |
36 ;; Linux console, but I have not been able to verify this. | |
37 | |
38 ;; You don't have to turn off xterm mode to use the normal xterm mouse | |
39 ;; functionality, it is still available by holding down the SHIFT key | |
40 ;; when you press the mouse button. | |
41 | |
13163 | 42 ;;; Todo: |
43 | |
44 ;; Support multi-click -- somehow. | |
45 | |
46 ;; Clicking on the mode-line does not work, although it should. | |
47 | |
27803 | 48 ;;; Code: |
13163 | 49 |
50 (define-key function-key-map "\e[M" 'xterm-mouse-translate) | |
51 | |
13920
3a5b5eeba5b5
(xterm-mouse-translate, xterm-mouse-event):
Richard M. Stallman <rms@gnu.org>
parents:
13500
diff
changeset
|
52 (defvar xterm-mouse-last) |
3a5b5eeba5b5
(xterm-mouse-translate, xterm-mouse-event):
Richard M. Stallman <rms@gnu.org>
parents:
13500
diff
changeset
|
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
3a5b5eeba5b5
(xterm-mouse-translate, xterm-mouse-event):
Richard M. Stallman <rms@gnu.org>
parents:
13500
diff
changeset
|
59 (let* ((xterm-mouse-last) |
13500
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
60 (down (xterm-mouse-event)) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
61 (down-command (nth 0 down)) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
62 (down-data (nth 1 down)) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
63 (down-where (nth 1 down-data)) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
64 (down-binding (key-binding (if (symbolp down-where) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
65 (vector down-where down-command) |
38563
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
66 (vector down-command)))) |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
67 (is-click (string-match "^mouse" (symbol-name (car down))))) |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
68 |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
69 (unless is-click |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
70 (unless (and (eq (read-char) ?\e) |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
71 (eq (read-char) ?\[) |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
72 (eq (read-char) ?M)) |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
73 (error "Unexpected escape sequence from XTerm"))) |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
74 |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
75 (let* ((click (if is-click down (xterm-mouse-event))) |
13500
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
76 (click-command (nth 0 click)) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
77 (click-data (nth 1 click)) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
78 (click-where (nth 1 click-data))) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
79 (if (memq down-binding '(nil ignore)) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
80 (if (and (symbolp click-where) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
81 (not (eq 'menu-bar click-where))) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
82 (vector (list click-where click-data) click) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
83 (vector click)) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
84 (setq unread-command-events |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
85 (if (eq down-where click-where) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
86 (list click) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
87 (list |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
88 ;; Cheat `mouse-drag-region' with move event. |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
89 (list 'mouse-movement click-data) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
90 ;; Generate a drag event. |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
91 (if (symbolp down-where) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
92 0 |
27803 | 93 (list (intern (format "drag-mouse-%d" |
94 (+ 1 xterm-mouse-last))) | |
13500
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
95 down-data click-data)) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
96 ))) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
97 (if (and (symbolp down-where) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
98 (not (eq 'menu-bar down-where))) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
99 (vector (list down-where down-data) down) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
100 (vector down)))))))) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
101 |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
102 (defvar xterm-mouse-x 0 |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
103 "Position of last xterm mouse event relative to the frame.") |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
104 |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
105 (defvar xterm-mouse-y 0 |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
106 "Position of last xterm mouse event relative to the frame.") |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
107 |
23823
d60ff4432412
(xterm-mouse-mode): Pacify the byte compiler.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
21270
diff
changeset
|
108 ;; Indicator for the xterm-mouse mode. |
d60ff4432412
(xterm-mouse-mode): Pacify the byte compiler.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
21270
diff
changeset
|
109 (defvar xterm-mouse-mode nil) |
d60ff4432412
(xterm-mouse-mode): Pacify the byte compiler.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
21270
diff
changeset
|
110 |
27803 | 111 (defun xterm-mouse-position-function (pos) |
112 "Bound to `mouse-position-function' in XTerm mouse mode." | |
113 (setcdr pos (cons xterm-mouse-x xterm-mouse-y)) | |
114 pos) | |
13163 | 115 |
116 (defun xterm-mouse-event () | |
27803 | 117 "Convert XTerm mouse event to Emacs mouse event." |
38563
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
118 (let* ((type (- (read-char) #o40)) |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
119 (x (- (read-char) #o40 1)) |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
120 (y (- (read-char) #o40 1)) |
13163 | 121 (point (cons x y)) |
122 (window (window-at x y)) | |
27803 | 123 (where (if window |
13500
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
124 (coordinates-in-window-p point window) |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
125 'menu-bar)) |
13163 | 126 (pos (if (consp where) |
127 (progn | |
128 (select-window window) | |
129 (goto-char (window-start window)) | |
38178
364478eab234
(xterm-mouse-event): If the buffer displayed in the
Eli Zaretskii <eliz@gnu.org>
parents:
27804
diff
changeset
|
130 (move-to-window-line (- |
364478eab234
(xterm-mouse-event): If the buffer displayed in the
Eli Zaretskii <eliz@gnu.org>
parents:
27804
diff
changeset
|
131 (cdr where) |
364478eab234
(xterm-mouse-event): If the buffer displayed in the
Eli Zaretskii <eliz@gnu.org>
parents:
27804
diff
changeset
|
132 (if (or header-line-format |
364478eab234
(xterm-mouse-event): If the buffer displayed in the
Eli Zaretskii <eliz@gnu.org>
parents:
27804
diff
changeset
|
133 default-header-line-format) |
364478eab234
(xterm-mouse-event): If the buffer displayed in the
Eli Zaretskii <eliz@gnu.org>
parents:
27804
diff
changeset
|
134 1 |
364478eab234
(xterm-mouse-event): If the buffer displayed in the
Eli Zaretskii <eliz@gnu.org>
parents:
27804
diff
changeset
|
135 0))) |
13163 | 136 (move-to-column (+ (car where) (current-column) |
15331
8cf5ec9e5058
(xterm-mouse-event): Adjust for minibuffer prompt width.
Richard M. Stallman <rms@gnu.org>
parents:
14750
diff
changeset
|
137 (if (string-match "\\` \\*Minibuf" |
8cf5ec9e5058
(xterm-mouse-event): Adjust for minibuffer prompt width.
Richard M. Stallman <rms@gnu.org>
parents:
14750
diff
changeset
|
138 (buffer-name)) |
8cf5ec9e5058
(xterm-mouse-event): Adjust for minibuffer prompt width.
Richard M. Stallman <rms@gnu.org>
parents:
14750
diff
changeset
|
139 (- (minibuffer-prompt-width)) |
8cf5ec9e5058
(xterm-mouse-event): Adjust for minibuffer prompt width.
Richard M. Stallman <rms@gnu.org>
parents:
14750
diff
changeset
|
140 0) |
13163 | 141 (max 0 (1- (window-hscroll))))) |
142 (point)) | |
143 where)) | |
38563
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
144 (mouse (intern |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
145 ;; For buttons > 3, the release-event looks |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
146 ;; differently (see xc/programs/xterm/button.c, |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
147 ;; function EditorButton), and there seems to come in |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
148 ;; a release-event only, no down-event. |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
149 (cond ((>= type 64) |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
150 (format "mouse-%d" (- type 60))) |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
151 ((= type 3) |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
152 (format "mouse-%d" (+ 1 xterm-mouse-last))) |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
153 (t |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
154 (setq xterm-mouse-last type) |
75f49513b989
(xterm-mouse-event): Recognize control sequences
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
155 (format "down-mouse-%d" (+ 1 type))))))) |
13500
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
156 (setq xterm-mouse-x x |
5de4c8a3f702
(global-map): Removed bindings of down events to ignore.
Richard M. Stallman <rms@gnu.org>
parents:
13163
diff
changeset
|
157 xterm-mouse-y y) |
13163 | 158 (list mouse |
159 (list window pos point | |
160 (/ (nth 2 (current-time)) 1000))))) | |
161 | |
162 (or (assq 'xterm-mouse-mode minor-mode-alist) | |
163 (setq minor-mode-alist | |
164 (cons '(xterm-mouse-mode (" Mouse")) minor-mode-alist))) | |
165 | |
166 ;;;###autoload | |
167 (defun xterm-mouse-mode (arg) | |
168 "Toggle XTerm mouse mode. | |
169 With prefix arg, turn XTerm mouse mode on iff arg is positive. | |
170 | |
171 Turn it on to use emacs mouse commands, and off to use xterm mouse commands." | |
172 (interactive "P") | |
173 (if (or (and (null arg) xterm-mouse-mode) | |
174 (<= (prefix-numeric-value arg) 0)) | |
175 ;; Turn it off | |
176 (if xterm-mouse-mode | |
177 (progn | |
178 (turn-off-xterm-mouse-tracking) | |
27803 | 179 (setq xterm-mouse-mode nil |
180 mouse-position-function nil) | |
13163 | 181 (set-buffer-modified-p (buffer-modified-p)))) |
182 ;;Turn it on | |
27804 | 183 (unless (or window-system xterm-mouse-mode) |
27803 | 184 (setq xterm-mouse-mode t |
185 mouse-position-function #'xterm-mouse-position-function) | |
13163 | 186 (turn-on-xterm-mouse-tracking) |
187 (set-buffer-modified-p (buffer-modified-p))))) | |
188 | |
189 (defun turn-on-xterm-mouse-tracking () | |
27803 | 190 "Enable Emacs mouse tracking in xterm." |
13163 | 191 (if xterm-mouse-mode |
192 (send-string-to-terminal "\e[?1000h"))) | |
193 | |
194 (defun turn-off-xterm-mouse-tracking () | |
41814
42c496dc0b7d
(turn-off-xterm-mouse-tracking): Doc fix.
Andreas Schwab <schwab@suse.de>
parents:
38563
diff
changeset
|
195 "Disable Emacs mouse tracking in xterm." |
13163 | 196 (if xterm-mouse-mode |
197 (send-string-to-terminal "\e[?1000l"))) | |
198 | |
199 ;; Restore normal mouse behaviour outside Emacs. | |
200 (add-hook 'suspend-hook 'turn-off-xterm-mouse-tracking) | |
201 (add-hook 'suspend-resume-hook 'turn-on-xterm-mouse-tracking) | |
202 (add-hook 'kill-emacs-hook 'turn-off-xterm-mouse-tracking) | |
203 | |
204 (provide 'xt-mouse) | |
205 | |
206 ;;; xt-mouse.el ends here |