1 ;;; gud.el --- Grand Unified Debugger mode for running GDB and other debuggers
3 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
5 ;; Keywords: unix, tools
7 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 2000, 2001, 2002, 2003,
8 ;; 2004, 2005 Free Software Foundation, Inc.
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
29 ;; The ancestral gdb.el was by W. Schelter <wfs@rascal.ics.utexas.edu> It was
30 ;; later rewritten by rms. Some ideas were due to Masanobu. Grand
31 ;; Unification (sdb/dbx support) by Eric S. Raymond <esr@thyrsus.com> Barry
32 ;; Warsaw <bwarsaw@cen.com> hacked the mode to use comint.el. Shane Hartman
33 ;; <shane@spr.com> added support for xdb (HPUX debugger). Rick Sladkey
34 ;; <jrs@world.std.com> wrote the GDB command completion code. Dave Love
35 ;; <d.love@dl.ac.uk> added the IRIX kluge, re-implemented the Mips-ish variant
36 ;; and added a menu. Brian D. Carlstrom <bdc@ai.mit.edu> combined the IRIX
37 ;; kluge with the gud-xdb-directories hack producing gud-dbx-directories.
38 ;; Derek L. Davies <ddavies@world.std.com> added support for jdb (Java
43 (eval-when-compile (require 'cl)) ; for case macro
48 (defvar gdb-active-process)
49 (defvar gdb-define-alist)
50 (defvar gdb-macro-info)
51 (defvar gdb-server-prefix)
52 (defvar gdb-show-changed-values)
53 (defvar gdb-var-changed)
57 ;; ======================================================================
58 ;; GUD commands must be visible in C buffers visited by GUD
61 "Grand Unified Debugger mode for gdb and other debuggers under Emacs.
62 Supported debuggers include gdb, sdb, dbx, xdb, perldb, pdb (Python), jdb, and bash."
67 (defcustom gud-key-prefix "\C-x\C-a"
68 "Prefix of all GUD commands valid in C buffers."
72 (global-set-key (concat gud-key-prefix "\C-l") 'gud-refresh)
73 (define-key ctl-x-map " " 'gud-break) ;; backward compatibility hack
75 (defvar gud-marker-filter nil)
76 (put 'gud-marker-filter 'permanent-local t)
77 (defvar gud-find-file nil)
78 (put 'gud-find-file 'permanent-local t)
80 (defun gud-marker-filter (&rest args)
81 (apply gud-marker-filter args))
83 (defvar gud-minor-mode nil)
84 (put 'gud-minor-mode 'permanent-local t)
86 (defvar gud-keep-buffer nil)
88 (defun gud-symbol (sym &optional soft minor-mode)
89 "Return the symbol used for SYM in MINOR-MODE.
90 MINOR-MODE defaults to `gud-minor-mode.
91 The symbol returned is `gud-<MINOR-MODE>-<SYM>'.
92 If SOFT is non-nil, returns nil if the symbol doesn't already exist."
93 (unless (or minor-mode gud-minor-mode) (error "Gud internal error"))
94 (funcall (if soft 'intern-soft 'intern)
95 (format "gud-%s-%s" (or minor-mode gud-minor-mode) sym)))
97 (defun gud-val (sym &optional minor-mode)
98 "Return the value of `gud-symbol' SYM. Default to nil."
99 (let ((sym (gud-symbol sym t minor-mode)))
100 (if (boundp sym) (symbol-value sym))))
102 (defvar gud-running nil
103 "Non-nil if debuggee is running.
104 Used to grey out relevant togolbar icons.")
106 ;; Use existing Info buffer, if possible.
107 (defun gud-goto-info ()
108 "Go to relevant Emacs info node."
110 (let ((same-window-regexps same-window-regexps)
111 (display-buffer-reuse-frames t))
115 (if (eq (window-buffer window) (get-buffer "*info*"))
117 (setq same-window-regexps nil)
118 (throw 'info-found nil))))
120 (select-frame (make-frame)))
121 (if (memq gud-minor-mode '(gdbmi gdba))
122 (info "(emacs)GDB Graphical Interface")
123 (info "(emacs)Debuggers"))))
125 (easy-mmode-defmap gud-menu-map
126 '(([help] "Info" . gud-goto-info)
127 ([tooltips] menu-item "Toggle GUD tooltips" gud-tooltip-mode
128 :enable (and (not emacs-basic-display)
130 (fboundp 'x-show-tip))
131 :button (:toggle . gud-tooltip-mode))
132 ([refresh] "Refresh" . gud-refresh)
133 ([run] menu-item "Run" gud-run
134 :enable (and (not gud-running)
135 (memq gud-minor-mode '(gdbmi gdba gdb dbx jdb))))
136 ([until] menu-item "Continue to selection" gud-until
137 :enable (and (not gud-running)
138 (memq gud-minor-mode '(gdbmi gdba gdb perldb)))
139 :visible (not (and (memq gud-minor-mode '(gdbmi gdba))
140 (> (car (window-fringes)) 0))))
141 ([remove] menu-item "Remove Breakpoint" gud-remove
142 :enable (not gud-running)
143 :visible (not (and (memq gud-minor-mode '(gdbmi gdba))
144 (> (car (window-fringes)) 0))))
145 ([tbreak] menu-item "Temporary Breakpoint" gud-tbreak
146 :enable (memq gud-minor-mode
147 '(gdbmi gdba gdb sdb xdb bashdb)))
148 ([break] menu-item "Set Breakpoint" gud-break
149 :enable (not gud-running)
150 :visible (not (and (memq gud-minor-mode '(gdbmi gdba))
151 (> (car (window-fringes)) 0))))
152 ([up] menu-item "Up Stack" gud-up
153 :enable (and (not gud-running)
155 '(gdbmi gdba gdb dbx xdb jdb pdb bashdb))))
156 ([down] menu-item "Down Stack" gud-down
157 :enable (and (not gud-running)
159 '(gdbmi gdba gdb dbx xdb jdb pdb bashdb))))
160 ([print*] menu-item "Print Dereference" gud-pstar
161 :enable (and (not gud-running)
162 (memq gud-minor-mode '(gdbmi gdba gdb))))
163 ([print] menu-item "Print Expression" gud-print
164 :enable (not gud-running))
165 ([watch] menu-item "Watch Expression" gud-watch
166 :enable (and (not gud-running)
167 (memq gud-minor-mode '(gdbmi gdba))))
168 ([finish] menu-item "Finish Function" gud-finish
169 :enable (and (not gud-running)
171 '(gdbmi gdba gdb xdb jdb pdb bashdb))))
172 ([stepi] menu-item "Step Instruction" gud-stepi
173 :enable (and (not gud-running)
174 (memq gud-minor-mode '(gdbmi gdba gdb dbx))))
175 ([nexti] menu-item "Next Instruction" gud-nexti
176 :enable (and (not gud-running)
177 (memq gud-minor-mode '(gdbmi gdba gdb dbx))))
178 ([step] menu-item "Step Line" gud-step
179 :enable (not gud-running))
180 ([next] menu-item "Next Line" gud-next
181 :enable (not gud-running))
182 ([cont] menu-item "Continue" gud-cont
183 :enable (not gud-running)))
184 "Menu for `gud-mode'."
187 (easy-mmode-defmap gud-minor-mode-map
188 `(([menu-bar debug] . ("Gud" . ,gud-menu-map)))
189 "Map used in visited files.")
191 (let ((m (assq 'gud-minor-mode minor-mode-map-alist)))
192 (if m (setcdr m gud-minor-mode-map)
193 (push (cons 'gud-minor-mode gud-minor-mode-map) minor-mode-map-alist)))
196 ;; Will inherit from comint-mode via define-derived-mode.
198 "`gud-mode' keymap.")
200 (defvar gud-tool-bar-map
201 (if (display-graphic-p)
202 (let ((map (make-sparse-keymap)))
203 (dolist (x '((gud-break . "gud/break")
204 (gud-remove . "gud/remove")
205 (gud-print . "gud/print")
206 (gud-pstar . "gud/pstar")
207 (gud-watch . "gud/watch")
208 (gud-cont . "gud/cont")
209 (gud-until . "gud/until")
210 (gud-finish . "gud/finish")
211 (gud-run . "gud/run")
212 ;; gud-s, gud-si etc. instead of gud-step,
213 ;; gud-stepi, to avoid file-name clashes on DOS
215 (gud-next . "gud/next")
216 (gud-step . "gud/step")
217 (gud-nexti . "gud/nexti")
218 (gud-stepi . "gud/stepi")
220 (gud-down . "gud/down")
221 (gud-goto-info . "info"))
223 (tool-bar-local-item-from-menu
224 (car x) (cdr x) map gud-minor-mode-map)))))
226 (defun gud-file-name (f)
227 "Transform a relative file name to an absolute file name.
228 Uses `gud-<MINOR-MODE>-directories' to find the source files."
229 (if (file-exists-p f) (expand-file-name f)
230 (let ((directories (gud-val 'directories))
233 (let ((path (expand-file-name f (car directories))))
234 (if (file-exists-p path)
237 (setq directories (cdr directories)))
240 (defun gud-find-file (file)
241 ;; Don't get confused by double slashes in the name that comes from GDB.
242 (while (string-match "//+" file)
243 (setq file (replace-match "/" t t file)))
244 (let ((minor-mode gud-minor-mode)
245 (buf (funcall (or gud-find-file 'gud-file-name) file)))
247 (setq buf (and (file-readable-p buf) (find-file-noselect buf 'nowarn))))
249 ;; Copy `gud-minor-mode' to the found buffer to turn on the menu.
250 (with-current-buffer buf
251 (set (make-local-variable 'gud-minor-mode) minor-mode)
252 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
253 (when (and gud-tooltip-mode
254 (memq gud-minor-mode '(gdbmi gdba)))
255 (make-local-variable 'gdb-define-alist)
256 (unless gdb-define-alist (gdb-create-define-alist))
257 (add-hook 'after-save-hook 'gdb-create-define-alist nil t))
258 (make-local-variable 'gud-keep-buffer))
261 ;; ======================================================================
262 ;; command definition
264 ;; This macro is used below to define some basic debugger interface commands.
265 ;; Of course you may use `gud-def' with any other debugger command, including
266 ;; user defined ones.
268 ;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
269 ;; which defines FUNC to send the command NAME to the debugger, gives
270 ;; it the docstring DOC, and binds that function to KEY in the GUD
271 ;; major mode. The function is also bound in the global keymap with the
274 (defmacro gud-def (func cmd key &optional doc)
275 "Define FUNC to be a command sending STR and bound to KEY, with
276 optional doc string DOC. Certain %-escapes in the string arguments
277 are interpreted specially if present. These are:
279 %f name (without directory) of current source file.
280 %F name (without directory or extension) of current source file.
281 %d directory of current source file.
282 %l number of current source line
283 %e text of the C lvalue or function-call expression surrounding point.
284 %a text of the hexadecimal address surrounding point
285 %p prefix argument to the command (if any) as a number
287 The `current' source file is the file of the current buffer (if
288 we're in a C file) or the source file current at the last break or
289 step (if we're in the GUD buffer).
290 The `current' line is that of the current buffer (if we're in a
291 source file) or the source line number at the last break or step (if
292 we're in the GUD buffer)."
295 ,@(if doc (list doc))
300 ,(if key `(local-set-key ,(concat "\C-c" key) ',func))
301 ,(if key `(global-set-key (vconcat gud-key-prefix ,key) ',func))))
303 ;; Where gud-display-frame should put the debugging arrow; a cons of
304 ;; (filename . line-number). This is set by the marker-filter, which scans
305 ;; the debugger's output for indications of the current program counter.
306 (defvar gud-last-frame nil)
308 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
309 ;; the last frame, even if it's been called before and gud-last-frame has
311 (defvar gud-last-last-frame nil)
313 ;; All debugger-specific information is collected here.
314 ;; Here's how it works, in case you ever need to add a debugger to the mode.
316 ;; Each entry must define the following at startup:
319 ;; comint-prompt-regexp
320 ;; gud-<name>-massage-args
321 ;; gud-<name>-marker-filter
322 ;; gud-<name>-find-file
324 ;; The job of the massage-args method is to modify the given list of
325 ;; debugger arguments before running the debugger.
327 ;; The job of the marker-filter method is to detect file/line markers in
328 ;; strings and set the global gud-last-frame to indicate what display
329 ;; action (if any) should be triggered by the marker. Note that only
330 ;; whatever the method *returns* is displayed in the buffer; thus, you
331 ;; can filter the debugger's output, interpreting some and passing on
334 ;; The job of the find-file method is to visit and return the buffer indicated
335 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
338 ;; ======================================================================
339 ;; speedbar support functions and variables.
340 (eval-when-compile (require 'speedbar)) ;For speedbar-with-attached-buffer.
342 (defvar gud-last-speedbar-stackframe nil
343 "Description of the currently displayed GUD stack.
344 t means that there is no stack, and we are in display-file mode.")
346 (defvar gud-speedbar-key-map nil
347 "Keymap used when in the buffers display mode.")
349 (defun gud-install-speedbar-variables ()
350 "Install those variables used by speedbar to enhance gud/gdb."
351 (if gud-speedbar-key-map
353 (setq gud-speedbar-key-map (speedbar-make-specialized-keymap))
355 (define-key gud-speedbar-key-map "j" 'speedbar-edit-line)
356 (define-key gud-speedbar-key-map "e" 'speedbar-edit-line)
357 (define-key gud-speedbar-key-map "\C-m" 'speedbar-edit-line)
358 (define-key gud-speedbar-key-map " " 'speedbar-toggle-line-expansion)
359 (define-key gud-speedbar-key-map "[" 'speedbar-expand-line-descendants)
360 (define-key gud-speedbar-key-map "]" 'speedbar-contract-line-descendants)
361 (define-key gud-speedbar-key-map "D" 'gdb-var-delete))
363 (speedbar-add-expansion-list '("GUD" gud-speedbar-menu-items
365 gud-expansion-speedbar-buttons)))
367 (defvar gud-speedbar-menu-items
368 '(["Jump to stack frame" speedbar-edit-line
369 :visible (with-current-buffer gud-comint-buffer
370 (not (memq gud-minor-mode '(gdbmi gdba))))]
371 ["Edit value" speedbar-edit-line
372 :visible (with-current-buffer gud-comint-buffer
373 (memq gud-minor-mode '(gdbmi gdba)))]
374 ["Delete expression" gdb-var-delete
375 (with-current-buffer gud-comint-buffer
376 (memq gud-minor-mode '(gdbmi gdba)))])
377 "Additional menu items to add to the speedbar frame.")
379 ;; Make sure our special speedbar mode is loaded
380 (if (featurep 'speedbar)
381 (gud-install-speedbar-variables)
382 (add-hook 'speedbar-load-hook 'gud-install-speedbar-variables))
384 (defun gud-expansion-speedbar-buttons (directory zero)
385 "Wrapper for call to speedbar-add-expansion-list. DIRECTORY and
386 ZERO are not used, but are required by the caller."
387 (gud-speedbar-buttons gud-comint-buffer))
389 (defun gud-speedbar-buttons (buffer)
390 "Create a speedbar display based on the current state of GUD.
391 If the GUD BUFFER is not running a supported debugger, then turn
392 off the specialized speedbar mode. BUFFER is not used, but are
393 required by the caller."
394 (when (and (boundp 'gud-comint-buffer)
396 ;; gud-comint-buffer might be killed
397 (buffer-name gud-comint-buffer))
398 (let* ((minor-mode (with-current-buffer buffer gud-minor-mode))
399 (window (get-buffer-window (current-buffer) 0))
400 (p (window-point window)))
402 ((memq minor-mode '(gdbmi gdba))
403 (when (or gdb-var-changed
405 (goto-char (point-min))
406 (let ((case-fold-search t))
407 (looking-at "Watch Expressions:")))))
409 (insert "Watch Expressions:\n")
410 (let ((var-list gdb-var-list))
412 (let* ((depth 0) (start 0) (char ?+)
413 (var (car var-list)) (varnum (nth 1 var)))
414 (while (string-match "\\." varnum start)
415 (setq depth (1+ depth)
416 start (1+ (match-beginning 0))))
417 (if (equal (nth 2 var) "0")
418 (speedbar-make-tag-line 'bracket ?? nil nil
419 (concat (car var) "\t" (nth 4 var))
423 gdb-show-changed-values)
424 'font-lock-warning-face
426 (if (and (cadr var-list)
427 (string-match varnum (cadr (cadr var-list))))
429 (speedbar-make-tag-line 'bracket char
430 'gdb-speedbar-expand-node varnum
431 (concat (car var) "\t" (nth 3 var))
433 (setq var-list (cdr var-list))))
434 (setq gdb-var-changed nil)))
435 (t (if (and (save-excursion
436 (goto-char (point-min))
437 (looking-at "Current Stack:"))
438 (equal gud-last-last-frame gud-last-speedbar-stackframe))
440 (let ((gud-frame-list
441 (cond ((eq minor-mode 'gdb)
442 (gud-gdb-get-stackframe buffer))
443 ;; Add more debuggers here!
444 (t (speedbar-remove-localized-speedbar-support buffer)
447 (if (not gud-frame-list)
448 (insert "No Stack frames\n")
449 (insert "Current Stack:\n"))
450 (dolist (frame gud-frame-list)
451 (insert (nth 1 frame) ":\n")
452 (if (= (length frame) 2)
454 (speedbar-insert-button (car frame)
455 'speedbar-directory-face
457 (speedbar-insert-button
460 'speedbar-highlight-face
461 (cond ((memq minor-mode '(gdbmi gdba gdb))
462 'gud-gdb-goto-stackframe)
463 (t (error "Should never be here")))
465 (setq gud-last-speedbar-stackframe gud-last-last-frame))))
466 (set-window-point window p))))
469 ;; ======================================================================
472 ;; History of argument lists passed to gdb.
473 (defvar gud-gdb-history nil)
475 (defcustom gud-gdb-command-name "gdb --annotate=3"
476 "Default command to execute an executable under the GDB debugger."
480 (defvar gud-gdb-marker-regexp
481 ;; This used to use path-separator instead of ":";
482 ;; however, we found that on both Windows 32 and MSDOS
483 ;; a colon is correct here.
484 (concat "\032\032\\(.:?[^" ":" "\n]*\\)" ":"
485 "\\([0-9]*\\)" ":" ".*\n"))
487 ;; There's no guarantee that Emacs will hand the filter the entire
488 ;; marker at once; it could be broken up across several strings. We
489 ;; might even receive a big chunk with several markers in it. If we
490 ;; receive a chunk of text which looks like it might contain the
491 ;; beginning of a marker, we save it here between calls to the
493 (defvar gud-marker-acc "")
494 (make-variable-buffer-local 'gud-marker-acc)
496 (defun gud-gdb-marker-filter (string)
497 (setq gud-marker-acc (concat gud-marker-acc string))
500 ;; Process all the complete markers in this chunk.
501 (while (string-match gud-gdb-marker-regexp gud-marker-acc)
504 ;; Extract the frame position from the marker.
505 gud-last-frame (cons (match-string 1 gud-marker-acc)
506 (string-to-number (match-string 2 gud-marker-acc)))
508 ;; Append any text before the marker to the output we're going
509 ;; to return - we don't include the marker in this text.
510 output (concat output
511 (substring gud-marker-acc 0 (match-beginning 0)))
513 ;; Set the accumulator to the remaining text.
514 gud-marker-acc (substring gud-marker-acc (match-end 0))))
516 ;; Check for annotations and change gud-minor-mode to 'gdba if
518 (while (string-match "\n\032\032\\(.*\\)\n" gud-marker-acc)
519 (let ((match (match-string 1 gud-marker-acc)))
520 (when (string-equal match "prompt")
525 ;; Append any text before the marker to the output we're going
526 ;; to return - we don't include the marker in this text.
527 output (concat output
528 (substring gud-marker-acc 0 (match-beginning 0)))
530 ;; Set the accumulator to the remaining text.
532 gud-marker-acc (substring gud-marker-acc (match-end 0)))
533 (if (string-equal match "error-begin")
534 (put-text-property 0 (length gud-marker-acc)
535 'face font-lock-warning-face
538 ;; Does the remaining text look like it might end with the
539 ;; beginning of another marker? If it does, then keep it in
540 ;; gud-marker-acc until we receive the rest of it. Since we
541 ;; know the full marker regexp above failed, it's pretty simple to
542 ;; test for marker starts.
543 (if (string-match "\n\\(\032.*\\)?\\'" gud-marker-acc)
545 ;; Everything before the potential marker start can be output.
546 (setq output (concat output (substring gud-marker-acc
547 0 (match-beginning 0))))
549 ;; Everything after, we save, to combine with later input.
551 (substring gud-marker-acc (match-beginning 0))))
553 (setq output (concat output gud-marker-acc)
558 (easy-mmode-defmap gud-minibuffer-local-map
559 '(("\C-i" . comint-dynamic-complete-filename))
560 "Keymap for minibuffer prompting of gud startup command."
561 :inherit minibuffer-local-map)
563 (defun gud-query-cmdline (minor-mode &optional init)
564 (let* ((hist-sym (gud-symbol 'history nil minor-mode))
565 (cmd-name (gud-val 'command-name minor-mode)))
566 (unless (boundp hist-sym) (set hist-sym nil))
567 (read-from-minibuffer
568 (format "Run %s (like this): " minor-mode)
569 (or (car-safe (symbol-value hist-sym))
570 (concat (or cmd-name (symbol-name minor-mode))
574 (dolist (f (directory-files default-directory) file)
575 (if (and (file-executable-p f)
576 (not (file-directory-p f))
578 (file-newer-than-file-p f file)))
580 gud-minibuffer-local-map nil
583 (defvar gdb-first-prompt t)
585 (defvar gud-filter-pending-text nil
586 "Non-nil means this is text that has been saved for later in `gud-filter'.")
589 (defun gdb (command-line)
590 "Run gdb on program FILE in buffer *gud-FILE*.
591 The directory containing FILE becomes the initial working directory
592 and source-file directory for your debugger."
593 (interactive (list (gud-query-cmdline 'gdb)))
595 (gud-common-init command-line nil 'gud-gdb-marker-filter)
596 (set (make-local-variable 'gud-minor-mode) 'gdb)
598 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
599 (gud-def gud-tbreak "tbreak %f:%l" "\C-t" "Set temporary breakpoint at current line.")
600 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
601 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
602 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
603 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
604 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
605 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
606 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
608 (progn (gud-call "tbreak %f:%l") (gud-call "jump %f:%l"))
609 "\C-j" "Set execution address to current line.")
611 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
612 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
613 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
614 (gud-def gud-pstar "print* %e" nil
615 "Evaluate C dereferenced pointer expression at point.")
616 (gud-def gud-until "until %l" "\C-u" "Continue to current line.")
617 (gud-def gud-run "run" nil "Run the program.")
619 (local-set-key "\C-i" 'gud-gdb-complete-command)
620 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
621 (setq paragraph-start comint-prompt-regexp)
622 (setq gdb-first-prompt t)
623 (setq gud-filter-pending-text nil)
624 (run-hooks 'gdb-mode-hook))
626 ;; One of the nice features of GDB is its impressive support for
627 ;; context-sensitive command completion. We preserve that feature
628 ;; in the GUD buffer by using a GDB command designed just for Emacs.
630 ;; The completion process filter indicates when it is finished.
631 (defvar gud-gdb-fetch-lines-in-progress)
633 ;; Since output may arrive in fragments we accumulate partials strings here.
634 (defvar gud-gdb-fetch-lines-string)
636 ;; We need to know how much of the completion to chop off.
637 (defvar gud-gdb-fetch-lines-break)
639 ;; The completion list is constructed by the process filter.
640 (defvar gud-gdb-fetched-lines)
642 (defvar gud-comint-buffer nil)
644 (defun gud-gdb-complete-command ()
645 "Perform completion on the GDB command preceding point.
646 This is implemented using the GDB `complete' command which isn't
647 available with older versions of GDB."
650 (command (buffer-substring (comint-line-beginning-position) end))
652 ;; Find the word break. This match will always succeed.
653 (and (string-match "\\(\\`\\| \\)\\([^ ]*\\)\\'" command)
654 (substring command (match-beginning 2))))
656 (gud-gdb-run-command-fetch-lines (concat "complete " command)
658 ;; From string-match above.
659 (match-beginning 2))))
660 ;; Protect against old versions of GDB.
662 (string-match "^Undefined command: \"complete\"" (car complete-list))
663 (error "This version of GDB doesn't support the `complete' command"))
664 ;; Sort the list like readline.
665 (setq complete-list (sort complete-list (function string-lessp)))
666 ;; Remove duplicates.
667 (let ((first complete-list)
668 (second (cdr complete-list)))
670 (if (string-equal (car first) (car second))
671 (setcdr first (setq second (cdr second)))
673 second (cdr second)))))
674 ;; Add a trailing single quote if there is a unique completion
675 ;; and it contains an odd number of unquoted single quotes.
676 (and (= (length complete-list) 1)
677 (let ((str (car complete-list))
680 (while (string-match "\\([^'\\]\\|\\\\'\\)*'" str pos)
681 (setq count (1+ count)
683 (and (= (mod count 2) 1)
684 (setq complete-list (list (concat str "'"))))))
685 ;; Let comint handle the rest.
686 (comint-dynamic-simple-complete command-word complete-list)))
688 ;; The completion process filter is installed temporarily to slurp the
689 ;; output of GDB up to the next prompt and build the completion list.
690 (defun gud-gdb-fetch-lines-filter (string filter)
691 "Filter used to read the list of lines output by a command.
692 STRING is the output to filter.
693 It is passed through FILTER before we look at it."
694 (setq string (funcall filter string))
695 (setq string (concat gud-gdb-fetch-lines-string string))
696 (while (string-match "\n" string)
697 (push (substring string gud-gdb-fetch-lines-break (match-beginning 0))
698 gud-gdb-fetched-lines)
699 (setq string (substring string (match-end 0))))
700 (if (string-match comint-prompt-regexp string)
702 (setq gud-gdb-fetch-lines-in-progress nil)
705 (setq gud-gdb-fetch-lines-string string)
708 ;; gdb speedbar functions
710 (defun gud-gdb-goto-stackframe (text token indent)
711 "Goto the stackframe described by TEXT, TOKEN, and INDENT."
712 (speedbar-with-attached-buffer
713 (gud-basic-call (concat "server frame " (nth 1 token)))
716 (defvar gud-gdb-fetched-stack-frame nil
717 "Stack frames we are fetching from GDB.")
719 ;(defun gud-gdb-get-scope-data (text token indent)
720 ; ;; checkdoc-params: (indent)
721 ; "Fetch data associated with a stack frame, and expand/contract it.
722 ;Data to do this is retrieved from TEXT and TOKEN."
723 ; (let ((args nil) (scope nil))
724 ; (gud-gdb-run-command-fetch-lines "info args")
726 ; (gud-gdb-run-command-fetch-lines "info local")
730 (defun gud-gdb-get-stackframe (buffer)
731 "Extract the current stack frame out of the GUD GDB BUFFER."
733 (fetched-stack-frame-list
734 (gud-gdb-run-command-fetch-lines "server backtrace" buffer)))
735 (if (and (car fetched-stack-frame-list)
736 (string-match "No stack" (car fetched-stack-frame-list)))
737 ;; Go into some other mode???
739 (dolist (e fetched-stack-frame-list)
740 (let ((name nil) (num nil))
742 (string-match "^#\\([0-9]+\\) +[0-9a-fx]+ in \\([:0-9a-zA-Z_]+\\) (" e)
743 (string-match "^#\\([0-9]+\\) +\\([:0-9a-zA-Z_]+\\) (" e)))
744 (if (not (string-match
745 "at \\([-0-9a-zA-Z_.]+\\):\\([0-9]+\\)$" e))
748 (list (nth 0 (car newlst))
751 (match-string 2 e))))
752 (setq num (match-string 1 e)
753 name (match-string 2 e))
757 "at \\([-0-9a-zA-Z_.]+\\):\\([0-9]+\\)$" e)
758 (list name num (match-string 1 e)
764 ;(defun gud-gdb-selected-frame-info (buffer)
765 ; "Learn GDB information for the currently selected stack frame in BUFFER."
768 (defun gud-gdb-run-command-fetch-lines (command buffer &optional skip)
769 "Run COMMAND, and return the list of lines it outputs.
770 BUFFER is the GUD buffer in which to run the command.
771 SKIP is the number of chars to skip on each lines, it defaults to 0."
772 (with-current-buffer buffer
774 (goto-char (point-max))
776 (not (looking-at comint-prompt-regexp)))
778 ;; Much of this copied from GDB complete, but I'm grabbing the stack
780 (let ((gud-gdb-fetch-lines-in-progress t)
781 (gud-gdb-fetched-lines nil)
782 (gud-gdb-fetch-lines-string nil)
783 (gud-gdb-fetch-lines-break (or skip 0))
785 `(lambda (string) (gud-gdb-fetch-lines-filter string ',gud-marker-filter))))
786 ;; Issue the command to GDB.
787 (gud-basic-call command)
789 (while gud-gdb-fetch-lines-in-progress
790 (accept-process-output (get-buffer-process buffer)))
791 (nreverse gud-gdb-fetched-lines)))))
794 ;; ======================================================================
797 ;; History of argument lists passed to sdb.
798 (defvar gud-sdb-history nil)
800 (defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
801 "If nil, we're on a System V Release 4 and don't need the tags hack.")
803 (defvar gud-sdb-lastfile nil)
805 (defun gud-sdb-marker-filter (string)
807 (if gud-marker-acc (concat gud-marker-acc string) string))
809 ;; Process all complete markers in this chunk
812 ;; System V Release 3.2 uses this format
813 ((string-match "\\(^\\|\n\\)\\*?\\(0x\\w* in \\)?\\([^:\n]*\\):\\([0-9]*\\):.*\n"
814 gud-marker-acc start)
816 (cons (match-string 3 gud-marker-acc)
817 (string-to-number (match-string 4 gud-marker-acc)))))
818 ;; System V Release 4.0 quite often clumps two lines together
819 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
820 gud-marker-acc start)
821 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc))
823 (cons gud-sdb-lastfile
824 (string-to-number (match-string 3 gud-marker-acc)))))
825 ;; System V Release 4.0
826 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n"
827 gud-marker-acc start)
828 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc)))
829 ((and gud-sdb-lastfile (string-match "^\\([0-9]+\\):"
830 gud-marker-acc start))
832 (cons gud-sdb-lastfile
833 (string-to-number (match-string 1 gud-marker-acc)))))
835 (setq gud-sdb-lastfile nil)))
836 (setq start (match-end 0)))
838 ;; Search for the last incomplete line in this chunk
839 (while (string-match "\n" gud-marker-acc start)
840 (setq start (match-end 0)))
842 ;; If we have an incomplete line, store it in gud-marker-acc.
843 (setq gud-marker-acc (substring gud-marker-acc (or start 0))))
846 (defun gud-sdb-find-file (f)
847 (if gud-sdb-needs-tags (find-tag-noselect f) (find-file-noselect f)))
850 (defun sdb (command-line)
851 "Run sdb on program FILE in buffer *gud-FILE*.
852 The directory containing FILE becomes the initial working directory
853 and source-file directory for your debugger."
854 (interactive (list (gud-query-cmdline 'sdb)))
856 (if gud-sdb-needs-tags (require 'etags))
857 (if (and gud-sdb-needs-tags
858 (not (and (boundp 'tags-file-name)
859 (stringp tags-file-name)
860 (file-exists-p tags-file-name))))
861 (error "The sdb support requires a valid tags table to work"))
863 (gud-common-init command-line nil 'gud-sdb-marker-filter 'gud-sdb-find-file)
864 (set (make-local-variable 'gud-minor-mode) 'sdb)
866 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
867 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
868 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
869 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
870 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
871 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
872 (gud-def gud-cont "c" "\C-r" "Continue with display.")
873 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
875 (setq comint-prompt-regexp "\\(^\\|\n\\)\\*")
876 (setq paragraph-start comint-prompt-regexp)
877 (run-hooks 'sdb-mode-hook)
880 ;; ======================================================================
883 ;; History of argument lists passed to dbx.
884 (defvar gud-dbx-history nil)
886 (defcustom gud-dbx-directories nil
887 "*A list of directories that dbx should search for source code.
888 If nil, only source files in the program directory
889 will be known to dbx.
891 The file names should be absolute, or relative to the directory
892 containing the executable being debugged."
893 :type '(choice (const :tag "Current Directory" nil)
898 (defun gud-dbx-massage-args (file args)
899 (nconc (let ((directories gud-dbx-directories)
902 (setq result (cons (car directories) (cons "-I" result)))
903 (setq directories (cdr directories)))
907 (defun gud-dbx-marker-filter (string)
908 (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
911 ;; Process all complete markers in this chunk.
912 (while (or (string-match
913 "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
914 gud-marker-acc start)
916 "signal .* in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
917 gud-marker-acc start))
919 (cons (match-string 2 gud-marker-acc)
920 (string-to-number (match-string 1 gud-marker-acc)))
921 start (match-end 0)))
923 ;; Search for the last incomplete line in this chunk
924 (while (string-match "\n" gud-marker-acc start)
925 (setq start (match-end 0)))
927 ;; If the incomplete line APPEARS to begin with another marker, keep it
928 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
929 ;; unnecessary concat during the next call.
931 (if (string-match "\\(stopped\\|signal\\)" gud-marker-acc start)
932 (substring gud-marker-acc (match-beginning 0))
936 ;; Functions for Mips-style dbx. Given the option `-emacs', documented in
937 ;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
939 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
940 ;; We haven't tested gud on this system:
941 (string-match "^mips-[^-]*-riscos" system-configuration)
942 ;; It's documented on OSF/1.3
943 (string-match "^mips-[^-]*-osf1" system-configuration)
944 (string-match "^alpha[^-]*-[^-]*-osf" system-configuration))
945 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
947 (defvar gud-dbx-command-name
948 (concat "dbx" (if gud-mips-p " -emacs")))
950 ;; This is just like the gdb one except for the regexps since we need to cope
951 ;; with an optional breakpoint number in [] before the ^Z^Z
952 (defun gud-mipsdbx-marker-filter (string)
953 (setq gud-marker-acc (concat gud-marker-acc string))
956 ;; Process all the complete markers in this chunk.
958 ;; This is like th gdb marker but with an optional
959 ;; leading break point number like `[1] '
960 "[][ 0-9]*\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
964 ;; Extract the frame position from the marker.
966 (cons (match-string 1 gud-marker-acc)
967 (string-to-number (match-string 2 gud-marker-acc)))
969 ;; Append any text before the marker to the output we're going
970 ;; to return - we don't include the marker in this text.
971 output (concat output
972 (substring gud-marker-acc 0 (match-beginning 0)))
974 ;; Set the accumulator to the remaining text.
975 gud-marker-acc (substring gud-marker-acc (match-end 0))))
977 ;; Does the remaining text look like it might end with the
978 ;; beginning of another marker? If it does, then keep it in
979 ;; gud-marker-acc until we receive the rest of it. Since we
980 ;; know the full marker regexp above failed, it's pretty simple to
981 ;; test for marker starts.
982 (if (string-match "[][ 0-9]*\032.*\\'" gud-marker-acc)
984 ;; Everything before the potential marker start can be output.
985 (setq output (concat output (substring gud-marker-acc
986 0 (match-beginning 0))))
988 ;; Everything after, we save, to combine with later input.
990 (substring gud-marker-acc (match-beginning 0))))
992 (setq output (concat output gud-marker-acc)
997 ;; The dbx in IRIX is a pain. It doesn't print the file name when
998 ;; stopping at a breakpoint (but you do get it from the `up' and
999 ;; `down' commands...). The only way to extract the information seems
1000 ;; to be with a `file' command, although the current line number is
1001 ;; available in $curline. Thus we have to look for output which
1002 ;; appears to indicate a breakpoint. Then we prod the dbx sub-process
1003 ;; to output the information we want with a combination of the
1004 ;; `printf' and `file' commands as a pseudo marker which we can
1005 ;; recognise next time through the marker-filter. This would be like
1006 ;; the gdb marker but you can't get the file name without a newline...
1007 ;; Note that gud-remove won't work since Irix dbx expects a breakpoint
1008 ;; number rather than a line number etc. Maybe this could be made to
1009 ;; work by listing all the breakpoints and picking the one(s) with the
1010 ;; correct line number, but life's too short.
1011 ;; d.love@dl.ac.uk (Dave Love) can be blamed for this
1014 (and (string-match "^mips-[^-]*-irix" system-configuration)
1015 (not (string-match "irix[6-9]\\.[1-9]" system-configuration)))
1016 "Non-nil to assume the interface appropriate for IRIX dbx.
1017 This works in IRIX 4, 5 and 6, but `gud-dbx-use-stopformat-p' provides
1018 a better solution in 6.1 upwards.")
1019 (defvar gud-dbx-use-stopformat-p
1020 (string-match "irix[6-9]\\.[1-9]" system-configuration)
1021 "Non-nil to use the dbx feature present at least from Irix 6.1
1022 whereby $stopformat=1 produces an output format compatiable with
1023 `gud-dbx-marker-filter'.")
1024 ;; [Irix dbx seems to be a moving target. The dbx output changed
1025 ;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
1026 ;; the output from `up' is no longer spotted by gud (and it's probably
1027 ;; not distinctive enough to try to match it -- use C-<, C->
1028 ;; exclusively) . For 5.3 and 6.0, the $curline variable changed to
1029 ;; `long long'(why?!), so the printf stuff needed changing. The line
1030 ;; number was cast to `long' as a compromise between the new `long
1031 ;; long' and the original `int'. This is reported not to work in 6.2,
1032 ;; so it's changed back to int -- don't make your sources too long.
1033 ;; From Irix6.1 (but not 6.0?) dbx supports an undocumented feature
1034 ;; whereby `set $stopformat=1' reportedly produces output compatible
1035 ;; with `gud-dbx-marker-filter', which we prefer.
1037 ;; The process filter is also somewhat
1038 ;; unreliable, sometimes not spotting the markers; I don't know
1039 ;; whether there's anything that can be done about that. It would be
1040 ;; much better if SGI could be persuaded to (re?)instate the MIPS
1041 ;; -emacs flag for gdb-like output (which ought to be possible as most
1042 ;; of the communication I've had over it has been from sgi.com).]
1044 ;; this filter is influenced by the xdb one rather than the gdb one
1045 (defun gud-irixdbx-marker-filter (string)
1046 (let (result (case-fold-search nil))
1047 (if (or (string-match comint-prompt-regexp string)
1048 (string-match ".*\012" string))
1049 (setq result (concat gud-marker-acc string)
1051 (setq gud-marker-acc (concat gud-marker-acc string)))
1054 ;; look for breakpoint or signal indication e.g.:
1055 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
1056 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
1057 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
1059 "^\\(\\[[0-9]+] \\)?Process +[0-9]+ ([^)]*) [^[]+\\[[^]\n]*]\n"
1061 ;; prod dbx into printing out the line number and file
1062 ;; name in a form we can grok as below
1063 (process-send-string (get-buffer-process gud-comint-buffer)
1064 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1065 ;; look for result of, say, "up" e.g.:
1066 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
1067 ;; (this will also catch one of the lines printed by "where")
1069 "^[^ ][^[]*\\[\"\\([^\"]+\\)\":\\([0-9]+\\), [^]]+]\n"
1071 (let ((file (match-string 1 result)))
1072 (if (file-exists-p file)
1073 (setq gud-last-frame
1074 (cons (match-string 1 result)
1075 (string-to-number (match-string 2 result))))))
1077 ((string-match ; kluged-up marker as above
1078 "\032\032\\([0-9]*\\):\\(.*\\)\n" result)
1079 (let ((file (gud-file-name (match-string 2 result))))
1080 (if (and file (file-exists-p file))
1081 (setq gud-last-frame
1083 (string-to-number (match-string 1 result))))))
1084 (setq result (substring result 0 (match-beginning 0))))))
1087 (defvar gud-dgux-p (string-match "-dgux" system-configuration)
1088 "Non-nil means to assume the interface approriate for DG/UX dbx.
1089 This was tested using R4.11.")
1091 ;; There are a couple of differences between DG's dbx output and normal
1092 ;; dbx output which make it nontrivial to integrate this into the
1093 ;; standard dbx-marker-filter (mainly, there are a different number of
1094 ;; backreferences). The markers look like:
1096 ;; (0) Stopped at line 10, routine main(argc=1, argv=0xeffff0e0), file t.c
1098 ;; from breakpoints (the `(0)' there isn't constant, it's the breakpoint
1101 ;; Stopped at line 13, routine main(argc=1, argv=0xeffff0e0), file t.c
1105 ;; Frame 21, line 974, routine command_loop(), file keyboard.c
1107 ;; from up/down/where.
1109 (defun gud-dguxdbx-marker-filter (string)
1110 (setq gud-marker-acc (if gud-marker-acc
1111 (concat gud-marker-acc string)
1113 (let ((re (concat "^\\(\\(([0-9]+) \\)?Stopped at\\|Frame [0-9]+,\\)"
1114 " line \\([0-9]+\\), routine .*, file \\([^ \t\n]+\\)"))
1116 ;; Process all complete markers in this chunk.
1117 (while (string-match re gud-marker-acc start)
1118 (setq gud-last-frame
1119 (cons (match-string 4 gud-marker-acc)
1120 (string-to-number (match-string 3 gud-marker-acc)))
1121 start (match-end 0)))
1123 ;; Search for the last incomplete line in this chunk
1124 (while (string-match "\n" gud-marker-acc start)
1125 (setq start (match-end 0)))
1127 ;; If the incomplete line APPEARS to begin with another marker, keep it
1128 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1129 ;; unnecessary concat during the next call.
1130 (setq gud-marker-acc
1131 (if (string-match "Stopped\\|Frame" gud-marker-acc start)
1132 (substring gud-marker-acc (match-beginning 0))
1137 (defun dbx (command-line)
1138 "Run dbx on program FILE in buffer *gud-FILE*.
1139 The directory containing FILE becomes the initial working directory
1140 and source-file directory for your debugger."
1141 (interactive (list (gud-query-cmdline 'dbx)))
1145 (gud-common-init command-line nil 'gud-mipsdbx-marker-filter))
1147 (gud-common-init command-line 'gud-dbx-massage-args
1148 'gud-irixdbx-marker-filter))
1150 (gud-common-init command-line 'gud-dbx-massage-args
1151 'gud-dguxdbx-marker-filter))
1153 (gud-common-init command-line 'gud-dbx-massage-args
1154 'gud-dbx-marker-filter)))
1156 (set (make-local-variable 'gud-minor-mode) 'dbx)
1160 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1161 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1162 (gud-def gud-break "stop at \"%f\":%l"
1163 "\C-b" "Set breakpoint at current line.")
1164 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
1166 (gud-def gud-break "stop at \"%d%f\":%l"
1167 "\C-b" "Set breakpoint at current line.")
1168 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1169 (gud-def gud-up "up %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1170 "<" "Up (numeric arg) stack frames.")
1171 (gud-def gud-down "down %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1172 ">" "Down (numeric arg) stack frames.")
1173 ;; Make dbx give out the source location info that we need.
1174 (process-send-string (get-buffer-process gud-comint-buffer)
1175 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1177 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1178 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1179 (gud-def gud-break "file \"%d%f\"\nstop at %l"
1180 "\C-b" "Set breakpoint at current line.")
1181 (if gud-dbx-use-stopformat-p
1182 (process-send-string (get-buffer-process gud-comint-buffer)
1183 "set $stopformat=1\n"))))
1185 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
1186 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
1187 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
1188 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
1189 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
1190 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
1191 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
1192 (gud-def gud-run "run" nil "Run the program.")
1194 (setq comint-prompt-regexp "^[^)\n]*dbx) *")
1195 (setq paragraph-start comint-prompt-regexp)
1196 (run-hooks 'dbx-mode-hook)
1199 ;; ======================================================================
1200 ;; xdb (HP PARISC debugger) functions
1202 ;; History of argument lists passed to xdb.
1203 (defvar gud-xdb-history nil)
1205 (defcustom gud-xdb-directories nil
1206 "*A list of directories that xdb should search for source code.
1207 If nil, only source files in the program directory
1208 will be known to xdb.
1210 The file names should be absolute, or relative to the directory
1211 containing the executable being debugged."
1212 :type '(choice (const :tag "Current Directory" nil)
1217 (defun gud-xdb-massage-args (file args)
1218 (nconc (let ((directories gud-xdb-directories)
1221 (setq result (cons (car directories) (cons "-d" result)))
1222 (setq directories (cdr directories)))
1226 ;; xdb does not print the lines all at once, so we have to accumulate them
1227 (defun gud-xdb-marker-filter (string)
1229 (if (or (string-match comint-prompt-regexp string)
1230 (string-match ".*\012" string))
1231 (setq result (concat gud-marker-acc string)
1233 (setq gud-marker-acc (concat gud-marker-acc string)))
1235 (if (or (string-match "\\([^\n \t:]+\\): [^:]+: \\([0-9]+\\)[: ]"
1237 (string-match "[^: \t]+:[ \t]+\\([^:]+\\): [^:]+: \\([0-9]+\\):"
1239 (let ((line (string-to-number (match-string 2 result)))
1240 (file (gud-file-name (match-string 1 result))))
1242 (setq gud-last-frame (cons file line))))))
1246 (defun xdb (command-line)
1247 "Run xdb on program FILE in buffer *gud-FILE*.
1248 The directory containing FILE becomes the initial working directory
1249 and source-file directory for your debugger.
1251 You can set the variable `gud-xdb-directories' to a list of program source
1252 directories if your program contains sources from more than one directory."
1253 (interactive (list (gud-query-cmdline 'xdb)))
1255 (gud-common-init command-line 'gud-xdb-massage-args
1256 'gud-xdb-marker-filter)
1257 (set (make-local-variable 'gud-minor-mode) 'xdb)
1259 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
1260 (gud-def gud-tbreak "b %f:%l\\t" "\C-t"
1261 "Set temporary breakpoint at current line.")
1262 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
1263 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
1264 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1265 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1266 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1267 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1268 (gud-def gud-finish "bu\\t" "\C-f" "Finish executing current function.")
1269 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
1271 (setq comint-prompt-regexp "^>")
1272 (setq paragraph-start comint-prompt-regexp)
1273 (run-hooks 'xdb-mode-hook))
1275 ;; ======================================================================
1278 ;; History of argument lists passed to perldb.
1279 (defvar gud-perldb-history nil)
1281 (defun gud-perldb-massage-args (file args)
1282 "Convert a command line as would be typed normally to run perldb
1283 into one that invokes an Emacs-enabled debugging session.
1284 \"-emacs\" is inserted where it will be $ARGV[0] (see perl5db.pl)."
1285 ;; FIXME: what if the command is `make perldb' and doesn't accept those extra
1287 (let* ((new-args nil)
1289 (shift (lambda () (push (pop args) new-args))))
1291 ;; Pass all switches and -e scripts through.
1293 (string-match "^-" (car args))
1294 (not (equal "-" (car args)))
1295 (not (equal "--" (car args))))
1296 (when (equal "-e" (car args))
1297 ;; -e goes with the next arg, so shift one extra.
1299 ;; -e as the last arg is an error in Perl.
1300 (error "No code specified for -e"))
1306 (string-match "^-" (car args)))
1307 (error "Can't use stdin as the script to debug"))
1308 ;; This is the program name.
1311 ;; If -e specified, make sure there is a -- so -emacs is not taken
1313 (if (and args (equal "--" (car args)))
1315 (and seen-e (push "--" new-args)))
1317 (push "-emacs" new-args)
1321 (nreverse new-args)))
1323 ;; There's no guarantee that Emacs will hand the filter the entire
1324 ;; marker at once; it could be broken up across several strings. We
1325 ;; might even receive a big chunk with several markers in it. If we
1326 ;; receive a chunk of text which looks like it might contain the
1327 ;; beginning of a marker, we save it here between calls to the
1329 (defun gud-perldb-marker-filter (string)
1330 (setq gud-marker-acc (concat gud-marker-acc string))
1333 ;; Process all the complete markers in this chunk.
1334 (while (string-match "\032\032\\(\\([a-zA-Z]:\\)?[^:\n]*\\):\\([0-9]*\\):.*\n"
1338 ;; Extract the frame position from the marker.
1340 (cons (match-string 1 gud-marker-acc)
1341 (string-to-number (match-string 3 gud-marker-acc)))
1343 ;; Append any text before the marker to the output we're going
1344 ;; to return - we don't include the marker in this text.
1345 output (concat output
1346 (substring gud-marker-acc 0 (match-beginning 0)))
1348 ;; Set the accumulator to the remaining text.
1349 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1351 ;; Does the remaining text look like it might end with the
1352 ;; beginning of another marker? If it does, then keep it in
1353 ;; gud-marker-acc until we receive the rest of it. Since we
1354 ;; know the full marker regexp above failed, it's pretty simple to
1355 ;; test for marker starts.
1356 (if (string-match "\032.*\\'" gud-marker-acc)
1358 ;; Everything before the potential marker start can be output.
1359 (setq output (concat output (substring gud-marker-acc
1360 0 (match-beginning 0))))
1362 ;; Everything after, we save, to combine with later input.
1363 (setq gud-marker-acc
1364 (substring gud-marker-acc (match-beginning 0))))
1366 (setq output (concat output gud-marker-acc)
1371 (defcustom gud-perldb-command-name "perl -d"
1372 "Default command to execute a Perl script under debugger."
1377 (defun perldb (command-line)
1378 "Run perldb on program FILE in buffer *gud-FILE*.
1379 The directory containing FILE becomes the initial working directory
1380 and source-file directory for your debugger."
1382 (list (gud-query-cmdline 'perldb
1383 (concat (or (buffer-file-name) "-e 0") " "))))
1385 (gud-common-init command-line 'gud-perldb-massage-args
1386 'gud-perldb-marker-filter)
1387 (set (make-local-variable 'gud-minor-mode) 'perldb)
1389 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
1390 (gud-def gud-remove "B %l" "\C-d" "Remove breakpoint at current line")
1391 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
1392 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
1393 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1394 ; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
1395 ; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
1396 ; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
1397 (gud-def gud-print "p %e" "\C-p" "Evaluate perl expression at point.")
1398 (gud-def gud-until "c %l" "\C-u" "Continue to current line.")
1401 (setq comint-prompt-regexp "^ DB<+[0-9]+>+ ")
1402 (setq paragraph-start comint-prompt-regexp)
1403 (run-hooks 'perldb-mode-hook))
1405 ;; ======================================================================
1406 ;; pdb (Python debugger) functions
1408 ;; History of argument lists passed to pdb.
1409 (defvar gud-pdb-history nil)
1411 ;; Last group is for return value, e.g. "> test.py(2)foo()->None"
1412 ;; Either file or function name may be omitted: "> <string>(0)?()"
1413 (defvar gud-pdb-marker-regexp
1414 "^> \\([-a-zA-Z0-9_/.:\\]*\\|<string>\\)(\\([0-9]+\\))\\([a-zA-Z0-9_]*\\|\\?\\)()\\(->[^\n]*\\)?\n")
1415 (defvar gud-pdb-marker-regexp-file-group 1)
1416 (defvar gud-pdb-marker-regexp-line-group 2)
1417 (defvar gud-pdb-marker-regexp-fnname-group 3)
1419 (defvar gud-pdb-marker-regexp-start "^> ")
1421 ;; There's no guarantee that Emacs will hand the filter the entire
1422 ;; marker at once; it could be broken up across several strings. We
1423 ;; might even receive a big chunk with several markers in it. If we
1424 ;; receive a chunk of text which looks like it might contain the
1425 ;; beginning of a marker, we save it here between calls to the
1427 (defun gud-pdb-marker-filter (string)
1428 (setq gud-marker-acc (concat gud-marker-acc string))
1431 ;; Process all the complete markers in this chunk.
1432 (while (string-match gud-pdb-marker-regexp gud-marker-acc)
1435 ;; Extract the frame position from the marker.
1437 (let ((file (match-string gud-pdb-marker-regexp-file-group
1439 (line (string-to-number
1440 (match-string gud-pdb-marker-regexp-line-group
1442 (if (string-equal file "<string>")
1446 ;; Output everything instead of the below
1447 output (concat output (substring gud-marker-acc 0 (match-end 0)))
1448 ;; ;; Append any text before the marker to the output we're going
1449 ;; ;; to return - we don't include the marker in this text.
1450 ;; output (concat output
1451 ;; (substring gud-marker-acc 0 (match-beginning 0)))
1453 ;; Set the accumulator to the remaining text.
1454 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1456 ;; Does the remaining text look like it might end with the
1457 ;; beginning of another marker? If it does, then keep it in
1458 ;; gud-marker-acc until we receive the rest of it. Since we
1459 ;; know the full marker regexp above failed, it's pretty simple to
1460 ;; test for marker starts.
1461 (if (string-match gud-pdb-marker-regexp-start gud-marker-acc)
1463 ;; Everything before the potential marker start can be output.
1464 (setq output (concat output (substring gud-marker-acc
1465 0 (match-beginning 0))))
1467 ;; Everything after, we save, to combine with later input.
1468 (setq gud-marker-acc
1469 (substring gud-marker-acc (match-beginning 0))))
1471 (setq output (concat output gud-marker-acc)
1476 (defcustom gud-pdb-command-name "pdb"
1477 "File name for executing the Python debugger.
1478 This should be an executable on your path, or an absolute file name."
1483 (defun pdb (command-line)
1484 "Run pdb on program FILE in buffer `*gud-FILE*'.
1485 The directory containing FILE becomes the initial working directory
1486 and source-file directory for your debugger."
1488 (list (gud-query-cmdline 'pdb)))
1490 (gud-common-init command-line nil 'gud-pdb-marker-filter)
1491 (set (make-local-variable 'gud-minor-mode) 'pdb)
1493 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
1494 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
1495 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
1496 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
1497 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
1498 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1499 (gud-def gud-up "up" "<" "Up one stack frame.")
1500 (gud-def gud-down "down" ">" "Down one stack frame.")
1501 (gud-def gud-print "p %e" "\C-p" "Evaluate Python expression at point.")
1503 (gud-def gud-statement "! %e" "\C-e" "Execute Python statement at point.")
1505 ;; (setq comint-prompt-regexp "^(.*pdb[+]?) *")
1506 (setq comint-prompt-regexp "^(Pdb) *")
1507 (setq paragraph-start comint-prompt-regexp)
1508 (run-hooks 'pdb-mode-hook))
1510 ;; ======================================================================
1514 ;; AUTHOR: Derek Davies <ddavies@world.std.com>
1515 ;; Zoltan Kemenczy <zoltan@ieee.org;zkemenczy@rim.net>
1517 ;; CREATED: Sun Feb 22 10:46:38 1998 Derek Davies.
1518 ;; UPDATED: Nov 11, 2001 Zoltan Kemenczy
1519 ;; Dec 10, 2002 Zoltan Kemenczy - added nested class support
1521 ;; INVOCATION NOTES:
1523 ;; You invoke jdb-mode with:
1527 ;; It responds with:
1529 ;; Run jdb (like this): jdb
1531 ;; type any jdb switches followed by the name of the class you'd like to debug.
1532 ;; Supply a fully qualfied classname (these do not have the ".class" extension)
1533 ;; for the name of the class to debug (e.g. "COM.the-kind.ddavies.CoolClass").
1534 ;; See the known problems section below for restrictions when specifying jdb
1535 ;; command line switches (search forward for '-classpath').
1537 ;; You should see something like the following:
1539 ;; Current directory is ~/src/java/hello/
1540 ;; Initializing jdb...
1541 ;; 0xed2f6628:class(hello)
1544 ;; To set an initial breakpoint try:
1546 ;; > stop in hello.main
1547 ;; Breakpoint set in hello.main
1550 ;; To execute the program type:
1555 ;; Breakpoint hit: running ...
1556 ;; hello.main (hello:12)
1558 ;; Type M-n to step over the current line and M-s to step into it. That,
1559 ;; along with the JDB 'help' command should get you started. The 'quit'
1560 ;; JDB command will get out out of the debugger. There is some truly
1561 ;; pathetic JDB documentation available at:
1563 ;; http://java.sun.com/products/jdk/1.1/debugging/
1565 ;; KNOWN PROBLEMS AND FIXME's:
1567 ;; Not sure what happens with inner classes ... haven't tried them.
1569 ;; Does not grok UNICODE id's. Only ASCII id's are supported.
1571 ;; You must not put whitespace between "-classpath" and the path to
1572 ;; search for java classes even though it is required when invoking jdb
1573 ;; from the command line. See gud-jdb-massage-args for details.
1574 ;; The same applies for "-sourcepath".
1576 ;; Note: The following applies only if `gud-jdb-use-classpath' is nil;
1577 ;; refer to the documentation of `gud-jdb-use-classpath' and
1578 ;; `gud-jdb-classpath',`gud-jdb-sourcepath' variables for information
1579 ;; on using the classpath for locating java source files.
1581 ;; If any of the source files in the directories listed in
1582 ;; gud-jdb-directories won't parse you'll have problems. Make sure
1583 ;; every file ending in ".java" in these directories parses without error.
1585 ;; All the .java files in the directories in gud-jdb-directories are
1586 ;; syntactically analyzed each time gud jdb is invoked. It would be
1587 ;; nice to keep as much information as possible between runs. It would
1588 ;; be really nice to analyze the files only as neccessary (when the
1589 ;; source needs to be displayed.) I'm not sure to what extent the former
1590 ;; can be accomplished and I'm not sure the latter can be done at all
1591 ;; since I don't know of any general way to tell which .class files are
1592 ;; defined by which .java file without analyzing all the .java files.
1593 ;; If anyone knows why JavaSoft didn't put the source file names in
1594 ;; debuggable .class files please clue me in so I find something else
1595 ;; to be spiteful and bitter about.
1597 ;; ======================================================================
1598 ;; gud jdb variables and functions
1600 (defcustom gud-jdb-command-name "jdb"
1601 "Command that executes the Java debugger."
1605 (defcustom gud-jdb-use-classpath t
1606 "If non-nil, search for Java source files in classpath directories.
1607 The list of directories to search is the value of `gud-jdb-classpath'.
1608 The file pathname is obtained by converting the fully qualified
1609 class information output by jdb to a relative pathname and appending
1610 it to `gud-jdb-classpath' element by element until a match is found.
1612 This method has a significant jdb startup time reduction advantage
1613 since it does not require the scanning of all `gud-jdb-directories'
1614 and parsing all Java files for class information.
1616 Set to nil to use `gud-jdb-directories' to scan java sources for
1617 class information on jdb startup (original method)."
1621 (defvar gud-jdb-classpath nil
1622 "Java/jdb classpath directories list.
1623 If `gud-jdb-use-classpath' is non-nil, gud-jdb derives the `gud-jdb-classpath'
1624 list automatically using the following methods in sequence
1625 \(with subsequent successful steps overriding the results of previous
1628 1) Read the CLASSPATH environment variable,
1629 2) Read any \"-classpath\" argument used to run jdb,
1630 or detected in jdb output (e.g. if jdb is run by a script
1631 that echoes the actual jdb command before starting jdb)
1632 3) Send a \"classpath\" command to jdb and scan jdb output for
1633 classpath information if jdb is invoked with an \"-attach\" (to
1634 an already running VM) argument (This case typically does not
1635 have a \"-classpath\" command line argument - that is provided
1636 to the VM when it is started).
1638 Note that method 3 cannot be used with oldjdb (or Java 1 jdb) since
1639 those debuggers do not support the classpath command. Use 1) or 2).")
1641 (defvar gud-jdb-sourcepath nil
1642 "Directory list provided by an (optional) \"-sourcepath\" option to jdb.
1643 This list is prepended to `gud-jdb-classpath' to form the complete
1644 list of directories searched for source files.")
1646 (defvar gud-marker-acc-max-length 4000
1647 "Maximum number of debugger output characters to keep.
1648 This variable limits the size of `gud-marker-acc' which holds
1649 the most recent debugger output history while searching for
1650 source file information.")
1652 (defvar gud-jdb-history nil
1653 "History of argument lists passed to jdb.")
1656 ;; List of Java source file directories.
1657 (defvar gud-jdb-directories (list ".")
1658 "*A list of directories that gud jdb should search for source code.
1659 The file names should be absolute, or relative to the current
1662 The set of .java files residing in the directories listed are
1663 syntactically analyzed to determine the classes they define and the
1664 packages in which these classes belong. In this way gud jdb maps the
1665 package-qualified class names output by the jdb debugger to the source
1666 file from which the class originated. This allows gud mode to keep
1667 the source code display in sync with the debugging session.")
1669 (defvar gud-jdb-source-files nil
1670 "List of the java source files for this debugging session.")
1672 ;; Association list of fully qualified class names (package + class name)
1673 ;; and their source files.
1674 (defvar gud-jdb-class-source-alist nil
1675 "Association list of fully qualified class names and source files.")
1677 ;; This is used to hold a source file during analysis.
1678 (defvar gud-jdb-analysis-buffer nil)
1680 (defvar gud-jdb-classpath-string nil
1681 "Holds temporary classpath values.")
1683 (defun gud-jdb-build-source-files-list (path extn)
1684 "Return a list of java source files (absolute paths).
1685 PATH gives the directories in which to search for files with
1686 extension EXTN. Normally EXTN is given as the regular expression
1688 (apply 'nconc (mapcar (lambda (d)
1689 (when (file-directory-p d)
1690 (directory-files d t extn nil)))
1693 ;; Move point past whitespace.
1694 (defun gud-jdb-skip-whitespace ()
1695 (skip-chars-forward " \n\r\t\014"))
1697 ;; Move point past a "// <eol>" type of comment.
1698 (defun gud-jdb-skip-single-line-comment ()
1701 ;; Move point past a "/* */" or "/** */" type of comment.
1702 (defun gud-jdb-skip-traditional-or-documentation-comment ()
1706 (if (eq (following-char) ?*)
1710 (if (eq (following-char) ?/)
1713 (throw 'break nil)))))
1716 ;; Move point past any number of consecutive whitespace chars and/or comments.
1717 (defun gud-jdb-skip-whitespace-and-comments ()
1718 (gud-jdb-skip-whitespace)
1723 (gud-jdb-skip-single-line-comment)
1724 (gud-jdb-skip-whitespace))
1725 ((looking-at "/\\*")
1726 (gud-jdb-skip-traditional-or-documentation-comment)
1727 (gud-jdb-skip-whitespace))
1728 (t (throw 'done nil))))))
1730 ;; Move point past things that are id-like. The intent is to skip regular
1731 ;; id's, such as class or interface names as well as package and interface
1733 (defun gud-jdb-skip-id-ish-thing ()
1734 (skip-chars-forward "^ /\n\r\t\014,;{"))
1736 ;; Move point past a string literal.
1737 (defun gud-jdb-skip-string-literal ()
1740 ((eq (following-char) ?\\)
1742 ((eq (following-char) ?\042))))
1746 ;; Move point past a character literal.
1747 (defun gud-jdb-skip-character-literal ()
1751 (if (eq (following-char) ?\\)
1753 (not (eq (following-char) ?\')))
1757 ;; Move point past the following block. There may be (legal) cruft before
1758 ;; the block's opening brace. There must be a block or it's the end of life
1759 ;; in petticoat junction.
1760 (defun gud-jdb-skip-block ()
1762 ;; Find the begining of the block.
1764 (not (eq (following-char) ?{))
1766 ;; Skip any constructs that can harbor literal block delimiter
1767 ;; characters and/or the delimiters for the constructs themselves.
1770 (gud-jdb-skip-single-line-comment))
1771 ((looking-at "/\\*")
1772 (gud-jdb-skip-traditional-or-documentation-comment))
1773 ((eq (following-char) ?\042)
1774 (gud-jdb-skip-string-literal))
1775 ((eq (following-char) ?\')
1776 (gud-jdb-skip-character-literal))
1777 (t (forward-char))))
1779 ;; Now at the begining of the block.
1782 ;; Skip over the body of the block as well as the final brace.
1783 (let ((open-level 1))
1784 (while (not (eq open-level 0))
1787 (gud-jdb-skip-single-line-comment))
1788 ((looking-at "/\\*")
1789 (gud-jdb-skip-traditional-or-documentation-comment))
1790 ((eq (following-char) ?\042)
1791 (gud-jdb-skip-string-literal))
1792 ((eq (following-char) ?\')
1793 (gud-jdb-skip-character-literal))
1794 ((eq (following-char) ?{)
1795 (setq open-level (+ open-level 1))
1797 ((eq (following-char) ?})
1798 (setq open-level (- open-level 1))
1800 (t (forward-char))))))
1802 ;; Find the package and class definitions in Java source file FILE. Assumes
1803 ;; that FILE contains a legal Java program. BUF is a scratch buffer used
1804 ;; to hold the source during analysis.
1805 (defun gud-jdb-analyze-source (buf file)
1808 (insert-file-contents file nil nil nil t)
1813 (gud-jdb-skip-whitespace)
1817 ;; Any number of semi's following a block is legal. Move point
1818 ;; past them. Note that comments and whitespace may be
1819 ;; interspersed as well.
1820 ((eq (following-char) ?\073)
1823 ;; Move point past a single line comment.
1825 (gud-jdb-skip-single-line-comment))
1827 ;; Move point past a traditional or documentation comment.
1828 ((looking-at "/\\*")
1829 (gud-jdb-skip-traditional-or-documentation-comment))
1831 ;; Move point past a package statement, but save the PackageName.
1832 ((looking-at "package")
1834 (gud-jdb-skip-whitespace-and-comments)
1836 (gud-jdb-skip-id-ish-thing)
1837 (setq p (concat (buffer-substring s (point)) "."))
1838 (gud-jdb-skip-whitespace-and-comments)
1839 (if (eq (following-char) ?\073)
1842 ;; Move point past an import statement.
1843 ((looking-at "import")
1845 (gud-jdb-skip-whitespace-and-comments)
1846 (gud-jdb-skip-id-ish-thing)
1847 (gud-jdb-skip-whitespace-and-comments)
1848 (if (eq (following-char) ?\073)
1851 ;; Move point past the various kinds of ClassModifiers.
1852 ((looking-at "public")
1854 ((looking-at "abstract")
1856 ((looking-at "final")
1859 ;; Move point past a ClassDeclaraction, but save the class
1861 ((looking-at "class")
1863 (gud-jdb-skip-whitespace-and-comments)
1865 (gud-jdb-skip-id-ish-thing)
1867 l (nconc l (list (concat p (buffer-substring s (point)))))))
1868 (gud-jdb-skip-block))
1870 ;; Move point past an interface statement.
1871 ((looking-at "interface")
1873 (gud-jdb-skip-block))
1875 ;; Anything else means the input is invalid.
1877 (message "Error parsing file %s." file)
1878 (throw 'abort nil))))))
1881 (defun gud-jdb-build-class-source-alist-for-file (file)
1885 (gud-jdb-analyze-source gud-jdb-analysis-buffer file)))
1887 ;; Return an alist of fully qualified classes and the source files
1888 ;; holding their definitions. SOURCES holds a list of all the source
1889 ;; files to examine.
1890 (defun gud-jdb-build-class-source-alist (sources)
1891 (setq gud-jdb-analysis-buffer (get-buffer-create " *gud-jdb-scratch*"))
1896 'gud-jdb-build-class-source-alist-for-file
1898 (kill-buffer gud-jdb-analysis-buffer)
1899 (setq gud-jdb-analysis-buffer nil)))
1901 ;; Change what was given in the minibuffer to something that can be used to
1902 ;; invoke the debugger.
1903 (defun gud-jdb-massage-args (file args)
1904 ;; The jdb executable must have whitespace between "-classpath" and
1905 ;; its value while gud-common-init expects all switch values to
1906 ;; follow the switch keyword without intervening whitespace. We
1907 ;; require that when the user enters the "-classpath" switch in the
1908 ;; EMACS minibuffer that they do so without the intervening
1909 ;; whitespace. This function adds it back (it's called after
1910 ;; gud-common-init). There are more switches like this (for
1911 ;; instance "-host" and "-password") but I don't care about them
1914 (let (massaged-args user-error)
1916 (while (and args (not user-error))
1918 ((setq user-error (string-match "-classpath$" (car args))))
1919 ((setq user-error (string-match "-sourcepath$" (car args))))
1920 ((string-match "-classpath\\(.+\\)" (car args))
1922 (append massaged-args
1924 (setq gud-jdb-classpath-string
1925 (match-string 1 (car args)))))))
1926 ((string-match "-sourcepath\\(.+\\)" (car args))
1928 (append massaged-args
1930 (setq gud-jdb-sourcepath
1931 (match-string 1 (car args)))))))
1932 (t (setq massaged-args (append massaged-args (list (car args))))))
1933 (setq args (cdr args)))
1935 ;; By this point the current directory is all screwed up. Maybe we
1936 ;; could fix things and re-invoke gud-common-init, but for now I think
1937 ;; issueing the error is good enough.
1940 (kill-buffer (current-buffer))
1941 (error "Error: Omit whitespace between '-classpath or -sourcepath' and its value")))
1944 ;; Search for an association with P, a fully qualified class name, in
1945 ;; gud-jdb-class-source-alist. The asssociation gives the fully
1946 ;; qualified file name of the source file which produced the class.
1947 (defun gud-jdb-find-source-file (p)
1948 (cdr (assoc p gud-jdb-class-source-alist)))
1950 ;; Note: Reset to this value every time a prompt is seen
1951 (defvar gud-jdb-lowest-stack-level 999)
1953 (defun gud-jdb-find-source-using-classpath (p)
1954 "Find source file corresponding to fully qualified class p.
1955 Convert p from jdb's output, converted to a pathname
1956 relative to a classpath directory."
1959 (;; Replace dots with slashes and append ".java" to generate file
1960 ;; name relative to classpath
1963 (mapconcat 'identity
1965 ;; Eliminate any subclass references in the class
1966 ;; name string. These start with a "$"
1968 (if (string-match "$.*" x)
1969 (replace-match "" t t x) p))
1973 (cplist (append gud-jdb-sourcepath gud-jdb-classpath))
1976 (not (setq found-file
1978 (concat (car cplist) "/" filename)))))
1979 (setq cplist (cdr cplist)))
1980 (if found-file (concat (car cplist) "/" filename)))))
1982 (defun gud-jdb-find-source (string)
1983 "Alias for function used to locate source files.
1984 Set to `gud-jdb-find-source-using-classpath' or `gud-jdb-find-source-file'
1985 during jdb initialization depending on the value of
1986 `gud-jdb-use-classpath'."
1989 (defun gud-jdb-parse-classpath-string (string)
1990 "Parse the classpath list and convert each item to an absolute pathname."
1991 (mapcar (lambda (s) (if (string-match "[/\\]$" s)
1992 (replace-match "" nil nil s) s))
1993 (mapcar 'file-truename
1996 (concat "[ \t\n\r,\"" path-separator "]+")))))
1998 ;; See comentary for other debugger's marker filters - there you will find
1999 ;; important notes about STRING.
2000 (defun gud-jdb-marker-filter (string)
2002 ;; Build up the accumulator.
2003 (setq gud-marker-acc
2005 (concat gud-marker-acc string)
2008 ;; Look for classpath information until gud-jdb-classpath-string is found
2009 ;; (interactive, multiple settings of classpath from jdb
2010 ;; not supported/followed)
2011 (if (and gud-jdb-use-classpath
2012 (not gud-jdb-classpath-string)
2013 (or (string-match "classpath:[ \t[]+\\([^]]+\\)" gud-marker-acc)
2014 (string-match "-classpath[ \t\"]+\\([^ \"]+\\)" gud-marker-acc)))
2015 (setq gud-jdb-classpath
2016 (gud-jdb-parse-classpath-string
2017 (setq gud-jdb-classpath-string
2018 (match-string 1 gud-marker-acc)))))
2020 ;; We process STRING from left to right. Each time through the
2021 ;; following loop we process at most one marker. After we've found a
2022 ;; marker, delete gud-marker-acc up to and including the match
2024 ;; Process each complete marker in the input.
2027 ;; Do we see a marker?
2029 ;; jdb puts out a string of the following form when it
2030 ;; hits a breakpoint:
2032 ;; <fully-qualified-class><method> (<class>:<line-number>)
2034 ;; <fully-qualified-class>'s are composed of Java ID's
2035 ;; separated by periods. <method> and <class> are
2036 ;; also Java ID's. <method> begins with a period and
2037 ;; may contain less-than and greater-than (constructors,
2038 ;; for instance, are called <init> in the symbol table.)
2039 ;; Java ID's begin with a letter followed by letters
2040 ;; and/or digits. The set of letters includes underscore
2043 ;; The first group matches <fully-qualified-class>,
2044 ;; the second group matches <class> and the third group
2045 ;; matches <line-number>. We don't care about using
2046 ;; <method> so we don't "group" it.
2048 ;; FIXME: Java ID's are UNICODE strings, this matches ASCII
2051 ;; The ".," in the last square-bracket are necessary because
2052 ;; of Sun's total disrespect for backwards compatibility in
2053 ;; reported line numbers from jdb - starting in 1.4.0 they
2054 ;; print line numbers using LOCALE, inserting a comma or a
2055 ;; period at the thousands positions (how ingenious!).
2057 "\\(\[[0-9]+\] \\)*\\([a-zA-Z0-9.$_]+\\)\\.[a-zA-Z0-9$_<>(),]+ \
2058 \\(([a-zA-Z0-9.$_]+:\\|line=\\)\\([0-9.,]+\\)"
2061 ;; A good marker is one that:
2062 ;; 1) does not have a "[n] " prefix (not part of a stack backtrace)
2063 ;; 2) does have an "[n] " prefix and n is the lowest prefix seen
2064 ;; since the last prompt
2065 ;; Figure out the line on which to position the debugging arrow.
2066 ;; Return the info as a cons of the form:
2068 ;; (<file-name> . <line-number>) .
2069 (if (if (match-beginning 1)
2071 (setq n (string-to-number (substring
2073 (1+ (match-beginning 1))
2074 (- (match-end 1) 2))))
2075 (if (< n gud-jdb-lowest-stack-level)
2076 (progn (setq gud-jdb-lowest-stack-level n) t)))
2078 (if (setq file-found
2079 (gud-jdb-find-source (match-string 2 gud-marker-acc)))
2080 (setq gud-last-frame
2084 ((numstr (match-string 4 gud-marker-acc)))
2085 (if (string-match "[.,]" numstr)
2086 (replace-match "" nil nil numstr)
2088 (message "Could not find source file.")))
2090 ;; Set the accumulator to the remaining text.
2091 (setq gud-marker-acc (substring gud-marker-acc (match-end 0))))
2093 (if (string-match comint-prompt-regexp gud-marker-acc)
2094 (setq gud-jdb-lowest-stack-level 999)))
2096 ;; Do not allow gud-marker-acc to grow without bound. If the source
2097 ;; file information is not within the last 3/4
2098 ;; gud-marker-acc-max-length characters, well,...
2099 (if (> (length gud-marker-acc) gud-marker-acc-max-length)
2100 (setq gud-marker-acc
2101 (substring gud-marker-acc
2102 (- (/ (* gud-marker-acc-max-length 3) 4)))))
2104 ;; We don't filter any debugger output so just return what we were given.
2107 (defvar gud-jdb-command-name "jdb" "Command that executes the Java debugger.")
2110 (defun jdb (command-line)
2111 "Run jdb with command line COMMAND-LINE in a buffer.
2112 The buffer is named \"*gud*\" if no initial class is given or
2113 \"*gud-<initial-class-basename>*\" if there is. If the \"-classpath\"
2114 switch is given, omit all whitespace between it and its value.
2116 See `gud-jdb-use-classpath' and `gud-jdb-classpath' documentation for
2117 information on how jdb accesses source files. Alternatively (if
2118 `gud-jdb-use-classpath' is nil), see `gud-jdb-directories' for the
2119 original source file access method.
2121 For general information about commands available to control jdb from
2122 gud, see `gud-mode'."
2124 (list (gud-query-cmdline 'jdb)))
2125 (setq gud-jdb-classpath nil)
2126 (setq gud-jdb-sourcepath nil)
2128 ;; Set gud-jdb-classpath from the CLASSPATH environment variable,
2129 ;; if CLASSPATH is set.
2130 (setq gud-jdb-classpath-string (getenv "CLASSPATH"))
2131 (if gud-jdb-classpath-string
2132 (setq gud-jdb-classpath
2133 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2134 (setq gud-jdb-classpath-string nil) ; prepare for next
2136 (gud-common-init command-line 'gud-jdb-massage-args
2137 'gud-jdb-marker-filter)
2138 (set (make-local-variable 'gud-minor-mode) 'jdb)
2140 ;; If a -classpath option was provided, set gud-jdb-classpath
2141 (if gud-jdb-classpath-string
2142 (setq gud-jdb-classpath
2143 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2144 (setq gud-jdb-classpath-string nil) ; prepare for next
2145 ;; If a -sourcepath option was provided, parse it
2146 (if gud-jdb-sourcepath
2147 (setq gud-jdb-sourcepath
2148 (gud-jdb-parse-classpath-string gud-jdb-sourcepath)))
2150 (gud-def gud-break "stop at %c:%l" "\C-b" "Set breakpoint at current line.")
2151 (gud-def gud-remove "clear %c:%l" "\C-d" "Remove breakpoint at current line")
2152 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2153 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2154 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
2155 (gud-def gud-finish "step up" "\C-f" "Continue until current method returns.")
2156 (gud-def gud-up "up\C-Mwhere" "<" "Up one stack frame.")
2157 (gud-def gud-down "down\C-Mwhere" ">" "Up one stack frame.")
2158 (gud-def gud-run "run" nil "Run the program.") ;if VM start using jdb
2160 (setq comint-prompt-regexp "^> \\|^[^ ]+\\[[0-9]+\\] ")
2161 (setq paragraph-start comint-prompt-regexp)
2162 (run-hooks 'jdb-mode-hook)
2164 (if gud-jdb-use-classpath
2165 ;; Get the classpath information from the debugger
2167 (if (string-match "-attach" command-line)
2168 (gud-call "classpath"))
2169 (fset 'gud-jdb-find-source
2170 'gud-jdb-find-source-using-classpath))
2172 ;; Else create and bind the class/source association list as well
2173 ;; as the source file list.
2174 (setq gud-jdb-class-source-alist
2175 (gud-jdb-build-class-source-alist
2176 (setq gud-jdb-source-files
2177 (gud-jdb-build-source-files-list gud-jdb-directories
2179 (fset 'gud-jdb-find-source 'gud-jdb-find-source-file)))
2182 ;; ======================================================================
2184 ;; BASHDB support. See http://bashdb.sourceforge.net
2186 ;; AUTHOR: Rocky Bernstein <rocky@panix.com>
2188 ;; CREATED: Sun Nov 10 10:46:38 2002 Rocky Bernstein.
2190 ;; INVOCATION NOTES:
2192 ;; You invoke bashdb-mode with:
2194 ;; M-x bashdb <enter>
2196 ;; It responds with:
2198 ;; Run bashdb (like this): bash
2201 ;; History of argument lists passed to bashdb.
2202 (defvar gud-bashdb-history nil)
2204 ;; Convert a command line as would be typed normally to run a script
2205 ;; into one that invokes an Emacs-enabled debugging session.
2206 ;; "--debugger" in inserted as the first switch.
2208 ;; There's no guarantee that Emacs will hand the filter the entire
2209 ;; marker at once; it could be broken up across several strings. We
2210 ;; might even receive a big chunk with several markers in it. If we
2211 ;; receive a chunk of text which looks like it might contain the
2212 ;; beginning of a marker, we save it here between calls to the
2214 (defun gud-bashdb-marker-filter (string)
2215 (setq gud-marker-acc (concat gud-marker-acc string))
2218 ;; Process all the complete markers in this chunk.
2219 ;; Format of line looks like this:
2220 ;; (/etc/init.d/ntp.init:16):
2221 ;; but we also allow DOS drive letters
2222 ;; (d:/etc/init.d/ntp.init:16):
2223 (while (string-match "\\(^\\|\n\\)(\\(\\([a-zA-Z]:\\)?[^:\n]*\\):\\([0-9]*\\)):.*\n"
2227 ;; Extract the frame position from the marker.
2229 (cons (match-string 2 gud-marker-acc)
2230 (string-to-number (match-string 4 gud-marker-acc)))
2232 ;; Append any text before the marker to the output we're going
2233 ;; to return - we don't include the marker in this text.
2234 output (concat output
2235 (substring gud-marker-acc 0 (match-beginning 0)))
2237 ;; Set the accumulator to the remaining text.
2238 gud-marker-acc (substring gud-marker-acc (match-end 0))))
2240 ;; Does the remaining text look like it might end with the
2241 ;; beginning of another marker? If it does, then keep it in
2242 ;; gud-marker-acc until we receive the rest of it. Since we
2243 ;; know the full marker regexp above failed, it's pretty simple to
2244 ;; test for marker starts.
2245 (if (string-match "\032.*\\'" gud-marker-acc)
2247 ;; Everything before the potential marker start can be output.
2248 (setq output (concat output (substring gud-marker-acc
2249 0 (match-beginning 0))))
2251 ;; Everything after, we save, to combine with later input.
2252 (setq gud-marker-acc
2253 (substring gud-marker-acc (match-beginning 0))))
2255 (setq output (concat output gud-marker-acc)
2260 (defcustom gud-bashdb-command-name "bash --debugger"
2261 "File name for executing bash debugger."
2266 (defun bashdb (command-line)
2267 "Run bashdb on program FILE in buffer *gud-FILE*.
2268 The directory containing FILE becomes the initial working directory
2269 and source-file directory for your debugger."
2271 (list (read-from-minibuffer "Run bashdb (like this): "
2272 (if (consp gud-bashdb-history)
2273 (car gud-bashdb-history)
2274 (concat gud-bashdb-command-name
2276 gud-minibuffer-local-map nil
2277 '(gud-bashdb-history . 1))))
2279 (gud-common-init command-line nil 'gud-bashdb-marker-filter)
2281 (set (make-local-variable 'gud-minor-mode) 'bashdb)
2283 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
2284 (gud-def gud-tbreak "tbreak %l" "\C-t" "Set temporary breakpoint at current line.")
2285 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
2286 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2287 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2288 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
2289 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
2290 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
2291 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
2292 (gud-def gud-print "x %e" "\C-p" "Evaluate BASH expression at point.")
2295 (gud-def gud-statement "eval %e" "\C-e" "Execute BASH statement at point.")
2297 (setq comint-prompt-regexp "^bashdb<+(*[0-9]+)*>+ ")
2298 (setq paragraph-start comint-prompt-regexp)
2299 (run-hooks 'bashdb-mode-hook)
2303 ;; End of debugger-specific information
2307 ;; When we send a command to the debugger via gud-call, it's annoying
2308 ;; to see the command and the new prompt inserted into the debugger's
2309 ;; buffer; we have other ways of knowing the command has completed.
2311 ;; If the buffer looks like this:
2312 ;; --------------------
2313 ;; (gdb) set args foo bar
2315 ;; --------------------
2316 ;; (the -!- marks the location of point), and we type `C-x SPC' in a
2317 ;; source file to set a breakpoint, we want the buffer to end up like
2319 ;; --------------------
2320 ;; (gdb) set args foo bar
2321 ;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
2323 ;; --------------------
2324 ;; Essentially, the old prompt is deleted, and the command's output
2325 ;; and the new prompt take its place.
2327 ;; Not echoing the command is easy enough; you send it directly using
2328 ;; process-send-string, and it never enters the buffer. However,
2329 ;; getting rid of the old prompt is trickier; you don't want to do it
2330 ;; when you send the command, since that will result in an annoying
2331 ;; flicker as the prompt is deleted, redisplay occurs while Emacs
2332 ;; waits for a response from the debugger, and the new prompt is
2333 ;; inserted. Instead, we'll wait until we actually get some output
2334 ;; from the subprocess before we delete the prompt. If the command
2335 ;; produced no output other than a new prompt, that prompt will most
2336 ;; likely be in the first chunk of output received, so we will delete
2337 ;; the prompt and then replace it with an identical one. If the
2338 ;; command produces output, the prompt is moving anyway, so the
2339 ;; flicker won't be annoying.
2341 ;; So - when we want to delete the prompt upon receipt of the next
2342 ;; chunk of debugger output, we position gud-delete-prompt-marker at
2343 ;; the start of the prompt; the process filter will notice this, and
2344 ;; delete all text between it and the process output marker. If
2345 ;; gud-delete-prompt-marker points nowhere, we leave the current
2347 (defvar gud-delete-prompt-marker nil)
2350 (put 'gud-mode 'mode-class 'special)
2352 (define-derived-mode gud-mode comint-mode "Debugger"
2353 "Major mode for interacting with an inferior debugger process.
2355 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
2356 M-x perldb, M-x xdb, or M-x jdb. Each entry point finishes by executing a
2357 hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook',
2358 `perldb-mode-hook', `xdb-mode-hook', or `jdb-mode-hook' respectively.
2360 After startup, the following commands are available in both the GUD
2361 interaction buffer and any source buffer GUD visits due to a breakpoint stop
2364 \\[gud-break] sets a breakpoint at the current file and line. In the
2365 GUD buffer, the current file and line are those of the last breakpoint or
2366 step. In a source buffer, they are the buffer's file and current line.
2368 \\[gud-remove] removes breakpoints on the current file and line.
2370 \\[gud-refresh] displays in the source window the last line referred to
2373 \\[gud-step], \\[gud-next], and \\[gud-stepi] do a step-one-line,
2374 step-one-line (not entering function calls), and step-one-instruction
2375 and then update the source window with the current file and position.
2376 \\[gud-cont] continues execution.
2378 \\[gud-print] tries to find the largest C lvalue or function-call expression
2379 around point, and sends it to the debugger for value display.
2381 The above commands are common to all supported debuggers except xdb which
2382 does not support stepping instructions.
2384 Under gdb, sdb and xdb, \\[gud-tbreak] behaves exactly like \\[gud-break],
2385 except that the breakpoint is temporary; that is, it is removed when
2386 execution stops on it.
2388 Under gdb, dbx, and xdb, \\[gud-up] pops up through an enclosing stack
2389 frame. \\[gud-down] drops back down through one.
2391 If you are using gdb or xdb, \\[gud-finish] runs execution to the return from
2392 the current function and stops.
2394 All the keystrokes above are accessible in the GUD buffer
2395 with the prefix C-c, and in all buffers through the prefix C-x C-a.
2397 All pre-defined functions for which the concept make sense repeat
2398 themselves the appropriate number of times if you give a prefix
2401 You may use the `gud-def' macro in the initialization hook to define other
2404 Other commands for interacting with the debugger process are inherited from
2405 comint mode, which see."
2406 (setq mode-line-process '(":%s"))
2407 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
2408 (set (make-local-variable 'gud-last-frame) nil)
2409 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
2410 (make-local-variable 'comint-prompt-regexp)
2411 ;; Don't put repeated commands in command history many times.
2412 (set (make-local-variable 'comint-input-ignoredups) t)
2413 (make-local-variable 'paragraph-start)
2414 (set (make-local-variable 'gud-delete-prompt-marker) (make-marker))
2415 (add-hook 'kill-buffer-hook 'gud-kill-buffer-hook nil t))
2417 ;; Cause our buffers to be displayed, by default,
2418 ;; in the selected window.
2419 ;;;###autoload (add-hook 'same-window-regexps "\\*gud-.*\\*\\(\\|<[0-9]+>\\)")
2421 (defcustom gud-chdir-before-run t
2422 "Non-nil if GUD should `cd' to the debugged executable."
2426 (defvar gud-target-name "--unknown--"
2427 "The apparent name of the program being debugged in a gud buffer.")
2429 ;; Perform initializations common to all debuggers.
2430 ;; The first arg is the specified command line,
2431 ;; which starts with the program to debug.
2432 ;; The other three args specify the values to use
2433 ;; for local variables in the debugger buffer.
2434 (defun gud-common-init (command-line massage-args marker-filter
2435 &optional find-file)
2436 (let* ((words (split-string command-line))
2437 (program (car words))
2438 (dir default-directory)
2439 ;; Extract the file name from WORDS
2440 ;; and put t in its place.
2441 ;; Later on we will put the modified file name arg back there.
2442 (file-word (let ((w (cdr words)))
2443 (while (and w (= ?- (aref (car w) 0)))
2449 (and file-word (substitute-in-file-name file-word)))
2451 ;; If a directory was specified, expand the file name.
2452 ;; Otherwise, don't expand it, so GDB can use the PATH.
2453 ;; A file name without directory is literally valid
2454 ;; only if the file exists in ., and in that case,
2455 ;; omitting the expansion here has no visible effect.
2456 (file (and file-word
2457 (if (file-name-directory file-subst)
2458 (expand-file-name file-subst)
2460 (filepart (and file-word (concat "-" (file-name-nondirectory file))))
2461 (existing-buffer (get-buffer (concat "*gud" filepart "*"))))
2462 (pop-to-buffer (concat "*gud" filepart "*"))
2463 (when (and existing-buffer (get-buffer-process existing-buffer))
2464 (error "This program is already running under gdb"))
2465 ;; Set the dir, in case the buffer already existed with a different dir.
2466 (setq default-directory dir)
2467 ;; Set default-directory to the file's directory.
2469 gud-chdir-before-run
2470 ;; Don't set default-directory if no directory was specified.
2471 ;; In that case, either the file is found in the current directory,
2472 ;; in which case this setq is a no-op,
2473 ;; or it is found by searching PATH,
2474 ;; in which case we don't know what directory it was found in.
2475 (file-name-directory file)
2476 (setq default-directory (file-name-directory file)))
2477 (or (bolp) (newline))
2478 (insert "Current directory is " default-directory "\n")
2479 ;; Put the substituted and expanded file name back in its place.
2481 (while (and w (not (eq (car w) t)))
2485 (apply 'make-comint (concat "gud" filepart) program nil
2486 (if massage-args (funcall massage-args file args) args))
2487 ;; Since comint clobbered the mode, we don't set it until now.
2489 (set (make-local-variable 'gud-target-name)
2490 (and file-word (file-name-nondirectory file))))
2491 (set (make-local-variable 'gud-marker-filter) marker-filter)
2492 (if find-file (set (make-local-variable 'gud-find-file) find-file))
2493 (setq gud-running nil)
2494 (setq gud-last-last-frame nil)
2496 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
2497 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
2500 (defun gud-set-buffer ()
2501 (when (eq major-mode 'gud-mode)
2502 (setq gud-comint-buffer (current-buffer))))
2504 (defvar gud-filter-defer-flag nil
2505 "Non-nil means don't process anything from the debugger right now.
2506 It is saved for when this flag is not set.")
2508 ;; These functions are responsible for inserting output from your debugger
2509 ;; into the buffer. The hard work is done by the method that is
2510 ;; the value of gud-marker-filter.
2512 (defun gud-filter (proc string)
2513 ;; Here's where the actual buffer insertion is done
2514 (let (output process-window)
2515 (if (buffer-name (process-buffer proc))
2516 (if gud-filter-defer-flag
2517 ;; If we can't process any text now,
2518 ;; save it for later.
2519 (setq gud-filter-pending-text
2520 (concat (or gud-filter-pending-text "") string))
2522 ;; If we have to ask a question during the processing,
2523 ;; defer any additional text that comes from the debugger
2524 ;; during that time.
2525 (let ((gud-filter-defer-flag t))
2526 ;; Process now any text we previously saved up.
2527 (if gud-filter-pending-text
2528 (setq string (concat gud-filter-pending-text string)
2529 gud-filter-pending-text nil))
2531 (with-current-buffer (process-buffer proc)
2532 ;; If we have been so requested, delete the debugger prompt.
2535 (if (marker-buffer gud-delete-prompt-marker)
2536 (let ((inhibit-read-only t))
2537 (delete-region (process-mark proc)
2538 gud-delete-prompt-marker)
2539 (comint-update-fence)
2540 (set-marker gud-delete-prompt-marker nil)))
2541 ;; Save the process output, checking for source file markers.
2542 (setq output (gud-marker-filter string))
2543 ;; Check for a filename-and-line number.
2544 ;; Don't display the specified file
2545 ;; unless (1) point is at or after the position where output appears
2546 ;; and (2) this buffer is on the screen.
2547 (setq process-window
2549 (>= (point) (process-mark proc))
2550 (get-buffer-window (current-buffer)))))
2552 ;; Let the comint filter do the actual insertion.
2553 ;; That lets us inherit various comint features.
2554 (comint-output-filter proc output))
2556 ;; Put the arrow on the source line.
2557 ;; This must be outside of the save-excursion
2558 ;; in case the source file is our current buffer.
2560 (with-selected-window process-window
2561 (gud-display-frame))
2562 ;; We have to be in the proper buffer, (process-buffer proc),
2563 ;; but not in a save-excursion, because that would restore point.
2564 (with-current-buffer (process-buffer proc)
2565 (gud-display-frame))))
2567 ;; If we deferred text that arrived during this processing,
2569 (if gud-filter-pending-text
2570 (gud-filter proc ""))))))
2572 (defvar gud-minor-mode-type nil)
2573 (defvar gud-overlay-arrow-position nil)
2574 (add-to-list 'overlay-arrow-variable-list 'gud-overlay-arrow-position)
2576 (defun gud-sentinel (proc msg)
2577 (cond ((null (buffer-name (process-buffer proc)))
2579 ;; Stop displaying an arrow in a source file.
2580 (setq gud-overlay-arrow-position nil)
2581 (set-process-buffer proc nil)
2582 (if (and (boundp 'speedbar-frame)
2583 (string-equal speedbar-initial-expansion-list-name "GUD"))
2584 (speedbar-change-initial-expansion-list
2585 speedbar-previously-used-expansion-list-name))
2586 (if (memq gud-minor-mode-type '(gdbmi gdba))
2589 ((memq (process-status proc) '(signal exit))
2590 ;; Stop displaying an arrow in a source file.
2591 (setq gud-overlay-arrow-position nil)
2592 (with-current-buffer gud-comint-buffer
2593 (if (memq gud-minor-mode-type '(gdbmi gdba))
2596 (let* ((obuf (current-buffer)))
2597 ;; save-excursion isn't the right thing if
2598 ;; process-buffer is current-buffer
2601 ;; Write something in *compilation* and hack its mode line,
2602 (set-buffer (process-buffer proc))
2603 ;; Fix the mode line.
2604 (setq mode-line-process
2606 (symbol-name (process-status proc))))
2607 (force-mode-line-update)
2609 (insert ?\n mode-name " " msg)
2611 (goto-char (point-max))
2612 (insert ?\n mode-name " " msg)))
2613 ;; If buffer and mode line will show that the process
2614 ;; is dead, we can delete it now. Otherwise it
2615 ;; will stay around until M-x list-processes.
2616 (delete-process proc))
2617 ;; Restore old buffer, but don't restore old point
2618 ;; if obuf is the gud buffer.
2619 (set-buffer obuf))))))
2621 (defun gud-kill-buffer-hook ()
2622 (setq gud-minor-mode-type gud-minor-mode)
2624 (kill-process (get-buffer-process (current-buffer)))
2628 (dolist (buffer (buffer-list))
2629 (unless (eq buffer gud-comint-buffer)
2630 (with-current-buffer buffer
2631 (when gud-minor-mode
2632 (setq gud-minor-mode nil)
2633 (kill-local-variable 'tool-bar-map))))))
2635 (defun gud-display-frame ()
2636 "Find and obey the last filename-and-line marker from the debugger.
2637 Obeying it means displaying in another window the specified file and line."
2639 (when gud-last-frame
2641 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
2642 (setq gud-last-last-frame gud-last-frame
2643 gud-last-frame nil)))
2645 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
2646 ;; and that its line LINE is visible.
2647 ;; Put the overlay-arrow on the line LINE in that buffer.
2648 ;; Most of the trickiness in here comes from wanting to preserve the current
2649 ;; region-restriction if that's possible. We use an explicit display-buffer
2650 ;; to get around the fact that this is called inside a save-excursion.
2652 (defun gud-display-line (true-file line)
2653 (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
2655 (with-current-buffer gud-comint-buffer
2656 (gud-find-file true-file)))
2657 (window (and buffer (or (get-buffer-window buffer)
2658 (display-buffer buffer))))
2662 (with-current-buffer buffer
2663 (unless (or (verify-visited-file-modtime buffer) gud-keep-buffer)
2665 (format "File %s changed on disk. Reread from disk? "
2668 (setq gud-keep-buffer t)))
2673 (or gud-overlay-arrow-position
2674 (setq gud-overlay-arrow-position (make-marker)))
2675 (set-marker gud-overlay-arrow-position (point) (current-buffer)))
2676 (cond ((or (< pos (point-min)) (> pos (point-max)))
2679 (if window (set-window-point window gud-overlay-arrow-position))))))
2681 ;; The gud-call function must do the right thing whether its invoking
2682 ;; keystroke is from the GUD buffer itself (via major-mode binding)
2683 ;; or a C buffer. In the former case, we want to supply data from
2684 ;; gud-last-frame. Here's how we do it:
2686 (defun gud-format-command (str arg)
2687 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
2688 (frame (or gud-last-frame gud-last-last-frame))
2690 (while (and str (string-match "\\([^%]*\\)%\\([adeflpc]\\)" str))
2691 (let ((key (string-to-char (match-string 2 str)))
2695 (setq subst (file-name-nondirectory (if insource
2699 (setq subst (file-name-sans-extension
2700 (file-name-nondirectory (if insource
2704 (setq subst (file-name-directory (if insource
2708 (setq subst (int-to-string
2712 (+ (count-lines (point-min) (point))
2716 (setq subst (gud-find-expr)))
2718 (setq subst (gud-read-address)))
2728 (+ (count-lines (point-min) (point))
2732 (setq subst (if arg (int-to-string arg)))))
2733 (setq result (concat result (match-string 1 str) subst)))
2734 (setq str (substring str (match-end 2))))
2735 ;; There might be text left in STR when the loop ends.
2736 (concat result str)))
2738 (defun gud-read-address ()
2739 "Return a string containing the core-address found in the buffer at point."
2742 (let ((pt (point)) found begin)
2743 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
2745 (found (forward-char 2)
2746 (buffer-substring found
2747 (progn (re-search-forward "[^0-9a-f]")
2750 (t (setq begin (progn (re-search-backward "[^0-9]")
2754 (re-search-forward "[^0-9]")
2756 (buffer-substring begin (point))))))))
2758 (defun gud-call (fmt &optional arg)
2759 (let ((msg (gud-format-command fmt arg)))
2760 (message "Command: %s" msg)
2762 (gud-basic-call msg)))
2764 (defun gud-basic-call (command)
2765 "Invoke the debugger COMMAND displaying source in other window."
2768 (let ((proc (get-buffer-process gud-comint-buffer)))
2769 (or proc (error "Current buffer has no process"))
2770 ;; Arrange for the current prompt to get deleted.
2772 (set-buffer gud-comint-buffer)
2775 (goto-char (process-mark proc))
2777 (if (looking-at comint-prompt-regexp)
2778 (set-marker gud-delete-prompt-marker (point)))
2779 (if (memq gud-minor-mode '(gdbmi gdba))
2780 (apply comint-input-sender (list proc command))
2781 (process-send-string proc (concat command "\n")))))))
2783 (defun gud-refresh (&optional arg)
2784 "Fix up a possibly garbled display, and redraw the arrow."
2786 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
2790 ;; Code for parsing expressions out of C or Fortran code. The single entry
2791 ;; point is gud-find-expr, which tries to return an lvalue expression from
2794 (defvar gud-find-expr-function 'gud-find-c-expr)
2796 (defun gud-find-expr (&rest args)
2797 (apply gud-find-expr-function args))
2799 ;; The next eight functions are hacked from gdbsrc.el by
2800 ;; Debby Ayers <ayers@asc.slb.com>,
2801 ;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
2803 (defun gud-find-c-expr ()
2804 "Returns the expr that surrounds point."
2808 (expr (gud-innermost-expr))
2809 (test-expr (gud-prev-expr)))
2810 (while (and test-expr (gud-expr-compound test-expr expr))
2811 (let ((prev-expr expr))
2812 (setq expr (cons (car test-expr) (cdr expr)))
2813 (goto-char (car expr))
2814 (setq test-expr (gud-prev-expr))
2815 ;; If we just pasted on the condition of an if or while,
2816 ;; throw it away again.
2817 (if (member (buffer-substring (car test-expr) (cdr test-expr))
2818 '("if" "while" "for"))
2822 (setq test-expr (gud-next-expr))
2823 (while (gud-expr-compound expr test-expr)
2824 (setq expr (cons (car expr) (cdr test-expr)))
2825 (setq test-expr (gud-next-expr)))
2826 (buffer-substring (car expr) (cdr expr)))))
2828 (defun gud-innermost-expr ()
2829 "Returns the smallest expr that point is in; move point to beginning of it.
2830 The expr is represented as a cons cell, where the car specifies the point in
2831 the current buffer that marks the beginning of the expr and the cdr specifies
2832 the character after the end of the expr."
2833 (let ((p (point)) begin end)
2835 (setq begin (point))
2848 (defun gud-backward-sexp ()
2849 "Version of `backward-sexp' that catches errors."
2854 (defun gud-forward-sexp ()
2855 "Version of `forward-sexp' that catches errors."
2860 (defun gud-prev-expr ()
2861 "Returns the previous expr, point is set to beginning of that expr.
2862 The expr is represented as a cons cell, where the car specifies the point in
2863 the current buffer that marks the beginning of the expr and the cdr specifies
2864 the character after the end of the expr"
2865 (let ((begin) (end))
2867 (setq begin (point))
2873 (defun gud-next-expr ()
2874 "Returns the following expr, point is set to beginning of that expr.
2875 The expr is represented as a cons cell, where the car specifies the point in
2876 the current buffer that marks the beginning of the expr and the cdr specifies
2877 the character after the end of the expr."
2878 (let ((begin) (end))
2883 (setq begin (point))
2886 (defun gud-expr-compound-sep (span-start span-end)
2887 "Scan from SPAN-START to SPAN-END for punctuation characters.
2888 If `->' is found, return `?.'. If `.' is found, return `?.'.
2889 If any other punctuation is found, return `??'.
2890 If no punctuation is found, return `? '."
2893 (while (< span-start span-end)
2894 (setq syntax (char-syntax (char-after span-start)))
2897 ((= syntax ?.) (setq syntax (char-after span-start))
2899 ((= syntax ?.) (setq result ?.))
2900 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
2902 (setq span-start (+ span-start 1)))
2903 (t (setq span-start span-end)
2904 (setq result ??)))))
2905 (setq span-start (+ span-start 1)))
2908 (defun gud-expr-compound (first second)
2909 "Non-nil if concatenating FIRST and SECOND makes a single C expression.
2910 The two exprs are represented as a cons cells, where the car
2911 specifies the point in the current buffer that marks the beginning of the
2912 expr and the cdr specifies the character after the end of the expr.
2913 Link exprs of the form:
2920 (let ((span-start (cdr first))
2921 (span-end (car second))
2923 (setq syntax (gud-expr-compound-sep span-start span-end))
2925 ((= (car first) (car second)) nil)
2926 ((= (cdr first) (cdr second)) nil)
2929 (setq span-start (char-after (- span-start 1)))
2930 (setq span-end (char-after span-end))
2932 ((= span-start ?)) t)
2933 ((= span-start ?]) t)
2939 (defun gud-find-class (f line)
2940 "Find fully qualified class in file F at line LINE.
2941 This function uses the `gud-jdb-classpath' (and optional
2942 `gud-jdb-sourcepath') list(s) to derive a file
2943 pathname relative to its classpath directory. The values in
2944 `gud-jdb-classpath' are assumed to have been converted to absolute
2945 pathname standards using file-truename.
2946 If F is visited by a buffer and its mode is CC-mode(Java),
2947 syntactic information of LINE is used to find the enclosing (nested)
2948 class string which is appended to the top level
2949 class of the file (using s to separate nested class ids)."
2950 ;; Convert f to a standard representation and remove suffix
2951 (if (and gud-jdb-use-classpath (or gud-jdb-classpath gud-jdb-sourcepath))
2953 (let ((cplist (append gud-jdb-sourcepath gud-jdb-classpath))
2954 (fbuffer (get-file-buffer f))
2955 syntax-symbol syntax-point class-found)
2956 (setq f (file-name-sans-extension (file-truename f)))
2957 ;; Syntax-symbol returns the symbol of the *first* element
2958 ;; in the syntactical analysis result list, syntax-point
2959 ;; returns the buffer position of same
2960 (fset 'syntax-symbol (lambda (x) (c-langelem-sym (car x))))
2961 (fset 'syntax-point (lambda (x) (c-langelem-pos (car x))))
2962 ;; Search through classpath list for an entry that is
2964 (while (and cplist (not class-found))
2965 (if (string-match (car cplist) f)
2967 (mapconcat 'identity
2969 (substring f (+ (match-end 0) 1))
2971 (setq cplist (cdr cplist)))
2972 ;; if f is visited by a java(cc-mode) buffer, walk up the
2973 ;; syntactic information chain and collect any 'inclass
2974 ;; symbols until 'topmost-intro is reached to find out if
2975 ;; point is within a nested class
2976 (if (and fbuffer (equal (symbol-file 'java-mode) "cc-mode"))
2978 (set-buffer fbuffer)
2979 (let ((nclass) (syntax))
2980 ;; While the c-syntactic information does not start
2981 ;; with the 'topmost-intro symbol, there may be
2982 ;; nested classes...
2983 (while (not (eq 'topmost-intro
2984 (syntax-symbol (c-guess-basic-syntax))))
2985 ;; Check if the current position c-syntactic
2986 ;; analysis has 'inclass
2987 (setq syntax (c-guess-basic-syntax))
2989 (and (not (eq 'inclass (syntax-symbol syntax)))
2991 (setq syntax (cdr syntax)))
2992 (if (eq 'inclass (syntax-symbol syntax))
2994 (goto-char (syntax-point syntax))
2995 ;; Now we're at the beginning of a class
2996 ;; definition. Find class name
2998 "[A-Za-z0-9 \t\n]*?class[ \t\n]+\\([^ \t\n]+\\)")
3000 (append (list (match-string-no-properties 1))
3002 (setq syntax (c-guess-basic-syntax))
3003 (while (and (not (syntax-point syntax)) (cdr syntax))
3004 (setq syntax (cdr syntax)))
3005 (goto-char (syntax-point syntax))
3007 (string-match (concat (car nclass) "$") class-found)
3009 (replace-match (mapconcat 'identity nclass "$")
3010 t t class-found)))))
3011 (if (not class-found)
3012 (message "gud-find-class: class for file %s not found!" f))
3014 ;; Not using classpath - try class/source association list
3015 (let ((class-found (rassoc f gud-jdb-class-source-alist)))
3018 (message "gud-find-class: class for file %s not found in gud-jdb-class-source-alist!" f)
3022 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3023 ;;; GDB script mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3024 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3026 (defvar gdb-script-mode-syntax-table
3027 (let ((st (make-syntax-table)))
3028 (modify-syntax-entry ?' "\"" st)
3029 (modify-syntax-entry ?# "<" st)
3030 (modify-syntax-entry ?\n ">" st)
3033 (defvar gdb-script-font-lock-keywords
3034 '(("^define\\s-+\\(\\(\\w\\|\\s_\\)+\\)" (1 font-lock-function-name-face))
3035 ("\\$\\(\\w+\\)" (1 font-lock-variable-name-face))
3036 ("^\\s-*\\([a-z]+\\)" (1 font-lock-keyword-face))))
3038 (defvar gdb-script-font-lock-syntactic-keywords
3039 '(("^document\\s-.*\\(\n\\)" (1 "< b"))
3040 ;; It would be best to change the \n in front, but it's more difficult.
3041 ("^en\\(d\\)\\>" (1 "> b"))))
3043 (defun gdb-script-font-lock-syntactic-face (state)
3045 ((nth 3 state) font-lock-string-face)
3046 ((nth 7 state) font-lock-doc-face)
3047 (t font-lock-comment-face)))
3049 (defvar gdb-script-basic-indent 2)
3051 (defun gdb-script-skip-to-head ()
3052 "We're just in front of an `end' and we need to go to its head."
3053 (while (and (re-search-backward "^\\s-*\\(\\(end\\)\\|define\\|document\\|if\\|while\\)\\>" nil 'move)
3055 (gdb-script-skip-to-head)))
3057 (defun gdb-script-calculate-indentation ()
3059 ((looking-at "end\\>")
3060 (gdb-script-skip-to-head)
3061 (current-indentation))
3062 ((looking-at "else\\>")
3063 (while (and (re-search-backward "^\\s-*\\(if\\|\\(end\\)\\)\\>" nil 'move)
3065 (gdb-script-skip-to-head))
3066 (current-indentation))
3068 (forward-comment (- (point-max)))
3070 (skip-chars-forward " \t")
3071 (+ (current-indentation)
3072 (if (looking-at "\\(if\\|while\\|define\\|else\\)\\>")
3073 gdb-script-basic-indent 0)))))
3075 (defun gdb-script-indent-line ()
3076 "Indent current line of GDB script."
3078 (if (and (eq (get-text-property (point) 'face) font-lock-doc-face)
3081 (skip-chars-forward " \t")
3082 (not (looking-at "end\\>"))))
3084 (let* ((savep (point))
3085 (indent (condition-case nil
3088 (skip-chars-forward " \t")
3089 (if (>= (point) savep) (setq savep nil))
3090 (max (gdb-script-calculate-indentation) 0))
3093 (save-excursion (indent-line-to indent))
3094 (indent-line-to indent)))))
3096 ;; Derived from cfengine.el.
3097 (defun gdb-script-beginning-of-defun ()
3098 "`beginning-of-defun' function for Gdb script mode.
3099 Treats actions as defuns."
3100 (unless (<= (current-column) (current-indentation))
3102 (if (re-search-backward "^define \\|^document " nil t)
3104 (goto-char (point-min)))
3107 ;; Derived from cfengine.el.
3108 (defun gdb-script-end-of-defun ()
3109 "`end-of-defun' function for Gdb script mode.
3110 Treats actions as defuns."
3112 (if (re-search-forward "^end" nil t)
3114 (goto-char (point-max)))
3118 (add-to-list 'auto-mode-alist '("/\\.gdbinit" . gdb-script-mode))
3121 (define-derived-mode gdb-script-mode nil "GDB-Script"
3122 "Major mode for editing GDB scripts"
3123 (set (make-local-variable 'comment-start) "#")
3124 (set (make-local-variable 'comment-start-skip) "#+\\s-*")
3125 (set (make-local-variable 'outline-regexp) "[ \t]")
3126 (set (make-local-variable 'imenu-generic-expression)
3127 '((nil "^define[ \t]+\\(\\w+\\)" 1)))
3128 (set (make-local-variable 'indent-line-function) 'gdb-script-indent-line)
3129 (set (make-local-variable 'beginning-of-defun-function)
3130 #'gdb-script-beginning-of-defun)
3131 (set (make-local-variable 'end-of-defun-function)
3132 #'gdb-script-end-of-defun)
3133 (set (make-local-variable 'font-lock-defaults)
3134 '(gdb-script-font-lock-keywords nil nil ((?_ . "w")) nil
3135 (font-lock-syntactic-keywords
3136 . gdb-script-font-lock-syntactic-keywords)
3137 (font-lock-syntactic-face-function
3138 . gdb-script-font-lock-syntactic-face))))
3141 ;;; tooltips for GUD
3143 ;;; Customizable settings
3144 (defcustom gud-tooltip-modes '(gud-mode c-mode c++-mode fortran-mode)
3145 "List of modes for which to enable GUD tips."
3150 (defcustom gud-tooltip-display
3151 '((eq (tooltip-event-buffer gud-tooltip-event)
3152 (marker-buffer gud-overlay-arrow-position)))
3153 "List of forms determining where GUD tooltips are displayed.
3155 Forms in the list are combined with AND. The default is to display
3156 only tooltips in the buffer containing the overlay arrow."
3158 :tag "GUD buffers predicate"
3161 (defcustom gud-tooltip-echo-area nil
3162 "Use the echo area instead of frames for GUD tooltips."
3164 :tag "Use echo area"
3167 (define-obsolete-variable-alias 'tooltip-gud-modes
3168 'gud-tooltip-modes "22.1")
3169 (define-obsolete-variable-alias 'tooltip-gud-display
3170 'gud-tooltip-display "22.1")
3172 ;;; Reacting on mouse movements
3174 (defun gud-tooltip-change-major-mode ()
3175 "Function added to `change-major-mode-hook' when tooltip mode is on."
3176 (add-hook 'post-command-hook 'gud-tooltip-activate-mouse-motions-if-enabled))
3178 (defun gud-tooltip-activate-mouse-motions-if-enabled ()
3179 "Reconsider for all buffers whether mouse motion events are desired."
3180 (remove-hook 'post-command-hook
3181 'gud-tooltip-activate-mouse-motions-if-enabled)
3182 (dolist (buffer (buffer-list))
3185 (if (and gud-tooltip-mode
3186 (memq major-mode gud-tooltip-modes))
3187 (gud-tooltip-activate-mouse-motions t)
3188 (gud-tooltip-activate-mouse-motions nil)))))
3190 (defvar gud-tooltip-mouse-motions-active nil
3191 "Locally t in a buffer if tooltip processing of mouse motion is enabled.")
3193 (defun gud-tooltip-activate-mouse-motions (activatep)
3194 "Activate/deactivate mouse motion events for the current buffer.
3195 ACTIVATEP non-nil means activate mouse motion events."
3198 (make-local-variable 'gud-tooltip-mouse-motions-active)
3199 (setq gud-tooltip-mouse-motions-active t)
3200 (make-local-variable 'track-mouse)
3201 (setq track-mouse t))
3202 (when gud-tooltip-mouse-motions-active
3203 (kill-local-variable 'gud-tooltip-mouse-motions-active)
3204 (kill-local-variable 'track-mouse))))
3206 (defun gud-tooltip-mouse-motion (event)
3207 "Command handler for mouse movement events in `global-map'."
3210 (when (car (mouse-pixel-position))
3211 (setq tooltip-last-mouse-motion-event (copy-sequence event))
3212 (tooltip-start-delayed-tip)))
3216 (defvar gud-tooltip-original-filter nil
3217 "Process filter to restore after GUD output has been received.")
3219 (defvar gud-tooltip-dereference nil
3220 "Non-nil means print expressions with a `*' in front of them.
3221 For C this would dereference a pointer expression.")
3223 (defvar gud-tooltip-event nil
3224 "The mouse movement event that led to a tooltip display.
3225 This event can be examined by forms in GUD-TOOLTIP-DISPLAY.")
3227 (defun toggle-gud-tooltip-dereference ()
3228 "Toggle whether tooltips should show `* expr' or `expr'."
3230 (setq gud-tooltip-dereference (not gud-tooltip-dereference))
3231 (when (interactive-p)
3232 (message "Dereferencing is now %s."
3233 (if gud-tooltip-dereference "on" "off"))))
3235 (define-obsolete-function-alias 'tooltip-gud-toggle-dereference
3236 'toggle-gud-tooltip-dereference "22.1")
3239 (define-minor-mode gud-tooltip-mode
3240 "Toggle the display of GUD tooltips."
3244 (if gud-tooltip-mode
3246 (add-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3247 (add-hook 'pre-command-hook 'tooltip-hide)
3248 (add-hook 'tooltip-hook 'gud-tooltip-tips)
3249 (define-key global-map [mouse-movement] 'gud-tooltip-mouse-motion))
3250 (unless tooltip-mode (remove-hook 'pre-command-hook 'tooltip-hide)
3251 (remove-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3252 (remove-hook 'tooltip-hook 'gud-tooltip-tips)
3253 (define-key global-map [mouse-movement] 'ignore)))
3254 (gud-tooltip-activate-mouse-motions-if-enabled)
3257 (buffer-name gud-comint-buffer); gud-comint-buffer might be kille
3258 (with-current-buffer gud-comint-buffer
3259 (memq gud-minor-mode '(gdbmi gdba))))
3260 (if gud-tooltip-mode
3262 (dolist (buffer (buffer-list))
3263 (unless (eq buffer gud-comint-buffer)
3264 (with-current-buffer buffer
3265 (when (and (memq gud-minor-mode '(gdbmi gdba))
3266 (not (string-match "\\`\\*.+\\*\\'"
3268 (make-local-variable 'gdb-define-alist)
3269 (gdb-create-define-alist)
3270 (add-hook 'after-save-hook
3271 'gdb-create-define-alist nil t))))))
3272 (kill-local-variable 'gdb-define-alist)
3273 (remove-hook 'after-save-hook 'gdb-create-define-alist t))))
3275 ; This will only display data that comes in one chunk.
3276 ; Larger arrays (say 400 elements) are displayed in
3277 ; the tooltip incompletely and spill over into the gud buffer.
3278 ; Switching the process-filter creates timing problems and
3279 ; it may be difficult to do better. Using annotations as in
3280 ; gdb-ui.el gets round this problem.
3281 (defun gud-tooltip-process-output (process output)
3282 "Process debugger output and show it in a tooltip window."
3283 (set-process-filter process gud-tooltip-original-filter)
3284 (tooltip-show (tooltip-strip-prompt process output)
3285 (or gud-tooltip-echo-area tooltip-use-echo-area)))
3287 (defun gud-tooltip-print-command (expr)
3288 "Return a suitable command to print the expression EXPR.
3289 If GUD-TOOLTIP-DEREFERENCE is t, also prepend a `*' to EXPR."
3290 (when gud-tooltip-dereference
3291 (setq expr (concat "*" expr)))
3292 (case gud-minor-mode
3293 (gdba (concat "server print " expr))
3294 ((dbx gdbmi) (concat "print " expr))
3295 (xdb (concat "p " expr))
3296 (sdb (concat expr "/"))
3299 (defun gud-tooltip-tips (event)
3300 "Show tip for identifier or selection under the mouse.
3301 The mouse must either point at an identifier or inside a selected
3302 region for the tip window to be shown. If gud-tooltip-dereference is t,
3303 add a `*' in front of the printed expression. In the case of a C program
3304 controlled by GDB, show the associated #define directives when program is
3307 This function must return nil if it doesn't handle EVENT."
3309 (when (and (eventp event)
3311 (boundp 'gud-comint-buffer)
3313 (buffer-name gud-comint-buffer); gud-comint-buffer might be killed
3314 (setq process (get-buffer-process gud-comint-buffer))
3315 (posn-point (event-end event))
3316 (or (and (eq gud-minor-mode 'gdba) (not gdb-active-process))
3317 (progn (setq gud-tooltip-event event)
3318 (eval (cons 'and gud-tooltip-display)))))
3319 (let ((expr (tooltip-expr-to-print event)))
3321 (if (and (eq gud-minor-mode 'gdba)
3322 (not gdb-active-process))
3324 (with-current-buffer
3325 (window-buffer (let ((mouse (mouse-position)))
3326 (window-at (cadr mouse)
3328 (let ((define-elt (assoc expr gdb-define-alist)))
3329 (unless (null define-elt)
3332 (or gud-tooltip-echo-area tooltip-use-echo-area))
3334 (let ((cmd (gud-tooltip-print-command expr)))
3335 (when (and gud-tooltip-mode (eq gud-minor-mode 'gdb))
3336 (gud-tooltip-mode -1)
3337 (message-box "Using GUD tooltips in this mode is unsafe\n\
3338 so they have been disabled."))
3339 (unless (null cmd) ; CMD can be nil if unknown debugger
3340 (if (memq gud-minor-mode '(gdba gdbmi))
3344 gdb-server-prefix "macro expand " expr "\n")
3345 `(lambda () (gdb-tooltip-print-1 ,expr))))
3347 (list (concat cmd "\n") 'gdb-tooltip-print)))
3348 (setq gud-tooltip-original-filter (process-filter process))
3349 (set-process-filter process 'gud-tooltip-process-output)
3350 (gud-basic-call cmd))
3355 ;;; arch-tag: 6d990948-df65-461a-be39-1c7fb83ac4c4
3356 ;;; gud.el ends here