annotate lisp/avoid.el @ 36224:600506f65cbf

Fix copyright notice.
author Gerd Moellmann <gerd@gnu.org>
date Tue, 20 Feb 2001 12:30:16 +0000
parents 19c8badbcb15
children f150471f4c55
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13337
84acc3adcd63 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 12940
diff changeset
1 ;;; avoid.el --- make mouse pointer stay out of the way of editing
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2
33809
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
3 ;;; Copyright (C) 1993, 1994, 2000 Free Software Foundation, Inc.
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4
25278
cbe304a26771 Fix maintainer address.
Karl Heuer <kwzh@gnu.org>
parents: 24639
diff changeset
5 ;; Author: Boris Goldowsky <boris@gnu.org>
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6 ;; Keywords: mouse
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
7
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8 ;; This file is part of GNU Emacs.
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 ;; it under the terms of the GNU General Public License as published by
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 ;; the Free Software Foundation; either version 2, or (at your option)
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 ;; any later version.
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15 ;; GNU Emacs is distributed in the hope that it will be useful,
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 ;; GNU General Public License for more details.
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 ;; You should have received a copy of the GNU General Public License
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
23 ;; Boston, MA 02111-1307, USA.
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25 ;;; Commentary:
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
27 ;; For those who are annoyed by the mouse pointer obscuring text,
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
28 ;; this mode moves the mouse pointer - either just a little out of
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
29 ;; the way, or all the way to the corner of the frame.
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
30 ;; To use, load or evaluate this file and type M-x mouse-avoidance-mode .
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
31 ;; To set up permanently, put the following in your .emacs:
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
32 ;;
29200
28c61db89225 Remove window-system from comments, suggest using display-*-p instead.
Eli Zaretskii <eliz@gnu.org>
parents: 28101
diff changeset
33 ;; (if (display-mouse-p) (mouse-avoidance-mode 'animate))
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
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
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
38 ;; See the documentation for function `mouse-avoidance-mode' for
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
39 ;; details of the different modes.
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
40 ;;
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
41 ;; For added silliness, make the animatee animate...
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
42 ;; put something similar to the following into your .emacs:
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
43 ;;
29200
28c61db89225 Remove window-system from comments, suggest using display-*-p instead.
Eli Zaretskii <eliz@gnu.org>
parents: 28101
diff changeset
44 ;; (if (eq window-system 'x)
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
45 ;; (mouse-avoidance-set-pointer-shape
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
46 ;; (eval (nth (random 4)
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
47 ;; '(x-pointer-man x-pointer-spider
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
48 ;; x-pointer-gobbler x-pointer-gumby)))))
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
49 ;;
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
50 ;; For completely random pointer shape, replace the setq above with:
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
51 ;; (setq x-pointer-shape (mouse-avoidance-random-shape))
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
52 ;;
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
53 ;; Bugs / Warnings / To-Do:
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
54 ;;
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
55 ;; - Using this code does slow emacs down. "banish" mode shouldn't
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
56 ;; be too bad, and on my workstation even "animate" is reasonable.
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
57 ;;
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
58 ;; - It ought to find out where any overlapping frames are and avoid them,
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
59 ;; rather than always raising the frame.
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
60
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
61 ;; Credits:
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
62 ;; This code was helped by all those who contributed suggestions,
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
63 ;; fixes, and additions
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
64 ;; Joe Harrington (and his advisor), for the original inspiration.
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
65 ;; Ken Manheimer, for dreaming up the Protean mode.
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
66 ;; Richard Stallman, for the awful cat-and-mouse pun, among other things.
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
67 ;; Mike Williams, Denis Howe, Bill Benedetto, Chris Moore, Don Morris,
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
68 ;; Simon Marshall, and M.S. Ashton, for their feedback.
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
69
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 ;;; Code:
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72 (provide 'avoid)
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
28101
b59523f7ce40 (mouse-avoidance-mode): Add autoload cookie to
Dave Love <fx@gnu.org>
parents: 25278
diff changeset
79 ;;;###autoload
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
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
81 "Activate mouse avoidance mode.
20512
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.
24639
219a6fe709d6 (mouse-avoidance-mode): Doc fix.
Dave Love <fx@gnu.org>
parents: 24550
diff changeset
83 Setting this variable directly does not take effect;
219a6fe709d6 (mouse-avoidance-mode): Doc fix.
Dave Love <fx@gnu.org>
parents: 24550
diff changeset
84 use either \\[customize] or the function `mouse-avoidance-mode'."
20512
65399b8cd0ad (mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents: 19323
diff changeset
85 :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
86 ;; 'none below prevents toggling when value is nil.
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
87 (mouse-avoidance-mode (or value 'none)))
20512
65399b8cd0ad (mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents: 19323
diff changeset
88 :initialize 'custom-initialize-default
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
89 :type '(choice (const :tag "none" nil) (const banish) (const jump)
20512
65399b8cd0ad (mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents: 19323
diff changeset
90 (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
91 )
65399b8cd0ad (mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents: 19323
diff changeset
92 :group 'avoid
21670
808ecc2eaa84 *** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents: 20993
diff changeset
93 :require 'avoid
808ecc2eaa84 *** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents: 20993
diff changeset
94 :version "20.3")
20512
65399b8cd0ad (mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents: 19323
diff changeset
95
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
96
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17067
diff changeset
97 (defcustom mouse-avoidance-nudge-dist 15
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
98 "*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
99 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
100 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
101 :type 'integer
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17067
diff changeset
102 :group 'avoid)
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17067
diff changeset
104 (defcustom mouse-avoidance-nudge-var 10
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17067
diff changeset
105 "*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
106 :type 'integer
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17067
diff changeset
107 :group 'avoid)
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
108
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17067
diff changeset
109 (defcustom mouse-avoidance-animation-delay .01
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17067
diff changeset
110 "Delay between animation steps, in seconds."
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17067
diff changeset
111 :type 'number
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17067
diff changeset
112 :group 'avoid)
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17067
diff changeset
113
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17067
diff changeset
114 (defcustom mouse-avoidance-threshold 5
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
115 "*Mouse-pointer's flight distance.
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
116 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
117 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
118 :type 'integer
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17067
diff changeset
119 :group 'avoid)
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
120
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
121 ;; Internal variables
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
122 (defvar mouse-avoidance-state nil)
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
123 (defvar mouse-avoidance-pointer-shapes nil)
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
124 (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
125 (defvar mouse-avoidance-old-pointer-shape nil)
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
126
19323
b686f7cb6849 (mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17436
diff changeset
127 ;; 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
128 (defvar mouse-avoidance-timer nil)
b686f7cb6849 (mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17436
diff changeset
129
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
130 ;;; Functions:
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
131
11269
26d830b04546 avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents: 7879
diff changeset
132 (defsubst mouse-avoidance-set-pointer-shape (shape)
26d830b04546 avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents: 7879
diff changeset
133 "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
134 (setq x-pointer-shape shape)
26d830b04546 avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents: 7879
diff changeset
135 (set-mouse-color nil))
26d830b04546 avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents: 7879
diff changeset
136
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
137 (defun mouse-avoidance-point-position ()
7556
48f98b59a339 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 7015
diff changeset
138 "Return the position of point as (FRAME X . Y).
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
139 Analogous to mouse-position."
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
140 (let* ((w (selected-window))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
141 (edges (window-edges w))
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
142 (list
7849
bbc7770db51c (mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents: 7571
diff changeset
143 (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
144 ;; window-start can be < point-min if the
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
145 ;; latter has changed since the last redisplay
7849
bbc7770db51c (mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents: 7571
diff changeset
146 '(0 . 0) ; start XY
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
147 (point) ; stop pos
7849
bbc7770db51c (mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents: 7571
diff changeset
148 (cons (window-width) (window-height)); stop XY: none
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
149 (1- (window-width)) ; width
7849
bbc7770db51c (mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents: 7571
diff changeset
150 (cons (window-hscroll w) 0) ; 0 may not be right?
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
151 (selected-window))))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
152 ;; compute-motion returns (pos HPOS VPOS prevhpos contin)
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
153 ;; we want: (frame hpos . vpos)
7849
bbc7770db51c (mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents: 7571
diff changeset
154 (cons (selected-frame)
bbc7770db51c (mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents: 7571
diff changeset
155 (cons (+ (car edges) (car (cdr list)))
bbc7770db51c (mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents: 7571
diff changeset
156 (+ (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
157
bbc7770db51c (mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents: 7571
diff changeset
158 ;(defun mouse-avoidance-point-position-test ()
bbc7770db51c (mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents: 7571
diff changeset
159 ; (interactive)
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
160 ; (message (format "point=%s mouse=%s"
7849
bbc7770db51c (mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents: 7571
diff changeset
161 ; (cdr (mouse-avoidance-point-position))
bbc7770db51c (mouse-avoidance-point-position): Fix compute-motion
Richard M. Stallman <rms@gnu.org>
parents: 7571
diff changeset
162 ; (cdr (mouse-position)))))
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
163
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
164 (defun mouse-avoidance-set-mouse-position (pos)
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
165 ;; Carefully set mouse position to given position (X . Y)
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
166 ;; Ideally, should check if X,Y is in the current frame, and if not,
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
167 ;; leave the mouse where it was. However, this is currently
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
168 ;; difficult to do, so we just raise the frame to avoid frame switches.
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
169 ;; Returns t if it moved the mouse.
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
170 (let ((f (selected-frame)))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
171 (raise-frame f)
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
172 (set-mouse-position f (car pos) (cdr pos))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
173 t))
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
174
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
175 (defun mouse-avoidance-too-close-p (mouse)
33809
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
176 "Return t if mouse pointer and point cursor are too close.
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
177 MOUSE is the current mouse position as returned by `mouse-position'.
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
178 Acceptable distance is defined by `mouse-avoidance-threshold'."
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
179 (let* ((frame (car mouse))
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
180 (mouse-y (cdr (cdr mouse)))
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
181 (tool-bar-lines (frame-parameter nil 'tool-bar-lines)))
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
182 (if (and mouse-y (< mouse-y tool-bar-lines))
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
183 nil
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
184 (let ((point (mouse-avoidance-point-position))
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
185 (mouse-x (car (cdr mouse))))
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
186 (and (eq frame (car point))
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
187 (not (null mouse-x))
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
188 (< (abs (- mouse-x (car (cdr point))))
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
189 mouse-avoidance-threshold)
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
190 (< (abs (- mouse-y (cdr (cdr point))))
19c8badbcb15 (mouse-avoidance-too-close-p): Return nil if mouse
Gerd Moellmann <gerd@gnu.org>
parents: 30765
diff changeset
191 mouse-avoidance-threshold))))))
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
192
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
193 (defun mouse-avoidance-banish-destination ()
7556
48f98b59a339 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 7015
diff changeset
194 "The position to which mouse-avoidance-mode `banish' moves the mouse.
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
195 You can redefine this if you want the mouse banished to a different corner."
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
196 (cons (1- (frame-width))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
197 0))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
198
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
199 (defun mouse-avoidance-banish-mouse ()
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
200 ;; Put the mouse pointer in the upper-right corner of the current frame.
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
201 (mouse-avoidance-set-mouse-position (mouse-avoidance-banish-destination)))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
202
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
203 (defsubst mouse-avoidance-delta (cur delta dist var min max)
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
204 ;; Decide how far to move in either dimension.
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
205 ;; Args are the CURRENT location, the desired DELTA for
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
206 ;; warp-conservation, the DISTANCE we like to move, the VARIABILITY
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
207 ;; in distance allowed, and the MIN and MAX possible window positions.
14040
187735b53d52 Comment fixes.
Karl Heuer <kwzh@gnu.org>
parents: 13337
diff changeset
208 ;; Returns something as close to DELTA as possible within the constraints.
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
209 (let ((L1 (max (- min cur) (+ (- dist) (- var))))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
210 (R1 (+ (- dist) var ))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
211 (L2 (+ dist (- var)))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
212 (R2 (min (- max cur) (+ dist var))))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
213 (if (< R1 (- min cur)) (setq L1 nil R1 nil))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
214 (if (> L2 (- max cur)) (setq L2 nil R2 nil))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
215 (cond ((and L1 (< delta L1)) L1)
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
216 ((and R1 (< delta R1)) delta)
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
217 ((and R1 (< delta 0)) R1)
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
218 ((and L2 (< delta L2)) L2)
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
219 ((and R2 (< delta R2)) delta)
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
220 (R2)
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
221 ((or R1 L2))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
222 (t 0))))
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
223
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
224 (defun mouse-avoidance-nudge-mouse ()
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
225 ;; Push the mouse a little way away, possibly animating the move
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
226 ;; For these modes, state keeps track of the total offset that we've
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
227 ;; accumulated, and tries to keep it close to zero.
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
228 (let* ((cur (mouse-position))
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
229 (cur-frame (car cur))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
230 (cur-pos (cdr cur))
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
231 (deltax (mouse-avoidance-delta
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
232 (car cur-pos) (- (random mouse-avoidance-nudge-var)
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
233 (car mouse-avoidance-state))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
234 mouse-avoidance-nudge-dist mouse-avoidance-nudge-var
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
235 0 (frame-width)))
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
236 (deltay (mouse-avoidance-delta
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
237 (cdr cur-pos) (- (random mouse-avoidance-nudge-var)
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
238 (cdr mouse-avoidance-state))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
239 mouse-avoidance-nudge-dist mouse-avoidance-nudge-var
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
240 0 (frame-height))))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
241 (setq mouse-avoidance-state
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
242 (cons (+ (car mouse-avoidance-state) deltax)
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
243 (+ (cdr mouse-avoidance-state) deltay)))
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
244 (if (or (eq mouse-avoidance-mode 'animate)
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
245 (eq mouse-avoidance-mode 'proteus))
11269
26d830b04546 avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents: 7879
diff changeset
246 (let ((i 0.0))
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
247 (while (<= i 1)
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
248 (mouse-avoidance-set-mouse-position
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
249 (cons (+ (car cur-pos) (round (* i deltax)))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
250 (+ (cdr cur-pos) (round (* i deltay)))))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
251 (setq i (+ i (max .1 (/ 1.0 mouse-avoidance-nudge-dist))))
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
252 (if (eq mouse-avoidance-mode 'proteus)
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
253 (mouse-avoidance-set-pointer-shape
11269
26d830b04546 avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents: 7879
diff changeset
254 (mouse-avoidance-random-shape)))
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
255 (sit-for mouse-avoidance-animation-delay)))
7556
48f98b59a339 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 7015
diff changeset
256 (mouse-avoidance-set-mouse-position (cons (+ (car (cdr cur)) deltax)
48f98b59a339 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 7015
diff changeset
257 (+ (cdr (cdr cur)) deltay))))))
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
258
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
259 (defun mouse-avoidance-random-shape ()
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
260 "Return a random cursor shape.
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
261 This assumes that any variable whose name begins with x-pointer- and
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
262 has an integer value is a valid cursor shape. You might want to
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
263 redefine this function to suit your own tastes."
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
264 (if (null mouse-avoidance-pointer-shapes)
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
265 (progn
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
266 (setq mouse-avoidance-pointer-shapes
29550
48ef50f314bf (mouse-avoidance-random-shape): Don't quote lambda.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 29200
diff changeset
267 (mapcar (lambda (x) (symbol-value (intern x)))
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
268 (all-completions "x-pointer-" obarray
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
269 (lambda (x)
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
270 (and (boundp x)
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
271 (integerp (symbol-value x)))))))
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
272 (setq mouse-avoidance-n-pointer-shapes
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
273 (length mouse-avoidance-pointer-shapes))))
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
274 (nth (random mouse-avoidance-n-pointer-shapes)
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
275 mouse-avoidance-pointer-shapes))
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
276
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
277 (defun mouse-avoidance-banish-hook ()
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
278 (if (and (not executing-kbd-macro) ; don't check inside macro
23295
722f0b9703c7 (mouse-avoidance-banish-hook): Don't move unless in an
Karl Heuer <kwzh@gnu.org>
parents: 21670
diff changeset
279 (cadr (mouse-position)) ; don't move unless in an Emacs frame
20993
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
280 ;; Don't do anything if last event was a mouse event.
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))
20993
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
283 (let ((modifiers (event-modifiers (car last-input-event))))
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
284 (or (memq (car last-input-event)
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
285 '(mouse-movement scroll-bar-movement))
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
286 (memq 'click modifiers)
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
287 (memq 'drag modifiers)
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
288 (memq 'down modifiers))))))
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
289 (mouse-avoidance-banish-mouse)))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
290
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
291 (defun mouse-avoidance-exile-hook ()
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
292 ;; For exile mode, the state is nil when the mouse is in its normal
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
293 ;; position, and set to the old mouse-position when the mouse is in exile.
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
294 (if (and (not executing-kbd-macro)
20993
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
295 ;; Don't do anything if last event was a mouse event.
20858
efafba146bb5 (mouse-avoidance-fancy-hook): Do nothing if button is down.
Richard M. Stallman <rms@gnu.org>
parents: 20512
diff changeset
296 (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
297 (symbolp (car last-input-event))
20993
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
298 (let ((modifiers (event-modifiers (car last-input-event))))
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
299 (or (memq (car last-input-event)
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
300 '(mouse-movement scroll-bar-movement))
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
301 (memq 'click modifiers)
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
302 (memq 'drag modifiers)
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
303 (memq 'down modifiers))))))
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
304 (let ((mp (mouse-position)))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
305 (cond ((and (not mouse-avoidance-state)
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
306 (mouse-avoidance-too-close-p mp))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
307 (setq mouse-avoidance-state mp)
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
308 (mouse-avoidance-banish-mouse))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
309 ((and mouse-avoidance-state
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
310 (not (mouse-avoidance-too-close-p mouse-avoidance-state)))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
311 (if (and (eq (car mp) (selected-frame))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
312 (equal (cdr mp) (mouse-avoidance-banish-destination)))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
313 (mouse-avoidance-set-mouse-position
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
314 ;; move back only if user has not moved mouse
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
315 (cdr mouse-avoidance-state)))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
316 ;; but clear state anyway, to be ready for another move
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
317 (setq mouse-avoidance-state nil))))))
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
318
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
319 (defun mouse-avoidance-fancy-hook ()
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
320 ;; Used for the "fancy" modes, ie jump et al.
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
321 (if (and (not executing-kbd-macro) ; don't check inside macro
20993
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
322 ;; Don't do anything if last event was a mouse event.
20858
efafba146bb5 (mouse-avoidance-fancy-hook): Do nothing if button is down.
Richard M. Stallman <rms@gnu.org>
parents: 20512
diff changeset
323 (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
324 (symbolp (car last-input-event))
20993
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
325 (let ((modifiers (event-modifiers (car last-input-event))))
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
326 (or (memq (car last-input-event)
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
327 '(mouse-movement scroll-bar-movement))
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
328 (memq 'click modifiers)
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
329 (memq 'drag modifiers)
c87385403522 (mouse-avoidance-kbd-command): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents: 20858
diff changeset
330 (memq 'down modifiers)))))
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
331 (mouse-avoidance-too-close-p (mouse-position)))
5745
01628c0b2646 Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 5145
diff changeset
332 (let ((old-pos (mouse-position)))
01628c0b2646 Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 5145
diff changeset
333 (mouse-avoidance-nudge-mouse)
11269
26d830b04546 avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents: 7879
diff changeset
334 (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
335 ;; This should never happen.
26d830b04546 avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents: 7879
diff changeset
336 (apply 'set-mouse-position old-pos)))))
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
337
11269
26d830b04546 avoid.el Add autoload cookies; doc fixes.
Boris Goldowsky <boris@gnu.org>
parents: 7879
diff changeset
338 ;;;###autoload
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
339 (defun mouse-avoidance-mode (&optional mode)
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
340 "Set cursor avoidance mode to MODE.
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
341 MODE should be one of the symbols `banish', `exile', `jump', `animate',
5745
01628c0b2646 Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 5145
diff changeset
342 `cat-and-mouse', `proteus', or `none'.
01628c0b2646 Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 5145
diff changeset
343
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
344 If MODE is nil, toggle mouse avoidance between `none' and `banish'
5745
01628c0b2646 Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 5145
diff changeset
345 modes. Positive numbers and symbols other than the above are treated
01628c0b2646 Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 5145
diff changeset
346 as equivalent to `banish'; negative numbers and `-' are equivalent to `none'.
01628c0b2646 Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 5145
diff changeset
347
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
348 Effects of the different modes:
7556
48f98b59a339 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 7015
diff changeset
349 * banish: Move the mouse to the upper-right corner on any keypress.
48f98b59a339 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 7015
diff changeset
350 * exile: Move the mouse to the corner only if the cursor gets too close,
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
351 and allow it to return once the cursor is out of the way.
7556
48f98b59a339 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 7015
diff changeset
352 * jump: If the cursor gets too close to the mouse, displace the mouse
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
353 a random distance & direction.
7556
48f98b59a339 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 7015
diff changeset
354 * animate: As `jump', but shows steps along the way for illusion of motion.
48f98b59a339 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 7015
diff changeset
355 * cat-and-mouse: Same as `animate'.
48f98b59a339 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 7015
diff changeset
356 * proteus: As `animate', but changes the shape of the mouse pointer too.
5745
01628c0b2646 Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 5145
diff changeset
357
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
358 Whenever the mouse is moved, the frame is also raised.
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
359
7879
e0f3cfb55df7 (mouse-avoidance-threshold): Renamed from ...threshhold.
Richard M. Stallman <rms@gnu.org>
parents: 7849
diff changeset
360 \(see `mouse-avoidance-threshold' for definition of \"too close\",
5745
01628c0b2646 Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 5145
diff changeset
361 and `mouse-avoidance-nudge-dist' and `mouse-avoidance-nudge-var' for
01628c0b2646 Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 5145
diff changeset
362 definition of \"random distance\".)"
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
363 (interactive
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
364 (list (intern (completing-read
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
365 "Select cursor avoidance technique (SPACE for list): "
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
366 '(("banish") ("exile") ("jump") ("animate")
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
367 ("cat-and-mouse") ("proteus") ("none"))
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
368 nil t))))
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
369 (if (eq mode 'cat-and-mouse)
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
370 (setq mode 'animate))
19323
b686f7cb6849 (mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17436
diff changeset
371 (if mouse-avoidance-timer
b686f7cb6849 (mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17436
diff changeset
372 (cancel-timer mouse-avoidance-timer))
b686f7cb6849 (mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17436
diff changeset
373 (setq mouse-avoidance-timer nil)
14897
9cce31ba2d61 (mouse-avoidance-old-pointer-shape): New vbl.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
374
9cce31ba2d61 (mouse-avoidance-old-pointer-shape): New vbl.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
375 ;; Restore pointer shape if necessary
9cce31ba2d61 (mouse-avoidance-old-pointer-shape): New vbl.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
376 (if (eq mouse-avoidance-mode 'proteus)
9cce31ba2d61 (mouse-avoidance-old-pointer-shape): New vbl.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
377 (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
378
9cce31ba2d61 (mouse-avoidance-old-pointer-shape): New vbl.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
379 ;; Do additional setup depending on version of mode requested
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
380 (cond ((eq mode 'none)
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
381 (setq mouse-avoidance-mode nil))
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
382 ((or (eq mode 'jump)
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
383 (eq mode 'animate)
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
384 (eq mode 'proteus))
19323
b686f7cb6849 (mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17436
diff changeset
385 (setq mouse-avoidance-timer
b686f7cb6849 (mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17436
diff changeset
386 (run-with-idle-timer 0.1 t 'mouse-avoidance-fancy-hook))
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
387 (setq mouse-avoidance-mode mode
14897
9cce31ba2d61 (mouse-avoidance-old-pointer-shape): New vbl.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
388 mouse-avoidance-state (cons 0 0)
9cce31ba2d61 (mouse-avoidance-old-pointer-shape): New vbl.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
389 mouse-avoidance-old-pointer-shape x-pointer-shape))
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
390 ((eq mode 'exile)
19323
b686f7cb6849 (mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17436
diff changeset
391 (setq mouse-avoidance-timer
b686f7cb6849 (mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17436
diff changeset
392 (run-with-idle-timer 0.1 t 'mouse-avoidance-exile-hook))
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
393 (setq mouse-avoidance-mode mode
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
394 mouse-avoidance-state nil))
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
395 ((or (eq mode 'banish)
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
396 (eq mode t)
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
397 (and (null mode) (null mouse-avoidance-mode))
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
398 (and mode (> (prefix-numeric-value mode) 0)))
19323
b686f7cb6849 (mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17436
diff changeset
399 (setq mouse-avoidance-timer
b686f7cb6849 (mouse-avoidance-timer): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17436
diff changeset
400 (run-with-idle-timer 0.1 t 'mouse-avoidance-banish-hook))
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
401 (setq mouse-avoidance-mode 'banish))
7015
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
402 (t (setq mouse-avoidance-mode nil)))
41b90d7dd228 doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6106
diff changeset
403 (force-mode-line-update))
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
404
17067
15b18d794b75 Don't put "Avoid" in the mode line.
Karl Heuer <kwzh@gnu.org>
parents: 14897
diff changeset
405 ;; 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
406 ;; 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
407 ;;(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
408 ;; (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
409 ;; minor-mode-alist)))
5119
bf9e7676a73e Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
410
20512
65399b8cd0ad (mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents: 19323
diff changeset
411 ;; Needed for custom.
30765
1e5a486b8b25 punctuation fixes in doc strings
Sam Steingold <sds@gnu.org>
parents: 29550
diff changeset
412 (if mouse-avoidance-mode
20512
65399b8cd0ad (mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents: 19323
diff changeset
413 (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
414
65399b8cd0ad (mouse-avoidance-mode): Variable customized to automatically load the package.
Richard M. Stallman <rms@gnu.org>
parents: 19323
diff changeset
415 ;;; avoid.el ends here