lisp/xt-mouse.el

   1 ;;; xt-mouse.el --- support the mouse when emacs run in an xterm
   2
   3 ;; Copyright (C) 1994, 2000, 2001 Free Software Foundation
   4
   5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
   6 ;; Keywords: mouse, terminals
   7
   8 ;; This file is part of GNU Emacs.
   9
  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.
  14
  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.
  19
  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.
  24
  25 ;;; Commentary:
  26
  27 ;; Enable mouse support when running inside an xterm or Linux console.
  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
  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
  42 ;;; Todo:
  43
  44 ;; Support multi-click -- somehow.
  45
  46 ;; Clicking on the mode-line does not work, although it should.
  47
  48 ;;; Code:
  49
  50 (define-key function-key-map "\e[M" 'xterm-mouse-translate)
  51
  52 (defvar xterm-mouse-last)
  53
  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)))))
  68
  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")))
  74
  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)
  92                          0
  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))))))))
 101
 102 (defvar xterm-mouse-x 0
 103   "Position of last xterm mouse event relative to the frame.")
 104
 105 (defvar xterm-mouse-y 0
 106   "Position of last xterm mouse event relative to the frame.")
 107
 108 ;; Indicator for the xterm-mouse mode.
 109 (defvar xterm-mouse-mode nil)
 110
 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)
 115
 116 (defun xterm-mouse-event ()
 117   "Convert XTerm mouse event to Emacs mouse event."
 118   (let* ((type (- (read-char) #o40))
 119          (x (- (read-char) #o40 1))
 120          (y (- (read-char) #o40 1))
 121          (point (cons x y))
 122          (window (window-at x y))
 123          (where (if window
 124                     (coordinates-in-window-p point window)
 125                   'menu-bar))
 126          (pos (if (consp where)
 127                   (progn
 128                     (select-window window)
 129                     (goto-char (window-start window))
 130                     (move-to-window-line (-
 131                                           (cdr where)
 132                                           (if (or header-line-format
 133                                                   default-header-line-format)
 134                                               1
 135                                             0)))
 136                     (move-to-column (+ (car where) (current-column)
 137                                        (if (string-match "\\` \\*Minibuf"
 138                                                          (buffer-name))
 139                                            (- (minibuffer-prompt-width))
 140                                          0)
 141                                        (max 0 (1- (window-hscroll)))))
 142                     (point))
 143                 where))
 144          (mouse (intern
 145                  ;; For buttons > 3, the release-event looks
 146                  ;; differently (see xc/programs/xterm/button.c,
 147                  ;; function EditorButton), and there seems to come in
 148                  ;; a release-event only, no down-event.
 149                  (cond ((>= type 64)
 150                         (format "mouse-%d" (- type 60)))
 151                        ((= type 3)
 152                         (format "mouse-%d" (+ 1 xterm-mouse-last)))
 153                        (t
 154                         (setq xterm-mouse-last type)
 155                         (format "down-mouse-%d" (+ 1 type)))))))
 156     (setq xterm-mouse-x x
 157           xterm-mouse-y y)
 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)
 179             (setq xterm-mouse-mode nil
 180                   mouse-position-function nil)
 181             (set-buffer-modified-p (buffer-modified-p))))
 182     ;;Turn it on
 183     (unless (or window-system xterm-mouse-mode)
 184       (setq xterm-mouse-mode t
 185             mouse-position-function #'xterm-mouse-position-function)
 186       (turn-on-xterm-mouse-tracking)
 187       (set-buffer-modified-p (buffer-modified-p)))))
 188
 189 (defun turn-on-xterm-mouse-tracking ()
 190   "Enable Emacs mouse tracking in xterm."
 191   (if xterm-mouse-mode
 192       (send-string-to-terminal "\e[?1000h")))
 193
 194 (defun turn-off-xterm-mouse-tracking ()
 195   "Disable Emacs mouse tracking in xterm."
 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