Simplify option erc-merge-wrap-merge-indicator

* lisp/erc/erc-fill.el (erc-fill-wrap-merge-indicator): Reduce
offering of acceptable values by removing leading symbols and ditching
the `post' variant entirely.  The justification for the latter move
hinges on it not being well suited to next-gen requirements involving
the splicing and deletion of inserted messages.  Meeting these would
be overly burdensome and involve scanning the buffer in both
directions for every such operation.  This option is new in ERC 5.6,
which is yet unreleased.
(erc-fill--wrap-massage-legacy-indicator-type): New function to warn
of obsolete `erc-fill-wrap-merge-indicator' value and perform a
migration for the current session.
(erc-fill-wrap, erc-fill-wrap-enable): Preform preflight compat check
for obsolete `erc-fill-wrap-merge-indicator' value types.
(erc-fill-wrap-disable): Don't bother killing nonexistent variable
`erc-fill--wrap-merge-indicator-post'.
(erc-fill--wrap-merge-indicator-post): Remove unused variable.
(erc-fill--wrap-insert-merged-post): Remove unused function.
(erc-fill--wrap-insert-merged-pre): Adapt to simplified format for
option `erc-merge-wrap-merge-indicator'.
(erc-fill-wrap): Remove conditional dispatch because there is only one
path and only one indicator style.
(erc-fill--wrap-rejigger-region): Remove reference to nonexistent
variable `erc-fill--wrap-merge-indicator-post'.
* test/lisp/erc/erc-fill-tests.el
(erc-fill-wrap--merge-action/indicator-pre): Update format of value
for option `erc-fill-wrap-merge-indicator'.
(erc-fill-wrap--merge-action/indicator-post): Remove test focusing on
obsolete and unsupported `post' variant of option
`erc-fill-wrap-merge-indicator'.
(erc-fill--wrap-massage-legacy-indicator-type): New test.
* test/lisp/erc/resources/fill/snapshots/merge-wrap-indicator-post-01.eld:
Delete file.  (Bug#60936)

(cherry picked from commit c572c30fb121008e5b248688ebe319dd85633c72)

diff --git a/lisp/erc/erc-fill.el b/lisp/erc/erc-fill.el
index aa12b807fbc1f55791c75b39b5edbab34a55b886..7e21a097c7c0d64e0f39d2723903cf2eb0702d5e 100644 (file)
--- a/lisp/erc/erc-fill.el
+++ b/lisp/erc/erc-fill.el
@@ -274,16 +274,10 @@ merged messages, see option `erc-fill-wrap-merge-indicator'."
 (defcustom erc-fill-wrap-merge-indicator nil
   "Indicator to help distinguish between merged messages.
 Only matters when the option `erc-fill-wrap-merge' is enabled.
-If the first element is the symbol `pre', ERC uses this option to
-generate a replacement for the speaker's name tag.  If the first
-element is `post', ERC affixes a short string to the end of the
-previous message.  In either case, the second element should be a
-character, like ?>, and the last element a valid face.  In
-special cases, you may also specify a cons of either
-aforementioned symbol and a string, which tells ERC not to manage
-the process for you.  If unsure, try either of the first two
-presets, both of which replace a continued speaker's name with a
-dot-product-like character in a `shadow'-like face.
+If the value is a cons of a character, like ?>, and a valid face,
+ERC generates a replacement for the speaker's name tag.  The
+first two presets replace a continued speaker's name with a
+bullet-like character in `shadow' face.
 
 Note that as of ERC 5.6, this option is still experimental, and
 changing its value mid-session is not yet supported (though, if
@@ -300,20 +294,14 @@ command."
   :type
   '(choice (const nil)
            (const :tag "Leading MIDDLE DOT (U+00B7) as speaker"
-                  (pre #xb7 erc-fill-wrap-merge-indicator-face))
+                  (#xb7 . erc-fill-wrap-merge-indicator-face))
            (const :tag "Leading MIDDLE DOT (U+00B7) sans gap"
-                  (pre . #("\u00b7" 0 1 (font-lock-face
-                                         erc-fill-wrap-merge-indicator-face))))
+                  #("\u00b7"
+                    0 1 (font-lock-face erc-fill-wrap-merge-indicator-face)))
            (const :tag "Leading RIGHT-ANGLE BRACKET (>) as speaker"
-                  (pre ?> erc-fill-wrap-merge-indicator-face))
-           (const :tag "Trailing PARAGRAPH SIGN (U+00B6)"
-                  (post #xb6 erc-fill-wrap-merge-indicator-face))
-           (const :tag "Trailing TILDE (~)"
-                  (post ?~ erc-fill-wrap-merge-indicator-face))
-           (cons :tag "User-provided string (advanced)"
-                 (choice (const pre) (const post)) string)
-           (list :tag "User-provided character-face pairing"
-                 (choice (const pre) (const post)) character face)))
+                  (?> . erc-fill-wrap-merge-indicator-face))
+           (string :tag "User-provided string (advanced)")
+           (cons :tag "User-provided character-face pairing" character face)))
 
 (defun erc-fill--wrap-move (normal-cmd visual-cmd &rest args)
   (apply (pcase erc-fill--wrap-visual-keys
@@ -459,6 +447,28 @@ is 0, reset to value of `erc-fill-wrap-visual-keys'."
         " warning. See Info:\"(erc) Modules\" for more."
         (mapcar (lambda (s) (format "`%s'" s)) missing-deps)))))
 
+(defun erc-fill--wrap-massage-legacy-indicator-type ()
+  "Migrate obsolete 5.6-git `erc-fill-wrap-merge-indicator' format."
+  (pcase erc-fill-wrap-merge-indicator
+    (`(post . ,_)
+     (erc--warn-once-before-connect 'erc-fill-wrap-mode
+       "The option `erc-fill-wrap-merge-indicator' has changed. Unfortunately,"
+       " the `post' variant and related presets are no longer available."
+       " Setting to nil for the current session. Apologies for the disruption."
+       (setq erc-fill-wrap-merge-indicator nil)))
+    (`(pre . ,(and (pred stringp) string))
+     (erc--warn-once-before-connect 'erc-fill-wrap-mode
+       "The format of option `erc-fill-wrap-merge-indicator' has changed"
+       " from a cons of (pre . STRING) to STRING. Please update your settings."
+       " Changing temporarily to \"" string "\" for the current session.")
+     (setq erc-fill-wrap-merge-indicator string))
+    (`(pre ,(and (pred characterp) char) ,face)
+     (erc--warn-once-before-connect 'erc-fill-wrap-mode
+       "The format of option `erc-fill-wrap-merge-indicator' has changed"
+       " from (pre CHAR FACE) to a cons of (CHAR . FACE). Please update"
+       " when possible. Changing temporarily to %S for the current session."
+       (setq erc-fill-wrap-merge-indicator (cons char face))))))
+
 ;;;###autoload(put 'fill-wrap 'erc--feature 'erc-fill)
 (define-erc-module fill-wrap nil
   "Fill style leveraging `visual-line-mode'.
@@ -505,6 +515,8 @@ enabled when shutting down.  To opt out of `scrolltobottom'
 specifically, disable its minor mode, `erc-scrolltobottom-mode',
 via `erc-fill-wrap-mode-hook'."
   ((erc-fill--wrap-ensure-dependencies)
+   (when erc-fill-wrap-merge-indicator
+     (erc-fill--wrap-massage-legacy-indicator-type))
    (erc--restore-initialize-priors erc-fill-wrap-mode
      erc-fill--wrap-visual-keys erc-fill-wrap-visual-keys
      erc-fill--wrap-value erc-fill-static-center
@@ -536,7 +548,6 @@ via `erc-fill-wrap-mode-hook'."
    (kill-local-variable 'erc-fill--wrap-last-msg)
    (kill-local-variable 'erc--inhibit-prompt-display-property-p)
    (kill-local-variable 'erc-fill--wrap-merge-indicator-pre)
-   (kill-local-variable 'erc-fill--wrap-merge-indicator-post)
    (remove-hook 'erc--refresh-prompt-hook
                 #'erc-fill--wrap-indent-prompt)
    (remove-hook 'erc-button--prev-next-predicate-functions
@@ -612,35 +623,6 @@ to be disabled."
   "Whether to dedent speakers in CTCP \"ACTION\" lines.")
 
 (defvar-local erc-fill--wrap-merge-indicator-pre nil)
-(defvar-local erc-fill--wrap-merge-indicator-post nil)
-
-;; To support `erc-fill-line-spacing' with the "post" variant, we'd
-;; need to use a new "replacing" `display' spec value for each
-;; insertion, and add a sentinel property alongside it atop every
-;; affected newline, e.g., (erc-fill-eol-display START-POS), where
-;; START-POS is the position of the newline in the replacing string.
-;; Then, upon spotting this sentinel in `erc-fill' (and maybe
-;; `erc-fill-wrap-refill-buffer'), we'd add `line-spacing' to the
-;; corresponding `display' replacement, starting at START-POS.
-(defun erc-fill--wrap-insert-merged-post ()
-  "Add `display' property at end of previous line."
-  (save-excursion
-    (goto-char (point-min))
-    (save-restriction
-      (widen)
-      (cl-assert (= ?\n (char-before (point))))
-      (unless erc-fill--wrap-merge-indicator-post
-        (let ((option (cdr erc-fill-wrap-merge-indicator)))
-          (setq erc-fill--wrap-merge-indicator-post
-                (if (stringp option)
-                    (concat option
-                            (and (not (string-suffix-p "\n" option)) "\n"))
-                  (propertize (concat (string (car option)) "\n")
-                              'font-lock-face (cadr option))))))
-      (unless (eq (field-at-pos (- (point) 2)) 'erc-timestamp)
-        (put-text-property (1- (point)) (point)
-                           'display erc-fill--wrap-merge-indicator-post)))
-    0))
 
 (defun erc-fill--wrap-insert-merged-pre ()
   "Add `display' property in lieu of speaker."
@@ -649,11 +631,11 @@ to be disabled."
         (put-text-property (point-min) (point) 'display
                            (car erc-fill--wrap-merge-indicator-pre))
         (cdr erc-fill--wrap-merge-indicator-pre))
-    (let* ((option (cdr erc-fill-wrap-merge-indicator))
+    (let* ((option erc-fill-wrap-merge-indicator)
            (s (if (stringp option)
                   (concat option)
                 (concat (propertize (string (car option))
-                                    'font-lock-face (cadr option))
+                                    'font-lock-face (cdr option))
                         " "))))
       (put-text-property (point-min) (point) 'display s)
       (cdr (setq erc-fill--wrap-merge-indicator-pre
@@ -693,9 +675,7 @@ See `erc-fill-wrap-mode' for details."
                             (put-text-property (point-min) (point)
                                                'display "")
                             (if erc-fill-wrap-merge-indicator
-                                (pcase (car erc-fill-wrap-merge-indicator)
-                                  ('pre (erc-fill--wrap-insert-merged-pre))
-                                  ('post (erc-fill--wrap-insert-merged-post)))
+                                (erc-fill--wrap-insert-merged-pre)
                               0))
                            (t
                             (erc-fill--wrap-measure (point-min) (point))))))))
@@ -732,8 +712,7 @@ case this module's insert hooks run by way of the process filter.
 With REPAIRP, destructively fill gaps and re-merge speakers."
   (goto-char start)
   (cl-assert (null erc-fill--wrap-rejigger-last-message))
-  (setq erc-fill--wrap-merge-indicator-pre nil
-        erc-fill--wrap-merge-indicator-post nil)
+  (setq erc-fill--wrap-merge-indicator-pre nil)
   (let (erc-fill--wrap-rejigger-last-message)
     (while-let
         (((< (point) finish))

diff --git a/test/lisp/erc/erc-fill-tests.el b/test/lisp/erc/erc-fill-tests.el
index 3c4ad04abd7ae6e4df4eef8b0e73311a73f09e00..79cfc1190bc53a9c6a4e1601a5e9079a3a71289b 100644 (file)
--- a/test/lisp/erc/erc-fill-tests.el
+++ b/test/lisp/erc/erc-fill-tests.el
@@ -299,17 +299,9 @@
 (ert-deftest erc-fill-wrap--merge-action/indicator-pre ()
   :tags `(:unstable
           ,@(and (getenv "ERC_TESTS_GRAPHICAL") '(:erc--graphical)))
-  (let ((erc-fill-wrap-merge-indicator '(pre ?> shadow)))
+  (let ((erc-fill-wrap-merge-indicator '(?> . shadow)))
     (erc-fill-wrap-tests--merge-action "merge-wrap-indicator-pre-01")))
 
-;; One crucial thing this test asserts is that the indicator is
-;; omitted when the previous line ends in a stamp.
-(ert-deftest erc-fill-wrap--merge-action/indicator-post ()
-  :tags `(:unstable
-          ,@(and (getenv "ERC_TESTS_GRAPHICAL") '(:erc--graphical)))
-  (let ((erc-fill-wrap-merge-indicator '(post ?~ shadow)))
-    (erc-fill-wrap-tests--merge-action "merge-wrap-indicator-post-01")))
-
 (ert-deftest erc-fill-line-spacing ()
   :tags `(:unstable
           ,@(and (getenv "ERC_TESTS_GRAPHICAL") '(:erc--graphical)))
@@ -450,4 +442,34 @@
                                   rear-nonsticky t
                                   font-lock-face erc-prompt-face))))))))))
 
+(ert-deftest erc-fill--wrap-massage-legacy-indicator-type ()
+  (let (calls
+        erc-fill-wrap-merge-indicator)
+    (cl-letf (((symbol-function 'erc--warn-once-before-connect)
+               (lambda (_ &rest args) (push args calls))))
+      ;; List of (pre CHAR FACE) becomes (CHAR . FACE).
+      (let ((erc-fill-wrap-merge-indicator
+             '(pre #xb7 erc-fill-wrap-merge-indicator-face)))
+        (erc-fill--wrap-massage-legacy-indicator-type)
+        (should (equal erc-fill-wrap-merge-indicator
+                       '(#xb7 . erc-fill-wrap-merge-indicator-face)))
+        (should (string-search "(pre CHAR FACE)" (nth 1 (pop calls)))))
+
+      ;; Cons of (CHAR . STRING) becomes STRING.
+      (let ((erc-fill-wrap-merge-indicator '(pre . "\u00b7")))
+        (erc-fill--wrap-massage-legacy-indicator-type)
+        (should (equal erc-fill-wrap-merge-indicator "\u00b7"))
+        (should (string-search "(pre . STRING)" (nth 1 (pop calls)))))
+
+      ;; Anything with a CAR of `post' becomes nil.
+      (let ((erc-fill-wrap-merge-indicator
+             '(post #xb6 erc-fill-wrap-merge-indicator-face)))
+        (erc-fill--wrap-massage-legacy-indicator-type)
+        (should-not erc-fill-wrap-merge-indicator)
+        (should (string-search "no longer available" (nth 1 (pop calls)))))
+      (let ((erc-fill-wrap-merge-indicator '(post . "\u00b7")))
+        (erc-fill--wrap-massage-legacy-indicator-type)
+        (should-not erc-fill-wrap-merge-indicator)
+        (should (string-search "no longer available" (nth 1 (pop calls))))))))
+
 ;;; erc-fill-tests.el ends here

diff --git a/test/lisp/erc/resources/fill/snapshots/merge-wrap-indicator-post-01.eld b/test/lisp/erc/resources/fill/snapshots/merge-wrap-indicator-post-01.eld
deleted file mode 100644 (file)
index e019e60..0000000
--- a/test/lisp/erc/resources/fill/snapshots/merge-wrap-indicator-post-01.eld
+++ /dev/null
@@ -1 +0,0 @@
-#("\n\n\n[Thu Jan  1 1970]\n*** This server is in debug mode and is logging all user I/O. If you do not wish for everything you send to be readable by the server owner(s), please disconnect. [00:00]\n<alice> bob: come, you are a tedious fool: to the purpose. What was done to Elbow's wife, that he hath cause to complain of? Come me to what was done to her.\n<bob> alice: Either your unparagoned mistress is dead, or she's outprized by a trifle.\n\n[Sat Apr  1 2023]\n<bob> zero. [07:00]\n<bob> 0.5\n* bob one.\n<bob> two.\n<bob> 2.5\n* bob three\n<bob> four.\n" 2 3 (erc--msg datestamp erc--ts 0 field erc-timestamp) 3 20 (field erc-timestamp wrap-prefix #1=(space :width 27) line-prefix (space :width (- 27 (18)))) 21 22 (erc--msg notice erc--ts 0 wrap-prefix #1# line-prefix #2=(space :width (- 27 (4)))) 22 183 (wrap-prefix #1# line-prefix #2#) 183 184 (field erc-timestamp wrap-prefix #1# line-prefix #2#) 184 191 (field erc-timestamp wrap-prefix #1# line-prefix #2# display (#5=(margin right-margin) #("[00:00]" 0 7 (invisible timestamp)))) 192 193 (erc--msg msg erc--spkr "alice" erc--ts 0 erc--cmd PRIVMSG wrap-prefix #1# line-prefix #3=(space :width (- 27 (8)))) 193 198 (wrap-prefix #1# line-prefix #3#) 198 200 (wrap-prefix #1# line-prefix #3#) 200 203 (wrap-prefix #1# line-prefix #3#) 203 316 (wrap-prefix #1# line-prefix #3#) 317 349 (wrap-prefix #1# line-prefix #3#) 350 351 (erc--msg msg erc--spkr "bob" erc--ts 0 erc--cmd PRIVMSG wrap-prefix #1# line-prefix #4=(space :width (- 27 (6)))) 351 354 (wrap-prefix #1# line-prefix #4#) 354 356 (wrap-prefix #1# line-prefix #4#) 356 361 (wrap-prefix #1# line-prefix #4#) 361 436 (wrap-prefix #1# line-prefix #4#) 437 438 (erc--msg datestamp erc--ts 1680307200 field erc-timestamp) 438 455 (field erc-timestamp wrap-prefix #1# line-prefix (space :width (- 27 (18)))) 456 457 (erc--msg msg erc--spkr "bob" erc--ts 1680332400 erc--cmd PRIVMSG wrap-prefix #1# line-prefix #6=(space :width (- 27 (6)))) 457 460 (wrap-prefix #1# line-prefix #6#) 460 467 (wrap-prefix #1# line-prefix #6#) 467 468 (field erc-timestamp wrap-prefix #1# line-prefix #6#) 468 475 (field erc-timestamp wrap-prefix #1# line-prefix #6# display (#5# #("[07:00]" 0 7 (invisible timestamp)))) 476 477 (erc--msg msg erc--spkr "bob" erc--ts 1680332400 erc--cmd PRIVMSG wrap-prefix #1# line-prefix #7=(space :width (- 27 0)) display #8="") 477 480 (wrap-prefix #1# line-prefix #7# display #8#) 480 482 (wrap-prefix #1# line-prefix #7# display #8#) 482 485 (wrap-prefix #1# line-prefix #7#) 486 487 (erc--msg ctcp-action erc--spkr "bob" erc--ts 1680332400 erc--cmd PRIVMSG erc--ctcp ACTION wrap-prefix #1# line-prefix #9=(space :width (- 27 (6)))) 487 488 (wrap-prefix #1# line-prefix #9#) 488 491 (wrap-prefix #1# line-prefix #9#) 491 496 (wrap-prefix #1# line-prefix #9#) 497 498 (erc--msg msg erc--spkr "bob" erc--ts 1680332400 erc--cmd PRIVMSG wrap-prefix #1# line-prefix #10=(space :width (- 27 (6)))) 498 501 (wrap-prefix #1# line-prefix #10#) 501 507 (wrap-prefix #1# line-prefix #10#) 507 508 (display #("~\n" 0 2 (font-lock-face shadow))) 508 509 (erc--msg msg erc--spkr "bob" erc--ts 1680332400 erc--cmd PRIVMSG wrap-prefix #1# line-prefix #11=(space :width (- 27 0)) display #8#) 509 512 (wrap-prefix #1# line-prefix #11# display #8#) 512 514 (wrap-prefix #1# line-prefix #11# display #8#) 514 517 (wrap-prefix #1# line-prefix #11#) 518 519 (erc--msg ctcp-action erc--spkr "bob" erc--ts 1680332400 erc--cmd PRIVMSG erc--ctcp ACTION wrap-prefix #1# line-prefix #12=(space :width (- 27 (2)))) 519 520 (wrap-prefix #1# line-prefix #12#) 520 523 (wrap-prefix #1# line-prefix #12#) 523 529 (wrap-prefix #1# line-prefix #12#) 530 531 (erc--msg msg erc--spkr "bob" erc--ts 1680332400 erc--cmd PRIVMSG wrap-prefix #1# line-prefix #13=(space :width (- 27 (6)))) 531 534 (wrap-prefix #1# line-prefix #13#) 534 541 (wrap-prefix #1# line-prefix #13#))
\ No newline at end of file