| blob | 4b2b621ee12a4ea6ff585cb4af0e2cf4792e6cc6 |
1 ;;; gud.el --- Grand Unified Debugger mode for running GDB and other debuggers
3 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
4 ;; Maintainer: FSF
5 ;; Keywords: unix, tools
7 ;; Copyright (C) 1992, 93, 94, 95, 96, 1998, 2000 Free Software Foundation, Inc.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Commentary:
28 ;; The ancestral gdb.el was by W. Schelter <wfs@rascal.ics.utexas.edu>
29 ;; It was later rewritten by rms. Some ideas were due to Masanobu.
30 ;; Grand Unification (sdb/dbx support) by Eric S. Raymond <esr@thyrsus.com>
31 ;; The overloading code was then rewritten by Barry Warsaw <bwarsaw@cen.com>,
32 ;; who also hacked the mode to use comint.el. Shane Hartman <shane@spr.com>
33 ;; added support for xdb (HPUX debugger). Rick Sladkey <jrs@world.std.com>
34 ;; wrote the GDB command completion code. Dave Love <d.love@dl.ac.uk>
35 ;; added the IRIX kluge, re-implemented the Mips-ish variant and added
36 ;; a menu. Brian D. Carlstrom <bdc@ai.mit.edu> combined the IRIX kluge with
37 ;; the gud-xdb-directories hack producing gud-dbx-directories. Derek L. Davies
38 ;; <ddavies@world.std.com> added support for jdb (Java debugger.)
40 ;;; Code:
45 ;; ======================================================================
46 ;; GUD commands must be visible in C buffers visited by GUD
49 "Grand Unified Debugger mode for gdb and other debuggers under Emacs.
50 Supported debuggers include gdb, sdb, dbx, xdb, perldb, pdb (Python), and jdb."
56 "Prefix of all GUD commands valid in C buffers."
75 "Return the symbol used for SYM in MINOR-MODE.
76 MINOR-MODE defaults to `gud-minor-mode.
77 The symbol returned is `gud-<MINOR-MODE>-<SYM>'.
78 If SOFT is non-nil, returns nil if the symbol doesn't already exist."
84 "Return the value of `gud-symbol' SYM. Default to nil."
89 ;; Don't get confused by double slashes in the name that comes from GDB.
95 ;; Copy `gud-minor-mode' to the found buffer to turn on the menu.
98 buf)))
102 ([remove] "Remove Breakpoint" . gud-remove)
103 ([tbreak] menu-item "Temporary Breakpoint" gud-tbreak
104 :enable (memq gud-minor-mode '(gdb sdb xdb)))
105 ([break] "Set Breakpoint" . gud-break)
106 ([up] menu-item "Up Stack" gud-up
107 :enable (memq gud-minor-mode '(gdb dbx xdb)))
108 ([down] menu-item "Down Stack" gud-down
109 :enable (memq gud-minor-mode '(gdb dbx xdb)))
110 ([print] "Print Expression" . gud-print)
111 ([finish] menu-item "Finish Function" gud-finish
112 :enable (memq gud-minor-mode '(gdb xdb)))
113 ([stepi] "Step Instruction" . gud-stepi)
114 ([step] "Step Line" . gud-step)
115 ([next] "Next Line" . gud-next)
116 ([cont] "Continue" . gud-cont))
117 "Menu for `gud-mode'."
118 :name "Gud")
120 (easy-mmode-defmap gud-minor-mode-map
121 `(([menu-bar debug] . ("Gud" . ,gud-menu-map)))
122 "Map used in visited files.")
124 (let ((m (assq 'gud-minor-mode minor-mode-map-alist)))
125 (if m (setcdr m gud-minor-mode-map)
126 (push (cons 'gud-minor-mode gud-minor-mode-map) minor-mode-map-alist)))
128 (defvar gud-mode-map
129 ;; Will inherit from comint-mode via define-derived-mode.
130 (make-sparse-keymap)
131 "`gud-mode' keymap.")
132 \f
133 ;; ======================================================================
134 ;; command definition
136 ;; This macro is used below to define some basic debugger interface commands.
137 ;; Of course you may use `gud-def' with any other debugger command, including
138 ;; user defined ones.
140 ;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
141 ;; which defines FUNC to send the command NAME to the debugger, gives
142 ;; it the docstring DOC, and binds that function to KEY in the GUD
143 ;; major mode. The function is also bound in the global keymap with the
144 ;; GUD prefix.
146 (defmacro gud-def (func cmd key &optional doc)
147 "Define FUNC to be a command sending STR and bound to KEY, with
148 optional doc string DOC. Certain %-escapes in the string arguments
149 are interpreted specially if present. These are:
151 %f name (without directory) of current source file.
152 %F name (without directory or extension) of current source file.
153 %d directory of current source file.
154 %l number of current source line
155 %e text of the C lvalue or function-call expression surrounding point.
156 %a text of the hexadecimal address surrounding point
157 %p prefix argument to the command (if any) as a number
159 The `current' source file is the file of the current buffer (if
160 we're in a C file) or the source file current at the last break or
161 step (if we're in the GUD buffer).
162 The `current' line is that of the current buffer (if we're in a
163 source file) or the source line number at the last break or step (if
164 we're in the GUD buffer)."
165 (list 'progn
166 (list 'defun func '(arg)
167 (or doc "")
168 '(interactive "p")
169 (list 'gud-call cmd 'arg))
170 (if key
171 (list 'define-key
172 '(current-local-map)
173 (concat "\C-c" key)
174 (list 'quote func)))
175 (if key
176 (list 'global-set-key
177 (list 'concat 'gud-key-prefix key)
178 (list 'quote func)))))
180 ;; Where gud-display-frame should put the debugging arrow; a cons of
181 ;; (filename . line-number). This is set by the marker-filter, which scans
182 ;; the debugger's output for indications of the current program counter.
183 (defvar gud-last-frame nil)
185 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
186 ;; the last frame, even if it's been called before and gud-last-frame has
187 ;; been set to nil.
188 (defvar gud-last-last-frame nil)
190 ;; All debugger-specific information is collected here.
191 ;; Here's how it works, in case you ever need to add a debugger to the mode.
192 ;;
193 ;; Each entry must define the following at startup:
194 ;;
195 ;;<name>
196 ;; comint-prompt-regexp
197 ;; gud-<name>-massage-args
198 ;; gud-<name>-marker-filter
199 ;; gud-<name>-find-file
200 ;;
201 ;; The job of the massage-args method is to modify the given list of
202 ;; debugger arguments before running the debugger.
203 ;;
204 ;; The job of the marker-filter method is to detect file/line markers in
205 ;; strings and set the global gud-last-frame to indicate what display
206 ;; action (if any) should be triggered by the marker. Note that only
207 ;; whatever the method *returns* is displayed in the buffer; thus, you
208 ;; can filter the debugger's output, interpreting some and passing on
209 ;; the rest.
210 ;;
211 ;; The job of the find-file method is to visit and return the buffer indicated
212 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
213 ;; something else.
214 \f
215 ;; ======================================================================
216 ;; speedbar support functions and variables.
217 (eval-when-compile (require 'speedbar))
219 (defvar gud-last-speedbar-buffer nil
220 "The last GUD buffer used.")
222 (defvar gud-last-speedbar-stackframe nil
223 "Description of the currently displayed GUD stack.
224 t means that there is no stack, and we are in display-file mode.")
226 (defvar gud-speedbar-key-map nil
227 "Keymap used when in the buffers display mode.")
229 (defun gud-install-speedbar-variables ()
230 "Install those variables used by speedbar to enhance gud/gdb."
231 (if gud-speedbar-key-map
232 nil
233 (setq gud-speedbar-key-map (speedbar-make-specialized-keymap))
235 (define-key gud-speedbar-key-map "j" 'speedbar-edit-line)
236 (define-key gud-speedbar-key-map "e" 'speedbar-edit-line)
237 (define-key gud-speedbar-key-map "\C-m" 'speedbar-edit-line)))
239 (defvar gud-speedbar-menu-items
240 ;; Note to self. Add expand, and turn off items when not available.
241 '(["Jump to stack frame" speedbar-edit-line t])
242 "Additional menu items to add the the speedbar frame.")
244 ;; Make sure our special speedbar mode is loaded
245 (if (featurep 'speedbar)
246 (gud-install-speedbar-variables)
247 (add-hook 'speedbar-load-hook 'gud-install-speedbar-variables))
249 (defun gud-speedbar-buttons (buffer)
250 "Create a speedbar display based on the current state of GUD.
251 If the GUD BUFFER is not running a supported debugger, then turn
252 off the specialized speedbar mode."
253 (if (and (save-excursion (goto-char (point-min))
254 (looking-at "Current Stack"))
255 (equal gud-last-last-frame gud-last-speedbar-stackframe))
256 nil
257 (setq gud-last-speedbar-buffer buffer)
258 (let* ((ff (save-excursion (set-buffer buffer) gud-find-file))
259 ;;(lf (save-excursion (set-buffer buffer) gud-last-last-frame))
260 (frames
261 (cond ((eq ff 'gud-gdb-find-file)
262 (gud-gdb-get-stackframe buffer)
263 )
264 ;; Add more debuggers here!
265 (t
266 (speedbar-remove-localized-speedbar-support buffer)
267 nil))))
268 (erase-buffer)
269 (if (not frames)
272 (while frames
274 (if (= (length (car frames)) 2)
275 (progn
276 ; (speedbar-insert-button "[?]"
277 ; 'speedbar-button-face
278 ; nil nil nil t)
279 (speedbar-insert-button (car (car frames))
280 'speedbar-directory-face
281 nil nil nil t))
282 ; (speedbar-insert-button "[+]"
283 ; 'speedbar-button-face
284 ; 'speedbar-highlight-face
285 ; 'gud-gdb-get-scope-data
286 ; (car frames) t)
287 (speedbar-insert-button (car (car frames))
288 'speedbar-file-face
289 'speedbar-highlight-face
290 (cond ((eq ff 'gud-gdb-find-file)
291 'gud-gdb-goto-stackframe)
292 (t (error "Should never be here.")))
293 (car frames) t))
294 (setq frames (cdr frames)))
295 ; (let ((selected-frame
296 ; (cond ((eq ff 'gud-gdb-find-file)
297 ; (gud-gdb-selected-frame-info buffer))
298 ; (t (error "Should never be here."))))))
299 )
300 (setq gud-last-speedbar-stackframe gud-last-last-frame)))
302 \f
303 ;; ======================================================================
304 ;; gdb functions
306 ;;; History of argument lists passed to gdb.
307 (defvar gud-gdb-history nil)
309 (defun gud-gdb-massage-args (file args)
310 (cons "-fullname" args))
312 (defvar gud-gdb-marker-regexp
313 ;; This used to use path-separator instead of ":";
314 ;; however, we found that on both Windows 32 and MSDOS
315 ;; a colon is correct here.
319 ;; There's no guarantee that Emacs will hand the filter the entire
320 ;; marker at once; it could be broken up across several strings. We
321 ;; might even receive a big chunk with several markers in it. If we
322 ;; receive a chunk of text which looks like it might contain the
323 ;; beginning of a marker, we save it here between calls to the
324 ;; filter.
325 (defvar gud-marker-acc "")
326 (make-variable-buffer-local 'gud-marker-acc)
328 (defun gud-gdb-marker-filter (string)
329 (setq gud-marker-acc (concat gud-marker-acc string))
330 (let ((output ""))
332 ;; Process all the complete markers in this chunk.
333 (while (string-match gud-gdb-marker-regexp gud-marker-acc)
334 (setq
336 ;; Extract the frame position from the marker.
337 gud-last-frame
338 (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
339 (string-to-int (substring gud-marker-acc
340 (match-beginning 2)
341 (match-end 2))))
343 ;; Append any text before the marker to the output we're going
344 ;; to return - we don't include the marker in this text.
345 output (concat output
346 (substring gud-marker-acc 0 (match-beginning 0)))
348 ;; Set the accumulator to the remaining text.
349 gud-marker-acc (substring gud-marker-acc (match-end 0))))
351 ;; Does the remaining text look like it might end with the
352 ;; beginning of another marker? If it does, then keep it in
353 ;; gud-marker-acc until we receive the rest of it. Since we
354 ;; know the full marker regexp above failed, it's pretty simple to
355 ;; test for marker starts.
357 (progn
358 ;; Everything before the potential marker start can be output.
359 (setq output (concat output (substring gud-marker-acc
360 0 (match-beginning 0))))
362 ;; Everything after, we save, to combine with later input.
363 (setq gud-marker-acc
364 (substring gud-marker-acc (match-beginning 0))))
366 (setq output (concat output gud-marker-acc)
367 gud-marker-acc ""))
369 output))
371 (defun gud-gdb-find-file (f)
372 (find-file-noselect f 'nowarn))
374 (easy-mmode-defmap gud-minibuffer-local-map
375 '(("\C-i" . comint-dynamic-complete-filename))
376 "Keymap for minibuffer prompting of gud startup command."
377 :inherit minibuffer-local-map)
379 (defun gud-query-cmdline (minor-mode &optional init)
380 (let* ((hist-sym (gud-symbol 'history nil minor-mode))
381 (cmd-name (gud-val 'command-name minor-mode)))
382 (unless (boundp hist-sym) (set hist-sym nil))
383 (read-from-minibuffer
384 (format "Run %s (like this): " minor-mode)
385 (or (car-safe (symbol-value hist-sym))
386 (concat (or cmd-name (symbol-name minor-mode)) " " init))
387 gud-minibuffer-local-map nil
388 hist-sym)))
390 ;;;###autoload
391 (defun gdb (command-line)
392 "Run gdb on program FILE in buffer *gud-FILE*.
393 The directory containing FILE becomes the initial working directory
394 and source-file directory for your debugger."
395 (interactive (list (gud-query-cmdline 'gdb)))
397 (gud-common-init command-line 'gud-gdb-massage-args
398 'gud-gdb-marker-filter 'gud-gdb-find-file)
399 (set (make-local-variable 'gud-minor-mode) 'gdb)
401 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
402 (gud-def gud-tbreak "tbreak %f:%l" "\C-t" "Set temporary breakpoint at current line.")
403 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
404 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
405 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
406 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
407 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
408 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
409 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
410 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
411 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
413 (local-set-key "\C-i" 'gud-gdb-complete-command)
414 (local-set-key [menu-bar debug tbreak] '("Temporary Breakpoint" . gud-tbreak))
415 (local-set-key [menu-bar debug finish] '("Finish Function" . gud-finish))
416 (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
417 (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
418 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
419 (setq paragraph-start comint-prompt-regexp)
420 (run-hooks 'gdb-mode-hook)
421 )
423 ;; One of the nice features of GDB is its impressive support for
424 ;; context-sensitive command completion. We preserve that feature
425 ;; in the GUD buffer by using a GDB command designed just for Emacs.
427 ;; The completion process filter indicates when it is finished.
428 (defvar gud-gdb-complete-in-progress)
430 ;; Since output may arrive in fragments we accumulate partials strings here.
431 (defvar gud-gdb-complete-string)
433 ;; We need to know how much of the completion to chop off.
434 (defvar gud-gdb-complete-break)
436 ;; The completion list is constructed by the process filter.
437 (defvar gud-gdb-complete-list)
439 (defvar gud-comint-buffer nil)
441 (defun gud-gdb-complete-command ()
442 "Perform completion on the GDB command preceding point.
443 This is implemented using the GDB `complete' command which isn't
444 available with older versions of GDB."
445 (interactive)
446 (let* ((end (point))
447 (command (buffer-substring (comint-line-beginning-position) end))
448 command-word)
449 ;; Find the word break. This match will always succeed.
451 (setq gud-gdb-complete-break (match-beginning 2)
452 command-word (substring command gud-gdb-complete-break))
453 ;; Temporarily install our filter function.
454 (let ((gud-marker-filter 'gud-gdb-complete-filter))
455 ;; Issue the command to GDB.
456 (gud-basic-call (concat "complete " command))
457 (setq gud-gdb-complete-in-progress t
458 gud-gdb-complete-string nil
459 gud-gdb-complete-list nil)
460 ;; Slurp the output.
461 (while gud-gdb-complete-in-progress
462 (accept-process-output (get-buffer-process gud-comint-buffer))))
463 ;; Protect against old versions of GDB.
464 (and gud-gdb-complete-list
466 (car gud-gdb-complete-list))
467 (error "This version of GDB doesn't support the `complete' command."))
468 ;; Sort the list like readline.
469 (setq gud-gdb-complete-list
470 (sort gud-gdb-complete-list (function string-lessp)))
471 ;; Remove duplicates.
472 (let ((first gud-gdb-complete-list)
473 (second (cdr gud-gdb-complete-list)))
474 (while second
475 (if (string-equal (car first) (car second))
476 (setcdr first (setq second (cdr second)))
477 (setq first second
478 second (cdr second)))))
479 ;; Add a trailing single quote if there is a unique completion
480 ;; and it contains an odd number of unquoted single quotes.
481 (and (= (length gud-gdb-complete-list) 1)
482 (let ((str (car gud-gdb-complete-list))
483 (pos 0)
484 (count 0))
486 (setq count (1+ count)
487 pos (match-end 0)))
488 (and (= (mod count 2) 1)
489 (setq gud-gdb-complete-list (list (concat str "'"))))))
490 ;; Let comint handle the rest.
491 (comint-dynamic-simple-complete command-word gud-gdb-complete-list)))
493 ;; The completion process filter is installed temporarily to slurp the
494 ;; output of GDB up to the next prompt and build the completion list.
495 (defun gud-gdb-complete-filter (string)
496 (setq string (concat gud-gdb-complete-string string))
498 (setq gud-gdb-complete-list
499 (cons (substring string gud-gdb-complete-break (match-beginning 0))
500 gud-gdb-complete-list))
501 (setq string (substring string (match-end 0))))
502 (if (string-match comint-prompt-regexp string)
503 (progn
504 (setq gud-gdb-complete-in-progress nil)
505 string)
506 (progn
507 (setq gud-gdb-complete-string string)
508 "")))
510 ;; gdb speedbar functions
512 (defun gud-gdb-goto-stackframe (text token indent)
513 "Goto the stackframe described by TEXT, TOKEN, and INDENT."
514 (speedbar-with-attached-buffer
515 (gud-basic-call (concat "frame " (nth 1 token)))
516 (sit-for 1)))
518 (defvar gud-gdb-fetched-stack-frame nil
519 "Stack frames we are fetching from GDB.")
521 (defvar gud-gdb-fetched-stack-frame-list nil
522 "List of stack frames we are fetching from GDB.")
524 ;(defun gud-gdb-get-scope-data (text token indent)
525 ; ;; checkdoc-params: (indent)
526 ; "Fetch data associated with a stack frame, and expand/contract it.
527 ;Data to do this is retrieved from TEXT and TOKEN."
528 ; (let ((args nil) (scope nil))
529 ; (gud-gdb-run-command-fetch-lines "info args")
530 ;
531 ; (gud-gdb-run-command-fetch-lines "info local")
532 ;
533 ; ))
535 (defun gud-gdb-get-stackframe (buffer)
536 "Extract the current stack frame out of the GUD GDB BUFFER."
537 (let ((newlst nil)
538 (gud-gdb-fetched-stack-frame-list nil))
539 (gud-gdb-run-command-fetch-lines "backtrace" buffer)
540 (if (and (car gud-gdb-fetched-stack-frame-list)
541 (string-match "No stack" (car gud-gdb-fetched-stack-frame-list)))
542 ;; Go into some other mode???
543 nil
544 (while gud-gdb-fetched-stack-frame-list
545 (let ((e (car gud-gdb-fetched-stack-frame-list))
546 (name nil) (num nil))
547 (if (not (or
550 (if (not (string-match
552 nil
553 (setcar newlst
554 (list (nth 0 (car newlst))
555 (nth 1 (car newlst))
556 (match-string 1 e)
557 (match-string 2 e))))
558 (setq num (match-string 1 e)
559 name (match-string 2 e))
560 (setq newlst
561 (cons
562 (if (string-match
564 (list name num (match-string 1 e)
565 (match-string 2 e))
566 (list name num))
567 newlst))))
568 (setq gud-gdb-fetched-stack-frame-list
569 (cdr gud-gdb-fetched-stack-frame-list)))
570 (nreverse newlst))))
572 ;(defun gud-gdb-selected-frame-info (buffer)
573 ; "Learn GDB information for the currently selected stack frame in BUFFER."
574 ; )
576 (defun gud-gdb-run-command-fetch-lines (command buffer)
577 "Run COMMAND, and return when `gud-gdb-fetched-stack-frame-list' is full.
578 BUFFER is the GUD buffer in which to run the command."
579 (save-excursion
580 (set-buffer buffer)
581 (if (save-excursion
582 (goto-char (point-max))
583 (beginning-of-line)
584 (not (looking-at comint-prompt-regexp)))
585 nil
586 ;; Much of this copied from GDB complete, but I'm grabbing the stack
587 ;; frame instead.
588 (let ((gud-marker-filter 'gud-gdb-speedbar-stack-filter))
589 ;; Issue the command to GDB.
590 (gud-basic-call command)
591 (setq gud-gdb-complete-in-progress t ;; use this flag for our purposes.
592 gud-gdb-complete-string nil
593 gud-gdb-complete-list nil)
594 ;; Slurp the output.
595 (while gud-gdb-complete-in-progress
596 (accept-process-output (get-buffer-process gud-comint-buffer)))
597 (setq gud-gdb-fetched-stack-frame nil
598 gud-gdb-fetched-stack-frame-list
599 (nreverse gud-gdb-fetched-stack-frame-list))))))
601 (defun gud-gdb-speedbar-stack-filter (string)
602 ;; checkdoc-params: (string)
603 "Filter used to read in the current GDB stack."
604 (setq string (concat gud-gdb-fetched-stack-frame string))
606 (setq gud-gdb-fetched-stack-frame-list
607 (cons (substring string 0 (match-beginning 0))
608 gud-gdb-fetched-stack-frame-list))
609 (setq string (substring string (match-end 0))))
610 (if (string-match comint-prompt-regexp string)
611 (progn
612 (setq gud-gdb-complete-in-progress nil)
613 string)
614 (progn
615 (setq gud-gdb-complete-string string)
616 "")))
618 \f
619 ;; ======================================================================
620 ;; sdb functions
622 ;;; History of argument lists passed to sdb.
623 (defvar gud-sdb-history nil)
625 (defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
626 "If nil, we're on a System V Release 4 and don't need the tags hack.")
628 (defvar gud-sdb-lastfile nil)
630 (defun gud-sdb-massage-args (file args) args)
632 (defun gud-sdb-marker-filter (string)
633 (setq gud-marker-acc
634 (if gud-marker-acc (concat gud-marker-acc string) string))
635 (let (start)
636 ;; Process all complete markers in this chunk
637 (while
638 (cond
639 ;; System V Release 3.2 uses this format
641 gud-marker-acc start)
642 (setq gud-last-frame
643 (cons
644 (substring gud-marker-acc (match-beginning 3) (match-end 3))
645 (string-to-int
646 (substring gud-marker-acc (match-beginning 4) (match-end 4))))))
647 ;; System V Release 4.0 quite often clumps two lines together
648 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
649 gud-marker-acc start)
650 (setq gud-sdb-lastfile
651 (substring gud-marker-acc (match-beginning 2) (match-end 2)))
652 (setq gud-last-frame
653 (cons
654 gud-sdb-lastfile
655 (string-to-int
656 (substring gud-marker-acc (match-beginning 3) (match-end 3))))))
657 ;; System V Release 4.0
659 gud-marker-acc start)
660 (setq gud-sdb-lastfile
661 (substring gud-marker-acc (match-beginning 2) (match-end 2))))
663 gud-marker-acc start))
664 (setq gud-last-frame
665 (cons
666 gud-sdb-lastfile
667 (string-to-int
668 (substring gud-marker-acc (match-beginning 1) (match-end 1))))))
669 (t
670 (setq gud-sdb-lastfile nil)))
671 (setq start (match-end 0)))
673 ;; Search for the last incomplete line in this chunk
675 (setq start (match-end 0)))
677 ;; If we have an incomplete line, store it in gud-marker-acc.
678 (setq gud-marker-acc (substring gud-marker-acc (or start 0))))
679 string)
681 (defun gud-sdb-find-file (f)
682 (if gud-sdb-needs-tags (find-tag-noselect f) (find-file-noselect f)))
684 ;;;###autoload
685 (defun sdb (command-line)
686 "Run sdb on program FILE in buffer *gud-FILE*.
687 The directory containing FILE becomes the initial working directory
688 and source-file directory for your debugger."
689 (interactive (list (gud-query-cmdline 'sdb)))
691 (if (and gud-sdb-needs-tags
692 (not (and (boundp 'tags-file-name)
693 (stringp tags-file-name)
694 (file-exists-p tags-file-name))))
695 (error "The sdb support requires a valid tags table to work."))
697 (gud-common-init command-line 'gud-sdb-massage-args
698 'gud-sdb-marker-filter 'gud-sdb-find-file)
699 (set (make-local-variable 'gud-minor-mode) 'sdb)
701 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
702 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
703 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
704 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
705 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
706 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
707 (gud-def gud-cont "c" "\C-r" "Continue with display.")
708 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
711 (setq paragraph-start comint-prompt-regexp)
712 (local-set-key [menu-bar debug tbreak]
713 '("Temporary Breakpoint" . gud-tbreak))
714 (run-hooks 'sdb-mode-hook)
715 )
716 \f
717 ;; ======================================================================
718 ;; dbx functions
720 ;;; History of argument lists passed to dbx.
721 (defvar gud-dbx-history nil)
723 (defcustom gud-dbx-directories nil
724 "*A list of directories that dbx should search for source code.
725 If nil, only source files in the program directory
726 will be known to dbx.
728 The file names should be absolute, or relative to the directory
729 containing the executable being debugged."
730 :type '(choice (const :tag "Current Directory" nil)
731 (repeat :value ("")
732 directory))
733 :group 'gud)
735 (defun gud-dbx-massage-args (file args)
736 (nconc (let ((directories gud-dbx-directories)
737 (result nil))
738 (while directories
739 (setq result (cons (car directories) (cons "-I" result)))
740 (setq directories (cdr directories)))
741 (nreverse result))
742 args))
744 (defun gud-dbx-file-name (f)
745 "Transform a relative file name to an absolute file name, for dbx."
746 (let ((result nil))
747 (if (file-exists-p f)
748 (setq result (expand-file-name f))
749 (let ((directories gud-dbx-directories))
750 (while directories
751 (let ((path (concat (car directories) "/" f)))
752 (if (file-exists-p path)
753 (setq result (expand-file-name path)
754 directories nil)))
755 (setq directories (cdr directories)))))
756 result))
758 (defun gud-dbx-marker-filter (string)
759 (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
761 (let (start)
762 ;; Process all complete markers in this chunk.
763 (while (or (string-match
765 gud-marker-acc start)
766 (string-match
768 gud-marker-acc start))
769 (setq gud-last-frame
770 (cons
771 (substring gud-marker-acc (match-beginning 2) (match-end 2))
772 (string-to-int
773 (substring gud-marker-acc (match-beginning 1) (match-end 1))))
774 start (match-end 0)))
776 ;; Search for the last incomplete line in this chunk
778 (setq start (match-end 0)))
780 ;; If the incomplete line APPEARS to begin with another marker, keep it
781 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
782 ;; unnecessary concat during the next call.
783 (setq gud-marker-acc
785 (substring gud-marker-acc (match-beginning 0))
786 nil)))
787 string)
789 ;; Functions for Mips-style dbx. Given the option `-emacs', documented in
790 ;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
791 (defvar gud-mips-p
792 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
793 ;; We haven't tested gud on this system:
794 (string-match "^mips-[^-]*-riscos" system-configuration)
795 ;; It's documented on OSF/1.3
796 (string-match "^mips-[^-]*-osf1" system-configuration)
797 (string-match "^alpha[^-]*-[^-]*-osf" system-configuration))
798 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
800 (defun gud-mipsdbx-massage-args (file args)
801 (cons "-emacs" args))
803 ;; This is just like the gdb one except for the regexps since we need to cope
804 ;; with an optional breakpoint number in [] before the ^Z^Z
805 (defun gud-mipsdbx-marker-filter (string)
806 (setq gud-marker-acc (concat gud-marker-acc string))
807 (let ((output ""))
809 ;; Process all the complete markers in this chunk.
810 (while (string-match
811 ;; This is like th gdb marker but with an optional
812 ;; leading break point number like `[1] '
814 gud-marker-acc)
815 (setq
817 ;; Extract the frame position from the marker.
818 gud-last-frame
819 (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
820 (string-to-int (substring gud-marker-acc
821 (match-beginning 2)
822 (match-end 2))))
824 ;; Append any text before the marker to the output we're going
825 ;; to return - we don't include the marker in this text.
826 output (concat output
827 (substring gud-marker-acc 0 (match-beginning 0)))
829 ;; Set the accumulator to the remaining text.
830 gud-marker-acc (substring gud-marker-acc (match-end 0))))
832 ;; Does the remaining text look like it might end with the
833 ;; beginning of another marker? If it does, then keep it in
834 ;; gud-marker-acc until we receive the rest of it. Since we
835 ;; know the full marker regexp above failed, it's pretty simple to
836 ;; test for marker starts.
838 (progn
839 ;; Everything before the potential marker start can be output.
840 (setq output (concat output (substring gud-marker-acc
841 0 (match-beginning 0))))
843 ;; Everything after, we save, to combine with later input.
844 (setq gud-marker-acc
845 (substring gud-marker-acc (match-beginning 0))))
847 (setq output (concat output gud-marker-acc)
848 gud-marker-acc ""))
850 output))
852 ;; The dbx in IRIX is a pain. It doesn't print the file name when
853 ;; stopping at a breakpoint (but you do get it from the `up' and
854 ;; `down' commands...). The only way to extract the information seems
855 ;; to be with a `file' command, although the current line number is
856 ;; available in $curline. Thus we have to look for output which
857 ;; appears to indicate a breakpoint. Then we prod the dbx sub-process
858 ;; to output the information we want with a combination of the
859 ;; `printf' and `file' commands as a pseudo marker which we can
860 ;; recognise next time through the marker-filter. This would be like
861 ;; the gdb marker but you can't get the file name without a newline...
862 ;; Note that gud-remove won't work since Irix dbx expects a breakpoint
863 ;; number rather than a line number etc. Maybe this could be made to
864 ;; work by listing all the breakpoints and picking the one(s) with the
865 ;; correct line number, but life's too short.
866 ;; d.love@dl.ac.uk (Dave Love) can be blamed for this
868 (defvar gud-irix-p
869 (and (string-match "^mips-[^-]*-irix" system-configuration)
871 "Non-nil to assume the interface appropriate for IRIX dbx.
872 This works in IRIX 4, 5 and 6, but `gud-dbx-use-stopformat-p' provides
873 a better solution in 6.1 upwards.")
874 (defvar gud-dbx-use-stopformat-p
876 "Non-nil to use the dbx feature present at least from Irix 6.1
877 whereby $stopformat=1 produces an output format compatiable with
878 `gud-dbx-marker-filter'.")
879 ;; [Irix dbx seems to be a moving target. The dbx output changed
880 ;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
881 ;; the output from `up' is no longer spotted by gud (and it's probably
882 ;; not distinctive enough to try to match it -- use C-<, C->
883 ;; exclusively) . For 5.3 and 6.0, the $curline variable changed to
884 ;; `long long'(why?!), so the printf stuff needed changing. The line
885 ;; number was cast to `long' as a compromise between the new `long
886 ;; long' and the original `int'. This is reported not to work in 6.2,
887 ;; so it's changed back to int -- don't make your sources too long.
888 ;; From Irix6.1 (but not 6.0?) dbx supports an undocumented feature
889 ;; whereby `set $stopformat=1' reportedly produces output compatible
890 ;; with `gud-dbx-marker-filter', which we prefer.
892 ;; The process filter is also somewhat
893 ;; unreliable, sometimes not spotting the markers; I don't know
894 ;; whether there's anything that can be done about that. It would be
895 ;; much better if SGI could be persuaded to (re?)instate the MIPS
896 ;; -emacs flag for gdb-like output (which ought to be possible as most
897 ;; of the communication I've had over it has been from sgi.com).]
899 ;; this filter is influenced by the xdb one rather than the gdb one
900 (defun gud-irixdbx-marker-filter (string)
901 (let (result (case-fold-search nil))
902 (if (or (string-match comint-prompt-regexp string)
904 (setq result (concat gud-marker-acc string)
905 gud-marker-acc "")
906 (setq gud-marker-acc (concat gud-marker-acc string)))
907 (if result
908 (cond
909 ;; look for breakpoint or signal indication e.g.:
910 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
911 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
912 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
913 ((string-match
915 result)
916 ;; prod dbx into printing out the line number and file
917 ;; name in a form we can grok as below
918 (process-send-string (get-buffer-process gud-comint-buffer)
920 ;; look for result of, say, "up" e.g.:
921 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
922 ;; (this will also catch one of the lines printed by "where")
923 ((string-match
925 result)
926 (let ((file (substring result (match-beginning 1)
927 (match-end 1))))
928 (if (file-exists-p file)
929 (setq gud-last-frame
930 (cons
931 (substring
932 result (match-beginning 1) (match-end 1))
933 (string-to-int
934 (substring
935 result (match-beginning 2) (match-end 2)))))))
936 result)
937 ((string-match ; kluged-up marker as above
939 (let ((file (gud-dbx-file-name
940 (substring result (match-beginning 2) (match-end 2)))))
941 (if (and file (file-exists-p file))
942 (setq gud-last-frame
943 (cons
944 file
945 (string-to-int
946 (substring
947 result (match-beginning 1) (match-end 1)))))))
948 (setq result (substring result 0 (match-beginning 0))))))
949 (or result "")))
951 (defvar gud-dgux-p (string-match "-dgux" system-configuration)
952 "Non-nil means to assume the interface approriate for DG/UX dbx.
953 This was tested using R4.11.")
955 ;; There are a couple of differences between DG's dbx output and normal
956 ;; dbx output which make it nontrivial to integrate this into the
957 ;; standard dbx-marker-filter (mainly, there are a different number of
958 ;; backreferences). The markers look like:
959 ;;
960 ;; (0) Stopped at line 10, routine main(argc=1, argv=0xeffff0e0), file t.c
961 ;;
962 ;; from breakpoints (the `(0)' there isn't constant, it's the breakpoint
963 ;; number), and
964 ;;
965 ;; Stopped at line 13, routine main(argc=1, argv=0xeffff0e0), file t.c
966 ;;
967 ;; from signals and
968 ;;
969 ;; Frame 21, line 974, routine command_loop(), file keyboard.c
970 ;;
971 ;; from up/down/where.
973 (defun gud-dguxdbx-marker-filter (string)
974 (setq gud-marker-acc (if gud-marker-acc
975 (concat gud-marker-acc string)
976 string))
979 start)
980 ;; Process all complete markers in this chunk.
981 (while (string-match re gud-marker-acc start)
982 (setq gud-last-frame
983 (cons
984 (substring gud-marker-acc (match-beginning 4) (match-end 4))
985 (string-to-int (substring gud-marker-acc
986 (match-beginning 3) (match-end 3))))
987 start (match-end 0)))
989 ;; Search for the last incomplete line in this chunk
991 (setq start (match-end 0)))
993 ;; If the incomplete line APPEARS to begin with another marker, keep it
994 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
995 ;; unnecessary concat during the next call.
996 (setq gud-marker-acc
998 (substring gud-marker-acc (match-beginning 0))
999 nil)))
1000 string)
1002 (defun gud-dbx-find-file (f)
1003 (save-excursion
1004 (let ((realf (gud-dbx-file-name f)))
1005 (if realf
1006 (find-file-noselect realf)))))
1008 ;;;###autoload
1009 (defun dbx (command-line)
1010 "Run dbx on program FILE in buffer *gud-FILE*.
1011 The directory containing FILE becomes the initial working directory
1012 and source-file directory for your debugger."
1013 (interactive (list (gud-query-cmdline 'dbx)))
1015 (cond
1016 (gud-mips-p
1017 (gud-common-init command-line 'gud-mipsdbx-massage-args
1018 'gud-mipsdbx-marker-filter 'gud-dbx-find-file))
1019 (gud-irix-p
1020 (gud-common-init command-line 'gud-dbx-massage-args
1021 'gud-irixdbx-marker-filter 'gud-dbx-find-file))
1022 (gud-dgux-p
1023 (gud-common-init command-line 'gud-dbx-massage-args
1024 'gud-dguxdbx-marker-filter 'gud-dbx-find-file))
1025 (t
1026 (gud-common-init command-line 'gud-dbx-massage-args
1027 'gud-dbx-marker-filter 'gud-dbx-find-file)))
1029 (set (make-local-variable 'gud-minor-mode) 'dbx)
1031 (cond
1032 (gud-mips-p
1033 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1034 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1036 "\C-b" "Set breakpoint at current line.")
1037 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
1038 (gud-irix-p
1040 "\C-b" "Set breakpoint at current line.")
1041 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1043 "<" "Up (numeric arg) stack frames.")
1045 ">" "Down (numeric arg) stack frames.")
1046 ;; Make dbx give out the source location info that we need.
1047 (process-send-string (get-buffer-process gud-comint-buffer)
1049 (gud-dbx-use-stopformat-p
1050 (process-send-string (get-buffer-process gud-comint-buffer)
1052 (t
1053 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1054 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1056 "\C-b" "Set breakpoint at current line.")))
1058 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
1059 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
1060 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
1061 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
1062 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
1063 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
1066 (setq paragraph-start comint-prompt-regexp)
1067 (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
1068 (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
1069 (run-hooks 'dbx-mode-hook)
1070 )
1071 \f
1072 ;; ======================================================================
1073 ;; xdb (HP PARISC debugger) functions
1075 ;;; History of argument lists passed to xdb.
1076 (defvar gud-xdb-history nil)
1078 (defcustom gud-xdb-directories nil
1079 "*A list of directories that xdb should search for source code.
1080 If nil, only source files in the program directory
1081 will be known to xdb.
1083 The file names should be absolute, or relative to the directory
1084 containing the executable being debugged."
1085 :type '(choice (const :tag "Current Directory" nil)
1086 (repeat :value ("")
1087 directory))
1088 :group 'gud)
1090 (defun gud-xdb-massage-args (file args)
1091 (nconc (let ((directories gud-xdb-directories)
1092 (result nil))
1093 (while directories
1094 (setq result (cons (car directories) (cons "-d" result)))
1095 (setq directories (cdr directories)))
1096 (nreverse result))
1097 args))
1099 (defun gud-xdb-file-name (f)
1100 "Transform a relative pathname to a full pathname in xdb mode"
1101 (let ((result nil))
1102 (if (file-exists-p f)
1103 (setq result (expand-file-name f))
1104 (let ((directories gud-xdb-directories))
1105 (while directories
1106 (let ((path (concat (car directories) "/" f)))
1107 (if (file-exists-p path)
1108 (setq result (expand-file-name path)
1109 directories nil)))
1110 (setq directories (cdr directories)))))
1111 result))
1113 ;; xdb does not print the lines all at once, so we have to accumulate them
1114 (defun gud-xdb-marker-filter (string)
1115 (let (result)
1116 (if (or (string-match comint-prompt-regexp string)
1118 (setq result (concat gud-marker-acc string)
1119 gud-marker-acc "")
1120 (setq gud-marker-acc (concat gud-marker-acc string)))
1121 (if result
1123 result)
1125 result))
1126 (let ((line (string-to-int
1127 (substring result (match-beginning 2) (match-end 2))))
1128 (file (gud-xdb-file-name
1129 (substring result (match-beginning 1) (match-end 1)))))
1130 (if file
1131 (setq gud-last-frame (cons file line))))))
1132 (or result "")))
1134 (defun gud-xdb-find-file (f)
1135 (save-excursion
1136 (let ((realf (gud-xdb-file-name f)))
1137 (if realf
1138 (find-file-noselect realf)))))
1140 ;;;###autoload
1141 (defun xdb (command-line)
1142 "Run xdb on program FILE in buffer *gud-FILE*.
1143 The directory containing FILE becomes the initial working directory
1144 and source-file directory for your debugger.
1146 You can set the variable 'gud-xdb-directories' to a list of program source
1147 directories if your program contains sources from more than one directory."
1148 (interactive (list (gud-query-cmdline 'xdb)))
1150 (gud-common-init command-line 'gud-xdb-massage-args
1151 'gud-xdb-marker-filter 'gud-xdb-find-file)
1152 (set (make-local-variable 'gud-minor-mode) 'xdb)
1154 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
1156 "Set temporary breakpoint at current line.")
1157 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
1158 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
1159 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1160 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1161 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1162 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1164 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
1166 (setq comint-prompt-regexp "^>")
1167 (setq paragraph-start comint-prompt-regexp)
1168 (local-set-key [menu-bar debug tbreak] '("Temporary Breakpoint" . gud-tbreak))
1169 (local-set-key [menu-bar debug finish] '("Finish Function" . gud-finish))
1170 (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
1171 (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
1172 (run-hooks 'xdb-mode-hook))
1173 \f
1174 ;; ======================================================================
1175 ;; perldb functions
1177 ;;; History of argument lists passed to perldb.
1178 (defvar gud-perldb-history nil)
1180 ;; Convert a command line as would be typed normally to run a script
1181 ;; into one that invokes an Emacs-enabled debugging session.
1182 ;; "-d" in inserted as the first switch, and "-emacs" is inserted where
1183 ;; it will be $ARGV[0] (see perl5db.pl).
1184 (defun gud-perldb-massage-args (file args)
1185 (let* ((new-args (list "-d"))
1186 (seen-e nil)
1187 (shift (lambda ()
1188 (setq new-args (cons (car args) new-args))
1189 (setq args (cdr args)))))
1191 ;; Pass all switches and -e scripts through.
1192 (while (and args
1193 (string-match "^-" (car args))
1194 (not (equal "-" (car args)))
1195 (not (equal "--" (car args))))
1196 (when (equal "-e" (car args))
1197 ;; -e goes with the next arg, so shift one extra.
1198 (or (funcall shift)
1199 ;; -e as the last arg is an error in Perl.
1200 (error "No code specified for -e."))
1201 (setq seen-e t))
1202 (funcall shift))
1204 (when (not seen-e)
1205 (if (or (not args)
1206 (string-match "^-" (car args)))
1207 (error "Can't use stdin as the script to debug."))
1208 ;; This is the program name.
1209 (funcall shift))
1211 ;; If -e specified, make sure there is a -- so -emacs is not taken
1212 ;; as -e macs.
1213 (if (and args (equal "--" (car args)))
1214 (funcall shift)
1215 (and seen-e (setq new-args (cons "--" new-args))))
1217 (setq new-args (cons "-emacs" new-args))
1218 (while args
1219 (funcall shift))
1221 (nreverse new-args)))
1223 ;; There's no guarantee that Emacs will hand the filter the entire
1224 ;; marker at once; it could be broken up across several strings. We
1225 ;; might even receive a big chunk with several markers in it. If we
1226 ;; receive a chunk of text which looks like it might contain the
1227 ;; beginning of a marker, we save it here between calls to the
1228 ;; filter.
1229 (defun gud-perldb-marker-filter (string)
1230 (setq gud-marker-acc (concat gud-marker-acc string))
1231 (let ((output ""))
1233 ;; Process all the complete markers in this chunk.
1235 gud-marker-acc)
1236 (setq
1238 ;; Extract the frame position from the marker.
1239 gud-last-frame
1240 (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
1241 (string-to-int (substring gud-marker-acc
1242 (match-beginning 3)
1243 (match-end 3))))
1245 ;; Append any text before the marker to the output we're going
1246 ;; to return - we don't include the marker in this text.
1247 output (concat output
1248 (substring gud-marker-acc 0 (match-beginning 0)))
1250 ;; Set the accumulator to the remaining text.
1251 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1253 ;; Does the remaining text look like it might end with the
1254 ;; beginning of another marker? If it does, then keep it in
1255 ;; gud-marker-acc until we receive the rest of it. Since we
1256 ;; know the full marker regexp above failed, it's pretty simple to
1257 ;; test for marker starts.
1259 (progn
1260 ;; Everything before the potential marker start can be output.
1261 (setq output (concat output (substring gud-marker-acc
1262 0 (match-beginning 0))))
1264 ;; Everything after, we save, to combine with later input.
1265 (setq gud-marker-acc
1266 (substring gud-marker-acc (match-beginning 0))))
1268 (setq output (concat output gud-marker-acc)
1269 gud-marker-acc ""))
1271 output))
1273 (defun gud-perldb-find-file (f)
1274 (find-file-noselect f))
1276 (defcustom gud-perldb-command-name "perl"
1277 "File name for executing Perl."
1278 :type 'string
1279 :group 'gud)
1281 ;;;###autoload
1282 (defun perldb (command-line)
1283 "Run perldb on program FILE in buffer *gud-FILE*.
1284 The directory containing FILE becomes the initial working directory
1285 and source-file directory for your debugger."
1286 (interactive
1287 (list (gud-query-cmdline 'perldb
1288 (concat (or (buffer-file-name) "-e 0") " "))))
1290 (gud-common-init command-line 'gud-perldb-massage-args
1291 'gud-perldb-marker-filter 'gud-perldb-find-file)
1292 (set (make-local-variable 'gud-minor-mode) 'perldb)
1294 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
1295 (gud-def gud-remove "d %l" "\C-d" "Remove breakpoint at current line")
1296 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
1297 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
1298 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1299 ; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
1300 ; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
1301 ; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
1302 (gud-def gud-print "%e" "\C-p" "Evaluate perl expression at point.")
1304 (setq comint-prompt-regexp "^ DB<+[0-9]+>+ ")
1305 (setq paragraph-start comint-prompt-regexp)
1306 (run-hooks 'perldb-mode-hook))
1307 \f
1308 ;; ======================================================================
1309 ;; pdb (Python debugger) functions
1311 ;;; History of argument lists passed to pdb.
1312 (defvar gud-pdb-history nil)
1314 (defun gud-pdb-massage-args (file args)
1315 args)
1317 ;; Last group is for return value, e.g. "> test.py(2)foo()->None"
1318 ;; Either file or function name may be omitted: "> <string>(0)?()"
1319 (defvar gud-pdb-marker-regexp
1320 "^> \\([-a-zA-Z0-9_/.]*\\|<string>\\)(\\([0-9]+\\))\\([a-zA-Z0-9_]*\\|\\?\\)()\\(->[^\n]*\\)?\n")
1321 (defvar gud-pdb-marker-regexp-file-group 1)
1322 (defvar gud-pdb-marker-regexp-line-group 2)
1323 (defvar gud-pdb-marker-regexp-fnname-group 3)
1325 (defvar gud-pdb-marker-regexp-start "^> ")
1327 ;; There's no guarantee that Emacs will hand the filter the entire
1328 ;; marker at once; it could be broken up across several strings. We
1329 ;; might even receive a big chunk with several markers in it. If we
1330 ;; receive a chunk of text which looks like it might contain the
1331 ;; beginning of a marker, we save it here between calls to the
1332 ;; filter.
1333 (defun gud-pdb-marker-filter (string)
1334 (setq gud-marker-acc (concat gud-marker-acc string))
1335 (let ((output ""))
1337 ;; Process all the complete markers in this chunk.
1338 (while (string-match gud-pdb-marker-regexp gud-marker-acc)
1339 (setq
1341 ;; Extract the frame position from the marker.
1342 gud-last-frame
1343 (let ((file (match-string gud-pdb-marker-regexp-file-group
1344 gud-marker-acc))
1345 (line (string-to-int
1346 (match-string gud-pdb-marker-regexp-line-group
1347 gud-marker-acc))))
1348 (if (string-equal file "<string>")
1349 gud-last-frame
1350 (cons file line)))
1352 ;; Output everything instead of the below
1353 output (concat output (substring gud-marker-acc 0 (match-end 0)))
1354 ;; ;; Append any text before the marker to the output we're going
1355 ;; ;; to return - we don't include the marker in this text.
1356 ;; output (concat output
1357 ;; (substring gud-marker-acc 0 (match-beginning 0)))
1359 ;; Set the accumulator to the remaining text.
1360 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1362 ;; Does the remaining text look like it might end with the
1363 ;; beginning of another marker? If it does, then keep it in
1364 ;; gud-marker-acc until we receive the rest of it. Since we
1365 ;; know the full marker regexp above failed, it's pretty simple to
1366 ;; test for marker starts.
1367 (if (string-match gud-pdb-marker-regexp-start gud-marker-acc)
1368 (progn
1369 ;; Everything before the potential marker start can be output.
1370 (setq output (concat output (substring gud-marker-acc
1371 0 (match-beginning 0))))
1373 ;; Everything after, we save, to combine with later input.
1374 (setq gud-marker-acc
1375 (substring gud-marker-acc (match-beginning 0))))
1377 (setq output (concat output gud-marker-acc)
1378 gud-marker-acc ""))
1380 output))
1382 (defun gud-pdb-find-file (f)
1383 (find-file-noselect f))
1385 (defcustom gud-pdb-command-name "pdb"
1386 "File name for executing the Python debugger.
1387 This should be an executable on your path, or an absolute file name."
1388 :type 'string
1389 :group 'gud)
1391 ;;;###autoload
1392 (defun pdb (command-line)
1393 "Run pdb on program FILE in buffer `*gud-FILE*'.
1394 The directory containing FILE becomes the initial working directory
1395 and source-file directory for your debugger."
1396 (interactive
1397 (list (gud-query-cmdline 'pdb)))
1399 (gud-common-init command-line 'gud-pdb-massage-args
1400 'gud-pdb-marker-filter 'gud-pdb-find-file)
1401 (set (make-local-variable 'gud-minor-mode) 'pdb)
1403 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
1404 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
1405 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
1406 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
1407 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
1408 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1409 (gud-def gud-up "up" "<" "Up one stack frame.")
1410 (gud-def gud-down "down" ">" "Down one stack frame.")
1411 (gud-def gud-print "p %e" "\C-p" "Evaluate Python expression at point.")
1412 ;; Is this right?
1413 (gud-def gud-statement "! %e" "\C-e" "Execute Python statement at point.")
1415 (local-set-key [menu-bar debug finish] '("Finish Function" . gud-finish))
1416 (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
1417 (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
1418 ;; (setq comint-prompt-regexp "^(.*pdb[+]?) *")
1419 (setq comint-prompt-regexp "^(Pdb) *")
1420 (setq paragraph-start comint-prompt-regexp)
1421 (run-hooks 'pdb-mode-hook))
1422 \f
1423 ;; ======================================================================
1424 ;;
1425 ;; JDB support.
1426 ;;
1427 ;; AUTHOR: Derek Davies <ddavies@world.std.com>
1428 ;;
1429 ;; CREATED: Sun Feb 22 10:46:38 1998 Derek Davies.
1430 ;;
1431 ;; INVOCATION NOTES:
1432 ;;
1433 ;; You invoke jdb-mode with:
1434 ;;
1435 ;; M-x jdb <enter>
1436 ;;
1437 ;; It responds with:
1438 ;;
1439 ;; Run jdb (like this): jdb
1440 ;;
1441 ;; type any jdb switches followed by the name of the class you'd like to debug.
1442 ;; Supply a fully qualfied classname (these do not have the ".class" extension)
1443 ;; for the name of the class to debug (e.g. "COM.the-kind.ddavies.CoolClass").
1444 ;; See the known problems section below for restrictions when specifying jdb
1445 ;; command line switches (search forward for '-classpath').
1446 ;;
1447 ;; You should see something like the following:
1448 ;;
1449 ;; Current directory is ~/src/java/hello/
1450 ;; Initializing jdb...
1451 ;; 0xed2f6628:class(hello)
1452 ;; >
1453 ;;
1454 ;; To set an initial breakpoint try:
1455 ;;
1456 ;; > stop in hello.main
1457 ;; Breakpoint set in hello.main
1458 ;; >
1459 ;;
1460 ;; To execute the program type:
1461 ;;
1462 ;; > run
1463 ;; run hello
1464 ;;
1465 ;; Breakpoint hit: running ...
1466 ;; hello.main (hello:12)
1467 ;;
1468 ;; Type M-n to step over the current line and M-s to step into it. That,
1469 ;; along with the JDB 'help' command should get you started. The 'quit'
1470 ;; JDB command will get out out of the debugger. There is some truly
1471 ;; pathetic JDB documentation available at:
1472 ;;
1473 ;; http://java.sun.com/products/jdk/1.1/debugging/
1474 ;;
1475 ;; KNOWN PROBLEMS AND FIXME's:
1476 ;;
1477 ;; Not sure what happens with inner classes ... haven't tried them.
1478 ;;
1479 ;; Does not grok UNICODE id's. Only ASCII id's are supported.
1480 ;;
1481 ;; You must not put whitespace between "-classpath" and the path to
1482 ;; search for java classes even though it is required when invoking jdb
1483 ;; from the command line. See gud-jdb-massage-args for details.
1484 ;;
1485 ;; If any of the source files in the directories listed in
1486 ;; gud-jdb-directories won't parse you'll have problems. Make sure
1487 ;; every file ending in ".java" in these directories parses without error.
1488 ;;
1489 ;; All the .java files in the directories in gud-jdb-directories are
1490 ;; syntactically analyzed each time gud jdb is invoked. It would be
1491 ;; nice to keep as much information as possible between runs. It would
1492 ;; be really nice to analyze the files only as neccessary (when the
1493 ;; source needs to be displayed.) I'm not sure to what extent the former
1494 ;; can be accomplished and I'm not sure the latter can be done at all
1495 ;; since I don't know of any general way to tell which .class files are
1496 ;; defined by which .java file without analyzing all the .java files.
1497 ;; If anyone knows why JavaSoft didn't put the source file names in
1498 ;; debuggable .class files please clue me in so I find something else
1499 ;; to be spiteful and bitter about.
1500 ;;
1501 ;; ======================================================================
1502 ;; gud jdb variables and functions
1504 ;; History of argument lists passed to jdb.
1505 (defvar gud-jdb-history nil)
1507 ;; List of Java source file directories.
1508 (defvar gud-jdb-directories (list ".")
1509 "*A list of directories that gud jdb should search for source code.
1510 The file names should be absolute, or relative to the current
1511 directory.
1513 The set of .java files residing in the directories listed are
1514 syntactically analyzed to determine the classes they define and the
1515 packages in which these classes belong. In this way gud jdb maps the
1516 package-qualified class names output by the jdb debugger to the source
1517 file from which the class originated. This allows gud mode to keep
1518 the source code display in sync with the debugging session.")
1520 ;; List of the java source files for this debugging session.
1521 (defvar gud-jdb-source-files nil)
1523 ;; Association list of fully qualified class names (package + class name) and
1524 ;; their source files.
1525 (defvar gud-jdb-class-source-alist nil)
1527 ;; This is used to hold a source file during analysis.
1528 (defvar gud-jdb-analysis-buffer nil)
1530 ;; Return a list of java source files. PATH gives the directories in
1531 ;; which to search for files with extension EXTN. Normally EXTN is
1533 (defun gud-jdb-build-source-files-list (path extn)
1534 (apply 'nconc (mapcar (lambda (d)
1535 (when (file-directory-p d)
1536 (directory-files d t extn nil)) path))))
1538 ;; Move point past whitespace.
1539 (defun gud-jdb-skip-whitespace ()
1542 ;; Move point past a "// <eol>" type of comment.
1543 (defun gud-jdb-skip-single-line-comment ()
1544 (end-of-line))
1546 ;; Move point past a "/* */" or "/** */" type of comment.
1547 (defun gud-jdb-skip-traditional-or-documentation-comment ()
1548 (forward-char 2)
1549 (catch 'break
1550 (while (not (eobp))
1551 (if (eq (following-char) ?*)
1552 (progn
1553 (forward-char)
1554 (if (not (eobp))
1555 (if (eq (following-char) ?/)
1556 (progn
1557 (forward-char)
1558 (throw 'break nil)))))
1559 (forward-char)))))
1561 ;; Move point past any number of consecutive whitespace chars and/or comments.
1562 (defun gud-jdb-skip-whitespace-and-comments ()
1563 (gud-jdb-skip-whitespace)
1564 (catch 'done
1565 (while t
1566 (cond
1567 ((looking-at "//")
1568 (gud-jdb-skip-single-line-comment)
1569 (gud-jdb-skip-whitespace))
1571 (gud-jdb-skip-traditional-or-documentation-comment)
1572 (gud-jdb-skip-whitespace))
1573 (t (throw 'done nil))))))
1575 ;; Move point past things that are id-like. The intent is to skip regular
1576 ;; id's, such as class or interface names as well as package and interface
1577 ;; names.
1578 (defun gud-jdb-skip-id-ish-thing ()
1581 ;; Move point past a string literal.
1582 (defun gud-jdb-skip-string-literal ()
1583 (forward-char)
1584 (while (not (cond
1586 (forward-char))
1588 (forward-char))
1589 (forward-char))
1591 ;; Move point past a character literal.
1592 (defun gud-jdb-skip-character-literal ()
1593 (forward-char)
1594 (while
1595 (progn
1597 (forward-char 2))
1599 (forward-char))
1600 (forward-char))
1602 ;; Move point past the following block. There may be (legal) cruft before
1603 ;; the block's opening brace. There must be a block or it's the end of life
1604 ;; in petticoat junction.
1605 (defun gud-jdb-skip-block ()
1607 ;; Find the begining of the block.
1608 (while
1609 (not (eq (following-char) ?{))
1611 ;; Skip any constructs that can harbor literal block delimiter
1612 ;; characters and/or the delimiters for the constructs themselves.
1613 (cond
1614 ((looking-at "//")
1615 (gud-jdb-skip-single-line-comment))
1617 (gud-jdb-skip-traditional-or-documentation-comment))
1619 (gud-jdb-skip-string-literal))
1621 (gud-jdb-skip-character-literal))
1622 (t (forward-char))))
1624 ;; Now at the begining of the block.
1625 (forward-char)
1627 ;; Skip over the body of the block as well as the final brace.
1628 (let ((open-level 1))
1629 (while (not (eq open-level 0))
1630 (cond
1631 ((looking-at "//")
1632 (gud-jdb-skip-single-line-comment))
1634 (gud-jdb-skip-traditional-or-documentation-comment))
1636 (gud-jdb-skip-string-literal))
1638 (gud-jdb-skip-character-literal))
1639 ((eq (following-char) ?{)
1640 (setq open-level (+ open-level 1))
1641 (forward-char))
1642 ((eq (following-char) ?})
1643 (setq open-level (- open-level 1))
1644 (forward-char))
1645 (t (forward-char))))))
1647 ;; Find the package and class definitions in Java source file FILE. Assumes
1648 ;; that FILE contains a legal Java program. BUF is a scratch buffer used
1649 ;; to hold the source during analysis.
1650 (defun gud-jdb-analyze-source (buf file)
1651 (let ((l nil))
1652 (set-buffer buf)
1653 (insert-file-contents file nil nil nil t)
1654 (goto-char 0)
1655 (catch 'abort
1656 (let ((p ""))
1657 (while (progn
1658 (gud-jdb-skip-whitespace)
1659 (not (eobp)))
1660 (cond
1662 ;; Any number of semi's following a block is legal. Move point
1663 ;; past them. Note that comments and whitespace may be
1664 ;; interspersed as well.
1666 (forward-char))
1668 ;; Move point past a single line comment.
1669 ((looking-at "//")
1670 (gud-jdb-skip-single-line-comment))
1672 ;; Move point past a traditional or documentation comment.
1674 (gud-jdb-skip-traditional-or-documentation-comment))
1676 ;; Move point past a package statement, but save the PackageName.
1677 ((looking-at "package")
1678 (forward-char 7)
1679 (gud-jdb-skip-whitespace-and-comments)
1680 (let ((s (point)))
1681 (gud-jdb-skip-id-ish-thing)
1682 (setq p (concat (buffer-substring s (point)) "."))
1683 (gud-jdb-skip-whitespace-and-comments)
1685 (forward-char))))
1687 ;; Move point past an import statement.
1688 ((looking-at "import")
1689 (forward-char 6)
1690 (gud-jdb-skip-whitespace-and-comments)
1691 (gud-jdb-skip-id-ish-thing)
1692 (gud-jdb-skip-whitespace-and-comments)
1694 (forward-char)))
1696 ;; Move point past the various kinds of ClassModifiers.
1697 ((looking-at "public")
1698 (forward-char 6))
1699 ((looking-at "abstract")
1700 (forward-char 8))
1701 ((looking-at "final")
1702 (forward-char 5))
1704 ;; Move point past a ClassDeclaraction, but save the class
1705 ;; Identifier.
1706 ((looking-at "class")
1707 (forward-char 5)
1708 (gud-jdb-skip-whitespace-and-comments)
1709 (let ((s (point)))
1710 (gud-jdb-skip-id-ish-thing)
1711 (setq
1712 l (nconc l (list (concat p (buffer-substring s (point)))))))
1713 (gud-jdb-skip-block))
1715 ;; Move point past an interface statement.
1716 ((looking-at "interface")
1717 (forward-char 9)
1718 (gud-jdb-skip-block))
1720 ;; Anything else means the input is invalid.
1721 (t
1722 (message (format "Error parsing file %s." file))
1723 (throw 'abort nil))))))
1724 l))
1726 (defun gud-jdb-build-class-source-alist-for-file (file)
1727 (mapcar
1728 (lambda (c)
1729 (cons c file))
1730 (gud-jdb-analyze-source gud-jdb-analysis-buffer file)))
1732 ;; Return an alist of fully qualified classes and the source files
1733 ;; holding their definitions. SOURCES holds a list of all the source
1734 ;; files to examine.
1735 (defun gud-jdb-build-class-source-alist (sources)
1736 (setq gud-jdb-analysis-buffer (get-buffer-create " *gud-jdb-scratch*"))
1737 (prog1
1738 (apply
1739 'nconc
1740 (mapcar
1741 'gud-jdb-build-class-source-alist-for-file
1742 sources))
1743 (kill-buffer gud-jdb-analysis-buffer)
1744 (setq gud-jdb-analysis-buffer nil)))
1746 ;; Change what was given in the minibuffer to something that can be used to
1747 ;; invoke the debugger.
1748 (defun gud-jdb-massage-args (file args)
1749 ;; The jdb executable must have whitespace between "-classpath" and
1750 ;; its value while gud-common-init expects all switch values to
1751 ;; follow the switch keyword without intervening whitespace. We
1752 ;; require that when the user enters the "-classpath" switch in the
1753 ;; EMACS minibuffer that they do so without the intervening
1754 ;; whitespace. This function adds it back (it's called after
1755 ;; gud-common-init). There are more switches like this (for
1756 ;; instance "-host" and "-password") but I don't care about them
1757 ;; yet.
1758 (if args
1759 (let (massaged-args user-error)
1761 (while
1762 (and args
1764 (not (setq user-error
1765 (string-match "-classpath$" (car args)))))
1766 (setq massaged-args (append massaged-args (list (car args))))
1767 (setq args (cdr args)))
1769 ;; By this point the current directory is all screwed up. Maybe we
1770 ;; could fix things and re-invoke gud-common-init, but for now I think
1771 ;; issueing the error is good enough.
1772 (if user-error
1773 (progn
1774 (kill-buffer (current-buffer))
1775 (error "Error: Omit whitespace between '-classpath' and its value")))
1777 (if args
1778 (setq massaged-args
1779 (append
1780 massaged-args
1781 (list "-classpath")
1782 (list
1783 (substring
1784 (car args)
1785 (match-beginning 1) (match-end 1)))
1786 (cdr args)))
1787 massaged-args))))
1789 ;; Search for an association with P, a fully qualified class name, in
1790 ;; gud-jdb-class-source-alist. The asssociation gives the fully
1791 ;; qualified file name of the source file which produced the class.
1792 (defun gud-jdb-find-source-file (p)
1793 (cdr (assoc p gud-jdb-class-source-alist)))
1795 ;; See comentary for other debugger's marker filters - there you will find
1796 ;; important notes about STRING.
1797 (defun gud-jdb-marker-filter (string)
1799 ;; Build up the accumulator.
1800 (setq gud-marker-acc
1801 (if gud-marker-acc
1802 (concat gud-marker-acc string)
1803 string))
1805 ;; We process STRING from left to right. Each time through the following
1806 ;; loop we process at most one marker. The start variable keeps track of
1807 ;; where we are in the input string through the iterations of this loop.
1808 (let (start file-found)
1810 ;; Process each complete marker in the input. There may be an incomplete
1811 ;; marker at the end of the input string. Incomplete markers are left
1812 ;; in the accumulator for processing the next time the function is called.
1813 (while
1815 ;; Do we see a marker?
1816 (string-match
1817 ;; jdb puts out a string of the following form when it
1818 ;; hits a breakpoint:
1819 ;;
1820 ;; <fully-qualified-class><method> (<class>:<line-number>)
1821 ;;
1822 ;; <fully-qualified-class>'s are composed of Java ID's
1823 ;; separated by periods. <method> and <class> are
1824 ;; also Java ID's. <method> begins with a period and
1825 ;; may contain less-than and greater-than (constructors,
1826 ;; for instance, are called <init> in the symbol table.)
1827 ;; Java ID's begin with a letter followed by letters
1828 ;; and/or digits. The set of letters includes underscore
1829 ;; and dollar sign.
1830 ;;
1831 ;; The first group matches <fully-qualified-class>,
1832 ;; the second group matches <class> and the third group
1833 ;; matches <line-number>. We don't care about using
1834 ;; <method> so we don't "group" it.
1835 ;;
1836 ;; FIXME: Java ID's are UNICODE strings, this matches ASCII
1837 ;; ID's only.
1839 gud-marker-acc start)
1841 ;; Figure out the line on which to position the debugging arrow.
1842 ;; Return the info as a cons of the form:
1843 ;;
1844 ;; (<file-name> . <line-number>) .
1845 (if (setq
1846 file-found
1847 (gud-jdb-find-source-file
1848 (substring gud-marker-acc
1849 (match-beginning 1)
1850 (match-end 1))))
1851 (setq gud-last-frame
1852 (cons
1853 file-found
1854 (string-to-int
1855 (substring gud-marker-acc
1856 (match-beginning 3)
1857 (match-end 3)))))
1858 (message "Could not find source file."))
1860 ;; Set start after the last character of STRING that we've looked at
1861 ;; and loop to look for another marker.
1862 (setq start (match-end 0))))
1864 ;; We don't filter any debugger output so just return what we were given.
1865 string)
1867 (defun gud-jdb-find-file (f)
1868 (and (file-readable-p f)
1869 (find-file-noselect f)))
1871 (defvar gud-jdb-command-name "jdb" "Command that executes the Java debugger.")
1873 ;;;###autoload
1874 (defun jdb (command-line)
1875 "Run jdb with command line COMMAND-LINE in a buffer. The buffer is named
1878 between it and it's value."
1879 (interactive
1880 (list (gud-query-cmdline 'jdb)))
1882 (gud-common-init command-line 'gud-jdb-massage-args
1883 'gud-jdb-marker-filter 'gud-jdb-find-file)
1884 (set (make-local-variable 'gud-minor-mode) 'jdb)
1886 (gud-def gud-break "stop at %F:%l" "\C-b" "Set breakpoint at current line.")
1887 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
1888 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
1889 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
1890 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
1893 (setq paragraph-start comint-prompt-regexp)
1894 (run-hooks 'jdb-mode-hook)
1896 ;; Create and bind the class/source association list as well as the source
1897 ;; file list.
1898 (setq
1899 gud-jdb-class-source-alist
1900 (gud-jdb-build-class-source-alist
1901 (setq
1902 gud-jdb-source-files
1904 \f
1906 ;;
1907 ;; End of debugger-specific information
1908 ;;
1910 \f
1911 ;;; When we send a command to the debugger via gud-call, it's annoying
1912 ;;; to see the command and the new prompt inserted into the debugger's
1913 ;;; buffer; we have other ways of knowing the command has completed.
1914 ;;;
1915 ;;; If the buffer looks like this:
1916 ;;; --------------------
1917 ;;; (gdb) set args foo bar
1918 ;;; (gdb) -!-
1919 ;;; --------------------
1920 ;;; (the -!- marks the location of point), and we type `C-x SPC' in a
1921 ;;; source file to set a breakpoint, we want the buffer to end up like
1922 ;;; this:
1923 ;;; --------------------
1924 ;;; (gdb) set args foo bar
1925 ;;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
1926 ;;; (gdb) -!-
1927 ;;; --------------------
1928 ;;; Essentially, the old prompt is deleted, and the command's output
1929 ;;; and the new prompt take its place.
1930 ;;;
1931 ;;; Not echoing the command is easy enough; you send it directly using
1932 ;;; process-send-string, and it never enters the buffer. However,
1933 ;;; getting rid of the old prompt is trickier; you don't want to do it
1934 ;;; when you send the command, since that will result in an annoying
1935 ;;; flicker as the prompt is deleted, redisplay occurs while Emacs
1936 ;;; waits for a response from the debugger, and the new prompt is
1937 ;;; inserted. Instead, we'll wait until we actually get some output
1938 ;;; from the subprocess before we delete the prompt. If the command
1939 ;;; produced no output other than a new prompt, that prompt will most
1940 ;;; likely be in the first chunk of output received, so we will delete
1941 ;;; the prompt and then replace it with an identical one. If the
1942 ;;; command produces output, the prompt is moving anyway, so the
1943 ;;; flicker won't be annoying.
1944 ;;;
1945 ;;; So - when we want to delete the prompt upon receipt of the next
1946 ;;; chunk of debugger output, we position gud-delete-prompt-marker at
1947 ;;; the start of the prompt; the process filter will notice this, and
1948 ;;; delete all text between it and the process output marker. If
1949 ;;; gud-delete-prompt-marker points nowhere, we leave the current
1950 ;;; prompt alone.
1951 (defvar gud-delete-prompt-marker nil)
1953 \f
1954 (put 'gud-mode 'mode-class 'special)
1956 (define-derived-mode gud-mode comint-mode "Debugger"
1957 "Major mode for interacting with an inferior debugger process.
1959 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
1960 M-x perldb, or M-x xdb. Each entry point finishes by executing a
1961 hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook',
1962 `perldb-mode-hook', or `xdb-mode-hook' respectively.
1964 After startup, the following commands are available in both the GUD
1965 interaction buffer and any source buffer GUD visits due to a breakpoint stop
1966 or step operation:
1969 GUD buffer, the current file and line are those of the last breakpoint or
1970 step. In a source buffer, they are the buffer's file and current line.
1975 in the gud buffer.
1978 step-one-line (not entering function calls), and step-one-instruction
1979 and then update the source window with the current file and position.
1983 around point, and sends it to the debugger for value display.
1985 The above commands are common to all supported debuggers except xdb which
1986 does not support stepping instructions.
1989 except that the breakpoint is temporary; that is, it is removed when
1990 execution stops on it.
1996 the current function and stops.
1998 All the keystrokes above are accessible in the GUD buffer
1999 with the prefix C-c, and in all buffers through the prefix C-x C-a.
2001 All pre-defined functions for which the concept make sense repeat
2002 themselves the appropriate number of times if you give a prefix
2003 argument.
2005 You may use the `gud-def' macro in the initialization hook to define other
2006 commands.
2008 Other commands for interacting with the debugger process are inherited from
2009 comint mode, which see."
2010 (setq mode-line-process '(":%s"))
2011 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
2012 (set (make-local-variable 'gud-last-frame) nil)
2013 (make-local-variable 'comint-prompt-regexp)
2014 ;; Don't put repeated commands in command history many times.
2015 (set (make-local-variable 'comint-input-ignoredups) t)
2016 (make-local-variable 'paragraph-start)
2017 (set (make-local-variable 'gud-delete-prompt-marker) (make-marker)))
2019 ;; Cause our buffers to be displayed, by default,
2020 ;; in the selected window.
2023 ;; Perform initializations common to all debuggers.
2024 ;; The first arg is the specified command line,
2025 ;; which starts with the program to debug.
2026 ;; The other three args specify the values to use
2027 ;; for local variables in the debugger buffer.
2028 (defun gud-common-init (command-line massage-args marker-filter find-file)
2029 (let* ((words (split-string command-line))
2030 (program (car words))
2031 ;; Extract the file name from WORDS
2032 ;; and put t in its place.
2033 ;; Later on we will put the modified file name arg back there.
2034 (file-word (let ((w (cdr words)))
2035 (while (and w (= ?- (aref (car w) 0)))
2036 (setq w (cdr w)))
2037 (and w
2038 (prog1 (car w)
2039 (setcar w t)))))
2040 (file-subst
2041 (and file-word (substitute-in-file-name file-word)))
2042 (args (cdr words))
2043 ;; If a directory was specified, expand the file name.
2044 ;; Otherwise, don't expand it, so GDB can use the PATH.
2045 ;; A file name without directory is literally valid
2046 ;; only if the file exists in ., and in that case,
2047 ;; omitting the expansion here has no visible effect.
2048 (file (and file-word
2049 (if (file-name-directory file-subst)
2050 (expand-file-name file-subst)
2051 file-subst)))
2052 (filepart (and file-word (concat "-" (file-name-nondirectory file)))))
2053 (pop-to-buffer (concat "*gud" filepart "*"))
2054 ;; Set default-directory to the file's directory.
2055 (and file-word
2056 ;; Don't set default-directory if no directory was specified.
2057 ;; In that case, either the file is found in the current directory,
2058 ;; in which case this setq is a no-op,
2059 ;; or it is found by searching PATH,
2060 ;; in which case we don't know what directory it was found in.
2061 (file-name-directory file)
2062 (setq default-directory (file-name-directory file)))
2063 (or (bolp) (newline))
2065 ;; Put the substituted and expanded file name back in its place.
2066 (let ((w args))
2067 (while (and w (not (eq (car w) t)))
2068 (setq w (cdr w)))
2069 (if w
2070 (setcar w file)))
2071 (apply 'make-comint (concat "gud" filepart) program nil
2072 (funcall massage-args file args)))
2073 ;; Since comint clobbered the mode, we don't set it until now.
2074 (gud-mode)
2075 (make-local-variable 'gud-marker-filter)
2076 (setq gud-marker-filter marker-filter)
2077 (make-local-variable 'gud-find-file)
2078 (setq gud-find-file find-file)
2080 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
2081 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
2082 (gud-set-buffer))
2084 (defun gud-set-buffer ()
2085 (when (eq major-mode 'gud-mode)
2086 (setq gud-comint-buffer (current-buffer))))
2088 (defvar gud-filter-defer-flag nil
2089 "Non-nil means don't process anything from the debugger right now.
2090 It is saved for when this flag is not set.")
2092 (defvar gud-filter-pending-text nil
2093 "Non-nil means this is text that has been saved for later in `gud-filter'.")
2095 ;; These functions are responsible for inserting output from your debugger
2096 ;; into the buffer. The hard work is done by the method that is
2097 ;; the value of gud-marker-filter.
2099 (defun gud-filter (proc string)
2100 ;; Here's where the actual buffer insertion is done
2101 (let (output process-window)
2102 (if (buffer-name (process-buffer proc))
2103 (if gud-filter-defer-flag
2104 ;; If we can't process any text now,
2105 ;; save it for later.
2106 (setq gud-filter-pending-text
2107 (concat (or gud-filter-pending-text "") string))
2109 ;; If we have to ask a question during the processing,
2110 ;; defer any additional text that comes from the debugger
2111 ;; during that time.
2112 (let ((gud-filter-defer-flag t))
2113 ;; Process now any text we previously saved up.
2114 (if gud-filter-pending-text
2115 (setq string (concat gud-filter-pending-text string)
2116 gud-filter-pending-text nil))
2118 (with-current-buffer (process-buffer proc)
2119 ;; If we have been so requested, delete the debugger prompt.
2120 (save-restriction
2121 (widen)
2122 (if (marker-buffer gud-delete-prompt-marker)
2123 (progn
2124 (delete-region (process-mark proc)
2125 gud-delete-prompt-marker)
2126 (set-marker gud-delete-prompt-marker nil)))
2127 ;; Save the process output, checking for source file markers.
2128 (setq output (gud-marker-filter string))
2129 ;; Check for a filename-and-line number.
2130 ;; Don't display the specified file
2131 ;; unless (1) point is at or after the position where output appears
2132 ;; and (2) this buffer is on the screen.
2133 (setq process-window
2134 (and gud-last-frame
2135 (>= (point) (process-mark proc))
2136 (get-buffer-window (current-buffer)))))
2138 ;; Let the comint filter do the actual insertion.
2139 ;; That lets us inherit various comint features.
2140 (comint-output-filter proc output))
2142 ;; Put the arrow on the source line.
2143 ;; This must be outside of the save-excursion
2144 ;; in case the source file is our current buffer.
2145 (if process-window
2146 (save-selected-window
2147 (select-window process-window)
2148 (gud-display-frame))
2149 ;; We have to be in the proper buffer, (process-buffer proc),
2150 ;; but not in a save-excursion, because that would restore point.
2151 (let ((old-buf (current-buffer)))
2152 (set-buffer (process-buffer proc))
2153 (unwind-protect
2154 (gud-display-frame)
2155 (set-buffer old-buf)))))
2157 ;; If we deferred text that arrived during this processing,
2158 ;; handle it now.
2159 (if gud-filter-pending-text
2160 (gud-filter proc ""))))))
2162 (defun gud-sentinel (proc msg)
2163 (cond ((null (buffer-name (process-buffer proc)))
2164 ;; buffer killed
2165 ;; Stop displaying an arrow in a source file.
2166 (setq overlay-arrow-position nil)
2167 (set-process-buffer proc nil))
2168 ((memq (process-status proc) '(signal exit))
2169 ;; Stop displaying an arrow in a source file.
2170 (setq overlay-arrow-position nil)
2171 (let* ((obuf (current-buffer)))
2172 ;; save-excursion isn't the right thing if
2173 ;; process-buffer is current-buffer
2174 (unwind-protect
2175 (progn
2176 ;; Write something in *compilation* and hack its mode line,
2177 (set-buffer (process-buffer proc))
2178 ;; Fix the mode line.
2179 (setq mode-line-process
2180 (concat ":"
2181 (symbol-name (process-status proc))))
2182 (force-mode-line-update)
2183 (if (eobp)
2185 (save-excursion
2186 (goto-char (point-max))
2188 ;; If buffer and mode line will show that the process
2189 ;; is dead, we can delete it now. Otherwise it
2190 ;; will stay around until M-x list-processes.
2191 (delete-process proc))
2192 ;; Restore old buffer, but don't restore old point
2193 ;; if obuf is the gud buffer.
2194 (set-buffer obuf))))))
2196 (defun gud-display-frame ()
2197 "Find and obey the last filename-and-line marker from the debugger.
2198 Obeying it means displaying in another window the specified file and line."
2199 (interactive)
2200 (if gud-last-frame
2201 (progn
2202 (gud-set-buffer)
2203 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
2204 (setq gud-last-last-frame gud-last-frame
2205 gud-last-frame nil))))
2207 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
2208 ;; and that its line LINE is visible.
2209 ;; Put the overlay-arrow on the line LINE in that buffer.
2210 ;; Most of the trickiness in here comes from wanting to preserve the current
2211 ;; region-restriction if that's possible. We use an explicit display-buffer
2212 ;; to get around the fact that this is called inside a save-excursion.
2214 (defun gud-display-line (true-file line)
2215 (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
2216 (buffer
2217 (save-excursion
2218 (or (eq (current-buffer) gud-comint-buffer)
2219 (set-buffer gud-comint-buffer))
2220 (gud-find-file true-file)))
2221 (window (and buffer (or (get-buffer-window buffer)
2222 (display-buffer buffer))))
2223 (pos))
2224 (if buffer
2225 (progn
2226 (save-excursion
2227 (set-buffer buffer)
2228 (save-restriction
2229 (widen)
2230 (goto-line line)
2231 (setq pos (point))
2232 (setq overlay-arrow-string "=>")
2233 (or overlay-arrow-position
2234 (setq overlay-arrow-position (make-marker)))
2235 (set-marker overlay-arrow-position (point) (current-buffer)))
2236 (cond ((or (< pos (point-min)) (> pos (point-max)))
2237 (widen)
2238 (goto-char pos))))
2239 (set-window-point window overlay-arrow-position)))))
2241 ;;; The gud-call function must do the right thing whether its invoking
2242 ;;; keystroke is from the GUD buffer itself (via major-mode binding)
2243 ;;; or a C buffer. In the former case, we want to supply data from
2244 ;;; gud-last-frame. Here's how we do it:
2246 (defun gud-format-command (str arg)
2247 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
2248 (frame (or gud-last-frame gud-last-last-frame))
2249 result)
2251 (let ((key (string-to-char (substring str (match-beginning 2))))
2252 subst)
2253 (cond
2254 ((eq key ?f)
2255 (setq subst (file-name-nondirectory (if insource
2256 (buffer-file-name)
2257 (car frame)))))
2258 ((eq key ?F)
2259 (setq subst (file-name-sans-extension
2260 (file-name-nondirectory (if insource
2261 (buffer-file-name)
2262 (car frame))))))
2263 ((eq key ?d)
2264 (setq subst (file-name-directory (if insource
2265 (buffer-file-name)
2266 (car frame)))))
2267 ((eq key ?l)
2268 (setq subst (if insource
2269 (save-excursion
2270 (beginning-of-line)
2271 (save-restriction
2272 (widen)
2273 (int-to-string (1+ (count-lines 1 (point))))))
2274 (cdr frame))))
2275 ((eq key ?e)
2276 (setq subst (gud-find-c-expr)))
2277 ((eq key ?a)
2278 (setq subst (gud-read-address)))
2279 ((eq key ?p)
2280 (setq subst (if arg (int-to-string arg)))))
2281 (setq result (concat result (match-string 1 str) subst)))
2282 (setq str (substring str (match-end 2))))
2283 ;; There might be text left in STR when the loop ends.
2284 (concat result str)))
2286 (defun gud-read-address ()
2287 "Return a string containing the core-address found in the buffer at point."
2288 (save-excursion
2289 (let ((pt (point)) found begin)
2290 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
2291 (cond
2292 (found (forward-char 2)
2293 (buffer-substring found
2294 (progn (re-search-forward "[^0-9a-f]")
2295 (forward-char -1)
2296 (point))))
2297 (t (setq begin (progn (re-search-backward "[^0-9]")
2298 (forward-char 1)
2299 (point)))
2300 (forward-char 1)
2301 (re-search-forward "[^0-9]")
2302 (forward-char -1)
2303 (buffer-substring begin (point)))))))
2305 (defun gud-call (fmt &optional arg)
2306 (let ((msg (gud-format-command fmt arg)))
2307 (message "Command: %s" msg)
2308 (sit-for 0)
2309 (gud-basic-call msg)))
2311 (defun gud-basic-call (command)
2312 "Invoke the debugger COMMAND displaying source in other window."
2313 (interactive)
2314 (gud-set-buffer)
2316 (proc (get-buffer-process gud-comint-buffer)))
2317 (or proc (error "Current buffer has no process"))
2318 ;; Arrange for the current prompt to get deleted.
2319 (save-excursion
2320 (set-buffer gud-comint-buffer)
2321 (save-restriction
2322 (widen)
2323 (goto-char (process-mark proc))
2324 (forward-line 0)
2325 (if (looking-at comint-prompt-regexp)
2326 (set-marker gud-delete-prompt-marker (point)))))
2327 (process-send-string proc command)))
2329 (defun gud-refresh (&optional arg)
2330 "Fix up a possibly garbled display, and redraw the arrow."
2331 (interactive "P")
2332 (recenter arg)
2333 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
2334 (gud-display-frame))
2335 \f
2336 ;;; Code for parsing expressions out of C code. The single entry point is
2337 ;;; find-c-expr, which tries to return an lvalue expression from around point.
2338 ;;;
2339 ;;; The rest of this file is a hacked version of gdbsrc.el by
2340 ;;; Debby Ayers <ayers@asc.slb.com>,
2341 ;;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
2343 (defun gud-find-c-expr ()
2344 "Returns the C expr that surrounds point."
2345 (interactive)
2346 (save-excursion
2347 (let (p expr test-expr)
2348 (setq p (point))
2349 (setq expr (gud-innermost-expr))
2350 (setq test-expr (gud-prev-expr))
2351 (while (and test-expr (gud-expr-compound test-expr expr))
2352 (let ((prev-expr expr))
2353 (setq expr (cons (car test-expr) (cdr expr)))
2354 (goto-char (car expr))
2355 (setq test-expr (gud-prev-expr))
2356 ;; If we just pasted on the condition of an if or while,
2357 ;; throw it away again.
2358 (if (member (buffer-substring (car test-expr) (cdr test-expr))
2359 '("if" "while" "for"))
2360 (setq test-expr nil
2361 expr prev-expr))))
2362 (goto-char p)
2363 (setq test-expr (gud-next-expr))
2364 (while (gud-expr-compound expr test-expr)
2365 (setq expr (cons (car expr) (cdr test-expr)))
2366 (setq test-expr (gud-next-expr)))
2367 (buffer-substring (car expr) (cdr expr)))))
2369 (defun gud-innermost-expr ()
2370 "Returns the smallest expr that point is in; move point to beginning of it.
2371 The expr is represented as a cons cell, where the car specifies the point in
2372 the current buffer that marks the beginning of the expr and the cdr specifies
2373 the character after the end of the expr."
2374 (let ((p (point)) begin end)
2375 (gud-backward-sexp)
2376 (setq begin (point))
2377 (gud-forward-sexp)
2378 (setq end (point))
2379 (if (>= p end)
2380 (progn
2381 (setq begin p)
2382 (goto-char p)
2383 (gud-forward-sexp)
2384 (setq end (point)))
2385 )
2386 (goto-char begin)
2387 (cons begin end)))
2389 (defun gud-backward-sexp ()
2390 "Version of `backward-sexp' that catches errors."
2391 (condition-case nil
2392 (backward-sexp)
2393 (error t)))
2395 (defun gud-forward-sexp ()
2396 "Version of `forward-sexp' that catches errors."
2397 (condition-case nil
2398 (forward-sexp)
2399 (error t)))
2401 (defun gud-prev-expr ()
2402 "Returns the previous expr, point is set to beginning of that expr.
2403 The expr is represented as a cons cell, where the car specifies the point in
2404 the current buffer that marks the beginning of the expr and the cdr specifies
2405 the character after the end of the expr"
2406 (let ((begin) (end))
2407 (gud-backward-sexp)
2408 (setq begin (point))
2409 (gud-forward-sexp)
2410 (setq end (point))
2411 (goto-char begin)
2412 (cons begin end)))
2414 (defun gud-next-expr ()
2415 "Returns the following expr, point is set to beginning of that expr.
2416 The expr is represented as a cons cell, where the car specifies the point in
2417 the current buffer that marks the beginning of the expr and the cdr specifies
2418 the character after the end of the expr."
2419 (let ((begin) (end))
2420 (gud-forward-sexp)
2421 (gud-forward-sexp)
2422 (setq end (point))
2423 (gud-backward-sexp)
2424 (setq begin (point))
2425 (cons begin end)))
2427 (defun gud-expr-compound-sep (span-start span-end)
2428 "Scan from SPAN-START to SPAN-END for punctuation characters.
2429 If `->' is found, return `?.'. If `.' is found, return `?.'.
2430 If any other punctuation is found, return `??'.
2431 If no punctuation is found, return `? '."
2432 (let ((result ?\ )
2433 (syntax))
2434 (while (< span-start span-end)
2435 (setq syntax (char-syntax (char-after span-start)))
2436 (cond
2437 ((= syntax ?\ ) t)
2438 ((= syntax ?.) (setq syntax (char-after span-start))
2439 (cond
2440 ((= syntax ?.) (setq result ?.))
2441 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
2442 (setq result ?.)
2443 (setq span-start (+ span-start 1)))
2444 (t (setq span-start span-end)
2445 (setq result ??)))))
2446 (setq span-start (+ span-start 1)))
2447 result))
2449 (defun gud-expr-compound (first second)
2450 "Non-nil if concatenating FIRST and SECOND makes a single C expression.
2451 The two exprs are represented as a cons cells, where the car
2452 specifies the point in the current buffer that marks the beginning of the
2453 expr and the cdr specifies the character after the end of the expr.
2454 Link exprs of the form:
2455 Expr -> Expr
2456 Expr . Expr
2457 Expr (Expr)
2458 Expr [Expr]
2459 (Expr) Expr
2460 [Expr] Expr"
2461 (let ((span-start (cdr first))
2462 (span-end (car second))
2463 (syntax))
2464 (setq syntax (gud-expr-compound-sep span-start span-end))
2465 (cond
2466 ((= (car first) (car second)) nil)
2467 ((= (cdr first) (cdr second)) nil)
2468 ((= syntax ?.) t)
2469 ((= syntax ?\ )
2470 (setq span-start (char-after (- span-start 1)))
2471 (setq span-end (char-after span-end))
2472 (cond
2473 ((= span-start ?)) t)
2474 ((= span-start ?]) t)
2475 ((= span-end ?() t)
2476 ((= span-end ?[) t)
2477 (t nil)))
2478 (t nil))))
2480 (provide 'gud)
2482 ;;; gud.el ends here