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, 2006, 2007 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 3, 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
47 (defvar gdb-active-process)
48 (defvar gdb-define-alist)
49 (defvar gdb-macro-info)
50 (defvar gdb-server-prefix)
51 (defvar gdb-show-changed-values)
53 (defvar gdb-speedbar-auto-raise)
56 ;; ======================================================================
57 ;; GUD commands must be visible in C buffers visited by GUD
60 "Grand Unified Debugger mode for gdb and other debuggers under Emacs.
61 Supported debuggers include gdb, sdb, dbx, xdb, perldb, pdb (Python), jdb."
66 (defcustom gud-key-prefix "\C-x\C-a"
67 "Prefix of all GUD commands valid in C buffers."
71 (global-set-key (concat gud-key-prefix "\C-l") 'gud-refresh)
72 (define-key ctl-x-map " " 'gud-break) ;; backward compatibility hack
74 (defvar gud-marker-filter nil)
75 (put 'gud-marker-filter 'permanent-local t)
76 (defvar gud-find-file nil)
77 (put 'gud-find-file 'permanent-local t)
79 (defun gud-marker-filter (&rest args)
80 (apply gud-marker-filter args))
82 (defvar gud-minor-mode nil)
83 (put 'gud-minor-mode 'permanent-local t)
85 (defvar gud-comint-buffer nil)
87 (defvar gud-keep-buffer nil)
89 (defun gud-symbol (sym &optional soft minor-mode)
90 "Return the symbol used for SYM in MINOR-MODE.
91 MINOR-MODE defaults to `gud-minor-mode.
92 The symbol returned is `gud-<MINOR-MODE>-<SYM>'.
93 If SOFT is non-nil, returns nil if the symbol doesn't already exist."
94 (unless (or minor-mode gud-minor-mode) (error "Gud internal error"))
95 (funcall (if soft 'intern-soft 'intern)
96 (format "gud-%s-%s" (or minor-mode gud-minor-mode) sym)))
98 (defun gud-val (sym &optional minor-mode)
99 "Return the value of `gud-symbol' SYM. Default to nil."
100 (let ((sym (gud-symbol sym t minor-mode)))
101 (if (boundp sym) (symbol-value sym))))
103 (defvar gud-running nil
104 "Non-nil if debugged program is running.
105 Used to grey out relevant toolbar icons.")
107 (defvar gdb-ready nil)
109 ;; Use existing Info buffer, if possible.
110 (defun gud-goto-info ()
111 "Go to relevant Emacs info node."
113 (let ((same-window-regexps same-window-regexps)
114 (display-buffer-reuse-frames t))
118 (if (eq (window-buffer window) (get-buffer "*info*"))
120 (setq same-window-regexps nil)
121 (throw 'info-found nil))))
123 (select-frame (make-frame)))
124 (if (memq gud-minor-mode '(gdbmi gdba))
125 (info "(emacs)GDB Graphical Interface")
126 (info "(emacs)Debuggers"))))
128 (defun gud-tool-bar-item-visible-no-fringe ()
129 (not (or (eq (buffer-local-value 'major-mode (window-buffer)) 'speedbar-mode)
130 (and (memq gud-minor-mode '(gdbmi gdba))
131 (> (car (window-fringes)) 0)))))
133 (defun gud-stop-subjob ()
135 (with-current-buffer gud-comint-buffer
136 (if (string-equal gud-target-name "emacs")
138 (comint-interrupt-subjob))))
140 (easy-mmode-defmap gud-menu-map
141 '(([help] "Info" . gud-goto-info)
142 ([tooltips] menu-item "Toggle GUD tooltips" gud-tooltip-mode
143 :enable (and (not emacs-basic-display)
145 (fboundp 'x-show-tip))
146 :visible (memq gud-minor-mode
147 '(gdbmi gdba dbx sdb xdb pdb))
148 :button (:toggle . gud-tooltip-mode))
149 ([refresh] "Refresh" . gud-refresh)
150 ([run] menu-item "Run" gud-run
151 :enable (not gud-running)
152 :visible (memq gud-minor-mode '(gdbmi gdb dbx jdb)))
153 ([go] menu-item (if gdb-active-process "Continue" "Run") gud-go
154 :visible (and (not gud-running)
155 (eq gud-minor-mode 'gdba)))
156 ([stop] menu-item "Stop" gud-stop-subjob
157 :visible (or (not (memq gud-minor-mode '(gdba pdb)))
159 (eq gud-minor-mode 'gdba))))
160 ([until] menu-item "Continue to selection" gud-until
161 :enable (not gud-running)
162 :visible (and (memq gud-minor-mode '(gdbmi gdba gdb perldb))
163 (gud-tool-bar-item-visible-no-fringe)))
164 ([remove] menu-item "Remove Breakpoint" gud-remove
165 :enable (not gud-running)
166 :visible (gud-tool-bar-item-visible-no-fringe))
167 ([tbreak] menu-item "Temporary Breakpoint" gud-tbreak
168 :enable (not gud-running)
169 :visible (memq gud-minor-mode
170 '(gdbmi gdba gdb sdb xdb)))
171 ([break] menu-item "Set Breakpoint" gud-break
172 :enable (not gud-running)
173 :visible (gud-tool-bar-item-visible-no-fringe))
174 ([up] menu-item "Up Stack" gud-up
175 :enable (not gud-running)
176 :visible (memq gud-minor-mode
177 '(gdbmi gdba gdb dbx xdb jdb pdb)))
178 ([down] menu-item "Down Stack" gud-down
179 :enable (not gud-running)
180 :visible (memq gud-minor-mode
181 '(gdbmi gdba gdb dbx xdb jdb pdb)))
182 ([pp] menu-item "Print S-expression" gud-pp
183 :enable (and (not gud-running)
185 :visible (and (string-equal
187 'gud-target-name gud-comint-buffer) "emacs")
188 (eq gud-minor-mode 'gdba)))
189 ([print*] menu-item "Print Dereference" gud-pstar
190 :enable (not gud-running)
191 :visible (memq gud-minor-mode '(gdbmi gdba gdb)))
192 ([print] menu-item "Print Expression" gud-print
193 :enable (not gud-running))
194 ([watch] menu-item "Watch Expression" gud-watch
195 :enable (not gud-running)
196 :visible (memq gud-minor-mode '(gdbmi gdba)))
197 ([finish] menu-item "Finish Function" gud-finish
198 :enable (not gud-running)
199 :visible (memq gud-minor-mode
200 '(gdbmi gdba gdb xdb jdb pdb)))
201 ([stepi] menu-item "Step Instruction" gud-stepi
202 :enable (not gud-running)
203 :visible (memq gud-minor-mode '(gdbmi gdba gdb dbx)))
204 ([nexti] menu-item "Next Instruction" gud-nexti
205 :enable (not gud-running)
206 :visible (memq gud-minor-mode '(gdbmi gdba gdb dbx)))
207 ([step] menu-item "Step Line" gud-step
208 :enable (not gud-running))
209 ([next] menu-item "Next Line" gud-next
210 :enable (not gud-running))
211 ([cont] menu-item "Continue" gud-cont
212 :enable (not gud-running)
213 :visible (not (eq gud-minor-mode 'gdba))))
214 "Menu for `gud-mode'."
217 (easy-mmode-defmap gud-minor-mode-map
219 `(([menu-bar debug] . ("Gud" . ,gud-menu-map)))
220 ;; Get tool bar like functionality from the menu bar on a text only
222 (unless window-system
224 . (,(propertize "down" 'face 'font-lock-doc-face) . gud-down))
226 . (,(propertize "up" 'face 'font-lock-doc-face) . gud-up))
228 . (,(propertize "finish" 'face 'font-lock-doc-face) . gud-finish))
230 . (,(propertize "step" 'face 'font-lock-doc-face) . gud-step))
232 . (,(propertize "next" 'face 'font-lock-doc-face) . gud-next))
233 ([menu-bar until] menu-item
234 ,(propertize "until" 'face 'font-lock-doc-face) gud-until
235 :visible (memq gud-minor-mode '(gdbmi gdba gdb perldb)))
236 ([menu-bar cont] menu-item
237 ,(propertize "cont" 'face 'font-lock-doc-face) gud-cont
238 :visible (not (eq gud-minor-mode 'gdba)))
239 ([menu-bar run] menu-item
240 ,(propertize "run" 'face 'font-lock-doc-face) gud-run
241 :visible (memq gud-minor-mode '(gdbmi gdb dbx jdb)))
242 ([menu-bar go] menu-item
243 ,(propertize " go " 'face 'font-lock-doc-face) gud-go
244 :visible (and (not gud-running)
245 (eq gud-minor-mode 'gdba)))
246 ([menu-bar stop] menu-item
247 ,(propertize "stop" 'face 'font-lock-doc-face) gud-stop-subjob
248 :visible (or gud-running
249 (not (eq gud-minor-mode 'gdba))))
251 . (,(propertize "print" 'face 'font-lock-doc-face) . gud-print))
252 ([menu-bar tools] . undefined)
253 ([menu-bar buffer] . undefined)
254 ([menu-bar options] . undefined)
255 ([menu-bar edit] . undefined)
256 ([menu-bar file] . undefined))))
257 "Map used in visited files.")
259 (let ((m (assq 'gud-minor-mode minor-mode-map-alist)))
260 (if m (setcdr m gud-minor-mode-map)
261 (push (cons 'gud-minor-mode gud-minor-mode-map) minor-mode-map-alist)))
264 ;; Will inherit from comint-mode via define-derived-mode.
266 "`gud-mode' keymap.")
268 (defvar gud-tool-bar-map
269 (if (display-graphic-p)
270 (let ((map (make-sparse-keymap)))
271 (dolist (x '((gud-break . "gud/break")
272 (gud-remove . "gud/remove")
273 (gud-print . "gud/print")
274 (gud-pstar . "gud/pstar")
276 (gud-watch . "gud/watch")
277 (gud-run . "gud/run")
279 (gud-stop-subjob . "gud/stop")
280 (gud-cont . "gud/cont")
281 (gud-until . "gud/until")
282 (gud-next . "gud/next")
283 (gud-step . "gud/step")
284 (gud-finish . "gud/finish")
285 (gud-nexti . "gud/nexti")
286 (gud-stepi . "gud/stepi")
288 (gud-down . "gud/down")
289 (gud-goto-info . "info"))
291 (tool-bar-local-item-from-menu
292 (car x) (cdr x) map gud-minor-mode-map)))))
294 (defun gud-file-name (f)
295 "Transform a relative file name to an absolute file name.
296 Uses `gud-<MINOR-MODE>-directories' to find the source files."
297 (if (file-exists-p f) (expand-file-name f)
298 (let ((directories (gud-val 'directories))
301 (let ((path (expand-file-name f (car directories))))
302 (if (file-exists-p path)
305 (setq directories (cdr directories)))
308 (defun gud-find-file (file)
309 ;; Don't get confused by double slashes in the name that comes from GDB.
310 (while (string-match "//+" file)
311 (setq file (replace-match "/" t t file)))
312 (let ((minor-mode gud-minor-mode)
313 (buf (funcall (or gud-find-file 'gud-file-name) file)))
315 (setq buf (and (file-readable-p buf) (find-file-noselect buf 'nowarn))))
317 ;; Copy `gud-minor-mode' to the found buffer to turn on the menu.
318 (with-current-buffer buf
319 (set (make-local-variable 'gud-minor-mode) minor-mode)
320 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
321 (when (and gud-tooltip-mode
322 (memq gud-minor-mode '(gdbmi gdba)))
323 (make-local-variable 'gdb-define-alist)
324 (unless gdb-define-alist (gdb-create-define-alist))
325 (add-hook 'after-save-hook 'gdb-create-define-alist nil t))
326 (make-local-variable 'gud-keep-buffer))
329 ;; ======================================================================
330 ;; command definition
332 ;; This macro is used below to define some basic debugger interface commands.
333 ;; Of course you may use `gud-def' with any other debugger command, including
334 ;; user defined ones.
336 ;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
337 ;; which defines FUNC to send the command NAME to the debugger, gives
338 ;; it the docstring DOC, and binds that function to KEY in the GUD
339 ;; major mode. The function is also bound in the global keymap with the
342 (defmacro gud-def (func cmd key &optional doc)
343 "Define FUNC to be a command sending STR and bound to KEY, with
344 optional doc string DOC. Certain %-escapes in the string arguments
345 are interpreted specially if present. These are:
347 %f -- Name (without directory) of current source file.
348 %F -- Name (without directory or extension) of current source file.
349 %d -- Directory of current source file.
350 %l -- Number of current source line.
351 %e -- Text of the C lvalue or function-call expression surrounding point.
352 %a -- Text of the hexadecimal address surrounding point.
353 %p -- Prefix argument to the command (if any) as a number.
354 %c -- Fully qualified class name derived from the expression
355 surrounding point (jdb only).
357 The `current' source file is the file of the current buffer (if
358 we're in a C file) or the source file current at the last break or
359 step (if we're in the GUD buffer).
360 The `current' line is that of the current buffer (if we're in a
361 source file) or the source line number at the last break or step (if
362 we're in the GUD buffer)."
365 ,@(if doc (list doc))
370 ,(if key `(local-set-key ,(concat "\C-c" key) ',func))
371 ,(if key `(global-set-key (vconcat gud-key-prefix ,key) ',func))))
373 ;; Where gud-display-frame should put the debugging arrow; a cons of
374 ;; (filename . line-number). This is set by the marker-filter, which scans
375 ;; the debugger's output for indications of the current program counter.
376 (defvar gud-last-frame nil)
378 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
379 ;; the last frame, even if it's been called before and gud-last-frame has
381 (defvar gud-last-last-frame nil)
383 ;; All debugger-specific information is collected here.
384 ;; Here's how it works, in case you ever need to add a debugger to the mode.
386 ;; Each entry must define the following at startup:
389 ;; comint-prompt-regexp
390 ;; gud-<name>-massage-args
391 ;; gud-<name>-marker-filter
392 ;; gud-<name>-find-file
394 ;; The job of the massage-args method is to modify the given list of
395 ;; debugger arguments before running the debugger.
397 ;; The job of the marker-filter method is to detect file/line markers in
398 ;; strings and set the global gud-last-frame to indicate what display
399 ;; action (if any) should be triggered by the marker. Note that only
400 ;; whatever the method *returns* is displayed in the buffer; thus, you
401 ;; can filter the debugger's output, interpreting some and passing on
404 ;; The job of the find-file method is to visit and return the buffer indicated
405 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
408 ;; ======================================================================
409 ;; speedbar support functions and variables.
410 (eval-when-compile (require 'speedbar)) ;For speedbar-with-attached-buffer.
412 (defvar gud-last-speedbar-stackframe nil
413 "Description of the currently displayed GUD stack.
414 t means that there is no stack, and we are in display-file mode.")
416 (defvar gud-speedbar-key-map nil
417 "Keymap used when in the buffers display mode.")
419 (defun gud-speedbar-item-info ()
420 "Display the data type of the watch expression element."
421 (let ((var (nth (- (line-number-at-pos (point)) 2) gdb-var-list)))
423 (speedbar-message "%s: %s" (nth 6 var) (nth 3 var))
424 (speedbar-message "%s" (nth 3 var)))))
426 (defun gud-install-speedbar-variables ()
427 "Install those variables used by speedbar to enhance gud/gdb."
428 (if gud-speedbar-key-map
430 (setq gud-speedbar-key-map (speedbar-make-specialized-keymap))
432 (define-key gud-speedbar-key-map "j" 'speedbar-edit-line)
433 (define-key gud-speedbar-key-map "e" 'speedbar-edit-line)
434 (define-key gud-speedbar-key-map "\C-m" 'speedbar-edit-line)
435 (define-key gud-speedbar-key-map " " 'speedbar-toggle-line-expansion)
436 (define-key gud-speedbar-key-map "D" 'gdb-var-delete)
437 (define-key gud-speedbar-key-map "p" 'gud-pp))
439 (speedbar-add-expansion-list '("GUD" gud-speedbar-menu-items
441 gud-expansion-speedbar-buttons))
444 'speedbar-mode-functions-list
445 '("GUD" (speedbar-item-info . gud-speedbar-item-info)
446 (speedbar-line-directory . ignore))))
448 (defvar gud-speedbar-menu-items
449 '(["Jump to stack frame" speedbar-edit-line
450 :visible (not (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
452 ["Edit value" speedbar-edit-line
453 :visible (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
455 ["Delete expression" gdb-var-delete
456 :visible (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
458 ["Auto raise frame" gdb-speedbar-auto-raise
459 :style toggle :selected gdb-speedbar-auto-raise
460 :visible (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
462 "Additional menu items to add to the speedbar frame.")
464 ;; Make sure our special speedbar mode is loaded
465 (if (featurep 'speedbar)
466 (gud-install-speedbar-variables)
467 (add-hook 'speedbar-load-hook 'gud-install-speedbar-variables))
469 (defun gud-expansion-speedbar-buttons (directory zero)
470 "Wrapper for call to speedbar-add-expansion-list. DIRECTORY and
471 ZERO are not used, but are required by the caller."
472 (gud-speedbar-buttons gud-comint-buffer))
474 (defun gud-speedbar-buttons (buffer)
475 "Create a speedbar display based on the current state of GUD.
476 If the GUD BUFFER is not running a supported debugger, then turn
477 off the specialized speedbar mode. BUFFER is not used, but are
478 required by the caller."
479 (when (and gud-comint-buffer
480 ;; gud-comint-buffer might be killed
481 (buffer-name gud-comint-buffer))
482 (let* ((minor-mode (with-current-buffer buffer gud-minor-mode))
483 (window (get-buffer-window (current-buffer) 0))
484 (start (window-start window))
485 (p (window-point window)))
487 ((memq minor-mode '(gdbmi gdba))
489 (insert "Watch Expressions:\n")
490 (if gdb-speedbar-auto-raise
491 (raise-frame speedbar-frame))
492 (let ((var-list gdb-var-list) parent)
494 (let* (char (depth 0) (start 0) (var (car var-list))
495 (varnum (car var)) (expr (nth 1 var))
496 (type (if (nth 3 var) (nth 3 var) " "))
497 (value (nth 4 var)) (status (nth 5 var)))
499 0 (length expr) 'face font-lock-variable-name-face expr)
501 0 (length type) 'face font-lock-type-face type)
502 (while (string-match "\\." varnum start)
503 (setq depth (1+ depth)
504 start (1+ (match-beginning 0))))
505 (if (eq depth 0) (setq parent nil))
506 (if (or (equal (nth 2 var) "0")
507 (and (equal (nth 2 var) "1")
508 (string-match "char \\*$" type)))
509 (speedbar-make-tag-line
511 (concat expr "\t" value)
512 (if (or parent (eq status 'out-of-scope))
515 (if gdb-show-changed-values
516 (or parent (case status
517 (changed 'font-lock-warning-face)
518 (out-of-scope 'shadow)
522 (if (eq status 'out-of-scope) (setq parent 'shadow))
523 (if (and (nth 1 var-list)
524 (string-match (concat varnum "\\.")
525 (car (nth 1 var-list))))
528 (if (string-match "\\*$\\|\\*&$" type)
529 (speedbar-make-tag-line
531 'gdb-speedbar-expand-node varnum
532 (concat expr "\t" type "\t" value)
533 (if (or parent (eq status 'out-of-scope))
536 (if gdb-show-changed-values
537 (or parent (case status
538 (changed 'font-lock-warning-face)
539 (out-of-scope 'shadow)
543 (speedbar-make-tag-line
545 'gdb-speedbar-expand-node varnum
546 (concat expr "\t" type)
548 (if (and (or parent status) gdb-show-changed-values)
551 (setq var-list (cdr var-list)))))
552 (t (unless (and (save-excursion
553 (goto-char (point-min))
554 (looking-at "Current Stack:"))
555 (equal gud-last-last-frame gud-last-speedbar-stackframe))
556 (let ((gud-frame-list
557 (cond ((eq minor-mode 'gdb)
558 (gud-gdb-get-stackframe buffer))
559 ;; Add more debuggers here!
560 (t (speedbar-remove-localized-speedbar-support buffer)
563 (if (not gud-frame-list)
564 (insert "No Stack frames\n")
565 (insert "Current Stack:\n"))
566 (dolist (frame gud-frame-list)
567 (insert (nth 1 frame) ":\n")
568 (if (= (length frame) 2)
570 (speedbar-insert-button (car frame)
571 'speedbar-directory-face
573 (speedbar-insert-button
576 'speedbar-highlight-face
577 (cond ((memq minor-mode '(gdbmi gdba gdb))
578 'gud-gdb-goto-stackframe)
579 (t (error "Should never be here")))
581 (setq gud-last-speedbar-stackframe gud-last-last-frame))))
582 (set-window-start window start)
583 (set-window-point window p))))
586 ;; ======================================================================
589 ;; History of argument lists passed to gdb.
590 (defvar gud-gdb-history nil)
592 (defcustom gud-gdb-command-name "gdb --annotate=3"
593 "Default command to execute an executable under the GDB debugger."
597 (defvar gud-gdb-marker-regexp
598 ;; This used to use path-separator instead of ":";
599 ;; however, we found that on both Windows 32 and MSDOS
600 ;; a colon is correct here.
601 (concat "\032\032\\(.:?[^" ":" "\n]*\\)" ":"
602 "\\([0-9]*\\)" ":" ".*\n"))
604 ;; There's no guarantee that Emacs will hand the filter the entire
605 ;; marker at once; it could be broken up across several strings. We
606 ;; might even receive a big chunk with several markers in it. If we
607 ;; receive a chunk of text which looks like it might contain the
608 ;; beginning of a marker, we save it here between calls to the
610 (defvar gud-marker-acc "")
611 (make-variable-buffer-local 'gud-marker-acc)
613 (defun gud-gdb-marker-filter (string)
614 (setq gud-marker-acc (concat gud-marker-acc string))
617 ;; Process all the complete markers in this chunk.
618 (while (string-match gud-gdb-marker-regexp gud-marker-acc)
621 ;; Extract the frame position from the marker.
622 gud-last-frame (cons (match-string 1 gud-marker-acc)
623 (string-to-number (match-string 2 gud-marker-acc)))
625 ;; Append any text before the marker to the output we're going
626 ;; to return - we don't include the marker in this text.
627 output (concat output
628 (substring gud-marker-acc 0 (match-beginning 0)))
630 ;; Set the accumulator to the remaining text.
631 gud-marker-acc (substring gud-marker-acc (match-end 0))))
633 ;; Check for annotations and change gud-minor-mode to 'gdba if
635 (while (string-match "\n\032\032\\(.*\\)\n" gud-marker-acc)
636 (let ((match (match-string 1 gud-marker-acc)))
638 ;; Pick up stopped annotation if attaching to process.
639 (if (string-equal match "stopped") (setq gdb-active-process t))
641 ;; Using annotations, switch to gud-gdba-marker-filter.
642 (when (string-equal match "prompt")
647 ;; Append any text before the marker to the output we're going
648 ;; to return - we don't include the marker in this text.
649 output (concat output
650 (substring gud-marker-acc 0 (match-beginning 0)))
652 ;; Set the accumulator to the remaining text.
654 gud-marker-acc (substring gud-marker-acc (match-end 0)))
656 ;; Pick up any errors that occur before first prompt annotation.
657 (if (string-equal match "error-begin")
658 (put-text-property 0 (length gud-marker-acc)
659 'face font-lock-warning-face
662 ;; Does the remaining text look like it might end with the
663 ;; beginning of another marker? If it does, then keep it in
664 ;; gud-marker-acc until we receive the rest of it. Since we
665 ;; know the full marker regexp above failed, it's pretty simple to
666 ;; test for marker starts.
667 (if (string-match "\n\\(\032.*\\)?\\'" gud-marker-acc)
669 ;; Everything before the potential marker start can be output.
670 (setq output (concat output (substring gud-marker-acc
671 0 (match-beginning 0))))
673 ;; Everything after, we save, to combine with later input.
675 (substring gud-marker-acc (match-beginning 0))))
677 (setq output (concat output gud-marker-acc)
682 (easy-mmode-defmap gud-minibuffer-local-map
683 '(("\C-i" . comint-dynamic-complete-filename))
684 "Keymap for minibuffer prompting of gud startup command."
685 :inherit minibuffer-local-map)
687 (defun gud-query-cmdline (minor-mode &optional init)
688 (let* ((hist-sym (gud-symbol 'history nil minor-mode))
689 (cmd-name (gud-val 'command-name minor-mode)))
690 (unless (boundp hist-sym) (set hist-sym nil))
691 (read-from-minibuffer
692 (format "Run %s (like this): " minor-mode)
693 (or (car-safe (symbol-value hist-sym))
694 (concat (or cmd-name (symbol-name minor-mode))
698 (dolist (f (directory-files default-directory) file)
699 (if (and (file-executable-p f)
700 (not (file-directory-p f))
702 (file-newer-than-file-p f file)))
704 gud-minibuffer-local-map nil
707 (defvar gdb-first-prompt t)
709 (defvar gud-filter-pending-text nil
710 "Non-nil means this is text that has been saved for later in `gud-filter'.")
713 (defun gdb (command-line)
714 "Run gdb on program FILE in buffer *gud-FILE*.
715 The directory containing FILE becomes the initial working
716 directory and source-file directory for your debugger. By
717 default this command starts GDB using a graphical interface. See
718 `gdba' for more information.
720 To run GDB in text command mode, replace the GDB \"--annotate=3\"
721 option with \"--fullname\" either in the minibuffer for the
722 current Emacs session, or the custom variable
723 `gud-gdb-command-name' for all future sessions. You need to use
724 text command mode to debug multiple programs within one Emacs
726 (interactive (list (gud-query-cmdline 'gdb)))
728 (when (and gud-comint-buffer
729 (buffer-name gud-comint-buffer)
730 (get-buffer-process gud-comint-buffer)
731 (with-current-buffer gud-comint-buffer (eq gud-minor-mode 'gdba)))
732 (gdb-restore-windows)
734 "Multiple debugging requires restarting in text command mode"))
736 (gud-common-init command-line nil 'gud-gdb-marker-filter)
737 (set (make-local-variable 'gud-minor-mode) 'gdb)
739 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
740 (gud-def gud-tbreak "tbreak %f:%l" "\C-t"
741 "Set temporary breakpoint at current line.")
742 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
743 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
744 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
745 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
746 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
747 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
748 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
750 (progn (gud-call "tbreak %f:%l") (gud-call "jump %f:%l"))
751 "\C-j" "Set execution address to current line.")
753 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
754 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
755 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
756 (gud-def gud-pstar "print* %e" nil
757 "Evaluate C dereferenced pointer expression at point.")
759 ;; For debugging Emacs only.
760 (gud-def gud-pv "pv1 %e" "\C-v" "Print the value of the lisp variable.")
762 (gud-def gud-until "until %l" "\C-u" "Continue to current line.")
763 (gud-def gud-run "run" nil "Run the program.")
765 (local-set-key "\C-i" 'gud-gdb-complete-command)
766 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
767 (setq paragraph-start comint-prompt-regexp)
768 (setq gdb-first-prompt t)
769 (setq gud-running nil)
771 (setq gud-filter-pending-text nil)
772 (run-hooks 'gdb-mode-hook))
774 ;; One of the nice features of GDB is its impressive support for
775 ;; context-sensitive command completion. We preserve that feature
776 ;; in the GUD buffer by using a GDB command designed just for Emacs.
778 ;; The completion process filter indicates when it is finished.
779 (defvar gud-gdb-fetch-lines-in-progress)
781 ;; Since output may arrive in fragments we accumulate partials strings here.
782 (defvar gud-gdb-fetch-lines-string)
784 ;; We need to know how much of the completion to chop off.
785 (defvar gud-gdb-fetch-lines-break)
787 ;; The completion list is constructed by the process filter.
788 (defvar gud-gdb-fetched-lines)
790 (defun gud-gdb-complete-command (&optional command a b)
791 "Perform completion on the GDB command preceding point.
792 This is implemented using the GDB `complete' command which isn't
793 available with older versions of GDB."
796 ;; Used by gud-watch in mini-buffer.
797 (setq command (concat "p " command))
798 ;; Used in GUD buffer.
800 (setq command (buffer-substring (comint-line-beginning-position) end))))
802 ;; Find the word break. This match will always succeed.
803 (and (string-match "\\(\\`\\| \\)\\([^ ]*\\)\\'" command)
804 (substring command (match-beginning 2))))
806 (gud-gdb-run-command-fetch-lines (concat "complete " command)
808 ;; From string-match above.
809 (match-beginning 2))))
810 ;; Protect against old versions of GDB.
812 (string-match "^Undefined command: \"complete\"" (car complete-list))
813 (error "This version of GDB doesn't support the `complete' command"))
814 ;; Sort the list like readline.
815 (setq complete-list (sort complete-list (function string-lessp)))
816 ;; Remove duplicates.
817 (let ((first complete-list)
818 (second (cdr complete-list)))
820 (if (string-equal (car first) (car second))
821 (setcdr first (setq second (cdr second)))
823 second (cdr second)))))
824 ;; Add a trailing single quote if there is a unique completion
825 ;; and it contains an odd number of unquoted single quotes.
826 (and (= (length complete-list) 1)
827 (let ((str (car complete-list))
830 (while (string-match "\\([^'\\]\\|\\\\'\\)*'" str pos)
831 (setq count (1+ count)
833 (and (= (mod count 2) 1)
834 (setq complete-list (list (concat str "'"))))))
835 ;; Let comint handle the rest.
836 (comint-dynamic-simple-complete command-word complete-list)))
838 ;; The completion process filter is installed temporarily to slurp the
839 ;; output of GDB up to the next prompt and build the completion list.
840 (defun gud-gdb-fetch-lines-filter (string filter)
841 "Filter used to read the list of lines output by a command.
842 STRING is the output to filter.
843 It is passed through FILTER before we look at it."
844 (setq string (funcall filter string))
845 (setq string (concat gud-gdb-fetch-lines-string string))
846 (while (string-match "\n" string)
847 (push (substring string gud-gdb-fetch-lines-break (match-beginning 0))
848 gud-gdb-fetched-lines)
849 (setq string (substring string (match-end 0))))
850 (if (string-match comint-prompt-regexp string)
852 (setq gud-gdb-fetch-lines-in-progress nil)
855 (setq gud-gdb-fetch-lines-string string)
858 ;; gdb speedbar functions
860 (defun gud-gdb-goto-stackframe (text token indent)
861 "Goto the stackframe described by TEXT, TOKEN, and INDENT."
862 (speedbar-with-attached-buffer
863 (gud-basic-call (concat "server frame " (nth 1 token)))
866 (defvar gud-gdb-fetched-stack-frame nil
867 "Stack frames we are fetching from GDB.")
869 ;(defun gud-gdb-get-scope-data (text token indent)
870 ; ;; checkdoc-params: (indent)
871 ; "Fetch data associated with a stack frame, and expand/contract it.
872 ;Data to do this is retrieved from TEXT and TOKEN."
873 ; (let ((args nil) (scope nil))
874 ; (gud-gdb-run-command-fetch-lines "info args")
876 ; (gud-gdb-run-command-fetch-lines "info local")
880 (defun gud-gdb-get-stackframe (buffer)
881 "Extract the current stack frame out of the GUD GDB BUFFER."
883 (fetched-stack-frame-list
884 (gud-gdb-run-command-fetch-lines "server backtrace" buffer)))
885 (if (and (car fetched-stack-frame-list)
886 (string-match "No stack" (car fetched-stack-frame-list)))
887 ;; Go into some other mode???
889 (dolist (e fetched-stack-frame-list)
890 (let ((name nil) (num nil))
892 (string-match "^#\\([0-9]+\\) +[0-9a-fx]+ in \\([:0-9a-zA-Z_]+\\) (" e)
893 (string-match "^#\\([0-9]+\\) +\\([:0-9a-zA-Z_]+\\) (" e)))
894 (if (not (string-match
895 "at \\([-0-9a-zA-Z_.]+\\):\\([0-9]+\\)$" e))
898 (list (nth 0 (car newlst))
901 (match-string 2 e))))
902 (setq num (match-string 1 e)
903 name (match-string 2 e))
907 "at \\([-0-9a-zA-Z_.]+\\):\\([0-9]+\\)$" e)
908 (list name num (match-string 1 e)
914 ;(defun gud-gdb-selected-frame-info (buffer)
915 ; "Learn GDB information for the currently selected stack frame in BUFFER."
918 (defun gud-gdb-run-command-fetch-lines (command buffer &optional skip)
919 "Run COMMAND, and return the list of lines it outputs.
920 BUFFER is the current buffer which may be the GUD buffer in which to run.
921 SKIP is the number of chars to skip on each lines, it defaults to 0."
922 (with-current-buffer gud-comint-buffer
923 (if (and (eq gud-comint-buffer buffer)
925 (goto-char (point-max))
927 (not (looking-at comint-prompt-regexp))))
929 ;; Much of this copied from GDB complete, but I'm grabbing the stack
931 (let ((gud-gdb-fetch-lines-in-progress t)
932 (gud-gdb-fetched-lines nil)
933 (gud-gdb-fetch-lines-string nil)
934 (gud-gdb-fetch-lines-break (or skip 0))
937 (gud-gdb-fetch-lines-filter string ',gud-marker-filter))))
938 ;; Issue the command to GDB.
939 (gud-basic-call command)
941 (while gud-gdb-fetch-lines-in-progress
942 (accept-process-output (get-buffer-process gud-comint-buffer)))
943 (nreverse gud-gdb-fetched-lines)))))
946 ;; ======================================================================
949 ;; History of argument lists passed to sdb.
950 (defvar gud-sdb-history nil)
952 (defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
953 "If nil, we're on a System V Release 4 and don't need the tags hack.")
955 (defvar gud-sdb-lastfile nil)
957 (defun gud-sdb-marker-filter (string)
959 (if gud-marker-acc (concat gud-marker-acc string) string))
961 ;; Process all complete markers in this chunk
964 ;; System V Release 3.2 uses this format
965 ((string-match "\\(^\\|\n\\)\\*?\\(0x\\w* in \\)?\\([^:\n]*\\):\\([0-9]*\\):.*\n"
966 gud-marker-acc start)
968 (cons (match-string 3 gud-marker-acc)
969 (string-to-number (match-string 4 gud-marker-acc)))))
970 ;; System V Release 4.0 quite often clumps two lines together
971 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
972 gud-marker-acc start)
973 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc))
975 (cons gud-sdb-lastfile
976 (string-to-number (match-string 3 gud-marker-acc)))))
977 ;; System V Release 4.0
978 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n"
979 gud-marker-acc start)
980 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc)))
981 ((and gud-sdb-lastfile (string-match "^\\([0-9]+\\):"
982 gud-marker-acc start))
984 (cons gud-sdb-lastfile
985 (string-to-number (match-string 1 gud-marker-acc)))))
987 (setq gud-sdb-lastfile nil)))
988 (setq start (match-end 0)))
990 ;; Search for the last incomplete line in this chunk
991 (while (string-match "\n" gud-marker-acc start)
992 (setq start (match-end 0)))
994 ;; If we have an incomplete line, store it in gud-marker-acc.
995 (setq gud-marker-acc (substring gud-marker-acc (or start 0))))
998 (defun gud-sdb-find-file (f)
999 (if gud-sdb-needs-tags (find-tag-noselect f) (find-file-noselect f)))
1002 (defun sdb (command-line)
1003 "Run sdb on program FILE in buffer *gud-FILE*.
1004 The directory containing FILE becomes the initial working directory
1005 and source-file directory for your debugger."
1006 (interactive (list (gud-query-cmdline 'sdb)))
1008 (if gud-sdb-needs-tags (require 'etags))
1009 (if (and gud-sdb-needs-tags
1010 (not (and (boundp 'tags-file-name)
1011 (stringp tags-file-name)
1012 (file-exists-p tags-file-name))))
1013 (error "The sdb support requires a valid tags table to work"))
1015 (gud-common-init command-line nil 'gud-sdb-marker-filter 'gud-sdb-find-file)
1016 (set (make-local-variable 'gud-minor-mode) 'sdb)
1018 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
1019 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
1020 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
1021 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
1022 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
1023 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1024 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1025 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
1027 (setq comint-prompt-regexp "\\(^\\|\n\\)\\*")
1028 (setq paragraph-start comint-prompt-regexp)
1029 (run-hooks 'sdb-mode-hook)
1032 ;; ======================================================================
1035 ;; History of argument lists passed to dbx.
1036 (defvar gud-dbx-history nil)
1038 (defcustom gud-dbx-directories nil
1039 "*A list of directories that dbx should search for source code.
1040 If nil, only source files in the program directory
1041 will be known to dbx.
1043 The file names should be absolute, or relative to the directory
1044 containing the executable being debugged."
1045 :type '(choice (const :tag "Current Directory" nil)
1050 (defun gud-dbx-massage-args (file args)
1051 (nconc (let ((directories gud-dbx-directories)
1054 (setq result (cons (car directories) (cons "-I" result)))
1055 (setq directories (cdr directories)))
1059 (defun gud-dbx-marker-filter (string)
1060 (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
1063 ;; Process all complete markers in this chunk.
1064 (while (or (string-match
1065 "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
1066 gud-marker-acc start)
1068 "signal .* in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
1069 gud-marker-acc start))
1070 (setq gud-last-frame
1071 (cons (match-string 2 gud-marker-acc)
1072 (string-to-number (match-string 1 gud-marker-acc)))
1073 start (match-end 0)))
1075 ;; Search for the last incomplete line in this chunk
1076 (while (string-match "\n" gud-marker-acc start)
1077 (setq start (match-end 0)))
1079 ;; If the incomplete line APPEARS to begin with another marker, keep it
1080 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1081 ;; unnecessary concat during the next call.
1082 (setq gud-marker-acc
1083 (if (string-match "\\(stopped\\|signal\\)" gud-marker-acc start)
1084 (substring gud-marker-acc (match-beginning 0))
1088 ;; Functions for Mips-style dbx. Given the option `-emacs', documented in
1089 ;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
1091 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
1092 ;; We haven't tested gud on this system:
1093 (string-match "^mips-[^-]*-riscos" system-configuration)
1094 ;; It's documented on OSF/1.3
1095 (string-match "^mips-[^-]*-osf1" system-configuration)
1096 (string-match "^alpha[^-]*-[^-]*-osf" system-configuration))
1097 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
1099 (defvar gud-dbx-command-name
1100 (concat "dbx" (if gud-mips-p " -emacs")))
1102 ;; This is just like the gdb one except for the regexps since we need to cope
1103 ;; with an optional breakpoint number in [] before the ^Z^Z
1104 (defun gud-mipsdbx-marker-filter (string)
1105 (setq gud-marker-acc (concat gud-marker-acc string))
1108 ;; Process all the complete markers in this chunk.
1109 (while (string-match
1110 ;; This is like th gdb marker but with an optional
1111 ;; leading break point number like `[1] '
1112 "[][ 0-9]*\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
1116 ;; Extract the frame position from the marker.
1118 (cons (match-string 1 gud-marker-acc)
1119 (string-to-number (match-string 2 gud-marker-acc)))
1121 ;; Append any text before the marker to the output we're going
1122 ;; to return - we don't include the marker in this text.
1123 output (concat output
1124 (substring gud-marker-acc 0 (match-beginning 0)))
1126 ;; Set the accumulator to the remaining text.
1127 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1129 ;; Does the remaining text look like it might end with the
1130 ;; beginning of another marker? If it does, then keep it in
1131 ;; gud-marker-acc until we receive the rest of it. Since we
1132 ;; know the full marker regexp above failed, it's pretty simple to
1133 ;; test for marker starts.
1134 (if (string-match "[][ 0-9]*\032.*\\'" gud-marker-acc)
1136 ;; Everything before the potential marker start can be output.
1137 (setq output (concat output (substring gud-marker-acc
1138 0 (match-beginning 0))))
1140 ;; Everything after, we save, to combine with later input.
1141 (setq gud-marker-acc
1142 (substring gud-marker-acc (match-beginning 0))))
1144 (setq output (concat output gud-marker-acc)
1149 ;; The dbx in IRIX is a pain. It doesn't print the file name when
1150 ;; stopping at a breakpoint (but you do get it from the `up' and
1151 ;; `down' commands...). The only way to extract the information seems
1152 ;; to be with a `file' command, although the current line number is
1153 ;; available in $curline. Thus we have to look for output which
1154 ;; appears to indicate a breakpoint. Then we prod the dbx sub-process
1155 ;; to output the information we want with a combination of the
1156 ;; `printf' and `file' commands as a pseudo marker which we can
1157 ;; recognise next time through the marker-filter. This would be like
1158 ;; the gdb marker but you can't get the file name without a newline...
1159 ;; Note that gud-remove won't work since Irix dbx expects a breakpoint
1160 ;; number rather than a line number etc. Maybe this could be made to
1161 ;; work by listing all the breakpoints and picking the one(s) with the
1162 ;; correct line number, but life's too short.
1163 ;; d.love@dl.ac.uk (Dave Love) can be blamed for this
1166 (and (string-match "^mips-[^-]*-irix" system-configuration)
1167 (not (string-match "irix[6-9]\\.[1-9]" system-configuration)))
1168 "Non-nil to assume the interface appropriate for IRIX dbx.
1169 This works in IRIX 4, 5 and 6, but `gud-dbx-use-stopformat-p' provides
1170 a better solution in 6.1 upwards.")
1171 (defvar gud-dbx-use-stopformat-p
1172 (string-match "irix[6-9]\\.[1-9]" system-configuration)
1173 "Non-nil to use the dbx feature present at least from Irix 6.1
1174 whereby $stopformat=1 produces an output format compatiable with
1175 `gud-dbx-marker-filter'.")
1176 ;; [Irix dbx seems to be a moving target. The dbx output changed
1177 ;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
1178 ;; the output from `up' is no longer spotted by gud (and it's probably
1179 ;; not distinctive enough to try to match it -- use C-<, C->
1180 ;; exclusively) . For 5.3 and 6.0, the $curline variable changed to
1181 ;; `long long'(why?!), so the printf stuff needed changing. The line
1182 ;; number was cast to `long' as a compromise between the new `long
1183 ;; long' and the original `int'. This is reported not to work in 6.2,
1184 ;; so it's changed back to int -- don't make your sources too long.
1185 ;; From Irix6.1 (but not 6.0?) dbx supports an undocumented feature
1186 ;; whereby `set $stopformat=1' reportedly produces output compatible
1187 ;; with `gud-dbx-marker-filter', which we prefer.
1189 ;; The process filter is also somewhat
1190 ;; unreliable, sometimes not spotting the markers; I don't know
1191 ;; whether there's anything that can be done about that. It would be
1192 ;; much better if SGI could be persuaded to (re?)instate the MIPS
1193 ;; -emacs flag for gdb-like output (which ought to be possible as most
1194 ;; of the communication I've had over it has been from sgi.com).]
1196 ;; this filter is influenced by the xdb one rather than the gdb one
1197 (defun gud-irixdbx-marker-filter (string)
1198 (let (result (case-fold-search nil))
1199 (if (or (string-match comint-prompt-regexp string)
1200 (string-match ".*\012" string))
1201 (setq result (concat gud-marker-acc string)
1203 (setq gud-marker-acc (concat gud-marker-acc string)))
1206 ;; look for breakpoint or signal indication e.g.:
1207 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
1208 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
1209 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
1211 "^\\(\\[[0-9]+] \\)?Process +[0-9]+ ([^)]*) [^[]+\\[[^]\n]*]\n"
1213 ;; prod dbx into printing out the line number and file
1214 ;; name in a form we can grok as below
1215 (process-send-string (get-buffer-process gud-comint-buffer)
1216 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1217 ;; look for result of, say, "up" e.g.:
1218 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
1219 ;; (this will also catch one of the lines printed by "where")
1221 "^[^ ][^[]*\\[\"\\([^\"]+\\)\":\\([0-9]+\\), [^]]+]\n"
1223 (let ((file (match-string 1 result)))
1224 (if (file-exists-p file)
1225 (setq gud-last-frame
1226 (cons (match-string 1 result)
1227 (string-to-number (match-string 2 result))))))
1229 ((string-match ; kluged-up marker as above
1230 "\032\032\\([0-9]*\\):\\(.*\\)\n" result)
1231 (let ((file (gud-file-name (match-string 2 result))))
1232 (if (and file (file-exists-p file))
1233 (setq gud-last-frame
1235 (string-to-number (match-string 1 result))))))
1236 (setq result (substring result 0 (match-beginning 0))))))
1239 (defvar gud-dgux-p (string-match "-dgux" system-configuration)
1240 "Non-nil means to assume the interface approriate for DG/UX dbx.
1241 This was tested using R4.11.")
1243 ;; There are a couple of differences between DG's dbx output and normal
1244 ;; dbx output which make it nontrivial to integrate this into the
1245 ;; standard dbx-marker-filter (mainly, there are a different number of
1246 ;; backreferences). The markers look like:
1248 ;; (0) Stopped at line 10, routine main(argc=1, argv=0xeffff0e0), file t.c
1250 ;; from breakpoints (the `(0)' there isn't constant, it's the breakpoint
1253 ;; Stopped at line 13, routine main(argc=1, argv=0xeffff0e0), file t.c
1257 ;; Frame 21, line 974, routine command_loop(), file keyboard.c
1259 ;; from up/down/where.
1261 (defun gud-dguxdbx-marker-filter (string)
1262 (setq gud-marker-acc (if gud-marker-acc
1263 (concat gud-marker-acc string)
1265 (let ((re (concat "^\\(\\(([0-9]+) \\)?Stopped at\\|Frame [0-9]+,\\)"
1266 " line \\([0-9]+\\), routine .*, file \\([^ \t\n]+\\)"))
1268 ;; Process all complete markers in this chunk.
1269 (while (string-match re gud-marker-acc start)
1270 (setq gud-last-frame
1271 (cons (match-string 4 gud-marker-acc)
1272 (string-to-number (match-string 3 gud-marker-acc)))
1273 start (match-end 0)))
1275 ;; Search for the last incomplete line in this chunk
1276 (while (string-match "\n" gud-marker-acc start)
1277 (setq start (match-end 0)))
1279 ;; If the incomplete line APPEARS to begin with another marker, keep it
1280 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1281 ;; unnecessary concat during the next call.
1282 (setq gud-marker-acc
1283 (if (string-match "Stopped\\|Frame" gud-marker-acc start)
1284 (substring gud-marker-acc (match-beginning 0))
1289 (defun dbx (command-line)
1290 "Run dbx on program FILE in buffer *gud-FILE*.
1291 The directory containing FILE becomes the initial working directory
1292 and source-file directory for your debugger."
1293 (interactive (list (gud-query-cmdline 'dbx)))
1297 (gud-common-init command-line nil 'gud-mipsdbx-marker-filter))
1299 (gud-common-init command-line 'gud-dbx-massage-args
1300 'gud-irixdbx-marker-filter))
1302 (gud-common-init command-line 'gud-dbx-massage-args
1303 'gud-dguxdbx-marker-filter))
1305 (gud-common-init command-line 'gud-dbx-massage-args
1306 'gud-dbx-marker-filter)))
1308 (set (make-local-variable 'gud-minor-mode) 'dbx)
1312 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1313 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1314 (gud-def gud-break "stop at \"%f\":%l"
1315 "\C-b" "Set breakpoint at current line.")
1316 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
1318 (gud-def gud-break "stop at \"%d%f\":%l"
1319 "\C-b" "Set breakpoint at current line.")
1320 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1321 (gud-def gud-up "up %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1322 "<" "Up (numeric arg) stack frames.")
1323 (gud-def gud-down "down %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1324 ">" "Down (numeric arg) stack frames.")
1325 ;; Make dbx give out the source location info that we need.
1326 (process-send-string (get-buffer-process gud-comint-buffer)
1327 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1329 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1330 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1331 (gud-def gud-break "file \"%d%f\"\nstop at %l"
1332 "\C-b" "Set breakpoint at current line.")
1333 (if gud-dbx-use-stopformat-p
1334 (process-send-string (get-buffer-process gud-comint-buffer)
1335 "set $stopformat=1\n"))))
1337 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
1338 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
1339 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
1340 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
1341 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
1342 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
1343 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
1344 (gud-def gud-run "run" nil "Run the program.")
1346 (setq comint-prompt-regexp "^[^)\n]*dbx) *")
1347 (setq paragraph-start comint-prompt-regexp)
1348 (run-hooks 'dbx-mode-hook)
1351 ;; ======================================================================
1352 ;; xdb (HP PARISC debugger) functions
1354 ;; History of argument lists passed to xdb.
1355 (defvar gud-xdb-history nil)
1357 (defcustom gud-xdb-directories nil
1358 "*A list of directories that xdb should search for source code.
1359 If nil, only source files in the program directory
1360 will be known to xdb.
1362 The file names should be absolute, or relative to the directory
1363 containing the executable being debugged."
1364 :type '(choice (const :tag "Current Directory" nil)
1369 (defun gud-xdb-massage-args (file args)
1370 (nconc (let ((directories gud-xdb-directories)
1373 (setq result (cons (car directories) (cons "-d" result)))
1374 (setq directories (cdr directories)))
1378 ;; xdb does not print the lines all at once, so we have to accumulate them
1379 (defun gud-xdb-marker-filter (string)
1381 (if (or (string-match comint-prompt-regexp string)
1382 (string-match ".*\012" string))
1383 (setq result (concat gud-marker-acc string)
1385 (setq gud-marker-acc (concat gud-marker-acc string)))
1387 (if (or (string-match "\\([^\n \t:]+\\): [^:]+: \\([0-9]+\\)[: ]"
1389 (string-match "[^: \t]+:[ \t]+\\([^:]+\\): [^:]+: \\([0-9]+\\):"
1391 (let ((line (string-to-number (match-string 2 result)))
1392 (file (gud-file-name (match-string 1 result))))
1394 (setq gud-last-frame (cons file line))))))
1398 (defun xdb (command-line)
1399 "Run xdb on program FILE in buffer *gud-FILE*.
1400 The directory containing FILE becomes the initial working directory
1401 and source-file directory for your debugger.
1403 You can set the variable `gud-xdb-directories' to a list of program source
1404 directories if your program contains sources from more than one directory."
1405 (interactive (list (gud-query-cmdline 'xdb)))
1407 (gud-common-init command-line 'gud-xdb-massage-args
1408 'gud-xdb-marker-filter)
1409 (set (make-local-variable 'gud-minor-mode) 'xdb)
1411 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
1412 (gud-def gud-tbreak "b %f:%l\\t" "\C-t"
1413 "Set temporary breakpoint at current line.")
1414 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
1415 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
1416 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1417 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1418 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1419 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1420 (gud-def gud-finish "bu\\t" "\C-f" "Finish executing current function.")
1421 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
1423 (setq comint-prompt-regexp "^>")
1424 (setq paragraph-start comint-prompt-regexp)
1425 (run-hooks 'xdb-mode-hook))
1427 ;; ======================================================================
1430 ;; History of argument lists passed to perldb.
1431 (defvar gud-perldb-history nil)
1433 (defun gud-perldb-massage-args (file args)
1434 "Convert a command line as would be typed normally to run perldb
1435 into one that invokes an Emacs-enabled debugging session.
1436 \"-emacs\" is inserted where it will be $ARGV[0] (see perl5db.pl)."
1437 ;; FIXME: what if the command is `make perldb' and doesn't accept those extra
1439 (let* ((new-args nil)
1441 (shift (lambda () (push (pop args) new-args))))
1443 ;; Pass all switches and -e scripts through.
1445 (string-match "^-" (car args))
1446 (not (equal "-" (car args)))
1447 (not (equal "--" (car args))))
1448 (when (equal "-e" (car args))
1449 ;; -e goes with the next arg, so shift one extra.
1451 ;; -e as the last arg is an error in Perl.
1452 (error "No code specified for -e"))
1458 (string-match "^-" (car args)))
1459 (error "Can't use stdin as the script to debug"))
1460 ;; This is the program name.
1463 ;; If -e specified, make sure there is a -- so -emacs is not taken
1465 (if (and args (equal "--" (car args)))
1467 (and seen-e (push "--" new-args)))
1469 (push "-emacs" new-args)
1473 (nreverse new-args)))
1475 ;; There's no guarantee that Emacs will hand the filter the entire
1476 ;; marker at once; it could be broken up across several strings. We
1477 ;; might even receive a big chunk with several markers in it. If we
1478 ;; receive a chunk of text which looks like it might contain the
1479 ;; beginning of a marker, we save it here between calls to the
1481 (defun gud-perldb-marker-filter (string)
1482 (setq gud-marker-acc (concat gud-marker-acc string))
1485 ;; Process all the complete markers in this chunk.
1486 (while (string-match "\032\032\\(\\([a-zA-Z]:\\)?[^:\n]*\\):\\([0-9]*\\):.*\n"
1490 ;; Extract the frame position from the marker.
1492 (cons (match-string 1 gud-marker-acc)
1493 (string-to-number (match-string 3 gud-marker-acc)))
1495 ;; Append any text before the marker to the output we're going
1496 ;; to return - we don't include the marker in this text.
1497 output (concat output
1498 (substring gud-marker-acc 0 (match-beginning 0)))
1500 ;; Set the accumulator to the remaining text.
1501 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1503 ;; Does the remaining text look like it might end with the
1504 ;; beginning of another marker? If it does, then keep it in
1505 ;; gud-marker-acc until we receive the rest of it. Since we
1506 ;; know the full marker regexp above failed, it's pretty simple to
1507 ;; test for marker starts.
1508 (if (string-match "\032.*\\'" gud-marker-acc)
1510 ;; Everything before the potential marker start can be output.
1511 (setq output (concat output (substring gud-marker-acc
1512 0 (match-beginning 0))))
1514 ;; Everything after, we save, to combine with later input.
1515 (setq gud-marker-acc
1516 (substring gud-marker-acc (match-beginning 0))))
1518 (setq output (concat output gud-marker-acc)
1523 (defcustom gud-perldb-command-name "perl -d"
1524 "Default command to execute a Perl script under debugger."
1529 (defun perldb (command-line)
1530 "Run perldb on program FILE in buffer *gud-FILE*.
1531 The directory containing FILE becomes the initial working directory
1532 and source-file directory for your debugger."
1534 (list (gud-query-cmdline 'perldb
1535 (concat (or (buffer-file-name) "-e 0") " "))))
1537 (gud-common-init command-line 'gud-perldb-massage-args
1538 'gud-perldb-marker-filter)
1539 (set (make-local-variable 'gud-minor-mode) 'perldb)
1541 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
1542 (gud-def gud-remove "B %l" "\C-d" "Remove breakpoint at current line")
1543 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
1544 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
1545 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1546 ; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
1547 ; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
1548 ; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
1549 (gud-def gud-print "p %e" "\C-p" "Evaluate perl expression at point.")
1550 (gud-def gud-until "c %l" "\C-u" "Continue to current line.")
1553 (setq comint-prompt-regexp "^ DB<+[0-9]+>+ ")
1554 (setq paragraph-start comint-prompt-regexp)
1555 (run-hooks 'perldb-mode-hook))
1557 ;; ======================================================================
1558 ;; pdb (Python debugger) functions
1560 ;; History of argument lists passed to pdb.
1561 (defvar gud-pdb-history nil)
1563 ;; Last group is for return value, e.g. "> test.py(2)foo()->None"
1564 ;; Either file or function name may be omitted: "> <string>(0)?()"
1565 (defvar gud-pdb-marker-regexp
1566 "^> \\([-a-zA-Z0-9_/.:\\]*\\|<string>\\)(\\([0-9]+\\))\\([a-zA-Z0-9_]*\\|\\?\\|<module>\\)()\\(->[^\n]*\\)?\n")
1567 (defvar gud-pdb-marker-regexp-file-group 1)
1568 (defvar gud-pdb-marker-regexp-line-group 2)
1569 (defvar gud-pdb-marker-regexp-fnname-group 3)
1571 (defvar gud-pdb-marker-regexp-start "^> ")
1573 ;; There's no guarantee that Emacs will hand the filter the entire
1574 ;; marker at once; it could be broken up across several strings. We
1575 ;; might even receive a big chunk with several markers in it. If we
1576 ;; receive a chunk of text which looks like it might contain the
1577 ;; beginning of a marker, we save it here between calls to the
1579 (defun gud-pdb-marker-filter (string)
1580 (setq gud-marker-acc (concat gud-marker-acc string))
1583 ;; Process all the complete markers in this chunk.
1584 (while (string-match gud-pdb-marker-regexp gud-marker-acc)
1587 ;; Extract the frame position from the marker.
1589 (let ((file (match-string gud-pdb-marker-regexp-file-group
1591 (line (string-to-number
1592 (match-string gud-pdb-marker-regexp-line-group
1594 (if (string-equal file "<string>")
1598 ;; Output everything instead of the below
1599 output (concat output (substring gud-marker-acc 0 (match-end 0)))
1600 ;; ;; Append any text before the marker to the output we're going
1601 ;; ;; to return - we don't include the marker in this text.
1602 ;; output (concat output
1603 ;; (substring gud-marker-acc 0 (match-beginning 0)))
1605 ;; Set the accumulator to the remaining text.
1606 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1608 ;; Does the remaining text look like it might end with the
1609 ;; beginning of another marker? If it does, then keep it in
1610 ;; gud-marker-acc until we receive the rest of it. Since we
1611 ;; know the full marker regexp above failed, it's pretty simple to
1612 ;; test for marker starts.
1613 (if (string-match gud-pdb-marker-regexp-start gud-marker-acc)
1615 ;; Everything before the potential marker start can be output.
1616 (setq output (concat output (substring gud-marker-acc
1617 0 (match-beginning 0))))
1619 ;; Everything after, we save, to combine with later input.
1620 (setq gud-marker-acc
1621 (substring gud-marker-acc (match-beginning 0))))
1623 (setq output (concat output gud-marker-acc)
1628 (defcustom gud-pdb-command-name "pdb"
1629 "File name for executing the Python debugger.
1630 This should be an executable on your path, or an absolute file name."
1635 (defun pdb (command-line)
1636 "Run pdb on program FILE in buffer `*gud-FILE*'.
1637 The directory containing FILE becomes the initial working directory
1638 and source-file directory for your debugger."
1640 (list (gud-query-cmdline 'pdb)))
1642 (gud-common-init command-line nil 'gud-pdb-marker-filter)
1643 (set (make-local-variable 'gud-minor-mode) 'pdb)
1645 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
1646 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
1647 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
1648 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
1649 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
1650 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1651 (gud-def gud-up "up" "<" "Up one stack frame.")
1652 (gud-def gud-down "down" ">" "Down one stack frame.")
1653 (gud-def gud-print "p %e" "\C-p" "Evaluate Python expression at point.")
1655 (gud-def gud-statement "! %e" "\C-e" "Execute Python statement at point.")
1657 ;; (setq comint-prompt-regexp "^(.*pdb[+]?) *")
1658 (setq comint-prompt-regexp "^(Pdb) *")
1659 (setq paragraph-start comint-prompt-regexp)
1660 (run-hooks 'pdb-mode-hook))
1662 ;; ======================================================================
1666 ;; AUTHOR: Derek Davies <ddavies@world.std.com>
1667 ;; Zoltan Kemenczy <zoltan@ieee.org;zkemenczy@rim.net>
1669 ;; CREATED: Sun Feb 22 10:46:38 1998 Derek Davies.
1670 ;; UPDATED: Nov 11, 2001 Zoltan Kemenczy
1671 ;; Dec 10, 2002 Zoltan Kemenczy - added nested class support
1673 ;; INVOCATION NOTES:
1675 ;; You invoke jdb-mode with:
1679 ;; It responds with:
1681 ;; Run jdb (like this): jdb
1683 ;; type any jdb switches followed by the name of the class you'd like to debug.
1684 ;; Supply a fully qualfied classname (these do not have the ".class" extension)
1685 ;; for the name of the class to debug (e.g. "COM.the-kind.ddavies.CoolClass").
1686 ;; See the known problems section below for restrictions when specifying jdb
1687 ;; command line switches (search forward for '-classpath').
1689 ;; You should see something like the following:
1691 ;; Current directory is ~/src/java/hello/
1692 ;; Initializing jdb...
1693 ;; 0xed2f6628:class(hello)
1696 ;; To set an initial breakpoint try:
1698 ;; > stop in hello.main
1699 ;; Breakpoint set in hello.main
1702 ;; To execute the program type:
1707 ;; Breakpoint hit: running ...
1708 ;; hello.main (hello:12)
1710 ;; Type M-n to step over the current line and M-s to step into it. That,
1711 ;; along with the JDB 'help' command should get you started. The 'quit'
1712 ;; JDB command will get out out of the debugger. There is some truly
1713 ;; pathetic JDB documentation available at:
1715 ;; http://java.sun.com/products/jdk/1.1/debugging/
1717 ;; KNOWN PROBLEMS AND FIXME's:
1719 ;; Not sure what happens with inner classes ... haven't tried them.
1721 ;; Does not grok UNICODE id's. Only ASCII id's are supported.
1723 ;; You must not put whitespace between "-classpath" and the path to
1724 ;; search for java classes even though it is required when invoking jdb
1725 ;; from the command line. See gud-jdb-massage-args for details.
1726 ;; The same applies for "-sourcepath".
1728 ;; Note: The following applies only if `gud-jdb-use-classpath' is nil;
1729 ;; refer to the documentation of `gud-jdb-use-classpath' and
1730 ;; `gud-jdb-classpath',`gud-jdb-sourcepath' variables for information
1731 ;; on using the classpath for locating java source files.
1733 ;; If any of the source files in the directories listed in
1734 ;; gud-jdb-directories won't parse you'll have problems. Make sure
1735 ;; every file ending in ".java" in these directories parses without error.
1737 ;; All the .java files in the directories in gud-jdb-directories are
1738 ;; syntactically analyzed each time gud jdb is invoked. It would be
1739 ;; nice to keep as much information as possible between runs. It would
1740 ;; be really nice to analyze the files only as neccessary (when the
1741 ;; source needs to be displayed.) I'm not sure to what extent the former
1742 ;; can be accomplished and I'm not sure the latter can be done at all
1743 ;; since I don't know of any general way to tell which .class files are
1744 ;; defined by which .java file without analyzing all the .java files.
1745 ;; If anyone knows why JavaSoft didn't put the source file names in
1746 ;; debuggable .class files please clue me in so I find something else
1747 ;; to be spiteful and bitter about.
1749 ;; ======================================================================
1750 ;; gud jdb variables and functions
1752 (defcustom gud-jdb-command-name "jdb"
1753 "Command that executes the Java debugger."
1757 (defcustom gud-jdb-use-classpath t
1758 "If non-nil, search for Java source files in classpath directories.
1759 The list of directories to search is the value of `gud-jdb-classpath'.
1760 The file pathname is obtained by converting the fully qualified
1761 class information output by jdb to a relative pathname and appending
1762 it to `gud-jdb-classpath' element by element until a match is found.
1764 This method has a significant jdb startup time reduction advantage
1765 since it does not require the scanning of all `gud-jdb-directories'
1766 and parsing all Java files for class information.
1768 Set to nil to use `gud-jdb-directories' to scan java sources for
1769 class information on jdb startup (original method)."
1773 (defvar gud-jdb-classpath nil
1774 "Java/jdb classpath directories list.
1775 If `gud-jdb-use-classpath' is non-nil, gud-jdb derives the `gud-jdb-classpath'
1776 list automatically using the following methods in sequence
1777 \(with subsequent successful steps overriding the results of previous
1780 1) Read the CLASSPATH environment variable,
1781 2) Read any \"-classpath\" argument used to run jdb,
1782 or detected in jdb output (e.g. if jdb is run by a script
1783 that echoes the actual jdb command before starting jdb)
1784 3) Send a \"classpath\" command to jdb and scan jdb output for
1785 classpath information if jdb is invoked with an \"-attach\" (to
1786 an already running VM) argument (This case typically does not
1787 have a \"-classpath\" command line argument - that is provided
1788 to the VM when it is started).
1790 Note that method 3 cannot be used with oldjdb (or Java 1 jdb) since
1791 those debuggers do not support the classpath command. Use 1) or 2).")
1793 (defvar gud-jdb-sourcepath nil
1794 "Directory list provided by an (optional) \"-sourcepath\" option to jdb.
1795 This list is prepended to `gud-jdb-classpath' to form the complete
1796 list of directories searched for source files.")
1798 (defvar gud-marker-acc-max-length 4000
1799 "Maximum number of debugger output characters to keep.
1800 This variable limits the size of `gud-marker-acc' which holds
1801 the most recent debugger output history while searching for
1802 source file information.")
1804 (defvar gud-jdb-history nil
1805 "History of argument lists passed to jdb.")
1808 ;; List of Java source file directories.
1809 (defvar gud-jdb-directories (list ".")
1810 "*A list of directories that gud jdb should search for source code.
1811 The file names should be absolute, or relative to the current
1814 The set of .java files residing in the directories listed are
1815 syntactically analyzed to determine the classes they define and the
1816 packages in which these classes belong. In this way gud jdb maps the
1817 package-qualified class names output by the jdb debugger to the source
1818 file from which the class originated. This allows gud mode to keep
1819 the source code display in sync with the debugging session.")
1821 (defvar gud-jdb-source-files nil
1822 "List of the java source files for this debugging session.")
1824 ;; Association list of fully qualified class names (package + class name)
1825 ;; and their source files.
1826 (defvar gud-jdb-class-source-alist nil
1827 "Association list of fully qualified class names and source files.")
1829 ;; This is used to hold a source file during analysis.
1830 (defvar gud-jdb-analysis-buffer nil)
1832 (defvar gud-jdb-classpath-string nil
1833 "Holds temporary classpath values.")
1835 (defun gud-jdb-build-source-files-list (path extn)
1836 "Return a list of java source files (absolute paths).
1837 PATH gives the directories in which to search for files with
1838 extension EXTN. Normally EXTN is given as the regular expression
1840 (apply 'nconc (mapcar (lambda (d)
1841 (when (file-directory-p d)
1842 (directory-files d t extn nil)))
1845 ;; Move point past whitespace.
1846 (defun gud-jdb-skip-whitespace ()
1847 (skip-chars-forward " \n\r\t\014"))
1849 ;; Move point past a "// <eol>" type of comment.
1850 (defun gud-jdb-skip-single-line-comment ()
1853 ;; Move point past a "/* */" or "/** */" type of comment.
1854 (defun gud-jdb-skip-traditional-or-documentation-comment ()
1858 (if (eq (following-char) ?*)
1862 (if (eq (following-char) ?/)
1865 (throw 'break nil)))))
1868 ;; Move point past any number of consecutive whitespace chars and/or comments.
1869 (defun gud-jdb-skip-whitespace-and-comments ()
1870 (gud-jdb-skip-whitespace)
1875 (gud-jdb-skip-single-line-comment)
1876 (gud-jdb-skip-whitespace))
1877 ((looking-at "/\\*")
1878 (gud-jdb-skip-traditional-or-documentation-comment)
1879 (gud-jdb-skip-whitespace))
1880 (t (throw 'done nil))))))
1882 ;; Move point past things that are id-like. The intent is to skip regular
1883 ;; id's, such as class or interface names as well as package and interface
1885 (defun gud-jdb-skip-id-ish-thing ()
1886 (skip-chars-forward "^ /\n\r\t\014,;{"))
1888 ;; Move point past a string literal.
1889 (defun gud-jdb-skip-string-literal ()
1892 ((eq (following-char) ?\\)
1894 ((eq (following-char) ?\042))))
1898 ;; Move point past a character literal.
1899 (defun gud-jdb-skip-character-literal ()
1903 (if (eq (following-char) ?\\)
1905 (not (eq (following-char) ?\')))
1909 ;; Move point past the following block. There may be (legal) cruft before
1910 ;; the block's opening brace. There must be a block or it's the end of life
1911 ;; in petticoat junction.
1912 (defun gud-jdb-skip-block ()
1914 ;; Find the begining of the block.
1916 (not (eq (following-char) ?{))
1918 ;; Skip any constructs that can harbor literal block delimiter
1919 ;; characters and/or the delimiters for the constructs themselves.
1922 (gud-jdb-skip-single-line-comment))
1923 ((looking-at "/\\*")
1924 (gud-jdb-skip-traditional-or-documentation-comment))
1925 ((eq (following-char) ?\042)
1926 (gud-jdb-skip-string-literal))
1927 ((eq (following-char) ?\')
1928 (gud-jdb-skip-character-literal))
1929 (t (forward-char))))
1931 ;; Now at the begining of the block.
1934 ;; Skip over the body of the block as well as the final brace.
1935 (let ((open-level 1))
1936 (while (not (eq open-level 0))
1939 (gud-jdb-skip-single-line-comment))
1940 ((looking-at "/\\*")
1941 (gud-jdb-skip-traditional-or-documentation-comment))
1942 ((eq (following-char) ?\042)
1943 (gud-jdb-skip-string-literal))
1944 ((eq (following-char) ?\')
1945 (gud-jdb-skip-character-literal))
1946 ((eq (following-char) ?{)
1947 (setq open-level (+ open-level 1))
1949 ((eq (following-char) ?})
1950 (setq open-level (- open-level 1))
1952 (t (forward-char))))))
1954 ;; Find the package and class definitions in Java source file FILE. Assumes
1955 ;; that FILE contains a legal Java program. BUF is a scratch buffer used
1956 ;; to hold the source during analysis.
1957 (defun gud-jdb-analyze-source (buf file)
1960 (insert-file-contents file nil nil nil t)
1965 (gud-jdb-skip-whitespace)
1969 ;; Any number of semi's following a block is legal. Move point
1970 ;; past them. Note that comments and whitespace may be
1971 ;; interspersed as well.
1972 ((eq (following-char) ?\073)
1975 ;; Move point past a single line comment.
1977 (gud-jdb-skip-single-line-comment))
1979 ;; Move point past a traditional or documentation comment.
1980 ((looking-at "/\\*")
1981 (gud-jdb-skip-traditional-or-documentation-comment))
1983 ;; Move point past a package statement, but save the PackageName.
1984 ((looking-at "package")
1986 (gud-jdb-skip-whitespace-and-comments)
1988 (gud-jdb-skip-id-ish-thing)
1989 (setq p (concat (buffer-substring s (point)) "."))
1990 (gud-jdb-skip-whitespace-and-comments)
1991 (if (eq (following-char) ?\073)
1994 ;; Move point past an import statement.
1995 ((looking-at "import")
1997 (gud-jdb-skip-whitespace-and-comments)
1998 (gud-jdb-skip-id-ish-thing)
1999 (gud-jdb-skip-whitespace-and-comments)
2000 (if (eq (following-char) ?\073)
2003 ;; Move point past the various kinds of ClassModifiers.
2004 ((looking-at "public")
2006 ((looking-at "abstract")
2008 ((looking-at "final")
2011 ;; Move point past a ClassDeclaraction, but save the class
2013 ((looking-at "class")
2015 (gud-jdb-skip-whitespace-and-comments)
2017 (gud-jdb-skip-id-ish-thing)
2019 l (nconc l (list (concat p (buffer-substring s (point)))))))
2020 (gud-jdb-skip-block))
2022 ;; Move point past an interface statement.
2023 ((looking-at "interface")
2025 (gud-jdb-skip-block))
2027 ;; Anything else means the input is invalid.
2029 (message "Error parsing file %s." file)
2030 (throw 'abort nil))))))
2033 (defun gud-jdb-build-class-source-alist-for-file (file)
2037 (gud-jdb-analyze-source gud-jdb-analysis-buffer file)))
2039 ;; Return an alist of fully qualified classes and the source files
2040 ;; holding their definitions. SOURCES holds a list of all the source
2041 ;; files to examine.
2042 (defun gud-jdb-build-class-source-alist (sources)
2043 (setq gud-jdb-analysis-buffer (get-buffer-create " *gud-jdb-scratch*"))
2048 'gud-jdb-build-class-source-alist-for-file
2050 (kill-buffer gud-jdb-analysis-buffer)
2051 (setq gud-jdb-analysis-buffer nil)))
2053 ;; Change what was given in the minibuffer to something that can be used to
2054 ;; invoke the debugger.
2055 (defun gud-jdb-massage-args (file args)
2056 ;; The jdb executable must have whitespace between "-classpath" and
2057 ;; its value while gud-common-init expects all switch values to
2058 ;; follow the switch keyword without intervening whitespace. We
2059 ;; require that when the user enters the "-classpath" switch in the
2060 ;; EMACS minibuffer that they do so without the intervening
2061 ;; whitespace. This function adds it back (it's called after
2062 ;; gud-common-init). There are more switches like this (for
2063 ;; instance "-host" and "-password") but I don't care about them
2066 (let (massaged-args user-error)
2068 (while (and args (not user-error))
2070 ((setq user-error (string-match "-classpath$" (car args))))
2071 ((setq user-error (string-match "-sourcepath$" (car args))))
2072 ((string-match "-classpath\\(.+\\)" (car args))
2074 (append massaged-args
2076 (setq gud-jdb-classpath-string
2077 (match-string 1 (car args)))))))
2078 ((string-match "-sourcepath\\(.+\\)" (car args))
2080 (append massaged-args
2082 (setq gud-jdb-sourcepath
2083 (match-string 1 (car args)))))))
2084 (t (setq massaged-args (append massaged-args (list (car args))))))
2085 (setq args (cdr args)))
2087 ;; By this point the current directory is all screwed up. Maybe we
2088 ;; could fix things and re-invoke gud-common-init, but for now I think
2089 ;; issueing the error is good enough.
2092 (kill-buffer (current-buffer))
2093 (error "Error: Omit whitespace between '-classpath or -sourcepath' and its value")))
2096 ;; Search for an association with P, a fully qualified class name, in
2097 ;; gud-jdb-class-source-alist. The asssociation gives the fully
2098 ;; qualified file name of the source file which produced the class.
2099 (defun gud-jdb-find-source-file (p)
2100 (cdr (assoc p gud-jdb-class-source-alist)))
2102 ;; Note: Reset to this value every time a prompt is seen
2103 (defvar gud-jdb-lowest-stack-level 999)
2105 (defun gud-jdb-find-source-using-classpath (p)
2106 "Find source file corresponding to fully qualified class p.
2107 Convert p from jdb's output, converted to a pathname
2108 relative to a classpath directory."
2111 (;; Replace dots with slashes and append ".java" to generate file
2112 ;; name relative to classpath
2115 (mapconcat 'identity
2117 ;; Eliminate any subclass references in the class
2118 ;; name string. These start with a "$"
2120 (if (string-match "$.*" x)
2121 (replace-match "" t t x) p))
2125 (cplist (append gud-jdb-sourcepath gud-jdb-classpath))
2128 (not (setq found-file
2130 (concat (car cplist) "/" filename)))))
2131 (setq cplist (cdr cplist)))
2132 (if found-file (concat (car cplist) "/" filename)))))
2134 (defun gud-jdb-find-source (string)
2135 "Alias for function used to locate source files.
2136 Set to `gud-jdb-find-source-using-classpath' or `gud-jdb-find-source-file'
2137 during jdb initialization depending on the value of
2138 `gud-jdb-use-classpath'."
2141 (defun gud-jdb-parse-classpath-string (string)
2142 "Parse the classpath list and convert each item to an absolute pathname."
2143 (mapcar (lambda (s) (if (string-match "[/\\]$" s)
2144 (replace-match "" nil nil s) s))
2145 (mapcar 'file-truename
2148 (concat "[ \t\n\r,\"" path-separator "]+")))))
2150 ;; See comentary for other debugger's marker filters - there you will find
2151 ;; important notes about STRING.
2152 (defun gud-jdb-marker-filter (string)
2154 ;; Build up the accumulator.
2155 (setq gud-marker-acc
2157 (concat gud-marker-acc string)
2160 ;; Look for classpath information until gud-jdb-classpath-string is found
2161 ;; (interactive, multiple settings of classpath from jdb
2162 ;; not supported/followed)
2163 (if (and gud-jdb-use-classpath
2164 (not gud-jdb-classpath-string)
2165 (or (string-match "classpath:[ \t[]+\\([^]]+\\)" gud-marker-acc)
2166 (string-match "-classpath[ \t\"]+\\([^ \"]+\\)" gud-marker-acc)))
2167 (setq gud-jdb-classpath
2168 (gud-jdb-parse-classpath-string
2169 (setq gud-jdb-classpath-string
2170 (match-string 1 gud-marker-acc)))))
2172 ;; We process STRING from left to right. Each time through the
2173 ;; following loop we process at most one marker. After we've found a
2174 ;; marker, delete gud-marker-acc up to and including the match
2176 ;; Process each complete marker in the input.
2179 ;; Do we see a marker?
2181 ;; jdb puts out a string of the following form when it
2182 ;; hits a breakpoint:
2184 ;; <fully-qualified-class><method> (<class>:<line-number>)
2186 ;; <fully-qualified-class>'s are composed of Java ID's
2187 ;; separated by periods. <method> and <class> are
2188 ;; also Java ID's. <method> begins with a period and
2189 ;; may contain less-than and greater-than (constructors,
2190 ;; for instance, are called <init> in the symbol table.)
2191 ;; Java ID's begin with a letter followed by letters
2192 ;; and/or digits. The set of letters includes underscore
2195 ;; The first group matches <fully-qualified-class>,
2196 ;; the second group matches <class> and the third group
2197 ;; matches <line-number>. We don't care about using
2198 ;; <method> so we don't "group" it.
2200 ;; FIXME: Java ID's are UNICODE strings, this matches ASCII
2203 ;; The ".," in the last square-bracket are necessary because
2204 ;; of Sun's total disrespect for backwards compatibility in
2205 ;; reported line numbers from jdb - starting in 1.4.0 they
2206 ;; print line numbers using LOCALE, inserting a comma or a
2207 ;; period at the thousands positions (how ingenious!).
2209 "\\(\\[[0-9]+] \\)*\\([a-zA-Z0-9.$_]+\\)\\.[a-zA-Z0-9$_<>(),]+ \
2210 \\(([a-zA-Z0-9.$_]+:\\|line=\\)\\([0-9.,]+\\)"
2213 ;; A good marker is one that:
2214 ;; 1) does not have a "[n] " prefix (not part of a stack backtrace)
2215 ;; 2) does have an "[n] " prefix and n is the lowest prefix seen
2216 ;; since the last prompt
2217 ;; Figure out the line on which to position the debugging arrow.
2218 ;; Return the info as a cons of the form:
2220 ;; (<file-name> . <line-number>) .
2221 (if (if (match-beginning 1)
2223 (setq n (string-to-number (substring
2225 (1+ (match-beginning 1))
2226 (- (match-end 1) 2))))
2227 (if (< n gud-jdb-lowest-stack-level)
2228 (progn (setq gud-jdb-lowest-stack-level n) t)))
2230 (if (setq file-found
2231 (gud-jdb-find-source (match-string 2 gud-marker-acc)))
2232 (setq gud-last-frame
2236 ((numstr (match-string 4 gud-marker-acc)))
2237 (if (string-match "[.,]" numstr)
2238 (replace-match "" nil nil numstr)
2240 (message "Could not find source file.")))
2242 ;; Set the accumulator to the remaining text.
2243 (setq gud-marker-acc (substring gud-marker-acc (match-end 0))))
2245 (if (string-match comint-prompt-regexp gud-marker-acc)
2246 (setq gud-jdb-lowest-stack-level 999)))
2248 ;; Do not allow gud-marker-acc to grow without bound. If the source
2249 ;; file information is not within the last 3/4
2250 ;; gud-marker-acc-max-length characters, well,...
2251 (if (> (length gud-marker-acc) gud-marker-acc-max-length)
2252 (setq gud-marker-acc
2253 (substring gud-marker-acc
2254 (- (/ (* gud-marker-acc-max-length 3) 4)))))
2256 ;; We don't filter any debugger output so just return what we were given.
2259 (defvar gud-jdb-command-name "jdb" "Command that executes the Java debugger.")
2262 (defun jdb (command-line)
2263 "Run jdb with command line COMMAND-LINE in a buffer.
2264 The buffer is named \"*gud*\" if no initial class is given or
2265 \"*gud-<initial-class-basename>*\" if there is. If the \"-classpath\"
2266 switch is given, omit all whitespace between it and its value.
2268 See `gud-jdb-use-classpath' and `gud-jdb-classpath' documentation for
2269 information on how jdb accesses source files. Alternatively (if
2270 `gud-jdb-use-classpath' is nil), see `gud-jdb-directories' for the
2271 original source file access method.
2273 For general information about commands available to control jdb from
2274 gud, see `gud-mode'."
2276 (list (gud-query-cmdline 'jdb)))
2277 (setq gud-jdb-classpath nil)
2278 (setq gud-jdb-sourcepath nil)
2280 ;; Set gud-jdb-classpath from the CLASSPATH environment variable,
2281 ;; if CLASSPATH is set.
2282 (setq gud-jdb-classpath-string (getenv "CLASSPATH"))
2283 (if gud-jdb-classpath-string
2284 (setq gud-jdb-classpath
2285 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2286 (setq gud-jdb-classpath-string nil) ; prepare for next
2288 (gud-common-init command-line 'gud-jdb-massage-args
2289 'gud-jdb-marker-filter)
2290 (set (make-local-variable 'gud-minor-mode) 'jdb)
2292 ;; If a -classpath option was provided, set gud-jdb-classpath
2293 (if gud-jdb-classpath-string
2294 (setq gud-jdb-classpath
2295 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2296 (setq gud-jdb-classpath-string nil) ; prepare for next
2297 ;; If a -sourcepath option was provided, parse it
2298 (if gud-jdb-sourcepath
2299 (setq gud-jdb-sourcepath
2300 (gud-jdb-parse-classpath-string gud-jdb-sourcepath)))
2302 (gud-def gud-break "stop at %c:%l" "\C-b" "Set breakpoint at current line.")
2303 (gud-def gud-remove "clear %c:%l" "\C-d" "Remove breakpoint at current line")
2304 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2305 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2306 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
2307 (gud-def gud-finish "step up" "\C-f" "Continue until current method returns.")
2308 (gud-def gud-up "up\C-Mwhere" "<" "Up one stack frame.")
2309 (gud-def gud-down "down\C-Mwhere" ">" "Up one stack frame.")
2310 (gud-def gud-run "run" nil "Run the program.") ;if VM start using jdb
2311 (gud-def gud-print "print %e" "\C-p" "Evaluate Java expression at point.")
2314 (setq comint-prompt-regexp "^> \\|^[^ ]+\\[[0-9]+\\] ")
2315 (setq paragraph-start comint-prompt-regexp)
2316 (run-hooks 'jdb-mode-hook)
2318 (if gud-jdb-use-classpath
2319 ;; Get the classpath information from the debugger
2321 (if (string-match "-attach" command-line)
2322 (gud-call "classpath"))
2323 (fset 'gud-jdb-find-source
2324 'gud-jdb-find-source-using-classpath))
2326 ;; Else create and bind the class/source association list as well
2327 ;; as the source file list.
2328 (setq gud-jdb-class-source-alist
2329 (gud-jdb-build-class-source-alist
2330 (setq gud-jdb-source-files
2331 (gud-jdb-build-source-files-list gud-jdb-directories
2333 (fset 'gud-jdb-find-source 'gud-jdb-find-source-file)))
2336 ;; End of debugger-specific information
2340 ;; When we send a command to the debugger via gud-call, it's annoying
2341 ;; to see the command and the new prompt inserted into the debugger's
2342 ;; buffer; we have other ways of knowing the command has completed.
2344 ;; If the buffer looks like this:
2345 ;; --------------------
2346 ;; (gdb) set args foo bar
2348 ;; --------------------
2349 ;; (the -!- marks the location of point), and we type `C-x SPC' in a
2350 ;; source file to set a breakpoint, we want the buffer to end up like
2352 ;; --------------------
2353 ;; (gdb) set args foo bar
2354 ;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
2356 ;; --------------------
2357 ;; Essentially, the old prompt is deleted, and the command's output
2358 ;; and the new prompt take its place.
2360 ;; Not echoing the command is easy enough; you send it directly using
2361 ;; process-send-string, and it never enters the buffer. However,
2362 ;; getting rid of the old prompt is trickier; you don't want to do it
2363 ;; when you send the command, since that will result in an annoying
2364 ;; flicker as the prompt is deleted, redisplay occurs while Emacs
2365 ;; waits for a response from the debugger, and the new prompt is
2366 ;; inserted. Instead, we'll wait until we actually get some output
2367 ;; from the subprocess before we delete the prompt. If the command
2368 ;; produced no output other than a new prompt, that prompt will most
2369 ;; likely be in the first chunk of output received, so we will delete
2370 ;; the prompt and then replace it with an identical one. If the
2371 ;; command produces output, the prompt is moving anyway, so the
2372 ;; flicker won't be annoying.
2374 ;; So - when we want to delete the prompt upon receipt of the next
2375 ;; chunk of debugger output, we position gud-delete-prompt-marker at
2376 ;; the start of the prompt; the process filter will notice this, and
2377 ;; delete all text between it and the process output marker. If
2378 ;; gud-delete-prompt-marker points nowhere, we leave the current
2380 (defvar gud-delete-prompt-marker nil)
2383 (put 'gud-mode 'mode-class 'special)
2385 (define-derived-mode gud-mode comint-mode "Debugger"
2386 "Major mode for interacting with an inferior debugger process.
2388 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
2389 M-x perldb, M-x xdb, or M-x jdb. Each entry point finishes by executing a
2390 hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook',
2391 `perldb-mode-hook', `xdb-mode-hook', or `jdb-mode-hook' respectively.
2393 After startup, the following commands are available in both the GUD
2394 interaction buffer and any source buffer GUD visits due to a breakpoint stop
2397 \\[gud-break] sets a breakpoint at the current file and line. In the
2398 GUD buffer, the current file and line are those of the last breakpoint or
2399 step. In a source buffer, they are the buffer's file and current line.
2401 \\[gud-remove] removes breakpoints on the current file and line.
2403 \\[gud-refresh] displays in the source window the last line referred to
2406 \\[gud-step], \\[gud-next], and \\[gud-stepi] do a step-one-line,
2407 step-one-line (not entering function calls), and step-one-instruction
2408 and then update the source window with the current file and position.
2409 \\[gud-cont] continues execution.
2411 \\[gud-print] tries to find the largest C lvalue or function-call expression
2412 around point, and sends it to the debugger for value display.
2414 The above commands are common to all supported debuggers except xdb which
2415 does not support stepping instructions.
2417 Under gdb, sdb and xdb, \\[gud-tbreak] behaves exactly like \\[gud-break],
2418 except that the breakpoint is temporary; that is, it is removed when
2419 execution stops on it.
2421 Under gdb, dbx, and xdb, \\[gud-up] pops up through an enclosing stack
2422 frame. \\[gud-down] drops back down through one.
2424 If you are using gdb or xdb, \\[gud-finish] runs execution to the return from
2425 the current function and stops.
2427 All the keystrokes above are accessible in the GUD buffer
2428 with the prefix C-c, and in all buffers through the prefix C-x C-a.
2430 All pre-defined functions for which the concept make sense repeat
2431 themselves the appropriate number of times if you give a prefix
2434 You may use the `gud-def' macro in the initialization hook to define other
2437 Other commands for interacting with the debugger process are inherited from
2438 comint mode, which see."
2439 (setq mode-line-process '(":%s"))
2440 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
2441 (set (make-local-variable 'gud-last-frame) nil)
2442 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
2443 (make-local-variable 'comint-prompt-regexp)
2444 ;; Don't put repeated commands in command history many times.
2445 (set (make-local-variable 'comint-input-ignoredups) t)
2446 (make-local-variable 'paragraph-start)
2447 (set (make-local-variable 'gud-delete-prompt-marker) (make-marker))
2448 (add-hook 'kill-buffer-hook 'gud-kill-buffer-hook nil t))
2450 ;; Cause our buffers to be displayed, by default,
2451 ;; in the selected window.
2452 ;;;###autoload (add-hook 'same-window-regexps "\\*gud-.*\\*\\(\\|<[0-9]+>\\)")
2454 (defcustom gud-chdir-before-run t
2455 "Non-nil if GUD should `cd' to the debugged executable."
2459 (defvar gud-target-name "--unknown--"
2460 "The apparent name of the program being debugged in a gud buffer.")
2462 ;; Perform initializations common to all debuggers.
2463 ;; The first arg is the specified command line,
2464 ;; which starts with the program to debug.
2465 ;; The other three args specify the values to use
2466 ;; for local variables in the debugger buffer.
2467 (defun gud-common-init (command-line massage-args marker-filter
2468 &optional find-file)
2469 (let* ((words (split-string-and-unquote command-line))
2470 (program (car words))
2471 (dir default-directory)
2472 ;; Extract the file name from WORDS
2473 ;; and put t in its place.
2474 ;; Later on we will put the modified file name arg back there.
2475 (file-word (let ((w (cdr words)))
2476 (while (and w (= ?- (aref (car w) 0)))
2482 (and file-word (substitute-in-file-name file-word)))
2484 ;; If a directory was specified, expand the file name.
2485 ;; Otherwise, don't expand it, so GDB can use the PATH.
2486 ;; A file name without directory is literally valid
2487 ;; only if the file exists in ., and in that case,
2488 ;; omitting the expansion here has no visible effect.
2489 (file (and file-word
2490 (if (file-name-directory file-subst)
2491 (expand-file-name file-subst)
2493 (filepart (and file-word (concat "-" (file-name-nondirectory file))))
2494 (existing-buffer (get-buffer (concat "*gud" filepart "*"))))
2495 (pop-to-buffer (concat "*gud" filepart "*"))
2496 (when (and existing-buffer (get-buffer-process existing-buffer))
2497 (error "This program is already being debugged"))
2498 ;; Set the dir, in case the buffer already existed with a different dir.
2499 (setq default-directory dir)
2500 ;; Set default-directory to the file's directory.
2502 gud-chdir-before-run
2503 ;; Don't set default-directory if no directory was specified.
2504 ;; In that case, either the file is found in the current directory,
2505 ;; in which case this setq is a no-op,
2506 ;; or it is found by searching PATH,
2507 ;; in which case we don't know what directory it was found in.
2508 (file-name-directory file)
2509 (setq default-directory (file-name-directory file)))
2510 (or (bolp) (newline))
2511 (insert "Current directory is " default-directory "\n")
2512 ;; Put the substituted and expanded file name back in its place.
2514 (while (and w (not (eq (car w) t)))
2518 (apply 'make-comint (concat "gud" filepart) program nil
2519 (if massage-args (funcall massage-args file args) args))
2520 ;; Since comint clobbered the mode, we don't set it until now.
2522 (set (make-local-variable 'gud-target-name)
2523 (and file-word (file-name-nondirectory file))))
2524 (set (make-local-variable 'gud-marker-filter) marker-filter)
2525 (if find-file (set (make-local-variable 'gud-find-file) find-file))
2526 (setq gud-last-last-frame nil)
2528 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
2529 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
2532 (defun gud-set-buffer ()
2533 (when (eq major-mode 'gud-mode)
2534 (setq gud-comint-buffer (current-buffer))))
2536 (defvar gud-filter-defer-flag nil
2537 "Non-nil means don't process anything from the debugger right now.
2538 It is saved for when this flag is not set.")
2540 ;; These functions are responsible for inserting output from your debugger
2541 ;; into the buffer. The hard work is done by the method that is
2542 ;; the value of gud-marker-filter.
2544 (defun gud-filter (proc string)
2545 ;; Here's where the actual buffer insertion is done
2546 (let (output process-window)
2547 (if (buffer-name (process-buffer proc))
2548 (if gud-filter-defer-flag
2549 ;; If we can't process any text now,
2550 ;; save it for later.
2551 (setq gud-filter-pending-text
2552 (concat (or gud-filter-pending-text "") string))
2554 ;; If we have to ask a question during the processing,
2555 ;; defer any additional text that comes from the debugger
2556 ;; during that time.
2557 (let ((gud-filter-defer-flag t))
2558 ;; Process now any text we previously saved up.
2559 (if gud-filter-pending-text
2560 (setq string (concat gud-filter-pending-text string)
2561 gud-filter-pending-text nil))
2563 (with-current-buffer (process-buffer proc)
2564 ;; If we have been so requested, delete the debugger prompt.
2567 (if (marker-buffer gud-delete-prompt-marker)
2568 (let ((inhibit-read-only t))
2569 (delete-region (process-mark proc)
2570 gud-delete-prompt-marker)
2571 (comint-update-fence)
2572 (set-marker gud-delete-prompt-marker nil)))
2573 ;; Save the process output, checking for source file markers.
2574 (setq output (gud-marker-filter string))
2575 ;; Check for a filename-and-line number.
2576 ;; Don't display the specified file
2577 ;; unless (1) point is at or after the position where output appears
2578 ;; and (2) this buffer is on the screen.
2579 (setq process-window
2581 (>= (point) (process-mark proc))
2582 (get-buffer-window (current-buffer)))))
2584 ;; Let the comint filter do the actual insertion.
2585 ;; That lets us inherit various comint features.
2586 (comint-output-filter proc output))
2588 ;; Put the arrow on the source line.
2589 ;; This must be outside of the save-excursion
2590 ;; in case the source file is our current buffer.
2592 (with-selected-window process-window
2593 (gud-display-frame))
2594 ;; We have to be in the proper buffer, (process-buffer proc),
2595 ;; but not in a save-excursion, because that would restore point.
2596 (with-current-buffer (process-buffer proc)
2597 (gud-display-frame))))
2599 ;; If we deferred text that arrived during this processing,
2601 (if gud-filter-pending-text
2602 (gud-filter proc ""))))))
2604 (defvar gud-minor-mode-type nil)
2605 (defvar gud-overlay-arrow-position nil)
2606 (add-to-list 'overlay-arrow-variable-list 'gud-overlay-arrow-position)
2608 (defun gud-sentinel (proc msg)
2609 (cond ((null (buffer-name (process-buffer proc)))
2611 ;; Stop displaying an arrow in a source file.
2612 (setq gud-overlay-arrow-position nil)
2613 (set-process-buffer proc nil)
2614 (if (and (boundp 'speedbar-frame)
2615 (string-equal speedbar-initial-expansion-list-name "GUD"))
2616 (speedbar-change-initial-expansion-list
2617 speedbar-previously-used-expansion-list-name))
2618 (if (memq gud-minor-mode-type '(gdbmi gdba))
2621 ((memq (process-status proc) '(signal exit))
2622 ;; Stop displaying an arrow in a source file.
2623 (setq gud-overlay-arrow-position nil)
2624 (if (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
2628 (let* ((obuf (current-buffer)))
2629 ;; save-excursion isn't the right thing if
2630 ;; process-buffer is current-buffer
2633 ;; Write something in the GUD buffer and hack its mode line,
2634 (set-buffer (process-buffer proc))
2635 ;; Fix the mode line.
2636 (setq mode-line-process
2638 (symbol-name (process-status proc))))
2639 (force-mode-line-update)
2641 (insert ?\n mode-name " " msg)
2643 (goto-char (point-max))
2644 (insert ?\n mode-name " " msg)))
2645 ;; If buffer and mode line will show that the process
2646 ;; is dead, we can delete it now. Otherwise it
2647 ;; will stay around until M-x list-processes.
2648 (delete-process proc))
2649 ;; Restore old buffer, but don't restore old point
2650 ;; if obuf is the gud buffer.
2651 (set-buffer obuf))))))
2653 (defun gud-kill-buffer-hook ()
2654 (setq gud-minor-mode-type gud-minor-mode)
2656 (kill-process (get-buffer-process (current-buffer)))
2660 (dolist (buffer (buffer-list))
2661 (unless (eq buffer gud-comint-buffer)
2662 (with-current-buffer buffer
2663 (when gud-minor-mode
2664 (setq gud-minor-mode nil)
2665 (kill-local-variable 'tool-bar-map))))))
2667 (defun gud-display-frame ()
2668 "Find and obey the last filename-and-line marker from the debugger.
2669 Obeying it means displaying in another window the specified file and line."
2671 (when gud-last-frame
2673 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
2674 (setq gud-last-last-frame gud-last-frame
2675 gud-last-frame nil)))
2677 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
2678 ;; and that its line LINE is visible.
2679 ;; Put the overlay-arrow on the line LINE in that buffer.
2680 ;; Most of the trickiness in here comes from wanting to preserve the current
2681 ;; region-restriction if that's possible. We use an explicit display-buffer
2682 ;; to get around the fact that this is called inside a save-excursion.
2684 (defun gud-display-line (true-file line)
2685 (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
2687 (with-current-buffer gud-comint-buffer
2688 (gud-find-file true-file)))
2690 (or (get-buffer-window buffer)
2691 (if (memq gud-minor-mode '(gdbmi gdba))
2692 (or (if (get-buffer-window buffer 0)
2693 (display-buffer buffer nil 0))
2694 (unless (gdb-display-source-buffer buffer)
2695 (gdb-display-buffer buffer nil))))
2696 (display-buffer buffer))))
2700 (with-current-buffer buffer
2701 (unless (or (verify-visited-file-modtime buffer) gud-keep-buffer)
2703 (format "File %s changed on disk. Reread from disk? "
2706 (setq gud-keep-buffer t)))
2711 (or gud-overlay-arrow-position
2712 (setq gud-overlay-arrow-position (make-marker)))
2713 (set-marker gud-overlay-arrow-position (point) (current-buffer))
2714 ;; If they turned on hl-line, move the hl-line highlight to
2715 ;; the arrow's line.
2716 (when (featurep 'hl-line)
2718 (global-hl-line-mode
2719 (global-hl-line-highlight))
2720 ((and hl-line-mode hl-line-sticky-flag)
2721 (hl-line-highlight)))))
2722 (cond ((or (< pos (point-min)) (> pos (point-max)))
2726 (set-window-point window gud-overlay-arrow-position)
2727 (if (memq gud-minor-mode '(gdbmi gdba))
2728 (setq gdb-source-window window)))))))
2730 ;; The gud-call function must do the right thing whether its invoking
2731 ;; keystroke is from the GUD buffer itself (via major-mode binding)
2732 ;; or a C buffer. In the former case, we want to supply data from
2733 ;; gud-last-frame. Here's how we do it:
2735 (defun gud-format-command (str arg)
2736 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
2737 (frame (or gud-last-frame gud-last-last-frame))
2740 (let ((case-fold-search nil))
2741 (string-match "\\([^%]*\\)%\\([adefFlpc]\\)" str)))
2742 (let ((key (string-to-char (match-string 2 str)))
2746 (setq subst (file-name-nondirectory (if insource
2750 (setq subst (file-name-sans-extension
2751 (file-name-nondirectory (if insource
2755 (setq subst (file-name-directory (if insource
2759 (setq subst (int-to-string
2763 (+ (count-lines (point-min) (point))
2767 (setq subst (gud-find-expr)))
2769 (setq subst (gud-read-address)))
2779 (+ (count-lines (point-min) (point))
2783 (setq subst (if arg (int-to-string arg)))))
2784 (setq result (concat result (match-string 1 str) subst)))
2785 (setq str (substring str (match-end 2))))
2786 ;; There might be text left in STR when the loop ends.
2787 (concat result str)))
2789 (defun gud-read-address ()
2790 "Return a string containing the core-address found in the buffer at point."
2793 (let ((pt (point)) found begin)
2794 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
2796 (found (forward-char 2)
2797 (buffer-substring found
2798 (progn (re-search-forward "[^0-9a-f]")
2801 (t (setq begin (progn (re-search-backward "[^0-9]")
2805 (re-search-forward "[^0-9]")
2807 (buffer-substring begin (point))))))))
2809 (defun gud-call (fmt &optional arg)
2810 (let ((msg (gud-format-command fmt arg)))
2811 (message "Command: %s" msg)
2813 (gud-basic-call msg)))
2815 (defun gud-basic-call (command)
2816 "Invoke the debugger COMMAND displaying source in other window."
2819 (let ((proc (get-buffer-process gud-comint-buffer)))
2820 (or proc (error "Current buffer has no process"))
2821 ;; Arrange for the current prompt to get deleted.
2823 (set-buffer gud-comint-buffer)
2826 (if (marker-position gud-delete-prompt-marker)
2827 ;; We get here when printing an expression.
2828 (goto-char gud-delete-prompt-marker)
2829 (goto-char (process-mark proc))
2831 (if (looking-at comint-prompt-regexp)
2832 (set-marker gud-delete-prompt-marker (point)))
2833 (if (memq gud-minor-mode '(gdbmi gdba))
2834 (apply comint-input-sender (list proc command))
2835 (process-send-string proc (concat command "\n")))))))
2837 (defun gud-refresh (&optional arg)
2838 "Fix up a possibly garbled display, and redraw the arrow."
2840 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
2844 ;; Code for parsing expressions out of C or Fortran code. The single entry
2845 ;; point is gud-find-expr, which tries to return an lvalue expression from
2848 (defvar gud-find-expr-function 'gud-find-c-expr)
2850 (defun gud-find-expr (&rest args)
2851 (let ((expr (if (and transient-mark-mode mark-active)
2852 (buffer-substring (region-beginning) (region-end))
2853 (apply gud-find-expr-function args))))
2855 (if (string-match "\n" expr)
2856 (error "Expression must not include a newline"))
2857 (with-current-buffer gud-comint-buffer
2859 (goto-char (process-mark (get-buffer-process gud-comint-buffer)))
2861 (when (looking-at comint-prompt-regexp)
2862 (set-marker gud-delete-prompt-marker (point))
2863 (set-marker-insertion-type gud-delete-prompt-marker t))
2864 (unless (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
2866 (insert (concat expr " = "))))))
2869 ;; The next eight functions are hacked from gdbsrc.el by
2870 ;; Debby Ayers <ayers@asc.slb.com>,
2871 ;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
2873 (defun gud-find-c-expr ()
2874 "Returns the expr that surrounds point."
2878 (expr (gud-innermost-expr))
2879 (test-expr (gud-prev-expr)))
2880 (while (and test-expr (gud-expr-compound test-expr expr))
2881 (let ((prev-expr expr))
2882 (setq expr (cons (car test-expr) (cdr expr)))
2883 (goto-char (car expr))
2884 (setq test-expr (gud-prev-expr))
2885 ;; If we just pasted on the condition of an if or while,
2886 ;; throw it away again.
2887 (if (member (buffer-substring (car test-expr) (cdr test-expr))
2888 '("if" "while" "for"))
2892 (setq test-expr (gud-next-expr))
2893 (while (gud-expr-compound expr test-expr)
2894 (setq expr (cons (car expr) (cdr test-expr)))
2895 (setq test-expr (gud-next-expr)))
2896 (buffer-substring (car expr) (cdr expr)))))
2898 (defun gud-innermost-expr ()
2899 "Returns the smallest expr that point is in; move point to beginning of it.
2900 The expr is represented as a cons cell, where the car specifies the point in
2901 the current buffer that marks the beginning of the expr and the cdr specifies
2902 the character after the end of the expr."
2903 (let ((p (point)) begin end)
2905 (setq begin (point))
2918 (defun gud-backward-sexp ()
2919 "Version of `backward-sexp' that catches errors."
2924 (defun gud-forward-sexp ()
2925 "Version of `forward-sexp' that catches errors."
2930 (defun gud-prev-expr ()
2931 "Returns the previous expr, point is set to beginning of that expr.
2932 The expr is represented as a cons cell, where the car specifies the point in
2933 the current buffer that marks the beginning of the expr and the cdr specifies
2934 the character after the end of the expr"
2935 (let ((begin) (end))
2937 (setq begin (point))
2943 (defun gud-next-expr ()
2944 "Returns the following expr, point is set to beginning of that expr.
2945 The expr is represented as a cons cell, where the car specifies the point in
2946 the current buffer that marks the beginning of the expr and the cdr specifies
2947 the character after the end of the expr."
2948 (let ((begin) (end))
2953 (setq begin (point))
2956 (defun gud-expr-compound-sep (span-start span-end)
2957 "Scan from SPAN-START to SPAN-END for punctuation characters.
2958 If `->' is found, return `?.'. If `.' is found, return `?.'.
2959 If any other punctuation is found, return `??'.
2960 If no punctuation is found, return `? '."
2963 (while (< span-start span-end)
2964 (setq syntax (char-syntax (char-after span-start)))
2967 ((= syntax ?.) (setq syntax (char-after span-start))
2969 ((= syntax ?.) (setq result ?.))
2970 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
2972 (setq span-start (+ span-start 1)))
2973 (t (setq span-start span-end)
2974 (setq result ??)))))
2975 (setq span-start (+ span-start 1)))
2978 (defun gud-expr-compound (first second)
2979 "Non-nil if concatenating FIRST and SECOND makes a single C expression.
2980 The two exprs are represented as a cons cells, where the car
2981 specifies the point in the current buffer that marks the beginning of the
2982 expr and the cdr specifies the character after the end of the expr.
2983 Link exprs of the form:
2990 (let ((span-start (cdr first))
2991 (span-end (car second))
2993 (setq syntax (gud-expr-compound-sep span-start span-end))
2995 ((= (car first) (car second)) nil)
2996 ((= (cdr first) (cdr second)) nil)
2999 (setq span-start (char-after (- span-start 1)))
3000 (setq span-end (char-after span-end))
3002 ((= span-start ?)) t)
3003 ((= span-start ?]) t)
3009 (defun gud-find-class (f line)
3010 "Find fully qualified class in file F at line LINE.
3011 This function uses the `gud-jdb-classpath' (and optional
3012 `gud-jdb-sourcepath') list(s) to derive a file
3013 pathname relative to its classpath directory. The values in
3014 `gud-jdb-classpath' are assumed to have been converted to absolute
3015 pathname standards using file-truename.
3016 If F is visited by a buffer and its mode is CC-mode(Java),
3017 syntactic information of LINE is used to find the enclosing (nested)
3018 class string which is appended to the top level
3019 class of the file (using s to separate nested class ids)."
3020 ;; Convert f to a standard representation and remove suffix
3021 (if (and gud-jdb-use-classpath (or gud-jdb-classpath gud-jdb-sourcepath))
3023 (let ((cplist (append gud-jdb-sourcepath gud-jdb-classpath))
3024 (fbuffer (get-file-buffer f))
3025 syntax-symbol syntax-point class-found)
3026 (setq f (file-name-sans-extension (file-truename f)))
3027 ;; Syntax-symbol returns the symbol of the *first* element
3028 ;; in the syntactical analysis result list, syntax-point
3029 ;; returns the buffer position of same
3030 (fset 'syntax-symbol (lambda (x) (c-langelem-sym (car x))))
3031 (fset 'syntax-point (lambda (x) (c-langelem-pos (car x))))
3032 ;; Search through classpath list for an entry that is
3034 (while (and cplist (not class-found))
3035 (if (string-match (car cplist) f)
3037 (mapconcat 'identity
3039 (substring f (+ (match-end 0) 1))
3041 (setq cplist (cdr cplist)))
3042 ;; if f is visited by a java(cc-mode) buffer, walk up the
3043 ;; syntactic information chain and collect any 'inclass
3044 ;; symbols until 'topmost-intro is reached to find out if
3045 ;; point is within a nested class
3046 (if (and fbuffer (equal (symbol-file 'java-mode) "cc-mode"))
3048 (set-buffer fbuffer)
3049 (let ((nclass) (syntax))
3050 ;; While the c-syntactic information does not start
3051 ;; with the 'topmost-intro symbol, there may be
3052 ;; nested classes...
3053 (while (not (eq 'topmost-intro
3054 (syntax-symbol (c-guess-basic-syntax))))
3055 ;; Check if the current position c-syntactic
3056 ;; analysis has 'inclass
3057 (setq syntax (c-guess-basic-syntax))
3059 (and (not (eq 'inclass (syntax-symbol syntax)))
3061 (setq syntax (cdr syntax)))
3062 (if (eq 'inclass (syntax-symbol syntax))
3064 (goto-char (syntax-point syntax))
3065 ;; Now we're at the beginning of a class
3066 ;; definition. Find class name
3068 "[A-Za-z0-9 \t\n]*?class[ \t\n]+\\([^ \t\n]+\\)")
3070 (append (list (match-string-no-properties 1))
3072 (setq syntax (c-guess-basic-syntax))
3073 (while (and (not (syntax-point syntax)) (cdr syntax))
3074 (setq syntax (cdr syntax)))
3075 (goto-char (syntax-point syntax))
3077 (string-match (concat (car nclass) "$") class-found)
3079 (replace-match (mapconcat 'identity nclass "$")
3080 t t class-found)))))
3081 (if (not class-found)
3082 (message "gud-find-class: class for file %s not found!" f))
3084 ;; Not using classpath - try class/source association list
3085 (let ((class-found (rassoc f gud-jdb-class-source-alist)))
3088 (message "gud-find-class: class for file %s not found in gud-jdb-class-source-alist!" f)
3092 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3093 ;;; GDB script mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3094 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3096 (defvar gdb-script-mode-syntax-table
3097 (let ((st (make-syntax-table)))
3098 (modify-syntax-entry ?' "\"" st)
3099 (modify-syntax-entry ?# "<" st)
3100 (modify-syntax-entry ?\n ">" st)
3103 (defvar gdb-script-font-lock-keywords
3104 '(("^define\\s-+\\(\\(\\w\\|\\s_\\)+\\)" (1 font-lock-function-name-face))
3105 ("\\$\\(\\w+\\)" (1 font-lock-variable-name-face))
3106 ("^\\s-*\\(\\w\\(\\w\\|\\s_\\)*\\)" (1 font-lock-keyword-face))))
3108 (defvar gdb-script-font-lock-syntactic-keywords
3109 '(("^document\\s-.*\\(\n\\)" (1 "< b"))
3111 (0 (unless (eq (match-beginning 0) (point-min))
3112 ;; We change the \n in front, which is more difficult, but results
3113 ;; in better highlighting. If the doc is empty, the single \n is
3114 ;; both the beginning and the end of the docstring, which can't be
3115 ;; expressed in syntax-tables. Instead, we place the "> b" after
3116 ;; placing the "< b", so the start marker is overwritten by the
3117 ;; termination marker and in the end Emacs simply considers that
3118 ;; there's no docstring at all, which is fine.
3119 (put-text-property (1- (match-beginning 0)) (match-beginning 0)
3120 'syntax-table (eval-when-compile
3121 (string-to-syntax "> b")))
3122 ;; Make sure that rehighlighting the previous line won't erase our
3123 ;; syntax-table property.
3124 (put-text-property (1- (match-beginning 0)) (match-end 0)
3125 'font-lock-multiline t)
3128 (defun gdb-script-font-lock-syntactic-face (state)
3130 ((nth 3 state) font-lock-string-face)
3131 ((nth 7 state) font-lock-doc-face)
3132 (t font-lock-comment-face)))
3134 (defvar gdb-script-basic-indent 2)
3136 (defun gdb-script-skip-to-head ()
3137 "We're just in front of an `end' and we need to go to its head."
3138 (while (and (re-search-backward "^\\s-*\\(\\(end\\)\\|define\\|document\\|if\\|while\\|commands\\)\\>" nil 'move)
3140 (gdb-script-skip-to-head)))
3142 (defun gdb-script-calculate-indentation ()
3144 ((looking-at "end\\>")
3145 (gdb-script-skip-to-head)
3146 (current-indentation))
3147 ((looking-at "else\\>")
3148 (while (and (re-search-backward "^\\s-*\\(if\\|\\(end\\)\\)\\>" nil 'move)
3150 (gdb-script-skip-to-head))
3151 (current-indentation))
3153 (forward-comment (- (point-max)))
3155 (skip-chars-forward " \t")
3156 (+ (current-indentation)
3157 (if (looking-at "\\(if\\|while\\|define\\|else\\|commands\\)\\>")
3158 gdb-script-basic-indent 0)))))
3160 (defun gdb-script-indent-line ()
3161 "Indent current line of GDB script."
3163 (if (and (eq (get-text-property (point) 'face) font-lock-doc-face)
3166 (skip-chars-forward " \t")
3167 (not (looking-at "end\\>"))))
3169 (let* ((savep (point))
3170 (indent (condition-case nil
3173 (skip-chars-forward " \t")
3174 (if (>= (point) savep) (setq savep nil))
3175 (max (gdb-script-calculate-indentation) 0))
3178 (save-excursion (indent-line-to indent))
3179 (indent-line-to indent)))))
3181 ;; Derived from cfengine.el.
3182 (defun gdb-script-beginning-of-defun ()
3183 "`beginning-of-defun' function for Gdb script mode.
3184 Treats actions as defuns."
3185 (unless (<= (current-column) (current-indentation))
3187 (if (re-search-backward "^define \\|^document " nil t)
3189 (goto-char (point-min)))
3192 ;; Derived from cfengine.el.
3193 (defun gdb-script-end-of-defun ()
3194 "`end-of-defun' function for Gdb script mode.
3195 Treats actions as defuns."
3197 (if (re-search-forward "^end" nil t)
3199 (goto-char (point-max)))
3202 ;; Besides .gdbinit, gdb documents other names to be usable for init
3203 ;; files, cross-debuggers can use something like
3204 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
3205 ;; don't interfere with each other.
3207 (add-to-list 'auto-mode-alist '("/\\.[a-z0-9-]*gdbinit" . gdb-script-mode))
3210 (define-derived-mode gdb-script-mode nil "GDB-Script"
3211 "Major mode for editing GDB scripts"
3212 (set (make-local-variable 'comment-start) "#")
3213 (set (make-local-variable 'comment-start-skip) "#+\\s-*")
3214 (set (make-local-variable 'outline-regexp) "[ \t]")
3215 (set (make-local-variable 'imenu-generic-expression)
3216 '((nil "^define[ \t]+\\(\\w+\\)" 1)))
3217 (set (make-local-variable 'indent-line-function) 'gdb-script-indent-line)
3218 (set (make-local-variable 'beginning-of-defun-function)
3219 #'gdb-script-beginning-of-defun)
3220 (set (make-local-variable 'end-of-defun-function)
3221 #'gdb-script-end-of-defun)
3222 (set (make-local-variable 'font-lock-defaults)
3223 '(gdb-script-font-lock-keywords nil nil ((?_ . "w")) nil
3224 (font-lock-syntactic-keywords
3225 . gdb-script-font-lock-syntactic-keywords)
3226 (font-lock-syntactic-face-function
3227 . gdb-script-font-lock-syntactic-face))))
3230 ;;; tooltips for GUD
3232 ;;; Customizable settings
3234 (define-minor-mode gud-tooltip-mode
3235 "Toggle the display of GUD tooltips."
3240 (if gud-tooltip-mode
3242 (add-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3243 (add-hook 'pre-command-hook 'tooltip-hide)
3244 (add-hook 'tooltip-hook 'gud-tooltip-tips)
3245 (define-key global-map [mouse-movement] 'gud-tooltip-mouse-motion))
3246 (unless tooltip-mode (remove-hook 'pre-command-hook 'tooltip-hide)
3247 (remove-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3248 (remove-hook 'tooltip-hook 'gud-tooltip-tips)
3249 (define-key global-map [mouse-movement] 'ignore)))
3250 (gud-tooltip-activate-mouse-motions-if-enabled)
3251 (if (and gud-comint-buffer
3252 (buffer-name gud-comint-buffer); gud-comint-buffer might be killed
3253 (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
3255 (if gud-tooltip-mode
3257 (dolist (buffer (buffer-list))
3258 (unless (eq buffer gud-comint-buffer)
3259 (with-current-buffer buffer
3260 (when (and (memq gud-minor-mode '(gdbmi gdba))
3261 (not (string-match "\\`\\*.+\\*\\'"
3263 (make-local-variable 'gdb-define-alist)
3264 (gdb-create-define-alist)
3265 (add-hook 'after-save-hook
3266 'gdb-create-define-alist nil t))))))
3267 (kill-local-variable 'gdb-define-alist)
3268 (remove-hook 'after-save-hook 'gdb-create-define-alist t))))
3270 (defcustom gud-tooltip-modes '(gud-mode c-mode c++-mode fortran-mode
3272 "List of modes for which to enable GUD tooltips."
3277 (defcustom gud-tooltip-display
3278 '((eq (tooltip-event-buffer gud-tooltip-event)
3279 (marker-buffer gud-overlay-arrow-position)))
3280 "List of forms determining where GUD tooltips are displayed.
3282 Forms in the list are combined with AND. The default is to display
3283 only tooltips in the buffer containing the overlay arrow."
3288 (defcustom gud-tooltip-echo-area nil
3289 "Use the echo area instead of frames for GUD tooltips."
3294 (define-obsolete-variable-alias 'tooltip-gud-modes
3295 'gud-tooltip-modes "22.1")
3296 (define-obsolete-variable-alias 'tooltip-gud-display
3297 'gud-tooltip-display "22.1")
3299 ;;; Reacting on mouse movements
3301 (defun gud-tooltip-change-major-mode ()
3302 "Function added to `change-major-mode-hook' when tooltip mode is on."
3303 (add-hook 'post-command-hook 'gud-tooltip-activate-mouse-motions-if-enabled))
3305 (defun gud-tooltip-activate-mouse-motions-if-enabled ()
3306 "Reconsider for all buffers whether mouse motion events are desired."
3307 (remove-hook 'post-command-hook
3308 'gud-tooltip-activate-mouse-motions-if-enabled)
3309 (dolist (buffer (buffer-list))
3312 (if (and gud-tooltip-mode
3313 (memq major-mode gud-tooltip-modes))
3314 (gud-tooltip-activate-mouse-motions t)
3315 (gud-tooltip-activate-mouse-motions nil)))))
3317 (defvar gud-tooltip-mouse-motions-active nil
3318 "Locally t in a buffer if tooltip processing of mouse motion is enabled.")
3320 ;; We don't set track-mouse globally because this is a big redisplay
3321 ;; problem in buffers having a pre-command-hook or such installed,
3322 ;; which does a set-buffer, like the summary buffer of Gnus. Calling
3323 ;; set-buffer prevents redisplay optimizations, so every mouse motion
3324 ;; would be accompanied by a full redisplay.
3326 (defun gud-tooltip-activate-mouse-motions (activatep)
3327 "Activate/deactivate mouse motion events for the current buffer.
3328 ACTIVATEP non-nil means activate mouse motion events."
3331 (make-local-variable 'gud-tooltip-mouse-motions-active)
3332 (setq gud-tooltip-mouse-motions-active t)
3333 (make-local-variable 'track-mouse)
3334 (setq track-mouse t))
3335 (when gud-tooltip-mouse-motions-active
3336 (kill-local-variable 'gud-tooltip-mouse-motions-active)
3337 (kill-local-variable 'track-mouse))))
3339 (defun gud-tooltip-mouse-motion (event)
3340 "Command handler for mouse movement events in `global-map'."
3343 (when (car (mouse-pixel-position))
3344 (setq tooltip-last-mouse-motion-event (copy-sequence event))
3345 (tooltip-start-delayed-tip)))
3349 (defvar gud-tooltip-original-filter nil
3350 "Process filter to restore after GUD output has been received.")
3352 (defvar gud-tooltip-dereference nil
3353 "Non-nil means print expressions with a `*' in front of them.
3354 For C this would dereference a pointer expression.")
3356 (defvar gud-tooltip-event nil
3357 "The mouse movement event that led to a tooltip display.
3358 This event can be examined by forms in GUD-TOOLTIP-DISPLAY.")
3360 (defun gud-tooltip-dereference (&optional arg)
3361 "Toggle whether tooltips should show `* expr' or `expr'.
3362 With arg, dereference expr if ARG is positive, otherwise do not derereference."
3364 (setq gud-tooltip-dereference
3366 (not gud-tooltip-dereference)
3367 (> (prefix-numeric-value arg) 0)))
3368 (message "Dereferencing is now %s."
3369 (if gud-tooltip-dereference "on" "off")))
3371 (define-obsolete-function-alias 'tooltip-gud-toggle-dereference
3372 'gud-tooltip-dereference "22.1")
3374 ; This will only display data that comes in one chunk.
3375 ; Larger arrays (say 400 elements) are displayed in
3376 ; the tooltip incompletely and spill over into the gud buffer.
3377 ; Switching the process-filter creates timing problems and
3378 ; it may be difficult to do better. Using annotations as in
3379 ; gdb-ui.el gets round this problem.
3380 (defun gud-tooltip-process-output (process output)
3381 "Process debugger output and show it in a tooltip window."
3382 (set-process-filter process gud-tooltip-original-filter)
3383 (tooltip-show (tooltip-strip-prompt process output)
3384 (or gud-tooltip-echo-area tooltip-use-echo-area)))
3386 (defun gud-tooltip-print-command (expr)
3387 "Return a suitable command to print the expression EXPR."
3388 (case gud-minor-mode
3389 (gdba (concat "server print " expr))
3390 ((dbx gdbmi) (concat "print " expr))
3391 ((xdb pdb) (concat "p " expr))
3392 (sdb (concat expr "/"))))
3394 (defun gud-tooltip-tips (event)
3395 "Show tip for identifier or selection under the mouse.
3396 The mouse must either point at an identifier or inside a selected
3397 region for the tip window to be shown. If gud-tooltip-dereference is t,
3398 add a `*' in front of the printed expression. In the case of a C program
3399 controlled by GDB, show the associated #define directives when program is
3402 This function must return nil if it doesn't handle EVENT."
3404 (when (and (eventp event)
3407 (buffer-name gud-comint-buffer); might be killed
3408 (setq process (get-buffer-process gud-comint-buffer))
3409 (posn-point (event-end event))
3410 (or (and (eq gud-minor-mode 'gdba) (not gdb-active-process))
3411 (progn (setq gud-tooltip-event event)
3412 (eval (cons 'and gud-tooltip-display)))))
3413 (let ((expr (tooltip-expr-to-print event)))
3415 (if (and (eq gud-minor-mode 'gdba)
3416 (not gdb-active-process))
3418 (with-current-buffer
3419 (window-buffer (let ((mouse (mouse-position)))
3420 (window-at (cadr mouse)
3422 (let ((define-elt (assoc expr gdb-define-alist)))
3423 (unless (null define-elt)
3426 (or gud-tooltip-echo-area tooltip-use-echo-area))
3428 (when gud-tooltip-dereference
3429 (setq expr (concat "*" expr)))
3430 (let ((cmd (gud-tooltip-print-command expr)))
3431 (when (and gud-tooltip-mode (eq gud-minor-mode 'gdb))
3432 (gud-tooltip-mode -1)
3433 (message-box "Using GUD tooltips in this mode is unsafe\n\
3434 so they have been disabled."))
3435 (unless (null cmd) ; CMD can be nil if unknown debugger
3436 (if (memq gud-minor-mode '(gdba gdbmi))
3440 gdb-server-prefix "macro expand " expr "\n")
3441 `(lambda () (gdb-tooltip-print-1 ,expr))))
3443 (list (concat cmd "\n")
3444 `(lambda () (gdb-tooltip-print ,expr)))))
3445 (setq gud-tooltip-original-filter (process-filter process))
3446 (set-process-filter process 'gud-tooltip-process-output)
3447 (gud-basic-call cmd))
3452 ;;; arch-tag: 6d990948-df65-461a-be39-1c7fb83ac4c4
3453 ;;; gud.el ends here