Add defgroup's; use defcustom for user vars.
[bpt/emacs.git] / lisp / avoid.el
index 882819f..c1bd595 100644 (file)
@@ -1,8 +1,8 @@
-;;; avoid.el -- make mouse pointer stay out of the way of editing.
+;;; avoid.el --- make mouse pointer stay out of the way of editing
 
 ;;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
 
-;; Author: Boris Goldowsky <boris@cs.rochester.edu>
+;; Author: Boris Goldowsky <boris@gnu.ai.mit.edu>
 ;; Keywords: mouse
 
 ;; This file is part of GNU Emacs.
 ;; 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, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
 
 ;;; Commentary:
-;;;
-;;; For those who are annoyed by the mouse pointer obscuring text,
-;;; this mode moves the mouse pointer - either just a little out of
-;;; the way, or all the way to the corner of the frame. 
-;;; To use, load or evaluate this file and type M-x mouse-avoidance-mode .
-;;; To set up permanently, put the following in your .emacs: 
-;;;
-;;; (if window-system (mouse-avoidance-mode 'animate))
-;;;
-;;; The 'animate can be 'jump or 'banish or 'exile or 'protean if you prefer.
-;;; See the documentation for function `mouse-avoidance-mode' for
-;;; details of the different modes.
-;;;
-;;; For added silliness, make the animatee animate...
-;;; put something similar to the following into your .emacs:
-;;;
-;;; (if window-system
-;;;     (mouse-avoidance-set-pointer-shape
-;;;         (eval (nth (random 4)
-;;;                    '(x-pointer-man x-pointer-spider
-;;;                      x-pointer-gobbler x-pointer-gumby)))))
-;;;
-;;; For completely random pointer shape, replace the setq above with:
-;;; (setq x-pointer-shape (mouse-avoidance-random-shape))
-;;; 
-;;; Bugs / Warnings / To-Do:
-;;;
-;;; - Using this code does slow emacs down.  "banish" mode shouldn't
-;;;   be too bad, and on my workstation even "animate" is reasonable.
-;;;
-;;; - It ought to find out where any overlapping frames are and avoid them,
-;;;   rather than always raising the frame.
-
-;;; Credits:
-;;; This code was helped by all those who contributed suggestions, 
-;;;   fixes, and additions
-;;; Joe Harrington (and his advisor), for the original inspiration.
-;;; Ken Manheimer, for dreaming up the Protean mode.
-;;; Richard Stallman, for the awful cat-and-mouse pun, among other things.
-;;; Mike Williams, Denis Howe, Bill Benedetto, Chris Moore, Don Morris,
-;;; Simon Marshall, and M.S. Ashton, for their feedback.
-;;;
+
+;; For those who are annoyed by the mouse pointer obscuring text,
+;; this mode moves the mouse pointer - either just a little out of
+;; the way, or all the way to the corner of the frame. 
+;; To use, load or evaluate this file and type M-x mouse-avoidance-mode .
+;; To set up permanently, put the following in your .emacs: 
+;;
+;; (if window-system (mouse-avoidance-mode 'animate))
+;;
+;; The 'animate can be 'jump or 'banish or 'exile or 'protean if you prefer.
+;; See the documentation for function `mouse-avoidance-mode' for
+;; details of the different modes.
+;;
+;; For added silliness, make the animatee animate...
+;; put something similar to the following into your .emacs:
+;;
+;; (if window-system
+;;     (mouse-avoidance-set-pointer-shape
+;;          (eval (nth (random 4)
+;;                     '(x-pointer-man x-pointer-spider
+;;                       x-pointer-gobbler x-pointer-gumby)))))
+;;
+;; For completely random pointer shape, replace the setq above with:
+;; (setq x-pointer-shape (mouse-avoidance-random-shape))
+;; 
+;; Bugs / Warnings / To-Do:
+;;
+;; - Using this code does slow emacs down.  "banish" mode shouldn't
+;;   be too bad, and on my workstation even "animate" is reasonable.
+;;
+;; - It ought to find out where any overlapping frames are and avoid them,
+;;   rather than always raising the frame.
+
+;; Credits:
+;; This code was helped by all those who contributed suggestions, 
+;;   fixes, and additions
+;; Joe Harrington (and his advisor), for the original inspiration.
+;; Ken Manheimer, for dreaming up the Protean mode.
+;; Richard Stallman, for the awful cat-and-mouse pun, among other things.
+;; Mike Williams, Denis Howe, Bill Benedetto, Chris Moore, Don Morris,
+;; Simon Marshall, and M.S. Ashton, for their feedback.
+
 ;;; Code:
 
 (provide 'avoid)
@@ -94,6 +95,7 @@ Only applies in mouse-avoidance-modes `animate' and `jump'.")
 (defvar mouse-avoidance-state nil)
 (defvar mouse-avoidance-pointer-shapes nil)
 (defvar mouse-avoidance-n-pointer-shapes 0)
+(defvar mouse-avoidance-old-pointer-shape nil)
 
 ;;; Functions:
 
@@ -166,7 +168,7 @@ You can redefine this if you want the mouse banished to a different corner."
   ;; Args are the CURRENT location, the desired DELTA for
   ;; warp-conservation, the DISTANCE we like to move, the VARIABILITY
   ;; in distance allowed, and the MIN and MAX possible window positions.
-  ;; Returns something as close to DELTA as possible withing the constraints.
+  ;; Returns something as close to DELTA as possible within the constraints.
   (let ((L1 (max (- min cur) (+ (- dist) (- var))))
        (R1                  (+ (- dist)    var ))
        (L2                  (+    dist  (- var)))
@@ -319,35 +321,41 @@ definition of \"random distance\".)"
                  nil t))))
   (if (eq mode 'cat-and-mouse)
       (setq mode 'animate))
-  (setq post-command-hook
-       (delete 'mouse-avoidance-banish-hook (append post-command-hook nil)))
-  (setq post-command-hook
-       (delete 'mouse-avoidance-exile-hook (append post-command-hook nil)))
-  (setq post-command-hook
-       (delete 'mouse-avoidance-fancy-hook (append post-command-hook nil)))
+  (remove-hook 'post-command-idle-hook 'mouse-avoidance-banish-hook)
+  (remove-hook 'post-command-idle-hook 'mouse-avoidance-exile-hook)
+  (remove-hook 'post-command-idle-hook 'mouse-avoidance-fancy-hook)
+
+  ;; Restore pointer shape if necessary
+  (if (eq mouse-avoidance-mode 'proteus)
+      (mouse-avoidance-set-pointer-shape mouse-avoidance-old-pointer-shape))
+
+  ;; Do additional setup depending on version of mode requested
   (cond        ((eq mode 'none)
         (setq mouse-avoidance-mode nil))
        ((or (eq mode 'jump)
             (eq mode 'animate)
             (eq mode 'proteus))
-        (add-hook 'post-command-hook 'mouse-avoidance-fancy-hook)
+        (add-hook 'post-command-idle-hook 'mouse-avoidance-fancy-hook)
         (setq mouse-avoidance-mode mode
-              mouse-avoidance-state (cons 0 0)))
+              mouse-avoidance-state (cons 0 0)
+              mouse-avoidance-old-pointer-shape x-pointer-shape))
        ((eq mode 'exile)
-        (add-hook 'post-command-hook 'mouse-avoidance-exile-hook)
+        (add-hook 'post-command-idle-hook 'mouse-avoidance-exile-hook)
         (setq mouse-avoidance-mode mode
               mouse-avoidance-state nil))
        ((or (eq mode 'banish) 
             (eq mode t)
             (and (null mode) (null mouse-avoidance-mode))
             (and mode (> (prefix-numeric-value mode) 0)))
-        (add-hook 'post-command-hook 'mouse-avoidance-banish-hook)
+        (add-hook 'post-command-idle-hook 'mouse-avoidance-banish-hook)
         (setq mouse-avoidance-mode 'banish))
        (t (setq mouse-avoidance-mode nil)))
   (force-mode-line-update))
 
-(or (assq 'mouse-avoidance-mode minor-mode-alist)
-    (setq minor-mode-alist (cons '(mouse-avoidance-mode " Avoid")
-                                minor-mode-alist)))
+;; Most people who use avoid mode leave it on all the time, so it's not
+;; very informative to announce it in the mode line.
+;;(or (assq 'mouse-avoidance-mode minor-mode-alist)
+;;    (setq minor-mode-alist (cons '(mouse-avoidance-mode " Avoid")
+;;                              minor-mode-alist)))
 
 ;;; End of avoid.el