annotate lisp/t-mouse.el @ 81311:9746ea590b08

Adjust copyright notice.
author Stefan Monnier <monnier@iro.umontreal.ca>
date Mon, 11 Jun 2007 22:06:36 +0000
parents 74965b1ffc6f
children b98604865ea0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
69185
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
1 ;;; t-mouse.el --- mouse support within the text terminal
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
2
80989
ce6c8b83a99a Reduce to a minor-mode macro call.
Nick Roberts <nickrob@snap.net.nz>
parents: 80848
diff changeset
3 ;; Author: Nick Roberts <nickrob@gnu.org>
ce6c8b83a99a Reduce to a minor-mode macro call.
Nick Roberts <nickrob@snap.net.nz>
parents: 80848
diff changeset
4 ;; Maintainer: FSF
69185
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
5 ;; Keywords: mouse gpm linux
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
6
75298
c5e686c22f72 Update copyright following assignment by
Nick Roberts <nickrob@snap.net.nz>
parents: 73753
diff changeset
7 ;; Copyright (C) 1994, 1995, 1998, 2006, 2007 Free Software Foundation, Inc.
69189
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
8
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
9 ;; This file is part of GNU Emacs.
69185
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
10
69189
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
12 ;; it under the terms of the GNU General Public License as published by
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
13 ;; the Free Software Foundation; either version 2, or (at your option)
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
14 ;; any later version.
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
15
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
16 ;; GNU Emacs is distributed in the hope that it will be useful,
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
19 ;; GNU General Public License for more details.
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
20
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
21 ;; You should have received a copy of the GNU General Public License
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
24 ;; Boston, MA 02110-1301, USA.
69185
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
25
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
26 ;;; Commentary:
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
27
80989
ce6c8b83a99a Reduce to a minor-mode macro call.
Nick Roberts <nickrob@snap.net.nz>
parents: 80848
diff changeset
28 ;; This package provides access to mouse event as reported by the gpm-Linux
ce6c8b83a99a Reduce to a minor-mode macro call.
Nick Roberts <nickrob@snap.net.nz>
parents: 80848
diff changeset
29 ;; package. It tries to reproduce the functionality offered by Emacs under X.
69185
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
30 ;; The "gpm" server runs under Linux, so this package is rather
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
31 ;; Linux-dependent.
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
32
81004
74965b1ffc6f (t-mouse-mode): Reset t-mouse-mode to nil if there
Nick Roberts <nickrob@snap.net.nz>
parents: 81000
diff changeset
33 ;; The file, t-mouse.el was originally written by Alessandro Rubini and Ian T
74965b1ffc6f (t-mouse-mode): Reset t-mouse-mode to nil if there
Nick Roberts <nickrob@snap.net.nz>
parents: 81000
diff changeset
34 ;; Zimmerman, and Emacs communicated with gpm through a client program called
74965b1ffc6f (t-mouse-mode): Reset t-mouse-mode to nil if there
Nick Roberts <nickrob@snap.net.nz>
parents: 81000
diff changeset
35 ;; mev. Now the interface with gpm is directly through a Unix socket, so this
74965b1ffc6f (t-mouse-mode): Reset t-mouse-mode to nil if there
Nick Roberts <nickrob@snap.net.nz>
parents: 81000
diff changeset
36 ;; file is reduced to a single minor mode macro call.
69185
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
37
80989
ce6c8b83a99a Reduce to a minor-mode macro call.
Nick Roberts <nickrob@snap.net.nz>
parents: 80848
diff changeset
38 ;;
69185
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
39
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
40 ;;; Code:
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
41
69189
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
42 ;;;###autoload
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
43 (define-minor-mode t-mouse-mode
77756
7d0f49cdc5da (t-mouse-mode): Improve docstring.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 77398
diff changeset
44 "Toggle t-mouse mode to use the mouse in Linux consoles.
69189
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
45 With prefix arg, turn t-mouse mode on iff arg is positive.
69185
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
46
77756
7d0f49cdc5da (t-mouse-mode): Improve docstring.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 77398
diff changeset
47 This allows the use of the mouse when operating on a Linux console, in the
7d0f49cdc5da (t-mouse-mode): Improve docstring.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 77398
diff changeset
48 same way as you can use the mouse under X11.
7d0f49cdc5da (t-mouse-mode): Improve docstring.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 77398
diff changeset
49 It requires the `mev' program, part of the `gpm' utilities."
81000
f273808d859e Reduce to a minor-mode macro call.
Nick Roberts <nickrob@snap.net.nz>
parents: 80990
diff changeset
50 :global t :group 'mouse
f273808d859e Reduce to a minor-mode macro call.
Nick Roberts <nickrob@snap.net.nz>
parents: 80990
diff changeset
51 (if window-system
f273808d859e Reduce to a minor-mode macro call.
Nick Roberts <nickrob@snap.net.nz>
parents: 80990
diff changeset
52 (error "t-mouse only works in the console on GNU/Linux")
80848
03a94cbf631a (t-mouse-mode): Do nothing on a graphical display
Nick Roberts <nickrob@snap.net.nz>
parents: 77398
diff changeset
53 (if t-mouse-mode
69189
ec62f416bd30 (t-mouse-tty): Use with-temp-buffer. Add more
Nick Roberts <nickrob@snap.net.nz>
parents: 69185
diff changeset
54 (progn
80989
ce6c8b83a99a Reduce to a minor-mode macro call.
Nick Roberts <nickrob@snap.net.nz>
parents: 80848
diff changeset
55 (unless (fboundp 'term-open-connection)
81004
74965b1ffc6f (t-mouse-mode): Reset t-mouse-mode to nil if there
Nick Roberts <nickrob@snap.net.nz>
parents: 81000
diff changeset
56 (progn
74965b1ffc6f (t-mouse-mode): Reset t-mouse-mode to nil if there
Nick Roberts <nickrob@snap.net.nz>
parents: 81000
diff changeset
57 (setq t-mouse-mode nil)
74965b1ffc6f (t-mouse-mode): Reset t-mouse-mode to nil if there
Nick Roberts <nickrob@snap.net.nz>
parents: 81000
diff changeset
58 (error "Emacs must be built with Gpm to use this mode")))
80989
ce6c8b83a99a Reduce to a minor-mode macro call.
Nick Roberts <nickrob@snap.net.nz>
parents: 80848
diff changeset
59 (unless (term-open-connection)
81004
74965b1ffc6f (t-mouse-mode): Reset t-mouse-mode to nil if there
Nick Roberts <nickrob@snap.net.nz>
parents: 81000
diff changeset
60 (progn
74965b1ffc6f (t-mouse-mode): Reset t-mouse-mode to nil if there
Nick Roberts <nickrob@snap.net.nz>
parents: 81000
diff changeset
61 (setq t-mouse-mode nil)
74965b1ffc6f (t-mouse-mode): Reset t-mouse-mode to nil if there
Nick Roberts <nickrob@snap.net.nz>
parents: 81000
diff changeset
62 (error "Can't open mouse connection"))))
80989
ce6c8b83a99a Reduce to a minor-mode macro call.
Nick Roberts <nickrob@snap.net.nz>
parents: 80848
diff changeset
63 ;; Turn it off
ce6c8b83a99a Reduce to a minor-mode macro call.
Nick Roberts <nickrob@snap.net.nz>
parents: 80848
diff changeset
64 (term-close-connection))))
69185
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
65
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
66 (provide 't-mouse)
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
67
69194
4c0f4c81c362 Add arch tagline
Miles Bader <miles@gnu.org>
parents: 69189
diff changeset
68 ;; arch-tag: a63163b3-bfbe-4eb2-ab4f-201cd164b05d
69185
ee54b3a792ff This version does *not* work with Emacs 22.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
69 ;;; t-mouse.el ends here