Comment changes.
[emacs.git] / lisp / xt-mouse.el
bloba261d3d36c8ec87e6fe5c7c757eea586cd5dacfe
1 ;;; xt-mouse.el --- support the mouse when emacs run in an xterm
3 ;; Copyright (C) 1994, 2000, 2001 Free Software Foundation
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 2, or (at your option)
13 ;; 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; 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.
25 ;;; Commentary:
27 ;; Enable mouse support when running inside an xterm or Linux console.
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.
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.
35 ;; The xterm mouse escape codes are supposedly also supported by the
36 ;; Linux console, but I have not been able to verify this.
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.
42 ;;; Todo:
44 ;; Support multi-click -- somehow.
46 ;; Clicking on the mode-line does not work, although it should.
48 ;;; Code:
50 (define-key function-key-map "\e[M" 'xterm-mouse-translate)
52 (defvar xterm-mouse-last)
54 (defun xterm-mouse-translate (event)
55 "Read a click and release event from XTerm."
56 (save-excursion
57 (save-window-excursion
58 (deactivate-mark)
59 (let* ((xterm-mouse-last)
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)
66 (vector down-command))))
67 (is-click (string-match "^mouse" (symbol-name (car down)))))
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")))
75 (let* ((click (if is-click down (xterm-mouse-event)))
76 (click-command (nth 0 click))
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)
81 (not (eq 'menu-bar click-where)))
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)
93 (list (intern (format "drag-mouse-%d"
94 (+ 1 xterm-mouse-last)))
95 down-data click-data))
96 )))
97 (if (and (symbolp down-where)
98 (not (eq 'menu-bar down-where)))
99 (vector (list down-where down-data) down)
100 (vector down))))))))
102 (defvar xterm-mouse-x 0
103 "Position of last xterm mouse event relative to the frame.")
105 (defvar xterm-mouse-y 0
106 "Position of last xterm mouse event relative to the frame.")
108 ;; Indicator for the xterm-mouse mode.
110 (defun xterm-mouse-position-function (pos)
111 "Bound to `mouse-position-function' in XTerm mouse mode."
112 (setcdr pos (cons xterm-mouse-x xterm-mouse-y))
113 pos)
115 ;; read xterm sequences above ascii 127 (#x7f)
116 (defun xterm-mouse-event-read ()
117 (let ((c (read-char)))
118 (if (< c 0)
119 (+ c #x8000000 128)
120 c)))
122 (defun xterm-mouse-event ()
123 "Convert XTerm mouse event to Emacs mouse event."
124 (let* ((type (- (xterm-mouse-event-read) #o40))
125 (x (- (xterm-mouse-event-read) #o40 1))
126 (y (- (xterm-mouse-event-read) #o40 1))
127 (point (cons x y))
128 (window (window-at x y))
129 (where (if window
130 (coordinates-in-window-p point window)
131 'menu-bar))
132 (pos (if (consp where)
133 (progn
134 (select-window window)
135 (goto-char (window-start window))
136 (move-to-window-line (-
137 (cdr where)
138 (if (or header-line-format
139 default-header-line-format)
141 0)))
142 (move-to-column (+ (car where) (current-column)
143 (if (string-match "\\` \\*Minibuf"
144 (buffer-name))
145 (- (minibuffer-prompt-width))
147 (max 0 (1- (window-hscroll)))))
148 (point))
149 where))
150 (mouse (intern
151 ;; For buttons > 3, the release-event looks
152 ;; differently (see xc/programs/xterm/button.c,
153 ;; function EditorButton), and there seems to come in
154 ;; a release-event only, no down-event.
155 (cond ((>= type 64)
156 (format "mouse-%d" (- type 60)))
157 ((= type 3)
158 (format "mouse-%d" (+ 1 xterm-mouse-last)))
160 (setq xterm-mouse-last type)
161 (format "down-mouse-%d" (+ 1 type)))))))
162 (setq xterm-mouse-x x
163 xterm-mouse-y y)
164 (list mouse
165 (list window pos point
166 (/ (nth 2 (current-time)) 1000)))))
168 ;;;###autoload
169 (define-minor-mode xterm-mouse-mode
170 "Toggle XTerm mouse mode.
171 With prefix arg, turn XTerm mouse mode on iff arg is positive.
173 Turn it on to use emacs mouse commands, and off to use xterm mouse commands."
174 nil " Mouse" nil :global t
175 (if xterm-mouse-mode
176 ;; Turn it on
177 (unless window-system
178 (setq mouse-position-function #'xterm-mouse-position-function)
179 (turn-on-xterm-mouse-tracking))
180 ;; Turn it off
181 (turn-off-xterm-mouse-tracking 'force)
182 (setq mouse-position-function nil)))
184 (defun turn-on-xterm-mouse-tracking ()
185 "Enable Emacs mouse tracking in xterm."
186 (if xterm-mouse-mode
187 (send-string-to-terminal "\e[?1000h")))
189 (defun turn-off-xterm-mouse-tracking (&optional force)
190 "Disable Emacs mouse tracking in xterm."
191 (if (or force xterm-mouse-mode)
192 (send-string-to-terminal "\e[?1000l")))
194 ;; Restore normal mouse behaviour outside Emacs.
195 (add-hook 'suspend-hook 'turn-off-xterm-mouse-tracking)
196 (add-hook 'suspend-resume-hook 'turn-on-xterm-mouse-tracking)
197 (add-hook 'kill-emacs-hook 'turn-off-xterm-mouse-tracking)
199 (provide 'xt-mouse)
201 ;;; arch-tag: 84962d4e-fae9-4c13-a9d7-ef4925a4ac03
202 ;;; xt-mouse.el ends here