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, 2008 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>.
30 ;; It was 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
)
52 (defvar gdb-source-window
)
54 (defvar gdb-speedbar-auto-raise
)
55 (defvar gud-tooltip-mode
)
57 (defvar hl-line-sticky-flag
)
61 ;; ======================================================================
62 ;; GUD commands must be visible in C buffers visited by GUD
65 "Grand Unified Debugger mode for gdb and other debuggers under Emacs.
66 Supported debuggers include gdb, sdb, dbx, xdb, perldb, pdb (Python) and jdb."
71 (defcustom gud-key-prefix
"\C-x\C-a"
72 "Prefix of all GUD commands valid in C buffers."
76 (global-set-key (concat gud-key-prefix
"\C-l") 'gud-refresh
)
77 (define-key ctl-x-map
" " 'gud-break
) ;; backward compatibility hack
79 (defvar gud-marker-filter nil
)
80 (put 'gud-marker-filter
'permanent-local t
)
81 (defvar gud-find-file nil
)
82 (put 'gud-find-file
'permanent-local t
)
84 (defun gud-marker-filter (&rest args
)
85 (apply gud-marker-filter args
))
87 (defvar gud-minor-mode nil
)
88 (put 'gud-minor-mode
'permanent-local t
)
90 (defvar gud-comint-buffer nil
)
92 (defvar gud-keep-buffer nil
)
94 (defun gud-symbol (sym &optional soft minor-mode
)
95 "Return the symbol used for SYM in MINOR-MODE.
96 MINOR-MODE defaults to `gud-minor-mode'.
97 The symbol returned is `gud-<MINOR-MODE>-<SYM>'.
98 If SOFT is non-nil, returns nil if the symbol doesn't already exist."
99 (unless (or minor-mode gud-minor-mode
) (error "Gud internal error"))
100 (funcall (if soft
'intern-soft
'intern
)
101 (format "gud-%s-%s" (or minor-mode gud-minor-mode
) sym
)))
103 (defun gud-val (sym &optional minor-mode
)
104 "Return the value of `gud-symbol' SYM. Default to nil."
105 (let ((sym (gud-symbol sym t minor-mode
)))
106 (if (boundp sym
) (symbol-value sym
))))
108 (defvar gud-running nil
109 "Non-nil if debugged program is running.
110 Used to grey out relevant toolbar icons.")
112 (defvar gud-target-name
"--unknown--"
113 "The apparent name of the program being debugged in a gud buffer.")
115 ;; Use existing Info buffer, if possible.
116 (defun gud-goto-info ()
117 "Go to relevant Emacs info node."
119 (let ((same-window-regexps same-window-regexps
)
120 (display-buffer-reuse-frames t
))
124 (if (eq (window-buffer window
) (get-buffer "*info*"))
126 (setq same-window-regexps nil
)
127 (throw 'info-found nil
))))
129 (select-frame (make-frame)))
130 (if (memq gud-minor-mode
'(gdbmi gdba
))
131 (info "(emacs)GDB Graphical Interface")
132 (info "(emacs)Debuggers"))))
134 (defun gud-tool-bar-item-visible-no-fringe ()
135 (not (or (eq (buffer-local-value 'major-mode
(window-buffer)) 'speedbar-mode
)
136 (and (memq gud-minor-mode
'(gdbmi gdba
))
137 (> (car (window-fringes)) 0)))))
139 (defun gud-stop-subjob ()
141 (with-current-buffer gud-comint-buffer
142 (if (string-equal gud-target-name
"emacs")
144 (comint-interrupt-subjob))))
146 (easy-mmode-defmap gud-menu-map
147 '(([help] "Info (debugger)" . gud-goto-info)
148 ([tooltips] menu-item "Show GUD tooltips" gud-tooltip-mode
149 :enable (and (not emacs-basic-display)
151 (fboundp 'x-show-tip))
152 :visible (memq gud-minor-mode
153 '(gdbmi gdba dbx sdb xdb pdb))
154 :button (:toggle . gud-tooltip-mode))
155 ([refresh] "Refresh" . gud-refresh)
156 ([run] menu-item "Run" gud-run
157 :enable (not gud-running)
158 :visible (memq gud-minor-mode '(gdbmi gdb dbx jdb)))
159 ([go] menu-item (if gdb-active-process "Continue" "Run") gud-go
160 :visible (and (not gud-running)
161 (eq gud-minor-mode 'gdba)))
162 ([stop] menu-item "Stop" gud-stop-subjob
163 :visible (or (not (memq gud-minor-mode '(gdba pdb)))
165 (eq gud-minor-mode 'gdba))))
166 ([until] menu-item "Continue to selection" gud-until
167 :enable (not gud-running)
168 :visible (and (memq gud-minor-mode '(gdbmi gdba gdb perldb))
169 (gud-tool-bar-item-visible-no-fringe)))
170 ([remove] menu-item "Remove Breakpoint" gud-remove
171 :enable (not gud-running)
172 :visible (gud-tool-bar-item-visible-no-fringe))
173 ([tbreak] menu-item "Temporary Breakpoint" gud-tbreak
174 :enable (not gud-running)
175 :visible (memq gud-minor-mode
176 '(gdbmi gdba gdb sdb xdb)))
177 ([break] menu-item "Set Breakpoint" gud-break
178 :enable (not gud-running)
179 :visible (gud-tool-bar-item-visible-no-fringe))
180 ([up] menu-item "Up Stack" gud-up
181 :enable (not gud-running)
182 :visible (memq gud-minor-mode
183 '(gdbmi gdba gdb dbx xdb jdb pdb)))
184 ([down] menu-item "Down Stack" gud-down
185 :enable (not gud-running)
186 :visible (memq gud-minor-mode
187 '(gdbmi gdba gdb dbx xdb jdb pdb)))
188 ([pp] menu-item "Print S-expression" gud-pp
189 :enable (and (not gud-running)
191 :visible (and (string-equal
193 'gud-target-name gud-comint-buffer) "emacs")
194 (eq gud-minor-mode 'gdba)))
195 ([print*] menu-item "Print Dereference" gud-pstar
196 :enable (not gud-running)
197 :visible (memq gud-minor-mode '(gdbmi gdba gdb)))
198 ([print] menu-item "Print Expression" gud-print
199 :enable (not gud-running))
200 ([watch] menu-item "Watch Expression" gud-watch
201 :enable (not gud-running)
202 :visible (memq gud-minor-mode '(gdbmi gdba)))
203 ([finish] menu-item "Finish Function" gud-finish
204 :enable (not gud-running)
205 :visible (memq gud-minor-mode
206 '(gdbmi gdba gdb xdb jdb pdb)))
207 ([stepi] menu-item "Step Instruction" gud-stepi
208 :enable (not gud-running)
209 :visible (memq gud-minor-mode '(gdbmi gdba gdb dbx)))
210 ([nexti] menu-item "Next Instruction" gud-nexti
211 :enable (not gud-running)
212 :visible (memq gud-minor-mode '(gdbmi gdba gdb dbx)))
213 ([step] menu-item "Step Line" gud-step
214 :enable (not gud-running))
215 ([next] menu-item "Next Line" gud-next
216 :enable (not gud-running))
217 ([cont] menu-item "Continue" gud-cont
218 :enable (not gud-running)
219 :visible (not (eq gud-minor-mode 'gdba))))
220 "Menu for `gud-mode'."
223 (easy-mmode-defmap gud-minor-mode-map
225 `(([menu-bar debug] . ("Gud" . ,gud-menu-map)))
226 ;; Get tool bar like functionality from the menu bar on a text only
228 (unless window-system
230 . (,(propertize "down" 'face 'font-lock-doc-face) . gud-down))
232 . (,(propertize "up" 'face 'font-lock-doc-face) . gud-up))
234 . (,(propertize "finish" 'face 'font-lock-doc-face) . gud-finish))
236 . (,(propertize "step" 'face 'font-lock-doc-face) . gud-step))
238 . (,(propertize "next" 'face 'font-lock-doc-face) . gud-next))
239 ([menu-bar until] menu-item
240 ,(propertize "until" 'face 'font-lock-doc-face) gud-until
241 :visible (memq gud-minor-mode '(gdbmi gdba gdb perldb)))
242 ([menu-bar cont] menu-item
243 ,(propertize "cont" 'face 'font-lock-doc-face) gud-cont
244 :visible (not (eq gud-minor-mode 'gdba)))
245 ([menu-bar run] menu-item
246 ,(propertize "run" 'face 'font-lock-doc-face) gud-run
247 :visible (memq gud-minor-mode '(gdbmi gdb dbx jdb)))
248 ([menu-bar go] menu-item
249 ,(propertize " go " 'face 'font-lock-doc-face) gud-go
250 :visible (and (not gud-running)
251 (eq gud-minor-mode 'gdba)))
252 ([menu-bar stop] menu-item
253 ,(propertize "stop" 'face 'font-lock-doc-face) gud-stop-subjob
254 :visible (or gud-running
255 (not (eq gud-minor-mode 'gdba))))
257 . (,(propertize "print" 'face 'font-lock-doc-face) . gud-print))
258 ([menu-bar tools] . undefined)
259 ([menu-bar buffer] . undefined)
260 ([menu-bar options] . undefined)
261 ([menu-bar edit] . undefined)
262 ([menu-bar file] . undefined))))
263 "Map used in visited files.")
265 (let ((m (assq 'gud-minor-mode minor-mode-map-alist)))
266 (if m (setcdr m gud-minor-mode-map)
267 (push (cons 'gud-minor-mode gud-minor-mode-map) minor-mode-map-alist)))
270 ;; Will inherit from comint-mode via define-derived-mode.
272 "`gud-mode' keymap.")
274 (defvar gud-tool-bar-map
275 (if (display-graphic-p)
276 (let ((map (make-sparse-keymap)))
277 (dolist (x '((gud-break . "gud/break")
278 (gud-remove . "gud/remove")
279 (gud-print . "gud/print")
280 (gud-pstar . "gud/pstar")
282 (gud-watch . "gud/watch")
283 (gud-run . "gud/run")
285 (gud-stop-subjob . "gud/stop")
286 (gud-cont . "gud/cont")
287 (gud-until . "gud/until")
288 (gud-next . "gud/next")
289 (gud-step . "gud/step")
290 (gud-finish . "gud/finish")
291 (gud-nexti . "gud/nexti")
292 (gud-stepi . "gud/stepi")
294 (gud-down . "gud/down")
295 (gud-goto-info . "info"))
297 (tool-bar-local-item-from-menu
298 (car x) (cdr x) map gud-minor-mode-map)))))
300 (defun gud-file-name (f)
301 "Transform a relative file name to an absolute file name.
302 Uses `gud-<MINOR-MODE>-directories' to find the source files."
303 ;; When `default-directory' is a remote file name, prepend its
304 ;; remote part to f, which is the local file name. Fortunately,
305 ;; `file-remote-p' returns exactly this remote file name part (or
307 (setq f (concat (or (file-remote-p default-directory) "") f))
308 (if (file-exists-p f) (expand-file-name f)
309 (let ((directories (gud-val 'directories))
312 (let ((path (expand-file-name f (car directories))))
313 (if (file-exists-p path)
316 (setq directories (cdr directories)))
319 (declare-function gdb-create-define-alist "gdb-ui" ())
321 (defun gud-find-file (file)
322 ;; Don't get confused by double slashes in the name that comes from GDB.
323 (while (string-match "//+" file)
324 (setq file (replace-match "/" t t file)))
325 (let ((minor-mode gud-minor-mode)
326 (buf (funcall (or gud-find-file 'gud-file-name) file)))
328 (setq buf (and (file-readable-p buf) (find-file-noselect buf 'nowarn))))
330 ;; Copy `gud-minor-mode' to the found buffer to turn on the menu.
331 (with-current-buffer buf
332 (set (make-local-variable 'gud-minor-mode) minor-mode)
333 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
334 (when (and gud-tooltip-mode
335 (memq gud-minor-mode '(gdbmi gdba)))
336 (make-local-variable 'gdb-define-alist)
337 (unless gdb-define-alist (gdb-create-define-alist))
338 (add-hook 'after-save-hook 'gdb-create-define-alist nil t))
339 (make-local-variable 'gud-keep-buffer))
342 ;; ======================================================================
343 ;; command definition
345 ;; This macro is used below to define some basic debugger interface commands.
346 ;; Of course you may use `gud-def' with any other debugger command, including
347 ;; user defined ones.
349 ;; A macro call like (gud-def FUNC CMD KEY DOC) expands to a form
350 ;; which defines FUNC to send the command CMD to the debugger, gives
351 ;; it the docstring DOC, and binds that function to KEY in the GUD
352 ;; major mode. The function is also bound in the global keymap with the
355 (defmacro gud-def (func cmd key &optional doc)
356 "Define FUNC to be a command sending CMD and bound to KEY, with
357 optional doc string DOC. Certain %-escapes in the string arguments
358 are interpreted specially if present. These are:
360 %f -- Name (without directory) of current source file.
361 %F -- Name (without directory or extension) of current source file.
362 %d -- Directory of current source file.
363 %l -- Number of current source line.
364 %e -- Text of the C lvalue or function-call expression surrounding point.
365 %a -- Text of the hexadecimal address surrounding point.
366 %p -- Prefix argument to the command (if any) as a number.
367 %c -- Fully qualified class name derived from the expression
368 surrounding point (jdb only).
370 The `current' source file is the file of the current buffer (if
371 we're in a C file) or the source file current at the last break or
372 step (if we're in the GUD buffer).
373 The `current' line is that of the current buffer (if we're in a
374 source file) or the source line number at the last break or step (if
375 we're in the GUD buffer)."
378 ,@(if doc (list doc))
380 (if (not gud-running)
384 ,(if key `(local-set-key ,(concat "\C-c" key) ',func))
385 ,(if key `(global-set-key (vconcat gud-key-prefix ,key) ',func))))
387 ;; Where gud-display-frame should put the debugging arrow; a cons of
388 ;; (filename . line-number). This is set by the marker-filter, which scans
389 ;; the debugger's output for indications of the current program counter.
390 (defvar gud-last-frame nil)
392 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
393 ;; the last frame, even if it's been called before and gud-last-frame has
395 (defvar gud-last-last-frame nil)
397 ;; All debugger-specific information is collected here.
398 ;; Here's how it works, in case you ever need to add a debugger to the mode.
400 ;; Each entry must define the following at startup:
403 ;; comint-prompt-regexp
404 ;; gud-<name>-massage-args
405 ;; gud-<name>-marker-filter
406 ;; gud-<name>-find-file
408 ;; The job of the massage-args method is to modify the given list of
409 ;; debugger arguments before running the debugger.
411 ;; The job of the marker-filter method is to detect file/line markers in
412 ;; strings and set the global gud-last-frame to indicate what display
413 ;; action (if any) should be triggered by the marker. Note that only
414 ;; whatever the method *returns* is displayed in the buffer; thus, you
415 ;; can filter the debugger's output, interpreting some and passing on
418 ;; The job of the find-file method is to visit and return the buffer indicated
419 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
422 ;; ======================================================================
423 ;; speedbar support functions and variables.
424 (eval-when-compile (require 'speedbar)) ;For speedbar-with-attached-buffer.
426 (defvar gud-last-speedbar-stackframe nil
427 "Description of the currently displayed GUD stack.
428 The value t means that there is no stack, and we are in display-file mode.")
430 (defvar gud-speedbar-key-map nil
431 "Keymap used when in the buffers display mode.")
433 (defun gud-speedbar-item-info ()
434 "Display the data type of the watch expression element."
435 (let ((var (nth (- (line-number-at-pos (point)) 2) gdb-var-list)))
437 (speedbar-message "%s: %s" (nth 6 var) (nth 3 var))
438 (speedbar-message "%s" (nth 3 var)))))
440 (defun gud-install-speedbar-variables ()
441 "Install those variables used by speedbar to enhance gud/gdb."
442 (if gud-speedbar-key-map
444 (setq gud-speedbar-key-map (speedbar-make-specialized-keymap))
446 (define-key gud-speedbar-key-map "j" 'speedbar-edit-line)
447 (define-key gud-speedbar-key-map "e" 'speedbar-edit-line)
448 (define-key gud-speedbar-key-map "\C-m" 'speedbar-edit-line)
449 (define-key gud-speedbar-key-map " " 'speedbar-toggle-line-expansion)
450 (define-key gud-speedbar-key-map "D" 'gdb-var-delete)
451 (define-key gud-speedbar-key-map "p" 'gud-pp))
453 (speedbar-add-expansion-list '("GUD" gud-speedbar-menu-items
455 gud-expansion-speedbar-buttons))
458 'speedbar-mode-functions-list
459 '("GUD" (speedbar-item-info . gud-speedbar-item-info)
460 (speedbar-line-directory . ignore))))
462 (defvar gud-speedbar-menu-items
463 '(["Jump to stack frame" speedbar-edit-line
464 :visible (not (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
466 ["Edit value" speedbar-edit-line
467 :visible (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
469 ["Delete expression" gdb-var-delete
470 :visible (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
472 ["Auto raise frame" gdb-speedbar-auto-raise
473 :style toggle :selected gdb-speedbar-auto-raise
474 :visible (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
477 :visible (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
479 ["Binary" (gdb-var-set-format "binary") t]
480 ["Natural" (gdb-var-set-format "natural") t]
481 ["Hexadecimal" (gdb-var-set-format "hexadecimal") t]))
482 "Additional menu items to add to the speedbar frame.")
484 ;; Make sure our special speedbar mode is loaded
485 (if (featurep 'speedbar)
486 (gud-install-speedbar-variables)
487 (add-hook 'speedbar-load-hook 'gud-install-speedbar-variables))
489 (defun gud-expansion-speedbar-buttons (directory zero)
490 "Wrapper for call to `speedbar-add-expansion-list'.
491 DIRECTORY and ZERO are not used, but are required by the caller."
492 (gud-speedbar-buttons gud-comint-buffer))
494 (defun gud-speedbar-buttons (buffer)
495 "Create a speedbar display based on the current state of GUD.
496 If the GUD BUFFER is not running a supported debugger, then turn
497 off the specialized speedbar mode. BUFFER is not used, but is
498 required by the caller."
499 (when (and gud-comint-buffer
500 ;; gud-comint-buffer might be killed
501 (buffer-name gud-comint-buffer))
502 (let* ((minor-mode (with-current-buffer buffer gud-minor-mode))
503 (window (get-buffer-window (current-buffer) 0))
504 (start (window-start window))
505 (p (window-point window)))
507 ((memq minor-mode '(gdbmi gdba))
509 (insert "Watch Expressions:\n")
510 (let ((var-list gdb-var-list) parent)
512 (let* (char (depth 0) (start 0) (var (car var-list))
513 (varnum (car var)) (expr (nth 1 var))
514 (type (if (nth 3 var) (nth 3 var) " "))
515 (value (nth 4 var)) (status (nth 5 var)))
517 0 (length expr) 'face font-lock-variable-name-face expr)
519 0 (length type) 'face font-lock-type-face type)
520 (while (string-match "\\." varnum start)
521 (setq depth (1+ depth)
522 start (1+ (match-beginning 0))))
523 (if (eq depth 0) (setq parent nil))
524 (if (or (equal (nth 2 var) "0")
525 (and (equal (nth 2 var) "1")
526 (string-match "char \\*$" type)))
527 (speedbar-make-tag-line
529 (concat expr "\t" value)
530 (if (or parent (eq status 'out-of-scope))
533 (if gdb-show-changed-values
534 (or parent (case status
535 (changed 'font-lock-warning-face)
536 (out-of-scope 'shadow)
540 (if (eq status 'out-of-scope) (setq parent 'shadow))
541 (if (and (nth 1 var-list)
542 (string-match (concat varnum "\\.")
543 (car (nth 1 var-list))))
546 (if (string-match "\\*$\\|\\*&$" type)
547 (speedbar-make-tag-line
549 'gdb-speedbar-expand-node varnum
550 (concat expr "\t" type "\t" value)
551 (if (or parent (eq status 'out-of-scope))
554 (if gdb-show-changed-values
555 (or parent (case status
556 (changed 'font-lock-warning-face)
557 (out-of-scope 'shadow)
561 (speedbar-make-tag-line
563 'gdb-speedbar-expand-node varnum
564 (concat expr "\t" type)
566 (if (and (or parent status) gdb-show-changed-values)
569 (setq var-list (cdr var-list)))))
570 (t (unless (and (save-excursion
571 (goto-char (point-min))
572 (looking-at "Current Stack:"))
573 (equal gud-last-last-frame gud-last-speedbar-stackframe))
574 (let ((gud-frame-list
575 (cond ((eq minor-mode 'gdb)
576 (gud-gdb-get-stackframe buffer))
577 ;; Add more debuggers here!
578 (t (speedbar-remove-localized-speedbar-support buffer)
581 (if (not gud-frame-list)
582 (insert "No Stack frames\n")
583 (insert "Current Stack:\n"))
584 (dolist (frame gud-frame-list)
585 (insert (nth 1 frame) ":\n")
586 (if (= (length frame) 2)
588 (speedbar-insert-button (car frame)
589 'speedbar-directory-face
591 (speedbar-insert-button
594 'speedbar-highlight-face
595 (cond ((memq minor-mode '(gdbmi gdba gdb))
596 'gud-gdb-goto-stackframe)
597 (t (error "Should never be here")))
599 (setq gud-last-speedbar-stackframe gud-last-last-frame))))
600 (set-window-start window start)
601 (set-window-point window p))))
604 ;; ======================================================================
607 ;; History of argument lists passed to gdb.
608 (defvar gud-gdb-history nil)
610 (defcustom gud-gud-gdb-command-name "gdb --fullname"
611 "Default command to run an executable under GDB in text command mode.
612 The option \"--fullname\" must be included in this value."
616 (defvar gud-gdb-marker-regexp
617 ;; This used to use path-separator instead of ":";
618 ;; however, we found that on both Windows 32 and MSDOS
619 ;; a colon is correct here.
620 (concat "\032\032\\(.:?[^" ":" "\n]*\\)" ":"
621 "\\([0-9]*\\)" ":" ".*\n"))
623 ;; There's no guarantee that Emacs will hand the filter the entire
624 ;; marker at once; it could be broken up across several strings. We
625 ;; might even receive a big chunk with several markers in it. If we
626 ;; receive a chunk of text which looks like it might contain the
627 ;; beginning of a marker, we save it here between calls to the
629 (defvar gud-marker-acc "")
630 (make-variable-buffer-local 'gud-marker-acc)
632 (defun gud-gdb-marker-filter (string)
633 (setq gud-marker-acc (concat gud-marker-acc string))
636 ;; Process all the complete markers in this chunk.
637 (while (string-match gud-gdb-marker-regexp gud-marker-acc)
640 ;; Extract the frame position from the marker.
641 gud-last-frame (cons (match-string 1 gud-marker-acc)
642 (string-to-number (match-string 2 gud-marker-acc)))
644 ;; Append any text before the marker to the output we're going
645 ;; to return - we don't include the marker in this text.
646 output (concat output
647 (substring gud-marker-acc 0 (match-beginning 0)))
649 ;; Set the accumulator to the remaining text.
650 gud-marker-acc (substring gud-marker-acc (match-end 0))))
652 ;; Check for annotations and change gud-minor-mode to 'gdba if
654 (while (string-match "\n\032\032\\(.*\\)\n" gud-marker-acc)
655 (let ((match (match-string 1 gud-marker-acc)))
658 ;; Append any text before the marker to the output we're going
659 ;; to return - we don't include the marker in this text.
660 output (concat output
661 (substring gud-marker-acc 0 (match-beginning 0)))
663 ;; Set the accumulator to the remaining text.
665 gud-marker-acc (substring gud-marker-acc (match-end 0)))))
667 ;; Does the remaining text look like it might end with the
668 ;; beginning of another marker? If it does, then keep it in
669 ;; gud-marker-acc until we receive the rest of it. Since we
670 ;; know the full marker regexp above failed, it's pretty simple to
671 ;; test for marker starts.
672 (if (string-match "\n\\(\032.*\\)?\\'" gud-marker-acc)
674 ;; Everything before the potential marker start can be output.
675 (setq output (concat output (substring gud-marker-acc
676 0 (match-beginning 0))))
678 ;; Everything after, we save, to combine with later input.
680 (substring gud-marker-acc (match-beginning 0))))
682 (setq output (concat output gud-marker-acc)
687 (easy-mmode-defmap gud-minibuffer-local-map
688 '(("\C-i" . comint-dynamic-complete-filename))
689 "Keymap for minibuffer prompting of gud startup command."
690 :inherit minibuffer-local-map)
692 (defun gud-query-cmdline (minor-mode &optional init)
693 (let* ((hist-sym (gud-symbol 'history nil minor-mode))
694 (cmd-name (gud-val 'command-name minor-mode)))
695 (unless (boundp hist-sym) (set hist-sym nil))
696 (read-from-minibuffer
697 (format "Run %s (like this): " minor-mode)
698 (or (car-safe (symbol-value hist-sym))
699 (concat (or cmd-name (symbol-name minor-mode))
703 (dolist (f (directory-files default-directory) file)
704 (if (and (file-executable-p f)
705 (not (file-directory-p f))
707 (file-newer-than-file-p f file)))
709 gud-minibuffer-local-map nil
712 (defvar gdb-first-prompt t)
714 (defvar gud-filter-pending-text nil
715 "Non-nil means this is text that has been saved for later in `gud-filter'.")
717 ;; If in gdba mode, gdb-ui is loaded.
718 (declare-function gdb-restore-windows "gdb-ui" ())
720 ;; The old gdb command (text command mode). The new one is in gdb-ui.el.
722 (defun gud-gdb (command-line)
723 "Run gdb on program FILE in buffer *gud-FILE*.
724 The directory containing FILE becomes the initial working
725 directory and source-file directory for your debugger."
726 (interactive (list (gud-query-cmdline 'gud-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)
770 (setq gud-filter-pending-text nil)
771 (run-hooks 'gud-gdb-mode-hook))
773 ;; One of the nice features of GDB is its impressive support for
774 ;; context-sensitive command completion. We preserve that feature
775 ;; in the GUD buffer by using a GDB command designed just for Emacs.
777 ;; The completion process filter indicates when it is finished.
778 (defvar gud-gdb-fetch-lines-in-progress)
780 ;; Since output may arrive in fragments we accumulate partials strings here.
781 (defvar gud-gdb-fetch-lines-string)
783 ;; We need to know how much of the completion to chop off.
784 (defvar gud-gdb-fetch-lines-break)
786 ;; The completion list is constructed by the process filter.
787 (defvar gud-gdb-fetched-lines)
789 (defun gud-gdb-complete-command (&optional command a b)
790 "Perform completion on the GDB command preceding point.
791 This is implemented using the GDB `complete' command which isn't
792 available with older versions of GDB."
795 ;; Used by gud-watch in mini-buffer.
796 (setq command (concat "p " command))
797 ;; Used in GUD buffer.
799 (setq command (buffer-substring (comint-line-beginning-position) end))))
801 ;; Find the word break. This match will always succeed.
802 (and (string-match "\\(\\`\\| \\)\\([^ ]*\\)\\'" command)
803 (substring command (match-beginning 2))))
805 (gud-gdb-run-command-fetch-lines (concat "complete " command)
807 ;; From string-match above.
808 (match-beginning 2))))
809 ;; Protect against old versions of GDB.
811 (string-match "^Undefined command: \"complete\"" (car complete-list))
812 (error "This version of GDB doesn't support the `complete' command"))
813 ;; Sort the list like readline.
814 (setq complete-list (sort complete-list (function string-lessp)))
815 ;; Remove duplicates.
816 (let ((first complete-list)
817 (second (cdr complete-list)))
819 (if (string-equal (car first) (car second))
820 (setcdr first (setq second (cdr second)))
822 second (cdr second)))))
823 ;; Add a trailing single quote if there is a unique completion
824 ;; and it contains an odd number of unquoted single quotes.
825 (and (= (length complete-list) 1)
826 (let ((str (car complete-list))
829 (while (string-match "\\([^'\\]\\|\\\\'\\)*'" str pos)
830 (setq count (1+ count)
832 (and (= (mod count 2) 1)
833 (setq complete-list (list (concat str "'"))))))
834 ;; Let comint handle the rest.
835 (comint-dynamic-simple-complete command-word complete-list)))
837 ;; The completion process filter is installed temporarily to slurp the
838 ;; output of GDB up to the next prompt and build the completion list.
839 (defun gud-gdb-fetch-lines-filter (string filter)
840 "Filter used to read the list of lines output by a command.
841 STRING is the output to filter.
842 It is passed through FILTER before we look at it."
843 (setq string (funcall filter string))
844 (setq string (concat gud-gdb-fetch-lines-string string))
845 (while (string-match "\n" string)
846 (push (substring string gud-gdb-fetch-lines-break (match-beginning 0))
847 gud-gdb-fetched-lines)
848 (setq string (substring string (match-end 0))))
849 (if (string-match comint-prompt-regexp string)
851 (setq gud-gdb-fetch-lines-in-progress nil)
854 (setq gud-gdb-fetch-lines-string string)
857 ;; gdb speedbar functions
859 (defun gud-gdb-goto-stackframe (text token indent)
860 "Goto the stackframe described by TEXT, TOKEN, and INDENT."
861 (speedbar-with-attached-buffer
862 (gud-basic-call (concat "server frame " (nth 1 token)))
865 (defvar gud-gdb-fetched-stack-frame nil
866 "Stack frames we are fetching from GDB.")
868 ;(defun gud-gdb-get-scope-data (text token indent)
869 ; ;; checkdoc-params: (indent)
870 ; "Fetch data associated with a stack frame, and expand/contract it.
871 ;Data to do this is retrieved from TEXT and TOKEN."
872 ; (let ((args nil) (scope nil))
873 ; (gud-gdb-run-command-fetch-lines "info args")
875 ; (gud-gdb-run-command-fetch-lines "info local")
879 (defun gud-gdb-get-stackframe (buffer)
880 "Extract the current stack frame out of the GUD GDB BUFFER."
882 (fetched-stack-frame-list
883 (gud-gdb-run-command-fetch-lines "server backtrace" buffer)))
884 (if (and (car fetched-stack-frame-list)
885 (string-match "No stack" (car fetched-stack-frame-list)))
886 ;; Go into some other mode???
888 (dolist (e fetched-stack-frame-list)
889 (let ((name nil) (num nil))
891 (string-match "^#\\([0-9]+\\) +[0-9a-fx]+ in \\([:0-9a-zA-Z_]+\\) (" e)
892 (string-match "^#\\([0-9]+\\) +\\([:0-9a-zA-Z_]+\\) (" e)))
893 (if (not (string-match
894 "at \\([-0-9a-zA-Z_.]+\\):\\([0-9]+\\)$" e))
897 (list (nth 0 (car newlst))
900 (match-string 2 e))))
901 (setq num (match-string 1 e)
902 name (match-string 2 e))
906 "at \\([-0-9a-zA-Z_.]+\\):\\([0-9]+\\)$" e)
907 (list name num (match-string 1 e)
913 ;(defun gud-gdb-selected-frame-info (buffer)
914 ; "Learn GDB information for the currently selected stack frame in BUFFER."
917 (defun gud-gdb-run-command-fetch-lines (command buffer &optional skip)
918 "Run COMMAND, and return the list of lines it outputs.
919 BUFFER is the current buffer which may be the GUD buffer in which to run.
920 SKIP is the number of chars to skip on each line, it defaults to 0."
921 (with-current-buffer gud-comint-buffer
922 (if (and (eq gud-comint-buffer buffer)
924 (goto-char (point-max))
926 (not (looking-at comint-prompt-regexp))))
928 ;; Much of this copied from GDB complete, but I'm grabbing the stack
930 (let ((gud-gdb-fetch-lines-in-progress t)
931 (gud-gdb-fetched-lines nil)
932 (gud-gdb-fetch-lines-string nil)
933 (gud-gdb-fetch-lines-break (or skip 0))
936 (gud-gdb-fetch-lines-filter string ',gud-marker-filter))))
937 ;; Issue the command to GDB.
938 (gud-basic-call command)
940 (while gud-gdb-fetch-lines-in-progress
941 (accept-process-output (get-buffer-process gud-comint-buffer)))
942 (nreverse gud-gdb-fetched-lines)))))
945 ;; ======================================================================
948 ;; History of argument lists passed to sdb.
949 (defvar gud-sdb-history nil)
951 (defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
952 "If nil, we're on a System V Release 4 and don't need the tags hack.")
954 (defvar gud-sdb-lastfile nil)
956 (defun gud-sdb-marker-filter (string)
958 (if gud-marker-acc (concat gud-marker-acc string) string))
960 ;; Process all complete markers in this chunk
963 ;; System V Release 3.2 uses this format
964 ((string-match "\\(^\\|\n\\)\\*?\\(0x\\w* in \\)?\\([^:\n]*\\):\\([0-9]*\\):.*\n"
965 gud-marker-acc start)
967 (cons (match-string 3 gud-marker-acc)
968 (string-to-number (match-string 4 gud-marker-acc)))))
969 ;; System V Release 4.0 quite often clumps two lines together
970 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
971 gud-marker-acc start)
972 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc))
974 (cons gud-sdb-lastfile
975 (string-to-number (match-string 3 gud-marker-acc)))))
976 ;; System V Release 4.0
977 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n"
978 gud-marker-acc start)
979 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc)))
980 ((and gud-sdb-lastfile (string-match "^\\([0-9]+\\):"
981 gud-marker-acc start))
983 (cons gud-sdb-lastfile
984 (string-to-number (match-string 1 gud-marker-acc)))))
986 (setq gud-sdb-lastfile nil)))
987 (setq start (match-end 0)))
989 ;; Search for the last incomplete line in this chunk
990 (while (string-match "\n" gud-marker-acc start)
991 (setq start (match-end 0)))
993 ;; If we have an incomplete line, store it in gud-marker-acc.
994 (setq gud-marker-acc (substring gud-marker-acc (or start 0))))
997 (defun gud-sdb-find-file (f)
998 (if gud-sdb-needs-tags (find-tag-noselect f) (find-file-noselect f)))
1001 (defun sdb (command-line)
1002 "Run sdb on program FILE in buffer *gud-FILE*.
1003 The directory containing FILE becomes the initial working directory
1004 and source-file directory for your debugger."
1005 (interactive (list (gud-query-cmdline 'sdb)))
1007 (if gud-sdb-needs-tags (require 'etags))
1008 (if (and gud-sdb-needs-tags
1009 (not (and (boundp 'tags-file-name)
1010 (stringp tags-file-name)
1011 (file-exists-p tags-file-name))))
1012 (error "The sdb support requires a valid tags table to work"))
1014 (gud-common-init command-line nil 'gud-sdb-marker-filter 'gud-sdb-find-file)
1015 (set (make-local-variable 'gud-minor-mode) 'sdb)
1017 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
1018 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
1019 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
1020 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
1021 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
1022 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1023 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1024 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
1026 (setq comint-prompt-regexp "\\(^\\|\n\\)\\*")
1027 (setq paragraph-start comint-prompt-regexp)
1028 (run-hooks 'sdb-mode-hook)
1031 ;; ======================================================================
1034 ;; History of argument lists passed to dbx.
1035 (defvar gud-dbx-history nil)
1037 (defcustom gud-dbx-directories nil
1038 "*A list of directories that dbx should search for source code.
1039 If nil, only source files in the program directory
1040 will be known to dbx.
1042 The file names should be absolute, or relative to the directory
1043 containing the executable being debugged."
1044 :type '(choice (const :tag "Current Directory" nil)
1049 (defun gud-dbx-massage-args (file args)
1050 (nconc (let ((directories gud-dbx-directories)
1053 (setq result (cons (car directories) (cons "-I" result)))
1054 (setq directories (cdr directories)))
1058 (defun gud-dbx-marker-filter (string)
1059 (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
1062 ;; Process all complete markers in this chunk.
1063 (while (or (string-match
1064 "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
1065 gud-marker-acc start)
1067 "signal .* in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
1068 gud-marker-acc start))
1069 (setq gud-last-frame
1070 (cons (match-string 2 gud-marker-acc)
1071 (string-to-number (match-string 1 gud-marker-acc)))
1072 start (match-end 0)))
1074 ;; Search for the last incomplete line in this chunk
1075 (while (string-match "\n" gud-marker-acc start)
1076 (setq start (match-end 0)))
1078 ;; If the incomplete line APPEARS to begin with another marker, keep it
1079 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1080 ;; unnecessary concat during the next call.
1081 (setq gud-marker-acc
1082 (if (string-match "\\(stopped\\|signal\\)" gud-marker-acc start)
1083 (substring gud-marker-acc (match-beginning 0))
1087 ;; Functions for Mips-style dbx. Given the option `-emacs', documented in
1088 ;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
1090 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
1091 ;; We haven't tested gud on this system:
1092 (string-match "^mips-[^-]*-riscos" system-configuration)
1093 ;; It's documented on OSF/1.3
1094 (string-match "^mips-[^-]*-osf1" system-configuration)
1095 (string-match "^alpha[^-]*-[^-]*-osf" system-configuration))
1096 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
1098 (defvar gud-dbx-command-name
1099 (concat "dbx" (if gud-mips-p " -emacs")))
1101 ;; This is just like the gdb one except for the regexps since we need to cope
1102 ;; with an optional breakpoint number in [] before the ^Z^Z
1103 (defun gud-mipsdbx-marker-filter (string)
1104 (setq gud-marker-acc (concat gud-marker-acc string))
1107 ;; Process all the complete markers in this chunk.
1108 (while (string-match
1109 ;; This is like th gdb marker but with an optional
1110 ;; leading break point number like `[1] '
1111 "[][ 0-9]*\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
1115 ;; Extract the frame position from the marker.
1117 (cons (match-string 1 gud-marker-acc)
1118 (string-to-number (match-string 2 gud-marker-acc)))
1120 ;; Append any text before the marker to the output we're going
1121 ;; to return - we don't include the marker in this text.
1122 output (concat output
1123 (substring gud-marker-acc 0 (match-beginning 0)))
1125 ;; Set the accumulator to the remaining text.
1126 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1128 ;; Does the remaining text look like it might end with the
1129 ;; beginning of another marker? If it does, then keep it in
1130 ;; gud-marker-acc until we receive the rest of it. Since we
1131 ;; know the full marker regexp above failed, it's pretty simple to
1132 ;; test for marker starts.
1133 (if (string-match "[][ 0-9]*\032.*\\'" gud-marker-acc)
1135 ;; Everything before the potential marker start can be output.
1136 (setq output (concat output (substring gud-marker-acc
1137 0 (match-beginning 0))))
1139 ;; Everything after, we save, to combine with later input.
1140 (setq gud-marker-acc
1141 (substring gud-marker-acc (match-beginning 0))))
1143 (setq output (concat output gud-marker-acc)
1148 ;; The dbx in IRIX is a pain. It doesn't print the file name when
1149 ;; stopping at a breakpoint (but you do get it from the `up' and
1150 ;; `down' commands...). The only way to extract the information seems
1151 ;; to be with a `file' command, although the current line number is
1152 ;; available in $curline. Thus we have to look for output which
1153 ;; appears to indicate a breakpoint. Then we prod the dbx sub-process
1154 ;; to output the information we want with a combination of the
1155 ;; `printf' and `file' commands as a pseudo marker which we can
1156 ;; recognise next time through the marker-filter. This would be like
1157 ;; the gdb marker but you can't get the file name without a newline...
1158 ;; Note that gud-remove won't work since Irix dbx expects a breakpoint
1159 ;; number rather than a line number etc. Maybe this could be made to
1160 ;; work by listing all the breakpoints and picking the one(s) with the
1161 ;; correct line number, but life's too short.
1162 ;; d.love@dl.ac.uk (Dave Love) can be blamed for this
1165 (and (string-match "^mips-[^-]*-irix" system-configuration)
1166 (not (string-match "irix[6-9]\\.[1-9]" system-configuration)))
1167 "Non-nil to assume the interface appropriate for IRIX dbx.
1168 This works in IRIX 4, 5 and 6, but `gud-dbx-use-stopformat-p' provides
1169 a better solution in 6.1 upwards.")
1170 (defvar gud-dbx-use-stopformat-p
1171 (string-match "irix[6-9]\\.[1-9]" system-configuration)
1172 "Non-nil to use the dbx feature present at least from Irix 6.1
1173 whereby $stopformat=1 produces an output format compatible with
1174 `gud-dbx-marker-filter'.")
1175 ;; [Irix dbx seems to be a moving target. The dbx output changed
1176 ;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
1177 ;; the output from `up' is no longer spotted by gud (and it's probably
1178 ;; not distinctive enough to try to match it -- use C-<, C->
1179 ;; exclusively) . For 5.3 and 6.0, the $curline variable changed to
1180 ;; `long long'(why?!), so the printf stuff needed changing. The line
1181 ;; number was cast to `long' as a compromise between the new `long
1182 ;; long' and the original `int'. This is reported not to work in 6.2,
1183 ;; so it's changed back to int -- don't make your sources too long.
1184 ;; From Irix6.1 (but not 6.0?) dbx supports an undocumented feature
1185 ;; whereby `set $stopformat=1' reportedly produces output compatible
1186 ;; with `gud-dbx-marker-filter', which we prefer.
1188 ;; The process filter is also somewhat
1189 ;; unreliable, sometimes not spotting the markers; I don't know
1190 ;; whether there's anything that can be done about that. It would be
1191 ;; much better if SGI could be persuaded to (re?)instate the MIPS
1192 ;; -emacs flag for gdb-like output (which ought to be possible as most
1193 ;; of the communication I've had over it has been from sgi.com).]
1195 ;; this filter is influenced by the xdb one rather than the gdb one
1196 (defun gud-irixdbx-marker-filter (string)
1197 (let (result (case-fold-search nil))
1198 (if (or (string-match comint-prompt-regexp string)
1199 (string-match ".*\012" string))
1200 (setq result (concat gud-marker-acc string)
1202 (setq gud-marker-acc (concat gud-marker-acc string)))
1205 ;; look for breakpoint or signal indication e.g.:
1206 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
1207 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
1208 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
1210 "^\\(\\[[0-9]+] \\)?Process +[0-9]+ ([^)]*) [^[]+\\[[^]\n]*]\n"
1212 ;; prod dbx into printing out the line number and file
1213 ;; name in a form we can grok as below
1214 (process-send-string (get-buffer-process gud-comint-buffer)
1215 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1216 ;; look for result of, say, "up" e.g.:
1217 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
1218 ;; (this will also catch one of the lines printed by "where")
1220 "^[^ ][^[]*\\[\"\\([^\"]+\\)\":\\([0-9]+\\), [^]]+]\n"
1222 (let ((file (match-string 1 result)))
1223 (if (file-exists-p file)
1224 (setq gud-last-frame
1225 (cons (match-string 1 result)
1226 (string-to-number (match-string 2 result))))))
1228 ((string-match ; kluged-up marker as above
1229 "\032\032\\([0-9]*\\):\\(.*\\)\n" result)
1230 (let ((file (gud-file-name (match-string 2 result))))
1231 (if (and file (file-exists-p file))
1232 (setq gud-last-frame
1234 (string-to-number (match-string 1 result))))))
1235 (setq result (substring result 0 (match-beginning 0))))))
1238 ;; There are a couple of differences between DG's dbx output and normal
1239 ;; dbx output which make it nontrivial to integrate this into the
1240 ;; standard dbx-marker-filter (mainly, there are a different number of
1241 ;; backreferences). The markers look like:
1243 ;; (0) Stopped at line 10, routine main(argc=1, argv=0xeffff0e0), file t.c
1245 ;; from breakpoints (the `(0)' there isn't constant, it's the breakpoint
1248 ;; Stopped at line 13, routine main(argc=1, argv=0xeffff0e0), file t.c
1252 ;; Frame 21, line 974, routine command_loop(), file keyboard.c
1254 ;; from up/down/where.
1256 (defun gud-dguxdbx-marker-filter (string)
1257 (setq gud-marker-acc (if gud-marker-acc
1258 (concat gud-marker-acc string)
1260 (let ((re (concat "^\\(\\(([0-9]+) \\)?Stopped at\\|Frame [0-9]+,\\)"
1261 " line \\([0-9]+\\), routine .*, file \\([^ \t\n]+\\)"))
1263 ;; Process all complete markers in this chunk.
1264 (while (string-match re gud-marker-acc start)
1265 (setq gud-last-frame
1266 (cons (match-string 4 gud-marker-acc)
1267 (string-to-number (match-string 3 gud-marker-acc)))
1268 start (match-end 0)))
1270 ;; Search for the last incomplete line in this chunk
1271 (while (string-match "\n" gud-marker-acc start)
1272 (setq start (match-end 0)))
1274 ;; If the incomplete line APPEARS to begin with another marker, keep it
1275 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1276 ;; unnecessary concat during the next call.
1277 (setq gud-marker-acc
1278 (if (string-match "Stopped\\|Frame" gud-marker-acc start)
1279 (substring gud-marker-acc (match-beginning 0))
1284 (defun dbx (command-line)
1285 "Run dbx on program FILE in buffer *gud-FILE*.
1286 The directory containing FILE becomes the initial working directory
1287 and source-file directory for your debugger."
1288 (interactive (list (gud-query-cmdline 'dbx)))
1292 (gud-common-init command-line nil 'gud-mipsdbx-marker-filter))
1294 (gud-common-init command-line 'gud-dbx-massage-args
1295 'gud-irixdbx-marker-filter))
1297 (gud-common-init command-line 'gud-dbx-massage-args
1298 'gud-dbx-marker-filter)))
1300 (set (make-local-variable 'gud-minor-mode) 'dbx)
1304 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1305 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1306 (gud-def gud-break "stop at \"%f\":%l"
1307 "\C-b" "Set breakpoint at current line.")
1308 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
1310 (gud-def gud-break "stop at \"%d%f\":%l"
1311 "\C-b" "Set breakpoint at current line.")
1312 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1313 (gud-def gud-up "up %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1314 "<" "Up (numeric arg) stack frames.")
1315 (gud-def gud-down "down %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1316 ">" "Down (numeric arg) stack frames.")
1317 ;; Make dbx give out the source location info that we need.
1318 (process-send-string (get-buffer-process gud-comint-buffer)
1319 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1321 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1322 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1323 (gud-def gud-break "file \"%d%f\"\nstop at %l"
1324 "\C-b" "Set breakpoint at current line.")
1325 (if gud-dbx-use-stopformat-p
1326 (process-send-string (get-buffer-process gud-comint-buffer)
1327 "set $stopformat=1\n"))))
1329 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
1330 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
1331 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
1332 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
1333 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
1334 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
1335 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
1336 (gud-def gud-run "run" nil "Run the program.")
1338 (setq comint-prompt-regexp "^[^)\n]*dbx) *")
1339 (setq paragraph-start comint-prompt-regexp)
1340 (run-hooks 'dbx-mode-hook)
1343 ;; ======================================================================
1344 ;; xdb (HP PARISC debugger) functions
1346 ;; History of argument lists passed to xdb.
1347 (defvar gud-xdb-history nil)
1349 (defcustom gud-xdb-directories nil
1350 "*A list of directories that xdb should search for source code.
1351 If nil, only source files in the program directory
1352 will be known to xdb.
1354 The file names should be absolute, or relative to the directory
1355 containing the executable being debugged."
1356 :type '(choice (const :tag "Current Directory" nil)
1361 (defun gud-xdb-massage-args (file args)
1362 (nconc (let ((directories gud-xdb-directories)
1365 (setq result (cons (car directories) (cons "-d" result)))
1366 (setq directories (cdr directories)))
1370 ;; xdb does not print the lines all at once, so we have to accumulate them
1371 (defun gud-xdb-marker-filter (string)
1373 (if (or (string-match comint-prompt-regexp string)
1374 (string-match ".*\012" string))
1375 (setq result (concat gud-marker-acc string)
1377 (setq gud-marker-acc (concat gud-marker-acc string)))
1379 (if (or (string-match "\\([^\n \t:]+\\): [^:]+: \\([0-9]+\\)[: ]"
1381 (string-match "[^: \t]+:[ \t]+\\([^:]+\\): [^:]+: \\([0-9]+\\):"
1383 (let ((line (string-to-number (match-string 2 result)))
1384 (file (gud-file-name (match-string 1 result))))
1386 (setq gud-last-frame (cons file line))))))
1390 (defun xdb (command-line)
1391 "Run xdb on program FILE in buffer *gud-FILE*.
1392 The directory containing FILE becomes the initial working directory
1393 and source-file directory for your debugger.
1395 You can set the variable `gud-xdb-directories' to a list of program source
1396 directories if your program contains sources from more than one directory."
1397 (interactive (list (gud-query-cmdline 'xdb)))
1399 (gud-common-init command-line 'gud-xdb-massage-args
1400 'gud-xdb-marker-filter)
1401 (set (make-local-variable 'gud-minor-mode) 'xdb)
1403 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
1404 (gud-def gud-tbreak "b %f:%l\\t" "\C-t"
1405 "Set temporary breakpoint at current line.")
1406 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
1407 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
1408 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1409 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1410 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1411 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1412 (gud-def gud-finish "bu\\t" "\C-f" "Finish executing current function.")
1413 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
1415 (setq comint-prompt-regexp "^>")
1416 (setq paragraph-start comint-prompt-regexp)
1417 (run-hooks 'xdb-mode-hook))
1419 ;; ======================================================================
1422 ;; History of argument lists passed to perldb.
1423 (defvar gud-perldb-history nil)
1425 (defun gud-perldb-massage-args (file args)
1426 "Convert a command line as would be typed normally to run perldb
1427 into one that invokes an Emacs-enabled debugging session.
1428 \"-emacs\" is inserted where it will be $ARGV[0] (see perl5db.pl)."
1429 ;; FIXME: what if the command is `make perldb' and doesn't accept those extra
1431 (let* ((new-args nil)
1433 (shift (lambda () (push (pop args) new-args))))
1435 ;; Pass all switches and -e scripts through.
1437 (string-match "^-" (car args))
1438 (not (equal "-" (car args)))
1439 (not (equal "--" (car args))))
1440 (when (equal "-e" (car args))
1441 ;; -e goes with the next arg, so shift one extra.
1443 ;; -e as the last arg is an error in Perl.
1444 (error "No code specified for -e"))
1450 (string-match "^-" (car args)))
1451 (error "Can't use stdin as the script to debug"))
1452 ;; This is the program name.
1455 ;; If -e specified, make sure there is a -- so -emacs is not taken
1457 (if (and args (equal "--" (car args)))
1459 (and seen-e (push "--" new-args)))
1461 (push "-emacs" new-args)
1465 (nreverse new-args)))
1467 ;; There's no guarantee that Emacs will hand the filter the entire
1468 ;; marker at once; it could be broken up across several strings. We
1469 ;; might even receive a big chunk with several markers in it. If we
1470 ;; receive a chunk of text which looks like it might contain the
1471 ;; beginning of a marker, we save it here between calls to the
1473 (defun gud-perldb-marker-filter (string)
1474 (setq gud-marker-acc (concat gud-marker-acc string))
1477 ;; Process all the complete markers in this chunk.
1478 (while (string-match "\032\032\\(\\([a-zA-Z]:\\)?[^:\n]*\\):\\([0-9]*\\):.*\n"
1482 ;; Extract the frame position from the marker.
1484 (cons (match-string 1 gud-marker-acc)
1485 (string-to-number (match-string 3 gud-marker-acc)))
1487 ;; Append any text before the marker to the output we're going
1488 ;; to return - we don't include the marker in this text.
1489 output (concat output
1490 (substring gud-marker-acc 0 (match-beginning 0)))
1492 ;; Set the accumulator to the remaining text.
1493 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1495 ;; Does the remaining text look like it might end with the
1496 ;; beginning of another marker? If it does, then keep it in
1497 ;; gud-marker-acc until we receive the rest of it. Since we
1498 ;; know the full marker regexp above failed, it's pretty simple to
1499 ;; test for marker starts.
1500 (if (string-match "\032.*\\'" gud-marker-acc)
1502 ;; Everything before the potential marker start can be output.
1503 (setq output (concat output (substring gud-marker-acc
1504 0 (match-beginning 0))))
1506 ;; Everything after, we save, to combine with later input.
1507 (setq gud-marker-acc
1508 (substring gud-marker-acc (match-beginning 0))))
1510 (setq output (concat output gud-marker-acc)
1515 (defcustom gud-perldb-command-name "perl -d"
1516 "Default command to execute a Perl script under debugger."
1521 (defun perldb (command-line)
1522 "Run perldb on program FILE in buffer *gud-FILE*.
1523 The directory containing FILE becomes the initial working directory
1524 and source-file directory for your debugger."
1526 (list (gud-query-cmdline 'perldb
1527 (concat (or (buffer-file-name) "-e 0") " "))))
1529 (gud-common-init command-line 'gud-perldb-massage-args
1530 'gud-perldb-marker-filter)
1531 (set (make-local-variable 'gud-minor-mode) 'perldb)
1533 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
1534 (gud-def gud-remove "B %l" "\C-d" "Remove breakpoint at current line")
1535 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
1536 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
1537 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1538 ; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
1539 ; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
1540 ; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
1541 (gud-def gud-print "p %e" "\C-p" "Evaluate perl expression at point.")
1542 (gud-def gud-until "c %l" "\C-u" "Continue to current line.")
1545 (setq comint-prompt-regexp "^ DB<+[0-9]+>+ ")
1546 (setq paragraph-start comint-prompt-regexp)
1547 (run-hooks 'perldb-mode-hook))
1549 ;; ======================================================================
1550 ;; pdb (Python debugger) functions
1552 ;; History of argument lists passed to pdb.
1553 (defvar gud-pdb-history nil)
1555 ;; Last group is for return value, e.g. "> test.py(2)foo()->None"
1556 ;; Either file or function name may be omitted: "> <string>(0)?()"
1557 (defvar gud-pdb-marker-regexp
1558 "^> \\([-a-zA-Z0-9_/.:\\]*\\|<string>\\)(\\([0-9]+\\))\\([a-zA-Z0-9_]*\\|\\?\\|<module>\\)()\\(->[^\n]*\\)?\n")
1559 (defvar gud-pdb-marker-regexp-file-group 1)
1560 (defvar gud-pdb-marker-regexp-line-group 2)
1561 (defvar gud-pdb-marker-regexp-fnname-group 3)
1563 (defvar gud-pdb-marker-regexp-start "^> ")
1565 ;; There's no guarantee that Emacs will hand the filter the entire
1566 ;; marker at once; it could be broken up across several strings. We
1567 ;; might even receive a big chunk with several markers in it. If we
1568 ;; receive a chunk of text which looks like it might contain the
1569 ;; beginning of a marker, we save it here between calls to the
1571 (defun gud-pdb-marker-filter (string)
1572 (setq gud-marker-acc (concat gud-marker-acc string))
1575 ;; Process all the complete markers in this chunk.
1576 (while (string-match gud-pdb-marker-regexp gud-marker-acc)
1579 ;; Extract the frame position from the marker.
1581 (let ((file (match-string gud-pdb-marker-regexp-file-group
1583 (line (string-to-number
1584 (match-string gud-pdb-marker-regexp-line-group
1586 (if (string-equal file "<string>")
1590 ;; Output everything instead of the below
1591 output (concat output (substring gud-marker-acc 0 (match-end 0)))
1592 ;; ;; Append any text before the marker to the output we're going
1593 ;; ;; to return - we don't include the marker in this text.
1594 ;; output (concat output
1595 ;; (substring gud-marker-acc 0 (match-beginning 0)))
1597 ;; Set the accumulator to the remaining text.
1598 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1600 ;; Does the remaining text look like it might end with the
1601 ;; beginning of another marker? If it does, then keep it in
1602 ;; gud-marker-acc until we receive the rest of it. Since we
1603 ;; know the full marker regexp above failed, it's pretty simple to
1604 ;; test for marker starts.
1605 (if (string-match gud-pdb-marker-regexp-start gud-marker-acc)
1607 ;; Everything before the potential marker start can be output.
1608 (setq output (concat output (substring gud-marker-acc
1609 0 (match-beginning 0))))
1611 ;; Everything after, we save, to combine with later input.
1612 (setq gud-marker-acc
1613 (substring gud-marker-acc (match-beginning 0))))
1615 (setq output (concat output gud-marker-acc)
1620 (defcustom gud-pdb-command-name "pdb"
1621 "File name for executing the Python debugger.
1622 This should be an executable on your path, or an absolute file name."
1627 (defun pdb (command-line)
1628 "Run pdb on program FILE in buffer `*gud-FILE*'.
1629 The directory containing FILE becomes the initial working directory
1630 and source-file directory for your debugger."
1632 (list (gud-query-cmdline 'pdb)))
1634 (gud-common-init command-line nil 'gud-pdb-marker-filter)
1635 (set (make-local-variable 'gud-minor-mode) 'pdb)
1637 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
1638 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
1639 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
1640 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
1641 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
1642 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1643 (gud-def gud-up "up" "<" "Up one stack frame.")
1644 (gud-def gud-down "down" ">" "Down one stack frame.")
1645 (gud-def gud-print "p %e" "\C-p" "Evaluate Python expression at point.")
1647 (gud-def gud-statement "! %e" "\C-e" "Execute Python statement at point.")
1649 ;; (setq comint-prompt-regexp "^(.*pdb[+]?) *")
1650 (setq comint-prompt-regexp "^(Pdb) *")
1651 (setq paragraph-start comint-prompt-regexp)
1652 (run-hooks 'pdb-mode-hook))
1654 ;; ======================================================================
1658 ;; AUTHOR: Derek Davies <ddavies@world.std.com>
1659 ;; Zoltan Kemenczy <zoltan@ieee.org;zkemenczy@rim.net>
1661 ;; CREATED: Sun Feb 22 10:46:38 1998 Derek Davies.
1662 ;; UPDATED: Nov 11, 2001 Zoltan Kemenczy
1663 ;; Dec 10, 2002 Zoltan Kemenczy - added nested class support
1665 ;; INVOCATION NOTES:
1667 ;; You invoke jdb-mode with:
1671 ;; It responds with:
1673 ;; Run jdb (like this): jdb
1675 ;; type any jdb switches followed by the name of the class you'd like to debug.
1676 ;; Supply a fully qualfied classname (these do not have the ".class" extension)
1677 ;; for the name of the class to debug (e.g. "COM.the-kind.ddavies.CoolClass").
1678 ;; See the known problems section below for restrictions when specifying jdb
1679 ;; command line switches (search forward for '-classpath').
1681 ;; You should see something like the following:
1683 ;; Current directory is ~/src/java/hello/
1684 ;; Initializing jdb...
1685 ;; 0xed2f6628:class(hello)
1688 ;; To set an initial breakpoint try:
1690 ;; > stop in hello.main
1691 ;; Breakpoint set in hello.main
1694 ;; To execute the program type:
1699 ;; Breakpoint hit: running ...
1700 ;; hello.main (hello:12)
1702 ;; Type M-n to step over the current line and M-s to step into it. That,
1703 ;; along with the JDB 'help' command should get you started. The 'quit'
1704 ;; JDB command will get out out of the debugger. There is some truly
1705 ;; pathetic JDB documentation available at:
1707 ;; http://java.sun.com/products/jdk/1.1/debugging/
1709 ;; KNOWN PROBLEMS AND FIXME's:
1711 ;; Not sure what happens with inner classes ... haven't tried them.
1713 ;; Does not grok UNICODE id's. Only ASCII id's are supported.
1715 ;; You must not put whitespace between "-classpath" and the path to
1716 ;; search for java classes even though it is required when invoking jdb
1717 ;; from the command line. See gud-jdb-massage-args for details.
1718 ;; The same applies for "-sourcepath".
1720 ;; Note: The following applies only if `gud-jdb-use-classpath' is nil;
1721 ;; refer to the documentation of `gud-jdb-use-classpath' and
1722 ;; `gud-jdb-classpath',`gud-jdb-sourcepath' variables for information
1723 ;; on using the classpath for locating java source files.
1725 ;; If any of the source files in the directories listed in
1726 ;; gud-jdb-directories won't parse you'll have problems. Make sure
1727 ;; every file ending in ".java" in these directories parses without error.
1729 ;; All the .java files in the directories in gud-jdb-directories are
1730 ;; syntactically analyzed each time gud jdb is invoked. It would be
1731 ;; nice to keep as much information as possible between runs. It would
1732 ;; be really nice to analyze the files only as neccessary (when the
1733 ;; source needs to be displayed.) I'm not sure to what extent the former
1734 ;; can be accomplished and I'm not sure the latter can be done at all
1735 ;; since I don't know of any general way to tell which .class files are
1736 ;; defined by which .java file without analyzing all the .java files.
1737 ;; If anyone knows why JavaSoft didn't put the source file names in
1738 ;; debuggable .class files please clue me in so I find something else
1739 ;; to be spiteful and bitter about.
1741 ;; ======================================================================
1742 ;; gud jdb variables and functions
1744 (defcustom gud-jdb-command-name "jdb"
1745 "Command that executes the Java debugger."
1749 (defcustom gud-jdb-use-classpath t
1750 "If non-nil, search for Java source files in classpath directories.
1751 The list of directories to search is the value of `gud-jdb-classpath'.
1752 The file pathname is obtained by converting the fully qualified
1753 class information output by jdb to a relative pathname and appending
1754 it to `gud-jdb-classpath' element by element until a match is found.
1756 This method has a significant jdb startup time reduction advantage
1757 since it does not require the scanning of all `gud-jdb-directories'
1758 and parsing all Java files for class information.
1760 Set to nil to use `gud-jdb-directories' to scan java sources for
1761 class information on jdb startup (original method)."
1765 (defvar gud-jdb-classpath nil
1766 "Java/jdb classpath directories list.
1767 If `gud-jdb-use-classpath' is non-nil, gud-jdb derives the `gud-jdb-classpath'
1768 list automatically using the following methods in sequence
1769 \(with subsequent successful steps overriding the results of previous
1772 1) Read the CLASSPATH environment variable,
1773 2) Read any \"-classpath\" argument used to run jdb,
1774 or detected in jdb output (e.g. if jdb is run by a script
1775 that echoes the actual jdb command before starting jdb),
1776 3) Send a \"classpath\" command to jdb and scan jdb output for
1777 classpath information if jdb is invoked with an \"-attach\" (to
1778 an already running VM) argument (This case typically does not
1779 have a \"-classpath\" command line argument - that is provided
1780 to the VM when it is started).
1782 Note that method 3 cannot be used with oldjdb (or Java 1 jdb) since
1783 those debuggers do not support the classpath command. Use 1) or 2).")
1785 (defvar gud-jdb-sourcepath nil
1786 "Directory list provided by an (optional) \"-sourcepath\" option to jdb.
1787 This list is prepended to `gud-jdb-classpath' to form the complete
1788 list of directories searched for source files.")
1790 (defvar gud-marker-acc-max-length 4000
1791 "Maximum number of debugger output characters to keep.
1792 This variable limits the size of `gud-marker-acc' which holds
1793 the most recent debugger output history while searching for
1794 source file information.")
1796 (defvar gud-jdb-history nil
1797 "History of argument lists passed to jdb.")
1800 ;; List of Java source file directories.
1801 (defvar gud-jdb-directories (list ".")
1802 "*A list of directories that gud jdb should search for source code.
1803 The file names should be absolute, or relative to the current
1806 The set of .java files residing in the directories listed are
1807 syntactically analyzed to determine the classes they define and the
1808 packages in which these classes belong. In this way gud jdb maps the
1809 package-qualified class names output by the jdb debugger to the source
1810 file from which the class originated. This allows gud mode to keep
1811 the source code display in sync with the debugging session.")
1813 (defvar gud-jdb-source-files nil
1814 "List of the java source files for this debugging session.")
1816 ;; Association list of fully qualified class names (package + class name)
1817 ;; and their source files.
1818 (defvar gud-jdb-class-source-alist nil
1819 "Association list of fully qualified class names and source files.")
1821 ;; This is used to hold a source file during analysis.
1822 (defvar gud-jdb-analysis-buffer nil)
1824 (defvar gud-jdb-classpath-string nil
1825 "Holds temporary classpath values.")
1827 (defun gud-jdb-build-source-files-list (path extn)
1828 "Return a list of java source files (absolute paths).
1829 PATH gives the directories in which to search for files with
1830 extension EXTN. Normally EXTN is given as the regular expression
1832 (apply 'nconc (mapcar (lambda (d)
1833 (when (file-directory-p d)
1834 (directory-files d t extn nil)))
1837 ;; Move point past whitespace.
1838 (defun gud-jdb-skip-whitespace ()
1839 (skip-chars-forward " \n\r\t\014"))
1841 ;; Move point past a "// <eol>" type of comment.
1842 (defun gud-jdb-skip-single-line-comment ()
1845 ;; Move point past a "/* */" or "/** */" type of comment.
1846 (defun gud-jdb-skip-traditional-or-documentation-comment ()
1850 (if (eq (following-char) ?*)
1854 (if (eq (following-char) ?/)
1857 (throw 'break nil)))))
1860 ;; Move point past any number of consecutive whitespace chars and/or comments.
1861 (defun gud-jdb-skip-whitespace-and-comments ()
1862 (gud-jdb-skip-whitespace)
1867 (gud-jdb-skip-single-line-comment)
1868 (gud-jdb-skip-whitespace))
1869 ((looking-at "/\\*")
1870 (gud-jdb-skip-traditional-or-documentation-comment)
1871 (gud-jdb-skip-whitespace))
1872 (t (throw 'done nil))))))
1874 ;; Move point past things that are id-like. The intent is to skip regular
1875 ;; id's, such as class or interface names as well as package and interface
1877 (defun gud-jdb-skip-id-ish-thing ()
1878 (skip-chars-forward "^ /\n\r\t\014,;{"))
1880 ;; Move point past a string literal.
1881 (defun gud-jdb-skip-string-literal ()
1884 ((eq (following-char) ?\\)
1886 ((eq (following-char) ?\042))))
1890 ;; Move point past a character literal.
1891 (defun gud-jdb-skip-character-literal ()
1895 (if (eq (following-char) ?\\)
1897 (not (eq (following-char) ?\')))
1901 ;; Move point past the following block. There may be (legal) cruft before
1902 ;; the block's opening brace. There must be a block or it's the end of life
1903 ;; in petticoat junction.
1904 (defun gud-jdb-skip-block ()
1906 ;; Find the begining of the block.
1908 (not (eq (following-char) ?{))
1910 ;; Skip any constructs that can harbor literal block delimiter
1911 ;; characters and/or the delimiters for the constructs themselves.
1914 (gud-jdb-skip-single-line-comment))
1915 ((looking-at "/\\*")
1916 (gud-jdb-skip-traditional-or-documentation-comment))
1917 ((eq (following-char) ?\042)
1918 (gud-jdb-skip-string-literal))
1919 ((eq (following-char) ?\')
1920 (gud-jdb-skip-character-literal))
1921 (t (forward-char))))
1923 ;; Now at the begining of the block.
1926 ;; Skip over the body of the block as well as the final brace.
1927 (let ((open-level 1))
1928 (while (not (eq open-level 0))
1931 (gud-jdb-skip-single-line-comment))
1932 ((looking-at "/\\*")
1933 (gud-jdb-skip-traditional-or-documentation-comment))
1934 ((eq (following-char) ?\042)
1935 (gud-jdb-skip-string-literal))
1936 ((eq (following-char) ?\')
1937 (gud-jdb-skip-character-literal))
1938 ((eq (following-char) ?{)
1939 (setq open-level (+ open-level 1))
1941 ((eq (following-char) ?})
1942 (setq open-level (- open-level 1))
1944 (t (forward-char))))))
1946 ;; Find the package and class definitions in Java source file FILE. Assumes
1947 ;; that FILE contains a legal Java program. BUF is a scratch buffer used
1948 ;; to hold the source during analysis.
1949 (defun gud-jdb-analyze-source (buf file)
1952 (insert-file-contents file nil nil nil t)
1957 (gud-jdb-skip-whitespace)
1961 ;; Any number of semi's following a block is legal. Move point
1962 ;; past them. Note that comments and whitespace may be
1963 ;; interspersed as well.
1964 ((eq (following-char) ?\073)
1967 ;; Move point past a single line comment.
1969 (gud-jdb-skip-single-line-comment))
1971 ;; Move point past a traditional or documentation comment.
1972 ((looking-at "/\\*")
1973 (gud-jdb-skip-traditional-or-documentation-comment))
1975 ;; Move point past a package statement, but save the PackageName.
1976 ((looking-at "package")
1978 (gud-jdb-skip-whitespace-and-comments)
1980 (gud-jdb-skip-id-ish-thing)
1981 (setq p (concat (buffer-substring s (point)) "."))
1982 (gud-jdb-skip-whitespace-and-comments)
1983 (if (eq (following-char) ?\073)
1986 ;; Move point past an import statement.
1987 ((looking-at "import")
1989 (gud-jdb-skip-whitespace-and-comments)
1990 (gud-jdb-skip-id-ish-thing)
1991 (gud-jdb-skip-whitespace-and-comments)
1992 (if (eq (following-char) ?\073)
1995 ;; Move point past the various kinds of ClassModifiers.
1996 ((looking-at "public")
1998 ((looking-at "abstract")
2000 ((looking-at "final")
2003 ;; Move point past a ClassDeclaraction, but save the class
2005 ((looking-at "class")
2007 (gud-jdb-skip-whitespace-and-comments)
2009 (gud-jdb-skip-id-ish-thing)
2011 l (nconc l (list (concat p (buffer-substring s (point)))))))
2012 (gud-jdb-skip-block))
2014 ;; Move point past an interface statement.
2015 ((looking-at "interface")
2017 (gud-jdb-skip-block))
2019 ;; Anything else means the input is invalid.
2021 (message "Error parsing file %s." file)
2022 (throw 'abort nil))))))
2025 (defun gud-jdb-build-class-source-alist-for-file (file)
2029 (gud-jdb-analyze-source gud-jdb-analysis-buffer file)))
2031 ;; Return an alist of fully qualified classes and the source files
2032 ;; holding their definitions. SOURCES holds a list of all the source
2033 ;; files to examine.
2034 (defun gud-jdb-build-class-source-alist (sources)
2035 (setq gud-jdb-analysis-buffer (get-buffer-create " *gud-jdb-scratch*"))
2040 'gud-jdb-build-class-source-alist-for-file
2042 (kill-buffer gud-jdb-analysis-buffer)
2043 (setq gud-jdb-analysis-buffer nil)))
2045 ;; Change what was given in the minibuffer to something that can be used to
2046 ;; invoke the debugger.
2047 (defun gud-jdb-massage-args (file args)
2048 ;; The jdb executable must have whitespace between "-classpath" and
2049 ;; its value while gud-common-init expects all switch values to
2050 ;; follow the switch keyword without intervening whitespace. We
2051 ;; require that when the user enters the "-classpath" switch in the
2052 ;; EMACS minibuffer that they do so without the intervening
2053 ;; whitespace. This function adds it back (it's called after
2054 ;; gud-common-init). There are more switches like this (for
2055 ;; instance "-host" and "-password") but I don't care about them
2058 (let (massaged-args user-error)
2060 (while (and args (not user-error))
2062 ((setq user-error (string-match "-classpath$" (car args))))
2063 ((setq user-error (string-match "-sourcepath$" (car args))))
2064 ((string-match "-classpath\\(.+\\)" (car args))
2066 (append massaged-args
2068 (setq gud-jdb-classpath-string
2069 (match-string 1 (car args)))))))
2070 ((string-match "-sourcepath\\(.+\\)" (car args))
2072 (append massaged-args
2074 (setq gud-jdb-sourcepath
2075 (match-string 1 (car args)))))))
2076 (t (setq massaged-args (append massaged-args (list (car args))))))
2077 (setq args (cdr args)))
2079 ;; By this point the current directory is all screwed up. Maybe we
2080 ;; could fix things and re-invoke gud-common-init, but for now I think
2081 ;; issueing the error is good enough.
2084 (kill-buffer (current-buffer))
2085 (error "Error: Omit whitespace between '-classpath or -sourcepath' and its value")))
2088 ;; Search for an association with P, a fully qualified class name, in
2089 ;; gud-jdb-class-source-alist. The asssociation gives the fully
2090 ;; qualified file name of the source file which produced the class.
2091 (defun gud-jdb-find-source-file (p)
2092 (cdr (assoc p gud-jdb-class-source-alist)))
2094 ;; Note: Reset to this value every time a prompt is seen
2095 (defvar gud-jdb-lowest-stack-level 999)
2097 (defun gud-jdb-find-source-using-classpath (p)
2098 "Find source file corresponding to fully qualified class P.
2099 Convert P from jdb's output, converted to a pathname
2100 relative to a classpath directory."
2103 (;; Replace dots with slashes and append ".java" to generate file
2104 ;; name relative to classpath
2107 (mapconcat 'identity
2109 ;; Eliminate any subclass references in the class
2110 ;; name string. These start with a "$"
2112 (if (string-match "$.*" x)
2113 (replace-match "" t t x) p))
2117 (cplist (append gud-jdb-sourcepath gud-jdb-classpath))
2120 (not (setq found-file
2122 (concat (car cplist) "/" filename)))))
2123 (setq cplist (cdr cplist)))
2124 (if found-file (concat (car cplist) "/" filename)))))
2126 (defun gud-jdb-find-source (string)
2127 "Alias for function used to locate source files.
2128 Set to `gud-jdb-find-source-using-classpath' or `gud-jdb-find-source-file'
2129 during jdb initialization depending on the value of
2130 `gud-jdb-use-classpath'."
2133 (defun gud-jdb-parse-classpath-string (string)
2134 "Parse the classpath list and convert each item to an absolute pathname."
2135 (mapcar (lambda (s) (if (string-match "[/\\]$" s)
2136 (replace-match "" nil nil s) s))
2137 (mapcar 'file-truename
2140 (concat "[ \t\n\r,\"" path-separator "]+")))))
2142 ;; See comentary for other debugger's marker filters - there you will find
2143 ;; important notes about STRING.
2144 (defun gud-jdb-marker-filter (string)
2146 ;; Build up the accumulator.
2147 (setq gud-marker-acc
2149 (concat gud-marker-acc string)
2152 ;; Look for classpath information until gud-jdb-classpath-string is found
2153 ;; (interactive, multiple settings of classpath from jdb
2154 ;; not supported/followed)
2155 (if (and gud-jdb-use-classpath
2156 (not gud-jdb-classpath-string)
2157 (or (string-match "classpath:[ \t[]+\\([^]]+\\)" gud-marker-acc)
2158 (string-match "-classpath[ \t\"]+\\([^ \"]+\\)" gud-marker-acc)))
2159 (setq gud-jdb-classpath
2160 (gud-jdb-parse-classpath-string
2161 (setq gud-jdb-classpath-string
2162 (match-string 1 gud-marker-acc)))))
2164 ;; We process STRING from left to right. Each time through the
2165 ;; following loop we process at most one marker. After we've found a
2166 ;; marker, delete gud-marker-acc up to and including the match
2168 ;; Process each complete marker in the input.
2171 ;; Do we see a marker?
2173 ;; jdb puts out a string of the following form when it
2174 ;; hits a breakpoint:
2176 ;; <fully-qualified-class><method> (<class>:<line-number>)
2178 ;; <fully-qualified-class>'s are composed of Java ID's
2179 ;; separated by periods. <method> and <class> are
2180 ;; also Java ID's. <method> begins with a period and
2181 ;; may contain less-than and greater-than (constructors,
2182 ;; for instance, are called <init> in the symbol table.)
2183 ;; Java ID's begin with a letter followed by letters
2184 ;; and/or digits. The set of letters includes underscore
2187 ;; The first group matches <fully-qualified-class>,
2188 ;; the second group matches <class> and the third group
2189 ;; matches <line-number>. We don't care about using
2190 ;; <method> so we don't "group" it.
2192 ;; FIXME: Java ID's are UNICODE strings, this matches ASCII
2195 ;; The ".," in the last square-bracket are necessary because
2196 ;; of Sun's total disrespect for backwards compatibility in
2197 ;; reported line numbers from jdb - starting in 1.4.0 they
2198 ;; print line numbers using LOCALE, inserting a comma or a
2199 ;; period at the thousands positions (how ingenious!).
2201 "\\(\\[[0-9]+] \\)*\\([a-zA-Z0-9.$_]+\\)\\.[a-zA-Z0-9$_<>(),]+ \
2202 \\(([a-zA-Z0-9.$_]+:\\|line=\\)\\([0-9.,]+\\)"
2205 ;; A good marker is one that:
2206 ;; 1) does not have a "[n] " prefix (not part of a stack backtrace)
2207 ;; 2) does have an "[n] " prefix and n is the lowest prefix seen
2208 ;; since the last prompt
2209 ;; Figure out the line on which to position the debugging arrow.
2210 ;; Return the info as a cons of the form:
2212 ;; (<file-name> . <line-number>) .
2213 (if (if (match-beginning 1)
2215 (setq n (string-to-number (substring
2217 (1+ (match-beginning 1))
2218 (- (match-end 1) 2))))
2219 (if (< n gud-jdb-lowest-stack-level)
2220 (progn (setq gud-jdb-lowest-stack-level n) t)))
2222 (if (setq file-found
2223 (gud-jdb-find-source (match-string 2 gud-marker-acc)))
2224 (setq gud-last-frame
2228 ((numstr (match-string 4 gud-marker-acc)))
2229 (if (string-match "[.,]" numstr)
2230 (replace-match "" nil nil numstr)
2232 (message "Could not find source file.")))
2234 ;; Set the accumulator to the remaining text.
2235 (setq gud-marker-acc (substring gud-marker-acc (match-end 0))))
2237 (if (string-match comint-prompt-regexp gud-marker-acc)
2238 (setq gud-jdb-lowest-stack-level 999)))
2240 ;; Do not allow gud-marker-acc to grow without bound. If the source
2241 ;; file information is not within the last 3/4
2242 ;; gud-marker-acc-max-length characters, well,...
2243 (if (> (length gud-marker-acc) gud-marker-acc-max-length)
2244 (setq gud-marker-acc
2245 (substring gud-marker-acc
2246 (- (/ (* gud-marker-acc-max-length 3) 4)))))
2248 ;; We don't filter any debugger output so just return what we were given.
2251 (defvar gud-jdb-command-name "jdb" "Command that executes the Java debugger.")
2254 (defun jdb (command-line)
2255 "Run jdb with command line COMMAND-LINE in a buffer.
2256 The buffer is named \"*gud*\" if no initial class is given or
2257 \"*gud-<initial-class-basename>*\" if there is. If the \"-classpath\"
2258 switch is given, omit all whitespace between it and its value.
2260 See `gud-jdb-use-classpath' and `gud-jdb-classpath' documentation for
2261 information on how jdb accesses source files. Alternatively (if
2262 `gud-jdb-use-classpath' is nil), see `gud-jdb-directories' for the
2263 original source file access method.
2265 For general information about commands available to control jdb from
2266 gud, see `gud-mode'."
2268 (list (gud-query-cmdline 'jdb)))
2269 (setq gud-jdb-classpath nil)
2270 (setq gud-jdb-sourcepath nil)
2272 ;; Set gud-jdb-classpath from the CLASSPATH environment variable,
2273 ;; if CLASSPATH is set.
2274 (setq gud-jdb-classpath-string (getenv "CLASSPATH"))
2275 (if gud-jdb-classpath-string
2276 (setq gud-jdb-classpath
2277 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2278 (setq gud-jdb-classpath-string nil) ; prepare for next
2280 (gud-common-init command-line 'gud-jdb-massage-args
2281 'gud-jdb-marker-filter)
2282 (set (make-local-variable 'gud-minor-mode) 'jdb)
2284 ;; If a -classpath option was provided, set gud-jdb-classpath
2285 (if gud-jdb-classpath-string
2286 (setq gud-jdb-classpath
2287 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2288 (setq gud-jdb-classpath-string nil) ; prepare for next
2289 ;; If a -sourcepath option was provided, parse it
2290 (if gud-jdb-sourcepath
2291 (setq gud-jdb-sourcepath
2292 (gud-jdb-parse-classpath-string gud-jdb-sourcepath)))
2294 (gud-def gud-break "stop at %c:%l" "\C-b" "Set breakpoint at current line.")
2295 (gud-def gud-remove "clear %c:%l" "\C-d" "Remove breakpoint at current line")
2296 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2297 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2298 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
2299 (gud-def gud-finish "step up" "\C-f" "Continue until current method returns.")
2300 (gud-def gud-up "up\C-Mwhere" "<" "Up one stack frame.")
2301 (gud-def gud-down "down\C-Mwhere" ">" "Up one stack frame.")
2302 (gud-def gud-run "run" nil "Run the program.") ;if VM start using jdb
2303 (gud-def gud-print "print %e" "\C-p" "Evaluate Java expression at point.")
2305 (setq comint-prompt-regexp "^> \\|^[^ ]+\\[[0-9]+\\] ")
2306 (setq paragraph-start comint-prompt-regexp)
2307 (run-hooks 'jdb-mode-hook)
2309 (if gud-jdb-use-classpath
2310 ;; Get the classpath information from the debugger
2312 (if (string-match "-attach" command-line)
2313 (gud-call "classpath"))
2314 (fset 'gud-jdb-find-source
2315 'gud-jdb-find-source-using-classpath))
2317 ;; Else create and bind the class/source association list as well
2318 ;; as the source file list.
2319 (setq gud-jdb-class-source-alist
2320 (gud-jdb-build-class-source-alist
2321 (setq gud-jdb-source-files
2322 (gud-jdb-build-source-files-list gud-jdb-directories
2324 (fset 'gud-jdb-find-source 'gud-jdb-find-source-file)))
2327 ;; End of debugger-specific information
2331 ;; When we send a command to the debugger via gud-call, it's annoying
2332 ;; to see the command and the new prompt inserted into the debugger's
2333 ;; buffer; we have other ways of knowing the command has completed.
2335 ;; If the buffer looks like this:
2336 ;; --------------------
2337 ;; (gdb) set args foo bar
2339 ;; --------------------
2340 ;; (the -!- marks the location of point), and we type `C-x SPC' in a
2341 ;; source file to set a breakpoint, we want the buffer to end up like
2343 ;; --------------------
2344 ;; (gdb) set args foo bar
2345 ;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
2347 ;; --------------------
2348 ;; Essentially, the old prompt is deleted, and the command's output
2349 ;; and the new prompt take its place.
2351 ;; Not echoing the command is easy enough; you send it directly using
2352 ;; process-send-string, and it never enters the buffer. However,
2353 ;; getting rid of the old prompt is trickier; you don't want to do it
2354 ;; when you send the command, since that will result in an annoying
2355 ;; flicker as the prompt is deleted, redisplay occurs while Emacs
2356 ;; waits for a response from the debugger, and the new prompt is
2357 ;; inserted. Instead, we'll wait until we actually get some output
2358 ;; from the subprocess before we delete the prompt. If the command
2359 ;; produced no output other than a new prompt, that prompt will most
2360 ;; likely be in the first chunk of output received, so we will delete
2361 ;; the prompt and then replace it with an identical one. If the
2362 ;; command produces output, the prompt is moving anyway, so the
2363 ;; flicker won't be annoying.
2365 ;; So - when we want to delete the prompt upon receipt of the next
2366 ;; chunk of debugger output, we position gud-delete-prompt-marker at
2367 ;; the start of the prompt; the process filter will notice this, and
2368 ;; delete all text between it and the process output marker. If
2369 ;; gud-delete-prompt-marker points nowhere, we leave the current
2371 (defvar gud-delete-prompt-marker nil)
2374 (put 'gud-mode 'mode-class 'special)
2376 (define-derived-mode gud-mode comint-mode "Debugger"
2377 "Major mode for interacting with an inferior debugger process.
2379 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
2380 M-x perldb, M-x xdb, or M-x jdb. Each entry point finishes by executing a
2381 hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook',
2382 `perldb-mode-hook', `xdb-mode-hook', or `jdb-mode-hook' respectively.
2384 After startup, the following commands are available in both the GUD
2385 interaction buffer and any source buffer GUD visits due to a breakpoint stop
2388 \\[gud-break] sets a breakpoint at the current file and line. In the
2389 GUD buffer, the current file and line are those of the last breakpoint or
2390 step. In a source buffer, they are the buffer's file and current line.
2392 \\[gud-remove] removes breakpoints on the current file and line.
2394 \\[gud-refresh] displays in the source window the last line referred to
2397 \\[gud-step], \\[gud-next], and \\[gud-stepi] do a step-one-line,
2398 step-one-line (not entering function calls), and step-one-instruction
2399 and then update the source window with the current file and position.
2400 \\[gud-cont] continues execution.
2402 \\[gud-print] tries to find the largest C lvalue or function-call expression
2403 around point, and sends it to the debugger for value display.
2405 The above commands are common to all supported debuggers except xdb which
2406 does not support stepping instructions.
2408 Under gdb, sdb and xdb, \\[gud-tbreak] behaves exactly like \\[gud-break],
2409 except that the breakpoint is temporary; that is, it is removed when
2410 execution stops on it.
2412 Under gdb, dbx, and xdb, \\[gud-up] pops up through an enclosing stack
2413 frame. \\[gud-down] drops back down through one.
2415 If you are using gdb or xdb, \\[gud-finish] runs execution to the return from
2416 the current function and stops.
2418 All the keystrokes above are accessible in the GUD buffer
2419 with the prefix C-c, and in all buffers through the prefix C-x C-a.
2421 All pre-defined functions for which the concept make sense repeat
2422 themselves the appropriate number of times if you give a prefix
2425 You may use the `gud-def' macro in the initialization hook to define other
2428 Other commands for interacting with the debugger process are inherited from
2429 comint mode, which see."
2430 (setq mode-line-process '(":%s"))
2431 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
2432 (set (make-local-variable 'gud-last-frame) nil)
2433 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
2434 (make-local-variable 'comint-prompt-regexp)
2435 ;; Don't put repeated commands in command history many times.
2436 (set (make-local-variable 'comint-input-ignoredups) t)
2437 (make-local-variable 'paragraph-start)
2438 (set (make-local-variable 'gud-delete-prompt-marker) (make-marker))
2439 (add-hook 'kill-buffer-hook 'gud-kill-buffer-hook nil t))
2441 ;; Cause our buffers to be displayed, by default,
2442 ;; in the selected window.
2443 ;;;###autoload (add-hook 'same-window-regexps "\\*gud-.*\\*\\(\\|<[0-9]+>\\)")
2445 (defcustom gud-chdir-before-run t
2446 "Non-nil if GUD should `cd' to the debugged executable."
2450 ;; Perform initializations common to all debuggers.
2451 ;; The first arg is the specified command line,
2452 ;; which starts with the program to debug.
2453 ;; The other three args specify the values to use
2454 ;; for local variables in the debugger buffer.
2455 (defun gud-common-init (command-line massage-args marker-filter
2456 &optional find-file)
2457 (let* ((words (split-string-and-unquote command-line))
2458 (program (car words))
2459 (dir default-directory)
2460 ;; Extract the file name from WORDS
2461 ;; and put t in its place.
2462 ;; Later on we will put the modified file name arg back there.
2463 (file-word (let ((w (cdr words)))
2464 (while (and w (= ?- (aref (car w) 0)))
2470 (and file-word (substitute-in-file-name file-word)))
2472 ;; If a directory was specified, expand the file name.
2473 ;; Otherwise, don't expand it, so GDB can use the PATH.
2474 ;; A file name without directory is literally valid
2475 ;; only if the file exists in ., and in that case,
2476 ;; omitting the expansion here has no visible effect.
2477 (file (and file-word
2478 (if (file-name-directory file-subst)
2479 (expand-file-name file-subst)
2481 (filepart (and file-word (concat "-" (file-name-nondirectory file))))
2482 (existing-buffer (get-buffer (concat "*gud" filepart "*"))))
2483 (pop-to-buffer (concat "*gud" filepart "*"))
2484 (when (and existing-buffer (get-buffer-process existing-buffer))
2485 (error "This program is already being debugged"))
2486 ;; Set the dir, in case the buffer already existed with a different dir.
2487 (setq default-directory dir)
2488 ;; Set default-directory to the file's directory.
2490 gud-chdir-before-run
2491 ;; Don't set default-directory if no directory was specified.
2492 ;; In that case, either the file is found in the current directory,
2493 ;; in which case this setq is a no-op,
2494 ;; or it is found by searching PATH,
2495 ;; in which case we don't know what directory it was found in.
2496 (file-name-directory file)
2497 (setq default-directory (file-name-directory file)))
2498 (or (bolp) (newline))
2499 (insert "Current directory is " default-directory "\n")
2500 ;; Put the substituted and expanded file name back in its place.
2502 (while (and w (not (eq (car w) t)))
2506 (if (file-remote-p default-directory)
2507 (setq file (file-name-nondirectory file))
2509 (apply 'make-comint (concat "gud" filepart) program nil
2510 (if massage-args (funcall massage-args file args) args))
2511 ;; Since comint clobbered the mode, we don't set it until now.
2513 (set (make-local-variable 'gud-target-name)
2514 (and file-word (file-name-nondirectory file))))
2515 (set (make-local-variable 'gud-marker-filter) marker-filter)
2516 (if find-file (set (make-local-variable 'gud-find-file) find-file))
2517 (setq gud-last-last-frame nil)
2519 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
2520 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
2523 (defun gud-set-buffer ()
2524 (when (eq major-mode 'gud-mode)
2525 (setq gud-comint-buffer (current-buffer))))
2527 (defvar gud-filter-defer-flag nil
2528 "Non-nil means don't process anything from the debugger right now.
2529 It is saved for when this flag is not set.")
2531 ;; These functions are responsible for inserting output from your debugger
2532 ;; into the buffer. The hard work is done by the method that is
2533 ;; the value of gud-marker-filter.
2535 (defun gud-filter (proc string)
2536 ;; Here's where the actual buffer insertion is done
2537 (let (output process-window)
2538 (if (buffer-name (process-buffer proc))
2539 (if gud-filter-defer-flag
2540 ;; If we can't process any text now,
2541 ;; save it for later.
2542 (setq gud-filter-pending-text
2543 (concat (or gud-filter-pending-text "") string))
2545 ;; If we have to ask a question during the processing,
2546 ;; defer any additional text that comes from the debugger
2547 ;; during that time.
2548 (let ((gud-filter-defer-flag t))
2549 ;; Process now any text we previously saved up.
2550 (if gud-filter-pending-text
2551 (setq string (concat gud-filter-pending-text string)
2552 gud-filter-pending-text nil))
2554 (with-current-buffer (process-buffer proc)
2555 ;; If we have been so requested, delete the debugger prompt.
2558 (if (marker-buffer gud-delete-prompt-marker)
2559 (let ((inhibit-read-only t))
2560 (delete-region (process-mark proc)
2561 gud-delete-prompt-marker)
2562 (comint-update-fence)
2563 (set-marker gud-delete-prompt-marker nil)))
2564 ;; Save the process output, checking for source file markers.
2565 (setq output (gud-marker-filter string))
2566 ;; Check for a filename-and-line number.
2567 ;; Don't display the specified file
2568 ;; unless (1) point is at or after the position where output appears
2569 ;; and (2) this buffer is on the screen.
2570 (setq process-window
2572 (>= (point) (process-mark proc))
2573 (get-buffer-window (current-buffer)))))
2575 ;; Let the comint filter do the actual insertion.
2576 ;; That lets us inherit various comint features.
2577 (comint-output-filter proc output))
2579 ;; Put the arrow on the source line.
2580 ;; This must be outside of the save-excursion
2581 ;; in case the source file is our current buffer.
2583 (with-selected-window process-window
2584 (gud-display-frame))
2585 ;; We have to be in the proper buffer, (process-buffer proc),
2586 ;; but not in a save-excursion, because that would restore point.
2587 (with-current-buffer (process-buffer proc)
2588 (gud-display-frame))))
2590 ;; If we deferred text that arrived during this processing,
2592 (if gud-filter-pending-text
2593 (gud-filter proc ""))))))
2595 (defvar gud-minor-mode-type nil)
2596 (defvar gud-overlay-arrow-position nil)
2597 (add-to-list 'overlay-arrow-variable-list 'gud-overlay-arrow-position)
2599 (declare-function gdb-reset "gdb-ui" ())
2601 (defun gud-sentinel (proc msg)
2602 (cond ((null (buffer-name (process-buffer proc)))
2604 ;; Stop displaying an arrow in a source file.
2605 (setq gud-overlay-arrow-position nil)
2606 (set-process-buffer proc nil)
2607 (if (and (boundp 'speedbar-frame)
2608 (string-equal speedbar-initial-expansion-list-name "GUD"))
2609 (speedbar-change-initial-expansion-list
2610 speedbar-previously-used-expansion-list-name))
2611 (if (memq gud-minor-mode-type '(gdbmi gdba))
2614 ((memq (process-status proc) '(signal exit))
2615 ;; Stop displaying an arrow in a source file.
2616 (setq gud-overlay-arrow-position nil)
2617 (if (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
2621 (let* ((obuf (current-buffer)))
2622 ;; save-excursion isn't the right thing if
2623 ;; process-buffer is current-buffer
2626 ;; Write something in the GUD buffer and hack its mode line,
2627 (set-buffer (process-buffer proc))
2628 ;; Fix the mode line.
2629 (setq mode-line-process
2631 (symbol-name (process-status proc))))
2632 (force-mode-line-update)
2634 (insert ?\n mode-name " " msg)
2636 (goto-char (point-max))
2637 (insert ?\n mode-name " " msg)))
2638 ;; If buffer and mode line will show that the process
2639 ;; is dead, we can delete it now. Otherwise it
2640 ;; will stay around until M-x list-processes.
2641 (delete-process proc))
2642 ;; Restore old buffer, but don't restore old point
2643 ;; if obuf is the gud buffer.
2644 (set-buffer obuf))))))
2646 (defun gud-kill-buffer-hook ()
2647 (setq gud-minor-mode-type gud-minor-mode)
2649 (kill-process (get-buffer-process (current-buffer)))
2653 (dolist (buffer (buffer-list))
2654 (unless (eq buffer gud-comint-buffer)
2655 (with-current-buffer buffer
2656 (when gud-minor-mode
2657 (setq gud-minor-mode nil)
2658 (kill-local-variable 'tool-bar-map))))))
2660 (defun gud-display-frame ()
2661 "Find and obey the last filename-and-line marker from the debugger.
2662 Obeying it means displaying in another window the specified file and line."
2664 (when gud-last-frame
2666 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
2667 (setq gud-last-last-frame gud-last-frame
2668 gud-last-frame nil)))
2670 (declare-function global-hl-line-highlight "hl-line" ())
2671 (declare-function hl-line-highlight "hl-line" ())
2672 (declare-function gdb-display-source-buffer "gdb-ui" (buffer))
2673 (declare-function gdb-display-buffer "gdb-ui" (buf dedicated &optional size))
2675 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
2676 ;; and that its line LINE is visible.
2677 ;; Put the overlay-arrow on the line LINE in that buffer.
2678 ;; Most of the trickiness in here comes from wanting to preserve the current
2679 ;; region-restriction if that's possible. We use an explicit display-buffer
2680 ;; to get around the fact that this is called inside a save-excursion.
2682 (defun gud-display-line (true-file line)
2683 (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
2685 (with-current-buffer gud-comint-buffer
2686 (gud-find-file true-file)))
2688 (or (get-buffer-window buffer)
2689 (if (memq gud-minor-mode '(gdbmi gdba))
2690 (or (if (get-buffer-window buffer 'visible)
2691 (display-buffer buffer nil 'visible))
2692 (unless (gdb-display-source-buffer buffer)
2693 (gdb-display-buffer buffer nil 'visible))))
2694 (display-buffer buffer))))
2698 (with-current-buffer buffer
2699 (unless (or (verify-visited-file-modtime buffer) gud-keep-buffer)
2701 (format "File %s changed on disk. Reread from disk? "
2704 (setq gud-keep-buffer t)))
2709 (or gud-overlay-arrow-position
2710 (setq gud-overlay-arrow-position (make-marker)))
2711 (set-marker gud-overlay-arrow-position (point) (current-buffer))
2712 ;; If they turned on hl-line, move the hl-line highlight to
2713 ;; the arrow's line.
2714 (when (featurep 'hl-line)
2716 (global-hl-line-mode
2717 (global-hl-line-highlight))
2718 ((and hl-line-mode hl-line-sticky-flag)
2719 (hl-line-highlight)))))
2720 (cond ((or (< pos (point-min)) (> pos (point-max)))
2724 (set-window-point window gud-overlay-arrow-position)
2725 (if (memq gud-minor-mode '(gdbmi gdba))
2726 (setq gdb-source-window window)))))))
2728 ;; The gud-call function must do the right thing whether its invoking
2729 ;; keystroke is from the GUD buffer itself (via major-mode binding)
2730 ;; or a C buffer. In the former case, we want to supply data from
2731 ;; gud-last-frame. Here's how we do it:
2733 (defun gud-format-command (str arg)
2734 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
2735 (frame (or gud-last-frame gud-last-last-frame))
2738 (let ((case-fold-search nil))
2739 (string-match "\\([^%]*\\)%\\([adefFlpc]\\)" str)))
2740 (let ((key (string-to-char (match-string 2 str)))
2744 (setq subst (file-name-nondirectory (if insource
2748 (setq subst (file-name-sans-extension
2749 (file-name-nondirectory (if insource
2753 (setq subst (file-name-directory (if insource
2757 (setq subst (int-to-string
2761 (+ (count-lines (point-min) (point))
2765 (setq subst (gud-find-expr)))
2767 (setq subst (gud-read-address)))
2777 (+ (count-lines (point-min) (point))
2781 (setq subst (if arg (int-to-string arg)))))
2782 (setq result (concat result (match-string 1 str) subst)))
2783 (setq str (substring str (match-end 2))))
2784 ;; There might be text left in STR when the loop ends.
2785 (concat result str)))
2787 (defun gud-read-address ()
2788 "Return a string containing the core-address found in the buffer at point."
2791 (let ((pt (point)) found begin)
2792 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
2794 (found (forward-char 2)
2795 (buffer-substring found
2796 (progn (re-search-forward "[^0-9a-f]")
2799 (t (setq begin (progn (re-search-backward "[^0-9]")
2803 (re-search-forward "[^0-9]")
2805 (buffer-substring begin (point))))))))
2807 (defun gud-call (fmt &optional arg)
2808 (let ((msg (gud-format-command fmt arg)))
2809 (message "Command: %s" msg)
2811 (gud-basic-call msg)))
2813 (defun gud-basic-call (command)
2814 "Invoke the debugger COMMAND displaying source in other window."
2817 (let ((proc (get-buffer-process gud-comint-buffer)))
2818 (or proc (error "Current buffer has no process"))
2819 ;; Arrange for the current prompt to get deleted.
2821 (set-buffer gud-comint-buffer)
2824 (if (marker-position gud-delete-prompt-marker)
2825 ;; We get here when printing an expression.
2826 (goto-char gud-delete-prompt-marker)
2827 (goto-char (process-mark proc))
2829 (if (looking-at comint-prompt-regexp)
2830 (set-marker gud-delete-prompt-marker (point)))
2831 (if (memq gud-minor-mode '(gdbmi gdba))
2832 (apply comint-input-sender (list proc command))
2833 (process-send-string proc (concat command "\n")))))))
2835 (defun gud-refresh (&optional arg)
2836 "Fix up a possibly garbled display, and redraw the arrow."
2838 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
2842 ;; Code for parsing expressions out of C or Fortran code. The single entry
2843 ;; point is gud-find-expr, which tries to return an lvalue expression from
2846 (defvar gud-find-expr-function 'gud-find-c-expr)
2848 (defun gud-find-expr (&rest args)
2849 (let ((expr (if (and transient-mark-mode mark-active)
2850 (buffer-substring (region-beginning) (region-end))
2851 (apply gud-find-expr-function args))))
2853 (if (string-match "\n" expr)
2854 (error "Expression must not include a newline"))
2855 (with-current-buffer gud-comint-buffer
2857 (goto-char (process-mark (get-buffer-process gud-comint-buffer)))
2859 (when (looking-at comint-prompt-regexp)
2860 (set-marker gud-delete-prompt-marker (point))
2861 (set-marker-insertion-type gud-delete-prompt-marker t))
2862 (unless (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
2864 (insert (concat expr " = "))))))
2867 ;; The next eight functions are hacked from gdbsrc.el by
2868 ;; Debby Ayers <ayers@asc.slb.com>,
2869 ;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
2871 (defun gud-find-c-expr ()
2872 "Returns the expr that surrounds point."
2876 (expr (gud-innermost-expr))
2877 (test-expr (gud-prev-expr)))
2878 (while (and test-expr (gud-expr-compound test-expr expr))
2879 (let ((prev-expr expr))
2880 (setq expr (cons (car test-expr) (cdr expr)))
2881 (goto-char (car expr))
2882 (setq test-expr (gud-prev-expr))
2883 ;; If we just pasted on the condition of an if or while,
2884 ;; throw it away again.
2885 (if (member (buffer-substring (car test-expr) (cdr test-expr))
2886 '("if" "while" "for"))
2890 (setq test-expr (gud-next-expr))
2891 (while (gud-expr-compound expr test-expr)
2892 (setq expr (cons (car expr) (cdr test-expr)))
2893 (setq test-expr (gud-next-expr)))
2894 (buffer-substring (car expr) (cdr expr)))))
2896 (defun gud-innermost-expr ()
2897 "Returns the smallest expr that point is in; move point to beginning of it.
2898 The expr is represented as a cons cell, where the car specifies the point in
2899 the current buffer that marks the beginning of the expr and the cdr specifies
2900 the character after the end of the expr."
2901 (let ((p (point)) begin end)
2903 (setq begin (point))
2916 (defun gud-backward-sexp ()
2917 "Version of `backward-sexp' that catches errors."
2922 (defun gud-forward-sexp ()
2923 "Version of `forward-sexp' that catches errors."
2928 (defun gud-prev-expr ()
2929 "Returns the previous expr, point is set to beginning of that expr.
2930 The expr is represented as a cons cell, where the car specifies the point in
2931 the current buffer that marks the beginning of the expr and the cdr specifies
2932 the character after the end of the expr"
2933 (let ((begin) (end))
2935 (setq begin (point))
2941 (defun gud-next-expr ()
2942 "Returns the following expr, point is set to beginning of that expr.
2943 The expr is represented as a cons cell, where the car specifies the point in
2944 the current buffer that marks the beginning of the expr and the cdr specifies
2945 the character after the end of the expr."
2946 (let ((begin) (end))
2951 (setq begin (point))
2954 (defun gud-expr-compound-sep (span-start span-end)
2955 "Scan from SPAN-START to SPAN-END for punctuation characters.
2956 If `->' is found, return `?.'. If `.' is found, return `?.'.
2957 If any other punctuation is found, return `??'.
2958 If no punctuation is found, return `? '."
2961 (while (< span-start span-end)
2962 (setq syntax (char-syntax (char-after span-start)))
2965 ((= syntax ?.) (setq syntax (char-after span-start))
2967 ((= syntax ?.) (setq result ?.))
2968 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
2970 (setq span-start (+ span-start 1)))
2971 (t (setq span-start span-end)
2972 (setq result ??)))))
2973 (setq span-start (+ span-start 1)))
2976 (defun gud-expr-compound (first second)
2977 "Non-nil if concatenating FIRST and SECOND makes a single C expression.
2978 The two exprs are represented as a cons cells, where the car
2979 specifies the point in the current buffer that marks the beginning of the
2980 expr and the cdr specifies the character after the end of the expr.
2981 Link exprs of the form:
2988 (let ((span-start (cdr first))
2989 (span-end (car second))
2991 (setq syntax (gud-expr-compound-sep span-start span-end))
2993 ((= (car first) (car second)) nil)
2994 ((= (cdr first) (cdr second)) nil)
2997 (setq span-start (char-after (- span-start 1)))
2998 (setq span-end (char-after span-end))
3000 ((= span-start ?)) t)
3001 ((= span-start ?]) t)
3008 (declare-function c-langelem-sym "cc-defs" (langelem))
3009 (declare-function c-langelem-pos "cc-defs" (langelem))
3010 (declare-function syntax-symbol "gud" (x))
3011 (declare-function syntax-point "gud" (x))
3013 (defun gud-find-class (f line)
3014 "Find fully qualified class in file F at line LINE.
3015 This function uses the `gud-jdb-classpath' (and optional
3016 `gud-jdb-sourcepath') list(s) to derive a file
3017 pathname relative to its classpath directory. The values in
3018 `gud-jdb-classpath' are assumed to have been converted to absolute
3019 pathname standards using file-truename.
3020 If F is visited by a buffer and its mode is CC-mode(Java),
3021 syntactic information of LINE is used to find the enclosing (nested)
3022 class string which is appended to the top level
3023 class of the file (using s to separate nested class ids)."
3024 ;; Convert f to a standard representation and remove suffix
3025 (if (and gud-jdb-use-classpath (or gud-jdb-classpath gud-jdb-sourcepath))
3027 (let ((cplist (append gud-jdb-sourcepath gud-jdb-classpath))
3028 (fbuffer (get-file-buffer f))
3029 syntax-symbol syntax-point class-found)
3030 (setq f (file-name-sans-extension (file-truename f)))
3031 ;; Syntax-symbol returns the symbol of the *first* element
3032 ;; in the syntactical analysis result list, syntax-point
3033 ;; returns the buffer position of same
3034 (fset 'syntax-symbol (lambda (x) (c-langelem-sym (car x))))
3035 (fset 'syntax-point (lambda (x) (c-langelem-pos (car x))))
3036 ;; Search through classpath list for an entry that is
3038 (while (and cplist (not class-found))
3039 (if (string-match (car cplist) f)
3041 (mapconcat 'identity
3043 (substring f (+ (match-end 0) 1))
3045 (setq cplist (cdr cplist)))
3046 ;; if f is visited by a java(cc-mode) buffer, walk up the
3047 ;; syntactic information chain and collect any 'inclass
3048 ;; symbols until 'topmost-intro is reached to find out if
3049 ;; point is within a nested class
3050 (if (and fbuffer (equal (symbol-file 'java-mode) "cc-mode"))
3052 (set-buffer fbuffer)
3053 (let ((nclass) (syntax))
3054 ;; While the c-syntactic information does not start
3055 ;; with the 'topmost-intro symbol, there may be
3056 ;; nested classes...
3057 (while (not (eq 'topmost-intro
3058 (syntax-symbol (c-guess-basic-syntax))))
3059 ;; Check if the current position c-syntactic
3060 ;; analysis has 'inclass
3061 (setq syntax (c-guess-basic-syntax))
3063 (and (not (eq 'inclass (syntax-symbol syntax)))
3065 (setq syntax (cdr syntax)))
3066 (if (eq 'inclass (syntax-symbol syntax))
3068 (goto-char (syntax-point syntax))
3069 ;; Now we're at the beginning of a class
3070 ;; definition. Find class name
3072 "[A-Za-z0-9 \t\n]*?class[ \t\n]+\\([^ \t\n]+\\)")
3074 (append (list (match-string-no-properties 1))
3076 (setq syntax (c-guess-basic-syntax))
3077 (while (and (not (syntax-point syntax)) (cdr syntax))
3078 (setq syntax (cdr syntax)))
3079 (goto-char (syntax-point syntax))
3081 (string-match (concat (car nclass) "$") class-found)
3083 (replace-match (mapconcat 'identity nclass "$")
3084 t t class-found)))))
3085 (if (not class-found)
3086 (message "gud-find-class: class for file %s not found!" f))
3088 ;; Not using classpath - try class/source association list
3089 (let ((class-found (rassoc f gud-jdb-class-source-alist)))
3092 (message "gud-find-class: class for file %s not found in gud-jdb-class-source-alist!" f)
3096 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3097 ;;; GDB script mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3098 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3100 (defvar gdb-script-mode-syntax-table
3101 (let ((st (make-syntax-table)))
3102 (modify-syntax-entry ?' "\"" st)
3103 (modify-syntax-entry ?# "<" st)
3104 (modify-syntax-entry ?\n ">" st)
3107 (defvar gdb-script-font-lock-keywords
3108 '(("^define\\s-+\\(\\(\\w\\|\\s_\\)+\\)" (1 font-lock-function-name-face))
3109 ("\\$\\(\\w+\\)" (1 font-lock-variable-name-face))
3110 ("^\\s-*\\(\\w\\(\\w\\|\\s_\\)*\\)" (1 font-lock-keyword-face))))
3112 (defvar gdb-script-font-lock-syntactic-keywords
3113 '(("^document\\s-.*\\(\n\\)" (1 "< b"))
3115 (0 (unless (eq (match-beginning 0) (point-min))
3116 ;; We change the \n in front, which is more difficult, but results
3117 ;; in better highlighting. If the doc is empty, the single \n is
3118 ;; both the beginning and the end of the docstring, which can't be
3119 ;; expressed in syntax-tables. Instead, we place the "> b" after
3120 ;; placing the "< b", so the start marker is overwritten by the
3121 ;; termination marker and in the end Emacs simply considers that
3122 ;; there's no docstring at all, which is fine.
3123 (put-text-property (1- (match-beginning 0)) (match-beginning 0)
3124 'syntax-table (eval-when-compile
3125 (string-to-syntax "> b")))
3126 ;; Make sure that rehighlighting the previous line won't erase our
3127 ;; syntax-table property.
3128 (put-text-property (1- (match-beginning 0)) (match-end 0)
3129 'font-lock-multiline t)
3132 (defun gdb-script-font-lock-syntactic-face (state)
3134 ((nth 3 state) font-lock-string-face)
3135 ((nth 7 state) font-lock-doc-face)
3136 (t font-lock-comment-face)))
3138 (defvar gdb-script-basic-indent 2)
3140 (defun gdb-script-skip-to-head ()
3141 "We're just in front of an `end' and we need to go to its head."
3142 (while (and (re-search-backward "^\\s-*\\(\\(end\\)\\|define\\|document\\|if\\|while\\|commands\\)\\>" nil 'move)
3144 (gdb-script-skip-to-head)))
3146 (defun gdb-script-calculate-indentation ()
3148 ((looking-at "end\\>")
3149 (gdb-script-skip-to-head)
3150 (current-indentation))
3151 ((looking-at "else\\>")
3152 (while (and (re-search-backward "^\\s-*\\(if\\|\\(end\\)\\)\\>" nil 'move)
3154 (gdb-script-skip-to-head))
3155 (current-indentation))
3157 (forward-comment (- (point-max)))
3159 (skip-chars-forward " \t")
3160 (+ (current-indentation)
3161 (if (looking-at "\\(if\\|while\\|define\\|else\\|commands\\)\\>")
3162 gdb-script-basic-indent 0)))))
3164 (defun gdb-script-indent-line ()
3165 "Indent current line of GDB script."
3167 (if (and (eq (get-text-property (point) 'face) font-lock-doc-face)
3170 (skip-chars-forward " \t")
3171 (not (looking-at "end\\>"))))
3173 (let* ((savep (point))
3174 (indent (condition-case nil
3177 (skip-chars-forward " \t")
3178 (if (>= (point) savep) (setq savep nil))
3179 (max (gdb-script-calculate-indentation) 0))
3182 (save-excursion (indent-line-to indent))
3183 (indent-line-to indent)))))
3185 ;; Derived from cfengine.el.
3186 (defun gdb-script-beginning-of-defun ()
3187 "`beginning-of-defun' function for Gdb script mode.
3188 Treats actions as defuns."
3189 (unless (<= (current-column) (current-indentation))
3191 (if (re-search-backward "^define \\|^document " nil t)
3193 (goto-char (point-min)))
3196 ;; Derived from cfengine.el.
3197 (defun gdb-script-end-of-defun ()
3198 "`end-of-defun' function for Gdb script mode.
3199 Treats actions as defuns."
3201 (if (re-search-forward "^end" nil t)
3203 (goto-char (point-max)))
3206 ;; Besides .gdbinit, gdb documents other names to be usable for init
3207 ;; files, cross-debuggers can use something like
3208 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
3209 ;; don't interfere with each other.
3211 (add-to-list 'auto-mode-alist '("/\\.[a-z0-9-]*gdbinit" . gdb-script-mode))
3214 (define-derived-mode gdb-script-mode nil "GDB-Script"
3215 "Major mode for editing GDB scripts."
3216 (set (make-local-variable 'comment-start) "#")
3217 (set (make-local-variable 'comment-start-skip) "#+\\s-*")
3218 (set (make-local-variable 'outline-regexp) "[ \t]")
3219 (set (make-local-variable 'imenu-generic-expression)
3220 '((nil "^define[ \t]+\\(\\w+\\)" 1)))
3221 (set (make-local-variable 'indent-line-function) 'gdb-script-indent-line)
3222 (set (make-local-variable 'beginning-of-defun-function)
3223 #'gdb-script-beginning-of-defun)
3224 (set (make-local-variable 'end-of-defun-function)
3225 #'gdb-script-end-of-defun)
3226 (set (make-local-variable 'font-lock-defaults)
3227 '(gdb-script-font-lock-keywords nil nil ((?_ . "w")) nil
3228 (font-lock-syntactic-keywords
3229 . gdb-script-font-lock-syntactic-keywords)
3230 (font-lock-syntactic-face-function
3231 . gdb-script-font-lock-syntactic-face))))
3234 ;;; tooltips for GUD
3236 ;;; Customizable settings
3238 (define-minor-mode gud-tooltip-mode
3239 "Toggle the display of GUD tooltips."
3244 (if gud-tooltip-mode
3246 (add-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3247 (add-hook 'pre-command-hook 'tooltip-hide)
3248 (add-hook 'tooltip-hook 'gud-tooltip-tips)
3249 (define-key global-map [mouse-movement] 'gud-tooltip-mouse-motion))
3250 (unless tooltip-mode (remove-hook 'pre-command-hook 'tooltip-hide)
3251 (remove-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3252 (remove-hook 'tooltip-hook 'gud-tooltip-tips)
3253 (define-key global-map [mouse-movement] 'ignore)))
3254 (gud-tooltip-activate-mouse-motions-if-enabled)
3255 (if (and gud-comint-buffer
3256 (buffer-name gud-comint-buffer); gud-comint-buffer might be killed
3257 (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
3259 (if gud-tooltip-mode
3261 (dolist (buffer (buffer-list))
3262 (unless (eq buffer gud-comint-buffer)
3263 (with-current-buffer buffer
3264 (when (and (memq gud-minor-mode '(gdbmi gdba))
3265 (not (string-match "\\`\\*.+\\*\\'"
3267 (make-local-variable 'gdb-define-alist)
3268 (gdb-create-define-alist)
3269 (add-hook 'after-save-hook
3270 'gdb-create-define-alist nil t))))))
3271 (kill-local-variable 'gdb-define-alist)
3272 (remove-hook 'after-save-hook 'gdb-create-define-alist t))))
3274 (define-obsolete-variable-alias 'tooltip-gud-modes
3275 'gud-tooltip-modes "22.1")
3277 (defcustom gud-tooltip-modes '(gud-mode c-mode c++-mode fortran-mode
3279 "List of modes for which to enable GUD tooltips."
3284 (define-obsolete-variable-alias 'tooltip-gud-display
3285 'gud-tooltip-display "22.1")
3287 (defcustom gud-tooltip-display
3288 '((eq (tooltip-event-buffer gud-tooltip-event)
3289 (marker-buffer gud-overlay-arrow-position)))
3290 "List of forms determining where GUD tooltips are displayed.
3292 Forms in the list are combined with AND. The default is to display
3293 only tooltips in the buffer containing the overlay arrow."
3298 (defcustom gud-tooltip-echo-area nil
3299 "Use the echo area instead of frames for GUD tooltips."
3304 ;;; Reacting on mouse movements
3306 (defun gud-tooltip-change-major-mode ()
3307 "Function added to `change-major-mode-hook' when tooltip mode is on."
3308 (add-hook 'post-command-hook 'gud-tooltip-activate-mouse-motions-if-enabled))
3310 (defun gud-tooltip-activate-mouse-motions-if-enabled ()
3311 "Reconsider for all buffers whether mouse motion events are desired."
3312 (remove-hook 'post-command-hook
3313 'gud-tooltip-activate-mouse-motions-if-enabled)
3314 (dolist (buffer (buffer-list))
3317 (if (and gud-tooltip-mode
3318 (memq major-mode gud-tooltip-modes))
3319 (gud-tooltip-activate-mouse-motions t)
3320 (gud-tooltip-activate-mouse-motions nil)))))
3322 (defvar gud-tooltip-mouse-motions-active nil
3323 "Locally t in a buffer if tooltip processing of mouse motion is enabled.")
3325 ;; We don't set track-mouse globally because this is a big redisplay
3326 ;; problem in buffers having a pre-command-hook or such installed,
3327 ;; which does a set-buffer, like the summary buffer of Gnus. Calling
3328 ;; set-buffer prevents redisplay optimizations, so every mouse motion
3329 ;; would be accompanied by a full redisplay.
3331 (defun gud-tooltip-activate-mouse-motions (activatep)
3332 "Activate/deactivate mouse motion events for the current buffer.
3333 ACTIVATEP non-nil means activate mouse motion events."
3336 (make-local-variable 'gud-tooltip-mouse-motions-active)
3337 (setq gud-tooltip-mouse-motions-active t)
3338 (make-local-variable 'track-mouse)
3339 (setq track-mouse t))
3340 (when gud-tooltip-mouse-motions-active
3341 (kill-local-variable 'gud-tooltip-mouse-motions-active)
3342 (kill-local-variable 'track-mouse))))
3344 (defun gud-tooltip-mouse-motion (event)
3345 "Command handler for mouse movement events in `global-map'."
3348 (when (car (mouse-pixel-position))
3349 (setq tooltip-last-mouse-motion-event (copy-sequence event))
3350 (tooltip-start-delayed-tip)))
3354 (defvar gud-tooltip-original-filter nil
3355 "Process filter to restore after GUD output has been received.")
3357 (defvar gud-tooltip-dereference nil
3358 "Non-nil means print expressions with a `*' in front of them.
3359 For C this would dereference a pointer expression.")
3361 (defvar gud-tooltip-event nil
3362 "The mouse movement event that led to a tooltip display.
3363 This event can be examined by forms in `gud-tooltip-display'.")
3365 (defun gud-tooltip-dereference (&optional arg)
3366 "Toggle whether tooltips should show `* expr' or `expr'.
3367 With arg, dereference expr if ARG is positive, otherwise do not derereference."
3369 (setq gud-tooltip-dereference
3371 (not gud-tooltip-dereference)
3372 (> (prefix-numeric-value arg) 0)))
3373 (message "Dereferencing is now %s."
3374 (if gud-tooltip-dereference "on" "off")))
3376 (define-obsolete-function-alias 'tooltip-gud-toggle-dereference
3377 'gud-tooltip-dereference "22.1")
3379 ; This will only display data that comes in one chunk.
3380 ; Larger arrays (say 400 elements) are displayed in
3381 ; the tooltip incompletely and spill over into the gud buffer.
3382 ; Switching the process-filter creates timing problems and
3383 ; it may be difficult to do better. Using annotations as in
3384 ; gdb-ui.el gets round this problem.
3385 (defun gud-tooltip-process-output (process output)
3386 "Process debugger output and show it in a tooltip window."
3387 (set-process-filter process gud-tooltip-original-filter)
3388 (tooltip-show (tooltip-strip-prompt process output)
3389 (or gud-tooltip-echo-area tooltip-use-echo-area)))
3391 (defun gud-tooltip-print-command (expr)
3392 "Return a suitable command to print the expression EXPR."
3393 (case gud-minor-mode
3394 (gdba (concat "server print " expr))
3395 ((dbx gdbmi) (concat "print " expr))
3396 ((xdb pdb) (concat "p " expr))
3397 (sdb (concat expr "/"))))
3399 (declare-function gdb-enqueue-input "gdb-ui" (item))
3401 (defun gud-tooltip-tips (event)
3402 "Show tip for identifier or selection under the mouse.
3403 The mouse must either point at an identifier or inside a selected
3404 region for the tip window to be shown. If `gud-tooltip-dereference' is t,
3405 add a `*' in front of the printed expression. In the case of a C program
3406 controlled by GDB, show the associated #define directives when program is
3409 This function must return nil if it doesn't handle EVENT."
3411 (when (and (eventp event)
3414 (buffer-name gud-comint-buffer); might be killed
3415 (setq process (get-buffer-process gud-comint-buffer))
3416 (posn-point (event-end event))
3417 (or (and (eq gud-minor-mode 'gdba) (not gdb-active-process))
3418 (progn (setq gud-tooltip-event event)
3419 (eval (cons 'and gud-tooltip-display)))))
3420 (let ((expr (tooltip-expr-to-print event)))
3422 (if (and (eq gud-minor-mode 'gdba)
3423 (not gdb-active-process))
3425 (with-current-buffer (tooltip-event-buffer event)
3426 (let ((define-elt (assoc expr gdb-define-alist)))
3427 (unless (null define-elt)
3430 (or gud-tooltip-echo-area tooltip-use-echo-area))
3432 (when gud-tooltip-dereference
3433 (setq expr (concat "*" expr)))
3434 (let ((cmd (gud-tooltip-print-command expr)))
3435 (when (and gud-tooltip-mode (eq gud-minor-mode 'gdb))
3436 (gud-tooltip-mode -1)
3437 (message-box "Using GUD tooltips in this mode is unsafe\n\
3438 so they have been disabled."))
3439 (unless (null cmd) ; CMD can be nil if unknown debugger
3440 (if (memq gud-minor-mode '(gdba gdbmi))
3444 gdb-server-prefix "macro expand " expr "\n")
3445 `(lambda () (gdb-tooltip-print-1 ,expr))))
3447 (list (concat cmd "\n")
3448 `(lambda () (gdb-tooltip-print ,expr)))))
3449 (setq gud-tooltip-original-filter (process-filter process))
3450 (set-process-filter process 'gud-tooltip-process-output)
3451 (gud-basic-call cmd))
3456 ;; arch-tag: 6d990948-df65-461a-be39-1c7fb83ac4c4
3457 ;;; gud.el ends here