xemacs-beta: lisp/packages/avoid.el comparison

comparison lisp/packages/avoid.el @ 2:ac2d302a0011 r19-15b2

Import from CVS: tag r19-15b2

author	cvs
date	Mon, 13 Aug 2007 08:46:35 +0200
parents	376386a54a3c
children	9ee227acff29

comparison

equal deleted inserted replaced

-:c0c6a60d29db
+:ac2d302a0011
-;;; 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
 ;; Version: 1.10
 ;; This file is part of XEmacs.
 ;; 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 XEmacs; see the file COPYING.  If not, write to the Free
-;; Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+;; 02111-1307, USA.
-;;; Synched up with: FSF 19.28.
+;;; Synched up with: FSF 19.34.
 ;;; Commentary:
-;;;
-;;; For those who are annoyed by the mouse pointer obscuring text,
+;; For those who are annoyed by the mouse pointer obscuring text,
-;;; this mode moves the mouse pointer - either just a little out of
+;; this mode moves the mouse pointer - either just a little out of
-;;; the way, or all the way to the corner of the frame.
+;; 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 use, load or evaluate this file and type M-x mouse-avoidance-mode .
-;;; To set up permanently, put this file on your load-path and put the
+;; To set up permanently, put this file on your .emacs:
-;;; following in your .emacs:
+;;
-;;;
+;; (if window-system (mouse-avoidance-mode 'animate))
-;;; (cond (window-system
+;;
-;;;        (require 'avoid)
+;; The 'animate can be 'jump or 'banish or 'exile or 'protean if you prefer.
-;;;        (mouse-avoidance-mode 'animate)))
+;; See the documentation for function `mouse-avoidance-mode' for
-;;;
+;; details of the different modes.
-;;; The 'animate can be 'jump or 'banish or 'exile or 'protean if you prefer.
+;;
-;;; See the documentation for function `mouse-avoidance-mode' for
+;; For added silliness, make the animatee animate...
-;;; details of the different modes.
+;; put something similar to the following into your .emacs:
-;;;
+;;
-;;; For added silliness, make the animatee animate...
+;; (if window-system
-;;; put something similar to the following into your .emacs:
+;;     (mouse-avoidance-set-pointer-shape
-;;;
+;;	     (eval (nth (random 4)
-;;; (cond (window-system
+;;			'(x-pointer-man x-pointer-spider
-;;;       (setq x-pointer-shape
+;;                       x-pointer-gobbler x-pointer-gumby)))))
-;;;	     (eval (nth (random 4)
+;;
-;;;			'(x-pointer-man x-pointer-spider
+;; For completely random pointer shape, replace the setq above with:
-;;;			  x-pointer-gobbler x-pointer-gumby))))
+;; (setq x-pointer-shape (mouse-avoidance-random-shape))
-;;;       (set-mouse-color (cdr (assoc 'mouse-color (frame-parameters))))))
+;;
-;;;
+;; Bugs / Warnings / To-Do:
-;;; For completely random pointer shape, replace the setq above with:
+;;
-;;; (setq x-pointer-shape (mouse-avoidance-random-shape))
+;; - Using this code does slow emacs down.  "banish" mode shouldn't
-;;;
+;;   be too bad, and on my workstation even "animate" is reasonable.
-;;; Bugs / Warnings / To-Do:
+;;
-;;;
+;; - It ought find out where any overlapping frames are and avoid them,
-;;; - Using this code does slow emacs down.  "banish" mode shouldn't
+;;   rather than always raising the frame.
-;;;   ever be too bad though, and on my workstation even "animate" doesn't
-;;;   seem to have a noticable effect during editing.
+;; Credits:
-;;;
+;; This code was helped by all those who contributed suggestions,
-;;; - It should find out where any overlapping frames are and avoid them,
+;;   fixes, and additions
-;;;   rather than always raising the frame.
+;; Joe Harrington (and his advisor), for the original inspiration.
+;; Ken Manheimer, for dreaming up the Protean mode.
-;;; Credits:
+;; Richard Stallman, for the awful cat-and-mouse pun, among other things.
-;;; This code was helped by all those who contributed suggestions,
+;; Mike Williams, Denis Howe, Bill Benedetto, Chris Moore, Don Morris,
-;;;   fixes, and additions
+;; Simon Marshall, and M.S. Ashton, for their feedback.
-;;; 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)
 (defvar mouse-avoidance-mode nil
 ;; Internal variables
 (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:
-;; XEmacs change -- this is so ugly.
+(defsubst mouse-avoidance-set-pointer-shape (shape)
+"Set the shape of the mouse pointer to SHAPE."
+(setq x-pointer-shape shape)
+(set-mouse-color nil))
+;; XEmacs change -- this is so ugly. [FSF version is totally different -sb]
 (defun mouse-avoidance-point-position ()
 "Returns (WINDOW X . Y) of current point - analogous to mouse-position"
 (let* ((beg (window-start))
 (pos (point))
 (col (current-column))
 ;; leave the mouse where it was.  However, this is currently
 ;; difficult to do, so we just raise the frame to avoid frame switches.
 ;; Returns t if it moved the mouse.
 (let ((f (selected-frame)))
 (raise-frame f)
+;; XEmacs: FSF version of set-mouse-position requires FRAME parameter
 (set-mouse-position (frame-selected-window f) (car pos) (cdr pos))
 t))
 (defun mouse-avoidance-too-close-p (mouse)
 ;;  Return t if mouse pointer and point cursor are too close.
 (defsubst mouse-avoidance-delta (cur delta dist var min max)
 ;; Decide how far to move in either dimension.
 ;; 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)))
 	(R2 (min (- max cur) (+    dist     var))))
 (if (< R1 (- min cur)) (setq L1 nil R1 nil))
 (defun mouse-avoidance-nudge-mouse ()
 ;; Push the mouse a little way away, possibly animating the move
 ;; For these modes, state keeps track of the total offset that we've
 ;; accumulated, and tries to keep it close to zero.
 (let* ((cur (mouse-position))
+	 (cur-frame (car cur))
 	 (cur-pos (cdr cur))
 	 (deltax (mouse-avoidance-delta
 		  (car cur-pos) (- (random mouse-avoidance-nudge-var)
 				   (car mouse-avoidance-state))
 		  mouse-avoidance-nudge-dist mouse-avoidance-nudge-var
 		  0 (frame-width)))
 	 (deltay (mouse-avoidance-delta
 		  (cdr cur-pos) (- (random mouse-avoidance-nudge-var)
 				   (cdr mouse-avoidance-state))
 		  mouse-avoidance-nudge-dist mouse-avoidance-nudge-var
-		  0 (window-height))))
+		  0 (frame-height))))
 (setq mouse-avoidance-state
 	  (cons (+ (car mouse-avoidance-state) deltax)
 		(+ (cdr mouse-avoidance-state) deltay)))
 (if (or (eq mouse-avoidance-mode 'animate)
 	    (eq mouse-avoidance-mode 'proteus))
 	(let ((i 0.0)
+	      ;; XEmacs change
 	      (color (cdr (assoc 'mouse-color (frame-parameters)))))
 	  (while (<= i 1)
 	    (mouse-avoidance-set-mouse-position
 	     (cons (+ (car cur-pos) (round (* i deltax)))
 		   (+ (cdr cur-pos) (round (* i deltay)))))
 	    (setq i (+ i (max .1 (/ 1.0 mouse-avoidance-nudge-dist))))
 	    (if (eq mouse-avoidance-mode 'proteus)
+		;; XEmacs change
 		(progn
 		  (setq x-pointer-shape (mouse-avoidance-random-shape))
 		  (set-mouse-color color)))
 	    (sit-for mouse-avoidance-animation-delay)))
 (mouse-avoidance-set-mouse-position (cons (+ (car (cdr cur)) deltax)
 		    (mouse-avoidance-too-close-p mp))
 	       (setq mouse-avoidance-state mp)
 	       (mouse-avoidance-banish-mouse))
 	      ((and mouse-avoidance-state
 		    (not (mouse-avoidance-too-close-p mouse-avoidance-state)))
+	       ;; XEmacs change
 	       (if (and (eq (car mp) (if (< emacs-minor-version 12)
 					 (selected-frame)
 				       (selected-window)))
 			(equal (cdr mp) (mouse-avoidance-banish-destination)))
 		   (mouse-avoidance-set-mouse-position
 (if (and (not executing-kbd-macro)	; don't check inside macro
 	   (mouse-avoidance-kbd-command (this-command-keys))
 	   (mouse-avoidance-too-close-p (mouse-position)))
 (let ((old-pos (mouse-position)))
 	(mouse-avoidance-nudge-mouse)
+	;; XEmacs change
 	(if (not (eq (if (< emacs-minor-version 12)
 			 (selected-frame)
 		       (selected-window)) (car old-pos))) ; move went awry
 	    (set-mouse-position (car old-pos) ; sigh..
 				(car (cdr old-pos))
 	       (if (listp (aref key i))
 		   (throw 'done nil))
 	       (setq i (1+ i))))
 	   t))))
+;;;###autoload
 (defun mouse-avoidance-mode (&optional mode)
 "Set cursor avoidance mode to MODE.
 MODE should be one of the symbols `banish', `exile', `jump', `animate',
 `cat-and-mouse', `proteus', or `none'.
 		  '(("banish") ("exile") ("jump") ("animate")
 		    ("cat-and-mouse") ("proteus") ("none"))
 		  nil t))))
 (if (eq mode 'cat-and-mouse)
 (setq mode 'animate))
-(setq post-command-hook
+;; XEmacs change - We don't have post-command-idle-hook
-	(delete 'mouse-avoidance-banish-hook (append post-command-hook nil)))
+(remove-hook 'post-command-hook 'mouse-avoidance-banish-hook)
-(setq post-command-hook
+(remove-hook 'post-command-hook 'mouse-avoidance-exile-hook)
-	(delete 'mouse-avoidance-exile-hook (append post-command-hook nil)))
+(remove-hook 'post-command-hook 'mouse-avoidance-fancy-hook)
-(setq post-command-hook
+;; Restore pointer shape if necessary
-	(delete 'mouse-avoidance-fancy-hook (append post-command-hook nil)))
+(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))
+	 ;; XEmacs: we don't have post-command-idle-hook
 	 (add-hook 'post-command-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)
+	 ;; XEmacs: FSF uses post-command-idle-hook
 	 (add-hook 'post-command-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)))
+	 ;; XEmacs: FSF uses post-command-idle-hook
 	 (add-hook 'post-command-hook 'mouse-avoidance-banish-hook)
 	 (setq mouse-avoidance-mode 'banish))
 	(t (setq mouse-avoidance-mode nil)))
 (force-mode-line-update))

Mercurial > hg > xemacs-beta

comparison lisp/packages/avoid.el @ 2:ac2d302a0011 r19-15b2