-;;; xt-mouse.el --- Support the mouse when emacs run in an xterm.
+;;; xt-mouse.el --- support the mouse when emacs run in an xterm
-;; Copyright (C) 1994 Free Software Foundation
+;; Copyright (C) 1994, 2000, 2001, 2005 Free Software Foundation
-;; Author: Per Abrahamsen <abraham@iesd.auc.dk>
+;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Keywords: mouse, terminals
;; This file is part of GNU Emacs.
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
-;;; Comments:
+;;; Commentary:
-;; Enable mouse support when running inside an xterm.
+;; Enable mouse support when running inside an xterm.
;; 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.
+;; 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.
+
;;; Todo:
-;; Support multi-click -- somehow.
+;; The xterm mouse escape codes are supposedly also supported by the
+;; Linux console, but I have not been able to verify this.
-;; Clicking on the mode-line does not work, although it should.
+;; Support multi-click -- somehow.
-;;; Code:
+;;; Code:
(define-key function-key-map "\e[M" 'xterm-mouse-translate)
(defvar xterm-mouse-last)
+;; 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))
+
(defun xterm-mouse-translate (event)
- ;; Read a click and release event from XTerm.
+ "Read a click and release event from XTerm."
(save-excursion
(save-window-excursion
(deactivate-mark)
(down-where (nth 1 down-data))
(down-binding (key-binding (if (symbolp down-where)
(vector down-where down-command)
- (vector down-command)))))
- (or (and (eq (read-char) ?\e)
- (eq (read-char) ?\[)
- (eq (read-char) ?M))
- (error "Unexpected escape sequence from XTerm"))
- (let* ((click (xterm-mouse-event))
+ (vector down-command))))
+ (is-click (string-match "^mouse" (symbol-name (car down)))))
+
+ (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)))
(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)
- (not (eq 'menu-bar click-where)))
+ (consp click-where))
(vector (list click-where click-data) click)
(vector click))
(setq unread-command-events
;; Generate a drag event.
(if (symbolp down-where)
0
- (list (intern (concat "drag-mouse-" (+ 1 xterm-mouse-last)))
- down-data click-data))
- )))
+ (list (intern (format "drag-mouse-%d"
+ (+ 1 xterm-mouse-last)))
+ down-data click-data)))))
(if (and (symbolp down-where)
- (not (eq 'menu-bar down-where)))
+ (consp down-where))
(vector (list down-where down-data) down)
(vector down))))))))
(defvar xterm-mouse-y 0
"Position of last xterm mouse event relative to the frame.")
-(defadvice mouse-position (around xterm-mouse activate)
- "Use last key from xterm-mouse-mode if available."
- (let ((answer ad-do-it))
- (setq ad-return-value
- (if xterm-mouse-mode
- (cons (car answer) (cons xterm-mouse-x xterm-mouse-y))
- answer))))
+;; Indicator for the xterm-mouse mode.
+
+(defun xterm-mouse-position-function (pos)
+ "Bound to `mouse-position-function' in XTerm mouse mode."
+ (setcdr pos (cons xterm-mouse-x xterm-mouse-y))
+ pos)
+
+;; read xterm sequences above ascii 127 (#x7f)
+(defun xterm-mouse-event-read ()
+ (let ((c (read-char)))
+ (if (< c 0)
+ (+ c #x8000000 128)
+ c)))
(defun xterm-mouse-event ()
- ;; Convert XTerm mouse event to Emacs mouse event.
- (let* ((type (- (read-char) ? ))
- (x (- (read-char) ? 1))
- (y (- (read-char) ? 1))
- (point (cons x y))
- (window (window-at x y))
- (where (if window
- (coordinates-in-window-p point window)
- 'menu-bar))
- (pos (if (consp where)
- (progn
- (select-window window)
- (goto-char (window-start window))
- (move-to-window-line (cdr where))
- (move-to-column (+ (car where) (current-column)
- (max 0 (1- (window-hscroll)))))
- (point))
- where))
- (mouse (intern (if (eq type 3)
- (concat "mouse-" (+ 1 xterm-mouse-last))
- (setq xterm-mouse-last type)
- (concat "down-mouse-" (+ 1 type))))))
+ "Convert XTerm mouse event to Emacs mouse event."
+ (let* ((type (- (xterm-mouse-event-read) #o40))
+ (x (- (xterm-mouse-event-read) #o40 1))
+ (y (- (xterm-mouse-event-read) #o40 1))
+ (mouse (intern
+ ;; 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)
+ (format "down-mouse-%d" (+ 1 type))))))
+ (w (window-at x y))
+ (ltrb (window-edges w))
+ (left (nth 0 ltrb))
+ (top (nth 1 ltrb)))
+
(setq xterm-mouse-x x
xterm-mouse-y y)
- (list mouse
- (list window pos point
- (/ (nth 2 (current-time)) 1000)))))
-
-;; Indicator for the xterm-mouse mode.
-(defvar xterm-mouse-mode nil)
-
-(or (assq 'xterm-mouse-mode minor-mode-alist)
- (setq minor-mode-alist
- (cons '(xterm-mouse-mode (" Mouse")) minor-mode-alist)))
+ (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)))))))
;;;###autoload
-(defun xterm-mouse-mode (arg)
+(define-minor-mode xterm-mouse-mode
"Toggle XTerm mouse mode.
With prefix arg, turn XTerm mouse mode on iff arg is positive.
Turn it on to use emacs mouse commands, and off to use xterm mouse commands."
- (interactive "P")
- (if (or (and (null arg) xterm-mouse-mode)
- (<= (prefix-numeric-value arg) 0))
- ;; Turn it off
- (if xterm-mouse-mode
- (progn
- (turn-off-xterm-mouse-tracking)
- (setq xterm-mouse-mode nil)
- (set-buffer-modified-p (buffer-modified-p))))
- ;;Turn it on
- (if xterm-mouse-mode
- ()
- (setq xterm-mouse-mode t)
- (turn-on-xterm-mouse-tracking)
- (set-buffer-modified-p (buffer-modified-p)))))
+ nil " Mouse" nil :global t
+ (if xterm-mouse-mode
+ ;; Turn it on
+ (unless window-system
+ (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)))
(defun turn-on-xterm-mouse-tracking ()
- ;; Enable emacs mouse tracking in xterm.
+ "Enable Emacs mouse tracking in xterm."
(if xterm-mouse-mode
(send-string-to-terminal "\e[?1000h")))
-(defun turn-off-xterm-mouse-tracking ()
- ;; Disable disable emacs mouse tracking in xterm.
- (if xterm-mouse-mode
+(defun turn-off-xterm-mouse-tracking (&optional force)
+ "Disable Emacs mouse tracking in xterm."
+ (if (or force xterm-mouse-mode)
(send-string-to-terminal "\e[?1000l")))
;; Restore normal mouse behaviour outside Emacs.
(provide 'xt-mouse)
+;;; arch-tag: 84962d4e-fae9-4c13-a9d7-ef4925a4ac03
;;; xt-mouse.el ends here