;;
;; (if window-system (mouse-avoidance-mode 'animate))
;;
-;; The 'animate can be 'jump or 'banish or 'exile or 'protean if you prefer.
+;; Other legitimate alternatives include
+;; `banish', `exile', `jump', `cat-and-mouse', and `proteus'.
+;; They do somewhat different things.
;; See the documentation for function `mouse-avoidance-mode' for
;; details of the different modes.
;;
(provide 'avoid)
-(defvar mouse-avoidance-mode nil
- "Value is t or a symbol if the mouse pointer should avoid the cursor.
-See function `mouse-avoidance-mode' for possible values. Changing this
-variable is NOT the recommended way to change modes; use that function
-instead.")
-
-(defvar mouse-avoidance-nudge-dist 15
+(defgroup avoid nil
+ "Make mouse pointer stay out of the way of editing."
+ :prefix "mouse-avoidance-"
+ :group 'mouse)
+
+
+(defcustom mouse-avoidance-mode nil
+ "Activate mouse avoidance mode.
+See function `mouse-avoidance-mode' for possible values.
+You must modify via \\[customize] for this variable to have an effect."
+ :set (lambda (symbol value)
+ ;; 'none below prevents toggling when value is nil.
+ (mouse-avoidance-mode (or value 'none)))
+ :initialize 'custom-initialize-default
+ :type '(choice (const :tag "none" nil) (const banish) (const jump)
+ (const animate) (const exile) (const proteus)
+ )
+ :group 'avoid
+ :require 'avoid
+ :version "20.3")
+
+
+(defcustom mouse-avoidance-nudge-dist 15
"*Average distance that mouse will be moved when approached by cursor.
Only applies in mouse-avoidance-mode `jump' and its derivatives.
-For best results make this larger than `mouse-avoidance-threshold'.")
+For best results make this larger than `mouse-avoidance-threshold'."
+ :type 'integer
+ :group 'avoid)
-(defvar mouse-avoidance-nudge-var 10
- "*Variability of `mouse-avoidance-nudge-dist' (which see).")
+(defcustom mouse-avoidance-nudge-var 10
+ "*Variability of `mouse-avoidance-nudge-dist' (which see)."
+ :type 'integer
+ :group 'avoid)
-(defvar mouse-avoidance-animation-delay .01
- "Delay between animation steps, in seconds.")
+(defcustom mouse-avoidance-animation-delay .01
+ "Delay between animation steps, in seconds."
+ :type 'number
+ :group 'avoid)
-(defvar mouse-avoidance-threshold 5
+(defcustom mouse-avoidance-threshold 5
"*Mouse-pointer's flight distance.
If the cursor gets closer than this, the mouse pointer will move away.
-Only applies in mouse-avoidance-modes `animate' and `jump'.")
+Only applies in mouse-avoidance-modes `animate' and `jump'."
+ :type 'integer
+ :group 'avoid)
;; Internal variables
(defvar mouse-avoidance-state nil)
(defvar mouse-avoidance-n-pointer-shapes 0)
(defvar mouse-avoidance-old-pointer-shape nil)
+;; This timer is used to run something when Emacs is idle.
+(defvar mouse-avoidance-timer nil)
+
;;; Functions:
(defsubst mouse-avoidance-set-pointer-shape (shape)
(defun mouse-avoidance-banish-hook ()
(if (and (not executing-kbd-macro) ; don't check inside macro
- (mouse-avoidance-kbd-command (this-command-keys)))
+ (cadr (mouse-position)) ; don't move unless in an Emacs frame
+ ;; Don't do anything if last event was a mouse event.
+ (not (and (consp last-input-event)
+ (symbolp (car last-input-event))
+ (let ((modifiers (event-modifiers (car last-input-event))))
+ (or (memq (car last-input-event)
+ '(mouse-movement scroll-bar-movement))
+ (memq 'click modifiers)
+ (memq 'drag modifiers)
+ (memq 'down modifiers))))))
(mouse-avoidance-banish-mouse)))
(defun mouse-avoidance-exile-hook ()
;; For exile mode, the state is nil when the mouse is in its normal
;; position, and set to the old mouse-position when the mouse is in exile.
(if (and (not executing-kbd-macro)
- (mouse-avoidance-kbd-command (this-command-keys)))
+ ;; Don't do anything if last event was a mouse event.
+ (not (and (consp last-input-event)
+ (symbolp (car last-input-event))
+ (let ((modifiers (event-modifiers (car last-input-event))))
+ (or (memq (car last-input-event)
+ '(mouse-movement scroll-bar-movement))
+ (memq 'click modifiers)
+ (memq 'drag modifiers)
+ (memq 'down modifiers))))))
(let ((mp (mouse-position)))
(cond ((and (not mouse-avoidance-state)
(mouse-avoidance-too-close-p mp))
(defun mouse-avoidance-fancy-hook ()
;; Used for the "fancy" modes, ie jump et al.
(if (and (not executing-kbd-macro) ; don't check inside macro
- (mouse-avoidance-kbd-command (this-command-keys))
+ ;; Don't do anything if last event was a mouse event.
+ (not (and (consp last-input-event)
+ (symbolp (car last-input-event))
+ (let ((modifiers (event-modifiers (car last-input-event))))
+ (or (memq (car last-input-event)
+ '(mouse-movement scroll-bar-movement))
+ (memq 'click modifiers)
+ (memq 'drag modifiers)
+ (memq 'down modifiers)))))
(mouse-avoidance-too-close-p (mouse-position)))
(let ((old-pos (mouse-position)))
(mouse-avoidance-nudge-mouse)
;; This should never happen.
(apply 'set-mouse-position old-pos)))))
-(defun mouse-avoidance-kbd-command (key)
- "Return t if the KEYSEQENCE is composed of keyboard events only.
-Return nil if there are any lists in the key sequence."
- (cond ((null key) nil) ; Null event seems to be
- ; returned occasionally.
- ((not (vectorp key)) t) ; Strings are keyboard events.
- ((catch 'done
- (let ((i 0)
- (l (length key)))
- (while (< i l)
- (if (listp (aref key i))
- (throw 'done nil))
- (setq i (1+ i))))
- t))))
-
;;;###autoload
(defun mouse-avoidance-mode (&optional mode)
"Set cursor avoidance mode to MODE.
nil t))))
(if (eq mode 'cat-and-mouse)
(setq mode 'animate))
- (remove-hook 'post-command-idle-hook 'mouse-avoidance-banish-hook)
- (remove-hook 'post-command-idle-hook 'mouse-avoidance-exile-hook)
- (remove-hook 'post-command-idle-hook 'mouse-avoidance-fancy-hook)
+ (if mouse-avoidance-timer
+ (cancel-timer mouse-avoidance-timer))
+ (setq mouse-avoidance-timer nil)
;; Restore pointer shape if necessary
(if (eq mouse-avoidance-mode 'proteus)
((or (eq mode 'jump)
(eq mode 'animate)
(eq mode 'proteus))
- (add-hook 'post-command-idle-hook 'mouse-avoidance-fancy-hook)
+ (setq mouse-avoidance-timer
+ (run-with-idle-timer 0.1 t 'mouse-avoidance-fancy-hook))
(setq mouse-avoidance-mode mode
mouse-avoidance-state (cons 0 0)
mouse-avoidance-old-pointer-shape x-pointer-shape))
((eq mode 'exile)
- (add-hook 'post-command-idle-hook 'mouse-avoidance-exile-hook)
+ (setq mouse-avoidance-timer
+ (run-with-idle-timer 0.1 t 'mouse-avoidance-exile-hook))
(setq mouse-avoidance-mode mode
mouse-avoidance-state nil))
((or (eq mode 'banish)
(eq mode t)
(and (null mode) (null mouse-avoidance-mode))
(and mode (> (prefix-numeric-value mode) 0)))
- (add-hook 'post-command-idle-hook 'mouse-avoidance-banish-hook)
+ (setq mouse-avoidance-timer
+ (run-with-idle-timer 0.1 t 'mouse-avoidance-banish-hook))
(setq mouse-avoidance-mode 'banish))
(t (setq mouse-avoidance-mode nil)))
(force-mode-line-update))
-(or (assq 'mouse-avoidance-mode minor-mode-alist)
- (setq minor-mode-alist (cons '(mouse-avoidance-mode " Avoid")
- minor-mode-alist)))
+;; Most people who use avoid mode leave it on all the time, so it's not
+;; very informative to announce it in the mode line.
+;;(or (assq 'mouse-avoidance-mode minor-mode-alist)
+;; (setq minor-mode-alist (cons '(mouse-avoidance-mode " Avoid")
+;; minor-mode-alist)))
+
+;; Needed for custom.
+(if mouse-avoidance-mode
+ (mouse-avoidance-mode mouse-avoidance-mode))
-;;; End of avoid.el
+;;; avoid.el ends here
HCoop / bpt / emacs.git / blobdiff