;; Author: Artur Malabarba <emacs@endlessparentheses.com>
;; URL: https://github.com/Malabarba/beacon
;; Keywords: convenience
-;; Version: 0.3
-;; Package-Requires: ((seq "1.9"))
+;; Version: 0.5.1
+;; Package-Requires: ((seq "1.11"))
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;;; Code:
(require 'seq)
+(require 'faces)
+(unless (fboundp 'seq-mapn)
+ ;; This is for people who are on outdated Emacs snapshots. Will be
+ ;; deleted in a couple of weeks.
+ (defun seq-mapn (function sequence &rest sequences)
+ "Like `seq-map' but FUNCTION is mapped over all SEQUENCES.
+The arity of FUNCTION must match the number of SEQUENCES, and the
+mapping stops on the shortest sequence.
+Return a list of the results.
+
+\(fn FUNCTION SEQUENCES...)"
+ (let ((result nil)
+ (sequences (seq-map (lambda (s) (seq-into s 'list))
+ (cons sequence sequences))))
+ (while (not (memq nil sequences))
+ (push (apply function (seq-map #'car sequences)) result)
+ (setq sequences (seq-map #'cdr sequences)))
+ (nreverse result))))
(defgroup beacon nil
"Customization group for beacon."
mark whenever point moves more than that many lines."
:type '(choice integer (const nil)))
-(defcustom beacon-blink-when-point-moves nil
- "Should the beacon blink when moving a long distance?
-If nil, don't blink due to plain movement.
+(defcustom beacon-blink-when-point-moves-vertically nil
+ "Should the beacon blink when moving a long distance vertically?
+If nil, don't blink due to vertical movement.
If non-nil, this should be an integer, which is the minimum
movement distance (in lines) that triggers a beacon blink."
:type '(choice integer (const nil)))
+(defcustom beacon-blink-when-point-moves-horizontally nil
+ "Should the beacon blink when moving a long distance horizontally?
+If nil, don't blink due to horizontal movement.
+If non-nil, this should be an integer, which is the minimum
+movement distance (in columns) that triggers a beacon blink."
+ :type '(choice integer (const nil)))
+
(defcustom beacon-blink-when-buffer-changes t
"Should the beacon blink when changing buffer?"
:type 'boolean)
blink."
:type '(repeat symbol))
-(defcustom beacon-dont-blink-commands '(recenter-top-bottom)
+(defcustom beacon-dont-blink-commands '(recenter-top-bottom next-line previous-line
+ forward-line)
"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
(defun beacon--ov-at-point ()
(car (or (seq-filter (lambda (o) (overlay-get o 'beacon))
- (overlays-in (point) (point)))
+ (overlays-in (point) (point)))
(seq-filter (lambda (o) (overlay-get o 'beacon))
- (overlays-at (point))))))
+ (overlays-at (point))))))
(defun beacon--vanish ()
"Turn off the beacon."
(defun beacon--color-range ()
"Return a list of background colors for the beacon."
- (let* ((default-bg (face-attribute 'default :background))
+ (let* ((default-bg (or (background-color-at-point)
+ (face-background 'default)))
(bg (color-values (if (string-match "\\`unspecified-" default-bg)
(face-attribute 'beacon-fallback-background :background)
default-bg)))
(color-distance "white" bg))
(make-list 3 (* beacon-color 65535)))
(t (make-list 3 (* (- 1 beacon-color) 65535))))))
- (apply #'cl-mapcar (lambda (r g b) (format "#%04x%04x%04x" r g b))
+ (apply #'seq-mapn (lambda (r g b) (format "#%04x%04x%04x" r g b))
(mapcar (lambda (n) (butlast (beacon--int-range (elt fg n) (elt bg n))))
[0 1 2]))))
\f
;;; Movement detection
-(defun beacon--movement-> (delta)
- "Return non-nil if latest point movement is > DELTA.
-If DELTA is nil, return nil."
- (and delta
+(defun beacon--movement-> (delta-y &optional delta-x)
+ "Return non-nil if latest vertical movement is > DELTA-Y.
+If DELTA-Y is nil, return nil.
+The same is true for DELTA-X and horizonta movement."
+ (and delta-y
(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 >= 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))))))
+ delta-y)
+ ;; Col movement.
+ (or (and delta-x
+ (> (abs (- (current-column)
+ (save-excursion
+ (goto-char beacon--previous-place)
+ (current-column))))
+ delta-x))
+ ;; 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-y)
+ (> (max p beacon--previous-place)
+ (line-beginning-position)))))))
(defun beacon--maybe-push-mark ()
"Push mark if it seems to be safe."
(let ((head (car mark-ring)))
(when (and (eq beacon--previous-mark-head head)
(not (equal head beacon--previous-place)))
- (push-mark beacon--previous-place)))))
+ (push-mark beacon--previous-place 'silent)))))
(defun beacon--post-command ()
"Blink if point moved very far."
(not (eq beacon--previous-window (selected-window))))
(beacon-blink))
;; Blink for scrolling.
- ((and beacon-blink-when-window-scrolls
- beacon--window-scrolled
+ ((and beacon--window-scrolled
(equal beacon--window-scrolled (selected-window)))
(beacon-blink))
;; Blink for movement
- ((beacon--movement-> beacon-blink-when-point-moves)
+ ((beacon--movement-> beacon-blink-when-point-moves-vertically
+ beacon-blink-when-point-moves-horizontally)
(beacon-blink))
;; Even if we don't blink, vanish any previous beacon.
(t (beacon--vanish)))
If invoked outside the command loop, `post-command-hook' would be
unreliable, so just blink immediately."
- (unless (and (equal beacon--previous-window-start start-pos)
- (equal beacon--previous-window win))
+ (unless (or (and (equal beacon--previous-window-start start-pos)
+ (equal beacon--previous-window win))
+ (not beacon-blink-when-window-scrolls))
(if this-command
(setq beacon--window-scrolled win)
(setq beacon--window-scrolled nil)