Mercurial > emacs
annotate lisp/tooltip.el @ 61901:787052160d87
(do_autoload): Record only autoloads in the autoload property of symbols.
author | Lute Kamstra <lute@gnu.org> |
---|---|
date | Thu, 28 Apr 2005 08:38:35 +0000 |
parents | c770a716e5cb |
children | 55735e23c27d |
rev | line source |
---|---|
45236 | 1 ;;; tooltip.el --- show tooltip windows |
25003 | 2 |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
3 ;; Copyright (C) 1997, 1999, 2000, 2001, 2002, 2003, 2004, 2005 |
59017
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
4 ;; Free Software Foundation, Inc. |
25003 | 5 |
6 ;; Author: Gerd Moellmann <gerd@acm.org> | |
7 ;; Keywords: help c mouse tools | |
8 | |
9 ;; This file is part of GNU Emacs. | |
10 | |
11 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 ;; it under the terms of the GNU General Public License as published by | |
13 ;; the Free Software Foundation; either version 2, or (at your option) | |
14 ;; any later version. | |
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 | |
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 ;; Boston, MA 02111-1307, USA. | |
25 | |
26 ;;; Commentary: | |
27 | |
28 ;;; Code: | |
29 | |
58163
7048d946d9df
(require): Explain why CL is needed.
Nick Roberts <nickrob@snap.net.nz>
parents:
58155
diff
changeset
|
30 (eval-when-compile (require 'cl)) ; for case macro |
58155 | 31 |
25003 | 32 |
33 ;;; Customizable settings | |
34 | |
35 (defgroup tooltip nil | |
36 "Customization group for the `tooltip' package." | |
37 :group 'help | |
37755
cf803b8f08ad
(tooltip) <defgroup>: Put it in `gud' group instead
Gerd Moellmann <gerd@gnu.org>
parents:
35401
diff
changeset
|
38 :group 'gud |
25003 | 39 :group 'mouse |
40 :group 'tools | |
25332
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
41 :version "21.1" |
25003 | 42 :tag "Tool Tips") |
43 | |
40679
3c4df1ce9e4c
(tooltip-delay): Decrease to 0.7.
Eli Zaretskii <eliz@gnu.org>
parents:
40376
diff
changeset
|
44 (defcustom tooltip-delay 0.7 |
25003 | 45 "Seconds to wait before displaying a tooltip the first time." |
46 :tag "Delay" | |
47 :type 'number | |
48 :group 'tooltip) | |
49 | |
50 (defcustom tooltip-short-delay 0.1 | |
51 "Seconds to wait between subsequent tooltips on different items." | |
52 :tag "Short delay" | |
53 :type 'number | |
54 :group 'tooltip) | |
55 | |
56 (defcustom tooltip-recent-seconds 1 | |
25332
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
57 "Display tooltips if changing tip items within this many seconds. |
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
58 Do so after `tooltip-short-delay'." |
25003 | 59 :tag "Recent seconds" |
60 :type 'number | |
61 :group 'tooltip) | |
62 | |
40679
3c4df1ce9e4c
(tooltip-delay): Decrease to 0.7.
Eli Zaretskii <eliz@gnu.org>
parents:
40376
diff
changeset
|
63 (defcustom tooltip-hide-delay 10 |
35401
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
64 "Hide tooltips automatically after this many seconds." |
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
65 :tag "Hide delay" |
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
66 :type 'number |
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
67 :group 'tooltip) |
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
68 |
33587
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
69 (defcustom tooltip-x-offset nil |
46025
ce0d438fe05e
(tooltip-x-offset, tooltip-y-offset): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
45571
diff
changeset
|
70 "X offset, in pixels, for the display of tooltips. |
33587
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
71 The offset is relative to the position of the mouse. It must |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
72 be chosen so that the tooltip window doesn't contain the mouse |
40173
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
73 when it pops up. If the value is nil, the default offset is 5 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
74 pixels. |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
75 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
76 If `tooltip-frame-parameters' includes the `left' parameter, |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
77 the value of `tooltip-x-offset' is ignored." |
33587
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
78 :tag "X offset" |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
79 :type '(choice (const :tag "Default" nil) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
80 (integer :tag "Offset" :value 1)) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
81 :group 'tooltip) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
82 |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
83 (defcustom tooltip-y-offset nil |
46025
ce0d438fe05e
(tooltip-x-offset, tooltip-y-offset): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
45571
diff
changeset
|
84 "Y offset, in pixels, for the display of tooltips. |
33587
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
85 The offset is relative to the position of the mouse. It must |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
86 be chosen so that the tooltip window doesn't contain the mouse |
40173
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
87 when it pops up. If the value is nil, the default offset is -10 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
88 pixels. |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
89 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
90 If `tooltip-frame-parameters' includes the `top' parameter, |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
91 the value of `tooltip-y-offset' is ignored." |
33587
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
92 :tag "Y offset" |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
93 :type '(choice (const :tag "Default" nil) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
94 (integer :tag "Offset" :value 1)) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
95 :group 'tooltip) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
96 |
25003 | 97 (defcustom tooltip-frame-parameters |
98 '((name . "tooltip") | |
99 (internal-border-width . 5) | |
100 (border-width . 1)) | |
40173
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
101 "Frame parameters used for tooltips. |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
102 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
103 If `left' or `top' parameters are included, they specify the absolute |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
104 position to pop up the tooltip." |
25003 | 105 :type 'sexp |
106 :tag "Frame Parameters" | |
107 :group 'tooltip) | |
108 | |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
109 (defface tooltip |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
110 '((((class color)) |
52031
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
111 :background "lightyellow" |
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
112 :foreground "black" |
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
113 :inherit variable-pitch) |
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
114 (t |
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
115 :inherit variable-pitch)) |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
116 "Face for tooltips." |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
117 :group 'tooltip) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
118 |
25003 | 119 (defcustom tooltip-gud-tips-p nil |
61691
c7e8695076af
(tooltip-gud-tips-p): Expand documentation.
Nick Roberts <nickrob@snap.net.nz>
parents:
61677
diff
changeset
|
120 "*Non-nil means show tooltips in GUD sessions. |
c7e8695076af
(tooltip-gud-tips-p): Expand documentation.
Nick Roberts <nickrob@snap.net.nz>
parents:
61677
diff
changeset
|
121 |
c7e8695076af
(tooltip-gud-tips-p): Expand documentation.
Nick Roberts <nickrob@snap.net.nz>
parents:
61677
diff
changeset
|
122 This allows you to display a variable's value in a tooltip simply by |
c7e8695076af
(tooltip-gud-tips-p): Expand documentation.
Nick Roberts <nickrob@snap.net.nz>
parents:
61677
diff
changeset
|
123 pointing at it with the mouse." |
25003 | 124 :type 'boolean |
125 :tag "GUD" | |
126 :group 'tooltip) | |
127 | |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
128 (defcustom tooltip-gud-modes '(gud-mode c-mode c++-mode fortran-mode) |
25003 | 129 "List of modes for which to enable GUD tips." |
130 :type 'sexp | |
131 :tag "GUD modes" | |
132 :group 'tooltip) | |
133 | |
134 (defcustom tooltip-gud-display | |
135 '((eq (tooltip-event-buffer tooltip-gud-event) | |
61128
dd51ca9ed348
(tooltip-gud-display): Use gud-overlay-arrow-position.
Nick Roberts <nickrob@snap.net.nz>
parents:
60832
diff
changeset
|
136 (marker-buffer gud-overlay-arrow-position))) |
25003 | 137 "List of forms determining where GUD tooltips are displayed. |
138 | |
139 Forms in the list are combined with AND. The default is to display | |
140 only tooltips in the buffer containing the overlay arrow." | |
141 :type 'sexp | |
142 :tag "GUD buffers predicate" | |
143 :group 'tooltip) | |
144 | |
61608
6a8ebeaf5f56
(tooltip-gud-echo-area): Rename from
Nick Roberts <nickrob@snap.net.nz>
parents:
61565
diff
changeset
|
145 (defcustom tooltip-gud-echo-area nil |
6a8ebeaf5f56
(tooltip-gud-echo-area): Rename from
Nick Roberts <nickrob@snap.net.nz>
parents:
61565
diff
changeset
|
146 "Use the echo area instead of frames for GUD tooltips." |
32431
a35cc9700ff7
* tooltip.el (tooltip-use-echo-area): New user variable.
Sam Steingold <sds@gnu.org>
parents:
30481
diff
changeset
|
147 :type 'boolean |
33925 | 148 :tag "Use echo area" |
32431
a35cc9700ff7
* tooltip.el (tooltip-use-echo-area): New user variable.
Sam Steingold <sds@gnu.org>
parents:
30481
diff
changeset
|
149 :group 'tooltip) |
a35cc9700ff7
* tooltip.el (tooltip-use-echo-area): New user variable.
Sam Steingold <sds@gnu.org>
parents:
30481
diff
changeset
|
150 |
61677
5d556f24030d
(tooltip-use-echo-area): Replace as alias and deprecate.
Nick Roberts <nickrob@snap.net.nz>
parents:
61626
diff
changeset
|
151 (defvaralias 'tooltip-use-echo-area 'tooltip-gud-echo-area) |
5d556f24030d
(tooltip-use-echo-area): Replace as alias and deprecate.
Nick Roberts <nickrob@snap.net.nz>
parents:
61626
diff
changeset
|
152 (make-obsolete-variable 'tooltip-use-echo-area 'tooltip-gud-echo-area "22.1") |
25003 | 153 |
154 ;;; Variables that are not customizable. | |
155 | |
156 (defvar tooltip-hook nil | |
157 "Functions to call to display tooltips. | |
158 Each function is called with one argument EVENT which is a copy of | |
159 the last mouse movement event that occurred.") | |
160 | |
161 (defvar tooltip-timeout-id nil | |
162 "The id of the timeout started when Emacs becomes idle.") | |
163 | |
164 (defvar tooltip-last-mouse-motion-event nil | |
165 "A copy of the last mouse motion event seen.") | |
166 | |
167 (defvar tooltip-hide-time nil | |
168 "Time when the last tooltip was hidden.") | |
169 | |
170 | |
171 ;;; Event accessors | |
172 | |
173 (defun tooltip-event-buffer (event) | |
174 "Return the buffer over which event EVENT occurred. | |
175 This might return nil if the event did not occur over a buffer." | |
176 (let ((window (posn-window (event-end event)))) | |
177 (and window (window-buffer window)))) | |
178 | |
179 | |
180 ;;; Switching tooltips on/off | |
181 | |
182 ;; We don't set track-mouse globally because this is a big redisplay | |
183 ;; problem in buffers having a pre-command-hook or such installed, | |
184 ;; which does a set-buffer, like the summary buffer of Gnus. Calling | |
185 ;; set-buffer prevents redisplay optimizations, so every mouse motion | |
186 ;; would be accompanied by a full redisplay. | |
187 | |
188 ;;;###autoload | |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
189 (define-minor-mode tooltip-mode |
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
190 "Toggle Tooltip display. |
25003 | 191 With ARG, turn tooltip mode on if and only if ARG is positive." |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
192 :global t |
61565
19480ce3528d
(tooltip-mode): Specify correct standard value for Custom in init-value.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61161
diff
changeset
|
193 ;; If you change the :init-value below, you also need to change the |
19480ce3528d
(tooltip-mode): Specify correct standard value for Custom in init-value.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61161
diff
changeset
|
194 ;; corresponding code in startup.el. |
19480ce3528d
(tooltip-mode): Specify correct standard value for Custom in init-value.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61161
diff
changeset
|
195 :init-value (not (or noninteractive |
61614
5739226d2d8c
(tooltip-mode): `emacs-quick-startup' and `display-graphic-p' may not
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
61608
diff
changeset
|
196 (and (boundp 'emacs-quick-startup) emacs-quick-startup) |
5739226d2d8c
(tooltip-mode): `emacs-quick-startup' and `display-graphic-p' may not
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
61608
diff
changeset
|
197 (not (and (fboundp 'display-graphic-p) |
5739226d2d8c
(tooltip-mode): `emacs-quick-startup' and `display-graphic-p' may not
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
61608
diff
changeset
|
198 (display-graphic-p))) |
61565
19480ce3528d
(tooltip-mode): Specify correct standard value for Custom in init-value.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61161
diff
changeset
|
199 (not (fboundp 'x-show-tip)))) |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
200 :group 'tooltip |
60547
23b4e52963d6
(tooltip-mode): Don't complain that you can't turn the
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
60539
diff
changeset
|
201 (unless (or (null tooltip-mode) (fboundp 'x-show-tip)) |
34689
e045e0e60223
(tooltip-mode): Signal an error if x-show-tip
Gerd Moellmann <gerd@gnu.org>
parents:
34540
diff
changeset
|
202 (error "Sorry, tooltips are not yet available on this system")) |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
203 (let ((hook-fn (if tooltip-mode 'add-hook 'remove-hook))) |
25003 | 204 (funcall hook-fn 'change-major-mode-hook 'tooltip-change-major-mode) |
205 (tooltip-activate-mouse-motions-if-enabled) | |
206 (funcall hook-fn 'pre-command-hook 'tooltip-hide) | |
207 (funcall hook-fn 'tooltip-hook 'tooltip-gud-tips) | |
208 (funcall hook-fn 'tooltip-hook 'tooltip-help-tips) | |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
209 (setq show-help-function (if tooltip-mode 'tooltip-show-help-function nil)) |
25003 | 210 ;; `ignore' is the default binding for mouse movements. |
211 (define-key global-map [mouse-movement] | |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
212 (if tooltip-mode 'tooltip-mouse-motion 'ignore)))) |
25003 | 213 |
214 | |
215 ;;; Timeout for tooltip display | |
216 | |
217 (defun tooltip-delay () | |
218 "Return the delay in seconds for the next tooltip." | |
219 (let ((delay tooltip-delay) | |
30481 | 220 (now (float-time))) |
25003 | 221 (when (and tooltip-hide-time |
222 (< (- now tooltip-hide-time) tooltip-recent-seconds)) | |
223 (setq delay tooltip-short-delay)) | |
224 delay)) | |
225 | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
226 (defun tooltip-cancel-delayed-tip () |
25003 | 227 "Disable the tooltip timeout." |
228 (when tooltip-timeout-id | |
229 (disable-timeout tooltip-timeout-id) | |
230 (setq tooltip-timeout-id nil))) | |
231 | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
232 (defun tooltip-start-delayed-tip () |
25003 | 233 "Add a one-shot timeout to call function tooltip-timeout." |
234 (setq tooltip-timeout-id | |
235 (add-timeout (tooltip-delay) 'tooltip-timeout nil))) | |
236 | |
237 (defun tooltip-timeout (object) | |
238 "Function called when timer with id tooltip-timeout-id fires." | |
239 (run-hook-with-args-until-success 'tooltip-hook | |
240 tooltip-last-mouse-motion-event)) | |
241 | |
242 | |
243 ;;; Reacting on mouse movements | |
244 | |
245 (defun tooltip-change-major-mode () | |
246 "Function added to `change-major-mode-hook' when tooltip mode is on." | |
247 (add-hook 'post-command-hook 'tooltip-activate-mouse-motions-if-enabled)) | |
248 | |
249 (defun tooltip-activate-mouse-motions-if-enabled () | |
250 "Reconsider for all buffers whether mouse motion events are desired." | |
251 (remove-hook 'post-command-hook 'tooltip-activate-mouse-motions-if-enabled) | |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
252 (dolist (buffer (buffer-list)) |
25003 | 253 (save-excursion |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
254 (set-buffer buffer) |
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
255 (if (and tooltip-mode |
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
256 tooltip-gud-tips-p |
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
257 (memq major-mode tooltip-gud-modes)) |
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
258 (tooltip-activate-mouse-motions t) |
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
259 (tooltip-activate-mouse-motions nil))))) |
25003 | 260 |
45571
04484b8dacdc
(tooltip-mouse-motions-active): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
45236
diff
changeset
|
261 (defvar tooltip-mouse-motions-active nil |
04484b8dacdc
(tooltip-mouse-motions-active): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
45236
diff
changeset
|
262 "Locally t in a buffer if tooltip processing of mouse motion is enabled.") |
25003 | 263 |
264 (defun tooltip-activate-mouse-motions (activatep) | |
265 "Activate/deactivate mouse motion events for the current buffer. | |
266 ACTIVATEP non-nil means activate mouse motion events." | |
267 (if activatep | |
268 (progn | |
45571
04484b8dacdc
(tooltip-mouse-motions-active): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
45236
diff
changeset
|
269 (make-local-variable 'tooltip-mouse-motions-active) |
04484b8dacdc
(tooltip-mouse-motions-active): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
45236
diff
changeset
|
270 (setq tooltip-mouse-motions-active t) |
25003 | 271 (make-local-variable 'track-mouse) |
272 (setq track-mouse t)) | |
45571
04484b8dacdc
(tooltip-mouse-motions-active): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
45236
diff
changeset
|
273 (when tooltip-mouse-motions-active |
04484b8dacdc
(tooltip-mouse-motions-active): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
45236
diff
changeset
|
274 (kill-local-variable 'tooltip-mouse-motions-active) |
04484b8dacdc
(tooltip-mouse-motions-active): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
45236
diff
changeset
|
275 (kill-local-variable 'track-mouse)))) |
25003 | 276 |
277 (defun tooltip-mouse-motion (event) | |
278 "Command handler for mouse movement events in `global-map'." | |
279 (interactive "e") | |
280 (tooltip-hide) | |
281 (when (car (mouse-pixel-position)) | |
282 (setq tooltip-last-mouse-motion-event (copy-sequence event)) | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
283 (tooltip-start-delayed-tip))) |
25003 | 284 |
285 | |
286 ;;; Displaying tips | |
287 | |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
288 (defun tooltip-set-param (alist key value) |
40178
1dab42ecd751
(tooltip-set-param): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
40173
diff
changeset
|
289 "Change the value of KEY in alist ALIST to VALUE. |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
290 If there's no association for KEY in ALIST, add one, otherwise |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
291 change the existing association. Value is the resulting alist." |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
292 (let ((param (assq key alist))) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
293 (if (consp param) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
294 (setcdr param value) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
295 (push (cons key value) alist)) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
296 alist)) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
297 |
61626
058da2e83614
(tooltip-show): Change second arg to USE-ECHO-AREA
Kim F. Storm <storm@cua.dk>
parents:
61614
diff
changeset
|
298 (defun tooltip-show (text &optional use-echo-area) |
40173
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
299 "Show a tooltip window displaying TEXT. |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
300 |
61608
6a8ebeaf5f56
(tooltip-gud-echo-area): Rename from
Nick Roberts <nickrob@snap.net.nz>
parents:
61565
diff
changeset
|
301 Text larger than `x-max-tooltip-size' is clipped. |
40173
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
302 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
303 If the alist in `tooltip-frame-parameters' includes `left' and `top' |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
304 parameters, they determine the x and y position where the tooltip |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
305 is displayed. Otherwise, the tooltip pops at offsets specified by |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
306 `tooltip-x-offset' and `tooltip-y-offset' from the current mouse |
61608
6a8ebeaf5f56
(tooltip-gud-echo-area): Rename from
Nick Roberts <nickrob@snap.net.nz>
parents:
61565
diff
changeset
|
307 position. |
6a8ebeaf5f56
(tooltip-gud-echo-area): Rename from
Nick Roberts <nickrob@snap.net.nz>
parents:
61565
diff
changeset
|
308 |
61626
058da2e83614
(tooltip-show): Change second arg to USE-ECHO-AREA
Kim F. Storm <storm@cua.dk>
parents:
61614
diff
changeset
|
309 Optional second arg USE-ECHO-AREA non-nil means to show tooltip |
058da2e83614
(tooltip-show): Change second arg to USE-ECHO-AREA
Kim F. Storm <storm@cua.dk>
parents:
61614
diff
changeset
|
310 in echo area." |
058da2e83614
(tooltip-show): Change second arg to USE-ECHO-AREA
Kim F. Storm <storm@cua.dk>
parents:
61614
diff
changeset
|
311 (if use-echo-area |
32431
a35cc9700ff7
* tooltip.el (tooltip-use-echo-area): New user variable.
Sam Steingold <sds@gnu.org>
parents:
30481
diff
changeset
|
312 (message "%s" text) |
34540
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
313 (condition-case error |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
314 (let ((params (copy-sequence tooltip-frame-parameters)) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
315 (fg (face-attribute 'tooltip :foreground)) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
316 (bg (face-attribute 'tooltip :background))) |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
317 (when (stringp fg) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
318 (setq params (tooltip-set-param params 'foreground-color fg)) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
319 (setq params (tooltip-set-param params 'border-color fg))) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
320 (when (stringp bg) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
321 (setq params (tooltip-set-param params 'background-color bg))) |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
322 (x-show-tip (propertize text 'face 'tooltip) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
323 (selected-frame) |
35044 | 324 params |
35401
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
325 tooltip-hide-delay |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
326 tooltip-x-offset |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
327 tooltip-y-offset)) |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
328 (error |
34540
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
329 (message "Error while displaying tooltip: %s" error) |
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
330 (sit-for 1) |
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
331 (message "%s" text))))) |
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
332 |
25003 | 333 (defun tooltip-hide (&optional ignored-arg) |
334 "Hide a tooltip, if one is displayed. | |
335 Value is non-nil if tooltip was open." | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
336 (tooltip-cancel-delayed-tip) |
25003 | 337 (when (x-hide-tip) |
30481 | 338 (setq tooltip-hide-time (float-time)))) |
25003 | 339 |
340 | |
341 ;;; Debugger-related functions | |
342 | |
343 (defun tooltip-identifier-from-point (point) | |
344 "Extract the identifier at POINT, if any. | |
345 Value is nil if no identifier exists at point. Identifier extraction | |
346 is based on the current syntax table." | |
347 (save-excursion | |
348 (goto-char point) | |
349 (let ((start (progn (skip-syntax-backward "w_") (point)))) | |
350 (unless (looking-at "[0-9]") | |
351 (skip-syntax-forward "w_") | |
352 (when (> (point) start) | |
353 (buffer-substring start (point))))))) | |
354 | |
355 (defmacro tooltip-region-active-p () | |
356 "Value is non-nil if the region is currently active." | |
357 (if (string-match "^GNU" (emacs-version)) | |
358 `(and transient-mark-mode mark-active) | |
359 `(region-active-p))) | |
360 | |
361 (defun tooltip-expr-to-print (event) | |
362 "Return an expression that should be printed for EVENT. | |
363 If a region is active and the mouse is inside the region, print | |
364 the region. Otherwise, figure out the identifier around the point | |
365 where the mouse is." | |
366 (save-excursion | |
367 (set-buffer (tooltip-event-buffer event)) | |
368 (let ((point (posn-point (event-end event)))) | |
369 (if (tooltip-region-active-p) | |
370 (when (and (<= (region-beginning) point) (<= point (region-end))) | |
371 (buffer-substring (region-beginning) (region-end))) | |
372 (tooltip-identifier-from-point point))))) | |
373 | |
374 (defun tooltip-process-prompt-regexp (process) | |
375 "Return regexp matching the prompt of PROCESS at the end of a string. | |
376 The prompt is taken from the value of COMINT-PROMPT-REGEXP in the buffer | |
377 of PROCESS." | |
378 (let ((prompt-regexp (save-excursion | |
379 (set-buffer (process-buffer process)) | |
380 comint-prompt-regexp))) | |
381 ;; Most start with `^' but the one for `sdb' cannot be easily | |
382 ;; stripped. Code the prompt for `sdb' fixed here. | |
383 (if (= (aref prompt-regexp 0) ?^) | |
384 (setq prompt-regexp (substring prompt-regexp 1)) | |
385 (setq prompt-regexp "\\*")) | |
386 (concat "\n*" prompt-regexp "$"))) | |
387 | |
388 (defun tooltip-strip-prompt (process output) | |
389 "Return OUTPUT with any prompt of PROCESS stripped from its end." | |
390 (let ((prompt-regexp (tooltip-process-prompt-regexp process))) | |
391 (save-match-data | |
392 (when (string-match prompt-regexp output) | |
393 (setq output (substring output 0 (match-beginning 0))))) | |
394 output)) | |
395 | |
396 | |
397 ;;; Tips for `gud' | |
398 | |
399 (defvar tooltip-gud-original-filter nil | |
400 "Process filter to restore after GUD output has been received.") | |
401 | |
402 (defvar tooltip-gud-dereference nil | |
403 "Non-nil means print expressions with a `*' in front of them. | |
404 For C this would dereference a pointer expression.") | |
405 | |
406 (defvar tooltip-gud-event nil | |
407 "The mouse movement event that led to a tooltip display. | |
408 This event can be examined by forms in TOOLTIP-GUD-DISPLAY.") | |
409 | |
410 (defun tooltip-gud-toggle-dereference () | |
27582
42b52d8b6703
(tooltip-gud-tips-p, tooltip-gud-toggle-dereference):
Dave Love <fx@gnu.org>
parents:
25332
diff
changeset
|
411 "Toggle whether tooltips should show `* expr' or `expr'." |
25003 | 412 (interactive) |
413 (setq tooltip-gud-dereference (not tooltip-gud-dereference)) | |
414 (when (interactive-p) | |
415 (message "Dereferencing is now %s." | |
416 (if tooltip-gud-dereference "on" "off")))) | |
417 | |
61691
c7e8695076af
(tooltip-gud-tips-p): Expand documentation.
Nick Roberts <nickrob@snap.net.nz>
parents:
61677
diff
changeset
|
418 (defun tooltip-toggle-gud-tips () |
c7e8695076af
(tooltip-gud-tips-p): Expand documentation.
Nick Roberts <nickrob@snap.net.nz>
parents:
61677
diff
changeset
|
419 "Toggle the display of GUD tooltips." |
c7e8695076af
(tooltip-gud-tips-p): Expand documentation.
Nick Roberts <nickrob@snap.net.nz>
parents:
61677
diff
changeset
|
420 (interactive) |
c7e8695076af
(tooltip-gud-tips-p): Expand documentation.
Nick Roberts <nickrob@snap.net.nz>
parents:
61677
diff
changeset
|
421 (setq tooltip-gud-tips-p (not tooltip-gud-tips-p)) |
c7e8695076af
(tooltip-gud-tips-p): Expand documentation.
Nick Roberts <nickrob@snap.net.nz>
parents:
61677
diff
changeset
|
422 ;; Reconsider for all buffers whether mouse motion events are desired. |
c7e8695076af
(tooltip-gud-tips-p): Expand documentation.
Nick Roberts <nickrob@snap.net.nz>
parents:
61677
diff
changeset
|
423 (tooltip-change-major-mode) |
c7e8695076af
(tooltip-gud-tips-p): Expand documentation.
Nick Roberts <nickrob@snap.net.nz>
parents:
61677
diff
changeset
|
424 (when (interactive-p) |
c7e8695076af
(tooltip-gud-tips-p): Expand documentation.
Nick Roberts <nickrob@snap.net.nz>
parents:
61677
diff
changeset
|
425 (message (format "GUD tooltips %sabled" |
c7e8695076af
(tooltip-gud-tips-p): Expand documentation.
Nick Roberts <nickrob@snap.net.nz>
parents:
61677
diff
changeset
|
426 (if tooltip-gud-tips-p "en" "dis"))))) |
c7e8695076af
(tooltip-gud-tips-p): Expand documentation.
Nick Roberts <nickrob@snap.net.nz>
parents:
61677
diff
changeset
|
427 |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
428 ; This will only display data that comes in one chunk. |
48601
ac47e19224b0
(tooltip-gud-process-output): Handle annotations that
Nick Roberts <nickrob@snap.net.nz>
parents:
48580
diff
changeset
|
429 ; Larger arrays (say 400 elements) are displayed in |
48925
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
430 ; the tootip incompletely and spill over into the gud buffer. |
48601
ac47e19224b0
(tooltip-gud-process-output): Handle annotations that
Nick Roberts <nickrob@snap.net.nz>
parents:
48580
diff
changeset
|
431 ; Switching the process-filter creates timing problems and |
61691
c7e8695076af
(tooltip-gud-tips-p): Expand documentation.
Nick Roberts <nickrob@snap.net.nz>
parents:
61677
diff
changeset
|
432 ; it may be difficult to do better. Using annotations as in |
c7e8695076af
(tooltip-gud-tips-p): Expand documentation.
Nick Roberts <nickrob@snap.net.nz>
parents:
61677
diff
changeset
|
433 ; gdb-ui.el gets round this problem. |
25003 | 434 (defun tooltip-gud-process-output (process output) |
435 "Process debugger output and show it in a tooltip window." | |
436 (set-process-filter process tooltip-gud-original-filter) | |
61626
058da2e83614
(tooltip-show): Change second arg to USE-ECHO-AREA
Kim F. Storm <storm@cua.dk>
parents:
61614
diff
changeset
|
437 (tooltip-show (tooltip-strip-prompt process output) |
058da2e83614
(tooltip-show): Change second arg to USE-ECHO-AREA
Kim F. Storm <storm@cua.dk>
parents:
61614
diff
changeset
|
438 tooltip-gud-echo-area)) |
25003 | 439 |
440 (defun tooltip-gud-print-command (expr) | |
441 "Return a suitable command to print the expression EXPR. | |
442 If TOOLTIP-GUD-DEREFERENCE is t, also prepend a `*' to EXPR." | |
443 (when tooltip-gud-dereference | |
444 (setq expr (concat "*" expr))) | |
48572
67d16fb6f6c8
(tooltip-gud-tips-setup): Remove.
Nick Roberts <nickrob@snap.net.nz>
parents:
48517
diff
changeset
|
445 (case gud-minor-mode |
67d16fb6f6c8
(tooltip-gud-tips-setup): Remove.
Nick Roberts <nickrob@snap.net.nz>
parents:
48517
diff
changeset
|
446 ((gdb gdba) (concat "server print " expr)) |
48517
2941d71711f3
(tooltip-gud-print-command): Add server prefix to the
Nick Roberts <nickrob@snap.net.nz>
parents:
46025
diff
changeset
|
447 (dbx (concat "print " expr)) |
25003 | 448 (xdb (concat "p " expr)) |
449 (sdb (concat expr "/")) | |
450 (perldb expr))) | |
30481 | 451 |
25003 | 452 (defun tooltip-gud-tips (event) |
25332
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
453 "Show tip for identifier or selection under the mouse. |
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
454 The mouse must either point at an identifier or inside a selected |
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
455 region for the tip window to be shown. If tooltip-gud-dereference is t, |
61897
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
456 add a `*' in front of the printed expression. In the case of a C program |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
457 controlled by GDB, show the associated #define directives when program is |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
458 not executing. |
25003 | 459 |
460 This function must return nil if it doesn't handle EVENT." | |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
461 (let (process) |
25003 | 462 (when (and (eventp event) |
463 tooltip-gud-tips-p | |
464 (boundp 'gud-comint-buffer) | |
61897
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
465 gud-comint-buffer |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
466 (buffer-name gud-comint-buffer); gud-comint-buffer might be killed |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
467 (setq process (get-buffer-process gud-comint-buffer)) |
25003 | 468 (posn-point (event-end event)) |
61897
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
469 (or (eq gud-minor-mode 'gdba) |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
470 (progn (setq tooltip-gud-event event) |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
471 (eval (cons 'and tooltip-gud-display))))) |
25003 | 472 (let ((expr (tooltip-expr-to-print event))) |
473 (when expr | |
61897
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
474 (if (and (eq gud-minor-mode 'gdba) |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
475 (not gdb-active-process)) |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
476 (progn |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
477 (with-current-buffer |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
478 (window-buffer (let ((mouse (mouse-position))) |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
479 (window-at (cadr mouse) |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
480 (cddr mouse)))) |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
481 (when (boundp 'cc-define-alist) ; might be a Fortran program |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
482 (let ((define-elt (assoc expr cc-define-alist))) |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
483 (unless (null define-elt) |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
484 (tooltip-show (cdr define-elt)) |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
485 expr))))) |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
486 (let ((cmd (tooltip-gud-print-command expr))) |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
487 (unless (null cmd) ; CMD can be nil if unknown debugger |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
488 (case gud-minor-mode |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
489 (gdba (gdb-enqueue-input |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
490 (list (concat cmd "\n") 'gdb-tooltip-print))) |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
491 (t |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
492 (setq tooltip-gud-original-filter (process-filter process)) |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
493 (set-process-filter process 'tooltip-gud-process-output) |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
494 (gud-basic-call cmd))) |
c770a716e5cb
(tooltip-gud-tips): Show the associated #define
Nick Roberts <nickrob@snap.net.nz>
parents:
61691
diff
changeset
|
495 expr)))))))) |
48925
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
496 |
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
497 (defun gdb-tooltip-print () |
60808
9afb7c1de631
(tooltip-show-help-function): Check car and cdr of
Kim F. Storm <storm@cua.dk>
parents:
60547
diff
changeset
|
498 (tooltip-show |
48925
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
499 (with-current-buffer (gdb-get-buffer 'gdb-partial-output-buffer) |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
500 (let ((string (buffer-string))) |
61608
6a8ebeaf5f56
(tooltip-gud-echo-area): Rename from
Nick Roberts <nickrob@snap.net.nz>
parents:
61565
diff
changeset
|
501 ;; remove newline for tooltip-gud-echo-area |
61626
058da2e83614
(tooltip-show): Change second arg to USE-ECHO-AREA
Kim F. Storm <storm@cua.dk>
parents:
61614
diff
changeset
|
502 (substring string 0 (- (length string) 1)))) |
058da2e83614
(tooltip-show): Change second arg to USE-ECHO-AREA
Kim F. Storm <storm@cua.dk>
parents:
61614
diff
changeset
|
503 tooltip-gud-echo-area)) |
25003 | 504 |
505 | |
506 ;;; Tooltip help. | |
507 | |
508 (defvar tooltip-help-message nil | |
509 "The last help message received via `tooltip-show-help-function'.") | |
510 | |
511 (defun tooltip-show-help-function (msg) | |
512 "Function installed as `show-help-function'. | |
513 MSG is either a help string to display, or nil to cancel the display." | |
61161
22abf0130979
(tooltip-show-help-function): Don't fixup message here.
Kim F. Storm <storm@cua.dk>
parents:
61128
diff
changeset
|
514 (let ((previous-help tooltip-help-message)) |
25003 | 515 (setq tooltip-help-message msg) |
516 (cond ((null msg) | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
517 ;; Cancel display. This also cancels a delayed tip, if |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
518 ;; there is one. |
25003 | 519 (tooltip-hide)) |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
520 ((equal previous-help msg) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
521 ;; Same help as before (but possibly the mouse has moved). |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
522 ;; Keep what we have. |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
523 ) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
524 (t |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
525 ;; A different help. Remove a previous tooltip, and |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
526 ;; display a new one, with some delay. |
25003 | 527 (tooltip-hide) |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
528 (tooltip-start-delayed-tip))))) |
25003 | 529 |
530 (defun tooltip-help-tips (event) | |
531 "Hook function to display a help tooltip. | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
532 This is installed on the hook `tooltip-hook', which is run when |
42706 | 533 the timer with ID `tooltip-timeout-id' fires. |
25003 | 534 Value is non-nil if this function handled the tip." |
535 (when (stringp tooltip-help-message) | |
61626
058da2e83614
(tooltip-show): Change second arg to USE-ECHO-AREA
Kim F. Storm <storm@cua.dk>
parents:
61614
diff
changeset
|
536 (tooltip-show tooltip-help-message) |
25003 | 537 t)) |
538 | |
48601
ac47e19224b0
(tooltip-gud-process-output): Handle annotations that
Nick Roberts <nickrob@snap.net.nz>
parents:
48580
diff
changeset
|
539 (provide 'tooltip) |
25003 | 540 |
58155 | 541 ;; arch-tag: 3d61135e-4618-4a78-af28-183f6df5636f |
25003 | 542 ;;; tooltip.el ends here |