;; URL: https://github.com/Malabarba/beacon
;; Keywords: convenience
;; Version: 0.3
-;; Package-Requires: ((seq "1.9"))
+;; Package-Requires: ((seq "1.9") (cl-lib "0.5"))
;; 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 'cl-lib)
(defgroup beacon nil
"Customization group for beacon."
:group 'emacs
:prefix "beacon-")
-(defface beacon-fallback
- '((((class color) (background light))
- (:background "black"))
- (((class color) (background dark))
- (:background "white")))
- "Fallback background color")
-
(defvar beacon--timer nil)
(defcustom beacon-push-mark 35
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)
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
(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))
- (bg (color-values (if (string-prefix-p "unspecified" default-bg)
- (face-attribute 'beacon-fallback :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))
\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."
(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)