lisp/xt-mouse.el

   1 ;;; xt-mouse.el --- support the mouse when emacs run in an xterm
   2
   3 ;; Copyright (C) 1994, 2000, 2001, 2002, 2003,
   4 ;;   2004, 2005, 2006, 2007 Free Software Foundation, Inc.
   5
   6 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
   7 ;; Keywords: mouse, terminals
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  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.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  24 ;; Boston, MA 02110-1301, USA.
  25
  26 ;;; Commentary:
  27
  28 ;; Enable mouse support when running inside an xterm.
  29
  30 ;; This is actually useful when you are running X11 locally, but is
  31 ;; working on remote machine over a modem line or through a gateway.
  32
  33 ;; It works by translating xterm escape codes into generic emacs mouse
  34 ;; events so it should work with any package that uses the mouse.
  35
  36 ;; You don't have to turn off xterm mode to use the normal xterm mouse
  37 ;; functionality, it is still available by holding down the SHIFT key
  38 ;; when you press the mouse button.
  39
  40 ;;; Todo:
  41
  42 ;; Support multi-click -- somehow.
  43
  44 ;;; Code:
  45
  46 (define-key function-key-map "\e[M" 'xterm-mouse-translate)
  47
  48 (defvar xterm-mouse-last)
  49
  50 ;; Mouse events symbols must have an 'event-kind property with
  51 ;; the value 'mouse-click.
  52 (dolist (event-type '(mouse-1 mouse-2 mouse-3
  53                               M-down-mouse-1 M-down-mouse-2 M-down-mouse-3))
  54   (put event-type 'event-kind 'mouse-click))
  55
  56 (defun xterm-mouse-translate (event)
  57   "Read a click and release event from XTerm."
  58   (save-excursion
  59     (save-window-excursion
  60       (deactivate-mark)
  61       (let* ((xterm-mouse-last)
  62              (down (xterm-mouse-event))
  63              (down-command (nth 0 down))
  64              (down-data (nth 1 down))
  65              (down-where (nth 1 down-data))
  66              (down-binding (key-binding (if (symbolp down-where)
  67                                             (vector down-where down-command)
  68                                           (vector down-command))))
  69              (is-click (string-match "^mouse" (symbol-name (car down)))))
  70
  71         (unless is-click
  72           (unless (and (eq (read-char) ?\e)
  73                        (eq (read-char) ?\[)
  74                        (eq (read-char) ?M))
  75             (error "Unexpected escape sequence from XTerm")))
  76
  77         (let* ((click (if is-click down (xterm-mouse-event)))
  78                (click-command (nth 0 click))
  79                (click-data (nth 1 click))
  80                (click-where (nth 1 click-data)))
  81           (if (memq down-binding '(nil ignore))
  82               (if (and (symbolp click-where)
  83                        (consp click-where))
  84                   (vector (list click-where click-data) click)
  85                 (vector click))
  86             (setq unread-command-events
  87                   (if (eq down-where click-where)
  88                       (list click)
  89                     (list
  90                      ;; Cheat `mouse-drag-region' with move event.
  91                      (list 'mouse-movement click-data)
  92                      ;; Generate a drag event.
  93                      (if (symbolp down-where)
  94                          0
  95                        (list (intern (format "drag-mouse-%d"
  96                                              (+ 1 xterm-mouse-last)))
  97                              down-data click-data)))))
  98             (if (and (symbolp down-where)
  99                      (consp down-where))
 100                 (vector (list down-where down-data) down)
 101               (vector down))))))))
 102
 103 (defvar xterm-mouse-x 0
 104   "Position of last xterm mouse event relative to the frame.")
 105
 106 (defvar xterm-mouse-y 0
 107   "Position of last xterm mouse event relative to the frame.")
 108
 109 (defvar xt-mouse-epoch nil)
 110
 111 ;; Indicator for the xterm-mouse mode.
 112
 113 (defun xterm-mouse-position-function (pos)
 114   "Bound to `mouse-position-function' in XTerm mouse mode."
 115   (setcdr pos (cons xterm-mouse-x xterm-mouse-y))
 116   pos)
 117
 118 ;; read xterm sequences above ascii 127 (#x7f)
 119 (defun xterm-mouse-event-read ()
 120   (let ((c (read-char)))
 121     (if (< c 0)
 122         (+ c #x8000000 128)
 123       c)))
 124
 125 (defun xterm-mouse-event ()
 126   "Convert XTerm mouse event to Emacs mouse event."
 127   (let* ((type (- (xterm-mouse-event-read) #o40))
 128          (x (- (xterm-mouse-event-read) #o40 1))
 129          (y (- (xterm-mouse-event-read) #o40 1))
 130          ;; Emulate timestamp information.  This is accurate enough
 131          ;; for default value of mouse-1-click-follows-link (450msec).
 132          (timestamp (truncate
 133                      (* 1000
 134                         (- (float-time)
 135                            (or xt-mouse-epoch
 136                                (setq xt-mouse-epoch (float-time)))))))
 137          (mouse (intern
 138                  ;; For buttons > 3, the release-event looks
 139                  ;; differently (see xc/programs/xterm/button.c,
 140                  ;; function EditorButton), and there seems to come in
 141                  ;; a release-event only, no down-event.
 142                  (cond ((>= type 64)
 143                         (format "mouse-%d" (- type 60)))
 144                        ((memq type '(8 9 10))
 145                         (setq xterm-mouse-last type)
 146                         (format "M-down-mouse-%d" (- type 7)))
 147                        ((= type 11)
 148                         (format "mouse-%d" (- xterm-mouse-last 7)))
 149                        ((= type 3)
 150                         (format "mouse-%d" (+ 1 xterm-mouse-last)))
 151                        (t
 152                         (setq xterm-mouse-last type)
 153                         (format "down-mouse-%d" (+ 1 type))))))
 154          (w (window-at x y))
 155          (ltrb (window-edges w))
 156          (left (nth 0 ltrb))
 157          (top (nth 1 ltrb)))
 158
 159     (setq xterm-mouse-x x
 160           xterm-mouse-y y)
 161     (setq
 162      last-input-event
 163      (list mouse
 164            (let ((event (if w
 165                             (posn-at-x-y (- x left) (- y top) w t)
 166                           (append (list nil 'menu-bar)
 167                                   (nthcdr 2 (posn-at-x-y x y))))))
 168              (setcar (nthcdr 3 event) timestamp)
 169              event)))))
 170
 171 ;;;###autoload
 172 (define-minor-mode xterm-mouse-mode
 173   "Toggle XTerm mouse mode.
 174 With prefix arg, turn XTerm mouse mode on iff arg is positive.
 175
 176 Turn it on to use Emacs mouse commands, and off to use xterm mouse commands.
 177 This works in terminal emulators compatible with xterm.  It only
 178 works for simple uses of the mouse.  Basically, only non-modified
 179 single clicks are supported.  When turned on, the normal xterm
 180 mouse functionality for such clicks is still available by holding
 181 down the SHIFT key while pressing the mouse button."
 182   :global t :group 'mouse
 183   (if xterm-mouse-mode
 184       ;; Turn it on
 185       (unless window-system
 186         (setq mouse-position-function #'xterm-mouse-position-function)
 187         (turn-on-xterm-mouse-tracking))
 188     ;; Turn it off
 189     (turn-off-xterm-mouse-tracking 'force)
 190     (setq mouse-position-function nil)))
 191
 192 (defun turn-on-xterm-mouse-tracking ()
 193   "Enable Emacs mouse tracking in xterm."
 194   (if xterm-mouse-mode
 195       (send-string-to-terminal "\e[?1000h")))
 196
 197 (defun turn-off-xterm-mouse-tracking (&optional force)
 198   "Disable Emacs mouse tracking in xterm."
 199   (if (or force xterm-mouse-mode)
 200       (send-string-to-terminal "\e[?1000l")))
 201
 202 ;; Restore normal mouse behaviour outside Emacs.
 203 (add-hook 'suspend-hook 'turn-off-xterm-mouse-tracking)
 204 (add-hook 'suspend-resume-hook 'turn-on-xterm-mouse-tracking)
 205 (add-hook 'kill-emacs-hook 'turn-off-xterm-mouse-tracking)
 206
 207 (provide 'xt-mouse)
 208
 209 ;;; arch-tag: 84962d4e-fae9-4c13-a9d7-ef4925a4ac03
 210 ;;; xt-mouse.el ends here