From 0f2350b9dee5b1c9902de7891c88d53b36d01b4d Mon Sep 17 00:00:00 2001 From: "F. Jason Park" Date: Fri, 16 Dec 2022 06:31:41 -0800 Subject: [PATCH 0/1] *** NOT A PATCH *** *** BLURB HERE *** F. Jason Park (1): Add option to show visual erc-keep-place indicator etc/ERC-NEWS | 10 ++++ lisp/erc/erc-goodies.el | 117 +++++++++++++++++++++++++++++++++++++++- 2 files changed, 125 insertions(+), 2 deletions(-) Interdiff: diff --git a/etc/ERC-NEWS b/etc/ERC-NEWS index 5b73760741..a994a37d83 100644 --- a/etc/ERC-NEWS +++ b/etc/ERC-NEWS @@ -16,10 +16,10 @@ GNU Emacs since Emacs version 22.1. ** Module 'keep-place' now offers a visual indicator. -Remember your place in a target buffer a bit more easily while also -having the freedom to roam. Optionally sync the indicator manually if -you've made progress but still haven't caught up to the live stream. -See new option 'erc-keep-place-indicator'. +Remember your place in ERC buffers a bit more easily while also having +the freedom to look around. Optionally sync the indicator to any +progress made when you haven't yet caught up to the live stream. See +new option 'erc-keep-place-indicator' and friends. * Changes in ERC 5.5 diff --git a/lisp/erc/erc-goodies.el b/lisp/erc/erc-goodies.el index 18e9f665bd..4efb88139f 100644 --- a/lisp/erc/erc-goodies.el +++ b/lisp/erc/erc-goodies.el @@ -47,6 +47,9 @@ erc-log-p (declare-function erc-extract-command-from-line "erc" (line)) (declare-function erc-beg-of-input-line "erc" nil) (declare-function erc-default-target "erc" nil) +(declare-function erc-buffer-filter "erc" (predicate &optional proc)) +(declare-function pulse-available-p "pulse" nil) +(declare-function pulse-momentary-highlight-overlay "pulse" (o &optional face)) (defun erc-imenu-setup () "Setup Imenu support in an ERC buffer." @@ -194,57 +197,63 @@ erc-keep-place-indicator-arrow (defvar-local erc--keep-place-overlay nil "Overlay for option `erc-keep-place-indicator'.") +;; Replace this with whatever mechanism is devised for persisting +;; a target buffer's variables (if not limited to local modules) +(put 'erc--keep-place-overlay 'permanent-local t) + (defun erc--keep-place-on-window-configuration-change () - "Maybe sync `erc--keep-place-overlay'." + "Maybe sync `erc--keep-place-overlay'. +Specifically, do so unless switching to or from another window in +the active frame." (when erc-keep-place-indicator-follow - (unless (minibuffer-window-active-p (minibuffer-window)) + (unless (or (minibuffer-window-active-p (minibuffer-window)) + (eq (window-old-buffer) (current-buffer))) (when (< (overlay-end erc--keep-place-overlay) (window-start) erc-insert-marker) (erc-keep-place-move (window-start)))))) (defun erc--keep-place-setup-overlay () - (when (erc-default-target) + (when erc-keep-place-indicator (add-hook 'window-configuration-change-hook #'erc--keep-place-on-window-configuration-change nil t) - (setq erc--keep-place-overlay (make-overlay 0 0)) - (when (memq erc-keep-place-indicator '(t arrow)) - (overlay-put erc--keep-place-overlay 'before-string - (propertize - " " - 'display - (if (zerop (fringe-columns 'left)) - `((margin left-margin) ,overlay-arrow-string) - '(left-fringe right-triangle - erc-keep-place-indicator-arrow))))) - (when (memq erc-keep-place-indicator '(t face)) - (overlay-put erc--keep-place-overlay 'face - 'erc-keep-place-indicator-line)))) + (unless erc--keep-place-overlay + (setq erc--keep-place-overlay (make-overlay 0 0)) + (when (memq erc-keep-place-indicator '(t arrow)) + (overlay-put erc--keep-place-overlay 'before-string + (propertize + " " + 'display + (if (zerop (fringe-columns 'left)) + `((margin left-margin) ,overlay-arrow-string) + '(left-fringe right-triangle + erc-keep-place-indicator-arrow))))) + (when (memq erc-keep-place-indicator '(t face)) + (overlay-put erc--keep-place-overlay 'face + 'erc-keep-place-indicator-line))))) ;;; Keep place in unvisited channels (define-erc-module keep-place nil "Leave point above un-viewed text in other channels." ((add-hook 'erc-insert-pre-hook #'erc-keep-place) - (when erc-keep-place-indicator - (if (derived-mode-p 'erc-mode) - (erc--keep-place-setup-overlay) - (add-hook 'erc-mode-hook #'erc--keep-place-setup-overlay)))) + (add-hook 'erc-mode-hook #'erc--keep-place-setup-overlay) + (erc-with-all-buffers-of-server erc-server-process nil + (erc--keep-place-setup-overlay))) ((remove-hook 'erc-insert-pre-hook #'erc-keep-place) - (when erc-keep-place-indicator - (remove-hook 'erc-mode-hook #'erc--keep-place-setup-overlay) - (erc-with-all-buffers-of-server erc-server-process nil - (when erc--keep-place-overlay - (delete-overlay erc--keep-place-overlay) - (remove-hook 'window-configuration-change-hook - #'erc--keep-place-on-window-configuration-change t) - (kill-local-variable 'erc--keep-place-overlay)))))) + (remove-hook 'erc-mode-hook #'erc--keep-place-setup-overlay) + (erc-with-all-buffers-of-server erc-server-process nil + (when erc--keep-place-overlay + (delete-overlay erc--keep-place-overlay) + (remove-hook 'window-configuration-change-hook + #'erc--keep-place-on-window-configuration-change t) + (kill-local-variable 'erc--keep-place-overlay))))) (defun erc-keep-place-move (&optional pos) - "Move keep-place indicator to the current line." - (interactive "P") + "Move keep-place indicator to the current line or POS." + (interactive) (save-excursion (let ((inhibit-field-text-motion t)) - (when (numberp pos) + (when pos (goto-char pos)) (move-overlay erc--keep-place-overlay (line-beginning-position) @@ -254,7 +263,10 @@ erc-keep-place-goto "Jump to keep-place indicator." (interactive) (goto-char (overlay-start erc--keep-place-overlay)) - (recenter (truncate (* (window-height) 0.25)) t)) + (recenter (truncate (* (window-height) 0.25)) t) + (require 'pulse) + (when (pulse-available-p) + (pulse-momentary-highlight-overlay erc--keep-place-overlay))) (defun erc-keep-place (_ignored) "Move point away from the last line in a non-selected ERC buffer." @@ -265,7 +277,10 @@ erc-keep-place (goto-char (erc-beg-of-input-line)) (forward-line -1) (when erc-keep-place-indicator - (erc-keep-place-move)) + (unless (or (minibuffer-window-active-p (selected-window)) + (and (frame-visible-p (selected-frame)) + (get-buffer-window (current-buffer) (selected-frame)))) + (erc-keep-place-move))) ;; if `switch-to-buffer-preserve-window-point' is set, ;; we cannot rely on point being saved, and must commit ;; it to window-prev-buffers. -- 2.38.1