mirror of
git://git.sv.gnu.org/emacs.git
synced 2026-01-07 20:30:32 -08:00
1841299a11
Inlay hints are small text annotations to specific parts of the whole buffer, not unlike diagnostics, but designed to help readability instead of indicating problems. For example, a C++ LSP server can serve hints about positional parameter names in function calls and a variable's automatically deduced type. Emacs can display these hints in many little 0-length overlays with an 'before-string property, thus helping the user remember those types and parameter names. Since inlay hints are potentially a large amount of data to request from the LSP server, the implementation strives to be as parsimonious as possible with these requests. So, by default, inlay hints are only requested for the visible portions of the buffer across windows showing this buffer. This is done by leveraging the 'window-scroll-functions' variable, making for a reasonably complex implementation involving per-window timers. When scrolling a window, it may take a short amount of time for inlay hints to "pop in". The new user variable 'eglot-lazy-inlay-hints' can be used to exert some control over this. Specifically, if the variable's value is set to 'nil', then inlay hints are greedily fetched for the whole buffer every time a change occurs. This is a much simpler mode of operation which may avoid problems, but is also likely much slower in large buffers. Also, because the inlay feature is probably visually suprising to some, it is turned OFF by default, which is not the usual practice of Eglot (at least not when the necessary infrastructure is present). This decision may be changed soon. Here's a good one-liner for enabling it by default in every Eglot-managed buffer: (add-hook 'eglot-managed-mode-hook #'eglot-inlay-hints-mode) I haven't tested inlay hints extensively across many LSP servers, so I would appreciate any testing, both for functional edge cases and regarding performance. There are possibly more optimization oportunities in the "lazy" mode of operation, like more aggressively deleting buffer overlays that are not in visible parts of the buffer. Though I ended up writing this one from scratch, I want to thank Dimitry Bolopopsky <dimitri@belopopsky.com> and Chinmay Dala <dalal.chinmay.0101@gmail.com> for suggestions and early patches. * lisp/progmodes/eglot.el (eglot--lsp-interface-alist): Define InlayHint. (eglot-client-capabilities): Announce 'inlayHint' capability. (eglot-ignored-server-capabilities): Add :inlayHintProvider. (eglot--document-changed-hook): New helper hook. (eglot--after-change): Use it. (eglot-inlay-hint-face, eglot-type-hint-face) (eglot-parameter-hint-face): New faces. (eglot--update-hints-1, eglot--inlay-hints-after-scroll) (eglot--inlay-hints-fully, eglot--inlay-hints-lazily): New helpers. (eglot-lazy-inlay-hints): New user variable. (eglot-inlay-hints-mode): New minor mode. (eglot--maybe-activate-editing-mode): Try to activate eglot-inlay-hints-mode. (eglot--before-change): Remove overlays immediately in the area being changed. (eglot--managed-mode-off): Remove overlays. * doc/misc/eglot.texi (Eglot Features): Mention inlay hints. (Eglot Variables): Mention eglot-lazy-inlay-hints. |
||
|---|---|---|
| .. | ||
| antlr-mode.el | ||
| asm-mode.el | ||
| autoconf.el | ||
| bat-mode.el | ||
| bug-reference.el | ||
| c-ts-common.el | ||
| c-ts-mode.el | ||
| cc-align.el | ||
| cc-awk.el | ||
| cc-bytecomp.el | ||
| cc-cmds.el | ||
| cc-defs.el | ||
| cc-engine.el | ||
| cc-fonts.el | ||
| cc-guess.el | ||
| cc-langs.el | ||
| cc-menus.el | ||
| cc-mode.el | ||
| cc-styles.el | ||
| cc-vars.el | ||
| cfengine.el | ||
| cl-font-lock.el | ||
| cmacexp.el | ||
| cmake-ts-mode.el | ||
| compile.el | ||
| cperl-mode.el | ||
| cpp.el | ||
| csharp-mode.el | ||
| cwarn.el | ||
| dcl-mode.el | ||
| dockerfile-ts-mode.el | ||
| ebnf-abn.el | ||
| ebnf-bnf.el | ||
| ebnf-dtd.el | ||
| ebnf-ebx.el | ||
| ebnf-iso.el | ||
| ebnf-otz.el | ||
| ebnf-yac.el | ||
| ebnf2ps.el | ||
| ebrowse.el | ||
| eglot.el | ||
| elisp-mode.el | ||
| erts-mode.el | ||
| etags.el | ||
| executable.el | ||
| f90.el | ||
| flymake-cc.el | ||
| flymake-proc.el | ||
| flymake.el | ||
| fortran.el | ||
| gdb-mi.el | ||
| glasses.el | ||
| go-ts-mode.el | ||
| grep.el | ||
| gud.el | ||
| hideif.el | ||
| hideshow.el | ||
| icon.el | ||
| idlw-complete-structtag.el | ||
| idlw-help.el | ||
| idlw-shell.el | ||
| idlw-toolbar.el | ||
| idlwave.el | ||
| inf-lisp.el | ||
| java-ts-mode.el | ||
| js.el | ||
| json-ts-mode.el | ||
| ld-script.el | ||
| m4-mode.el | ||
| make-mode.el | ||
| meta-mode.el | ||
| mixal-mode.el | ||
| modula2.el | ||
| octave.el | ||
| opascal.el | ||
| pascal.el | ||
| perl-mode.el | ||
| prog-mode.el | ||
| project.el | ||
| prolog.el | ||
| ps-mode.el | ||
| python.el | ||
| ruby-mode.el | ||
| ruby-ts-mode.el | ||
| rust-ts-mode.el | ||
| scheme.el | ||
| sh-script.el | ||
| simula.el | ||
| sql.el | ||
| subword.el | ||
| tcl.el | ||
| typescript-ts-mode.el | ||
| vera-mode.el | ||
| verilog-mode.el | ||
| vhdl-mode.el | ||
| which-func.el | ||
| xref.el | ||
| xscheme.el | ||