Commit | Line | Data |
---|---|---|
b670783a | 1 | ;;; tooltip.el --- show tooltip windows |
7840ced1 | 2 | |
0d30b337 | 3 | ;; Copyright (C) 1997, 1999, 2000, 2001, 2002, 2003, 2004, |
114f9c96 | 4 | ;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. |
7840ced1 GM |
5 | |
6 | ;; Author: Gerd Moellmann <gerd@acm.org> | |
7 | ;; Keywords: help c mouse tools | |
8 | ||
9 | ;; This file is part of GNU Emacs. | |
10 | ||
eb3fa2cf | 11 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
7840ced1 | 12 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
13 | ;; the Free Software Foundation, either version 3 of the License, or |
14 | ;; (at your option) any later version. | |
7840ced1 GM |
15 | |
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
eb3fa2cf | 22 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
7840ced1 GM |
23 | |
24 | ;;; Commentary: | |
25 | ||
7840ced1 GM |
26 | ;;; Code: |
27 | ||
5673b222 JB |
28 | (defvar comint-prompt-regexp) |
29 | ||
e3947513 JL |
30 | (defgroup tooltip nil |
31 | "Customization group for the `tooltip' package." | |
32 | :group 'help | |
33 | :group 'gud | |
34 | :group 'mouse | |
35 | :group 'tools | |
36 | :version "21.1" | |
37 | :tag "Tool Tips") | |
38 | \f | |
e85dcd95 NR |
39 | ;;; Switching tooltips on/off |
40 | ||
e85dcd95 | 41 | (define-minor-mode tooltip-mode |
42cc79e6 RS |
42 | "Toggle Tooltip mode. |
43 | With ARG, turn Tooltip mode on if and only if ARG is positive. | |
4c08ab31 | 44 | When this minor mode is enabled, Emacs displays help text |
42cc79e6 RS |
45 | in a pop-up window for buttons and menu items that you put the mouse on. |
46 | \(However, if `tooltip-use-echo-area' is non-nil, this and | |
47 | all pop-up help appears in the echo area.) | |
48 | ||
49 | When Tooltip mode is disabled, Emacs displays one line of | |
50 | the help text in the echo area, and does not make a pop-up window." | |
e85dcd95 | 51 | :global t |
8431201e CY |
52 | ;; Even if we start on a text-only terminal, make this non-nil by |
53 | ;; default because we can open a graphical frame later (multi-tty). | |
54 | :init-value t | |
adba8116 | 55 | :initialize 'custom-initialize-delay |
e85dcd95 NR |
56 | :group 'tooltip |
57 | (unless (or (null tooltip-mode) (fboundp 'x-show-tip)) | |
58 | (error "Sorry, tooltips are not yet available on this system")) | |
59 | (if tooltip-mode | |
60 | (progn | |
61 | (add-hook 'pre-command-hook 'tooltip-hide) | |
19423c53 | 62 | (add-hook 'tooltip-functions 'tooltip-help-tips)) |
e85dcd95 NR |
63 | (unless (and (boundp 'gud-tooltip-mode) gud-tooltip-mode) |
64 | (remove-hook 'pre-command-hook 'tooltip-hide)) | |
19423c53 | 65 | (remove-hook 'tooltip-functions 'tooltip-help-tips)) |
e85dcd95 | 66 | (setq show-help-function |
14c0a34d | 67 | (if tooltip-mode 'tooltip-show-help 'tooltip-show-help-non-mode))) |
7840ced1 | 68 | |
e3947513 JL |
69 | \f |
70 | ;;; Customizable settings | |
7840ced1 | 71 | |
88751b11 | 72 | (defcustom tooltip-delay 0.7 |
7840ced1 | 73 | "Seconds to wait before displaying a tooltip the first time." |
7840ced1 GM |
74 | :type 'number |
75 | :group 'tooltip) | |
76 | ||
7840ced1 GM |
77 | (defcustom tooltip-short-delay 0.1 |
78 | "Seconds to wait between subsequent tooltips on different items." | |
7840ced1 GM |
79 | :type 'number |
80 | :group 'tooltip) | |
81 | ||
7840ced1 | 82 | (defcustom tooltip-recent-seconds 1 |
01b23b99 DL |
83 | "Display tooltips if changing tip items within this many seconds. |
84 | Do so after `tooltip-short-delay'." | |
7840ced1 GM |
85 | :type 'number |
86 | :group 'tooltip) | |
87 | ||
88751b11 | 88 | (defcustom tooltip-hide-delay 10 |
a93c8ba8 | 89 | "Hide tooltips automatically after this many seconds." |
a93c8ba8 GM |
90 | :type 'number |
91 | :group 'tooltip) | |
92 | ||
5fddd8e6 | 93 | (defcustom tooltip-x-offset 5 |
37a29d46 | 94 | "X offset, in pixels, for the display of tooltips. |
e3947513 JL |
95 | The offset is the distance between the X position of the mouse and |
96 | the left border of the tooltip window. It must be chosen so that the | |
97 | tooltip window doesn't contain the mouse when it pops up, or it may | |
98 | interfere with clicking where you wish. | |
7142670a EZ |
99 | |
100 | If `tooltip-frame-parameters' includes the `left' parameter, | |
101 | the value of `tooltip-x-offset' is ignored." | |
5fddd8e6 | 102 | :type 'integer |
e4df9b40 GM |
103 | :group 'tooltip) |
104 | ||
48736093 | 105 | (defcustom tooltip-y-offset +20 |
37a29d46 | 106 | "Y offset, in pixels, for the display of tooltips. |
e3947513 JL |
107 | The offset is the distance between the Y position of the mouse and |
108 | the top border of the tooltip window. It must be chosen so that the | |
109 | tooltip window doesn't contain the mouse when it pops up, or it may | |
110 | interfere with clicking where you wish. | |
7142670a EZ |
111 | |
112 | If `tooltip-frame-parameters' includes the `top' parameter, | |
113 | the value of `tooltip-y-offset' is ignored." | |
5fddd8e6 | 114 | :type 'integer |
e4df9b40 GM |
115 | :group 'tooltip) |
116 | ||
7840ced1 | 117 | (defcustom tooltip-frame-parameters |
5297bc10 | 118 | '((name . "tooltip") |
5fddd8e6 | 119 | (internal-border-width . 2) |
7840ced1 | 120 | (border-width . 1)) |
7142670a EZ |
121 | "Frame parameters used for tooltips. |
122 | ||
123 | If `left' or `top' parameters are included, they specify the absolute | |
38df7d21 JB |
124 | position to pop up the tooltip. |
125 | ||
126 | Note that font and color parameters are ignored, and the attributes | |
127 | of the `tooltip' face are used instead." | |
7840ced1 | 128 | :type 'sexp |
7840ced1 GM |
129 | :group 'tooltip) |
130 | ||
2621f5a9 GM |
131 | (defface tooltip |
132 | '((((class color)) | |
39440204 JPW |
133 | :background "lightyellow" |
134 | :foreground "black" | |
135 | :inherit variable-pitch) | |
136 | (t | |
137 | :inherit variable-pitch)) | |
2621f5a9 | 138 | "Face for tooltips." |
daf96a41 JL |
139 | :group 'tooltip |
140 | :group 'basic-faces) | |
2621f5a9 | 141 | |
90aff7c6 | 142 | (defcustom tooltip-use-echo-area nil |
42cc79e6 RS |
143 | "Use the echo area instead of tooltip frames for help and GUD tooltips. |
144 | To display multi-line help text in the echo area, set this to t | |
145 | and enable `tooltip-mode'." | |
90aff7c6 | 146 | :type 'boolean |
90aff7c6 NR |
147 | :group 'tooltip) |
148 | ||
7840ced1 GM |
149 | \f |
150 | ;;; Variables that are not customizable. | |
151 | ||
19423c53 | 152 | (defvar tooltip-functions nil |
7840ced1 | 153 | "Functions to call to display tooltips. |
19423c53 JB |
154 | Each function is called with one argument EVENT which is a copy |
155 | of the last mouse movement event that occurred. If one of these | |
156 | functions displays the tooltip, it should return non-nil and the | |
157 | rest are not called.") | |
158 | ||
159 | (define-obsolete-variable-alias 'tooltip-hook 'tooltip-functions "23.1") | |
7840ced1 | 160 | |
7840ced1 GM |
161 | (defvar tooltip-timeout-id nil |
162 | "The id of the timeout started when Emacs becomes idle.") | |
163 | ||
7840ced1 GM |
164 | (defvar tooltip-last-mouse-motion-event nil |
165 | "A copy of the last mouse motion event seen.") | |
166 | ||
7840ced1 GM |
167 | (defvar tooltip-hide-time nil |
168 | "Time when the last tooltip was hidden.") | |
169 | ||
1af98f07 RS |
170 | (defvar gud-tooltip-mode) ;; Prevent warning. |
171 | ||
7840ced1 GM |
172 | ;;; Event accessors |
173 | ||
174 | (defun tooltip-event-buffer (event) | |
175 | "Return the buffer over which event EVENT occurred. | |
176 | This might return nil if the event did not occur over a buffer." | |
177 | (let ((window (posn-window (event-end event)))) | |
178 | (and window (window-buffer window)))) | |
179 | ||
7840ced1 GM |
180 | \f |
181 | ;;; Timeout for tooltip display | |
182 | ||
7840ced1 GM |
183 | (defun tooltip-delay () |
184 | "Return the delay in seconds for the next tooltip." | |
ece5f847 SM |
185 | (if (and tooltip-hide-time |
186 | (< (- (float-time) tooltip-hide-time) tooltip-recent-seconds)) | |
187 | tooltip-short-delay | |
188 | tooltip-delay)) | |
7840ced1 | 189 | |
06f76f9f | 190 | (defun tooltip-cancel-delayed-tip () |
7840ced1 GM |
191 | "Disable the tooltip timeout." |
192 | (when tooltip-timeout-id | |
193 | (disable-timeout tooltip-timeout-id) | |
194 | (setq tooltip-timeout-id nil))) | |
195 | ||
06f76f9f | 196 | (defun tooltip-start-delayed-tip () |
04cedb11 | 197 | "Add a one-shot timeout to call function `tooltip-timeout'." |
7840ced1 GM |
198 | (setq tooltip-timeout-id |
199 | (add-timeout (tooltip-delay) 'tooltip-timeout nil))) | |
200 | ||
7840ced1 | 201 | (defun tooltip-timeout (object) |
04cedb11 | 202 | "Function called when timer with id `tooltip-timeout-id' fires." |
19423c53 | 203 | (run-hook-with-args-until-success 'tooltip-functions |
7840ced1 GM |
204 | tooltip-last-mouse-motion-event)) |
205 | ||
7840ced1 | 206 | \f |
7840ced1 GM |
207 | ;;; Displaying tips |
208 | ||
2621f5a9 | 209 | (defun tooltip-set-param (alist key value) |
4b2bb9be | 210 | "Change the value of KEY in alist ALIST to VALUE. |
f1180544 | 211 | If there's no association for KEY in ALIST, add one, otherwise |
2621f5a9 GM |
212 | change the existing association. Value is the resulting alist." |
213 | (let ((param (assq key alist))) | |
214 | (if (consp param) | |
215 | (setcdr param value) | |
216 | (push (cons key value) alist)) | |
217 | alist)) | |
218 | ||
aa360da1 GM |
219 | (declare-function x-show-tip "xfns.c" |
220 | (string &optional frame parms timeout dx dy)) | |
221 | ||
cae07240 | 222 | (defun tooltip-show (text &optional use-echo-area) |
7142670a EZ |
223 | "Show a tooltip window displaying TEXT. |
224 | ||
1d6197fb | 225 | Text larger than `x-max-tooltip-size' is clipped. |
7142670a EZ |
226 | |
227 | If the alist in `tooltip-frame-parameters' includes `left' and `top' | |
228 | parameters, they determine the x and y position where the tooltip | |
229 | is displayed. Otherwise, the tooltip pops at offsets specified by | |
230 | `tooltip-x-offset' and `tooltip-y-offset' from the current mouse | |
1d6197fb NR |
231 | position. |
232 | ||
cae07240 KS |
233 | Optional second arg USE-ECHO-AREA non-nil means to show tooltip |
234 | in echo area." | |
235 | (if use-echo-area | |
14c0a34d | 236 | (tooltip-show-help-non-mode text) |
e5603149 | 237 | (condition-case error |
2621f5a9 GM |
238 | (let ((params (copy-sequence tooltip-frame-parameters)) |
239 | (fg (face-attribute 'tooltip :foreground)) | |
240 | (bg (face-attribute 'tooltip :background))) | |
06f76f9f GM |
241 | (when (stringp fg) |
242 | (setq params (tooltip-set-param params 'foreground-color fg)) | |
243 | (setq params (tooltip-set-param params 'border-color fg))) | |
244 | (when (stringp bg) | |
245 | (setq params (tooltip-set-param params 'background-color bg))) | |
2621f5a9 GM |
246 | (x-show-tip (propertize text 'face 'tooltip) |
247 | (selected-frame) | |
f3b05e99 | 248 | params |
a93c8ba8 | 249 | tooltip-hide-delay |
2621f5a9 GM |
250 | tooltip-x-offset |
251 | tooltip-y-offset)) | |
f1180544 | 252 | (error |
e5603149 GM |
253 | (message "Error while displaying tooltip: %s" error) |
254 | (sit-for 1) | |
255 | (message "%s" text))))) | |
256 | ||
aa360da1 GM |
257 | (declare-function x-hide-tip "xfns.c" ()) |
258 | ||
7840ced1 GM |
259 | (defun tooltip-hide (&optional ignored-arg) |
260 | "Hide a tooltip, if one is displayed. | |
261 | Value is non-nil if tooltip was open." | |
06f76f9f | 262 | (tooltip-cancel-delayed-tip) |
7840ced1 | 263 | (when (x-hide-tip) |
a1f84f6d | 264 | (setq tooltip-hide-time (float-time)))) |
7840ced1 | 265 | |
7840ced1 GM |
266 | \f |
267 | ;;; Debugger-related functions | |
268 | ||
269 | (defun tooltip-identifier-from-point (point) | |
270 | "Extract the identifier at POINT, if any. | |
271 | Value is nil if no identifier exists at point. Identifier extraction | |
272 | is based on the current syntax table." | |
273 | (save-excursion | |
274 | (goto-char point) | |
275 | (let ((start (progn (skip-syntax-backward "w_") (point)))) | |
276 | (unless (looking-at "[0-9]") | |
277 | (skip-syntax-forward "w_") | |
278 | (when (> (point) start) | |
279 | (buffer-substring start (point))))))) | |
280 | ||
7840ced1 | 281 | (defmacro tooltip-region-active-p () |
8af7e4bd | 282 | "Value is non-nil if the region should override command actions." |
71dffedd | 283 | `(use-region-p)) |
7840ced1 | 284 | |
7840ced1 GM |
285 | (defun tooltip-expr-to-print (event) |
286 | "Return an expression that should be printed for EVENT. | |
287 | If a region is active and the mouse is inside the region, print | |
288 | the region. Otherwise, figure out the identifier around the point | |
289 | where the mouse is." | |
ece5f847 | 290 | (with-current-buffer (tooltip-event-buffer event) |
7840ced1 GM |
291 | (let ((point (posn-point (event-end event)))) |
292 | (if (tooltip-region-active-p) | |
293 | (when (and (<= (region-beginning) point) (<= point (region-end))) | |
294 | (buffer-substring (region-beginning) (region-end))) | |
295 | (tooltip-identifier-from-point point))))) | |
296 | ||
7840ced1 GM |
297 | (defun tooltip-process-prompt-regexp (process) |
298 | "Return regexp matching the prompt of PROCESS at the end of a string. | |
04cedb11 JB |
299 | The prompt is taken from the value of `comint-prompt-regexp' in |
300 | the buffer of PROCESS." | |
ece5f847 | 301 | (let ((prompt-regexp (with-current-buffer (process-buffer process) |
7840ced1 | 302 | comint-prompt-regexp))) |
ece5f847 SM |
303 | (concat "\n*" |
304 | ;; Most start with `^' but the one for `sdb' cannot be easily | |
305 | ;; stripped. Code the prompt for `sdb' fixed here. | |
306 | (if (= (aref prompt-regexp 0) ?^) | |
307 | (substring prompt-regexp 1) | |
308 | "\\*") | |
309 | "$"))) | |
7840ced1 | 310 | |
7840ced1 GM |
311 | (defun tooltip-strip-prompt (process output) |
312 | "Return OUTPUT with any prompt of PROCESS stripped from its end." | |
ece5f847 SM |
313 | (save-match-data |
314 | (if (string-match (tooltip-process-prompt-regexp process) output) | |
315 | (substring output 0 (match-beginning 0)) | |
316 | output))) | |
7840ced1 | 317 | |
7840ced1 | 318 | \f |
7840ced1 GM |
319 | ;;; Tooltip help. |
320 | ||
321 | (defvar tooltip-help-message nil | |
707731ee CY |
322 | "The last help message received via `show-help-function'. |
323 | This is used by `tooltip-show-help' and | |
324 | `tooltip-show-help-non-mode'.") | |
7840ced1 | 325 | |
ece5f847 SM |
326 | (defvar tooltip-previous-message nil |
327 | "The previous content of the echo area.") | |
328 | ||
329 | (defun tooltip-show-help-non-mode (help) | |
68a4b77d CY |
330 | "Function installed as `show-help-function' when Tooltip mode is off. |
331 | It is also called if Tooltip mode is on, for text-only displays." | |
ece5f847 | 332 | (when (and (not (window-minibuffer-p)) ;Don't overwrite minibuffer contents. |
707731ee | 333 | (not cursor-in-echo-area)) ;Don't overwrite a prompt. |
ece5f847 SM |
334 | (cond |
335 | ((stringp help) | |
9bec41de CY |
336 | (setq help (replace-regexp-in-string "\n" ", " help)) |
337 | (unless (or tooltip-previous-message | |
707731ee CY |
338 | (string-equal help (current-message)) |
339 | (and (stringp tooltip-help-message) | |
340 | (string-equal tooltip-help-message | |
341 | (current-message)))) | |
ece5f847 | 342 | (setq tooltip-previous-message (current-message))) |
707731ee | 343 | (setq tooltip-help-message help) |
ece5f847 SM |
344 | (let ((message-truncate-lines t) |
345 | (message-log-max nil)) | |
9bec41de | 346 | (message "%s" help))) |
ece5f847 SM |
347 | ((stringp tooltip-previous-message) |
348 | (let ((message-log-max nil)) | |
349 | (message "%s" tooltip-previous-message) | |
350 | (setq tooltip-previous-message nil))) | |
351 | (t | |
352 | (message nil))))) | |
14c0a34d | 353 | |
90aff7c6 | 354 | (defun tooltip-show-help (msg) |
7840ced1 GM |
355 | "Function installed as `show-help-function'. |
356 | MSG is either a help string to display, or nil to cancel the display." | |
68a4b77d CY |
357 | (if (display-graphic-p) |
358 | (let ((previous-help tooltip-help-message)) | |
359 | (setq tooltip-help-message msg) | |
360 | (cond ((null msg) | |
361 | ;; Cancel display. This also cancels a delayed tip, if | |
362 | ;; there is one. | |
363 | (tooltip-hide)) | |
364 | ((equal previous-help msg) | |
365 | ;; Same help as before (but possibly the mouse has moved). | |
366 | ;; Keep what we have. | |
367 | ) | |
368 | (t | |
369 | ;; A different help. Remove a previous tooltip, and | |
370 | ;; display a new one, with some delay. | |
371 | (tooltip-hide) | |
372 | (tooltip-start-delayed-tip)))) | |
373 | ;; On text-only displays, try `tooltip-show-help-non-mode'. | |
374 | (tooltip-show-help-non-mode msg))) | |
7840ced1 | 375 | |
7840ced1 GM |
376 | (defun tooltip-help-tips (event) |
377 | "Hook function to display a help tooltip. | |
19423c53 JB |
378 | This is installed on the hook `tooltip-functions', which |
379 | is run when the timer with id `tooltip-timeout-id' fires. | |
7840ced1 GM |
380 | Value is non-nil if this function handled the tip." |
381 | (when (stringp tooltip-help-message) | |
90aff7c6 | 382 | (tooltip-show tooltip-help-message tooltip-use-echo-area) |
7840ced1 GM |
383 | t)) |
384 | ||
5ce0fb91 | 385 | (provide 'tooltip) |
7840ced1 | 386 | |
18385083 | 387 | ;; arch-tag: 3d61135e-4618-4a78-af28-183f6df5636f |
7840ced1 | 388 | ;;; tooltip.el ends here |