Commit | Line | Data |
---|---|---|
9efe4a2d NR |
1 | ;;; t-mouse.el --- mouse support within the text terminal |
2 | ||
20d385d6 NR |
3 | ;; Author: Nick Roberts <nickrob@gnu.org> |
4 | ;; Maintainer: FSF | |
9efe4a2d NR |
5 | ;; Keywords: mouse gpm linux |
6 | ||
478975a9 GM |
7 | ;; Copyright (C) 1994, 1995, 1998, 2006, 2007, 2008 |
8 | ;; Free Software Foundation, Inc. | |
eff05ea1 NR |
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 | |
b4aa6026 | 14 | ;; the Free Software Foundation; either version 3, or (at your option) |
eff05ea1 NR |
15 | ;; 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. | |
9efe4a2d | 21 | |
eff05ea1 NR |
22 | ;; You should have received a copy of the GNU General Public License |
23 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
24 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, | |
25 | ;; Boston, MA 02110-1301, USA. | |
9efe4a2d NR |
26 | |
27 | ;;; Commentary: | |
28 | ||
20d385d6 NR |
29 | ;; This package provides access to mouse event as reported by the gpm-Linux |
30 | ;; package. It tries to reproduce the functionality offered by Emacs under X. | |
9efe4a2d NR |
31 | ;; The "gpm" server runs under Linux, so this package is rather |
32 | ;; Linux-dependent. | |
33 | ||
43180aff NR |
34 | ;; The file, t-mouse.el was originally written by Alessandro Rubini and Ian T |
35 | ;; Zimmerman, and Emacs communicated with gpm through a client program called | |
36 | ;; mev. Now the interface with gpm is directly through a Unix socket, so this | |
37 | ;; file is reduced to a single minor mode macro call. | |
9efe4a2d | 38 | |
20d385d6 | 39 | ;; |
9efe4a2d NR |
40 | \f |
41 | ;;; Code: | |
42 | ||
478975a9 GM |
43 | ;; Prevent warning when compiling in an Emacs without gpm support. |
44 | (declare-function gpm-mouse-start "term.c" ()) | |
45 | ||
eff05ea1 | 46 | ;;;###autoload |
0e2806fa SM |
47 | (define-obsolete-function-alias 't-mouse-mode 'gpm-mouse-mode "23.1") |
48 | ;;;###autoload | |
49 | (define-minor-mode gpm-mouse-mode | |
50 | "Toggle gpm-mouse mode to use the mouse in GNU/Linux consoles. | |
51 | With prefix arg, turn gpm-mouse mode on if arg is positive, | |
52 | otherwise turn it off. | |
eff05ea1 | 53 | |
0e2806fa SM |
54 | This allows the use of the mouse when operating on a GNU/Linux console, |
55 | in the same way as you can use the mouse under X11. | |
56 | It relies on the `gpm' daemon being activated." | |
9086c6b1 | 57 | :global t :group 'mouse |
0e2806fa SM |
58 | (let ((activated nil)) |
59 | (unwind-protect | |
60 | (progn | |
61 | (unless (fboundp 'gpm-mouse-start) | |
62 | (error "Emacs must be built with Gpm to use this mode")) | |
63 | (when gpm-mouse-mode | |
64 | (gpm-mouse-start) | |
65 | (setq activated t))) | |
66 | ;; If the user asked to turn it off do that. | |
67 | ;; If something failed to turn it on, try to turn it off as well, | |
68 | ;; just in case. | |
69 | (when (and (fboundp 'gpm-mouse-stop) (not activated)) | |
70 | (setq gpm-mouse-mode nil) | |
71 | (gpm-mouse-stop))))) | |
9efe4a2d NR |
72 | |
73 | (provide 't-mouse) | |
74 | ||
e1b267c1 | 75 | ;; arch-tag: a63163b3-bfbe-4eb2-ab4f-201cd164b05d |
9efe4a2d | 76 | ;;; t-mouse.el ends here |