Merge commit 'b56ef781d5a712fd06378f78eb9551ab9269bb2e'

[gnu-emacs-elpa] / packages / beacon / beacon.el

diff --git a/packages/beacon/beacon.el b/packages/beacon/beacon.el
index 290054eb083ed3a04a91c8bf9689a2058bcc4159..777e809985bf90754e8aedb908b345b1e7e2ccd9 100644 (file)
--- a/packages/beacon/beacon.el
+++ b/packages/beacon/beacon.el
@@ -5,7 +5,7 @@
 ;; Author: Artur Malabarba <emacs@endlessparentheses.com>
 ;; URL: https://github.com/Malabarba/beacon
 ;; Keywords: convenience
 ;; Author: Artur Malabarba <emacs@endlessparentheses.com>
 ;; URL: https://github.com/Malabarba/beacon
 ;; Keywords: convenience

-;; Version: 0.1
+;; Version: 0.1.1

 ;; Package-Requires: ((seq "1.9"))
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; Package-Requires: ((seq "1.9"))
 
 ;; This program is free software; you can redistribute it and/or modify


@@ -33,28 +33,7 @@
 ;;
 ;; That’s it.
 ;;
 ;;
 ;; That’s it.
 ;;

-;;
-;; 1 Customizations
-;; ════════════════
-;;
-;;   • The appearance of the beacon is configured by `beacon-size' and
-;;     `beacon-color'.
-;;
-;;   • The duration is configured by `beacon-blink-duration' and
-;;     `beacon-blink-delay'.
-;;
-;;   • To customize /when/ the beacon should blink at all, configure
-;;     `beacon-blink-when-window-scrolls',
-;;     `beacon-blink-when-window-changes', and
-;;     `beacon-blink-when-point-moves'.
-;;
-;;   • To prevent the beacon from blinking only on some major-modes,
-;;     configure `beacon-dont-blink-major-modes'. For specific buffers, you
-;;     can do `(setq-local beacon-mode nil)'. For even more refined
-;;     control, configure `beacon-dont-blink-predicates'
-;;
-;;   • Beacon can also push the mark for you whenever point moves a long
-;;     distance. For this, configure `beacon-push-mark'.
+;; See the accompanying Readme.org for configuration details.

 
 ;;; Code:
 
 
 ;;; Code:
 


@@ -67,7 +46,7 @@
 
 (defvar beacon--timer nil)
 
 
 (defvar beacon--timer nil)
 

-(defcustom beacon-push-mark nil
+(defcustom beacon-push-mark 35

   "Should the mark be pushed before long movements?
 If nil, `beacon' will not push the mark.
 Otherwise this should be a number, and `beacon' will push the
   "Should the mark be pushed before long movements?
 If nil, `beacon' will not push the mark.
 Otherwise this should be a number, and `beacon' will push the


@@ -117,14 +96,18 @@ If it is a string, it is a color name or specification,
 e.g. \"#666600\"."
   :type '(choice number color))
 
 e.g. \"#666600\"."
   :type '(choice number color))
 

-(defcustom beacon-dont-blink-predicates nil
+(defvar beacon-dont-blink-predicates nil

   "A list of predicates that prevent the beacon blink.
 These predicate functions are called in order, with no
 arguments, before blinking the beacon.  If any returns
   "A list of predicates that prevent the beacon blink.
 These predicate functions are called in order, with no
 arguments, before blinking the beacon.  If any returns

-non-nil, the beacon will not blink."
-  :type 'hook)
+non-nil, the beacon will not blink.
+
+For instance, if you want to disable beacon on buffers where
+`hl-line-mode' is on, you can do:
+
+    (add-hook \\='beacon-dont-blink-predicates
+              (lambda () (bound-and-true-p hl-line-mode)))")

 
 

-(add-hook 'beacon-dont-blink-predicates (lambda () (bound-and-true-p hl-line-mode)))

 (add-hook 'beacon-dont-blink-predicates #'window-minibuffer-p)
 
 (defcustom beacon-dont-blink-major-modes '(magit-status-mode)
 (add-hook 'beacon-dont-blink-predicates #'window-minibuffer-p)
 
 (defcustom beacon-dont-blink-major-modes '(magit-status-mode)


@@ -134,6 +117,13 @@ one of the major-modes on this list, the beacon will not
 blink."
   :type '(repeat symbol))
 
 blink."
   :type '(repeat symbol))
 

+(defcustom beacon-dont-blink-commands '(recenter-top-bottom)
+  "A list of commands that should not make the beacon blink.
+Use this for commands that scroll the window in very
+predictable ways, when the blink would be more distracting
+than helpful.."
+  :type '(repeat symbol))
+

 \f
 ;;; Overlays
 (defvar beacon--ovs nil)
 \f
 ;;; Overlays
 (defvar beacon--ovs nil)


@@ -259,7 +249,8 @@ Only returns `beacon-size' elements."
   (beacon--vanish)
   (unless (or (not beacon-mode)
               (run-hook-with-args-until-success 'beacon-dont-blink-predicates)
   (beacon--vanish)
   (unless (or (not beacon-mode)
               (run-hook-with-args-until-success 'beacon-dont-blink-predicates)

-              (seq-find #'derived-mode-p beacon-dont-blink-major-modes))
+              (seq-find #'derived-mode-p beacon-dont-blink-major-modes)
+              (memq (or this-command last-command) beacon-dont-blink-commands))

     (beacon--shine)
     (setq beacon--timer
           (run-at-time beacon-blink-delay
     (beacon--shine)
     (setq beacon--timer
           (run-at-time beacon-blink-delay


@@ -280,11 +271,18 @@ If DELTA is nil, return nil."
        (markerp beacon--previous-place)
        (equal (marker-buffer beacon--previous-place)
               (current-buffer))
        (markerp beacon--previous-place)
        (equal (marker-buffer beacon--previous-place)
               (current-buffer))

+       ;; Quick check that prevents running the code below in very
+       ;; short movements (like typing).

        (> (abs (- (point) beacon--previous-place))
           delta)
        (> (abs (- (point) beacon--previous-place))
           delta)

-       (> (count-screen-lines (min (point) beacon--previous-place)
-                              (max (point) beacon--previous-place))
-          delta)))
+       ;; Check if the movement was >= DELTA lines by moving DELTA
+       ;; lines. `count-screen-lines' is too slow if the movement had
+       ;; thousands of lines.
+       (save-excursion
+         (goto-char (min beacon--previous-place (point)))
+         (vertical-motion delta)
+         (> (max (point) beacon--previous-place)
+            (line-beginning-position)))))

 
 (defun beacon--maybe-push-mark ()
   "Push mark if it seems to be safe."
 
 (defun beacon--maybe-push-mark ()
   "Push mark if it seems to be safe."


@@ -352,11 +350,17 @@ unreliable, so just blink immediately."
   (if beacon-mode
       (progn
         (add-hook 'window-scroll-functions #'beacon--window-scroll-function)
   (if beacon-mode
       (progn
         (add-hook 'window-scroll-functions #'beacon--window-scroll-function)

+        (add-hook 'focus-in-hook #'beacon-blink)

         (add-hook 'post-command-hook #'beacon--post-command)
         (add-hook 'pre-command-hook #'beacon--vanish))
         (add-hook 'post-command-hook #'beacon--post-command)
         (add-hook 'pre-command-hook #'beacon--vanish))

+    (remove-hook 'focus-in-hook #'beacon-blink)

     (remove-hook 'window-scroll-functions #'beacon--window-scroll-function)
     (remove-hook 'post-command-hook #'beacon--post-command)
     (remove-hook 'pre-command-hook #'beacon--vanish)))
 
 (provide 'beacon)
 ;;; beacon.el ends here
     (remove-hook 'window-scroll-functions #'beacon--window-scroll-function)
     (remove-hook 'post-command-hook #'beacon--post-command)
     (remove-hook 'pre-command-hook #'beacon--vanish)))
 
 (provide 'beacon)
 ;;; beacon.el ends here

+
+;; Local Variables:
+;; indent-tabs-mode: nil
+;; End: