bug#46992: xref-after-update-hook

bug#46992: xref-after-update-hook

[Juri Linkov]

[-- Attachment #1: Type: text/plain, Size: 172 bytes --]

Version: 28.0.50
Severity: wishlist
Tags: patch

As suggested in https://lists.gnu.org/archive/html/emacs-devel/2021-03/msg00161.html
here is a patch that adds such hook:


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: xref-after-update-hook.patch --]
[-- Type: text/x-diff, Size: 912 bytes --]

diff --git a/lisp/progmodes/xref.el b/lisp/progmodes/xref.el
index 18fdd963fb..ba4e48faf8 100644
--- a/lisp/progmodes/xref.el
+++ b/lisp/progmodes/xref.el
@@ -415,6 +415,10 @@ xref-after-return-hook
   "Functions called after returning to a pre-jump location."
   :type 'hook)
 
+(defcustom xref-after-update-hook nil
+  "Functions called after the xref buffer is updated."
+  :type 'hook)
+
 (defvar xref--marker-ring (make-ring xref-marker-ring-length)
   "Ring of markers to implement the marker stack.")
 
@@ -919,7 +933,8 @@ xref--insert-xrefs
                                        "RET or mouse-1: follow reference"))
                          prefix new-summary)
                         (setq prev-line-key line-key)))
-                    (insert "\n"))))
+                    (insert "\n")))
+  (run-hooks 'xref-after-update-hook))
 
 (defun xref--analyze (xrefs)
   "Find common filenames in XREFS.

bug#46992: xref-after-update-hook

[Dmitry Gutov]

Hi!

On 07.03.2021 20:50, Juri Linkov wrote:
> As suggested inhttps://lists.gnu.org/archive/html/emacs-devel/2021-03/msg00161.html
> here is a patch that adds such hook:

The patch LGTM, but have you tried using xref--xref-buffer-mode-hook?

bug#46992: xref-after-update-hook

[Juri Linkov]

>> As suggested inhttps://lists.gnu.org/archive/html/emacs-devel/2021-03/msg00161.html
>> here is a patch that adds such hook:
>
> The patch LGTM, but have you tried using xref--xref-buffer-mode-hook?

This is the first thing that I tried, but the problem is that
it's called before the xref buffer is filled with results
where I need to put overlays on output lines.

Also the hook needs to be called after reverting xref buffer.

bug#46992: xref-after-update-hook

[Dmitry Gutov]

On 07.03.2021 22:43, Juri Linkov wrote:
> This is the first thing that I tried, but the problem is that
> it's called before the xref buffer is filled with results
> where I need to put overlays on output lines.
> 
> Also the hook needs to be called after reverting xref buffer.

I figured if all you are doing is some setup and turning on a minor 
mode, it should be enough to only do once. A minor mode would generally 
track all subsequent modifications to the buffer with 
after-change-functions or the like (we don't bind 
(inhibit-modification-hooks t) while rendering the output, although it 
looks like we might, for a small extra speed boost).

But if that doesn't work for some reason, or doesn't cover all your 
goals, please feel free to install the patch.

bug#46992: xref-after-update-hook

[Juri Linkov]

tags 46992 fixed
close 46992 28.0.50
thanks

>> This is the first thing that I tried, but the problem is that
>> it's called before the xref buffer is filled with results
>> where I need to put overlays on output lines.
>> Also the hook needs to be called after reverting xref buffer.
>
> I figured if all you are doing is some setup and turning on a minor mode,
> it should be enough to only do once. A minor mode would generally track all
> subsequent modifications to the buffer with after-change-functions or the
> like (we don't bind (inhibit-modification-hooks t) while rendering the
> output, although it looks like we might, for a small extra speed boost).

We can't overburden minor modes with such complexity that is not used
most of the time.

> But if that doesn't work for some reason, or doesn't cover all your goals,
> please feel free to install the patch.

Ok, pushed to master, and closed.