X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/970ce0d8c7347b6fff4f01bcf11324db929e2280..0925c80cd3d8f9a973d699fc1dbdbe79cca62988:/lisp/avoid.el

diff --git a/lisp/avoid.el b/lisp/avoid.el
index c931356365..e99d09d675 100644
--- a/lisp/avoid.el
+++ b/lisp/avoid.el
@@ -1,8 +1,9 @@
 ;;; avoid.el --- make mouse pointer stay out of the way of editing
 
-;;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
+;; Copyright (C) 1993, 1994, 2000, 2002, 2003, 2004,
+;;   2005 Free Software Foundation, Inc.
 
-;; Author: Boris Goldowsky <boris@gnu.ai.mit.edu>
+;; Author: Boris Goldowsky <boris@gnu.org>
 ;; Keywords: mouse
 
 ;; This file is part of GNU Emacs.
@@ -19,18 +20,18 @@
 
 ;; 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., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, 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. 
+;; 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: 
+;; To set up permanently, put the following in your .emacs:
 ;;
-;; (if window-system (mouse-avoidance-mode 'animate))
+;; (if (display-mouse-p) (mouse-avoidance-mode 'animate))
 ;;
 ;; Other legitimate alternatives include
 ;; `banish', `exile', `jump', `cat-and-mouse', and `proteus'.
@@ -41,7 +42,7 @@
 ;; For added silliness, make the animatee animate...
 ;; put something similar to the following into your .emacs:
 ;;
-;; (if window-system
+;; (if (eq window-system 'x)
 ;;     (mouse-avoidance-set-pointer-shape
 ;;	     (eval (nth (random 4)
 ;;			'(x-pointer-man x-pointer-spider
@@ -49,17 +50,17 @@
 ;;
 ;; 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
+;; - 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, 
+;; 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.
@@ -76,17 +77,17 @@
   :prefix "mouse-avoidance-"
   :group 'mouse)
 
-
+;;;###autoload
 (defcustom mouse-avoidance-mode nil
-  "Activate mouse avoidance mode.  
+  "Activate mouse avoidance mode.
 See function `mouse-avoidance-mode' for possible values.
 Setting this variable directly does not take effect;
 use either \\[customize] or the function `mouse-avoidance-mode'."
   :set (lambda (symbol value)
 	 ;; 'none below prevents toggling when value is nil.
-	 (mouse-avoidance-mode (or value 'none))) 
+	 (mouse-avoidance-mode (or value 'none)))
   :initialize 'custom-initialize-default
-  :type '(choice (const :tag "none" nil) (const banish) (const jump) 
+  :type '(choice (const :tag "none" nil) (const banish) (const jump)
 		 (const animate) (const exile) (const proteus)
 		 )
   :group 'avoid
@@ -96,7 +97,7 @@ use either \\[customize] or the function `mouse-avoidance-mode'."
 
 (defcustom mouse-avoidance-nudge-dist 15
   "*Average distance that mouse will be moved when approached by cursor.
-Only applies in mouse-avoidance-mode `jump' and its derivatives.
+Only applies in Mouse-Avoidance mode `jump' and its derivatives.
 For best results make this larger than `mouse-avoidance-threshold'."
   :type 'integer
   :group 'avoid)
@@ -131,22 +132,23 @@ Only applies in mouse-avoidance-modes `animate' and `jump'."
 
 (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))
+  (when (boundp 'x-pointer-shape)
+    (setq x-pointer-shape shape)
+    (set-mouse-color nil)))
 
 (defun mouse-avoidance-point-position ()
   "Return the position of point as (FRAME X . Y).
-Analogous to mouse-position."
+Analogous to `mouse-position'."
   (let* ((w (selected-window))
-	 (edges (window-edges w))
-	 (list 
+	 (edges (window-inside-edges w))
+	 (list
 	  (compute-motion (max (window-start w) (point-min))   ; start pos
 			  ;; window-start can be < point-min if the
-			  ;; latter has changed since the last redisplay 
+			  ;; latter has changed since the last redisplay
 			  '(0 . 0)	                       ; start XY
 			  (point)	                       ; stop pos
-			  (cons (window-width) (window-height)); stop XY: none
-			  (1- (window-width))                  ; width
+			  nil				       ; stop XY: none
+			  nil				       ; width
 			  (cons (window-hscroll w) 0)          ; 0 may not be right?
 			  (selected-window))))
     ;; compute-motion returns (pos HPOS VPOS prevhpos contin)
@@ -157,7 +159,7 @@ Analogous to mouse-position."
 
 ;(defun mouse-avoidance-point-position-test ()
 ;  (interactive)
-;  (message (format "point=%s mouse=%s" 
+;  (message (format "point=%s mouse=%s"
 ;		   (cdr (mouse-avoidance-point-position))
 ;		   (cdr (mouse-position)))))
 
@@ -171,23 +173,33 @@ Analogous to mouse-position."
     (raise-frame f)
     (set-mouse-position f (car pos) (cdr pos))
     t))
-      
+
 (defun mouse-avoidance-too-close-p (mouse)
-  ;;  Return t if mouse pointer and point cursor are too close.
-  ;; Acceptable distance is defined by mouse-avoidance-threshold.
-  (let ((point (mouse-avoidance-point-position)))
-    (and (eq (car mouse) (car point))
-	 (car (cdr mouse))
-	 (< (abs (- (car (cdr mouse)) (car (cdr point))))
-	    mouse-avoidance-threshold)
-	 (< (abs (- (cdr (cdr mouse)) (cdr (cdr point))))
-	    mouse-avoidance-threshold))))
+  "Return t if mouse pointer and point cursor are too close.
+MOUSE is the current mouse position as returned by `mouse-position'.
+Acceptable distance is defined by `mouse-avoidance-threshold'."
+  (let* ((frame (car mouse))
+	 (mouse-y (cdr (cdr mouse)))
+	 (tool-bar-lines (frame-parameter nil 'tool-bar-lines)))
+    (or tool-bar-lines
+	(setq tool-bar-lines 0))
+    (if (and mouse-y (< mouse-y tool-bar-lines))
+	nil
+      (let ((point (mouse-avoidance-point-position))
+	    (mouse-x (car (cdr mouse))))
+	(and (eq frame (car point))
+	     (not (null mouse-x))
+	     (< (abs (- mouse-x (car (cdr point))))
+		mouse-avoidance-threshold)
+	     (< (abs (- mouse-y (cdr (cdr point))))
+		mouse-avoidance-threshold))))))
 
 (defun mouse-avoidance-banish-destination ()
-  "The position to which mouse-avoidance-mode `banish' moves the mouse.
+  "The position to which Mouse-Avoidance mode `banish' moves the mouse.
 You can redefine this if you want the mouse banished to a different corner."
- (cons (1- (frame-width))
-       0))
+  (let* ((pos (window-edges)))
+    (cons (- (nth 2 pos) 2)
+	  (nth 1 pos))))
 
 (defun mouse-avoidance-banish-mouse ()
   ;; Put the mouse pointer in the upper-right corner of the current frame.
@@ -214,36 +226,41 @@ You can redefine this if you want the mouse banished to a different corner."
 	  ((or R1 L2))
 	  (t 0))))
 
-(defun mouse-avoidance-nudge-mouse () 
-  ;; Push the mouse a little way away, possibly animating the move
+(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 
+ 	 (pos (window-edges))
+ 	 (wleft (pop pos))
+ 	 (wtop (pop pos))
+ 	 (wright (pop pos))
+ 	 (wbot (pop pos))
+	 (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 
+		  wleft (1- wright)))
+	 (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 (frame-height))))
+		  wtop (1- wbot))))
     (setq mouse-avoidance-state
 	  (cons (+ (car mouse-avoidance-state) deltax)
 		(+ (cdr mouse-avoidance-state) deltay)))
-    (if (or (eq mouse-avoidance-mode 'animate) 
+    (if (or (eq mouse-avoidance-mode 'animate)
 	    (eq mouse-avoidance-mode 'proteus))
 	(let ((i 0.0))
 	  (while (<= i 1)
-	    (mouse-avoidance-set-mouse-position 
+	    (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)
-		(mouse-avoidance-set-pointer-shape 
+		(mouse-avoidance-set-pointer-shape
 		 (mouse-avoidance-random-shape)))
 	    (sit-for mouse-avoidance-animation-delay)))
       (mouse-avoidance-set-mouse-position (cons (+ (car (cdr cur)) deltax)
@@ -257,43 +274,44 @@ redefine this function to suit your own tastes."
   (if (null mouse-avoidance-pointer-shapes)
       (progn
 	(setq mouse-avoidance-pointer-shapes
-	      (mapcar '(lambda (x) (symbol-value (intern x)))
+	      (mapcar (lambda (x) (symbol-value (intern x)))
 		      (all-completions "x-pointer-" obarray
-				       '(lambda (x) 
+				       (lambda (x)
 					  (and (boundp x)
 					       (integerp (symbol-value x)))))))
-	(setq mouse-avoidance-n-pointer-shapes 
+	(setq mouse-avoidance-n-pointer-shapes
 	      (length mouse-avoidance-pointer-shapes))))
   (nth (random mouse-avoidance-n-pointer-shapes)
        mouse-avoidance-pointer-shapes))
 
+(defun mouse-avoidance-ignore-p ()
+  (let ((mp (mouse-position)))
+    (or executing-kbd-macro	       ; don't check inside macro
+	(null (cadr mp))	       ; don't move unless in an Emacs frame
+	(not (eq (car mp) (selected-frame)))
+	;; Don't do anything if last event was a mouse event.
+	;; FIXME: this code fails in the case where the mouse was moved
+	;; since the last key-press but without generating any event.
+	(and (consp last-input-event)
+	     (symbolp (car last-input-event))
+	     (let ((modifiers (event-modifiers (car last-input-event))))
+	       (or (memq (car last-input-event)
+			 '(mouse-movement scroll-bar-movement
+			   select-window switch-frame))
+		   (memq 'click modifiers)
+		   (memq 'double modifiers)
+		   (memq 'triple modifiers)
+		   (memq 'drag modifiers)
+		   (memq 'down modifiers)))))))
+
 (defun mouse-avoidance-banish-hook ()
-  (if (and (not executing-kbd-macro)	; don't check inside macro
-	   (cadr (mouse-position))      ; don't move unless in an Emacs frame
-	   ;; Don't do anything if last event was a mouse event.
-	   (not (and (consp last-input-event)
-		     (symbolp (car last-input-event))
-		     (let ((modifiers (event-modifiers (car last-input-event))))
-		       (or (memq (car last-input-event)
-				 '(mouse-movement scroll-bar-movement))
-			   (memq 'click modifiers)
-			   (memq 'drag modifiers)
-			   (memq 'down modifiers))))))
+  (if (not (mouse-avoidance-ignore-p))
       (mouse-avoidance-banish-mouse)))
 
 (defun mouse-avoidance-exile-hook ()
   ;; For exile mode, the state is nil when the mouse is in its normal
   ;; position, and set to the old mouse-position when the mouse is in exile.
-  (if (and (not executing-kbd-macro)
-	   ;; Don't do anything if last event was a mouse event.
-	   (not (and (consp last-input-event)
-		     (symbolp (car last-input-event))
-		     (let ((modifiers (event-modifiers (car last-input-event))))
-		       (or (memq (car last-input-event)
-				 '(mouse-movement scroll-bar-movement))
-			   (memq 'click modifiers)
-			   (memq 'drag modifiers)
-			   (memq 'down modifiers))))))
+  (if (not (mouse-avoidance-ignore-p))
       (let ((mp (mouse-position)))
 	(cond ((and (not mouse-avoidance-state)
 		    (mouse-avoidance-too-close-p mp))
@@ -311,16 +329,7 @@ redefine this function to suit your own tastes."
 
 (defun mouse-avoidance-fancy-hook ()
   ;; Used for the "fancy" modes, ie jump et al.
-  (if (and (not executing-kbd-macro)	; don't check inside macro
-	   ;; Don't do anything if last event was a mouse event.
-	   (not (and (consp last-input-event)
-		     (symbolp (car last-input-event))
-		     (let ((modifiers (event-modifiers (car last-input-event))))
-		       (or (memq (car last-input-event)
-				 '(mouse-movement scroll-bar-movement))
-			   (memq 'click modifiers)
-			   (memq 'drag modifiers)
-			   (memq 'down modifiers)))))
+  (if (and (not (mouse-avoidance-ignore-p))
 	   (mouse-avoidance-too-close-p (mouse-position)))
       (let ((old-pos (mouse-position)))
 	(mouse-avoidance-nudge-mouse)
@@ -334,11 +343,11 @@ redefine this function to suit your own tastes."
 MODE should be one of the symbols `banish', `exile', `jump', `animate',
 `cat-and-mouse', `proteus', or `none'.
 
-If MODE is nil, toggle mouse avoidance between `none` and `banish'
+If MODE is nil, toggle mouse avoidance between `none' and `banish'
 modes.  Positive numbers and symbols other than the above are treated
 as equivalent to `banish'; negative numbers and `-' are equivalent to `none'.
 
-Effects of the different modes: 
+Effects of the different modes:
  * banish: Move the mouse to the upper-right corner on any keypress.
  * exile: Move the mouse to the corner only if the cursor gets too close,
      and allow it to return once the cursor is out of the way.
@@ -379,13 +388,14 @@ definition of \"random distance\".)"
 	       (run-with-idle-timer 0.1 t 'mouse-avoidance-fancy-hook))
 	 (setq mouse-avoidance-mode mode
 	       mouse-avoidance-state (cons 0 0)
-	       mouse-avoidance-old-pointer-shape x-pointer-shape))
+	       mouse-avoidance-old-pointer-shape
+	       (and (boundp 'x-pointer-shape) x-pointer-shape)))
 	((eq mode 'exile)
 	 (setq mouse-avoidance-timer
 	       (run-with-idle-timer 0.1 t 'mouse-avoidance-exile-hook))
 	 (setq mouse-avoidance-mode mode
 	       mouse-avoidance-state nil))
-	((or (eq mode 'banish) 
+	((or (eq mode 'banish)
 	     (eq mode t)
 	     (and (null mode) (null mouse-avoidance-mode))
 	     (and mode (> (prefix-numeric-value mode) 0)))
@@ -402,7 +412,8 @@ definition of \"random distance\".)"
 ;;				 minor-mode-alist)))
 
 ;; Needed for custom.
-(if mouse-avoidance-mode 
+(if mouse-avoidance-mode
     (mouse-avoidance-mode mouse-avoidance-mode))
 
+;; arch-tag: 64ad4ef8-a870-4183-8d96-3aa93b7a6800
 ;;; avoid.el ends here