lisp/t-mouse.el

   1 ;;; t-mouse.el --- mouse support within the text terminal
   2
   3 ;; Author: Nick Roberts <nickrob@gnu.org>
   4 ;; Maintainer: FSF
   5 ;; Keywords: mouse gpm linux
   6
   7 ;; Copyright (C) 1994, 1995, 1998, 2006, 2007 Free Software Foundation, Inc.
   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 3, 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 ;; This package provides access to mouse event as reported by the gpm-Linux
  29 ;; package. It tries to reproduce the functionality offered by Emacs under X.
  30 ;; The "gpm" server runs under Linux, so this package is rather
  31 ;; Linux-dependent.
  32
  33 ;; The file, t-mouse.el was originally written by Alessandro Rubini and Ian T
  34 ;; Zimmerman, and Emacs communicated with gpm through a client program called
  35 ;; mev.  Now the interface with gpm is directly through a Unix socket, so this
  36 ;; file is reduced to a single minor mode macro call.
  37
  38 ;;
  39 \f
  40 ;;; Code:
  41
  42 ;;;###autoload
  43 (define-obsolete-function-alias 't-mouse-mode 'gpm-mouse-mode "23.1")
  44 ;;;###autoload
  45 (define-minor-mode gpm-mouse-mode
  46   "Toggle gpm-mouse mode to use the mouse in GNU/Linux consoles.
  47 With prefix arg, turn gpm-mouse mode on if arg is positive,
  48 otherwise turn it off.
  49
  50 This allows the use of the mouse when operating on a GNU/Linux console,
  51 in the same way as you can use the mouse under X11.
  52 It relies on the `gpm' daemon being activated."
  53   :global t :group 'mouse
  54   (let ((activated nil))
  55     (unwind-protect
  56         (progn
  57           (unless (fboundp 'gpm-mouse-start)
  58             (error "Emacs must be built with Gpm to use this mode"))
  59           (when gpm-mouse-mode
  60             (gpm-mouse-start)
  61             (setq activated t)))
  62       ;; If the user asked to turn it off do that.
  63       ;; If something failed to turn it on, try to turn it off as well,
  64       ;; just in case.
  65       (when (and (fboundp 'gpm-mouse-stop) (not activated))
  66         (setq gpm-mouse-mode nil)
  67         (gpm-mouse-stop)))))
  68
  69 (provide 't-mouse)
  70
  71 ;; arch-tag: a63163b3-bfbe-4eb2-ab4f-201cd164b05d
  72 ;;; t-mouse.el ends here