xt-mouse.el 7.91 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 4
;; Copyright (C) 1994, 2000, 2001, 2002, 2003,
;;   2004, 2005 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
;;; Todo:

42 43 44
;; The xterm mouse escape codes are supposedly also supported by the
;; Linux console, but I have not been able to verify this.

Richard M. Stallman's avatar
Richard M. Stallman committed
45 46
;; Support multi-click -- somehow.

Dave Love's avatar
Dave Love committed
47
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
48

49
;; XXX Perhaps this should be terminal-local instead. --lorentey
Richard M. Stallman's avatar
Richard M. Stallman committed
50 51
(define-key function-key-map "\e[M" 'xterm-mouse-translate)

52 53
(defvar xterm-mouse-last)

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

Richard M. Stallman's avatar
Richard M. Stallman committed
59
(defun xterm-mouse-translate (event)
Dave Love's avatar
Dave Love committed
60
  "Read a click and release event from XTerm."
Richard M. Stallman's avatar
Richard M. Stallman committed
61 62 63
  (save-excursion
    (save-window-excursion
      (deactivate-mark)
64
      (let* ((xterm-mouse-last)
65 66 67 68 69 70
	     (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)
71 72
					  (vector down-command))))
	     (is-click (string-match "^mouse" (symbol-name (car down)))))
73

74 75 76 77 78 79 80
	(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)))
81 82 83 84 85
	       (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)
86
		       (consp click-where))
87 88 89 90 91 92 93 94 95 96 97
		  (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
98 99
		       (list (intern (format "drag-mouse-%d"
					     (+ 1 xterm-mouse-last)))
100
			     down-data click-data)))))
101
	    (if (and (symbolp down-where)
102
		     (consp down-where))
103 104 105
		(vector (list down-where down-data) down)
	      (vector down))))))))

106 107 108 109 110 111 112
;; These two variables have been converted to terminal parameters.
;;
;;(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.")
113

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

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

123 124 125 126 127 128 129
;; 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
130
(defun xterm-mouse-event ()
Dave Love's avatar
Dave Love committed
131
  "Convert XTerm mouse event to Emacs mouse event."
132 133 134
  (let* ((type (- (xterm-mouse-event-read) #o40))
	 (x (- (xterm-mouse-event-read) #o40 1))
	 (y (- (xterm-mouse-event-read) #o40 1))
135
	 (mouse (intern
136 137 138 139 140 141 142 143 144 145
		 ;; 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)))
		       ((= type 3)
			(format "mouse-%d" (+ 1 xterm-mouse-last)))
		       (t
			(setq xterm-mouse-last type)
146
			(format "down-mouse-%d" (+ 1 type))))))
147 148 149 150 151
	 (w (window-at x y))
         (ltrb (window-edges w))
         (left (nth 0 ltrb))
         (top (nth 1 ltrb)))

152 153
    (set-terminal-parameter nil 'xterm-mouse-x x)
    (set-terminal-parameter nil 'xterm-mouse-y y)
154 155 156 157 158 159
    (setq
     last-input-event
     (if w
	 (list mouse (posn-at-x-y (- x left) (- y top) w t))
       (list mouse
	     (append (list nil 'menu-bar) (nthcdr 2 (posn-at-x-y x y w t))))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
160 161

;;;###autoload
162
(define-minor-mode xterm-mouse-mode
Richard M. Stallman's avatar
Richard M. Stallman committed
163 164 165
  "Toggle XTerm mouse mode.
With prefix arg, turn XTerm mouse mode on iff arg is positive.

166
Turn it on to use Emacs mouse commands, and off to use xterm mouse commands.
167 168 169 170 171 172
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
173 174
  (if xterm-mouse-mode
      ;; Turn it on
175
      (progn
176 177 178 179 180
	(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
181 182

(defun turn-on-xterm-mouse-tracking ()
Dave Love's avatar
Dave Love committed
183
  "Enable Emacs mouse tracking in xterm."
184 185 186 187 188
  (dolist (f (frame-list))
    (when (eq t (frame-live-p f))
      (with-selected-frame f
	(when xterm-mouse-mode
	  (send-string-to-terminal "\e[?1000h"))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
189

190
(defun turn-off-xterm-mouse-tracking (&optional force)
191
  "Disable Emacs mouse tracking in xterm."
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
  (dolist (f (frame-list))
    (when (eq t (frame-live-p f))
      (with-selected-frame f
	(when (or force xterm-mouse-mode)
	  (send-string-to-terminal "\e[?1000l"))))))

(defun turn-on-xterm-mouse-tracking-on-terminal (terminal)
  "Enable xterm mouse tracking on TERMINAL."
  (when (and xterm-mouse-mode (eq t (display-live-p terminal)))
    (send-string-to-terminal "\e[?1000h" terminal)))

(defun turn-off-xterm-mouse-tracking-on-terminal (terminal)
  "Disable xterm mouse tracking on TERMINAL."
  (when (and xterm-mouse-mode (eq t (display-live-p terminal)))
    (send-string-to-terminal "\e[?1000l" terminal)))

(defun xterm-mouse-handle-delete-frame (frame)
  "Turn off xterm mouse tracking if FRAME is the last frame on its device."
  (when (and (eq t (frame-live-p frame))
	     (<= 1 (length (frames-on-display-list (frame-display frame)))))
    (turn-off-xterm-mouse-tracking-on-terminal frame)))

;; Frame creation and deletion.
(add-hook 'after-make-frame-functions 'turn-on-xterm-mouse-tracking-on-terminal)
(add-hook 'delete-frame-functions 'xterm-mouse-handle-delete-frame)
Richard M. Stallman's avatar
Richard M. Stallman committed
217 218

;; Restore normal mouse behaviour outside Emacs.
219 220
(add-hook 'suspend-tty-functions 'turn-off-xterm-mouse-tracking-on-terminal)
(add-hook 'resume-tty-functions 'turn-on-xterm-mouse-tracking-on-terminal)
Richard M. Stallman's avatar
Richard M. Stallman committed
221 222 223 224 225 226
(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
227
;;; arch-tag: 84962d4e-fae9-4c13-a9d7-ef4925a4ac03
Richard M. Stallman's avatar
Richard M. Stallman committed
228
;;; xt-mouse.el ends here