Make lsp-headerline--check-breadcrumb public so that it can be added to after-*-jump-hooks by external code (#4803)

* make lsp-headerline--check-breadcrumb public

* update docs

* update changelog

Author: dhashe

CHANGELOG.org

@@ -40,6 +40,7 @@
   * Add support for ~source.removeUnusedImports~ for lsp-javascript
   * Add Python(ty) support
   * Add support for [[https://github.com/tombi-toml/tombi][Tombi language server]] (TOML language).
+  * Make lsp-headerline--check-breadcrumb public
 
 ** 9.0.0
   * Add language server config for QML (Qt Modeling Language) using qmlls.

docs/page/faq.md

@@ -85,3 +85,18 @@ You can use `lsp-clients-clangd-args` to configure your clangd. Add the followin
 For more flags, see clangd --help.
 
 (Thanks to [Martingale on Emacs StackExchange](https://emacs.stackexchange.com/questions/58015/how-to-stop-lsp-mode-including-headers-automatically-for-c-c-code) for this answer!)
+
+---
+### :grey_question: I have lsp-headerline-breadcrumb-mode enabled but the breadcrumb isn't always updating, for example when previewing results in consult-xref.
+
+The function that updates the breadcrumb is `lsp-headerline-check-breadcrumb`. By default, this is added to `xref-after-jump-hook`, so that the breadcrumb will update immediately after jumping to a new location. Some packages, such as consult during previews, do jumps without calling `xref-after-jump-hook`, so the breadcrumb never updates.
+
+The solution is to add `lsp-headerline-check-breadcrumb` to the appropriate hook. For consult, add the following to your user configuration:
+
+  ```elisp
+  (add-hook 'lsp-headerline-breadcrumb-mode-hook
+            (lambda ()
+              (if lsp-headerline-breadcrumb-mode
+                  (add-hook 'consult-after-jump-hook #'lsp-headerline-check-breadcrumb nil t)
+                  (remove-hook 'consult-after-jump-hook #'lsp-headerline-check-breadcrumb t))))
+  ```

lsp-headerline.el

@@ -407,7 +407,7 @@ PATH is the current folder to be checked."
     lsp-headerline-breadcrumb-segments
     "")))
 
-(defun lsp-headerline--check-breadcrumb (&rest _)
+(defun lsp-headerline-check-breadcrumb (&rest _)
   "Request for document symbols to build the breadcrumb."
   (set-window-parameter (selected-window) 'lsp-headerline--string (lsp-headerline--build-string))
   (force-mode-line-update))
@@ -440,17 +440,17 @@ PATH is the current folder to be checked."
       (setq header-line-format (list header-line-format)))
     (add-to-list 'header-line-format '(t (:eval (window-parameter nil 'lsp-headerline--string) )))
 
-    (add-hook 'xref-after-jump-hook #'lsp-headerline--check-breadcrumb nil t)
+    (add-hook 'xref-after-jump-hook #'lsp-headerline-check-breadcrumb nil t)
 
-    (add-hook 'lsp-on-idle-hook #'lsp-headerline--check-breadcrumb nil t)
+    (add-hook 'lsp-on-idle-hook #'lsp-headerline-check-breadcrumb nil t)
     (add-hook 'lsp-configure-hook #'lsp-headerline--enable-breadcrumb nil t)
     (add-hook 'lsp-unconfigure-hook #'lsp-headerline--disable-breadcrumb nil t))
    (t
-    (remove-hook 'lsp-on-idle-hook #'lsp-headerline--check-breadcrumb t)
+    (remove-hook 'lsp-on-idle-hook #'lsp-headerline-check-breadcrumb t)
     (remove-hook 'lsp-configure-hook #'lsp-headerline--enable-breadcrumb t)
     (remove-hook 'lsp-unconfigure-hook #'lsp-headerline--disable-breadcrumb t)
 
-    (remove-hook 'xref-after-jump-hook #'lsp-headerline--check-breadcrumb t)
+    (remove-hook 'xref-after-jump-hook #'lsp-headerline-check-breadcrumb t)
 
     (setq lsp-headerline--path-up-to-project-segments nil)
     (setq header-line-format (remove '(t (:eval (window-parameter nil 'lsp-headerline--string) )) header-line-format)))))