tooltip.el 16.6 KB
Newer Older
Pavel Janík's avatar
Pavel Janík committed
1
;;; tooltip.el --- show tooltip windows
Gerd Moellmann's avatar
Gerd Moellmann committed
2

3
;; Copyright (C) 1997, 1999, 2000, 2001, 2002, 2003, 2004, 2005
4
;;        Free Software Foundation, Inc.
Gerd Moellmann's avatar
Gerd Moellmann committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

;; Author: Gerd Moellmann <gerd@acm.org>
;; Keywords: help c mouse tools

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;; Commentary:

;;; Code:

30
(eval-when-compile (require 'cl)) ; for case macro
Stefan Monnier's avatar
Stefan Monnier committed
31

Gerd Moellmann's avatar
Gerd Moellmann committed
32 33 34 35 36 37

;;; Customizable settings

(defgroup tooltip nil
  "Customization group for the `tooltip' package."
  :group 'help
38
  :group 'gud
Gerd Moellmann's avatar
Gerd Moellmann committed
39 40
  :group 'mouse
  :group 'tools
41
  :version "21.1"
Gerd Moellmann's avatar
Gerd Moellmann committed
42 43
  :tag "Tool Tips")

44
(defcustom tooltip-delay 0.7
Gerd Moellmann's avatar
Gerd Moellmann committed
45 46 47 48 49 50 51 52 53 54 55 56
  "Seconds to wait before displaying a tooltip the first time."
  :tag "Delay"
  :type 'number
  :group 'tooltip)

(defcustom tooltip-short-delay 0.1
  "Seconds to wait between subsequent tooltips on different items."
  :tag "Short delay"
  :type 'number
  :group 'tooltip)

(defcustom tooltip-recent-seconds 1
57 58
  "Display tooltips if changing tip items within this many seconds.
Do so after `tooltip-short-delay'."
Gerd Moellmann's avatar
Gerd Moellmann committed
59 60 61 62
  :tag "Recent seconds"
  :type 'number
  :group 'tooltip)

63
(defcustom tooltip-hide-delay 10
64 65 66 67 68
  "Hide tooltips automatically after this many seconds."
  :tag "Hide delay"
  :type 'number
  :group 'tooltip)

69
(defcustom tooltip-x-offset nil
70
  "X offset, in pixels, for the display of tooltips.
71 72
The offset is relative to the position of the mouse.  It must
be chosen so that the tooltip window doesn't contain the mouse
73 74 75 76 77
when it pops up.  If the value is nil, the default offset is 5
pixels.

If `tooltip-frame-parameters' includes the `left' parameter,
the value of `tooltip-x-offset' is ignored."
78 79 80 81 82 83
  :tag "X offset"
  :type '(choice (const :tag "Default" nil)
		 (integer :tag "Offset" :value 1))
  :group 'tooltip)

(defcustom tooltip-y-offset nil
84
  "Y offset, in pixels, for the display of tooltips.
85 86
The offset is relative to the position of the mouse.  It must
be chosen so that the tooltip window doesn't contain the mouse
87 88 89 90 91
when it pops up.  If the value is nil, the default offset is -10
pixels.

If `tooltip-frame-parameters' includes the `top' parameter,
the value of `tooltip-y-offset' is ignored."
92 93 94 95 96
  :tag "Y offset"
  :type '(choice (const :tag "Default" nil)
		 (integer :tag "Offset" :value 1))
  :group 'tooltip)

Gerd Moellmann's avatar
Gerd Moellmann committed
97 98 99 100
(defcustom tooltip-frame-parameters
  '((name . "tooltip")
    (internal-border-width . 5)
    (border-width . 1))
101 102 103 104
  "Frame parameters used for tooltips.

If `left' or `top' parameters are included, they specify the absolute
position to pop up the tooltip."
Gerd Moellmann's avatar
Gerd Moellmann committed
105 106 107 108
  :type 'sexp
  :tag "Frame Parameters"
  :group 'tooltip)

109 110
(defface tooltip
  '((((class color))
111 112 113 114 115
     :background "lightyellow"
     :foreground "black"
     :inherit variable-pitch)
    (t
     :inherit variable-pitch))
116 117 118
  "Face for tooltips."
  :group 'tooltip)

Gerd Moellmann's avatar
Gerd Moellmann committed
119
(defcustom tooltip-gud-tips-p nil
120
  "*Non-nil means show tooltips in GUD sessions."
Gerd Moellmann's avatar
Gerd Moellmann committed
121 122 123 124
  :type 'boolean
  :tag "GUD"
  :group 'tooltip)

125
(defcustom tooltip-gud-modes '(gud-mode c-mode c++-mode fortran-mode)
Gerd Moellmann's avatar
Gerd Moellmann committed
126 127 128 129 130 131 132
  "List of modes for which to enable GUD tips."
  :type 'sexp
  :tag "GUD modes"
  :group 'tooltip)

(defcustom tooltip-gud-display
  '((eq (tooltip-event-buffer tooltip-gud-event)
133
	(marker-buffer gud-overlay-arrow-position)))
Gerd Moellmann's avatar
Gerd Moellmann committed
134 135 136 137 138 139 140 141
  "List of forms determining where GUD tooltips are displayed.

Forms in the list are combined with AND.  The default is to display
only tooltips in the buffer containing the overlay arrow."
  :type 'sexp
  :tag "GUD buffers predicate"
  :group 'tooltip)

142
(defcustom tooltip-use-echo-area nil
Dave Love's avatar
Dave Love committed
143 144 145
  "Use the echo area instead of tooltip frames.
This is only relevant GUD display, since otherwise it is equivalent to
turning off Tooltip mode."
146
  :type 'boolean
Dave Love's avatar
Dave Love committed
147
  :tag "Use echo area"
148 149
  :group 'tooltip)

Gerd Moellmann's avatar
Gerd Moellmann committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185

;;; Variables that are not customizable.

(defvar tooltip-hook nil
  "Functions to call to display tooltips.
Each function is called with one argument EVENT which is a copy of
the last mouse movement event that occurred.")

(defvar tooltip-timeout-id nil
  "The id of the timeout started when Emacs becomes idle.")

(defvar tooltip-last-mouse-motion-event nil
  "A copy of the last mouse motion event seen.")

(defvar tooltip-hide-time nil
  "Time when the last tooltip was hidden.")


;;; Event accessors

(defun tooltip-event-buffer (event)
  "Return the buffer over which event EVENT occurred.
This might return nil if the event did not occur over a buffer."
  (let ((window (posn-window (event-end event))))
    (and window (window-buffer window))))


;;; Switching tooltips on/off

;; We don't set track-mouse globally because this is a big redisplay
;; problem in buffers having a pre-command-hook or such installed,
;; which does a set-buffer, like the summary buffer of Gnus.  Calling
;; set-buffer prevents redisplay optimizations, so every mouse motion
;; would be accompanied by a full redisplay.

;;;###autoload
186 187
(define-minor-mode tooltip-mode
  "Toggle Tooltip display.
Gerd Moellmann's avatar
Gerd Moellmann committed
188
With ARG, turn tooltip mode on if and only if ARG is positive."
189 190
  :global t
  :group 'tooltip
191
  (unless (or (null tooltip-mode) (fboundp 'x-show-tip))
192
    (error "Sorry, tooltips are not yet available on this system"))
193
  (let ((hook-fn (if tooltip-mode 'add-hook 'remove-hook)))
Gerd Moellmann's avatar
Gerd Moellmann committed
194 195 196 197 198
    (funcall hook-fn 'change-major-mode-hook 'tooltip-change-major-mode)
    (tooltip-activate-mouse-motions-if-enabled)
    (funcall hook-fn 'pre-command-hook 'tooltip-hide)
    (funcall hook-fn 'tooltip-hook 'tooltip-gud-tips)
    (funcall hook-fn 'tooltip-hook 'tooltip-help-tips)
199
    (setq show-help-function (if tooltip-mode 'tooltip-show-help-function nil))
Gerd Moellmann's avatar
Gerd Moellmann committed
200 201
    ;; `ignore' is the default binding for mouse movements.
    (define-key global-map [mouse-movement]
202
      (if tooltip-mode 'tooltip-mouse-motion 'ignore))))
203

Gerd Moellmann's avatar
Gerd Moellmann committed
204 205 206 207 208 209

;;; Timeout for tooltip display

(defun tooltip-delay ()
  "Return the delay in seconds for the next tooltip."
  (let ((delay tooltip-delay)
Sam Steingold's avatar
Sam Steingold committed
210
	(now (float-time)))
Gerd Moellmann's avatar
Gerd Moellmann committed
211 212 213 214 215
    (when (and tooltip-hide-time
	       (< (- now tooltip-hide-time) tooltip-recent-seconds))
      (setq delay tooltip-short-delay))
    delay))

Gerd Moellmann's avatar
Gerd Moellmann committed
216
(defun tooltip-cancel-delayed-tip ()
Gerd Moellmann's avatar
Gerd Moellmann committed
217 218 219 220 221
  "Disable the tooltip timeout."
  (when tooltip-timeout-id
    (disable-timeout tooltip-timeout-id)
    (setq tooltip-timeout-id nil)))

Gerd Moellmann's avatar
Gerd Moellmann committed
222
(defun tooltip-start-delayed-tip ()
Gerd Moellmann's avatar
Gerd Moellmann committed
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
  "Add a one-shot timeout to call function tooltip-timeout."
  (setq tooltip-timeout-id
	(add-timeout (tooltip-delay) 'tooltip-timeout nil)))

(defun tooltip-timeout (object)
  "Function called when timer with id tooltip-timeout-id fires."
  (run-hook-with-args-until-success 'tooltip-hook
				    tooltip-last-mouse-motion-event))


;;; Reacting on mouse movements

(defun tooltip-change-major-mode ()
  "Function added to `change-major-mode-hook' when tooltip mode is on."
  (add-hook 'post-command-hook 'tooltip-activate-mouse-motions-if-enabled))

(defun tooltip-activate-mouse-motions-if-enabled ()
  "Reconsider for all buffers whether mouse motion events are desired."
  (remove-hook 'post-command-hook 'tooltip-activate-mouse-motions-if-enabled)
242
  (dolist (buffer (buffer-list))
Gerd Moellmann's avatar
Gerd Moellmann committed
243
    (save-excursion
244 245 246 247 248 249
      (set-buffer buffer)
      (if (and tooltip-mode
	       tooltip-gud-tips-p
	       (memq major-mode tooltip-gud-modes))
	  (tooltip-activate-mouse-motions t)
	(tooltip-activate-mouse-motions nil)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
250

251 252
(defvar tooltip-mouse-motions-active nil
  "Locally t in a buffer if tooltip processing of mouse motion is enabled.")
Gerd Moellmann's avatar
Gerd Moellmann committed
253 254 255 256 257 258

(defun tooltip-activate-mouse-motions (activatep)
  "Activate/deactivate mouse motion events for the current buffer.
ACTIVATEP non-nil means activate mouse motion events."
  (if activatep
      (progn
259 260
	(make-local-variable 'tooltip-mouse-motions-active)
	(setq tooltip-mouse-motions-active t)
Gerd Moellmann's avatar
Gerd Moellmann committed
261 262
	(make-local-variable 'track-mouse)
	(setq track-mouse t))
263 264 265
    (when tooltip-mouse-motions-active
      (kill-local-variable 'tooltip-mouse-motions-active)
      (kill-local-variable 'track-mouse))))
Gerd Moellmann's avatar
Gerd Moellmann committed
266 267 268 269 270 271 272

(defun tooltip-mouse-motion (event)
  "Command handler for mouse movement events in `global-map'."
  (interactive "e")
  (tooltip-hide)
  (when (car (mouse-pixel-position))
    (setq tooltip-last-mouse-motion-event (copy-sequence event))
Gerd Moellmann's avatar
Gerd Moellmann committed
273
    (tooltip-start-delayed-tip)))
Gerd Moellmann's avatar
Gerd Moellmann committed
274 275 276 277


;;; Displaying tips

278
(defun tooltip-set-param (alist key value)
Eli Zaretskii's avatar
Eli Zaretskii committed
279
  "Change the value of KEY in alist ALIST to VALUE.
280
If there's no association for KEY in ALIST, add one, otherwise
281 282 283 284 285 286 287
change the existing association.  Value is the resulting alist."
  (let ((param (assq key alist)))
    (if (consp param)
	(setcdr param value)
      (push (cons key value) alist))
    alist))

Gerd Moellmann's avatar
Gerd Moellmann committed
288
(defun tooltip-show (text)
289 290 291 292 293 294 295 296 297
  "Show a tooltip window displaying TEXT.

Text larger than `x-max-tooltip-size' (which see) is clipped.

If the alist in `tooltip-frame-parameters' includes `left' and `top'
parameters, they determine the x and y position where the tooltip
is displayed.  Otherwise, the tooltip pops at offsets specified by
`tooltip-x-offset' and `tooltip-y-offset' from the current mouse
position."
298 299
  (if tooltip-use-echo-area
      (message "%s" text)
300
    (condition-case error
301 302 303
	(let ((params (copy-sequence tooltip-frame-parameters))
	      (fg (face-attribute 'tooltip :foreground))
	      (bg (face-attribute 'tooltip :background)))
Gerd Moellmann's avatar
Gerd Moellmann committed
304 305 306 307 308
	  (when (stringp fg)
	    (setq params (tooltip-set-param params 'foreground-color fg))
	    (setq params (tooltip-set-param params 'border-color fg)))
	  (when (stringp bg)
	    (setq params (tooltip-set-param params 'background-color bg)))
309 310
	  (x-show-tip (propertize text 'face 'tooltip)
		      (selected-frame)
Gerd Moellmann's avatar
Gerd Moellmann committed
311
		      params
312
		      tooltip-hide-delay
313 314
		      tooltip-x-offset
		      tooltip-y-offset))
315
      (error
316 317 318 319
       (message "Error while displaying tooltip: %s" error)
       (sit-for 1)
       (message "%s" text)))))

Gerd Moellmann's avatar
Gerd Moellmann committed
320 321 322
(defun tooltip-hide (&optional ignored-arg)
  "Hide a tooltip, if one is displayed.
Value is non-nil if tooltip was open."
Gerd Moellmann's avatar
Gerd Moellmann committed
323
  (tooltip-cancel-delayed-tip)
Gerd Moellmann's avatar
Gerd Moellmann committed
324
  (when (x-hide-tip)
Sam Steingold's avatar
Sam Steingold committed
325
    (setq tooltip-hide-time (float-time))))
Gerd Moellmann's avatar
Gerd Moellmann committed
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397


;;; Debugger-related functions

(defun tooltip-identifier-from-point (point)
  "Extract the identifier at POINT, if any.
Value is nil if no identifier exists at point.  Identifier extraction
is based on the current syntax table."
  (save-excursion
    (goto-char point)
    (let ((start (progn (skip-syntax-backward "w_") (point))))
      (unless (looking-at "[0-9]")
	(skip-syntax-forward "w_")
	(when (> (point) start)
	  (buffer-substring start (point)))))))

(defmacro tooltip-region-active-p ()
  "Value is non-nil if the region is currently active."
  (if (string-match "^GNU" (emacs-version))
      `(and transient-mark-mode mark-active)
    `(region-active-p)))

(defun tooltip-expr-to-print (event)
  "Return an expression that should be printed for EVENT.
If a region is active and the mouse is inside the region, print
the region.  Otherwise, figure out the identifier around the point
where the mouse is."
  (save-excursion
    (set-buffer (tooltip-event-buffer event))
    (let ((point (posn-point (event-end event))))
      (if (tooltip-region-active-p)
	  (when (and (<= (region-beginning) point) (<= point (region-end)))
	    (buffer-substring (region-beginning) (region-end)))
	(tooltip-identifier-from-point point)))))

(defun tooltip-process-prompt-regexp (process)
  "Return regexp matching the prompt of PROCESS at the end of a string.
The prompt is taken from the value of COMINT-PROMPT-REGEXP in the buffer
of PROCESS."
  (let ((prompt-regexp (save-excursion
			 (set-buffer (process-buffer process))
			 comint-prompt-regexp)))
    ;; Most start with `^' but the one for `sdb' cannot be easily
    ;; stripped.  Code the prompt for `sdb' fixed here.
    (if (= (aref prompt-regexp 0) ?^)
	(setq prompt-regexp (substring prompt-regexp 1))
      (setq prompt-regexp "\\*"))
    (concat "\n*" prompt-regexp "$")))

(defun tooltip-strip-prompt (process output)
  "Return OUTPUT with any prompt of PROCESS stripped from its end."
  (let ((prompt-regexp (tooltip-process-prompt-regexp process)))
    (save-match-data
      (when (string-match prompt-regexp output)
	(setq output (substring output 0 (match-beginning 0)))))
    output))


;;; Tips for `gud'

(defvar tooltip-gud-original-filter nil
  "Process filter to restore after GUD output has been received.")

(defvar tooltip-gud-dereference nil
  "Non-nil means print expressions with a `*' in front of them.
For C this would dereference a pointer expression.")

(defvar tooltip-gud-event nil
  "The mouse movement event that led to a tooltip display.
This event can be examined by forms in TOOLTIP-GUD-DISPLAY.")

(defun tooltip-gud-toggle-dereference ()
398
  "Toggle whether tooltips should show `* expr' or `expr'."
Gerd Moellmann's avatar
Gerd Moellmann committed
399 400 401 402 403 404
  (interactive)
  (setq tooltip-gud-dereference (not tooltip-gud-dereference))
  (when (interactive-p)
    (message "Dereferencing is now %s."
	     (if tooltip-gud-dereference "on" "off"))))

405
; This will only display data that comes in one chunk.
406
; Larger arrays (say 400 elements) are displayed in
407
; the tootip incompletely and spill over into the gud buffer.
408
; Switching the process-filter creates timing problems and
409 410
; it may be difficult to do better. gdba in gdb-ui.el
; gets round this problem.
Gerd Moellmann's avatar
Gerd Moellmann committed
411 412 413
(defun tooltip-gud-process-output (process output)
  "Process debugger output and show it in a tooltip window."
  (set-process-filter process tooltip-gud-original-filter)
414
  (tooltip-show (tooltip-strip-prompt process output)))
Gerd Moellmann's avatar
Gerd Moellmann committed
415 416 417 418 419 420

(defun tooltip-gud-print-command (expr)
  "Return a suitable command to print the expression EXPR.
If TOOLTIP-GUD-DEREFERENCE is t, also prepend a `*' to EXPR."
  (when tooltip-gud-dereference
    (setq expr (concat "*" expr)))
421 422
  (case gud-minor-mode
    ((gdb gdba) (concat "server print " expr))
423
    (dbx (concat "print " expr))
Gerd Moellmann's avatar
Gerd Moellmann committed
424 425 426
    (xdb (concat "p " expr))
    (sdb (concat expr "/"))
    (perldb expr)))
Sam Steingold's avatar
Sam Steingold committed
427

Gerd Moellmann's avatar
Gerd Moellmann committed
428
(defun tooltip-gud-tips (event)
429 430 431 432
  "Show tip for identifier or selection under the mouse.
The mouse must either point at an identifier or inside a selected
region for the tip window to be shown.  If tooltip-gud-dereference is t,
add a `*' in front of the printed expression.
Gerd Moellmann's avatar
Gerd Moellmann committed
433 434

This function must return nil if it doesn't handle EVENT."
435
  (let (process)
Gerd Moellmann's avatar
Gerd Moellmann committed
436 437 438
    (when (and (eventp event)
	       tooltip-gud-tips-p
	       (boundp 'gud-comint-buffer)
439
	       (setq process (get-buffer-process gud-comint-buffer))
Gerd Moellmann's avatar
Gerd Moellmann committed
440 441 442 443 444
	       (posn-point (event-end event))
	       (progn (setq tooltip-gud-event event)
		      (eval (cons 'and tooltip-gud-display))))
      (let ((expr (tooltip-expr-to-print event)))
	(when expr
445 446
	  (let ((cmd (tooltip-gud-print-command expr)))
	    (unless (null cmd)	       ; CMD can be nil if unknown debugger
447
	      (case gud-minor-mode
448
		    (gdba (gdb-enqueue-input
449
			   (list  (concat cmd "\n") 'gdb-tooltip-print)))
450
		    (t
451 452 453 454 455 456
		     (setq tooltip-gud-original-filter (process-filter process))
		       (set-process-filter process 'tooltip-gud-process-output)
		       (gud-basic-call cmd)))
		    expr)))))))

(defun gdb-tooltip-print ()
457
  (tooltip-show
458
   (with-current-buffer (gdb-get-buffer 'gdb-partial-output-buffer)
459 460 461
     (let ((string (buffer-string)))
       ;; remove newline for tooltip-use-echo-area
       (substring string 0 (- (length string) 1))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
462 463 464 465 466 467 468 469 470 471


;;; Tooltip help.

(defvar tooltip-help-message nil
  "The last help message received via `tooltip-show-help-function'.")

(defun tooltip-show-help-function (msg)
  "Function installed as `show-help-function'.
MSG is either a help string to display, or nil to cancel the display."
472
  (let ((previous-help tooltip-help-message))
Gerd Moellmann's avatar
Gerd Moellmann committed
473 474
    (setq tooltip-help-message msg)
    (cond ((null msg)
Gerd Moellmann's avatar
Gerd Moellmann committed
475 476
	   ;; Cancel display.  This also cancels a delayed tip, if
	   ;; there is one.
Gerd Moellmann's avatar
Gerd Moellmann committed
477
	   (tooltip-hide))
Gerd Moellmann's avatar
Gerd Moellmann committed
478 479 480 481
	  ((equal previous-help msg)
	   ;; Same help as before (but possibly the mouse has moved).
	   ;; Keep what we have.
	   )
Gerd Moellmann's avatar
Gerd Moellmann committed
482
	  (t
483
	   ;; A different help.  Remove a previous tooltip, and
Gerd Moellmann's avatar
Gerd Moellmann committed
484 485 486
	   ;; display a new one, with some delay.
	   (tooltip-hide)
	   (tooltip-start-delayed-tip)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
487 488 489

(defun tooltip-help-tips (event)
  "Hook function to display a help tooltip.
Gerd Moellmann's avatar
Gerd Moellmann committed
490
This is installed on the hook `tooltip-hook', which is run when
Pavel Janík's avatar
Pavel Janík committed
491
the timer with ID `tooltip-timeout-id' fires.
Gerd Moellmann's avatar
Gerd Moellmann committed
492 493 494 495 496
Value is non-nil if this function handled the tip."
  (when (stringp tooltip-help-message)
    (tooltip-show tooltip-help-message)
    t))

497
(provide 'tooltip)
Gerd Moellmann's avatar
Gerd Moellmann committed
498

Stefan Monnier's avatar
Stefan Monnier committed
499
;; arch-tag: 3d61135e-4618-4a78-af28-183f6df5636f
Gerd Moellmann's avatar
Gerd Moellmann committed
500
;;; tooltip.el ends here