From bad9830c78319263b072abe20ba39d015e2acb94 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20T=C3=A1vora?= Date: Sat, 19 Oct 2019 23:07:47 +0100 Subject: [PATCH] Fix #324: let user keep control of some variables during Eglot sessions * NEWS.md: Mention new variable eglot-stay-out-of * eglot.el (eglot-stay-out-of): New variable. (eglot--setq-saving): Use it. (eglot--managed-mode): Use eglot--setq-saving for imenu. No need to remove 'eglot-flymake-backend from diagnostic functions. #324: https://github.com/joaotavora/eglot/issues/324 --- lisp/progmodes/eglot.el | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el index 09c1461a06..7a22b5c33b 100644 --- a/lisp/progmodes/eglot.el +++ b/lisp/progmodes/eglot.el @@ -1172,8 +1172,33 @@ and just return it. PROMPT shouldn't end with a question mark." (defvar-local eglot--saved-bindings nil "Bindings saved by `eglot--setq-saving'.") +(defvar eglot-stay-out-of '() + "List of Emacs things that Eglot should try to stay of. +Before Eglot starts \"managing\" a particular buffer, it +opinionatedly sets some peripheral Emacs facilites, such as +Flymake, Xref and Company. These overriding settings help ensure +consistent Eglot behaviour and only stay in place until +\"managing\" stops (usually via `eglot-shutdown'), whereupon the +previous settings are restored. + +However, if you wish for Eglot to stay out of a particular Emacs +facility that you'd like to keep control of, add a string, a +symbol, or a regexp here that will be matched against the +variable's name, and Eglot will refrain from setting it. + +For example, to keep your Company customization use + +(add-to-list 'eglot-stay-out-of 'company)") + (defmacro eglot--setq-saving (symbol binding) - `(when (boundp ',symbol) + `(when (and (boundp ',symbol) + (not (cl-find (symbol-name ',symbol) + eglot-stay-out-of + :test + (lambda (s thing) + (let ((re (if (symbolp thing) (symbol-name thing) + thing))) + (string-match re s)))))) (push (cons ',symbol (symbol-value ',symbol)) eglot--saved-bindings) (setq-local ,symbol ,binding))) @@ -1200,11 +1225,10 @@ and just return it. PROMPT shouldn't end with a question mark." (eglot--setq-saving xref-prompt-for-identifier nil) (eglot--setq-saving flymake-diagnostic-functions '(eglot-flymake-backend t)) (eglot--setq-saving company-backends '(company-capf)) - (add-function :around (local 'imenu-create-index-function) #'eglot-imenu) + (eglot--setq-saving imenu-create-index-function #'eglot-imenu) (flymake-mode 1) (eldoc-mode 1)) (t - (remove-hook 'flymake-diagnostic-functions 'eglot-flymake-backend t) (remove-hook 'after-change-functions 'eglot--after-change t) (remove-hook 'before-change-functions 'eglot--before-change t) (remove-hook 'kill-buffer-hook 'eglot--signal-textDocument/didClose t)