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, 2008
   8 ;;   Free Software Foundation, Inc.
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 ;;; Commentary:
  26
  27 ;; This package provides access to mouse event as reported by the gpm-Linux
  28 ;; package. It tries to reproduce the functionality offered by Emacs under X.
  29 ;; The "gpm" server runs under Linux, so this package is rather
  30 ;; Linux-dependent.
  31
  32 ;; The file, t-mouse.el was originally written by Alessandro Rubini and Ian T
  33 ;; Zimmerman, and Emacs communicated with gpm through a client program called
  34 ;; mev.  Now the interface with gpm is directly through a Unix socket, so this
  35 ;; file is reduced to a single minor mode macro call.
  36
  37 ;;
  38 \f
  39 ;;; Code:
  40
  41 ;; Prevent warning when compiling in an Emacs without gpm support.
  42 (declare-function gpm-mouse-start "term.c" ())
  43
  44 ;;;###autoload
  45 (define-obsolete-function-alias 't-mouse-mode 'gpm-mouse-mode "23.1")
  46 ;;;###autoload
  47 (define-minor-mode gpm-mouse-mode
  48   "Toggle gpm-mouse mode to use the mouse in GNU/Linux consoles.
  49 With prefix arg, turn gpm-mouse mode on if arg is positive,
  50 otherwise turn it off.
  51
  52 This allows the use of the mouse when operating on a GNU/Linux console,
  53 in the same way as you can use the mouse under X11.
  54 It relies on the `gpm' daemon being activated."
  55   :global t :group 'mouse
  56   (let ((activated nil))
  57     (unwind-protect
  58         (progn
  59           (unless (fboundp 'gpm-mouse-start)
  60             (error "Emacs must be built with Gpm to use this mode"))
  61           (when gpm-mouse-mode
  62             (gpm-mouse-start)
  63             (setq activated t)))
  64       ;; If the user asked to turn it off do that.
  65       ;; If something failed to turn it on, try to turn it off as well,
  66       ;; just in case.
  67       (when (and (fboundp 'gpm-mouse-stop) (not activated))
  68         (setq gpm-mouse-mode nil)
  69         (gpm-mouse-stop)))))
  70
  71 (provide 't-mouse)
  72
  73 ;; arch-tag: a63163b3-bfbe-4eb2-ab4f-201cd164b05d
  74 ;;; t-mouse.el ends here