;; 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
;; │ (beacon-mode 1)
;; └────
;;
-;; Whenever the window scrolls or you switch buffer a light will shine on
-;; top of your cursor so you know where it is.
+;; Whenever the window scrolls a light will shine on top of your cursor so
+;; you know where it is.
;;
;; 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-buffer-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:
(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 beacon blink when the window scrolls?"
:type 'boolean)
+(defcustom beacon-blink-when-window-changes t
+ "Should the beacon blink when the window changes?"
+ :type 'boolean)
+
(defcustom beacon-blink-duration 0.3
"Time, in seconds, that the blink should last."
:type 'number)
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
-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 nil
+(defcustom beacon-dont-blink-major-modes '(magit-status-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
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)
-(defun beacon--colored-overlay (color)
+(defconst beacon-overlay-priority (/ most-positive-fixnum 2)
+ "Priotiy used on all of our overlays.")
+
+(defun beacon--make-overlay (length &rest properties)
"Put an overlay at point with background COLOR."
- (let ((ov (make-overlay (point) (1+ (point)))))
- (overlay-put ov 'face (list :background color))
+ (let ((ov (make-overlay (point) (+ length (point)))))
(overlay-put ov 'beacon t)
- (push ov beacon--ovs)))
+ ;; Our overlay is very temporary, so we take the liberty of giving
+ ;; it a high priority.
+ (overlay-put ov 'priority beacon-overlay-priority)
+ (overlay-put ov 'window (selected-window))
+ (while properties
+ (overlay-put ov (pop properties) (pop properties)))
+ (push ov beacon--ovs)
+ ov))
+
+(defun beacon--colored-overlay (color)
+ "Put an overlay at point with background COLOR."
+ (beacon--make-overlay 1 'face (list :background color)))
(defun beacon--ov-put-after-string (overlay colors)
"Add an after-string property to OVERLAY.
(when (overlayp overlay)
(delete-overlay overlay))
(overlay-put overlay 'beacon-colors colors)
- (overlay-put overlay 'priority most-positive-fixnum)
(overlay-put overlay 'after-string
(propertize
(mapconcat (lambda (c) (propertize " " 'face (list :background c)))
"Put an overlay at point with an after-string property.
The property's value is a string of spaces with background
COLORS applied to each one."
- (let ((ov (make-overlay (point) (point)))
- ;; The after-string must not be longer than the remaining columns from
- ;; point to right window-end else it will be wrapped around (assuming
- ;; truncate-lines is nil) introducing an ugly wrap-around for a
- ;; fraction of a second.
- (colors (seq-take colors (- (window-width) (current-column)))))
- (beacon--ov-put-after-string ov colors)
- (overlay-put ov 'beacon t)
- (push ov beacon--ovs)))
+ ;; The after-string must not be longer than the remaining columns
+ ;; from point to right window-end else it will be wrapped around.
+ (let ((colors (seq-take colors (- (window-width) (current-column)))))
+ (beacon--ov-put-after-string (beacon--make-overlay 0) colors)))
(defun beacon--ov-at-point ()
(car (or (seq-filter (lambda (o) (overlay-get o 'beacon))
(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
(defvar beacon--window-scrolled nil)
(defvar beacon--previous-place nil)
(defvar beacon--previous-mark-head nil)
+(defvar beacon--previous-window nil)
(defun beacon--movement-> (delta)
"Return non-nil if latest point movement is > DELTA.
(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)
- (> (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."
(cond
((not (markerp beacon--previous-place))
(beacon--vanish))
- ;; Blink because we changed buffer.
- ((not (equal (marker-buffer beacon--previous-place)
- (current-buffer)))
- (when beacon-blink-when-buffer-changes
- (beacon-blink)))
+ ;; Blink for switching windows.
+ ((and beacon-blink-when-window-changes
+ (not (eq beacon--previous-window (selected-window))))
+ (beacon-blink))
;; Blink for scrolling.
((and beacon-blink-when-window-scrolls
beacon--window-scrolled
(equal beacon--window-scrolled (selected-window)))
- (beacon-blink)
- (setq beacon--window-scrolled nil))
+ (beacon-blink))
;; Blink for movement
((beacon--movement-> beacon-blink-when-point-moves)
(beacon-blink))
;; 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-place (point-marker))
+ (setq beacon--previous-window (selected-window))))
(defun beacon--window-scroll-function (win _start-pos)
"Blink the beacon or record that window has been scrolled.
unreliable, so just blink immediately."
(if this-command
(setq beacon--window-scrolled win)
+ (setq beacon--window-scrolled nil)
(beacon-blink)))
\f
(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))
+ (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
+
+;; Local Variables:
+;; indent-tabs-mode: nil
+;; End: