;; Author: Artur Malabarba <emacs@endlessparentheses.com>
;; URL: https://github.com/Malabarba/beacon
;; Keywords: convenience
-;; Version: 0.1.1
+;; Version: 0.3
;; Package-Requires: ((seq "1.9"))
;; This program is free software; you can redistribute it and/or modify
"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)
e.g. \"#666600\"."
:type '(choice number color))
+(defface beacon-fallback-background
+ '((((class color) (background light)) (:background "black"))
+ (((class color) (background dark)) (:background "white")))
+ "Fallback beacon background color.
+Used in cases where the color can't be determined by Emacs.
+Only the background of this face is used.")
+
(defvar beacon-dont-blink-predicates nil
"A list of predicates that prevent the beacon blink.
These predicate functions are called in order, with no
(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
than helpful.."
:type '(repeat symbol))
+\f
+;;; Internal variables
+(defvar beacon--window-scrolled nil)
+(defvar beacon--previous-place nil)
+(defvar beacon--previous-mark-head nil)
+(defvar beacon--previous-window nil)
+(defvar beacon--previous-window-start 0)
+
+(defun beacon--record-vars ()
+ (unless (window-minibuffer-p)
+ (setq beacon--previous-mark-head (car mark-ring))
+ (setq beacon--previous-place (point-marker))
+ (setq beacon--previous-window (selected-window))
+ (setq beacon--previous-window-start (window-start))))
+
\f
;;; Overlays
(defvar beacon--ovs nil)
(defun beacon--color-range ()
"Return a list of background colors for the beacon."
- (let* ((bg (color-values (face-attribute 'default :background)))
+ (let* ((default-bg (face-attribute 'default :background))
+ (bg (color-values (if (string-match "\\`unspecified-" default-bg)
+ (face-attribute 'beacon-fallback-background :background)
+ default-bg)))
(fg (cond
((stringp beacon-color) (color-values beacon-color))
((< (color-distance "black" bg)
"Blink the beacon at the position of the cursor."
(interactive)
(beacon--vanish)
+ ;; Record vars here in case something is blinking outside the
+ ;; command loop.
+ (beacon--record-vars)
(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)
\f
;;; Movement detection
-(defvar beacon--window-scrolled nil)
-(defvar beacon--previous-place nil)
-(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."
(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 prev-pos)
- (throw 'movement nil))
- (dolist (inc '(1 -1))
- (save-excursion
- (dotimes (i delta)
- (vertical-motion inc)
- (when (beacon--pos-on-current-line-p prev-pos)
- (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."
(beacon--vanish))
;; Blink for switching windows.
((and beacon-blink-when-window-changes
- (not (eq beacon--previous-window (selected-window))))
+ (not (eq beacon--previous-window (selected-window))))
(beacon-blink))
;; Blink for scrolling.
((and beacon-blink-when-window-scrolls
;; Even if we don't blink, vanish any previous beacon.
(t (beacon--vanish)))
(beacon--maybe-push-mark)
- (setq beacon--window-scrolled nil)
- (unless (window-minibuffer-p)
- (setq beacon--previous-mark-head (car mark-ring))
- (setq beacon--previous-place (point-marker))
- (setq beacon--previous-window (selected-window))))
+ (setq beacon--window-scrolled nil))
-(defun beacon--window-scroll-function (win _start-pos)
+(defun beacon--window-scroll-function (win start-pos)
"Blink the beacon or record that window has been scrolled.
If invoked during the command loop, record the current window so
that it may be blinked on post-command. This is because the
If invoked outside the command loop, `post-command-hook' would be
unreliable, so just blink immediately."
- (if this-command
- (setq beacon--window-scrolled win)
- (setq beacon--window-scrolled nil)
+ (unless (and (equal beacon--previous-window-start start-pos)
+ (equal beacon--previous-window win))
+ (if this-command
+ (setq beacon--window-scrolled win)
+ (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)
(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--record-vars)
(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--record-vars)
(remove-hook 'pre-command-hook #'beacon--vanish)))
(provide 'beacon)
;;; beacon.el ends here
+
+;; Local Variables:
+;; indent-tabs-mode: nil
+;; End: