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 ;; ======================================================================
49 ;; GUD commands must be visible in C buffers visited by GUD
52 "Grand Unified Debugger mode for gdb and other debuggers under Emacs.
53 Supported debuggers include gdb, sdb, dbx, xdb, perldb, pdb (Python), jdb, and bash."
58 (defcustom gud-key-prefix
"\C-x\C-a"
59 "Prefix of all GUD commands valid in C buffers."
63 (global-set-key (concat gud-key-prefix
"\C-l") 'gud-refresh
)
64 (define-key ctl-x-map
" " 'gud-break
) ;; backward compatibility hack
66 (defvar gud-marker-filter nil
)
67 (put 'gud-marker-filter
'permanent-local t
)
68 (defvar gud-find-file nil
)
69 (put 'gud-find-file
'permanent-local t
)
71 (defun gud-marker-filter (&rest args
)
72 (apply gud-marker-filter args
))
74 (defvar gud-minor-mode nil
)
75 (put 'gud-minor-mode
'permanent-local t
)
77 (defvar gud-keep-buffer nil
)
79 (defun gud-symbol (sym &optional soft minor-mode
)
80 "Return the symbol used for SYM in MINOR-MODE.
81 MINOR-MODE defaults to `gud-minor-mode.
82 The symbol returned is `gud-<MINOR-MODE>-<SYM>'.
83 If SOFT is non-nil, returns nil if the symbol doesn't already exist."
84 (unless (or minor-mode gud-minor-mode
) (error "Gud internal error"))
85 (funcall (if soft
'intern-soft
'intern
)
86 (format "gud-%s-%s" (or minor-mode gud-minor-mode
) sym
)))
88 (defun gud-val (sym &optional minor-mode
)
89 "Return the value of `gud-symbol' SYM. Default to nil."
90 (let ((sym (gud-symbol sym t minor-mode
)))
91 (if (boundp sym
) (symbol-value sym
))))
93 (defvar gud-running nil
94 "Non-nil if debuggee is running.
95 Used to grey out relevant togolbar icons.")
97 ;; Use existing Info buffer, if possible.
98 (defun gud-goto-info ()
99 "Go to relevant Emacs info node."
101 (let ((same-window-regexps same-window-regexps
)
102 (display-buffer-reuse-frames t
))
106 (if (eq (window-buffer window
) (get-buffer "*info*"))
108 (setq same-window-regexps nil
)
109 (throw 'info-found nil
))))
111 (select-frame (make-frame)))
112 (if (memq gud-minor-mode
'(gdbmi gdba
))
113 (info "(emacs)GDB Graphical Interface")
114 (info "(emacs)Debuggers"))))
116 (easy-mmode-defmap gud-menu-map
117 '(([help] "Info" . gud-goto-info)
118 ([tooltips] menu-item "Toggle GUD tooltips" gud-tooltip-mode
119 :enable (and (not emacs-basic-display)
121 (fboundp 'x-show-tip))
122 :button (:toggle . gud-tooltip-mode))
123 ([refresh] "Refresh" . gud-refresh)
124 ([run] menu-item "Run" gud-run
125 :enable (and (not gud-running)
126 (memq gud-minor-mode '(gdbmi gdba gdb dbx jdb))))
127 ([until] menu-item "Continue to selection" gud-until
128 :enable (and (not gud-running)
129 (memq gud-minor-mode '(gdbmi gdba gdb perldb))))
130 ([remove] menu-item "Remove Breakpoint" gud-remove
131 :enable (not gud-running))
132 ([tbreak] menu-item "Temporary Breakpoint" gud-tbreak
133 :enable (memq gud-minor-mode '(gdbmi gdba gdb sdb xdb bashdb)))
134 ([break] menu-item "Set Breakpoint" gud-break
135 :enable (not gud-running))
136 ([up] menu-item "Up Stack" gud-up
137 :enable (and (not gud-running)
139 '(gdbmi gdba gdb dbx xdb jdb pdb bashdb))))
140 ([down] menu-item "Down Stack" gud-down
141 :enable (and (not gud-running)
143 '(gdbmi gdba gdb dbx xdb jdb pdb bashdb))))
144 ([print*] menu-item "Print Dereference" gud-pstar
145 :enable (and (not gud-running)
146 (memq gud-minor-mode '(gdbmi gdba gdb))))
147 ([print] menu-item "Print Expression" gud-print
148 :enable (not gud-running))
149 ([watch] menu-item "Watch Expression" gud-watch
150 :enable (and (not gud-running)
151 (memq gud-minor-mode '(gdbmi gdba))))
152 ([finish] menu-item "Finish Function" gud-finish
153 :enable (and (not gud-running)
155 '(gdbmi gdba gdb xdb jdb pdb bashdb))))
156 ([stepi] menu-item "Step Instruction" gud-stepi
157 :enable (and (not gud-running)
158 (memq gud-minor-mode '(gdbmi gdba gdb dbx))))
159 ([nexti] menu-item "Next Instruction" gud-nexti
160 :enable (and (not gud-running)
161 (memq gud-minor-mode '(gdbmi gdba gdb dbx))))
162 ([step] menu-item "Step Line" gud-step
163 :enable (not gud-running))
164 ([next] menu-item "Next Line" gud-next
165 :enable (not gud-running))
166 ([cont] menu-item "Continue" gud-cont
167 :enable (not gud-running)))
168 "Menu for `gud-mode'."
171 (easy-mmode-defmap gud-minor-mode-map
172 `(([menu-bar debug] . ("Gud" . ,gud-menu-map)))
173 "Map used in visited files.")
175 (let ((m (assq 'gud-minor-mode minor-mode-map-alist)))
176 (if m (setcdr m gud-minor-mode-map)
177 (push (cons 'gud-minor-mode gud-minor-mode-map) minor-mode-map-alist)))
180 ;; Will inherit from comint-mode via define-derived-mode.
182 "`gud-mode' keymap.")
184 (defvar gud-tool-bar-map
185 (if (display-graphic-p)
186 (let ((map (make-sparse-keymap)))
187 (dolist (x '((gud-break . "gud-break")
188 (gud-remove . "gud-remove")
189 (gud-print . "gud-print")
190 (gud-pstar . "gud-pstar")
191 (gud-watch . "gud-watch")
192 (gud-cont . "gud-cont")
193 (gud-until . "gud-until")
194 (gud-finish . "gud-finish")
195 (gud-run . "gud-run")
196 ;; gud-s, gud-si etc. instead of gud-step,
197 ;; gud-stepi, to avoid file-name clashes on DOS
201 (gud-nexti . "gud-ni")
202 (gud-stepi . "gud-si")
204 (gud-down . "gud-down")
205 (gud-goto-info . "info"))
207 (tool-bar-local-item-from-menu
208 (car x) (cdr x) map gud-minor-mode-map)))))
210 (defun gud-file-name (f)
211 "Transform a relative file name to an absolute file name.
212 Uses `gud-<MINOR-MODE>-directories' to find the source files."
213 (if (file-exists-p f) (expand-file-name f)
214 (let ((directories (gud-val 'directories))
217 (let ((path (expand-file-name f (car directories))))
218 (if (file-exists-p path)
221 (setq directories (cdr directories)))
224 (defun gud-find-file (file)
225 ;; Don't get confused by double slashes in the name that comes from GDB.
226 (while (string-match "//+" file)
227 (setq file (replace-match "/" t t file)))
228 (let ((minor-mode gud-minor-mode)
229 (buf (funcall (or gud-find-file 'gud-file-name) file)))
231 (setq buf (and (file-readable-p buf) (find-file-noselect buf 'nowarn))))
233 ;; Copy `gud-minor-mode' to the found buffer to turn on the menu.
234 (with-current-buffer buf
235 (set (make-local-variable 'gud-minor-mode) minor-mode)
236 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
237 (when (and gud-tooltip-mode
238 (memq gud-minor-mode '(gdbmi gdba)))
239 (make-local-variable 'gdb-define-alist)
240 (unless gdb-define-alist (gdb-create-define-alist))
241 (add-hook 'after-save-hook 'gdb-create-define-alist nil t))
242 (make-local-variable 'gud-keep-buffer))
245 ;; ======================================================================
246 ;; command definition
248 ;; This macro is used below to define some basic debugger interface commands.
249 ;; Of course you may use `gud-def' with any other debugger command, including
250 ;; user defined ones.
252 ;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
253 ;; which defines FUNC to send the command NAME to the debugger, gives
254 ;; it the docstring DOC, and binds that function to KEY in the GUD
255 ;; major mode. The function is also bound in the global keymap with the
258 (defmacro gud-def (func cmd key &optional doc)
259 "Define FUNC to be a command sending STR and bound to KEY, with
260 optional doc string DOC. Certain %-escapes in the string arguments
261 are interpreted specially if present. These are:
263 %f name (without directory) of current source file.
264 %F name (without directory or extension) of current source file.
265 %d directory of current source file.
266 %l number of current source line
267 %e text of the C lvalue or function-call expression surrounding point.
268 %a text of the hexadecimal address surrounding point
269 %p prefix argument to the command (if any) as a number
271 The `current' source file is the file of the current buffer (if
272 we're in a C file) or the source file current at the last break or
273 step (if we're in the GUD buffer).
274 The `current' line is that of the current buffer (if we're in a
275 source file) or the source line number at the last break or step (if
276 we're in the GUD buffer)."
279 ,@(if doc (list doc))
284 ,(if key `(local-set-key ,(concat "\C-c" key) ',func))
285 ,(if key `(global-set-key (vconcat gud-key-prefix ,key) ',func))))
287 ;; Where gud-display-frame should put the debugging arrow; a cons of
288 ;; (filename . line-number). This is set by the marker-filter, which scans
289 ;; the debugger's output for indications of the current program counter.
290 (defvar gud-last-frame nil)
292 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
293 ;; the last frame, even if it's been called before and gud-last-frame has
295 (defvar gud-last-last-frame nil)
297 ;; All debugger-specific information is collected here.
298 ;; Here's how it works, in case you ever need to add a debugger to the mode.
300 ;; Each entry must define the following at startup:
303 ;; comint-prompt-regexp
304 ;; gud-<name>-massage-args
305 ;; gud-<name>-marker-filter
306 ;; gud-<name>-find-file
308 ;; The job of the massage-args method is to modify the given list of
309 ;; debugger arguments before running the debugger.
311 ;; The job of the marker-filter method is to detect file/line markers in
312 ;; strings and set the global gud-last-frame to indicate what display
313 ;; action (if any) should be triggered by the marker. Note that only
314 ;; whatever the method *returns* is displayed in the buffer; thus, you
315 ;; can filter the debugger's output, interpreting some and passing on
318 ;; The job of the find-file method is to visit and return the buffer indicated
319 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
322 ;; ======================================================================
323 ;; speedbar support functions and variables.
324 (eval-when-compile (require 'speedbar)) ;For speedbar-with-attached-buffer.
326 (defvar gud-last-speedbar-buffer nil
327 "The last GUD buffer used.")
329 (defvar gud-last-speedbar-stackframe nil
330 "Description of the currently displayed GUD stack.
331 t means that there is no stack, and we are in display-file mode.")
333 (defvar gud-speedbar-key-map nil
334 "Keymap used when in the buffers display mode.")
336 (defun gud-install-speedbar-variables ()
337 "Install those variables used by speedbar to enhance gud/gdb."
338 (if gud-speedbar-key-map
340 (setq gud-speedbar-key-map (speedbar-make-specialized-keymap))
342 (define-key gud-speedbar-key-map "j" 'speedbar-edit-line)
343 (define-key gud-speedbar-key-map "e" 'speedbar-edit-line)
344 (define-key gud-speedbar-key-map "\C-m" 'speedbar-edit-line)
345 (define-key gud-speedbar-key-map "D" 'gdb-var-delete)))
348 (defvar gud-speedbar-menu-items
349 ;; Note to self. Add expand, and turn off items when not available.
350 '(["Jump to stack frame" speedbar-edit-line
351 (with-current-buffer gud-comint-buffer
352 (not (memq gud-minor-mode '(gdbmi gdba))))]
353 ["Edit value" speedbar-edit-line
354 (with-current-buffer gud-comint-buffer
355 (memq gud-minor-mode '(gdbmi gdba)))]
356 ["Delete expression" gdb-var-delete
357 (with-current-buffer gud-comint-buffer
358 (memq gud-minor-mode '(gdbmi gdba)))])
359 "Additional menu items to add to the speedbar frame.")
361 ;; Make sure our special speedbar mode is loaded
362 (if (featurep 'speedbar)
363 (gud-install-speedbar-variables)
364 (add-hook 'speedbar-load-hook 'gud-install-speedbar-variables))
366 (defun gud-speedbar-buttons (buffer)
367 "Create a speedbar display based on the current state of GUD.
368 If the GUD BUFFER is not running a supported debugger, then turn
369 off the specialized speedbar mode."
370 (let ((minor-mode (with-current-buffer buffer gud-minor-mode)))
372 ((memq minor-mode '(gdbmi gdba))
373 (when (or gdb-var-changed
375 (goto-char (point-min))
376 (let ((case-fold-search t))
377 (looking-at "Watch Expressions:")))))
379 (insert "Watch Expressions:\n")
380 (let ((var-list gdb-var-list))
382 (let* ((depth 0) (start 0) (char ?+)
383 (var (car var-list)) (varnum (nth 1 var)))
384 (while (string-match "\\." varnum start)
385 (setq depth (1+ depth)
386 start (1+ (match-beginning 0))))
387 (if (equal (nth 2 var) "0")
388 (speedbar-make-tag-line 'bracket ?? nil nil
389 (concat (car var) "\t" (nth 4 var))
393 gdb-show-changed-values)
394 'font-lock-warning-face
396 (if (and (cadr var-list)
397 (string-match varnum (cadr (cadr var-list))))
399 (speedbar-make-tag-line 'bracket char
400 'gdb-speedbar-expand-node varnum
401 (concat (car var) "\t" (nth 3 var))
403 (setq var-list (cdr var-list))))
404 (setq gdb-var-changed nil)))
405 (t (if (and (save-excursion
406 (goto-char (point-min))
407 (looking-at "Current Stack"))
408 (equal gud-last-last-frame gud-last-speedbar-stackframe))
410 (setq gud-last-speedbar-buffer buffer)
411 (let ((gud-frame-list
412 (cond ((eq minor-mode 'gdb)
413 (gud-gdb-get-stackframe buffer))
414 ;; Add more debuggers here!
415 (t (speedbar-remove-localized-speedbar-support buffer)
418 (if (not gud-frame-list)
419 (insert "No Stack frames\n")
420 (insert "Current Stack:\n"))
421 (dolist (frame gud-frame-list)
422 (insert (nth 1 frame) ":\n")
423 (if (= (length frame) 2)
425 ; (speedbar-insert-button "[?]"
426 ; 'speedbar-button-face
428 (speedbar-insert-button (car frame)
429 'speedbar-directory-face
431 ; (speedbar-insert-button "[+]"
432 ; 'speedbar-button-face
433 ; 'speedbar-highlight-face
434 ; 'gud-gdb-get-scope-data
436 (speedbar-insert-button (car frame)
438 'speedbar-highlight-face
439 (cond ((memq minor-mode '(gdbmi gdba gdb))
440 'gud-gdb-goto-stackframe)
441 (t (error "Should never be here")))
443 ; (let ((selected-frame
444 ; (cond ((eq ff 'gud-gdb-find-file)
445 ; (gud-gdb-selected-frame-info buffer))
446 ; (t (error "Should never be here"))))))
448 (setq gud-last-speedbar-stackframe gud-last-last-frame))))))
451 ;; ======================================================================
454 ;; History of argument lists passed to gdb.
455 (defvar gud-gdb-history nil)
457 (defcustom gud-gdb-command-name "gdb --annotate=3"
458 "Default command to execute an executable under the GDB debugger."
462 (defvar gud-gdb-marker-regexp
463 ;; This used to use path-separator instead of ":";
464 ;; however, we found that on both Windows 32 and MSDOS
465 ;; a colon is correct here.
466 (concat "\032\032\\(.:?[^" ":" "\n]*\\)" ":"
467 "\\([0-9]*\\)" ":" ".*\n"))
469 ;; There's no guarantee that Emacs will hand the filter the entire
470 ;; marker at once; it could be broken up across several strings. We
471 ;; might even receive a big chunk with several markers in it. If we
472 ;; receive a chunk of text which looks like it might contain the
473 ;; beginning of a marker, we save it here between calls to the
475 (defvar gud-marker-acc "")
476 (make-variable-buffer-local 'gud-marker-acc)
478 (defun gud-gdb-marker-filter (string)
479 (setq gud-marker-acc (concat gud-marker-acc string))
482 ;; Process all the complete markers in this chunk.
483 (while (string-match gud-gdb-marker-regexp gud-marker-acc)
486 ;; Extract the frame position from the marker.
487 gud-last-frame (cons (match-string 1 gud-marker-acc)
488 (string-to-number (match-string 2 gud-marker-acc)))
490 ;; Append any text before the marker to the output we're going
491 ;; to return - we don't include the marker in this text.
492 output (concat output
493 (substring gud-marker-acc 0 (match-beginning 0)))
495 ;; Set the accumulator to the remaining text.
496 gud-marker-acc (substring gud-marker-acc (match-end 0))))
498 ;; Check for annotations and change gud-minor-mode to 'gdba if
500 (while (string-match "\n\032\032\\(.*\\)\n" gud-marker-acc)
501 (let ((match (match-string 1 gud-marker-acc)))
502 (when (string-equal match "prompt")
507 ;; Append any text before the marker to the output we're going
508 ;; to return - we don't include the marker in this text.
509 output (concat output
510 (substring gud-marker-acc 0 (match-beginning 0)))
512 ;; Set the accumulator to the remaining text.
514 gud-marker-acc (substring gud-marker-acc (match-end 0)))
515 (if (string-equal match "error-begin")
516 (put-text-property 0 (length gud-marker-acc)
517 'face font-lock-warning-face
520 ;; Does the remaining text look like it might end with the
521 ;; beginning of another marker? If it does, then keep it in
522 ;; gud-marker-acc until we receive the rest of it. Since we
523 ;; know the full marker regexp above failed, it's pretty simple to
524 ;; test for marker starts.
525 (if (string-match "\n\\(\032.*\\)?\\'" gud-marker-acc)
527 ;; Everything before the potential marker start can be output.
528 (setq output (concat output (substring gud-marker-acc
529 0 (match-beginning 0))))
531 ;; Everything after, we save, to combine with later input.
533 (substring gud-marker-acc (match-beginning 0))))
535 (setq output (concat output gud-marker-acc)
540 (easy-mmode-defmap gud-minibuffer-local-map
541 '(("\C-i" . comint-dynamic-complete-filename))
542 "Keymap for minibuffer prompting of gud startup command."
543 :inherit minibuffer-local-map)
545 (defun gud-query-cmdline (minor-mode &optional init)
546 (let* ((hist-sym (gud-symbol 'history nil minor-mode))
547 (cmd-name (gud-val 'command-name minor-mode)))
548 (unless (boundp hist-sym) (set hist-sym nil))
549 (read-from-minibuffer
550 (format "Run %s (like this): " minor-mode)
551 (or (car-safe (symbol-value hist-sym))
552 (concat (or cmd-name (symbol-name minor-mode))
556 (dolist (f (directory-files default-directory) file)
557 (if (and (file-executable-p f)
558 (not (file-directory-p f))
560 (file-newer-than-file-p f file)))
562 gud-minibuffer-local-map nil
565 (defvar gdb-first-prompt t)
567 (defvar gud-filter-pending-text nil
568 "Non-nil means this is text that has been saved for later in `gud-filter'.")
571 (defun gdb (command-line)
572 "Run gdb on program FILE in buffer *gud-FILE*.
573 The directory containing FILE becomes the initial working directory
574 and source-file directory for your debugger."
575 (interactive (list (gud-query-cmdline 'gdb)))
577 (gud-common-init command-line nil 'gud-gdb-marker-filter)
578 (set (make-local-variable 'gud-minor-mode) 'gdb)
580 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
581 (gud-def gud-tbreak "tbreak %f:%l" "\C-t" "Set temporary breakpoint at current line.")
582 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
583 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
584 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
585 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
586 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
587 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
588 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
589 (gud-def gud-jump "tbreak %f:%l\njump %f:%l" "\C-j" "Relocate execution address to line at point in source buffer.")
591 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
592 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
593 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
594 (gud-def gud-pstar "print* %e" nil
595 "Evaluate C dereferenced pointer expression at point.")
596 (gud-def gud-until "until %l" "\C-u" "Continue to current line.")
597 (gud-def gud-run "run" nil "Run the program.")
599 (local-set-key "\C-i" 'gud-gdb-complete-command)
600 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
601 (setq paragraph-start comint-prompt-regexp)
602 (setq gdb-first-prompt t)
603 (setq gud-filter-pending-text nil)
604 (run-hooks 'gdb-mode-hook))
606 ;; One of the nice features of GDB is its impressive support for
607 ;; context-sensitive command completion. We preserve that feature
608 ;; in the GUD buffer by using a GDB command designed just for Emacs.
610 ;; The completion process filter indicates when it is finished.
611 (defvar gud-gdb-fetch-lines-in-progress)
613 ;; Since output may arrive in fragments we accumulate partials strings here.
614 (defvar gud-gdb-fetch-lines-string)
616 ;; We need to know how much of the completion to chop off.
617 (defvar gud-gdb-fetch-lines-break)
619 ;; The completion list is constructed by the process filter.
620 (defvar gud-gdb-fetched-lines)
622 (defvar gud-comint-buffer nil)
624 (defun gud-gdb-complete-command ()
625 "Perform completion on the GDB command preceding point.
626 This is implemented using the GDB `complete' command which isn't
627 available with older versions of GDB."
630 (command (buffer-substring (comint-line-beginning-position) end))
632 ;; Find the word break. This match will always succeed.
633 (and (string-match "\\(\\`\\| \\)\\([^ ]*\\)\\'" command)
634 (substring command (match-beginning 2))))
636 (gud-gdb-run-command-fetch-lines (concat "complete " command)
638 ;; From string-match above.
639 (match-beginning 2))))
640 ;; Protect against old versions of GDB.
642 (string-match "^Undefined command: \"complete\"" (car complete-list))
643 (error "This version of GDB doesn't support the `complete' command"))
644 ;; Sort the list like readline.
645 (setq complete-list (sort complete-list (function string-lessp)))
646 ;; Remove duplicates.
647 (let ((first complete-list)
648 (second (cdr complete-list)))
650 (if (string-equal (car first) (car second))
651 (setcdr first (setq second (cdr second)))
653 second (cdr second)))))
654 ;; Add a trailing single quote if there is a unique completion
655 ;; and it contains an odd number of unquoted single quotes.
656 (and (= (length complete-list) 1)
657 (let ((str (car complete-list))
660 (while (string-match "\\([^'\\]\\|\\\\'\\)*'" str pos)
661 (setq count (1+ count)
663 (and (= (mod count 2) 1)
664 (setq complete-list (list (concat str "'"))))))
665 ;; Let comint handle the rest.
666 (comint-dynamic-simple-complete command-word complete-list)))
668 ;; The completion process filter is installed temporarily to slurp the
669 ;; output of GDB up to the next prompt and build the completion list.
670 (defun gud-gdb-fetch-lines-filter (string filter)
671 "Filter used to read the list of lines output by a command.
672 STRING is the output to filter.
673 It is passed through FILTER before we look at it."
674 (setq string (funcall filter string))
675 (setq string (concat gud-gdb-fetch-lines-string string))
676 (while (string-match "\n" string)
677 (push (substring string gud-gdb-fetch-lines-break (match-beginning 0))
678 gud-gdb-fetched-lines)
679 (setq string (substring string (match-end 0))))
680 (if (string-match comint-prompt-regexp string)
682 (setq gud-gdb-fetch-lines-in-progress nil)
685 (setq gud-gdb-fetch-lines-string string)
688 ;; gdb speedbar functions
690 (defun gud-gdb-goto-stackframe (text token indent)
691 "Goto the stackframe described by TEXT, TOKEN, and INDENT."
692 (speedbar-with-attached-buffer
693 (gud-basic-call (concat "server frame " (nth 1 token)))
696 (defvar gud-gdb-fetched-stack-frame nil
697 "Stack frames we are fetching from GDB.")
699 ;(defun gud-gdb-get-scope-data (text token indent)
700 ; ;; checkdoc-params: (indent)
701 ; "Fetch data associated with a stack frame, and expand/contract it.
702 ;Data to do this is retrieved from TEXT and TOKEN."
703 ; (let ((args nil) (scope nil))
704 ; (gud-gdb-run-command-fetch-lines "info args")
706 ; (gud-gdb-run-command-fetch-lines "info local")
710 (defun gud-gdb-get-stackframe (buffer)
711 "Extract the current stack frame out of the GUD GDB BUFFER."
713 (fetched-stack-frame-list
714 (gud-gdb-run-command-fetch-lines "server backtrace" buffer)))
715 (if (and (car fetched-stack-frame-list)
716 (string-match "No stack" (car fetched-stack-frame-list)))
717 ;; Go into some other mode???
719 (dolist (e fetched-stack-frame-list)
720 (let ((name nil) (num nil))
722 (string-match "^#\\([0-9]+\\) +[0-9a-fx]+ in \\([:0-9a-zA-Z_]+\\) (" e)
723 (string-match "^#\\([0-9]+\\) +\\([:0-9a-zA-Z_]+\\) (" e)))
724 (if (not (string-match
725 "at \\([-0-9a-zA-Z_.]+\\):\\([0-9]+\\)$" e))
728 (list (nth 0 (car newlst))
731 (match-string 2 e))))
732 (setq num (match-string 1 e)
733 name (match-string 2 e))
737 "at \\([-0-9a-zA-Z_.]+\\):\\([0-9]+\\)$" e)
738 (list name num (match-string 1 e)
744 ;(defun gud-gdb-selected-frame-info (buffer)
745 ; "Learn GDB information for the currently selected stack frame in BUFFER."
748 (defun gud-gdb-run-command-fetch-lines (command buffer &optional skip)
749 "Run COMMAND, and return the list of lines it outputs.
750 BUFFER is the GUD buffer in which to run the command.
751 SKIP is the number of chars to skip on each lines, it defaults to 0."
752 (with-current-buffer buffer
754 (goto-char (point-max))
756 (not (looking-at comint-prompt-regexp)))
758 ;; Much of this copied from GDB complete, but I'm grabbing the stack
760 (let ((gud-gdb-fetch-lines-in-progress t)
761 (gud-gdb-fetched-lines nil)
762 (gud-gdb-fetch-lines-string nil)
763 (gud-gdb-fetch-lines-break (or skip 0))
765 `(lambda (string) (gud-gdb-fetch-lines-filter string ',gud-marker-filter))))
766 ;; Issue the command to GDB.
767 (gud-basic-call command)
769 (while gud-gdb-fetch-lines-in-progress
770 (accept-process-output (get-buffer-process buffer)))
771 (nreverse gud-gdb-fetched-lines)))))
774 ;; ======================================================================
777 ;; History of argument lists passed to sdb.
778 (defvar gud-sdb-history nil)
780 (defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
781 "If nil, we're on a System V Release 4 and don't need the tags hack.")
783 (defvar gud-sdb-lastfile nil)
785 (defun gud-sdb-marker-filter (string)
787 (if gud-marker-acc (concat gud-marker-acc string) string))
789 ;; Process all complete markers in this chunk
792 ;; System V Release 3.2 uses this format
793 ((string-match "\\(^\\|\n\\)\\*?\\(0x\\w* in \\)?\\([^:\n]*\\):\\([0-9]*\\):.*\n"
794 gud-marker-acc start)
796 (cons (match-string 3 gud-marker-acc)
797 (string-to-number (match-string 4 gud-marker-acc)))))
798 ;; System V Release 4.0 quite often clumps two lines together
799 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
800 gud-marker-acc start)
801 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc))
803 (cons gud-sdb-lastfile
804 (string-to-number (match-string 3 gud-marker-acc)))))
805 ;; System V Release 4.0
806 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n"
807 gud-marker-acc start)
808 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc)))
809 ((and gud-sdb-lastfile (string-match "^\\([0-9]+\\):"
810 gud-marker-acc start))
812 (cons gud-sdb-lastfile
813 (string-to-number (match-string 1 gud-marker-acc)))))
815 (setq gud-sdb-lastfile nil)))
816 (setq start (match-end 0)))
818 ;; Search for the last incomplete line in this chunk
819 (while (string-match "\n" gud-marker-acc start)
820 (setq start (match-end 0)))
822 ;; If we have an incomplete line, store it in gud-marker-acc.
823 (setq gud-marker-acc (substring gud-marker-acc (or start 0))))
826 (defun gud-sdb-find-file (f)
827 (if gud-sdb-needs-tags (find-tag-noselect f) (find-file-noselect f)))
830 (defun sdb (command-line)
831 "Run sdb on program FILE in buffer *gud-FILE*.
832 The directory containing FILE becomes the initial working directory
833 and source-file directory for your debugger."
834 (interactive (list (gud-query-cmdline 'sdb)))
836 (if gud-sdb-needs-tags (require 'etags))
837 (if (and gud-sdb-needs-tags
838 (not (and (boundp 'tags-file-name)
839 (stringp tags-file-name)
840 (file-exists-p tags-file-name))))
841 (error "The sdb support requires a valid tags table to work"))
843 (gud-common-init command-line nil 'gud-sdb-marker-filter 'gud-sdb-find-file)
844 (set (make-local-variable 'gud-minor-mode) 'sdb)
846 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
847 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
848 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
849 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
850 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
851 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
852 (gud-def gud-cont "c" "\C-r" "Continue with display.")
853 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
855 (setq comint-prompt-regexp "\\(^\\|\n\\)\\*")
856 (setq paragraph-start comint-prompt-regexp)
857 (run-hooks 'sdb-mode-hook)
860 ;; ======================================================================
863 ;; History of argument lists passed to dbx.
864 (defvar gud-dbx-history nil)
866 (defcustom gud-dbx-directories nil
867 "*A list of directories that dbx should search for source code.
868 If nil, only source files in the program directory
869 will be known to dbx.
871 The file names should be absolute, or relative to the directory
872 containing the executable being debugged."
873 :type '(choice (const :tag "Current Directory" nil)
878 (defun gud-dbx-massage-args (file args)
879 (nconc (let ((directories gud-dbx-directories)
882 (setq result (cons (car directories) (cons "-I" result)))
883 (setq directories (cdr directories)))
887 (defun gud-dbx-marker-filter (string)
888 (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
891 ;; Process all complete markers in this chunk.
892 (while (or (string-match
893 "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
894 gud-marker-acc start)
896 "signal .* in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
897 gud-marker-acc start))
899 (cons (match-string 2 gud-marker-acc)
900 (string-to-number (match-string 1 gud-marker-acc)))
901 start (match-end 0)))
903 ;; Search for the last incomplete line in this chunk
904 (while (string-match "\n" gud-marker-acc start)
905 (setq start (match-end 0)))
907 ;; If the incomplete line APPEARS to begin with another marker, keep it
908 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
909 ;; unnecessary concat during the next call.
911 (if (string-match "\\(stopped\\|signal\\)" gud-marker-acc start)
912 (substring gud-marker-acc (match-beginning 0))
916 ;; Functions for Mips-style dbx. Given the option `-emacs', documented in
917 ;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
919 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
920 ;; We haven't tested gud on this system:
921 (string-match "^mips-[^-]*-riscos" system-configuration)
922 ;; It's documented on OSF/1.3
923 (string-match "^mips-[^-]*-osf1" system-configuration)
924 (string-match "^alpha[^-]*-[^-]*-osf" system-configuration))
925 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
927 (defvar gud-dbx-command-name
928 (concat "dbx" (if gud-mips-p " -emacs")))
930 ;; This is just like the gdb one except for the regexps since we need to cope
931 ;; with an optional breakpoint number in [] before the ^Z^Z
932 (defun gud-mipsdbx-marker-filter (string)
933 (setq gud-marker-acc (concat gud-marker-acc string))
936 ;; Process all the complete markers in this chunk.
938 ;; This is like th gdb marker but with an optional
939 ;; leading break point number like `[1] '
940 "[][ 0-9]*\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
944 ;; Extract the frame position from the marker.
946 (cons (match-string 1 gud-marker-acc)
947 (string-to-number (match-string 2 gud-marker-acc)))
949 ;; Append any text before the marker to the output we're going
950 ;; to return - we don't include the marker in this text.
951 output (concat output
952 (substring gud-marker-acc 0 (match-beginning 0)))
954 ;; Set the accumulator to the remaining text.
955 gud-marker-acc (substring gud-marker-acc (match-end 0))))
957 ;; Does the remaining text look like it might end with the
958 ;; beginning of another marker? If it does, then keep it in
959 ;; gud-marker-acc until we receive the rest of it. Since we
960 ;; know the full marker regexp above failed, it's pretty simple to
961 ;; test for marker starts.
962 (if (string-match "[][ 0-9]*\032.*\\'" gud-marker-acc)
964 ;; Everything before the potential marker start can be output.
965 (setq output (concat output (substring gud-marker-acc
966 0 (match-beginning 0))))
968 ;; Everything after, we save, to combine with later input.
970 (substring gud-marker-acc (match-beginning 0))))
972 (setq output (concat output gud-marker-acc)
977 ;; The dbx in IRIX is a pain. It doesn't print the file name when
978 ;; stopping at a breakpoint (but you do get it from the `up' and
979 ;; `down' commands...). The only way to extract the information seems
980 ;; to be with a `file' command, although the current line number is
981 ;; available in $curline. Thus we have to look for output which
982 ;; appears to indicate a breakpoint. Then we prod the dbx sub-process
983 ;; to output the information we want with a combination of the
984 ;; `printf' and `file' commands as a pseudo marker which we can
985 ;; recognise next time through the marker-filter. This would be like
986 ;; the gdb marker but you can't get the file name without a newline...
987 ;; Note that gud-remove won't work since Irix dbx expects a breakpoint
988 ;; number rather than a line number etc. Maybe this could be made to
989 ;; work by listing all the breakpoints and picking the one(s) with the
990 ;; correct line number, but life's too short.
991 ;; d.love@dl.ac.uk (Dave Love) can be blamed for this
994 (and (string-match "^mips-[^-]*-irix" system-configuration)
995 (not (string-match "irix[6-9]\\.[1-9]" system-configuration)))
996 "Non-nil to assume the interface appropriate for IRIX dbx.
997 This works in IRIX 4, 5 and 6, but `gud-dbx-use-stopformat-p' provides
998 a better solution in 6.1 upwards.")
999 (defvar gud-dbx-use-stopformat-p
1000 (string-match "irix[6-9]\\.[1-9]" system-configuration)
1001 "Non-nil to use the dbx feature present at least from Irix 6.1
1002 whereby $stopformat=1 produces an output format compatiable with
1003 `gud-dbx-marker-filter'.")
1004 ;; [Irix dbx seems to be a moving target. The dbx output changed
1005 ;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
1006 ;; the output from `up' is no longer spotted by gud (and it's probably
1007 ;; not distinctive enough to try to match it -- use C-<, C->
1008 ;; exclusively) . For 5.3 and 6.0, the $curline variable changed to
1009 ;; `long long'(why?!), so the printf stuff needed changing. The line
1010 ;; number was cast to `long' as a compromise between the new `long
1011 ;; long' and the original `int'. This is reported not to work in 6.2,
1012 ;; so it's changed back to int -- don't make your sources too long.
1013 ;; From Irix6.1 (but not 6.0?) dbx supports an undocumented feature
1014 ;; whereby `set $stopformat=1' reportedly produces output compatible
1015 ;; with `gud-dbx-marker-filter', which we prefer.
1017 ;; The process filter is also somewhat
1018 ;; unreliable, sometimes not spotting the markers; I don't know
1019 ;; whether there's anything that can be done about that. It would be
1020 ;; much better if SGI could be persuaded to (re?)instate the MIPS
1021 ;; -emacs flag for gdb-like output (which ought to be possible as most
1022 ;; of the communication I've had over it has been from sgi.com).]
1024 ;; this filter is influenced by the xdb one rather than the gdb one
1025 (defun gud-irixdbx-marker-filter (string)
1026 (let (result (case-fold-search nil))
1027 (if (or (string-match comint-prompt-regexp string)
1028 (string-match ".*\012" string))
1029 (setq result (concat gud-marker-acc string)
1031 (setq gud-marker-acc (concat gud-marker-acc string)))
1034 ;; look for breakpoint or signal indication e.g.:
1035 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
1036 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
1037 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
1039 "^\\(\\[[0-9]+] \\)?Process +[0-9]+ ([^)]*) [^[]+\\[[^]\n]*]\n"
1041 ;; prod dbx into printing out the line number and file
1042 ;; name in a form we can grok as below
1043 (process-send-string (get-buffer-process gud-comint-buffer)
1044 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1045 ;; look for result of, say, "up" e.g.:
1046 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
1047 ;; (this will also catch one of the lines printed by "where")
1049 "^[^ ][^[]*\\[\"\\([^\"]+\\)\":\\([0-9]+\\), [^]]+]\n"
1051 (let ((file (match-string 1 result)))
1052 (if (file-exists-p file)
1053 (setq gud-last-frame
1054 (cons (match-string 1 result)
1055 (string-to-number (match-string 2 result))))))
1057 ((string-match ; kluged-up marker as above
1058 "\032\032\\([0-9]*\\):\\(.*\\)\n" result)
1059 (let ((file (gud-file-name (match-string 2 result))))
1060 (if (and file (file-exists-p file))
1061 (setq gud-last-frame
1063 (string-to-number (match-string 1 result))))))
1064 (setq result (substring result 0 (match-beginning 0))))))
1067 (defvar gud-dgux-p (string-match "-dgux" system-configuration)
1068 "Non-nil means to assume the interface approriate for DG/UX dbx.
1069 This was tested using R4.11.")
1071 ;; There are a couple of differences between DG's dbx output and normal
1072 ;; dbx output which make it nontrivial to integrate this into the
1073 ;; standard dbx-marker-filter (mainly, there are a different number of
1074 ;; backreferences). The markers look like:
1076 ;; (0) Stopped at line 10, routine main(argc=1, argv=0xeffff0e0), file t.c
1078 ;; from breakpoints (the `(0)' there isn't constant, it's the breakpoint
1081 ;; Stopped at line 13, routine main(argc=1, argv=0xeffff0e0), file t.c
1085 ;; Frame 21, line 974, routine command_loop(), file keyboard.c
1087 ;; from up/down/where.
1089 (defun gud-dguxdbx-marker-filter (string)
1090 (setq gud-marker-acc (if gud-marker-acc
1091 (concat gud-marker-acc string)
1093 (let ((re (concat "^\\(\\(([0-9]+) \\)?Stopped at\\|Frame [0-9]+,\\)"
1094 " line \\([0-9]+\\), routine .*, file \\([^ \t\n]+\\)"))
1096 ;; Process all complete markers in this chunk.
1097 (while (string-match re gud-marker-acc start)
1098 (setq gud-last-frame
1099 (cons (match-string 4 gud-marker-acc)
1100 (string-to-number (match-string 3 gud-marker-acc)))
1101 start (match-end 0)))
1103 ;; Search for the last incomplete line in this chunk
1104 (while (string-match "\n" gud-marker-acc start)
1105 (setq start (match-end 0)))
1107 ;; If the incomplete line APPEARS to begin with another marker, keep it
1108 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1109 ;; unnecessary concat during the next call.
1110 (setq gud-marker-acc
1111 (if (string-match "Stopped\\|Frame" gud-marker-acc start)
1112 (substring gud-marker-acc (match-beginning 0))
1117 (defun dbx (command-line)
1118 "Run dbx on program FILE in buffer *gud-FILE*.
1119 The directory containing FILE becomes the initial working directory
1120 and source-file directory for your debugger."
1121 (interactive (list (gud-query-cmdline 'dbx)))
1125 (gud-common-init command-line nil 'gud-mipsdbx-marker-filter))
1127 (gud-common-init command-line 'gud-dbx-massage-args
1128 'gud-irixdbx-marker-filter))
1130 (gud-common-init command-line 'gud-dbx-massage-args
1131 'gud-dguxdbx-marker-filter))
1133 (gud-common-init command-line 'gud-dbx-massage-args
1134 'gud-dbx-marker-filter)))
1136 (set (make-local-variable 'gud-minor-mode) 'dbx)
1140 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1141 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1142 (gud-def gud-break "stop at \"%f\":%l"
1143 "\C-b" "Set breakpoint at current line.")
1144 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
1146 (gud-def gud-break "stop at \"%d%f\":%l"
1147 "\C-b" "Set breakpoint at current line.")
1148 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1149 (gud-def gud-up "up %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1150 "<" "Up (numeric arg) stack frames.")
1151 (gud-def gud-down "down %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1152 ">" "Down (numeric arg) stack frames.")
1153 ;; Make dbx give out the source location info that we need.
1154 (process-send-string (get-buffer-process gud-comint-buffer)
1155 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1157 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1158 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1159 (gud-def gud-break "file \"%d%f\"\nstop at %l"
1160 "\C-b" "Set breakpoint at current line.")
1161 (if gud-dbx-use-stopformat-p
1162 (process-send-string (get-buffer-process gud-comint-buffer)
1163 "set $stopformat=1\n"))))
1165 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
1166 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
1167 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
1168 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
1169 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
1170 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
1171 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
1172 (gud-def gud-run "run" nil "Run the program.")
1174 (setq comint-prompt-regexp "^[^)\n]*dbx) *")
1175 (setq paragraph-start comint-prompt-regexp)
1176 (run-hooks 'dbx-mode-hook)
1179 ;; ======================================================================
1180 ;; xdb (HP PARISC debugger) functions
1182 ;; History of argument lists passed to xdb.
1183 (defvar gud-xdb-history nil)
1185 (defcustom gud-xdb-directories nil
1186 "*A list of directories that xdb should search for source code.
1187 If nil, only source files in the program directory
1188 will be known to xdb.
1190 The file names should be absolute, or relative to the directory
1191 containing the executable being debugged."
1192 :type '(choice (const :tag "Current Directory" nil)
1197 (defun gud-xdb-massage-args (file args)
1198 (nconc (let ((directories gud-xdb-directories)
1201 (setq result (cons (car directories) (cons "-d" result)))
1202 (setq directories (cdr directories)))
1206 ;; xdb does not print the lines all at once, so we have to accumulate them
1207 (defun gud-xdb-marker-filter (string)
1209 (if (or (string-match comint-prompt-regexp string)
1210 (string-match ".*\012" string))
1211 (setq result (concat gud-marker-acc string)
1213 (setq gud-marker-acc (concat gud-marker-acc string)))
1215 (if (or (string-match "\\([^\n \t:]+\\): [^:]+: \\([0-9]+\\)[: ]"
1217 (string-match "[^: \t]+:[ \t]+\\([^:]+\\): [^:]+: \\([0-9]+\\):"
1219 (let ((line (string-to-number (match-string 2 result)))
1220 (file (gud-file-name (match-string 1 result))))
1222 (setq gud-last-frame (cons file line))))))
1226 (defun xdb (command-line)
1227 "Run xdb on program FILE in buffer *gud-FILE*.
1228 The directory containing FILE becomes the initial working directory
1229 and source-file directory for your debugger.
1231 You can set the variable `gud-xdb-directories' to a list of program source
1232 directories if your program contains sources from more than one directory."
1233 (interactive (list (gud-query-cmdline 'xdb)))
1235 (gud-common-init command-line 'gud-xdb-massage-args
1236 'gud-xdb-marker-filter)
1237 (set (make-local-variable 'gud-minor-mode) 'xdb)
1239 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
1240 (gud-def gud-tbreak "b %f:%l\\t" "\C-t"
1241 "Set temporary breakpoint at current line.")
1242 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
1243 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
1244 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1245 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1246 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1247 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1248 (gud-def gud-finish "bu\\t" "\C-f" "Finish executing current function.")
1249 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
1251 (setq comint-prompt-regexp "^>")
1252 (setq paragraph-start comint-prompt-regexp)
1253 (run-hooks 'xdb-mode-hook))
1255 ;; ======================================================================
1258 ;; History of argument lists passed to perldb.
1259 (defvar gud-perldb-history nil)
1261 (defun gud-perldb-massage-args (file args)
1262 "Convert a command line as would be typed normally to run perldb
1263 into one that invokes an Emacs-enabled debugging session.
1264 \"-emacs\" is inserted where it will be $ARGV[0] (see perl5db.pl)."
1265 ;; FIXME: what if the command is `make perldb' and doesn't accept those extra
1267 (let* ((new-args nil)
1269 (shift (lambda () (push (pop args) new-args))))
1271 ;; Pass all switches and -e scripts through.
1273 (string-match "^-" (car args))
1274 (not (equal "-" (car args)))
1275 (not (equal "--" (car args))))
1276 (when (equal "-e" (car args))
1277 ;; -e goes with the next arg, so shift one extra.
1279 ;; -e as the last arg is an error in Perl.
1280 (error "No code specified for -e"))
1286 (string-match "^-" (car args)))
1287 (error "Can't use stdin as the script to debug"))
1288 ;; This is the program name.
1291 ;; If -e specified, make sure there is a -- so -emacs is not taken
1293 (if (and args (equal "--" (car args)))
1295 (and seen-e (push "--" new-args)))
1297 (push "-emacs" new-args)
1301 (nreverse new-args)))
1303 ;; There's no guarantee that Emacs will hand the filter the entire
1304 ;; marker at once; it could be broken up across several strings. We
1305 ;; might even receive a big chunk with several markers in it. If we
1306 ;; receive a chunk of text which looks like it might contain the
1307 ;; beginning of a marker, we save it here between calls to the
1309 (defun gud-perldb-marker-filter (string)
1310 (setq gud-marker-acc (concat gud-marker-acc string))
1313 ;; Process all the complete markers in this chunk.
1314 (while (string-match "\032\032\\(\\([a-zA-Z]:\\)?[^:\n]*\\):\\([0-9]*\\):.*\n"
1318 ;; Extract the frame position from the marker.
1320 (cons (match-string 1 gud-marker-acc)
1321 (string-to-number (match-string 3 gud-marker-acc)))
1323 ;; Append any text before the marker to the output we're going
1324 ;; to return - we don't include the marker in this text.
1325 output (concat output
1326 (substring gud-marker-acc 0 (match-beginning 0)))
1328 ;; Set the accumulator to the remaining text.
1329 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1331 ;; Does the remaining text look like it might end with the
1332 ;; beginning of another marker? If it does, then keep it in
1333 ;; gud-marker-acc until we receive the rest of it. Since we
1334 ;; know the full marker regexp above failed, it's pretty simple to
1335 ;; test for marker starts.
1336 (if (string-match "\032.*\\'" gud-marker-acc)
1338 ;; Everything before the potential marker start can be output.
1339 (setq output (concat output (substring gud-marker-acc
1340 0 (match-beginning 0))))
1342 ;; Everything after, we save, to combine with later input.
1343 (setq gud-marker-acc
1344 (substring gud-marker-acc (match-beginning 0))))
1346 (setq output (concat output gud-marker-acc)
1351 (defcustom gud-perldb-command-name "perl -d"
1352 "Default command to execute a Perl script under debugger."
1357 (defun perldb (command-line)
1358 "Run perldb on program FILE in buffer *gud-FILE*.
1359 The directory containing FILE becomes the initial working directory
1360 and source-file directory for your debugger."
1362 (list (gud-query-cmdline 'perldb
1363 (concat (or (buffer-file-name) "-e 0") " "))))
1365 (gud-common-init command-line 'gud-perldb-massage-args
1366 'gud-perldb-marker-filter)
1367 (set (make-local-variable 'gud-minor-mode) 'perldb)
1369 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
1370 (gud-def gud-remove "B %l" "\C-d" "Remove breakpoint at current line")
1371 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
1372 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
1373 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1374 ; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
1375 ; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
1376 ; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
1377 (gud-def gud-print "p %e" "\C-p" "Evaluate perl expression at point.")
1378 (gud-def gud-until "c %l" "\C-u" "Continue to current line.")
1381 (setq comint-prompt-regexp "^ DB<+[0-9]+>+ ")
1382 (setq paragraph-start comint-prompt-regexp)
1383 (run-hooks 'perldb-mode-hook))
1385 ;; ======================================================================
1386 ;; pdb (Python debugger) functions
1388 ;; History of argument lists passed to pdb.
1389 (defvar gud-pdb-history nil)
1391 ;; Last group is for return value, e.g. "> test.py(2)foo()->None"
1392 ;; Either file or function name may be omitted: "> <string>(0)?()"
1393 (defvar gud-pdb-marker-regexp
1394 "^> \\([-a-zA-Z0-9_/.:\\]*\\|<string>\\)(\\([0-9]+\\))\\([a-zA-Z0-9_]*\\|\\?\\)()\\(->[^\n]*\\)?\n")
1395 (defvar gud-pdb-marker-regexp-file-group 1)
1396 (defvar gud-pdb-marker-regexp-line-group 2)
1397 (defvar gud-pdb-marker-regexp-fnname-group 3)
1399 (defvar gud-pdb-marker-regexp-start "^> ")
1401 ;; There's no guarantee that Emacs will hand the filter the entire
1402 ;; marker at once; it could be broken up across several strings. We
1403 ;; might even receive a big chunk with several markers in it. If we
1404 ;; receive a chunk of text which looks like it might contain the
1405 ;; beginning of a marker, we save it here between calls to the
1407 (defun gud-pdb-marker-filter (string)
1408 (setq gud-marker-acc (concat gud-marker-acc string))
1411 ;; Process all the complete markers in this chunk.
1412 (while (string-match gud-pdb-marker-regexp gud-marker-acc)
1415 ;; Extract the frame position from the marker.
1417 (let ((file (match-string gud-pdb-marker-regexp-file-group
1419 (line (string-to-number
1420 (match-string gud-pdb-marker-regexp-line-group
1422 (if (string-equal file "<string>")
1426 ;; Output everything instead of the below
1427 output (concat output (substring gud-marker-acc 0 (match-end 0)))
1428 ;; ;; Append any text before the marker to the output we're going
1429 ;; ;; to return - we don't include the marker in this text.
1430 ;; output (concat output
1431 ;; (substring gud-marker-acc 0 (match-beginning 0)))
1433 ;; Set the accumulator to the remaining text.
1434 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1436 ;; Does the remaining text look like it might end with the
1437 ;; beginning of another marker? If it does, then keep it in
1438 ;; gud-marker-acc until we receive the rest of it. Since we
1439 ;; know the full marker regexp above failed, it's pretty simple to
1440 ;; test for marker starts.
1441 (if (string-match gud-pdb-marker-regexp-start gud-marker-acc)
1443 ;; Everything before the potential marker start can be output.
1444 (setq output (concat output (substring gud-marker-acc
1445 0 (match-beginning 0))))
1447 ;; Everything after, we save, to combine with later input.
1448 (setq gud-marker-acc
1449 (substring gud-marker-acc (match-beginning 0))))
1451 (setq output (concat output gud-marker-acc)
1456 (defcustom gud-pdb-command-name "pdb"
1457 "File name for executing the Python debugger.
1458 This should be an executable on your path, or an absolute file name."
1463 (defun pdb (command-line)
1464 "Run pdb on program FILE in buffer `*gud-FILE*'.
1465 The directory containing FILE becomes the initial working directory
1466 and source-file directory for your debugger."
1468 (list (gud-query-cmdline 'pdb)))
1470 (gud-common-init command-line nil 'gud-pdb-marker-filter)
1471 (set (make-local-variable 'gud-minor-mode) 'pdb)
1473 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
1474 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
1475 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
1476 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
1477 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
1478 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1479 (gud-def gud-up "up" "<" "Up one stack frame.")
1480 (gud-def gud-down "down" ">" "Down one stack frame.")
1481 (gud-def gud-print "p %e" "\C-p" "Evaluate Python expression at point.")
1483 (gud-def gud-statement "! %e" "\C-e" "Execute Python statement at point.")
1485 ;; (setq comint-prompt-regexp "^(.*pdb[+]?) *")
1486 (setq comint-prompt-regexp "^(Pdb) *")
1487 (setq paragraph-start comint-prompt-regexp)
1488 (run-hooks 'pdb-mode-hook))
1490 ;; ======================================================================
1494 ;; AUTHOR: Derek Davies <ddavies@world.std.com>
1495 ;; Zoltan Kemenczy <zoltan@ieee.org;zkemenczy@rim.net>
1497 ;; CREATED: Sun Feb 22 10:46:38 1998 Derek Davies.
1498 ;; UPDATED: Nov 11, 2001 Zoltan Kemenczy
1499 ;; Dec 10, 2002 Zoltan Kemenczy - added nested class support
1501 ;; INVOCATION NOTES:
1503 ;; You invoke jdb-mode with:
1507 ;; It responds with:
1509 ;; Run jdb (like this): jdb
1511 ;; type any jdb switches followed by the name of the class you'd like to debug.
1512 ;; Supply a fully qualfied classname (these do not have the ".class" extension)
1513 ;; for the name of the class to debug (e.g. "COM.the-kind.ddavies.CoolClass").
1514 ;; See the known problems section below for restrictions when specifying jdb
1515 ;; command line switches (search forward for '-classpath').
1517 ;; You should see something like the following:
1519 ;; Current directory is ~/src/java/hello/
1520 ;; Initializing jdb...
1521 ;; 0xed2f6628:class(hello)
1524 ;; To set an initial breakpoint try:
1526 ;; > stop in hello.main
1527 ;; Breakpoint set in hello.main
1530 ;; To execute the program type:
1535 ;; Breakpoint hit: running ...
1536 ;; hello.main (hello:12)
1538 ;; Type M-n to step over the current line and M-s to step into it. That,
1539 ;; along with the JDB 'help' command should get you started. The 'quit'
1540 ;; JDB command will get out out of the debugger. There is some truly
1541 ;; pathetic JDB documentation available at:
1543 ;; http://java.sun.com/products/jdk/1.1/debugging/
1545 ;; KNOWN PROBLEMS AND FIXME's:
1547 ;; Not sure what happens with inner classes ... haven't tried them.
1549 ;; Does not grok UNICODE id's. Only ASCII id's are supported.
1551 ;; You must not put whitespace between "-classpath" and the path to
1552 ;; search for java classes even though it is required when invoking jdb
1553 ;; from the command line. See gud-jdb-massage-args for details.
1554 ;; The same applies for "-sourcepath".
1556 ;; Note: The following applies only if `gud-jdb-use-classpath' is nil;
1557 ;; refer to the documentation of `gud-jdb-use-classpath' and
1558 ;; `gud-jdb-classpath',`gud-jdb-sourcepath' variables for information
1559 ;; on using the classpath for locating java source files.
1561 ;; If any of the source files in the directories listed in
1562 ;; gud-jdb-directories won't parse you'll have problems. Make sure
1563 ;; every file ending in ".java" in these directories parses without error.
1565 ;; All the .java files in the directories in gud-jdb-directories are
1566 ;; syntactically analyzed each time gud jdb is invoked. It would be
1567 ;; nice to keep as much information as possible between runs. It would
1568 ;; be really nice to analyze the files only as neccessary (when the
1569 ;; source needs to be displayed.) I'm not sure to what extent the former
1570 ;; can be accomplished and I'm not sure the latter can be done at all
1571 ;; since I don't know of any general way to tell which .class files are
1572 ;; defined by which .java file without analyzing all the .java files.
1573 ;; If anyone knows why JavaSoft didn't put the source file names in
1574 ;; debuggable .class files please clue me in so I find something else
1575 ;; to be spiteful and bitter about.
1577 ;; ======================================================================
1578 ;; gud jdb variables and functions
1580 (defcustom gud-jdb-command-name "jdb"
1581 "Command that executes the Java debugger."
1585 (defcustom gud-jdb-use-classpath t
1586 "If non-nil, search for Java source files in classpath directories.
1587 The list of directories to search is the value of `gud-jdb-classpath'.
1588 The file pathname is obtained by converting the fully qualified
1589 class information output by jdb to a relative pathname and appending
1590 it to `gud-jdb-classpath' element by element until a match is found.
1592 This method has a significant jdb startup time reduction advantage
1593 since it does not require the scanning of all `gud-jdb-directories'
1594 and parsing all Java files for class information.
1596 Set to nil to use `gud-jdb-directories' to scan java sources for
1597 class information on jdb startup (original method)."
1601 (defvar gud-jdb-classpath nil
1602 "Java/jdb classpath directories list.
1603 If `gud-jdb-use-classpath' is non-nil, gud-jdb derives the `gud-jdb-classpath'
1604 list automatically using the following methods in sequence
1605 \(with subsequent successful steps overriding the results of previous
1608 1) Read the CLASSPATH environment variable,
1609 2) Read any \"-classpath\" argument used to run jdb,
1610 or detected in jdb output (e.g. if jdb is run by a script
1611 that echoes the actual jdb command before starting jdb)
1612 3) Send a \"classpath\" command to jdb and scan jdb output for
1613 classpath information if jdb is invoked with an \"-attach\" (to
1614 an already running VM) argument (This case typically does not
1615 have a \"-classpath\" command line argument - that is provided
1616 to the VM when it is started).
1618 Note that method 3 cannot be used with oldjdb (or Java 1 jdb) since
1619 those debuggers do not support the classpath command. Use 1) or 2).")
1621 (defvar gud-jdb-sourcepath nil
1622 "Directory list provided by an (optional) \"-sourcepath\" option to jdb.
1623 This list is prepended to `gud-jdb-classpath' to form the complete
1624 list of directories searched for source files.")
1626 (defvar gud-marker-acc-max-length 4000
1627 "Maximum number of debugger output characters to keep.
1628 This variable limits the size of `gud-marker-acc' which holds
1629 the most recent debugger output history while searching for
1630 source file information.")
1632 (defvar gud-jdb-history nil
1633 "History of argument lists passed to jdb.")
1636 ;; List of Java source file directories.
1637 (defvar gud-jdb-directories (list ".")
1638 "*A list of directories that gud jdb should search for source code.
1639 The file names should be absolute, or relative to the current
1642 The set of .java files residing in the directories listed are
1643 syntactically analyzed to determine the classes they define and the
1644 packages in which these classes belong. In this way gud jdb maps the
1645 package-qualified class names output by the jdb debugger to the source
1646 file from which the class originated. This allows gud mode to keep
1647 the source code display in sync with the debugging session.")
1649 (defvar gud-jdb-source-files nil
1650 "List of the java source files for this debugging session.")
1652 ;; Association list of fully qualified class names (package + class name)
1653 ;; and their source files.
1654 (defvar gud-jdb-class-source-alist nil
1655 "Association list of fully qualified class names and source files.")
1657 ;; This is used to hold a source file during analysis.
1658 (defvar gud-jdb-analysis-buffer nil)
1660 (defvar gud-jdb-classpath-string nil
1661 "Holds temporary classpath values.")
1663 (defun gud-jdb-build-source-files-list (path extn)
1664 "Return a list of java source files (absolute paths).
1665 PATH gives the directories in which to search for files with
1666 extension EXTN. Normally EXTN is given as the regular expression
1668 (apply 'nconc (mapcar (lambda (d)
1669 (when (file-directory-p d)
1670 (directory-files d t extn nil)))
1673 ;; Move point past whitespace.
1674 (defun gud-jdb-skip-whitespace ()
1675 (skip-chars-forward " \n\r\t\014"))
1677 ;; Move point past a "// <eol>" type of comment.
1678 (defun gud-jdb-skip-single-line-comment ()
1681 ;; Move point past a "/* */" or "/** */" type of comment.
1682 (defun gud-jdb-skip-traditional-or-documentation-comment ()
1686 (if (eq (following-char) ?*)
1690 (if (eq (following-char) ?/)
1693 (throw 'break nil)))))
1696 ;; Move point past any number of consecutive whitespace chars and/or comments.
1697 (defun gud-jdb-skip-whitespace-and-comments ()
1698 (gud-jdb-skip-whitespace)
1703 (gud-jdb-skip-single-line-comment)
1704 (gud-jdb-skip-whitespace))
1705 ((looking-at "/\\*")
1706 (gud-jdb-skip-traditional-or-documentation-comment)
1707 (gud-jdb-skip-whitespace))
1708 (t (throw 'done nil))))))
1710 ;; Move point past things that are id-like. The intent is to skip regular
1711 ;; id's, such as class or interface names as well as package and interface
1713 (defun gud-jdb-skip-id-ish-thing ()
1714 (skip-chars-forward "^ /\n\r\t\014,;{"))
1716 ;; Move point past a string literal.
1717 (defun gud-jdb-skip-string-literal ()
1720 ((eq (following-char) ?\\)
1722 ((eq (following-char) ?\042))))
1726 ;; Move point past a character literal.
1727 (defun gud-jdb-skip-character-literal ()
1731 (if (eq (following-char) ?\\)
1733 (not (eq (following-char) ?\')))
1737 ;; Move point past the following block. There may be (legal) cruft before
1738 ;; the block's opening brace. There must be a block or it's the end of life
1739 ;; in petticoat junction.
1740 (defun gud-jdb-skip-block ()
1742 ;; Find the begining of the block.
1744 (not (eq (following-char) ?{))
1746 ;; Skip any constructs that can harbor literal block delimiter
1747 ;; characters and/or the delimiters for the constructs themselves.
1750 (gud-jdb-skip-single-line-comment))
1751 ((looking-at "/\\*")
1752 (gud-jdb-skip-traditional-or-documentation-comment))
1753 ((eq (following-char) ?\042)
1754 (gud-jdb-skip-string-literal))
1755 ((eq (following-char) ?\')
1756 (gud-jdb-skip-character-literal))
1757 (t (forward-char))))
1759 ;; Now at the begining of the block.
1762 ;; Skip over the body of the block as well as the final brace.
1763 (let ((open-level 1))
1764 (while (not (eq open-level 0))
1767 (gud-jdb-skip-single-line-comment))
1768 ((looking-at "/\\*")
1769 (gud-jdb-skip-traditional-or-documentation-comment))
1770 ((eq (following-char) ?\042)
1771 (gud-jdb-skip-string-literal))
1772 ((eq (following-char) ?\')
1773 (gud-jdb-skip-character-literal))
1774 ((eq (following-char) ?{)
1775 (setq open-level (+ open-level 1))
1777 ((eq (following-char) ?})
1778 (setq open-level (- open-level 1))
1780 (t (forward-char))))))
1782 ;; Find the package and class definitions in Java source file FILE. Assumes
1783 ;; that FILE contains a legal Java program. BUF is a scratch buffer used
1784 ;; to hold the source during analysis.
1785 (defun gud-jdb-analyze-source (buf file)
1788 (insert-file-contents file nil nil nil t)
1793 (gud-jdb-skip-whitespace)
1797 ;; Any number of semi's following a block is legal. Move point
1798 ;; past them. Note that comments and whitespace may be
1799 ;; interspersed as well.
1800 ((eq (following-char) ?\073)
1803 ;; Move point past a single line comment.
1805 (gud-jdb-skip-single-line-comment))
1807 ;; Move point past a traditional or documentation comment.
1808 ((looking-at "/\\*")
1809 (gud-jdb-skip-traditional-or-documentation-comment))
1811 ;; Move point past a package statement, but save the PackageName.
1812 ((looking-at "package")
1814 (gud-jdb-skip-whitespace-and-comments)
1816 (gud-jdb-skip-id-ish-thing)
1817 (setq p (concat (buffer-substring s (point)) "."))
1818 (gud-jdb-skip-whitespace-and-comments)
1819 (if (eq (following-char) ?\073)
1822 ;; Move point past an import statement.
1823 ((looking-at "import")
1825 (gud-jdb-skip-whitespace-and-comments)
1826 (gud-jdb-skip-id-ish-thing)
1827 (gud-jdb-skip-whitespace-and-comments)
1828 (if (eq (following-char) ?\073)
1831 ;; Move point past the various kinds of ClassModifiers.
1832 ((looking-at "public")
1834 ((looking-at "abstract")
1836 ((looking-at "final")
1839 ;; Move point past a ClassDeclaraction, but save the class
1841 ((looking-at "class")
1843 (gud-jdb-skip-whitespace-and-comments)
1845 (gud-jdb-skip-id-ish-thing)
1847 l (nconc l (list (concat p (buffer-substring s (point)))))))
1848 (gud-jdb-skip-block))
1850 ;; Move point past an interface statement.
1851 ((looking-at "interface")
1853 (gud-jdb-skip-block))
1855 ;; Anything else means the input is invalid.
1857 (message (format "Error parsing file %s." file))
1858 (throw 'abort nil))))))
1861 (defun gud-jdb-build-class-source-alist-for-file (file)
1865 (gud-jdb-analyze-source gud-jdb-analysis-buffer file)))
1867 ;; Return an alist of fully qualified classes and the source files
1868 ;; holding their definitions. SOURCES holds a list of all the source
1869 ;; files to examine.
1870 (defun gud-jdb-build-class-source-alist (sources)
1871 (setq gud-jdb-analysis-buffer (get-buffer-create " *gud-jdb-scratch*"))
1876 'gud-jdb-build-class-source-alist-for-file
1878 (kill-buffer gud-jdb-analysis-buffer)
1879 (setq gud-jdb-analysis-buffer nil)))
1881 ;; Change what was given in the minibuffer to something that can be used to
1882 ;; invoke the debugger.
1883 (defun gud-jdb-massage-args (file args)
1884 ;; The jdb executable must have whitespace between "-classpath" and
1885 ;; its value while gud-common-init expects all switch values to
1886 ;; follow the switch keyword without intervening whitespace. We
1887 ;; require that when the user enters the "-classpath" switch in the
1888 ;; EMACS minibuffer that they do so without the intervening
1889 ;; whitespace. This function adds it back (it's called after
1890 ;; gud-common-init). There are more switches like this (for
1891 ;; instance "-host" and "-password") but I don't care about them
1894 (let (massaged-args user-error)
1896 (while (and args (not user-error))
1898 ((setq user-error (string-match "-classpath$" (car args))))
1899 ((setq user-error (string-match "-sourcepath$" (car args))))
1900 ((string-match "-classpath\\(.+\\)" (car args))
1902 (append massaged-args
1904 (setq gud-jdb-classpath-string
1905 (match-string 1 (car args)))))))
1906 ((string-match "-sourcepath\\(.+\\)" (car args))
1908 (append massaged-args
1910 (setq gud-jdb-sourcepath
1911 (match-string 1 (car args)))))))
1912 (t (setq massaged-args (append massaged-args (list (car args))))))
1913 (setq args (cdr args)))
1915 ;; By this point the current directory is all screwed up. Maybe we
1916 ;; could fix things and re-invoke gud-common-init, but for now I think
1917 ;; issueing the error is good enough.
1920 (kill-buffer (current-buffer))
1921 (error "Error: Omit whitespace between '-classpath or -sourcepath' and its value")))
1924 ;; Search for an association with P, a fully qualified class name, in
1925 ;; gud-jdb-class-source-alist. The asssociation gives the fully
1926 ;; qualified file name of the source file which produced the class.
1927 (defun gud-jdb-find-source-file (p)
1928 (cdr (assoc p gud-jdb-class-source-alist)))
1930 ;; Note: Reset to this value every time a prompt is seen
1931 (defvar gud-jdb-lowest-stack-level 999)
1933 (defun gud-jdb-find-source-using-classpath (p)
1934 "Find source file corresponding to fully qualified class p.
1935 Convert p from jdb's output, converted to a pathname
1936 relative to a classpath directory."
1939 (;; Replace dots with slashes and append ".java" to generate file
1940 ;; name relative to classpath
1943 (mapconcat 'identity
1945 ;; Eliminate any subclass references in the class
1946 ;; name string. These start with a "$"
1948 (if (string-match "$.*" x)
1949 (replace-match "" t t x) p))
1953 (cplist (append gud-jdb-sourcepath gud-jdb-classpath))
1956 (not (setq found-file
1958 (concat (car cplist) "/" filename)))))
1959 (setq cplist (cdr cplist)))
1960 (if found-file (concat (car cplist) "/" filename)))))
1962 (defun gud-jdb-find-source (string)
1963 "Alias for function used to locate source files.
1964 Set to `gud-jdb-find-source-using-classpath' or `gud-jdb-find-source-file'
1965 during jdb initialization depending on the value of
1966 `gud-jdb-use-classpath'."
1969 (defun gud-jdb-parse-classpath-string (string)
1970 "Parse the classpath list and convert each item to an absolute pathname."
1971 (mapcar (lambda (s) (if (string-match "[/\\]$" s)
1972 (replace-match "" nil nil s) s))
1973 (mapcar 'file-truename
1976 (concat "[ \t\n\r,\"" path-separator "]+")))))
1978 ;; See comentary for other debugger's marker filters - there you will find
1979 ;; important notes about STRING.
1980 (defun gud-jdb-marker-filter (string)
1982 ;; Build up the accumulator.
1983 (setq gud-marker-acc
1985 (concat gud-marker-acc string)
1988 ;; Look for classpath information until gud-jdb-classpath-string is found
1989 ;; (interactive, multiple settings of classpath from jdb
1990 ;; not supported/followed)
1991 (if (and gud-jdb-use-classpath
1992 (not gud-jdb-classpath-string)
1993 (or (string-match "classpath:[ \t[]+\\([^]]+\\)" gud-marker-acc)
1994 (string-match "-classpath[ \t\"]+\\([^ \"]+\\)" gud-marker-acc)))
1995 (setq gud-jdb-classpath
1996 (gud-jdb-parse-classpath-string
1997 (setq gud-jdb-classpath-string
1998 (match-string 1 gud-marker-acc)))))
2000 ;; We process STRING from left to right. Each time through the
2001 ;; following loop we process at most one marker. After we've found a
2002 ;; marker, delete gud-marker-acc up to and including the match
2004 ;; Process each complete marker in the input.
2007 ;; Do we see a marker?
2009 ;; jdb puts out a string of the following form when it
2010 ;; hits a breakpoint:
2012 ;; <fully-qualified-class><method> (<class>:<line-number>)
2014 ;; <fully-qualified-class>'s are composed of Java ID's
2015 ;; separated by periods. <method> and <class> are
2016 ;; also Java ID's. <method> begins with a period and
2017 ;; may contain less-than and greater-than (constructors,
2018 ;; for instance, are called <init> in the symbol table.)
2019 ;; Java ID's begin with a letter followed by letters
2020 ;; and/or digits. The set of letters includes underscore
2023 ;; The first group matches <fully-qualified-class>,
2024 ;; the second group matches <class> and the third group
2025 ;; matches <line-number>. We don't care about using
2026 ;; <method> so we don't "group" it.
2028 ;; FIXME: Java ID's are UNICODE strings, this matches ASCII
2031 ;; The ".," in the last square-bracket are necessary because
2032 ;; of Sun's total disrespect for backwards compatibility in
2033 ;; reported line numbers from jdb - starting in 1.4.0 they
2034 ;; print line numbers using LOCALE, inserting a comma or a
2035 ;; period at the thousands positions (how ingenious!).
2037 "\\(\[[0-9]+\] \\)*\\([a-zA-Z0-9.$_]+\\)\\.[a-zA-Z0-9$_<>(),]+ \
2038 \\(([a-zA-Z0-9.$_]+:\\|line=\\)\\([0-9.,]+\\)"
2041 ;; A good marker is one that:
2042 ;; 1) does not have a "[n] " prefix (not part of a stack backtrace)
2043 ;; 2) does have an "[n] " prefix and n is the lowest prefix seen
2044 ;; since the last prompt
2045 ;; Figure out the line on which to position the debugging arrow.
2046 ;; Return the info as a cons of the form:
2048 ;; (<file-name> . <line-number>) .
2049 (if (if (match-beginning 1)
2051 (setq n (string-to-number (substring
2053 (1+ (match-beginning 1))
2054 (- (match-end 1) 2))))
2055 (if (< n gud-jdb-lowest-stack-level)
2056 (progn (setq gud-jdb-lowest-stack-level n) t)))
2058 (if (setq file-found
2059 (gud-jdb-find-source (match-string 2 gud-marker-acc)))
2060 (setq gud-last-frame
2064 ((numstr (match-string 4 gud-marker-acc)))
2065 (if (string-match "[.,]" numstr)
2066 (replace-match "" nil nil numstr)
2068 (message "Could not find source file.")))
2070 ;; Set the accumulator to the remaining text.
2071 (setq gud-marker-acc (substring gud-marker-acc (match-end 0))))
2073 (if (string-match comint-prompt-regexp gud-marker-acc)
2074 (setq gud-jdb-lowest-stack-level 999)))
2076 ;; Do not allow gud-marker-acc to grow without bound. If the source
2077 ;; file information is not within the last 3/4
2078 ;; gud-marker-acc-max-length characters, well,...
2079 (if (> (length gud-marker-acc) gud-marker-acc-max-length)
2080 (setq gud-marker-acc
2081 (substring gud-marker-acc
2082 (- (/ (* gud-marker-acc-max-length 3) 4)))))
2084 ;; We don't filter any debugger output so just return what we were given.
2087 (defvar gud-jdb-command-name "jdb" "Command that executes the Java debugger.")
2090 (defun jdb (command-line)
2091 "Run jdb with command line COMMAND-LINE in a buffer.
2092 The buffer is named \"*gud*\" if no initial class is given or
2093 \"*gud-<initial-class-basename>*\" if there is. If the \"-classpath\"
2094 switch is given, omit all whitespace between it and its value.
2096 See `gud-jdb-use-classpath' and `gud-jdb-classpath' documentation for
2097 information on how jdb accesses source files. Alternatively (if
2098 `gud-jdb-use-classpath' is nil), see `gud-jdb-directories' for the
2099 original source file access method.
2101 For general information about commands available to control jdb from
2102 gud, see `gud-mode'."
2104 (list (gud-query-cmdline 'jdb)))
2105 (setq gud-jdb-classpath nil)
2106 (setq gud-jdb-sourcepath nil)
2108 ;; Set gud-jdb-classpath from the CLASSPATH environment variable,
2109 ;; if CLASSPATH is set.
2110 (setq gud-jdb-classpath-string (getenv "CLASSPATH"))
2111 (if gud-jdb-classpath-string
2112 (setq gud-jdb-classpath
2113 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2114 (setq gud-jdb-classpath-string nil) ; prepare for next
2116 (gud-common-init command-line 'gud-jdb-massage-args
2117 'gud-jdb-marker-filter)
2118 (set (make-local-variable 'gud-minor-mode) 'jdb)
2120 ;; If a -classpath option was provided, set gud-jdb-classpath
2121 (if gud-jdb-classpath-string
2122 (setq gud-jdb-classpath
2123 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2124 (setq gud-jdb-classpath-string nil) ; prepare for next
2125 ;; If a -sourcepath option was provided, parse it
2126 (if gud-jdb-sourcepath
2127 (setq gud-jdb-sourcepath
2128 (gud-jdb-parse-classpath-string gud-jdb-sourcepath)))
2130 (gud-def gud-break "stop at %c:%l" "\C-b" "Set breakpoint at current line.")
2131 (gud-def gud-remove "clear %c:%l" "\C-d" "Remove breakpoint at current line")
2132 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2133 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2134 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
2135 (gud-def gud-finish "step up" "\C-f" "Continue until current method returns.")
2136 (gud-def gud-up "up\C-Mwhere" "<" "Up one stack frame.")
2137 (gud-def gud-down "down\C-Mwhere" ">" "Up one stack frame.")
2138 (gud-def gud-run "run" nil "Run the program.") ;if VM start using jdb
2140 (setq comint-prompt-regexp "^> \\|^[^ ]+\\[[0-9]+\\] ")
2141 (setq paragraph-start comint-prompt-regexp)
2142 (run-hooks 'jdb-mode-hook)
2144 (if gud-jdb-use-classpath
2145 ;; Get the classpath information from the debugger
2147 (if (string-match "-attach" command-line)
2148 (gud-call "classpath"))
2149 (fset 'gud-jdb-find-source
2150 'gud-jdb-find-source-using-classpath))
2152 ;; Else create and bind the class/source association list as well
2153 ;; as the source file list.
2154 (setq gud-jdb-class-source-alist
2155 (gud-jdb-build-class-source-alist
2156 (setq gud-jdb-source-files
2157 (gud-jdb-build-source-files-list gud-jdb-directories
2159 (fset 'gud-jdb-find-source 'gud-jdb-find-source-file)))
2162 ;; ======================================================================
2164 ;; BASHDB support. See http://bashdb.sourceforge.net
2166 ;; AUTHOR: Rocky Bernstein <rocky@panix.com>
2168 ;; CREATED: Sun Nov 10 10:46:38 2002 Rocky Bernstein.
2170 ;; INVOCATION NOTES:
2172 ;; You invoke bashdb-mode with:
2174 ;; M-x bashdb <enter>
2176 ;; It responds with:
2178 ;; Run bashdb (like this): bash
2181 ;; History of argument lists passed to bashdb.
2182 (defvar gud-bashdb-history nil)
2184 ;; Convert a command line as would be typed normally to run a script
2185 ;; into one that invokes an Emacs-enabled debugging session.
2186 ;; "--debugger" in inserted as the first switch.
2188 ;; There's no guarantee that Emacs will hand the filter the entire
2189 ;; marker at once; it could be broken up across several strings. We
2190 ;; might even receive a big chunk with several markers in it. If we
2191 ;; receive a chunk of text which looks like it might contain the
2192 ;; beginning of a marker, we save it here between calls to the
2194 (defun gud-bashdb-marker-filter (string)
2195 (setq gud-marker-acc (concat gud-marker-acc string))
2198 ;; Process all the complete markers in this chunk.
2199 ;; Format of line looks like this:
2200 ;; (/etc/init.d/ntp.init:16):
2201 ;; but we also allow DOS drive letters
2202 ;; (d:/etc/init.d/ntp.init:16):
2203 (while (string-match "\\(^\\|\n\\)(\\(\\([a-zA-Z]:\\)?[^:\n]*\\):\\([0-9]*\\)):.*\n"
2207 ;; Extract the frame position from the marker.
2209 (cons (match-string 2 gud-marker-acc)
2210 (string-to-number (match-string 4 gud-marker-acc)))
2212 ;; Append any text before the marker to the output we're going
2213 ;; to return - we don't include the marker in this text.
2214 output (concat output
2215 (substring gud-marker-acc 0 (match-beginning 0)))
2217 ;; Set the accumulator to the remaining text.
2218 gud-marker-acc (substring gud-marker-acc (match-end 0))))
2220 ;; Does the remaining text look like it might end with the
2221 ;; beginning of another marker? If it does, then keep it in
2222 ;; gud-marker-acc until we receive the rest of it. Since we
2223 ;; know the full marker regexp above failed, it's pretty simple to
2224 ;; test for marker starts.
2225 (if (string-match "\032.*\\'" gud-marker-acc)
2227 ;; Everything before the potential marker start can be output.
2228 (setq output (concat output (substring gud-marker-acc
2229 0 (match-beginning 0))))
2231 ;; Everything after, we save, to combine with later input.
2232 (setq gud-marker-acc
2233 (substring gud-marker-acc (match-beginning 0))))
2235 (setq output (concat output gud-marker-acc)
2240 (defcustom gud-bashdb-command-name "bash --debugger"
2241 "File name for executing bash debugger."
2246 (defun bashdb (command-line)
2247 "Run bashdb on program FILE in buffer *gud-FILE*.
2248 The directory containing FILE becomes the initial working directory
2249 and source-file directory for your debugger."
2251 (list (read-from-minibuffer "Run bashdb (like this): "
2252 (if (consp gud-bashdb-history)
2253 (car gud-bashdb-history)
2254 (concat gud-bashdb-command-name
2256 gud-minibuffer-local-map nil
2257 '(gud-bashdb-history . 1))))
2259 (gud-common-init command-line nil 'gud-bashdb-marker-filter)
2261 (set (make-local-variable 'gud-minor-mode) 'bashdb)
2263 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
2264 (gud-def gud-tbreak "tbreak %l" "\C-t" "Set temporary breakpoint at current line.")
2265 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
2266 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2267 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2268 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
2269 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
2270 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
2271 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
2272 (gud-def gud-print "x %e" "\C-p" "Evaluate BASH expression at point.")
2275 (gud-def gud-statement "eval %e" "\C-e" "Execute BASH statement at point.")
2277 (setq comint-prompt-regexp "^bashdb<+(*[0-9]+)*>+ ")
2278 (setq paragraph-start comint-prompt-regexp)
2279 (run-hooks 'bashdb-mode-hook)
2283 ;; End of debugger-specific information
2287 ;; When we send a command to the debugger via gud-call, it's annoying
2288 ;; to see the command and the new prompt inserted into the debugger's
2289 ;; buffer; we have other ways of knowing the command has completed.
2291 ;; If the buffer looks like this:
2292 ;; --------------------
2293 ;; (gdb) set args foo bar
2295 ;; --------------------
2296 ;; (the -!- marks the location of point), and we type `C-x SPC' in a
2297 ;; source file to set a breakpoint, we want the buffer to end up like
2299 ;; --------------------
2300 ;; (gdb) set args foo bar
2301 ;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
2303 ;; --------------------
2304 ;; Essentially, the old prompt is deleted, and the command's output
2305 ;; and the new prompt take its place.
2307 ;; Not echoing the command is easy enough; you send it directly using
2308 ;; process-send-string, and it never enters the buffer. However,
2309 ;; getting rid of the old prompt is trickier; you don't want to do it
2310 ;; when you send the command, since that will result in an annoying
2311 ;; flicker as the prompt is deleted, redisplay occurs while Emacs
2312 ;; waits for a response from the debugger, and the new prompt is
2313 ;; inserted. Instead, we'll wait until we actually get some output
2314 ;; from the subprocess before we delete the prompt. If the command
2315 ;; produced no output other than a new prompt, that prompt will most
2316 ;; likely be in the first chunk of output received, so we will delete
2317 ;; the prompt and then replace it with an identical one. If the
2318 ;; command produces output, the prompt is moving anyway, so the
2319 ;; flicker won't be annoying.
2321 ;; So - when we want to delete the prompt upon receipt of the next
2322 ;; chunk of debugger output, we position gud-delete-prompt-marker at
2323 ;; the start of the prompt; the process filter will notice this, and
2324 ;; delete all text between it and the process output marker. If
2325 ;; gud-delete-prompt-marker points nowhere, we leave the current
2327 (defvar gud-delete-prompt-marker nil)
2330 (put 'gud-mode 'mode-class 'special)
2332 (define-derived-mode gud-mode comint-mode "Debugger"
2333 "Major mode for interacting with an inferior debugger process.
2335 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
2336 M-x perldb, M-x xdb, or M-x jdb. Each entry point finishes by executing a
2337 hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook',
2338 `perldb-mode-hook', `xdb-mode-hook', or `jdb-mode-hook' respectively.
2340 After startup, the following commands are available in both the GUD
2341 interaction buffer and any source buffer GUD visits due to a breakpoint stop
2344 \\[gud-break] sets a breakpoint at the current file and line. In the
2345 GUD buffer, the current file and line are those of the last breakpoint or
2346 step. In a source buffer, they are the buffer's file and current line.
2348 \\[gud-remove] removes breakpoints on the current file and line.
2350 \\[gud-refresh] displays in the source window the last line referred to
2353 \\[gud-step], \\[gud-next], and \\[gud-stepi] do a step-one-line,
2354 step-one-line (not entering function calls), and step-one-instruction
2355 and then update the source window with the current file and position.
2356 \\[gud-cont] continues execution.
2358 \\[gud-print] tries to find the largest C lvalue or function-call expression
2359 around point, and sends it to the debugger for value display.
2361 The above commands are common to all supported debuggers except xdb which
2362 does not support stepping instructions.
2364 Under gdb, sdb and xdb, \\[gud-tbreak] behaves exactly like \\[gud-break],
2365 except that the breakpoint is temporary; that is, it is removed when
2366 execution stops on it.
2368 Under gdb, dbx, and xdb, \\[gud-up] pops up through an enclosing stack
2369 frame. \\[gud-down] drops back down through one.
2371 If you are using gdb or xdb, \\[gud-finish] runs execution to the return from
2372 the current function and stops.
2374 All the keystrokes above are accessible in the GUD buffer
2375 with the prefix C-c, and in all buffers through the prefix C-x C-a.
2377 All pre-defined functions for which the concept make sense repeat
2378 themselves the appropriate number of times if you give a prefix
2381 You may use the `gud-def' macro in the initialization hook to define other
2384 Other commands for interacting with the debugger process are inherited from
2385 comint mode, which see."
2386 (setq mode-line-process '(":%s"))
2387 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
2388 (set (make-local-variable 'gud-last-frame) nil)
2389 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
2390 (make-local-variable 'comint-prompt-regexp)
2391 ;; Don't put repeated commands in command history many times.
2392 (set (make-local-variable 'comint-input-ignoredups) t)
2393 (make-local-variable 'paragraph-start)
2394 (set (make-local-variable 'gud-delete-prompt-marker) (make-marker))
2395 (add-hook 'kill-buffer-hook 'gud-kill-buffer-hook nil t))
2397 ;; Cause our buffers to be displayed, by default,
2398 ;; in the selected window.
2399 ;;;###autoload (add-hook 'same-window-regexps "\\*gud-.*\\*\\(\\|<[0-9]+>\\)")
2401 (defcustom gud-chdir-before-run t
2402 "Non-nil if GUD should `cd' to the debugged executable."
2406 (defvar gud-target-name "--unknown--"
2407 "The apparent name of the program being debugged in a gud buffer.")
2409 ;; Perform initializations common to all debuggers.
2410 ;; The first arg is the specified command line,
2411 ;; which starts with the program to debug.
2412 ;; The other three args specify the values to use
2413 ;; for local variables in the debugger buffer.
2414 (defun gud-common-init (command-line massage-args marker-filter
2415 &optional find-file)
2416 (let* ((words (split-string command-line))
2417 (program (car words))
2418 (dir default-directory)
2419 ;; Extract the file name from WORDS
2420 ;; and put t in its place.
2421 ;; Later on we will put the modified file name arg back there.
2422 (file-word (let ((w (cdr words)))
2423 (while (and w (= ?- (aref (car w) 0)))
2429 (and file-word (substitute-in-file-name file-word)))
2431 ;; If a directory was specified, expand the file name.
2432 ;; Otherwise, don't expand it, so GDB can use the PATH.
2433 ;; A file name without directory is literally valid
2434 ;; only if the file exists in ., and in that case,
2435 ;; omitting the expansion here has no visible effect.
2436 (file (and file-word
2437 (if (file-name-directory file-subst)
2438 (expand-file-name file-subst)
2440 (filepart (and file-word (concat "-" (file-name-nondirectory file))))
2441 (existing-buffer (get-buffer (concat "*gud" filepart "*"))))
2442 (pop-to-buffer (concat "*gud" filepart "*"))
2443 (when (and existing-buffer (get-buffer-process existing-buffer))
2444 (error "This program is already running under gdb"))
2445 ;; Set the dir, in case the buffer already existed with a different dir.
2446 (setq default-directory dir)
2447 ;; Set default-directory to the file's directory.
2449 gud-chdir-before-run
2450 ;; Don't set default-directory if no directory was specified.
2451 ;; In that case, either the file is found in the current directory,
2452 ;; in which case this setq is a no-op,
2453 ;; or it is found by searching PATH,
2454 ;; in which case we don't know what directory it was found in.
2455 (file-name-directory file)
2456 (setq default-directory (file-name-directory file)))
2457 (or (bolp) (newline))
2458 (insert "Current directory is " default-directory "\n")
2459 ;; Put the substituted and expanded file name back in its place.
2461 (while (and w (not (eq (car w) t)))
2465 (apply 'make-comint (concat "gud" filepart) program nil
2466 (if massage-args (funcall massage-args file args) args))
2467 ;; Since comint clobbered the mode, we don't set it until now.
2469 (set (make-local-variable 'gud-target-name)
2470 (and file-word (file-name-nondirectory file))))
2471 (set (make-local-variable 'gud-marker-filter) marker-filter)
2472 (if find-file (set (make-local-variable 'gud-find-file) find-file))
2473 (setq gud-running nil)
2474 (setq gud-last-last-frame nil)
2476 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
2477 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
2480 (defun gud-set-buffer ()
2481 (when (eq major-mode 'gud-mode)
2482 (setq gud-comint-buffer (current-buffer))))
2484 (defvar gud-filter-defer-flag nil
2485 "Non-nil means don't process anything from the debugger right now.
2486 It is saved for when this flag is not set.")
2488 ;; These functions are responsible for inserting output from your debugger
2489 ;; into the buffer. The hard work is done by the method that is
2490 ;; the value of gud-marker-filter.
2492 (defun gud-filter (proc string)
2493 ;; Here's where the actual buffer insertion is done
2494 (let (output process-window)
2495 (if (buffer-name (process-buffer proc))
2496 (if gud-filter-defer-flag
2497 ;; If we can't process any text now,
2498 ;; save it for later.
2499 (setq gud-filter-pending-text
2500 (concat (or gud-filter-pending-text "") string))
2502 ;; If we have to ask a question during the processing,
2503 ;; defer any additional text that comes from the debugger
2504 ;; during that time.
2505 (let ((gud-filter-defer-flag t))
2506 ;; Process now any text we previously saved up.
2507 (if gud-filter-pending-text
2508 (setq string (concat gud-filter-pending-text string)
2509 gud-filter-pending-text nil))
2511 (with-current-buffer (process-buffer proc)
2512 ;; If we have been so requested, delete the debugger prompt.
2515 (if (marker-buffer gud-delete-prompt-marker)
2517 (delete-region (process-mark proc)
2518 gud-delete-prompt-marker)
2519 (set-marker gud-delete-prompt-marker nil)))
2520 ;; Save the process output, checking for source file markers.
2521 (setq output (gud-marker-filter string))
2522 ;; Check for a filename-and-line number.
2523 ;; Don't display the specified file
2524 ;; unless (1) point is at or after the position where output appears
2525 ;; and (2) this buffer is on the screen.
2526 (setq process-window
2528 (>= (point) (process-mark proc))
2529 (get-buffer-window (current-buffer)))))
2531 ;; Let the comint filter do the actual insertion.
2532 ;; That lets us inherit various comint features.
2533 (comint-output-filter proc output))
2535 ;; Put the arrow on the source line.
2536 ;; This must be outside of the save-excursion
2537 ;; in case the source file is our current buffer.
2539 (with-selected-window process-window
2540 (gud-display-frame))
2541 ;; We have to be in the proper buffer, (process-buffer proc),
2542 ;; but not in a save-excursion, because that would restore point.
2543 (with-current-buffer (process-buffer proc)
2544 (gud-display-frame))))
2546 ;; If we deferred text that arrived during this processing,
2548 (if gud-filter-pending-text
2549 (gud-filter proc ""))))))
2551 (defvar gud-minor-mode-type nil)
2552 (defvar gud-overlay-arrow-position nil)
2553 (add-to-list 'overlay-arrow-variable-list 'gud-overlay-arrow-position)
2555 (defun gud-sentinel (proc msg)
2556 (cond ((null (buffer-name (process-buffer proc)))
2558 ;; Stop displaying an arrow in a source file.
2559 (setq gud-overlay-arrow-position nil)
2560 (set-process-buffer proc nil)
2561 (if (memq gud-minor-mode-type '(gdbmi gdba))
2564 ((memq (process-status proc) '(signal exit))
2565 ;; Stop displaying an arrow in a source file.
2566 (setq gud-overlay-arrow-position nil)
2567 (with-current-buffer gud-comint-buffer
2568 (if (memq gud-minor-mode-type '(gdbmi gdba))
2571 (let* ((obuf (current-buffer)))
2572 ;; save-excursion isn't the right thing if
2573 ;; process-buffer is current-buffer
2576 ;; Write something in *compilation* and hack its mode line,
2577 (set-buffer (process-buffer proc))
2578 ;; Fix the mode line.
2579 (setq mode-line-process
2581 (symbol-name (process-status proc))))
2582 (force-mode-line-update)
2584 (insert ?\n mode-name " " msg)
2586 (goto-char (point-max))
2587 (insert ?\n mode-name " " msg)))
2588 ;; If buffer and mode line will show that the process
2589 ;; is dead, we can delete it now. Otherwise it
2590 ;; will stay around until M-x list-processes.
2591 (delete-process proc))
2592 ;; Restore old buffer, but don't restore old point
2593 ;; if obuf is the gud buffer.
2594 (set-buffer obuf))))))
2596 (defun gud-kill-buffer-hook ()
2597 (setq gud-minor-mode-type gud-minor-mode)
2599 (kill-process (get-buffer-process gud-comint-buffer))
2603 (dolist (buffer (buffer-list))
2604 (unless (eq buffer gud-comint-buffer)
2605 (with-current-buffer buffer
2606 (when gud-minor-mode
2607 (setq gud-minor-mode nil)
2608 (kill-local-variable 'tool-bar-map))))))
2610 (defun gud-display-frame ()
2611 "Find and obey the last filename-and-line marker from the debugger.
2612 Obeying it means displaying in another window the specified file and line."
2614 (when gud-last-frame
2616 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
2617 (setq gud-last-last-frame gud-last-frame
2618 gud-last-frame nil)))
2620 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
2621 ;; and that its line LINE is visible.
2622 ;; Put the overlay-arrow on the line LINE in that buffer.
2623 ;; Most of the trickiness in here comes from wanting to preserve the current
2624 ;; region-restriction if that's possible. We use an explicit display-buffer
2625 ;; to get around the fact that this is called inside a save-excursion.
2627 (defun gud-display-line (true-file line)
2628 (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
2630 (with-current-buffer gud-comint-buffer
2631 (gud-find-file true-file)))
2632 (window (and buffer (or (get-buffer-window buffer)
2633 (display-buffer buffer))))
2637 (with-current-buffer buffer
2638 (unless (or (verify-visited-file-modtime buffer) gud-keep-buffer)
2640 (format "File %s changed on disk. Reread from disk? "
2643 (setq gud-keep-buffer t)))
2648 (or gud-overlay-arrow-position
2649 (setq gud-overlay-arrow-position (make-marker)))
2650 (set-marker gud-overlay-arrow-position (point) (current-buffer)))
2651 (cond ((or (< pos (point-min)) (> pos (point-max)))
2654 (if window (set-window-point window gud-overlay-arrow-position))))))
2656 ;; The gud-call function must do the right thing whether its invoking
2657 ;; keystroke is from the GUD buffer itself (via major-mode binding)
2658 ;; or a C buffer. In the former case, we want to supply data from
2659 ;; gud-last-frame. Here's how we do it:
2661 (defun gud-format-command (str arg)
2662 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
2663 (frame (or gud-last-frame gud-last-last-frame))
2665 (while (and str (string-match "\\([^%]*\\)%\\([adeflpc]\\)" str))
2666 (let ((key (string-to-char (match-string 2 str)))
2670 (setq subst (file-name-nondirectory (if insource
2674 (setq subst (file-name-sans-extension
2675 (file-name-nondirectory (if insource
2679 (setq subst (file-name-directory (if insource
2683 (setq subst (int-to-string
2687 (+ (count-lines (point-min) (point))
2691 (setq subst (gud-find-expr)))
2693 (setq subst (gud-read-address)))
2703 (+ (count-lines (point-min) (point))
2707 (setq subst (if arg (int-to-string arg)))))
2708 (setq result (concat result (match-string 1 str) subst)))
2709 (setq str (substring str (match-end 2))))
2710 ;; There might be text left in STR when the loop ends.
2711 (concat result str)))
2713 (defun gud-read-address ()
2714 "Return a string containing the core-address found in the buffer at point."
2717 (let ((pt (point)) found begin)
2718 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
2720 (found (forward-char 2)
2721 (buffer-substring found
2722 (progn (re-search-forward "[^0-9a-f]")
2725 (t (setq begin (progn (re-search-backward "[^0-9]")
2729 (re-search-forward "[^0-9]")
2731 (buffer-substring begin (point))))))))
2733 (defun gud-call (fmt &optional arg)
2734 (let ((msg (gud-format-command fmt arg)))
2735 (message "Command: %s" msg)
2737 (gud-basic-call msg)))
2739 (defun gud-basic-call (command)
2740 "Invoke the debugger COMMAND displaying source in other window."
2743 (let ((proc (get-buffer-process gud-comint-buffer)))
2744 (or proc (error "Current buffer has no process"))
2745 ;; Arrange for the current prompt to get deleted.
2747 (set-buffer gud-comint-buffer)
2750 (goto-char (process-mark proc))
2752 (if (looking-at comint-prompt-regexp)
2753 (set-marker gud-delete-prompt-marker (point)))
2754 (if (memq gud-minor-mode '(gdbmi gdba))
2755 (apply comint-input-sender (list proc command))
2756 (process-send-string proc (concat command "\n")))))))
2758 (defun gud-refresh (&optional arg)
2759 "Fix up a possibly garbled display, and redraw the arrow."
2761 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
2765 ;; Code for parsing expressions out of C or Fortran code. The single entry
2766 ;; point is gud-find-expr, which tries to return an lvalue expression from
2769 (defvar gud-find-expr-function 'gud-find-c-expr)
2771 (defun gud-find-expr (&rest args)
2772 (apply gud-find-expr-function args))
2774 ;; The next eight functions are hacked from gdbsrc.el by
2775 ;; Debby Ayers <ayers@asc.slb.com>,
2776 ;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
2778 (defun gud-find-c-expr ()
2779 "Returns the expr that surrounds point."
2783 (expr (gud-innermost-expr))
2784 (test-expr (gud-prev-expr)))
2785 (while (and test-expr (gud-expr-compound test-expr expr))
2786 (let ((prev-expr expr))
2787 (setq expr (cons (car test-expr) (cdr expr)))
2788 (goto-char (car expr))
2789 (setq test-expr (gud-prev-expr))
2790 ;; If we just pasted on the condition of an if or while,
2791 ;; throw it away again.
2792 (if (member (buffer-substring (car test-expr) (cdr test-expr))
2793 '("if" "while" "for"))
2797 (setq test-expr (gud-next-expr))
2798 (while (gud-expr-compound expr test-expr)
2799 (setq expr (cons (car expr) (cdr test-expr)))
2800 (setq test-expr (gud-next-expr)))
2801 (buffer-substring (car expr) (cdr expr)))))
2803 (defun gud-innermost-expr ()
2804 "Returns the smallest expr that point is in; move point to beginning of it.
2805 The expr is represented as a cons cell, where the car specifies the point in
2806 the current buffer that marks the beginning of the expr and the cdr specifies
2807 the character after the end of the expr."
2808 (let ((p (point)) begin end)
2810 (setq begin (point))
2823 (defun gud-backward-sexp ()
2824 "Version of `backward-sexp' that catches errors."
2829 (defun gud-forward-sexp ()
2830 "Version of `forward-sexp' that catches errors."
2835 (defun gud-prev-expr ()
2836 "Returns the previous expr, point is set to beginning of that expr.
2837 The expr is represented as a cons cell, where the car specifies the point in
2838 the current buffer that marks the beginning of the expr and the cdr specifies
2839 the character after the end of the expr"
2840 (let ((begin) (end))
2842 (setq begin (point))
2848 (defun gud-next-expr ()
2849 "Returns the following expr, point is set to beginning of that expr.
2850 The expr is represented as a cons cell, where the car specifies the point in
2851 the current buffer that marks the beginning of the expr and the cdr specifies
2852 the character after the end of the expr."
2853 (let ((begin) (end))
2858 (setq begin (point))
2861 (defun gud-expr-compound-sep (span-start span-end)
2862 "Scan from SPAN-START to SPAN-END for punctuation characters.
2863 If `->' is found, return `?.'. If `.' is found, return `?.'.
2864 If any other punctuation is found, return `??'.
2865 If no punctuation is found, return `? '."
2868 (while (< span-start span-end)
2869 (setq syntax (char-syntax (char-after span-start)))
2872 ((= syntax ?.) (setq syntax (char-after span-start))
2874 ((= syntax ?.) (setq result ?.))
2875 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
2877 (setq span-start (+ span-start 1)))
2878 (t (setq span-start span-end)
2879 (setq result ??)))))
2880 (setq span-start (+ span-start 1)))
2883 (defun gud-expr-compound (first second)
2884 "Non-nil if concatenating FIRST and SECOND makes a single C expression.
2885 The two exprs are represented as a cons cells, where the car
2886 specifies the point in the current buffer that marks the beginning of the
2887 expr and the cdr specifies the character after the end of the expr.
2888 Link exprs of the form:
2895 (let ((span-start (cdr first))
2896 (span-end (car second))
2898 (setq syntax (gud-expr-compound-sep span-start span-end))
2900 ((= (car first) (car second)) nil)
2901 ((= (cdr first) (cdr second)) nil)
2904 (setq span-start (char-after (- span-start 1)))
2905 (setq span-end (char-after span-end))
2907 ((= span-start ?)) t)
2908 ((= span-start ?]) t)
2914 (defun gud-find-class (f line)
2915 "Find fully qualified class in file F at line LINE.
2916 This function uses the `gud-jdb-classpath' (and optional
2917 `gud-jdb-sourcepath') list(s) to derive a file
2918 pathname relative to its classpath directory. The values in
2919 `gud-jdb-classpath' are assumed to have been converted to absolute
2920 pathname standards using file-truename.
2921 If F is visited by a buffer and its mode is CC-mode(Java),
2922 syntactic information of LINE is used to find the enclosing (nested)
2923 class string which is appended to the top level
2924 class of the file (using s to separate nested class ids)."
2925 ;; Convert f to a standard representation and remove suffix
2926 (if (and gud-jdb-use-classpath (or gud-jdb-classpath gud-jdb-sourcepath))
2928 (let ((cplist (append gud-jdb-sourcepath gud-jdb-classpath))
2929 (fbuffer (get-file-buffer f))
2930 syntax-symbol syntax-point class-found)
2931 (setq f (file-name-sans-extension (file-truename f)))
2932 ;; Syntax-symbol returns the symbol of the *first* element
2933 ;; in the syntactical analysis result list, syntax-point
2934 ;; returns the buffer position of same
2935 (fset 'syntax-symbol (lambda (x) (c-langelem-sym (car x))))
2936 (fset 'syntax-point (lambda (x) (c-langelem-pos (car x))))
2937 ;; Search through classpath list for an entry that is
2939 (while (and cplist (not class-found))
2940 (if (string-match (car cplist) f)
2942 (mapconcat 'identity
2944 (substring f (+ (match-end 0) 1))
2946 (setq cplist (cdr cplist)))
2947 ;; if f is visited by a java(cc-mode) buffer, walk up the
2948 ;; syntactic information chain and collect any 'inclass
2949 ;; symbols until 'topmost-intro is reached to find out if
2950 ;; point is within a nested class
2951 (if (and fbuffer (equal (symbol-file 'java-mode) "cc-mode"))
2953 (set-buffer fbuffer)
2954 (let ((nclass) (syntax))
2955 ;; While the c-syntactic information does not start
2956 ;; with the 'topmost-intro symbol, there may be
2957 ;; nested classes...
2958 (while (not (eq 'topmost-intro
2959 (syntax-symbol (c-guess-basic-syntax))))
2960 ;; Check if the current position c-syntactic
2961 ;; analysis has 'inclass
2962 (setq syntax (c-guess-basic-syntax))
2964 (and (not (eq 'inclass (syntax-symbol syntax)))
2966 (setq syntax (cdr syntax)))
2967 (if (eq 'inclass (syntax-symbol syntax))
2969 (goto-char (syntax-point syntax))
2970 ;; Now we're at the beginning of a class
2971 ;; definition. Find class name
2973 "[A-Za-z0-9 \t\n]*?class[ \t\n]+\\([^ \t\n]+\\)")
2975 (append (list (match-string-no-properties 1))
2977 (setq syntax (c-guess-basic-syntax))
2978 (while (and (not (syntax-point syntax)) (cdr syntax))
2979 (setq syntax (cdr syntax)))
2980 (goto-char (syntax-point syntax))
2982 (string-match (concat (car nclass) "$") class-found)
2984 (replace-match (mapconcat 'identity nclass "$")
2985 t t class-found)))))
2986 (if (not class-found)
2987 (message "gud-find-class: class for file %s not found!" f))
2989 ;; Not using classpath - try class/source association list
2990 (let ((class-found (rassoc f gud-jdb-class-source-alist)))
2993 (message "gud-find-class: class for file %s not found in gud-jdb-class-source-alist!" f)
2997 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2998 ;;; GDB script mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2999 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3001 (defvar gdb-script-mode-syntax-table
3002 (let ((st (make-syntax-table)))
3003 (modify-syntax-entry ?' "\"" st)
3004 (modify-syntax-entry ?# "<" st)
3005 (modify-syntax-entry ?\n ">" st)
3008 (defvar gdb-script-font-lock-keywords
3009 '(("^define\\s-+\\(\\(\\w\\|\\s_\\)+\\)" (1 font-lock-function-name-face))
3010 ("\\$\\(\\w+\\)" (1 font-lock-variable-name-face))
3011 ("^\\s-*\\([a-z]+\\)" (1 font-lock-keyword-face))))
3013 (defvar gdb-script-font-lock-syntactic-keywords
3014 '(("^document\\s-.*\\(\n\\)" (1 "< b"))
3015 ;; It would be best to change the \n in front, but it's more difficult.
3016 ("^en\\(d\\)\\>" (1 "> b"))))
3018 (defun gdb-script-font-lock-syntactic-face (state)
3020 ((nth 3 state) font-lock-string-face)
3021 ((nth 7 state) font-lock-doc-face)
3022 (t font-lock-comment-face)))
3024 (defvar gdb-script-basic-indent 2)
3026 (defun gdb-script-skip-to-head ()
3027 "We're just in front of an `end' and we need to go to its head."
3028 (while (and (re-search-backward "^\\s-*\\(\\(end\\)\\|define\\|document\\|if\\|while\\)\\>" nil 'move)
3030 (gdb-script-skip-to-head)))
3032 (defun gdb-script-calculate-indentation ()
3034 ((looking-at "end\\>")
3035 (gdb-script-skip-to-head)
3036 (current-indentation))
3037 ((looking-at "else\\>")
3038 (while (and (re-search-backward "^\\s-*\\(if\\|\\(end\\)\\)\\>" nil 'move)
3040 (gdb-script-skip-to-head))
3041 (current-indentation))
3043 (forward-comment (- (point-max)))
3045 (skip-chars-forward " \t")
3046 (+ (current-indentation)
3047 (if (looking-at "\\(if\\|while\\|define\\|else\\)\\>")
3048 gdb-script-basic-indent 0)))))
3050 (defun gdb-script-indent-line ()
3051 "Indent current line of GDB script."
3053 (if (and (eq (get-text-property (point) 'face) font-lock-doc-face)
3056 (skip-chars-forward " \t")
3057 (not (looking-at "end\\>"))))
3059 (let* ((savep (point))
3060 (indent (condition-case nil
3063 (skip-chars-forward " \t")
3064 (if (>= (point) savep) (setq savep nil))
3065 (max (gdb-script-calculate-indentation) 0))
3068 (save-excursion (indent-line-to indent))
3069 (indent-line-to indent)))))
3071 ;; Derived from cfengine.el.
3072 (defun gdb-script-beginning-of-defun ()
3073 "`beginning-of-defun' function for Gdb script mode.
3074 Treats actions as defuns."
3075 (unless (<= (current-column) (current-indentation))
3077 (if (re-search-backward "^define \\|^document " nil t)
3079 (goto-char (point-min)))
3082 ;; Derived from cfengine.el.
3083 (defun gdb-script-end-of-defun ()
3084 "`end-of-defun' function for Gdb script mode.
3085 Treats actions as defuns."
3087 (if (re-search-forward "^end" nil t)
3089 (goto-char (point-max)))
3093 (add-to-list 'auto-mode-alist '("/\\.gdbinit" . gdb-script-mode))
3096 (define-derived-mode gdb-script-mode nil "GDB-Script"
3097 "Major mode for editing GDB scripts"
3098 (set (make-local-variable 'comment-start) "#")
3099 (set (make-local-variable 'comment-start-skip) "#+\\s-*")
3100 (set (make-local-variable 'outline-regexp) "[ \t]")
3101 (set (make-local-variable 'imenu-generic-expression)
3102 '((nil "^define[ \t]+\\(\\w+\\)" 1)))
3103 (set (make-local-variable 'indent-line-function) 'gdb-script-indent-line)
3104 (set (make-local-variable 'beginning-of-defun-function)
3105 #'gdb-script-beginning-of-defun)
3106 (set (make-local-variable 'end-of-defun-function)
3107 #'gdb-script-end-of-defun)
3108 (set (make-local-variable 'font-lock-defaults)
3109 '(gdb-script-font-lock-keywords nil nil ((?_ . "w")) nil
3110 (font-lock-syntactic-keywords
3111 . gdb-script-font-lock-syntactic-keywords)
3112 (font-lock-syntactic-face-function
3113 . gdb-script-font-lock-syntactic-face))))
3116 ;;; tooltips for GUD
3118 ;;; Customizable settings
3119 (defcustom gud-tooltip-modes '(gud-mode c-mode c++-mode fortran-mode)
3120 "List of modes for which to enable GUD tips."
3125 (defcustom gud-tooltip-display
3126 '((eq (tooltip-event-buffer gud-tooltip-event)
3127 (marker-buffer gud-overlay-arrow-position)))
3128 "List of forms determining where GUD tooltips are displayed.
3130 Forms in the list are combined with AND. The default is to display
3131 only tooltips in the buffer containing the overlay arrow."
3133 :tag "GUD buffers predicate"
3136 (defcustom gud-tooltip-echo-area nil
3137 "Use the echo area instead of frames for GUD tooltips."
3139 :tag "Use echo area"
3142 (define-obsolete-variable-alias 'tooltip-gud-modes
3143 'gud-tooltip-modes "22.1")
3144 (define-obsolete-variable-alias 'tooltip-gud-display
3145 'gud-tooltip-display "22.1")
3147 ;;; Reacting on mouse movements
3149 (defun gud-tooltip-change-major-mode ()
3150 "Function added to `change-major-mode-hook' when tooltip mode is on."
3151 (add-hook 'post-command-hook 'gud-tooltip-activate-mouse-motions-if-enabled))
3153 (defun gud-tooltip-activate-mouse-motions-if-enabled ()
3154 "Reconsider for all buffers whether mouse motion events are desired."
3155 (remove-hook 'post-command-hook
3156 'gud-tooltip-activate-mouse-motions-if-enabled)
3157 (dolist (buffer (buffer-list))
3160 (if (and gud-tooltip-mode
3161 (memq major-mode gud-tooltip-modes))
3162 (gud-tooltip-activate-mouse-motions t)
3163 (gud-tooltip-activate-mouse-motions nil)))))
3165 (defvar gud-tooltip-mouse-motions-active nil
3166 "Locally t in a buffer if tooltip processing of mouse motion is enabled.")
3168 (defun gud-tooltip-activate-mouse-motions (activatep)
3169 "Activate/deactivate mouse motion events for the current buffer.
3170 ACTIVATEP non-nil means activate mouse motion events."
3173 (make-local-variable 'gud-tooltip-mouse-motions-active)
3174 (setq gud-tooltip-mouse-motions-active t)
3175 (make-local-variable 'track-mouse)
3176 (setq track-mouse t))
3177 (when gud-tooltip-mouse-motions-active
3178 (kill-local-variable 'gud-tooltip-mouse-motions-active)
3179 (kill-local-variable 'track-mouse))))
3181 (defun gud-tooltip-mouse-motion (event)
3182 "Command handler for mouse movement events in `global-map'."
3185 (when (car (mouse-pixel-position))
3186 (setq tooltip-last-mouse-motion-event (copy-sequence event))
3187 (tooltip-start-delayed-tip)))
3191 (defvar gud-tooltip-original-filter nil
3192 "Process filter to restore after GUD output has been received.")
3194 (defvar gud-tooltip-dereference nil
3195 "Non-nil means print expressions with a `*' in front of them.
3196 For C this would dereference a pointer expression.")
3198 (defvar gud-tooltip-event nil
3199 "The mouse movement event that led to a tooltip display.
3200 This event can be examined by forms in GUD-TOOLTIP-DISPLAY.")
3202 (defun toggle-gud-tooltip-dereference ()
3203 "Toggle whether tooltips should show `* expr' or `expr'."
3205 (setq gud-tooltip-dereference (not gud-tooltip-dereference))
3206 (when (interactive-p)
3207 (message "Dereferencing is now %s."
3208 (if gud-tooltip-dereference "on" "off"))))
3210 (define-obsolete-function-alias 'tooltip-gud-toggle-dereference
3211 'toggle-gud-tooltip-dereference "22.1")
3214 (define-minor-mode gud-tooltip-mode
3215 "Toggle the display of GUD tooltips."
3219 (if gud-tooltip-mode
3221 (add-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3222 (add-hook 'pre-command-hook 'tooltip-hide)
3223 (add-hook 'tooltip-hook 'gud-tooltip-tips)
3224 (define-key global-map [mouse-movement] 'gud-tooltip-mouse-motion))
3225 (unless tooltip-mode (remove-hook 'pre-command-hook 'tooltip-hide)
3226 (remove-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3227 (remove-hook 'tooltip-hook 'gud-tooltip-tips)
3228 (define-key global-map [mouse-movement] 'ignore)))
3229 (gud-tooltip-activate-mouse-motions-if-enabled)
3232 (buffer-name gud-comint-buffer); gud-comint-buffer might be kille
3233 (with-current-buffer gud-comint-buffer
3234 (memq gud-minor-mode '(gdbmi gdba))))
3235 (if gud-tooltip-mode
3237 (dolist (buffer (buffer-list))
3238 (unless (eq buffer gud-comint-buffer)
3239 (with-current-buffer buffer
3240 (when (and (memq gud-minor-mode '(gdbmi gdba))
3241 (not (string-match "\\`\\*.+\\*\\'"
3243 (make-local-variable 'gdb-define-alist)
3244 (gdb-create-define-alist)
3245 (add-hook 'after-save-hook
3246 'gdb-create-define-alist nil t))))))
3247 (kill-local-variable 'gdb-define-alist)
3248 (remove-hook 'after-save-hook 'gdb-create-define-alist t))))
3250 ; This will only display data that comes in one chunk.
3251 ; Larger arrays (say 400 elements) are displayed in
3252 ; the tooltip incompletely and spill over into the gud buffer.
3253 ; Switching the process-filter creates timing problems and
3254 ; it may be difficult to do better. Using annotations as in
3255 ; gdb-ui.el gets round this problem.
3256 (defun gud-tooltip-process-output (process output)
3257 "Process debugger output and show it in a tooltip window."
3258 (set-process-filter process gud-tooltip-original-filter)
3259 (tooltip-show (tooltip-strip-prompt process output)
3260 (or gud-tooltip-echo-area tooltip-use-echo-area)))
3262 (defun gud-tooltip-print-command (expr)
3263 "Return a suitable command to print the expression EXPR.
3264 If GUD-TOOLTIP-DEREFERENCE is t, also prepend a `*' to EXPR."
3265 (when gud-tooltip-dereference
3266 (setq expr (concat "*" expr)))
3267 (case gud-minor-mode
3268 (gdba (concat "server print " expr))
3269 ((dbx gdbmi) (concat "print " expr))
3270 (xdb (concat "p " expr))
3271 (sdb (concat expr "/"))
3274 (defun gud-tooltip-tips (event)
3275 "Show tip for identifier or selection under the mouse.
3276 The mouse must either point at an identifier or inside a selected
3277 region for the tip window to be shown. If gud-tooltip-dereference is t,
3278 add a `*' in front of the printed expression. In the case of a C program
3279 controlled by GDB, show the associated #define directives when program is
3282 This function must return nil if it doesn't handle EVENT."
3284 (when (and (eventp event)
3286 (boundp 'gud-comint-buffer)
3288 (buffer-name gud-comint-buffer); gud-comint-buffer might be killed
3289 (setq process (get-buffer-process gud-comint-buffer))
3290 (posn-point (event-end event))
3291 (or (and (eq gud-minor-mode 'gdba) (not gdb-active-process))
3292 (progn (setq gud-tooltip-event event)
3293 (eval (cons 'and gud-tooltip-display)))))
3294 (let ((expr (tooltip-expr-to-print event)))
3296 (if (and (eq gud-minor-mode 'gdba)
3297 (not gdb-active-process))
3299 (with-current-buffer
3300 (window-buffer (let ((mouse (mouse-position)))
3301 (window-at (cadr mouse)
3303 (let ((define-elt (assoc expr gdb-define-alist)))
3304 (unless (null define-elt)
3307 (or gud-tooltip-echo-area tooltip-use-echo-area))
3309 (let ((cmd (gud-tooltip-print-command expr)))
3310 (when (and gud-tooltip-mode (eq gud-minor-mode 'gdb))
3311 (gud-tooltip-mode -1)
3312 (message-box "Using GUD tooltips in this mode is unsafe\n\
3313 so they have been disabled."))
3314 (unless (null cmd) ; CMD can be nil if unknown debugger
3315 (if (memq gud-minor-mode '(gdba gdbmi))
3319 gdb-server-prefix "macro expand " expr "\n")
3320 `(lambda () (gdb-tooltip-print-1 ,expr))))
3322 (list (concat cmd "\n") 'gdb-tooltip-print)))
3323 (setq gud-tooltip-original-filter (process-filter process))
3324 (set-process-filter process 'gud-tooltip-process-output)
3325 (gud-basic-call cmd))
3330 ;;; arch-tag: 6d990948-df65-461a-be39-1c7fb83ac4c4
3331 ;;; gud.el ends here