-;;; tooltip.el --- Show tooltip windows
+;;; tooltip.el --- show tooltip windows
;; Copyright (C) 1997, 1999, 2000, 2001 Free Software Foundation, Inc.
;;; Commentary:
-;; Put into your `.emacs'
-
-;; (require 'tooltip)
-;; (tooltip-mode 1)
-
-
-\f
;;; Code:
(eval-when-compile
(require 'cl)
(require 'comint)
- (require 'gud))
-
-(provide 'tooltip)
+ (require 'gud)
+ (require 'gdb-ui))
\f
;;; Customizable settings
(defvar tooltip-mode)
-(defcustom tooltip-delay 1.0
+(defcustom tooltip-delay 0.7
"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
"Display tooltips if changing tip items within this many seconds.
Do so after `tooltip-short-delay'."
:type 'number
:group 'tooltip)
-
-(defcustom tooltip-hide-delay 5
+(defcustom tooltip-hide-delay 10
"Hide tooltips automatically after this many seconds."
:tag "Hide delay"
:type 'number
:group 'tooltip)
-
(defcustom tooltip-x-offset nil
- "Specify an X offset for the display of tooltips.
+ "X offset, in pixels, for the display of tooltips.
The offset is relative to the position of the mouse. It must
be chosen so that the tooltip window doesn't contain the mouse
-when it pops up."
+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."
:tag "X offset"
:type '(choice (const :tag "Default" nil)
(integer :tag "Offset" :value 1))
:group 'tooltip)
-
(defcustom tooltip-y-offset nil
- "Specify an Y offset for the display of tooltips.
+ "Y offset, in pixels, for the display of tooltips.
The offset is relative to the position of the mouse. It must
be chosen so that the tooltip window doesn't contain the mouse
-when it pops up."
+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."
:tag "Y offset"
:type '(choice (const :tag "Default" nil)
(integer :tag "Offset" :value 1))
:group 'tooltip)
-
(defcustom tooltip-frame-parameters
'((name . "tooltip")
(internal-border-width . 5)
(border-width . 1))
- "Frame parameters used for tooltips."
+ "Frame parameters used for tooltips.
+
+If `left' or `top' parameters are included, they specify the absolute
+position to pop up the tooltip."
:type 'sexp
:tag "Frame Parameters"
:group 'tooltip)
-
(defface tooltip
'((((class color))
- (:background "lightyellow" :foreground "black"))
- (t ()))
+ :background "lightyellow"
+ :foreground "black"
+ :inherit variable-pitch)
+ (t
+ :inherit variable-pitch))
"Face for tooltips."
:group 'tooltip)
-
(defcustom tooltip-gud-tips-p nil
"*Non-nil means show tooltips in GUD sessions."
:type 'boolean
:tag "GUD"
:set #'(lambda (symbol on)
- (setq tooltip-gud-tips-p on)
- (if on (tooltip-gud-tips-setup)))
+ (setq tooltip-gud-tips-p on))
:group 'tooltip)
-
(defcustom tooltip-gud-modes '(gud-mode c-mode c++-mode)
"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)
(marker-buffer overlay-arrow-position)))
:tag "GUD buffers predicate"
:group 'tooltip)
-
(defcustom tooltip-use-echo-area nil
"Use the echo area instead of tooltip frames.
This is only relevant GUD display, since otherwise it is equivalent to
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.")
-
-(defvar tooltip-gud-debugger nil
- "The debugger for which we show tooltips.")
-
-
\f
;;; Event accessors
(let ((window (posn-window (event-end event))))
(and window (window-buffer window))))
-
\f
;;; Switching tooltips on/off
(setq show-help-function (if on 'tooltip-show-help-function nil))
;; `ignore' is the default binding for mouse movements.
(define-key global-map [mouse-movement]
- (if on 'tooltip-mouse-motion 'ignore))
- (tooltip-gud-tips-setup)))
-
-(defun tooltip-gud-tips-setup ()
- "Setup debugger mode-hooks for tooltips."
- (when (and tooltip-mode tooltip-gud-tips-p)
- (global-set-key [S-mouse-3] 'tooltip-gud-toggle-dereference)
- (add-hook 'gdb-mode-hook
- #'(lambda () (setq tooltip-gud-debugger 'gdb)))
- (add-hook 'sdb-mode-hook
- #'(lambda () (setq tooltip-gud-debugger 'sdb)))
- (add-hook 'dbx-mode-hook
- #'(lambda () (setq tooltip-gud-debugger 'dbx)))
- (add-hook 'xdb-mode-hook
- #'(lambda () (setq tooltip-gud-debugger 'xdb)))
- (add-hook 'perldb-mode-hook
- #'(lambda () (setq tooltip-gud-debugger 'perldb)))))
+ (if on 'tooltip-mouse-motion 'ignore))))
+
\f
;;; Timeout for tooltip display
(setq delay tooltip-short-delay))
delay))
-
(defun tooltip-cancel-delayed-tip ()
"Disable the tooltip timeout."
(when tooltip-timeout-id
(disable-timeout tooltip-timeout-id)
(setq tooltip-timeout-id nil)))
-
(defun tooltip-start-delayed-tip ()
"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))
-
\f
;;; Reacting on mouse movements
"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)
(tooltip-activate-mouse-motions nil))
(setq buffers (cdr buffers))))))
+(defvar tooltip-mouse-motions-active nil
+ "Locally t in a buffer if tooltip processing of mouse motion is enabled.")
(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
+ (make-local-variable 'tooltip-mouse-motions-active)
+ (setq tooltip-mouse-motions-active t)
(make-local-variable 'track-mouse)
(setq track-mouse t))
- (kill-local-variable 'track-mouse)))
-
+ (when tooltip-mouse-motions-active
+ (kill-local-variable 'tooltip-mouse-motions-active)
+ (kill-local-variable 'track-mouse))))
(defun tooltip-mouse-motion (event)
"Command handler for mouse movement events in `global-map'."
(setq tooltip-last-mouse-motion-event (copy-sequence event))
(tooltip-start-delayed-tip)))
-
\f
;;; Displaying tips
(defun tooltip-set-param (alist key value)
- "Change the value of KEY in alist ALIAS to VALUE.
-If there's no association for KEY in ALIST, add one, otherwise
+ "Change the value of KEY in alist ALIST to VALUE.
+If there's no association for KEY in ALIST, add one, otherwise
change the existing association. Value is the resulting alist."
(let ((param (assq key alist)))
(if (consp param)
(push (cons key value) alist))
alist))
-
(defun tooltip-show (text)
- "Show a tooltip window at the current mouse position displaying TEXT."
+ "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."
(if tooltip-use-echo-area
(message "%s" text)
(condition-case error
tooltip-hide-delay
tooltip-x-offset
tooltip-y-offset))
- (error
+ (error
(message "Error while displaying tooltip: %s" error)
(sit-for 1)
(message "%s" text)))))
-
(defun tooltip-hide (&optional ignored-arg)
"Hide a tooltip, if one is displayed.
Value is non-nil if tooltip was open."
(when (x-hide-tip)
(setq tooltip-hide-time (float-time))))
-
\f
;;; Debugger-related functions
(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
(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
(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)))
(setq output (substring output 0 (match-beginning 0)))))
output))
-
\f
;;; 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.")
-
-(defvar tooltip-gud-debugger nil
- "A symbol describing the debugger running under GUD.")
-
-
(defun tooltip-gud-toggle-dereference ()
"Toggle whether tooltips should show `* expr' or `expr'."
(interactive)
(message "Dereferencing is now %s."
(if tooltip-gud-dereference "on" "off"))))
-
+; This will only display data that comes in one chunk.
+; Larger arrays (say 400 elements) are displayed in
+; the tootip incompletely and spill over into the gud buffer.
+; Switching the process-filter creates timing problems and
+; it may be difficult to do better. gdba in gdb-ui.el
+; gets round this problem.
(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)
(tooltip-show (tooltip-strip-prompt process output)))
-
(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)))
- (case tooltip-gud-debugger
- ((gdb dbx) (concat "print " expr))
+ (case gud-minor-mode
+ ((gdb gdba) (concat "server print " expr))
+ (dbx (concat "print " expr))
(xdb (concat "p " expr))
(sdb (concat expr "/"))
(perldb expr)))
-
(defun tooltip-gud-tips (event)
"Show tip for identifier or selection under the mouse.
The mouse must either point at an identifier or inside a selected
(when expr
(let ((cmd (tooltip-gud-print-command expr)))
(unless (null cmd) ; CMD can be nil if unknown debugger
- (setq tooltip-gud-original-filter (process-filter process))
- (set-process-filter process 'tooltip-gud-process-output)
- (gud-basic-call cmd)
- expr)))))))
+ (case gud-minor-mode
+ (gdba (gdb-enqueue-input
+ (list (concat cmd "\n") 'gdb-tooltip-print)))
+ (t
+ (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 ()
+ (tooltip-show
+ (with-current-buffer (gdb-get-buffer 'gdb-partial-output-buffer)
+ (buffer-string))))
\f
;;; 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."
;; Keep what we have.
)
(t
- ;; A different help. Remove a previous tooltip, and
+ ;; A different help. Remove a previous tooltip, and
;; display a new one, with some delay.
(tooltip-hide)
(tooltip-start-delayed-tip)))))
-
(defun tooltip-help-tips (event)
"Hook function to display a help tooltip.
This is installed on the hook `tooltip-hook', which is run when
-the the timer with ID `tooltip-timeout-id' fires.
+the timer with ID `tooltip-timeout-id' fires.
Value is non-nil if this function handled the tip."
(when (stringp tooltip-help-message)
(tooltip-show tooltip-help-message)
t))
-
\f
;;; Do this after all functions have been defined that are called from
;;; `tooltip-mode'. The actual default value of `tooltip-mode' is set
:require 'tooltip
:group 'tooltip)
+(provide 'tooltip)
+;;; arch-tag: 3d61135e-4618-4a78-af28-183f6df5636f
;;; tooltip.el ends here