1 ;;; eldoc-overlay.el --- Display eldoc with contextual documentation overlay.
3 ;; Author: stardiviner <numbchild@gmail.com>
4 ;; Author: Robert Weiner <rsw@gnu.org>
5 ;; Maintainer: stardiviner <numbchild@gmail.com>
6 ;; Keywords: documentation, eldoc, overlay
7 ;; URL: https://github.com/stardiviner/eldoc-overlay
8 ;; Created: 14th Jan 2017
9 ;; Modified: 18th Dec 2017
11 ;; Package-Requires: ((emacs "24.3") (inline-docs "1.0.1") (quick-peek "1.0"))
15 ;; Eldoc displays the function signature of the closest function call
16 ;; around point either in the minibuffer or in the modeline.
18 ;; This package modifies Eldoc to display this documentation inline
19 ;; using a buffer text overlay.
21 ;; `eldoc-overlay-mode' is a per-buffer minor mode.
22 ;; A call to `eldoc-overlay-enable' turns it on.
23 ;; A call to `eldoc-overlay-disable' turns it off
25 ;; {C-x C-h} interactively calls `eldoc-overlay-toggle' and tells
26 ;; you the mode's new state.
28 ;; `global-eldoc-overlay-mode' can be used to toggle this for all buffers.
29 ;; A call to `global-eldoc-overlay-enable' turns it on.
30 ;; A call to `global-eldoc-overlay-disable' turns it off
32 ;; {C-u C-x C-h} interactively calls `global-eldoc-overlay-toggle' and tells
33 ;; you the mode's new state.
35 ;; By default, the overlay is not used in the minibuffer, eldoc is shown in the modeline
36 ;; in this case. Set the option `eldoc-overlay-in-minibuffer-flag' non-nil if you want
37 ;; to enable overlay use in the minibuffer.
39 ;; The key used to toggle the mode can be customized by setting the `eldoc-overlay-key'
42 ;; Finally, see the documentation for `eldoc-overlay-backend' if you want to try
43 ;; a different overlay display package backend.
46 ;;; ----------------------------------------------------------------------------
51 (defgroup eldoc-overlay nil
52 "Display Eldoc function signatures using in-buffer text overlays"
53 :prefix
"eldoc-overlay-"
56 (defcustom eldoc-overlay-in-minibuffer-flag nil
57 "Non-nil (default: nil) means enable `eldoc-overlay-mode' in the minibuffer.
58 When nil and in the minibuffer, if standard `eldoc-mode' is
59 enabled, it displays function signatures in the modeline."
61 :group
'eldoc-overlay
)
63 (defcustom eldoc-overlay-key
(kbd "C-x C-h")
64 "Key to toggle eldoc overlay mode."
67 :set
(lambda (option value
)
69 (global-set-key value
#'eldoc-overlay-toggle
)))
73 (defvar eldoc-overlay-backend
'quick-peek
74 "The backend library that displays eldoc overlays.
75 Two backends are supported: `inline-docs' and `quick-peek'.")
78 (defun eldoc-overlay-inline-docs (format-string &rest args
)
79 "Inline-docs backend function to show FORMAT-STRING and ARGS."
80 (inline-docs format-string args
))
82 (defun eldoc-overlay-quick-peek (format-string &rest args
)
83 "Quick-peek backend function to show FORMAT-STRING and ARGS."
86 (apply 'format format-string args
)
90 (defun eldoc-overlay-display (format-string &rest args
)
91 "Display eldoc for the minibuffer when there or call the function indexed by `eldoc-overlay-backend'."
92 (unless (company-tooltip-visible-p)
93 (if (and (minibufferp) (not eldoc-overlay-in-minibuffer-flag
))
94 (apply #'eldoc-minibuffer-message format-string args
)
96 (pcase eldoc-overlay-backend
97 (`inline-docs
'eldoc-overlay-inline-docs
)
98 (`quick-peek
'eldoc-overlay-quick-peek
))
99 (funcall eldoc-documentation-function
)))))
102 (defun eldoc-overlay-enable ()
103 "Enable `eldoc-overlay-mode' minor mode."
105 (eldoc-overlay-mode 1))
107 (defun eldoc-overlay-disable ()
108 "Disable `eldoc-overlay-mode' minor mode."
110 (eldoc-overlay-mode 0))
112 (defun global-eldoc-overlay-enable ()
113 "Globally enable `eldoc-overlay-mode' minor mode."
115 (global-eldoc-overlay-mode 1))
117 (defun global-eldoc-overlay-disable ()
118 "Globally disable `eldoc-overlay-mode' minor mode."
120 (global-eldoc-overlay-mode 0))
123 (defun global-eldoc-overlay-toggle ()
124 "Globally toggle display of eldoc-overlay."
125 (if global-eldoc-overlay-mode
126 (progn (global-eldoc-overlay-disable)
127 (message "Globally disabled eldoc-overlay minor mode"))
128 (message "Globally enabled eldoc-overlay minor mode")
129 (global-eldoc-overlay-enable)
130 (eldoc-message (funcall eldoc-documentation-function
))))
133 (defun eldoc-overlay-toggle (global-flag)
134 "Toggle display of eldoc-overlay in this buffer or with prefix arg GLOBAL-FLAG, globally."
138 (global-eldoc-overlay-toggle))
140 (eldoc-overlay-disable)
141 (message "Disabled eldoc-overlay minor mode in the current buffer"))
142 (t (message "Enabled eldoc-overlay minor mode in the current buffer")
143 (eldoc-overlay-enable)
144 (eldoc-message (funcall eldoc-documentation-function
)))))
147 (define-minor-mode eldoc-overlay-mode
148 "Minor mode for displaying eldoc contextual documentation using a text overlay."
149 :require
'eldoc-overlay-mode
150 :group
'eldoc-overlay
153 :lighter
" ElDocOver"
154 (if eldoc-overlay-mode
156 (when (eq eldoc-overlay-backend
'quick-peek
)
157 (add-hook 'post-command-hook
#'quick-peek-hide
))
158 (add-hook 'org-mode-hook
#'eldoc-overlay-disable
)
159 (setq eldoc-message-function
#'eldoc-overlay-display
)
161 (when (eq eldoc-overlay-backend
'quick-peek
)
163 ;; Remove hook when no buffers have any peek overlays
164 (unless (delq nil
(mapcar (lambda (buf) (buffer-local-value 'quick-peek--overlays buf
)) (buffer-list)))
165 (remove-hook 'post-command-hook
#'quick-peek-hide
)))
167 (setq eldoc-message-function
#'eldoc-minibuffer-message
)))
170 (define-globalized-minor-mode global-eldoc-overlay-mode eldoc-overlay-mode eldoc-overlay-enable
171 :group
'eldoc-overlay
175 ;;; ----------------------------------------------------------------------------
177 (provide 'eldoc-overlay
)
179 ;;; eldoc-overlay.el ends here