Commit | Line | Data |
---|---|---|
be010748 | 1 | ;;; avoid.el --- make mouse pointer stay out of the way of editing |
bb5d4e1a | 2 | |
d9f132a8 | 3 | ;;; Copyright (C) 1993, 1994 Free Software Foundation, Inc. |
bb5d4e1a | 4 | |
7865eac6 | 5 | ;; Author: Boris Goldowsky <boris@gnu.ai.mit.edu> |
bb5d4e1a | 6 | ;; Keywords: mouse |
bb5d4e1a RS |
7 | |
8 | ;; This file is part of GNU Emacs. | |
9 | ||
10 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 | ;; it under the terms of the GNU General Public License as published by | |
12 | ;; the Free Software Foundation; either version 2, or (at your option) | |
13 | ;; any later version. | |
14 | ||
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
22 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 | ;; Boston, MA 02111-1307, USA. | |
bb5d4e1a RS |
24 | |
25 | ;;; Commentary: | |
bb5d4e1a | 26 | |
b578f267 EN |
27 | ;; For those who are annoyed by the mouse pointer obscuring text, |
28 | ;; this mode moves the mouse pointer - either just a little out of | |
29 | ;; the way, or all the way to the corner of the frame. | |
30 | ;; To use, load or evaluate this file and type M-x mouse-avoidance-mode . | |
31 | ;; To set up permanently, put the following in your .emacs: | |
32 | ;; | |
33 | ;; (if window-system (mouse-avoidance-mode 'animate)) | |
34 | ;; | |
35 | ;; The 'animate can be 'jump or 'banish or 'exile or 'protean if you prefer. | |
36 | ;; See the documentation for function `mouse-avoidance-mode' for | |
37 | ;; details of the different modes. | |
38 | ;; | |
39 | ;; For added silliness, make the animatee animate... | |
40 | ;; put something similar to the following into your .emacs: | |
41 | ;; | |
42 | ;; (if window-system | |
43 | ;; (mouse-avoidance-set-pointer-shape | |
44 | ;; (eval (nth (random 4) | |
45 | ;; '(x-pointer-man x-pointer-spider | |
46 | ;; x-pointer-gobbler x-pointer-gumby))))) | |
47 | ;; | |
48 | ;; For completely random pointer shape, replace the setq above with: | |
49 | ;; (setq x-pointer-shape (mouse-avoidance-random-shape)) | |
50 | ;; | |
51 | ;; Bugs / Warnings / To-Do: | |
52 | ;; | |
53 | ;; - Using this code does slow emacs down. "banish" mode shouldn't | |
54 | ;; be too bad, and on my workstation even "animate" is reasonable. | |
55 | ;; | |
56 | ;; - It ought to find out where any overlapping frames are and avoid them, | |
57 | ;; rather than always raising the frame. | |
58 | ||
59 | ;; Credits: | |
60 | ;; This code was helped by all those who contributed suggestions, | |
61 | ;; fixes, and additions | |
62 | ;; Joe Harrington (and his advisor), for the original inspiration. | |
63 | ;; Ken Manheimer, for dreaming up the Protean mode. | |
64 | ;; Richard Stallman, for the awful cat-and-mouse pun, among other things. | |
65 | ;; Mike Williams, Denis Howe, Bill Benedetto, Chris Moore, Don Morris, | |
66 | ;; Simon Marshall, and M.S. Ashton, for their feedback. | |
67 | ||
bb5d4e1a RS |
68 | ;;; Code: |
69 | ||
70 | (provide 'avoid) | |
71 | ||
00ed33e7 RS |
72 | (defgroup avoid nil |
73 | "Make mouse pointer stay out of the way of editing." | |
74 | :prefix "mouse-avoidance-" | |
75 | :group 'mouse) | |
76 | ||
77 | ||
bb5d4e1a RS |
78 | (defvar mouse-avoidance-mode nil |
79 | "Value is t or a symbol if the mouse pointer should avoid the cursor. | |
3f32656c RS |
80 | See function `mouse-avoidance-mode' for possible values. Changing this |
81 | variable is NOT the recommended way to change modes; use that function | |
bb5d4e1a RS |
82 | instead.") |
83 | ||
00ed33e7 | 84 | (defcustom mouse-avoidance-nudge-dist 15 |
bb5d4e1a | 85 | "*Average distance that mouse will be moved when approached by cursor. |
f87bb1ee | 86 | Only applies in mouse-avoidance-mode `jump' and its derivatives. |
00ed33e7 RS |
87 | For best results make this larger than `mouse-avoidance-threshold'." |
88 | :type 'integer | |
89 | :group 'avoid) | |
bb5d4e1a | 90 | |
00ed33e7 RS |
91 | (defcustom mouse-avoidance-nudge-var 10 |
92 | "*Variability of `mouse-avoidance-nudge-dist' (which see)." | |
93 | :type 'integer | |
94 | :group 'avoid) | |
bb5d4e1a | 95 | |
00ed33e7 RS |
96 | (defcustom mouse-avoidance-animation-delay .01 |
97 | "Delay between animation steps, in seconds." | |
98 | :type 'number | |
99 | :group 'avoid) | |
bb5d4e1a | 100 | |
00ed33e7 | 101 | (defcustom mouse-avoidance-threshold 5 |
bb5d4e1a RS |
102 | "*Mouse-pointer's flight distance. |
103 | If the cursor gets closer than this, the mouse pointer will move away. | |
00ed33e7 RS |
104 | Only applies in mouse-avoidance-modes `animate' and `jump'." |
105 | :type 'integer | |
106 | :group 'avoid) | |
bb5d4e1a | 107 | |
bdd20095 KH |
108 | ;; Internal variables |
109 | (defvar mouse-avoidance-state nil) | |
bb5d4e1a RS |
110 | (defvar mouse-avoidance-pointer-shapes nil) |
111 | (defvar mouse-avoidance-n-pointer-shapes 0) | |
5babefcf | 112 | (defvar mouse-avoidance-old-pointer-shape nil) |
bb5d4e1a RS |
113 | |
114 | ;;; Functions: | |
115 | ||
1f31a9f1 BG |
116 | (defsubst mouse-avoidance-set-pointer-shape (shape) |
117 | "Set the shape of the mouse pointer to SHAPE." | |
118 | (setq x-pointer-shape shape) | |
119 | (set-mouse-color nil)) | |
120 | ||
bdd20095 | 121 | (defun mouse-avoidance-point-position () |
3f32656c | 122 | "Return the position of point as (FRAME X . Y). |
bdd20095 KH |
123 | Analogous to mouse-position." |
124 | (let* ((w (selected-window)) | |
125 | (edges (window-edges w)) | |
126 | (list | |
96ae4787 RS |
127 | (compute-motion (max (window-start w) (point-min)) ; start pos |
128 | ;; window-start can be < point-min if the | |
129 | ;; latter has changed since the last redisplay | |
130 | '(0 . 0) ; start XY | |
bdd20095 | 131 | (point) ; stop pos |
96ae4787 | 132 | (cons (window-width) (window-height)); stop XY: none |
bdd20095 | 133 | (1- (window-width)) ; width |
96ae4787 | 134 | (cons (window-hscroll w) 0) ; 0 may not be right? |
bdd20095 KH |
135 | (selected-window)))) |
136 | ;; compute-motion returns (pos HPOS VPOS prevhpos contin) | |
137 | ;; we want: (frame hpos . vpos) | |
96ae4787 RS |
138 | (cons (selected-frame) |
139 | (cons (+ (car edges) (car (cdr list))) | |
140 | (+ (car (cdr edges)) (car (cdr (cdr list)))))))) | |
141 | ||
142 | ;(defun mouse-avoidance-point-position-test () | |
143 | ; (interactive) | |
144 | ; (message (format "point=%s mouse=%s" | |
145 | ; (cdr (mouse-avoidance-point-position)) | |
146 | ; (cdr (mouse-position))))) | |
bdd20095 KH |
147 | |
148 | (defun mouse-avoidance-set-mouse-position (pos) | |
149 | ;; Carefully set mouse position to given position (X . Y) | |
150 | ;; Ideally, should check if X,Y is in the current frame, and if not, | |
151 | ;; leave the mouse where it was. However, this is currently | |
152 | ;; difficult to do, so we just raise the frame to avoid frame switches. | |
153 | ;; Returns t if it moved the mouse. | |
154 | (let ((f (selected-frame))) | |
155 | (raise-frame f) | |
156 | (set-mouse-position f (car pos) (cdr pos)) | |
157 | t)) | |
158 | ||
159 | (defun mouse-avoidance-too-close-p (mouse) | |
bb5d4e1a | 160 | ;; Return t if mouse pointer and point cursor are too close. |
25cd2c1b | 161 | ;; Acceptable distance is defined by mouse-avoidance-threshold. |
bdd20095 KH |
162 | (let ((point (mouse-avoidance-point-position))) |
163 | (and (eq (car mouse) (car point)) | |
164 | (car (cdr mouse)) | |
165 | (< (abs (- (car (cdr mouse)) (car (cdr point)))) | |
25cd2c1b | 166 | mouse-avoidance-threshold) |
bdd20095 | 167 | (< (abs (- (cdr (cdr mouse)) (cdr (cdr point)))) |
25cd2c1b | 168 | mouse-avoidance-threshold)))) |
bb5d4e1a | 169 | |
bdd20095 | 170 | (defun mouse-avoidance-banish-destination () |
3f32656c | 171 | "The position to which mouse-avoidance-mode `banish' moves the mouse. |
bdd20095 KH |
172 | You can redefine this if you want the mouse banished to a different corner." |
173 | (cons (1- (frame-width)) | |
174 | 0)) | |
175 | ||
bb5d4e1a RS |
176 | (defun mouse-avoidance-banish-mouse () |
177 | ;; Put the mouse pointer in the upper-right corner of the current frame. | |
bdd20095 KH |
178 | (mouse-avoidance-set-mouse-position (mouse-avoidance-banish-destination))) |
179 | ||
180 | (defsubst mouse-avoidance-delta (cur delta dist var min max) | |
181 | ;; Decide how far to move in either dimension. | |
182 | ;; Args are the CURRENT location, the desired DELTA for | |
183 | ;; warp-conservation, the DISTANCE we like to move, the VARIABILITY | |
184 | ;; in distance allowed, and the MIN and MAX possible window positions. | |
a7acbbe4 | 185 | ;; Returns something as close to DELTA as possible within the constraints. |
bdd20095 KH |
186 | (let ((L1 (max (- min cur) (+ (- dist) (- var)))) |
187 | (R1 (+ (- dist) var )) | |
188 | (L2 (+ dist (- var))) | |
189 | (R2 (min (- max cur) (+ dist var)))) | |
190 | (if (< R1 (- min cur)) (setq L1 nil R1 nil)) | |
191 | (if (> L2 (- max cur)) (setq L2 nil R2 nil)) | |
192 | (cond ((and L1 (< delta L1)) L1) | |
193 | ((and R1 (< delta R1)) delta) | |
194 | ((and R1 (< delta 0)) R1) | |
195 | ((and L2 (< delta L2)) L2) | |
196 | ((and R2 (< delta R2)) delta) | |
197 | (R2) | |
198 | ((or R1 L2)) | |
199 | (t 0)))) | |
bb5d4e1a RS |
200 | |
201 | (defun mouse-avoidance-nudge-mouse () | |
202 | ;; Push the mouse a little way away, possibly animating the move | |
bdd20095 KH |
203 | ;; For these modes, state keeps track of the total offset that we've |
204 | ;; accumulated, and tries to keep it close to zero. | |
bb5d4e1a | 205 | (let* ((cur (mouse-position)) |
bdd20095 KH |
206 | (cur-frame (car cur)) |
207 | (cur-pos (cdr cur)) | |
208 | (deltax (mouse-avoidance-delta | |
209 | (car cur-pos) (- (random mouse-avoidance-nudge-var) | |
210 | (car mouse-avoidance-state)) | |
211 | mouse-avoidance-nudge-dist mouse-avoidance-nudge-var | |
212 | 0 (frame-width))) | |
213 | (deltay (mouse-avoidance-delta | |
214 | (cdr cur-pos) (- (random mouse-avoidance-nudge-var) | |
215 | (cdr mouse-avoidance-state)) | |
216 | mouse-avoidance-nudge-dist mouse-avoidance-nudge-var | |
217 | 0 (frame-height)))) | |
218 | (setq mouse-avoidance-state | |
219 | (cons (+ (car mouse-avoidance-state) deltax) | |
220 | (+ (cdr mouse-avoidance-state) deltay))) | |
bb5d4e1a RS |
221 | (if (or (eq mouse-avoidance-mode 'animate) |
222 | (eq mouse-avoidance-mode 'proteus)) | |
1f31a9f1 | 223 | (let ((i 0.0)) |
bb5d4e1a | 224 | (while (<= i 1) |
bdd20095 KH |
225 | (mouse-avoidance-set-mouse-position |
226 | (cons (+ (car cur-pos) (round (* i deltax))) | |
227 | (+ (cdr cur-pos) (round (* i deltay))))) | |
228 | (setq i (+ i (max .1 (/ 1.0 mouse-avoidance-nudge-dist)))) | |
bb5d4e1a | 229 | (if (eq mouse-avoidance-mode 'proteus) |
1f31a9f1 BG |
230 | (mouse-avoidance-set-pointer-shape |
231 | (mouse-avoidance-random-shape))) | |
bb5d4e1a | 232 | (sit-for mouse-avoidance-animation-delay))) |
3f32656c RS |
233 | (mouse-avoidance-set-mouse-position (cons (+ (car (cdr cur)) deltax) |
234 | (+ (cdr (cdr cur)) deltay)))))) | |
bb5d4e1a RS |
235 | |
236 | (defun mouse-avoidance-random-shape () | |
237 | "Return a random cursor shape. | |
238 | This assumes that any variable whose name begins with x-pointer- and | |
239 | has an integer value is a valid cursor shape. You might want to | |
240 | redefine this function to suit your own tastes." | |
241 | (if (null mouse-avoidance-pointer-shapes) | |
242 | (progn | |
243 | (setq mouse-avoidance-pointer-shapes | |
244 | (mapcar '(lambda (x) (symbol-value (intern x))) | |
245 | (all-completions "x-pointer-" obarray | |
246 | '(lambda (x) | |
247 | (and (boundp x) | |
248 | (integerp (symbol-value x))))))) | |
249 | (setq mouse-avoidance-n-pointer-shapes | |
250 | (length mouse-avoidance-pointer-shapes)))) | |
251 | (nth (random mouse-avoidance-n-pointer-shapes) | |
252 | mouse-avoidance-pointer-shapes)) | |
253 | ||
bdd20095 KH |
254 | (defun mouse-avoidance-banish-hook () |
255 | (if (and (not executing-kbd-macro) ; don't check inside macro | |
256 | (mouse-avoidance-kbd-command (this-command-keys))) | |
257 | (mouse-avoidance-banish-mouse))) | |
258 | ||
259 | (defun mouse-avoidance-exile-hook () | |
260 | ;; For exile mode, the state is nil when the mouse is in its normal | |
261 | ;; position, and set to the old mouse-position when the mouse is in exile. | |
262 | (if (and (not executing-kbd-macro) | |
263 | (mouse-avoidance-kbd-command (this-command-keys))) | |
264 | (let ((mp (mouse-position))) | |
265 | (cond ((and (not mouse-avoidance-state) | |
266 | (mouse-avoidance-too-close-p mp)) | |
267 | (setq mouse-avoidance-state mp) | |
268 | (mouse-avoidance-banish-mouse)) | |
269 | ((and mouse-avoidance-state | |
270 | (not (mouse-avoidance-too-close-p mouse-avoidance-state))) | |
271 | (if (and (eq (car mp) (selected-frame)) | |
272 | (equal (cdr mp) (mouse-avoidance-banish-destination))) | |
273 | (mouse-avoidance-set-mouse-position | |
274 | ;; move back only if user has not moved mouse | |
275 | (cdr mouse-avoidance-state))) | |
276 | ;; but clear state anyway, to be ready for another move | |
277 | (setq mouse-avoidance-state nil)))))) | |
bb5d4e1a RS |
278 | |
279 | (defun mouse-avoidance-fancy-hook () | |
bdd20095 KH |
280 | ;; Used for the "fancy" modes, ie jump et al. |
281 | (if (and (not executing-kbd-macro) ; don't check inside macro | |
282 | (mouse-avoidance-kbd-command (this-command-keys)) | |
283 | (mouse-avoidance-too-close-p (mouse-position))) | |
d9f132a8 RS |
284 | (let ((old-pos (mouse-position))) |
285 | (mouse-avoidance-nudge-mouse) | |
1f31a9f1 BG |
286 | (if (not (eq (selected-frame) (car old-pos))) |
287 | ;; This should never happen. | |
288 | (apply 'set-mouse-position old-pos))))) | |
bb5d4e1a | 289 | |
bdd20095 | 290 | (defun mouse-avoidance-kbd-command (key) |
bb5d4e1a | 291 | "Return t if the KEYSEQENCE is composed of keyboard events only. |
3f32656c | 292 | Return nil if there are any lists in the key sequence." |
bb5d4e1a RS |
293 | (cond ((null key) nil) ; Null event seems to be |
294 | ; returned occasionally. | |
295 | ((not (vectorp key)) t) ; Strings are keyboard events. | |
296 | ((catch 'done | |
297 | (let ((i 0) | |
298 | (l (length key))) | |
299 | (while (< i l) | |
300 | (if (listp (aref key i)) | |
301 | (throw 'done nil)) | |
302 | (setq i (1+ i)))) | |
303 | t)))) | |
304 | ||
1f31a9f1 | 305 | ;;;###autoload |
bb5d4e1a RS |
306 | (defun mouse-avoidance-mode (&optional mode) |
307 | "Set cursor avoidance mode to MODE. | |
bdd20095 | 308 | MODE should be one of the symbols `banish', `exile', `jump', `animate', |
d9f132a8 RS |
309 | `cat-and-mouse', `proteus', or `none'. |
310 | ||
bdd20095 | 311 | If MODE is nil, toggle mouse avoidance between `none` and `banish' |
d9f132a8 RS |
312 | modes. Positive numbers and symbols other than the above are treated |
313 | as equivalent to `banish'; negative numbers and `-' are equivalent to `none'. | |
314 | ||
315 | Effects of the different modes: | |
3f32656c RS |
316 | * banish: Move the mouse to the upper-right corner on any keypress. |
317 | * exile: Move the mouse to the corner only if the cursor gets too close, | |
bdd20095 | 318 | and allow it to return once the cursor is out of the way. |
3f32656c | 319 | * jump: If the cursor gets too close to the mouse, displace the mouse |
bdd20095 | 320 | a random distance & direction. |
3f32656c RS |
321 | * animate: As `jump', but shows steps along the way for illusion of motion. |
322 | * cat-and-mouse: Same as `animate'. | |
323 | * proteus: As `animate', but changes the shape of the mouse pointer too. | |
d9f132a8 | 324 | |
bdd20095 KH |
325 | Whenever the mouse is moved, the frame is also raised. |
326 | ||
25cd2c1b | 327 | \(see `mouse-avoidance-threshold' for definition of \"too close\", |
d9f132a8 RS |
328 | and `mouse-avoidance-nudge-dist' and `mouse-avoidance-nudge-var' for |
329 | definition of \"random distance\".)" | |
bb5d4e1a RS |
330 | (interactive |
331 | (list (intern (completing-read | |
332 | "Select cursor avoidance technique (SPACE for list): " | |
bdd20095 KH |
333 | '(("banish") ("exile") ("jump") ("animate") |
334 | ("cat-and-mouse") ("proteus") ("none")) | |
bb5d4e1a RS |
335 | nil t)))) |
336 | (if (eq mode 'cat-and-mouse) | |
337 | (setq mode 'animate)) | |
cf329c95 RS |
338 | (remove-hook 'post-command-idle-hook 'mouse-avoidance-banish-hook) |
339 | (remove-hook 'post-command-idle-hook 'mouse-avoidance-exile-hook) | |
340 | (remove-hook 'post-command-idle-hook 'mouse-avoidance-fancy-hook) | |
5babefcf RS |
341 | |
342 | ;; Restore pointer shape if necessary | |
343 | (if (eq mouse-avoidance-mode 'proteus) | |
344 | (mouse-avoidance-set-pointer-shape mouse-avoidance-old-pointer-shape)) | |
345 | ||
346 | ;; Do additional setup depending on version of mode requested | |
bb5d4e1a RS |
347 | (cond ((eq mode 'none) |
348 | (setq mouse-avoidance-mode nil)) | |
349 | ((or (eq mode 'jump) | |
350 | (eq mode 'animate) | |
351 | (eq mode 'proteus)) | |
cf329c95 | 352 | (add-hook 'post-command-idle-hook 'mouse-avoidance-fancy-hook) |
bdd20095 | 353 | (setq mouse-avoidance-mode mode |
5babefcf RS |
354 | mouse-avoidance-state (cons 0 0) |
355 | mouse-avoidance-old-pointer-shape x-pointer-shape)) | |
bdd20095 | 356 | ((eq mode 'exile) |
cf329c95 | 357 | (add-hook 'post-command-idle-hook 'mouse-avoidance-exile-hook) |
bdd20095 KH |
358 | (setq mouse-avoidance-mode mode |
359 | mouse-avoidance-state nil)) | |
bb5d4e1a RS |
360 | ((or (eq mode 'banish) |
361 | (eq mode t) | |
362 | (and (null mode) (null mouse-avoidance-mode)) | |
363 | (and mode (> (prefix-numeric-value mode) 0))) | |
cf329c95 | 364 | (add-hook 'post-command-idle-hook 'mouse-avoidance-banish-hook) |
bb5d4e1a | 365 | (setq mouse-avoidance-mode 'banish)) |
bdd20095 KH |
366 | (t (setq mouse-avoidance-mode nil))) |
367 | (force-mode-line-update)) | |
bb5d4e1a | 368 | |
ed62ad33 KH |
369 | ;; Most people who use avoid mode leave it on all the time, so it's not |
370 | ;; very informative to announce it in the mode line. | |
371 | ;;(or (assq 'mouse-avoidance-mode minor-mode-alist) | |
372 | ;; (setq minor-mode-alist (cons '(mouse-avoidance-mode " Avoid") | |
373 | ;; minor-mode-alist))) | |
bb5d4e1a RS |
374 | |
375 | ;;; End of avoid.el |