emacs/lisp/t-mouse.el

;;; t-mouse.el --- mouse support within the text terminal

;; Author: Nick Roberts <nickrob@gnu.org>
;; Maintainer: FSF
;; Keywords: mouse gpm linux

;; Copyright (C) 1994, 1995, 1998, 2006, 2007 Free Software Foundation, Inc.

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; Commentary:

;; This package provides access to mouse event as reported by the gpm-Linux
;; package. It tries to reproduce the functionality offered by Emacs under X.
;; The "gpm" server runs under Linux, so this package is rather
;; Linux-dependent.

;; The file, t-mouse was originally written by Alessandro Rubini and Ian T
;; Zimmerman and communicated with Emacs through the client program mev.  Now
;; the interface with gpm is directly through a Unix socket, so this file is
;; reduced to a minor mode macro call.

;; 

;;; Code:

;;;###autoload
(define-minor-mode t-mouse-mode
  "Toggle t-mouse mode to use the mouse in Linux consoles.
With prefix arg, turn t-mouse mode on iff arg is positive.

This allows the use of the mouse when operating on a Linux console, in the
same way as you can use the mouse under X11.
It requires the `mev' program, part of the `gpm' utilities."
  nil " Mouse" nil :global t
  (unless window-system
    (if t-mouse-mode
	(progn
	  (unless (fboundp 'term-open-connection)
	    (error "Emacs must be built with Gpm to use this mode"))
	  (unless (term-open-connection)
	    (error "Can't open mouse connection")))
      ;; Turn it off
      (term-close-connection))))

(provide 't-mouse)

;; arch-tag: a63163b3-bfbe-4eb2-ab4f-201cd164b05d
;;; t-mouse.el ends here
-												This version does *not* work with Emacs 22.
It is just the initial import from gpm-1.20.1.

											
										
										
											2006-02-27 22:10:43 +00:00
+								;;; t-mouse.el --- mouse support within the text terminal
-												Reduce to a minor-mode macro call.

											
										
										
											2007-05-20 02:52:46 +00:00
+								;; Author: Nick Roberts <nickrob@gnu.org>
 								;; Maintainer: FSF
-												This version does *not* work with Emacs 22.
It is just the initial import from gpm-1.20.1.

											
										
										
											2006-02-27 22:10:43 +00:00
+								;; Keywords: mouse gpm linux
-												Update copyright following assignment by
Alessandro Rubini.

											
										
										
											2007-01-20 08:08:33 +00:00
+								;; Copyright (C) 1994, 1995, 1998, 2006, 2007 Free Software Foundation, Inc.
-												(t-mouse-tty): Use with-temp-buffer.  Add more
terminal types.
(t-mouse-lispy-buffer-posn-from-coords): Remove.  Use C
primitive...
(t-mouse-make-event-element): ...posn-at-x-y instead.
(t-mouse-make-event): Deal with Fedora Core 3.
(t-mouse-make-event): Don't sink the `stupid text mode menubar'.
(t-mouse-mouse-position-function): New function.  Use it instead
of advising mouse-position.
(t-mouse-mode): New minor mode.
(t-mouse-stop, t-mouse-run): Remove.  Use t-mouse-mode instead.

											
										
										
											2006-02-27 22:46:06 +00:00
 								;; This file is part of GNU Emacs.
 								;; GNU Emacs is free software; you can redistribute it and/or modify
 								;; it under the terms of the GNU General Public License as published by
 								;; the Free Software Foundation; either version 2, or (at your option)
 								;; any later version.
 								;; GNU Emacs is distributed in the hope that it will be useful,
 								;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 								;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 								;; GNU General Public License for more details.
-												This version does *not* work with Emacs 22.
It is just the initial import from gpm-1.20.1.

											
										
										
											2006-02-27 22:10:43 +00:00
-												(t-mouse-tty): Use with-temp-buffer.  Add more
terminal types.
(t-mouse-lispy-buffer-posn-from-coords): Remove.  Use C
primitive...
(t-mouse-make-event-element): ...posn-at-x-y instead.
(t-mouse-make-event): Deal with Fedora Core 3.
(t-mouse-make-event): Don't sink the `stupid text mode menubar'.
(t-mouse-mouse-position-function): New function.  Use it instead
of advising mouse-position.
(t-mouse-mode): New minor mode.
(t-mouse-stop, t-mouse-run): Remove.  Use t-mouse-mode instead.

											
										
										
											2006-02-27 22:46:06 +00:00
+								;; You should have received a copy of the GNU General Public License
 								;; along with GNU Emacs; see the file COPYING.  If not, write to the
 								;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 								;; Boston, MA 02110-1301, USA.
-												This version does *not* work with Emacs 22.
It is just the initial import from gpm-1.20.1.

											
										
										
											2006-02-27 22:10:43 +00:00
 								;;; Commentary:
-												Reduce to a minor-mode macro call.

											
										
										
											2007-05-20 02:52:46 +00:00
+								;; This package provides access to mouse event as reported by the gpm-Linux
 								;; package. It tries to reproduce the functionality offered by Emacs under X.
-												This version does *not* work with Emacs 22.
It is just the initial import from gpm-1.20.1.

											
										
										
											2006-02-27 22:10:43 +00:00
+								;; The "gpm" server runs under Linux, so this package is rather
 								;; Linux-dependent.
-												Reduce to a minor-mode macro call.

											
										
										
											2007-05-20 02:52:46 +00:00
+								;; The file, t-mouse was originally written by Alessandro Rubini and Ian T
 								;; Zimmerman and communicated with Emacs through the client program mev.  Now
 								;; the interface with gpm is directly through a Unix socket, so this file is
 								;; reduced to a minor mode macro call.
-												This version does *not* work with Emacs 22.
It is just the initial import from gpm-1.20.1.

											
										
										
											2006-02-27 22:10:43 +00:00
-												Reduce to a minor-mode macro call.

											
										
										
											2007-05-20 02:52:46 +00:00
+								;;
-												This version does *not* work with Emacs 22.
It is just the initial import from gpm-1.20.1.

											
										
										
											2006-02-27 22:10:43 +00:00
 								;;; Code:
-												(t-mouse-tty): Use with-temp-buffer.  Add more
terminal types.
(t-mouse-lispy-buffer-posn-from-coords): Remove.  Use C
primitive...
(t-mouse-make-event-element): ...posn-at-x-y instead.
(t-mouse-make-event): Deal with Fedora Core 3.
(t-mouse-make-event): Don't sink the `stupid text mode menubar'.
(t-mouse-mouse-position-function): New function.  Use it instead
of advising mouse-position.
(t-mouse-mode): New minor mode.
(t-mouse-stop, t-mouse-run): Remove.  Use t-mouse-mode instead.

											
										
										
											2006-02-27 22:46:06 +00:00
+								;;;###autoload
 								(define-minor-mode t-mouse-mode
-												(t-mouse-mode): Improve docstring.

											
										
										
											2007-05-19 14:00:15 +00:00
+								  "Toggle t-mouse mode to use the mouse in Linux consoles.
-												(t-mouse-tty): Use with-temp-buffer.  Add more
terminal types.
(t-mouse-lispy-buffer-posn-from-coords): Remove.  Use C
primitive...
(t-mouse-make-event-element): ...posn-at-x-y instead.
(t-mouse-make-event): Deal with Fedora Core 3.
(t-mouse-make-event): Don't sink the `stupid text mode menubar'.
(t-mouse-mouse-position-function): New function.  Use it instead
of advising mouse-position.
(t-mouse-mode): New minor mode.
(t-mouse-stop, t-mouse-run): Remove.  Use t-mouse-mode instead.

											
										
										
											2006-02-27 22:46:06 +00:00
+								With prefix arg, turn t-mouse mode on iff arg is positive.
-												(t-mouse-mode): Improve docstring.

											
										
										
											2007-05-19 14:00:15 +00:00
+								This allows the use of the mouse when operating on a Linux console, in the
 								same way as you can use the mouse under X11.
 								It requires the `mev' program, part of the `gpm' utilities."
-												(t-mouse-tty): Use with-temp-buffer.  Add more
terminal types.
(t-mouse-lispy-buffer-posn-from-coords): Remove.  Use C
primitive...
(t-mouse-make-event-element): ...posn-at-x-y instead.
(t-mouse-make-event): Deal with Fedora Core 3.
(t-mouse-make-event): Don't sink the `stupid text mode menubar'.
(t-mouse-mouse-position-function): New function.  Use it instead
of advising mouse-position.
(t-mouse-mode): New minor mode.
(t-mouse-stop, t-mouse-run): Remove.  Use t-mouse-mode instead.

											
										
										
											2006-02-27 22:46:06 +00:00
+								  nil " Mouse" nil :global t
-												(t-mouse-mode): Do nothing on a graphical display
when disabling t-mouse-mode.

											
										
										
											2007-05-04 02:26:14 +00:00
+								  (unless window-system
 								    (if t-mouse-mode
-												(t-mouse-tty): Use with-temp-buffer.  Add more
terminal types.
(t-mouse-lispy-buffer-posn-from-coords): Remove.  Use C
primitive...
(t-mouse-make-event-element): ...posn-at-x-y instead.
(t-mouse-make-event): Deal with Fedora Core 3.
(t-mouse-make-event): Don't sink the `stupid text mode menubar'.
(t-mouse-mouse-position-function): New function.  Use it instead
of advising mouse-position.
(t-mouse-mode): New minor mode.
(t-mouse-stop, t-mouse-run): Remove.  Use t-mouse-mode instead.

											
										
										
											2006-02-27 22:46:06 +00:00
+									(progn
-												Reduce to a minor-mode macro call.

											
										
										
											2007-05-20 02:52:46 +00:00
+									  (unless (fboundp 'term-open-connection)
 									    (error "Emacs must be built with Gpm to use this mode"))
 									  (unless (term-open-connection)
 									    (error "Can't open mouse connection")))
 								      ;; Turn it off
 								      (term-close-connection))))
-												This version does *not* work with Emacs 22.
It is just the initial import from gpm-1.20.1.

											
										
										
											2006-02-27 22:10:43 +00:00
 								(provide 't-mouse)
-												Add arch tagline

											
										
										
											2006-02-27 23:40:51 +00:00
+								;; arch-tag: a63163b3-bfbe-4eb2-ab4f-201cd164b05d
-												This version does *not* work with Emacs 22.
It is just the initial import from gpm-1.20.1.

											
										
										
											2006-02-27 22:10:43 +00:00
+								;;; t-mouse.el ends here