]> code.delx.au - gnu-emacs-elpa/blobdiff - beacon.el
Don't blink in Magit popups
[gnu-emacs-elpa] / beacon.el
index 0b2042381be8ce034ce320131a72d621fc4119a0..bfeeade2de683dadf844d06e52a1a52e93129c0b 100644 (file)
--- a/beacon.el
+++ b/beacon.el
@@ -5,7 +5,7 @@
 ;; Author: Artur Malabarba <emacs@endlessparentheses.com>
 ;; URL: https://github.com/Malabarba/beacon
 ;; Keywords: convenience
-;; Version: 0.1.1
+;; Version: 0.2.1
 ;; Package-Requires: ((seq "1.9"))
 
 ;; This program is free software; you can redistribute it and/or modify
@@ -72,6 +72,13 @@ movement distance (in lines) that triggers a beacon blink."
   "Should the beacon blink when the window changes?"
   :type 'boolean)
 
+(defcustom beacon-blink-when-focused nil
+  "Should the beacon blink when Emacs gains focus?
+Note that, due to a limitation of `focus-in-hook', this might
+trigger false positives on some systems."
+  :type 'boolean
+  :package-version '(beacon . "0.2"))
+
 (defcustom beacon-blink-duration 0.3
   "Time, in seconds, that the blink should last."
   :type 'number)
@@ -110,7 +117,7 @@ For instance, if you want to disable beacon on buffers where
 
 (add-hook 'beacon-dont-blink-predicates #'window-minibuffer-p)
 
-(defcustom beacon-dont-blink-major-modes '(magit-status-mode)
+(defcustom beacon-dont-blink-major-modes '(magit-status-mode magit-popup-mode)
   "A list of major-modes where the beacon won't blink.
 Whenever the current buffer satisfies `derived-mode-p' for
 one of the major-modes on this list, the beacon will not
@@ -264,11 +271,6 @@ Only returns `beacon-size' elements."
 (defvar beacon--previous-mark-head nil)
 (defvar beacon--previous-window nil)
 
-(defun beacon--pos-on-current-line-p (pos)
-  "Return non-nil if POS is on the current line."
-  (and (<= (save-excursion (beginning-of-line) (point)) pos)
-       (<= pos (save-excursion (end-of-line) (point)))))
-
 (defun beacon--movement-> (delta)
   "Return non-nil if latest point movement is > DELTA.
 If DELTA is nil, return nil."
@@ -276,23 +278,19 @@ If DELTA is nil, return nil."
        (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)
-       ;; Check if the movement was larger than DELTA lines by testing if
-       ;; `point' is still on the same line or on any line DELTA lines up or
-       ;; down.  This is much cheaper than computing the actual number of lines
-       ;; moved using `count-screen-lines'.
-       (let ((prev-pos (marker-position beacon--previous-place)))
-        (catch 'movement
-          (when (beacon--pos-on-current-line-p (point))
-            (throw 'movement nil))
-          (dolist (inc '(1 -1))
-            (save-excursion
-              (dotimes (i delta)
-                (vertical-motion inc)
-                (when (beacon--pos-on-current-line-p (point))
-                  (throw 'movement nil)))))
-          (throw 'movement t)))))
+       ;; 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
+         (let ((p (point)))
+           (goto-char (min beacon--previous-place p))
+           (vertical-motion delta)
+           (> (max p beacon--previous-place)
+              (line-beginning-position))))))
 
 (defun beacon--maybe-push-mark ()
   "Push mark if it seems to be safe."
@@ -343,13 +341,18 @@ unreliable, so just blink immediately."
     (setq beacon--window-scrolled nil)
     (beacon-blink)))
 
+(defun beacon--blink-on-focus ()
+  "Blink if `beacon-blink-when-focused' is non-nil"
+  (when beacon-blink-when-focused
+    (beacon-blink)))
+
 \f
 ;;; Minor-mode
 (defcustom beacon-lighter
   (cond
-   ((char-displayable-p ?💡) " ðŸ’¡")
-   ((char-displayable-p ?Λ) " Î›")
-   (t " *"))
+   ;; ((char-displayable-p ?💡) " ðŸ’¡")
+   ;; ((char-displayable-p ?Λ) " Î›")
+   (t " (*)"))
   "Lighter string used on the mode-line."
   :type 'string)
 
@@ -360,11 +363,17 @@ unreliable, so just blink immediately."
   (if beacon-mode
       (progn
         (add-hook 'window-scroll-functions #'beacon--window-scroll-function)
+        (add-hook 'focus-in-hook #'beacon--blink-on-focus)
         (add-hook 'post-command-hook #'beacon--post-command)
         (add-hook 'pre-command-hook #'beacon--vanish))
+    (remove-hook 'focus-in-hook #'beacon--blink-on-focus)
     (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: