jessieh/eldoc-frame
jessieh/eldoc-frame
1
Fork 0
Code Issues Pull Requests Releases Activity

Clean up childframe after ElDoc

Browse Source 
Add cleanup function and a idle timer

Why a timer? ElDoc is mainly use in minibuffer,
where the text is constantly being flushed by other commands
so ElDoc doesn't try very hard to cleanup
This commit is contained in:
Yuan Fu 2018-12-12 00:03:38 -05:00
parent 3fab3fb571
commit 388282f59f
No known key found for this signature in database
GPG Key ID: 1CF5ECABEC37A901
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
eldoc-box.el
View File

@ -181,6 +181,23 @@ Checkout `lsp-ui-doc--make-frame', `lsp-ui-doc--move-frame'."
(setq eldoc-box--frame frame)))
;;;;; ElDoc
(defvar eldoc-box--cleanup-timer nil
"The timer used to cleanup childframe after ElDoc.")
(defun eldoc-box--maybe-cleanup ()
"Clean up after ElDOc."
;; timer is global, so this function will be called outside
;; the buffer with `eldoc-box-hover-mode' enabled
(if eldoc-box-hover-mode
;; if eldoc-last-message is nil, the childframe is cleared
(eldoc-box--eldoc-message-function eldoc-last-message)
;; sometimes you switched buffer when childframe is on.
;; it wouldn't go away unless you goes back and let eldoc
;; shut it off. this code can save you
;; this is gold, right here, you know it my friend?
(when (frame-parameter eldoc-box--frame 'visibility)
(eldoc-box-quit-frame))))
(defun eldoc-box--eldoc-message-function (str &rest args)
"Frontend for eldoc. Display STR in childframe and ARGS works like `message'."
(if (stringp str)
@ -194,12 +211,19 @@ Checkout `lsp-ui-doc--make-frame', `lsp-ui-doc--move-frame'."
"Displays hover documentations in a childframe. This mode is buffer local."
:lighter " ELDOC-BOX"
(if eldoc-box-hover-mode
(setq-local eldoc-message-function #'eldoc-box--eldoc-message-function)
(progn
;; Why a timer? ElDoc is mainly use in minibuffer,
;; where the text is constantly being flushed by other commands
;; so ElDoc doesn't try very hard to cleanup
(setq eldoc-box--cleanup-timer (run-with-idle-timer 1 t #'eldoc-box--maybe-cleanup))
(setq-local eldoc-message-function #'eldoc-box--eldoc-message-function))
(setq-local eldoc-message-function #'eldoc-minibuffer-message)
(when eldoc-box--cleanup-timer (cancel-timer eldoc-box--cleanup-timer))
;; if minor mode is turned off when childframe is visible
;; hide it
(eldoc-box-quit-frame)))
(provide 'eldoc-box)
;;; eldoc-box.el ends here