Mercurial > emacs
annotate lisp/avoid.el @ 20876:c80b908e5af5
(compute_motion): If right margin is reached and we are
truncating don't clobber PREV_HPOS if we are already past TO.
author | Andreas Schwab <schwab@suse.de> |
---|---|
date | Mon, 09 Feb 1998 11:16:35 +0000 |
parents | efafba146bb5 |
children | c87385403522 |
rev | line source |
---|---|
13337 | 1 ;;; avoid.el --- make mouse pointer stay out of the way of editing |
5119 | 2 |
5745 | 3 ;;; Copyright (C) 1993, 1994 Free Software Foundation, Inc. |
5119 | 4 |
12082
257af4819582
Change email address for Boris.
Boris Goldowsky <boris@gnu.org>
parents:
11269
diff
changeset
|
5 ;; Author: Boris Goldowsky <boris@gnu.ai.mit.edu> |
5119 | 6 ;; Keywords: mouse |
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 | |
14169 | 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. | |
5119 | 24 |
25 ;;; Commentary: | |
26 | |
14169 | 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 ;; | |
20512
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
35 ;; Other legitimate alternatives include |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
36 ;; `banish', `exile', `jump', `cat-and-mouse', and `proteus'. |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
37 ;; They do somewhat different things. |
14169 | 38 ;; See the documentation for function `mouse-avoidance-mode' for |
39 ;; details of the different modes. | |
40 ;; | |
41 ;; For added silliness, make the animatee animate... | |
42 ;; put something similar to the following into your .emacs: | |
43 ;; | |
44 ;; (if window-system | |
45 ;; (mouse-avoidance-set-pointer-shape | |
46 ;; (eval (nth (random 4) | |
47 ;; '(x-pointer-man x-pointer-spider | |
48 ;; x-pointer-gobbler x-pointer-gumby))))) | |
49 ;; | |
50 ;; For completely random pointer shape, replace the setq above with: | |
51 ;; (setq x-pointer-shape (mouse-avoidance-random-shape)) | |
52 ;; | |
53 ;; Bugs / Warnings / To-Do: | |
54 ;; | |
55 ;; - Using this code does slow emacs down. "banish" mode shouldn't | |
56 ;; be too bad, and on my workstation even "animate" is reasonable. | |
57 ;; | |
58 ;; - It ought to find out where any overlapping frames are and avoid them, | |
59 ;; rather than always raising the frame. | |
60 | |
61 ;; Credits: | |
62 ;; This code was helped by all those who contributed suggestions, | |
63 ;; fixes, and additions | |
64 ;; Joe Harrington (and his advisor), for the original inspiration. | |
65 ;; Ken Manheimer, for dreaming up the Protean mode. | |
66 ;; Richard Stallman, for the awful cat-and-mouse pun, among other things. | |
67 ;; Mike Williams, Denis Howe, Bill Benedetto, Chris Moore, Don Morris, | |
68 ;; Simon Marshall, and M.S. Ashton, for their feedback. | |
69 | |
5119 | 70 ;;; Code: |
71 | |
72 (provide 'avoid) | |
73 | |
17436
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
74 (defgroup avoid nil |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
75 "Make mouse pointer stay out of the way of editing." |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
76 :prefix "mouse-avoidance-" |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
77 :group 'mouse) |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
78 |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
79 |
20512
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
80 (defcustom mouse-avoidance-mode nil |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
81 "Activate mouse avoidance mode. |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
82 See function `mouse-avoidance-mode' for possible values. |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
83 You must modify via \\[customize] for this variable to have an effect." |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
84 :set (lambda (symbol value) |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
85 ;; 'none below prevents toggling when value is nil. |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
86 (mouse-avoidance-mode (or value 'none))) |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
87 :initialize 'custom-initialize-default |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
88 :type '(choice (const :tag "none" nil) (const banish) (const jump) |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
89 (const animate) (const exile) (const proteus) |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
90 ) |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
91 :group 'avoid |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
92 :require 'avoid) |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
93 |
5119 | 94 |
17436
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
95 (defcustom mouse-avoidance-nudge-dist 15 |
5119 | 96 "*Average distance that mouse will be moved when approached by cursor. |
7571
d0c9af68a5ba
(mouse-avoidance-nudge-dist): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
7556
diff
changeset
|
97 Only applies in mouse-avoidance-mode `jump' and its derivatives. |
17436
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
98 For best results make this larger than `mouse-avoidance-threshold'." |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
99 :type 'integer |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
100 :group 'avoid) |
5119 | 101 |
17436
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
102 (defcustom mouse-avoidance-nudge-var 10 |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
103 "*Variability of `mouse-avoidance-nudge-dist' (which see)." |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
104 :type 'integer |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
105 :group 'avoid) |
5119 | 106 |
17436
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
107 (defcustom mouse-avoidance-animation-delay .01 |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
108 "Delay between animation steps, in seconds." |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
109 :type 'number |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
110 :group 'avoid) |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
111 |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
112 (defcustom mouse-avoidance-threshold 5 |
5119 | 113 "*Mouse-pointer's flight distance. |
114 If the cursor gets closer than this, the mouse pointer will move away. | |
17436
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
115 Only applies in mouse-avoidance-modes `animate' and `jump'." |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
116 :type 'integer |
2a9fdbfcb993
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17067
diff
changeset
|
117 :group 'avoid) |
5119 | 118 |
7015 | 119 ;; Internal variables |
120 (defvar mouse-avoidance-state nil) | |
5119 | 121 (defvar mouse-avoidance-pointer-shapes nil) |
122 (defvar mouse-avoidance-n-pointer-shapes 0) | |
14897
9cce31ba2d61
(mouse-avoidance-old-pointer-shape): New vbl.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
123 (defvar mouse-avoidance-old-pointer-shape nil) |
5119 | 124 |
19323
b686f7cb6849
(mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
17436
diff
changeset
|
125 ;; This timer is used to run something when Emacs is idle. |
b686f7cb6849
(mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
17436
diff
changeset
|
126 (defvar mouse-avoidance-timer nil) |
b686f7cb6849
(mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
17436
diff
changeset
|
127 |
5119 | 128 ;;; Functions: |
129 | |
11269
26d830b04546
avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents:
7879
diff
changeset
|
130 (defsubst mouse-avoidance-set-pointer-shape (shape) |
26d830b04546
avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents:
7879
diff
changeset
|
131 "Set the shape of the mouse pointer to SHAPE." |
26d830b04546
avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents:
7879
diff
changeset
|
132 (setq x-pointer-shape shape) |
26d830b04546
avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents:
7879
diff
changeset
|
133 (set-mouse-color nil)) |
26d830b04546
avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents:
7879
diff
changeset
|
134 |
7015 | 135 (defun mouse-avoidance-point-position () |
7556 | 136 "Return the position of point as (FRAME X . Y). |
7015 | 137 Analogous to mouse-position." |
138 (let* ((w (selected-window)) | |
139 (edges (window-edges w)) | |
140 (list | |
7849
bbc7770db51c
(mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents:
7571
diff
changeset
|
141 (compute-motion (max (window-start w) (point-min)) ; start pos |
bbc7770db51c
(mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents:
7571
diff
changeset
|
142 ;; window-start can be < point-min if the |
bbc7770db51c
(mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents:
7571
diff
changeset
|
143 ;; latter has changed since the last redisplay |
bbc7770db51c
(mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents:
7571
diff
changeset
|
144 '(0 . 0) ; start XY |
7015 | 145 (point) ; stop pos |
7849
bbc7770db51c
(mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents:
7571
diff
changeset
|
146 (cons (window-width) (window-height)); stop XY: none |
7015 | 147 (1- (window-width)) ; width |
7849
bbc7770db51c
(mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents:
7571
diff
changeset
|
148 (cons (window-hscroll w) 0) ; 0 may not be right? |
7015 | 149 (selected-window)))) |
150 ;; compute-motion returns (pos HPOS VPOS prevhpos contin) | |
151 ;; we want: (frame hpos . vpos) | |
7849
bbc7770db51c
(mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents:
7571
diff
changeset
|
152 (cons (selected-frame) |
bbc7770db51c
(mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents:
7571
diff
changeset
|
153 (cons (+ (car edges) (car (cdr list))) |
bbc7770db51c
(mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents:
7571
diff
changeset
|
154 (+ (car (cdr edges)) (car (cdr (cdr list)))))))) |
bbc7770db51c
(mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents:
7571
diff
changeset
|
155 |
bbc7770db51c
(mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents:
7571
diff
changeset
|
156 ;(defun mouse-avoidance-point-position-test () |
bbc7770db51c
(mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents:
7571
diff
changeset
|
157 ; (interactive) |
bbc7770db51c
(mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents:
7571
diff
changeset
|
158 ; (message (format "point=%s mouse=%s" |
bbc7770db51c
(mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents:
7571
diff
changeset
|
159 ; (cdr (mouse-avoidance-point-position)) |
bbc7770db51c
(mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents:
7571
diff
changeset
|
160 ; (cdr (mouse-position))))) |
7015 | 161 |
162 (defun mouse-avoidance-set-mouse-position (pos) | |
163 ;; Carefully set mouse position to given position (X . Y) | |
164 ;; Ideally, should check if X,Y is in the current frame, and if not, | |
165 ;; leave the mouse where it was. However, this is currently | |
166 ;; difficult to do, so we just raise the frame to avoid frame switches. | |
167 ;; Returns t if it moved the mouse. | |
168 (let ((f (selected-frame))) | |
169 (raise-frame f) | |
170 (set-mouse-position f (car pos) (cdr pos)) | |
171 t)) | |
172 | |
173 (defun mouse-avoidance-too-close-p (mouse) | |
5119 | 174 ;; Return t if mouse pointer and point cursor are too close. |
7879
e0f3cfb55df7
(mouse-avoidance-threshold): Renamed from ...threshhold.
Richard M. Stallman <rms@gnu.org>
parents:
7849
diff
changeset
|
175 ;; Acceptable distance is defined by mouse-avoidance-threshold. |
7015 | 176 (let ((point (mouse-avoidance-point-position))) |
177 (and (eq (car mouse) (car point)) | |
178 (car (cdr mouse)) | |
179 (< (abs (- (car (cdr mouse)) (car (cdr point)))) | |
7879
e0f3cfb55df7
(mouse-avoidance-threshold): Renamed from ...threshhold.
Richard M. Stallman <rms@gnu.org>
parents:
7849
diff
changeset
|
180 mouse-avoidance-threshold) |
7015 | 181 (< (abs (- (cdr (cdr mouse)) (cdr (cdr point)))) |
7879
e0f3cfb55df7
(mouse-avoidance-threshold): Renamed from ...threshhold.
Richard M. Stallman <rms@gnu.org>
parents:
7849
diff
changeset
|
182 mouse-avoidance-threshold)))) |
5119 | 183 |
7015 | 184 (defun mouse-avoidance-banish-destination () |
7556 | 185 "The position to which mouse-avoidance-mode `banish' moves the mouse. |
7015 | 186 You can redefine this if you want the mouse banished to a different corner." |
187 (cons (1- (frame-width)) | |
188 0)) | |
189 | |
5119 | 190 (defun mouse-avoidance-banish-mouse () |
191 ;; Put the mouse pointer in the upper-right corner of the current frame. | |
7015 | 192 (mouse-avoidance-set-mouse-position (mouse-avoidance-banish-destination))) |
193 | |
194 (defsubst mouse-avoidance-delta (cur delta dist var min max) | |
195 ;; Decide how far to move in either dimension. | |
196 ;; Args are the CURRENT location, the desired DELTA for | |
197 ;; warp-conservation, the DISTANCE we like to move, the VARIABILITY | |
198 ;; in distance allowed, and the MIN and MAX possible window positions. | |
14040 | 199 ;; Returns something as close to DELTA as possible within the constraints. |
7015 | 200 (let ((L1 (max (- min cur) (+ (- dist) (- var)))) |
201 (R1 (+ (- dist) var )) | |
202 (L2 (+ dist (- var))) | |
203 (R2 (min (- max cur) (+ dist var)))) | |
204 (if (< R1 (- min cur)) (setq L1 nil R1 nil)) | |
205 (if (> L2 (- max cur)) (setq L2 nil R2 nil)) | |
206 (cond ((and L1 (< delta L1)) L1) | |
207 ((and R1 (< delta R1)) delta) | |
208 ((and R1 (< delta 0)) R1) | |
209 ((and L2 (< delta L2)) L2) | |
210 ((and R2 (< delta R2)) delta) | |
211 (R2) | |
212 ((or R1 L2)) | |
213 (t 0)))) | |
5119 | 214 |
215 (defun mouse-avoidance-nudge-mouse () | |
216 ;; Push the mouse a little way away, possibly animating the move | |
7015 | 217 ;; For these modes, state keeps track of the total offset that we've |
218 ;; accumulated, and tries to keep it close to zero. | |
5119 | 219 (let* ((cur (mouse-position)) |
7015 | 220 (cur-frame (car cur)) |
221 (cur-pos (cdr cur)) | |
222 (deltax (mouse-avoidance-delta | |
223 (car cur-pos) (- (random mouse-avoidance-nudge-var) | |
224 (car mouse-avoidance-state)) | |
225 mouse-avoidance-nudge-dist mouse-avoidance-nudge-var | |
226 0 (frame-width))) | |
227 (deltay (mouse-avoidance-delta | |
228 (cdr cur-pos) (- (random mouse-avoidance-nudge-var) | |
229 (cdr mouse-avoidance-state)) | |
230 mouse-avoidance-nudge-dist mouse-avoidance-nudge-var | |
231 0 (frame-height)))) | |
232 (setq mouse-avoidance-state | |
233 (cons (+ (car mouse-avoidance-state) deltax) | |
234 (+ (cdr mouse-avoidance-state) deltay))) | |
5119 | 235 (if (or (eq mouse-avoidance-mode 'animate) |
236 (eq mouse-avoidance-mode 'proteus)) | |
11269
26d830b04546
avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents:
7879
diff
changeset
|
237 (let ((i 0.0)) |
5119 | 238 (while (<= i 1) |
7015 | 239 (mouse-avoidance-set-mouse-position |
240 (cons (+ (car cur-pos) (round (* i deltax))) | |
241 (+ (cdr cur-pos) (round (* i deltay))))) | |
242 (setq i (+ i (max .1 (/ 1.0 mouse-avoidance-nudge-dist)))) | |
5119 | 243 (if (eq mouse-avoidance-mode 'proteus) |
11269
26d830b04546
avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents:
7879
diff
changeset
|
244 (mouse-avoidance-set-pointer-shape |
26d830b04546
avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents:
7879
diff
changeset
|
245 (mouse-avoidance-random-shape))) |
5119 | 246 (sit-for mouse-avoidance-animation-delay))) |
7556 | 247 (mouse-avoidance-set-mouse-position (cons (+ (car (cdr cur)) deltax) |
248 (+ (cdr (cdr cur)) deltay)))))) | |
5119 | 249 |
250 (defun mouse-avoidance-random-shape () | |
251 "Return a random cursor shape. | |
252 This assumes that any variable whose name begins with x-pointer- and | |
253 has an integer value is a valid cursor shape. You might want to | |
254 redefine this function to suit your own tastes." | |
255 (if (null mouse-avoidance-pointer-shapes) | |
256 (progn | |
257 (setq mouse-avoidance-pointer-shapes | |
258 (mapcar '(lambda (x) (symbol-value (intern x))) | |
259 (all-completions "x-pointer-" obarray | |
260 '(lambda (x) | |
261 (and (boundp x) | |
262 (integerp (symbol-value x))))))) | |
263 (setq mouse-avoidance-n-pointer-shapes | |
264 (length mouse-avoidance-pointer-shapes)))) | |
265 (nth (random mouse-avoidance-n-pointer-shapes) | |
266 mouse-avoidance-pointer-shapes)) | |
267 | |
7015 | 268 (defun mouse-avoidance-banish-hook () |
269 (if (and (not executing-kbd-macro) ; don't check inside macro | |
20858
efafba146bb5
(mouse-avoidance-fancy-hook): Do nothing if button is down.
Richard M. Stallman <rms@gnu.org>
parents:
20512
diff
changeset
|
270 ;; Don't check while mouse is down. |
efafba146bb5
(mouse-avoidance-fancy-hook): Do nothing if button is down.
Richard M. Stallman <rms@gnu.org>
parents:
20512
diff
changeset
|
271 (not (and (consp last-input-event) |
efafba146bb5
(mouse-avoidance-fancy-hook): Do nothing if button is down.
Richard M. Stallman <rms@gnu.org>
parents:
20512
diff
changeset
|
272 (symbolp (car last-input-event)) |
efafba146bb5
(mouse-avoidance-fancy-hook): Do nothing if button is down.
Richard M. Stallman <rms@gnu.org>
parents:
20512
diff
changeset
|
273 (memq 'down (event-modifiers (car last-input-event))))) |
7015 | 274 (mouse-avoidance-kbd-command (this-command-keys))) |
275 (mouse-avoidance-banish-mouse))) | |
276 | |
277 (defun mouse-avoidance-exile-hook () | |
278 ;; For exile mode, the state is nil when the mouse is in its normal | |
279 ;; position, and set to the old mouse-position when the mouse is in exile. | |
280 (if (and (not executing-kbd-macro) | |
20858
efafba146bb5
(mouse-avoidance-fancy-hook): Do nothing if button is down.
Richard M. Stallman <rms@gnu.org>
parents:
20512
diff
changeset
|
281 (not (and (consp last-input-event) |
efafba146bb5
(mouse-avoidance-fancy-hook): Do nothing if button is down.
Richard M. Stallman <rms@gnu.org>
parents:
20512
diff
changeset
|
282 (symbolp (car last-input-event)) |
efafba146bb5
(mouse-avoidance-fancy-hook): Do nothing if button is down.
Richard M. Stallman <rms@gnu.org>
parents:
20512
diff
changeset
|
283 (memq 'down (event-modifiers (car last-input-event))))) |
7015 | 284 (mouse-avoidance-kbd-command (this-command-keys))) |
285 (let ((mp (mouse-position))) | |
286 (cond ((and (not mouse-avoidance-state) | |
287 (mouse-avoidance-too-close-p mp)) | |
288 (setq mouse-avoidance-state mp) | |
289 (mouse-avoidance-banish-mouse)) | |
290 ((and mouse-avoidance-state | |
291 (not (mouse-avoidance-too-close-p mouse-avoidance-state))) | |
292 (if (and (eq (car mp) (selected-frame)) | |
293 (equal (cdr mp) (mouse-avoidance-banish-destination))) | |
294 (mouse-avoidance-set-mouse-position | |
295 ;; move back only if user has not moved mouse | |
296 (cdr mouse-avoidance-state))) | |
297 ;; but clear state anyway, to be ready for another move | |
298 (setq mouse-avoidance-state nil)))))) | |
5119 | 299 |
300 (defun mouse-avoidance-fancy-hook () | |
7015 | 301 ;; Used for the "fancy" modes, ie jump et al. |
302 (if (and (not executing-kbd-macro) ; don't check inside macro | |
20858
efafba146bb5
(mouse-avoidance-fancy-hook): Do nothing if button is down.
Richard M. Stallman <rms@gnu.org>
parents:
20512
diff
changeset
|
303 (not (and (consp last-input-event) |
efafba146bb5
(mouse-avoidance-fancy-hook): Do nothing if button is down.
Richard M. Stallman <rms@gnu.org>
parents:
20512
diff
changeset
|
304 (symbolp (car last-input-event)) |
efafba146bb5
(mouse-avoidance-fancy-hook): Do nothing if button is down.
Richard M. Stallman <rms@gnu.org>
parents:
20512
diff
changeset
|
305 (memq 'down (event-modifiers (car last-input-event))))) |
7015 | 306 (mouse-avoidance-kbd-command (this-command-keys)) |
307 (mouse-avoidance-too-close-p (mouse-position))) | |
5745 | 308 (let ((old-pos (mouse-position))) |
309 (mouse-avoidance-nudge-mouse) | |
11269
26d830b04546
avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents:
7879
diff
changeset
|
310 (if (not (eq (selected-frame) (car old-pos))) |
26d830b04546
avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents:
7879
diff
changeset
|
311 ;; This should never happen. |
26d830b04546
avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents:
7879
diff
changeset
|
312 (apply 'set-mouse-position old-pos))))) |
5119 | 313 |
7015 | 314 (defun mouse-avoidance-kbd-command (key) |
5119 | 315 "Return t if the KEYSEQENCE is composed of keyboard events only. |
7556 | 316 Return nil if there are any lists in the key sequence." |
5119 | 317 (cond ((null key) nil) ; Null event seems to be |
318 ; returned occasionally. | |
319 ((not (vectorp key)) t) ; Strings are keyboard events. | |
320 ((catch 'done | |
321 (let ((i 0) | |
322 (l (length key))) | |
323 (while (< i l) | |
324 (if (listp (aref key i)) | |
325 (throw 'done nil)) | |
326 (setq i (1+ i)))) | |
327 t)))) | |
328 | |
11269
26d830b04546
avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents:
7879
diff
changeset
|
329 ;;;###autoload |
5119 | 330 (defun mouse-avoidance-mode (&optional mode) |
331 "Set cursor avoidance mode to MODE. | |
7015 | 332 MODE should be one of the symbols `banish', `exile', `jump', `animate', |
5745 | 333 `cat-and-mouse', `proteus', or `none'. |
334 | |
7015 | 335 If MODE is nil, toggle mouse avoidance between `none` and `banish' |
5745 | 336 modes. Positive numbers and symbols other than the above are treated |
337 as equivalent to `banish'; negative numbers and `-' are equivalent to `none'. | |
338 | |
339 Effects of the different modes: | |
7556 | 340 * banish: Move the mouse to the upper-right corner on any keypress. |
341 * exile: Move the mouse to the corner only if the cursor gets too close, | |
7015 | 342 and allow it to return once the cursor is out of the way. |
7556 | 343 * jump: If the cursor gets too close to the mouse, displace the mouse |
7015 | 344 a random distance & direction. |
7556 | 345 * animate: As `jump', but shows steps along the way for illusion of motion. |
346 * cat-and-mouse: Same as `animate'. | |
347 * proteus: As `animate', but changes the shape of the mouse pointer too. | |
5745 | 348 |
7015 | 349 Whenever the mouse is moved, the frame is also raised. |
350 | |
7879
e0f3cfb55df7
(mouse-avoidance-threshold): Renamed from ...threshhold.
Richard M. Stallman <rms@gnu.org>
parents:
7849
diff
changeset
|
351 \(see `mouse-avoidance-threshold' for definition of \"too close\", |
5745 | 352 and `mouse-avoidance-nudge-dist' and `mouse-avoidance-nudge-var' for |
353 definition of \"random distance\".)" | |
5119 | 354 (interactive |
355 (list (intern (completing-read | |
356 "Select cursor avoidance technique (SPACE for list): " | |
7015 | 357 '(("banish") ("exile") ("jump") ("animate") |
358 ("cat-and-mouse") ("proteus") ("none")) | |
5119 | 359 nil t)))) |
360 (if (eq mode 'cat-and-mouse) | |
361 (setq mode 'animate)) | |
19323
b686f7cb6849
(mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
17436
diff
changeset
|
362 (if mouse-avoidance-timer |
b686f7cb6849
(mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
17436
diff
changeset
|
363 (cancel-timer mouse-avoidance-timer)) |
b686f7cb6849
(mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
17436
diff
changeset
|
364 (setq mouse-avoidance-timer nil) |
14897
9cce31ba2d61
(mouse-avoidance-old-pointer-shape): New vbl.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
365 |
9cce31ba2d61
(mouse-avoidance-old-pointer-shape): New vbl.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
366 ;; Restore pointer shape if necessary |
9cce31ba2d61
(mouse-avoidance-old-pointer-shape): New vbl.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
367 (if (eq mouse-avoidance-mode 'proteus) |
9cce31ba2d61
(mouse-avoidance-old-pointer-shape): New vbl.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
368 (mouse-avoidance-set-pointer-shape mouse-avoidance-old-pointer-shape)) |
9cce31ba2d61
(mouse-avoidance-old-pointer-shape): New vbl.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
369 |
9cce31ba2d61
(mouse-avoidance-old-pointer-shape): New vbl.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
370 ;; Do additional setup depending on version of mode requested |
5119 | 371 (cond ((eq mode 'none) |
372 (setq mouse-avoidance-mode nil)) | |
373 ((or (eq mode 'jump) | |
374 (eq mode 'animate) | |
375 (eq mode 'proteus)) | |
19323
b686f7cb6849
(mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
17436
diff
changeset
|
376 (setq mouse-avoidance-timer |
b686f7cb6849
(mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
17436
diff
changeset
|
377 (run-with-idle-timer 0.1 t 'mouse-avoidance-fancy-hook)) |
7015 | 378 (setq mouse-avoidance-mode mode |
14897
9cce31ba2d61
(mouse-avoidance-old-pointer-shape): New vbl.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
379 mouse-avoidance-state (cons 0 0) |
9cce31ba2d61
(mouse-avoidance-old-pointer-shape): New vbl.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
380 mouse-avoidance-old-pointer-shape x-pointer-shape)) |
7015 | 381 ((eq mode 'exile) |
19323
b686f7cb6849
(mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
17436
diff
changeset
|
382 (setq mouse-avoidance-timer |
b686f7cb6849
(mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
17436
diff
changeset
|
383 (run-with-idle-timer 0.1 t 'mouse-avoidance-exile-hook)) |
7015 | 384 (setq mouse-avoidance-mode mode |
385 mouse-avoidance-state nil)) | |
5119 | 386 ((or (eq mode 'banish) |
387 (eq mode t) | |
388 (and (null mode) (null mouse-avoidance-mode)) | |
389 (and mode (> (prefix-numeric-value mode) 0))) | |
19323
b686f7cb6849
(mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
17436
diff
changeset
|
390 (setq mouse-avoidance-timer |
b686f7cb6849
(mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
17436
diff
changeset
|
391 (run-with-idle-timer 0.1 t 'mouse-avoidance-banish-hook)) |
5119 | 392 (setq mouse-avoidance-mode 'banish)) |
7015 | 393 (t (setq mouse-avoidance-mode nil))) |
394 (force-mode-line-update)) | |
5119 | 395 |
17067
15b18d794b75
Don't put "Avoid" in the mode line.
Karl Heuer <kwzh@gnu.org>
parents:
14897
diff
changeset
|
396 ;; Most people who use avoid mode leave it on all the time, so it's not |
15b18d794b75
Don't put "Avoid" in the mode line.
Karl Heuer <kwzh@gnu.org>
parents:
14897
diff
changeset
|
397 ;; very informative to announce it in the mode line. |
15b18d794b75
Don't put "Avoid" in the mode line.
Karl Heuer <kwzh@gnu.org>
parents:
14897
diff
changeset
|
398 ;;(or (assq 'mouse-avoidance-mode minor-mode-alist) |
15b18d794b75
Don't put "Avoid" in the mode line.
Karl Heuer <kwzh@gnu.org>
parents:
14897
diff
changeset
|
399 ;; (setq minor-mode-alist (cons '(mouse-avoidance-mode " Avoid") |
15b18d794b75
Don't put "Avoid" in the mode line.
Karl Heuer <kwzh@gnu.org>
parents:
14897
diff
changeset
|
400 ;; minor-mode-alist))) |
5119 | 401 |
20512
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
402 ;; Needed for custom. |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
403 (if mouse-avoidance-mode |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
404 (mouse-avoidance-mode mouse-avoidance-mode)) |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
405 |
65399b8cd0ad
(mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents:
19323
diff
changeset
|
406 ;;; avoid.el ends here |