1 ;;; gud.el --- Grand Unified Debugger mode for gdb, sdb, dbx, or xdb
4 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
7 ;; Keywords: unix, tools
9 ;; Copyright (C) 1992, 1993, 1994 Free Software Foundation, Inc.
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to
25 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, 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.
31 ;; Grand Unification (sdb/dbx support) by Eric S. Raymond <esr@thyrsus.com>
32 ;; The overloading code was then rewritten by Barry Warsaw <bwarsaw@cen.com>,
33 ;; who also hacked the mode to use comint.el. Shane Hartman <shane@spr.com>
34 ;; added support for xdb (HPUX debugger). Rick Sladkey <jrs@world.std.com>
35 ;; wrote the GDB command completion code. Dave Love <d.love@dl.ac.uk>
36 ;; added the IRIX kluge and re-implemented the Mips-ish variant.
43 ;; ======================================================================
44 ;; GUD commands must be visible in C buffers visited by GUD
46 (defvar gud-key-prefix "\C-x\C-a"
47 "Prefix of all GUD commands valid in C buffers.")
49 (global-set-key (concat gud-key-prefix "\C-l") 'gud-refresh)
50 (global-set-key "\C-x " 'gud-break) ;; backward compatibility hack
52 ;; ======================================================================
53 ;; the overloading mechanism
55 (defun gud-overload-functions (gud-overload-alist)
56 "Overload functions defined in GUD-OVERLOAD-ALIST.
57 This association list has elements of the form
58 (ORIGINAL-FUNCTION-NAME OVERLOAD-FUNCTION)"
60 (function (lambda (p) (fset (car p) (symbol-function (cdr p)))))
63 (defun gud-massage-args (file args)
64 (error "GUD not properly entered."))
66 (defun gud-marker-filter (str)
67 (error "GUD not properly entered."))
69 (defun gud-find-file (f)
70 (error "GUD not properly entered."))
72 ;; ======================================================================
75 ;; This macro is used below to define some basic debugger interface commands.
76 ;; Of course you may use `gud-def' with any other debugger command, including
79 ;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
80 ;; which defines FUNC to send the command NAME to the debugger, gives
81 ;; it the docstring DOC, and binds that function to KEY in the GUD
82 ;; major mode. The function is also bound in the global keymap with the
85 (defmacro gud-def (func cmd key &optional doc)
86 "Define FUNC to be a command sending STR and bound to KEY, with
87 optional doc string DOC. Certain %-escapes in the string arguments
88 are interpreted specially if present. These are:
90 %f name (without directory) of current source file.
91 %d directory of current source file.
92 %l number of current source line
93 %e text of the C lvalue or function-call expression surrounding point.
94 %a text of the hexadecimal address surrounding point
95 %p prefix argument to the command (if any) as a number
97 The `current' source file is the file of the current buffer (if
98 we're in a C file) or the source file current at the last break or
99 step (if we're in the GUD buffer).
100 The `current' line is that of the current buffer (if we're in a
101 source file) or the source line number at the last break or step (if
102 we're in the GUD buffer)."
104 (list 'defun func '(arg)
107 (list 'gud-call cmd 'arg))
114 (list 'global-set-key
115 (list 'concat 'gud-key-prefix key)
116 (list 'quote func)))))
118 ;; Where gud-display-frame should put the debugging arrow. This is
119 ;; set by the marker-filter, which scans the debugger's output for
120 ;; indications of the current program counter.
121 (defvar gud-last-frame nil)
123 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
124 ;; the last frame, even if it's been called before and gud-last-frame has
126 (defvar gud-last-last-frame nil)
128 ;; All debugger-specific information is collected here.
129 ;; Here's how it works, in case you ever need to add a debugger to the mode.
131 ;; Each entry must define the following at startup:
134 ;; comint-prompt-regexp
135 ;; gud-<name>-massage-args
136 ;; gud-<name>-marker-filter
137 ;; gud-<name>-find-file
139 ;; The job of the massage-args method is to modify the given list of
140 ;; debugger arguments before running the debugger.
142 ;; The job of the marker-filter method is to detect file/line markers in
143 ;; strings and set the global gud-last-frame to indicate what display
144 ;; action (if any) should be triggered by the marker. Note that only
145 ;; whatever the method *returns* is displayed in the buffer; thus, you
146 ;; can filter the debugger's output, interpreting some and passing on
149 ;; The job of the find-file method is to visit and return the buffer indicated
150 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
153 ;; ======================================================================
156 ;;; History of argument lists passed to gdb.
157 (defvar gud-gdb-history nil)
159 (defun gud-gdb-massage-args (file args)
160 (cons "-fullname" (cons file args)))
162 ;; There's no guarantee that Emacs will hand the filter the entire
163 ;; marker at once; it could be broken up across several strings. We
164 ;; might even receive a big chunk with several markers in it. If we
165 ;; receive a chunk of text which looks like it might contain the
166 ;; beginning of a marker, we save it here between calls to the
168 (defvar gud-marker-acc "")
169 (make-variable-buffer-local 'gud-marker-acc)
171 (defun gud-gdb-marker-filter (string)
173 (setq gud-marker-acc (concat gud-marker-acc string))
176 ;; Process all the complete markers in this chunk.
177 (while (string-match "^\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
181 ;; Extract the frame position from the marker.
183 (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
184 (string-to-int (substring gud-marker-acc
188 ;; Append any text before the marker to the output we're going
189 ;; to return - we don't include the marker in this text.
190 output (concat output
191 (substring gud-marker-acc 0 (match-beginning 0)))
193 ;; Set the accumulator to the remaining text.
194 gud-marker-acc (substring gud-marker-acc (match-end 0))))
196 ;; Does the remaining text look like it might end with the
197 ;; beginning of another marker? If it does, then keep it in
198 ;; gud-marker-acc until we receive the rest of it. Since we
199 ;; know the full marker regexp above failed, it's pretty simple to
200 ;; test for marker starts.
201 (if (string-match "^\032.*\\'" gud-marker-acc)
203 ;; Everything before the potential marker start can be output.
204 (setq output (concat output (substring gud-marker-acc
205 0 (match-beginning 0))))
207 ;; Everything after, we save, to combine with later input.
209 (substring gud-marker-acc (match-beginning 0))))
211 (setq output (concat output gud-marker-acc)
216 (defun gud-gdb-find-file (f)
217 (find-file-noselect f))
219 (defvar gdb-minibuffer-local-map nil
220 "Keymap for minibuffer prompting of gdb startup command.")
221 (if gdb-minibuffer-local-map
223 (setq gdb-minibuffer-local-map (copy-keymap minibuffer-local-map))
225 gdb-minibuffer-local-map "\C-i" 'comint-dynamic-complete-filename))
228 (defun gdb (command-line)
229 "Run gdb on program FILE in buffer *gud-FILE*.
230 The directory containing FILE becomes the initial working directory
231 and source-file directory for your debugger."
233 (list (read-from-minibuffer "Run gdb (like this): "
234 (if (consp gud-gdb-history)
235 (car gud-gdb-history)
237 gdb-minibuffer-local-map nil
238 '(gud-gdb-history . 1))))
239 (gud-overload-functions '((gud-massage-args . gud-gdb-massage-args)
240 (gud-marker-filter . gud-gdb-marker-filter)
241 (gud-find-file . gud-gdb-find-file)
244 (gud-common-init command-line)
246 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
247 (gud-def gud-tbreak "tbreak %f:%l" "\C-t" "Set breakpoint at current line.")
248 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
249 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
250 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
251 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
252 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
253 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
254 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
255 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
256 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
258 (local-set-key "\C-i" 'gud-gdb-complete-command)
259 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
260 (setq paragraph-start comint-prompt-regexp)
261 (run-hooks 'gdb-mode-hook)
264 ;; One of the nice features of GDB is its impressive support for
265 ;; context-sensitive command completion. We preserve that feature
266 ;; in the GUD buffer by using a GDB command designed just for Emacs.
268 ;; The completion process filter indicates when it is finished.
269 (defvar gud-gdb-complete-in-progress)
271 ;; Since output may arrive in fragments we accumulate partials strings here.
272 (defvar gud-gdb-complete-string)
274 ;; We need to know how much of the completion to chop off.
275 (defvar gud-gdb-complete-break)
277 ;; The completion list is constructed by the process filter.
278 (defvar gud-gdb-complete-list)
280 (defvar gud-comint-buffer nil)
282 (defun gud-gdb-complete-command ()
283 "Perform completion on the GDB command preceding point.
284 This is implemented using the GDB `complete' command which isn't
285 available with older versions of GDB."
288 (command (save-excursion
290 (and (looking-at comint-prompt-regexp)
291 (goto-char (match-end 0)))
292 (buffer-substring (point) end)))
294 ;; Find the word break. This match will always succeed.
295 (string-match "\\(\\`\\| \\)\\([^ ]*\\)\\'" command)
296 (setq gud-gdb-complete-break (match-beginning 2)
297 command-word (substring command gud-gdb-complete-break))
300 ;; Temporarily install our filter function.
301 (gud-overload-functions
302 '((gud-marker-filter . gud-gdb-complete-filter)))
303 ;; Issue the command to GDB.
304 (gud-basic-call (concat "complete " command))
305 (setq gud-gdb-complete-in-progress t
306 gud-gdb-complete-string nil
307 gud-gdb-complete-list nil)
309 (while gud-gdb-complete-in-progress
310 (accept-process-output (get-buffer-process gud-comint-buffer))))
311 ;; Restore the old filter function.
312 (gud-overload-functions '((gud-marker-filter . gud-gdb-marker-filter))))
313 ;; Protect against old versions of GDB.
314 (and gud-gdb-complete-list
315 (string-match "^Undefined command: \"complete\""
316 (car gud-gdb-complete-list))
317 (error "This version of GDB doesn't support the `complete' command."))
318 ;; Sort the list like readline.
319 (setq gud-gdb-complete-list
320 (sort gud-gdb-complete-list (function string-lessp)))
321 ;; Remove duplicates.
322 (let ((first gud-gdb-complete-list)
323 (second (cdr gud-gdb-complete-list)))
325 (if (string-equal (car first) (car second))
326 (setcdr first (setq second (cdr second)))
328 second (cdr second)))))
329 ;; Let comint handle the rest.
330 (comint-dynamic-simple-complete command-word gud-gdb-complete-list)))
332 ;; The completion process filter is installed temporarily to slurp the
333 ;; output of GDB up to the next prompt and build the completion list.
334 (defun gud-gdb-complete-filter (string)
335 (setq string (concat gud-gdb-complete-string string))
336 (while (string-match "\n" string)
337 (setq gud-gdb-complete-list
338 (cons (substring string gud-gdb-complete-break (match-beginning 0))
339 gud-gdb-complete-list))
340 (setq string (substring string (match-end 0))))
341 (if (string-match comint-prompt-regexp string)
343 (setq gud-gdb-complete-in-progress nil)
346 (setq gud-gdb-complete-string string)
350 ;; ======================================================================
353 ;;; History of argument lists passed to sdb.
354 (defvar gud-sdb-history nil)
356 (defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
357 "If nil, we're on a System V Release 4 and don't need the tags hack.")
359 (defvar gud-sdb-lastfile nil)
361 (defun gud-sdb-massage-args (file args)
364 (defun gud-sdb-marker-filter (string)
366 ;; System V Release 3.2 uses this format
367 ((string-match "\\(^0x\\w* in \\|^\\|\n\\)\\([^:\n]*\\):\\([0-9]*\\):.*\n"
371 (substring string (match-beginning 2) (match-end 2))
373 (substring string (match-beginning 3) (match-end 3))))))
374 ;; System V Release 4.0
375 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n"
377 (setq gud-sdb-lastfile
378 (substring string (match-beginning 2) (match-end 2))))
379 ((and gud-sdb-lastfile (string-match "^\\([0-9]+\\):" string))
384 (substring string (match-beginning 1) (match-end 1))))))
386 (setq gud-sdb-lastfile nil)))
389 (defun gud-sdb-find-file (f)
390 (if gud-sdb-needs-tags
391 (find-tag-noselect f)
392 (find-file-noselect f)))
395 (defun sdb (command-line)
396 "Run sdb on program FILE in buffer *gud-FILE*.
397 The directory containing FILE becomes the initial working directory
398 and source-file directory for your debugger."
400 (list (read-from-minibuffer "Run sdb (like this): "
401 (if (consp gud-sdb-history)
402 (car gud-sdb-history)
405 '(gud-sdb-history . 1))))
406 (if (and gud-sdb-needs-tags
407 (not (and (boundp 'tags-file-name) (file-exists-p tags-file-name))))
408 (error "The sdb support requires a valid tags table to work."))
409 (gud-overload-functions '((gud-massage-args . gud-sdb-massage-args)
410 (gud-marker-filter . gud-sdb-marker-filter)
411 (gud-find-file . gud-sdb-find-file)
414 (gud-common-init command-line)
416 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
417 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
418 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
419 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
420 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
421 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
422 (gud-def gud-cont "c" "\C-r" "Continue with display.")
423 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
425 (setq comint-prompt-regexp "\\(^\\|\n\\)\\*")
426 (setq paragraph-start comint-prompt-regexp)
427 (run-hooks 'sdb-mode-hook)
430 ;; ======================================================================
433 ;;; History of argument lists passed to dbx.
434 (defvar gud-dbx-history nil)
436 (defun gud-dbx-massage-args (file args)
439 (defun gud-dbx-marker-filter (string)
440 (if (or (string-match
441 "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
444 "signal .* in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
448 (substring string (match-beginning 2) (match-end 2))
450 (substring string (match-beginning 1) (match-end 1))))))
453 ;; Functions for Mips-style dbx. Given the option `-emacs', documented in
454 ;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
456 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
457 ;; We haven't tested gud on this system:
458 (string-match "^mips-[^-]*-riscos" system-configuration)
459 ;; It's documented on OSF/1.3
460 (string-match "^mips-[^-]*-osf1" system-configuration))
461 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
463 (defun gud-mipsdbx-massage-args (file args)
464 (cons "-emacs" (cons file args)))
466 ;; This is just like the gdb one except for the regexps since we need to cope
467 ;; with an optional breakpoint number in [] before the ^Z^Z
468 (defun gud-mipsdbx-marker-filter (string)
470 (setq gud-marker-acc (concat gud-marker-acc string))
473 ;; Process all the complete markers in this chunk.
475 ;; This is like th gdb marker but with an optional
476 ;; leading break point number like `[1] '
477 "^[][ 0-9]*\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
481 ;; Extract the frame position from the marker.
483 (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
484 (string-to-int (substring gud-marker-acc
488 ;; Append any text before the marker to the output we're going
489 ;; to return - we don't include the marker in this text.
490 output (concat output
491 (substring gud-marker-acc 0 (match-beginning 0)))
493 ;; Set the accumulator to the remaining text.
494 gud-marker-acc (substring gud-marker-acc (match-end 0))))
496 ;; Does the remaining text look like it might end with the
497 ;; beginning of another marker? If it does, then keep it in
498 ;; gud-marker-acc until we receive the rest of it. Since we
499 ;; know the full marker regexp above failed, it's pretty simple to
500 ;; test for marker starts.
501 (if (string-match "^[][ 0-9]*\032.*\\'" gud-marker-acc)
503 ;; Everything before the potential marker start can be output.
504 (setq output (concat output (substring gud-marker-acc
505 0 (match-beginning 0))))
507 ;; Everything after, we save, to combine with later input.
509 (substring gud-marker-acc (match-beginning 0))))
511 (setq output (concat output gud-marker-acc)
516 ;; The dbx in IRIX is a pain. It doesn't print the file name when
517 ;; stopping at a breakpoint (but you do get it from the `up' and
518 ;; `down' commands...). The only way to extract the information seems
519 ;; to be with a `file' command, although the current line number is
520 ;; available in $curline. Thus we have to look for output which
521 ;; appears to indicate a breakpoint. Then we prod the dbx sub-process
522 ;; to output the information we want with a combination of the
523 ;; `printf' and `file' commands as a pseudo marker which we can
524 ;; recognise next time through the marker-filter. This would be like
525 ;; the gdb marker but you can't get the file name without a newline...
526 ;; Note that gud-remove won't work since Irix dbx expects a breakpoint
527 ;; number rather than a line number etc. Maybe this could be made to
528 ;; work by listing all the breakpoints and picking the one(s) with the
529 ;; correct line number, but life's too short.
530 ;; d.love@dl.ac.uk (Dave Love) can be blamed for this
532 (defvar gud-irix-p (string-match "^mips-[^-]*-irix" system-configuration)
533 "Non-nil to assume the interface appropriate for IRIX dbx.
534 This works in IRIX 4 and probably IRIX 5.")
535 ;; (It's been tested in IRIX 4 and the output from dbx on IRIX 5 looks
538 ;; this filter is influenced by the xdb one rather than the gdb one
539 (defun gud-irixdbx-marker-filter (string)
541 (let (result (case-fold-search nil))
542 (if (or (string-match comint-prompt-regexp string)
543 (string-match ".*\012" string))
544 (setq result (concat gud-marker-acc string)
546 (setq gud-marker-acc (concat gud-marker-acc string)))
549 ;; look for breakpoint or signal indication e.g.:
550 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
551 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
552 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
554 "^\\(\\[[0-9]+] \\)?Process +[0-9]+ ([^)]*) [^[]+\\[[^]\n]*]\n"
556 ;; prod dbx into printing out the line number and file
557 ;; name in a form we can grok as below
558 (process-send-string (get-buffer-process gud-comint-buffer)
559 "printf \"\032\032%1d:\",$curline;file\n"))
560 ;; look for result of, say, "up" e.g.:
561 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
562 ;; (this will also catch one of the lines printed by "where")
564 "^[^ ][^[]*\\[\"\\([^\"]+\\)\":\\([0-9]+\\), [^]]+]\n"
566 (let ((file (substring result (match-beginning 1)
568 (if (file-exists-p file)
572 result (match-beginning 1) (match-end 1))
575 result (match-beginning 2) (match-end 2)))))))
577 ((string-match ; kluged-up marker as above
578 "\032\032\\([0-9]*\\):\\(.*\\)\n" result)
579 (let ((file (substring result (match-beginning 2) (match-end 2))))
580 (if (file-exists-p file)
586 result (match-beginning 1) (match-end 1)))))))
587 (setq result (substring result 0 (match-beginning 0))))))
590 (defun gud-dbx-find-file (f)
591 (find-file-noselect f))
594 (defun dbx (command-line)
595 "Run dbx on program FILE in buffer *gud-FILE*.
596 The directory containing FILE becomes the initial working directory
597 and source-file directory for your debugger."
599 (list (read-from-minibuffer "Run dbx (like this): "
600 (if (consp gud-dbx-history)
601 (car gud-dbx-history)
604 '(gud-dbx-history . 1))))
606 (gud-overload-functions
609 '((gud-massage-args . gud-mipsdbx-massage-args)
610 (gud-marker-filter . gud-mipsdbx-marker-filter)
611 (gud-find-file . gud-dbx-find-file)))
613 '((gud-massage-args . gud-dbx-massage-args)
614 (gud-marker-filter . gud-irixdbx-marker-filter)
615 (gud-find-file . gud-dbx-find-file)))
617 '((gud-massage-args . gud-dbx-massage-args)
618 (gud-marker-filter . gud-dbx-marker-filter)
619 (gud-find-file . gud-dbx-find-file)))))
621 (gud-common-init command-line)
625 (gud-def gud-break "stop at \"%f\":%l"
626 "\C-b" "Set breakpoint at current line.")
627 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
629 (gud-def gud-break "stop at \"%d%f\":%l"
630 "\C-b" "Set breakpoint at current line.")
631 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
632 ;; Make dbx give out the source location info that we need.
633 (process-send-string (get-buffer-process gud-comint-buffer)
634 "printf \"\032\032%1d:\",$curline;file\n"))
635 ((or (string-match "-sunos" (symbol-name system-type))
636 (string-match "-solaris" (symbol-name system-type)))
637 ;; The following works for both the UCB and SunPro 2.0.1 versions
638 ;; of dbx. The `stop' is lost using the `\n' separator as in the
639 ;; default case. Is there a dbx where the newline is actually
640 ;; necessary? (d.love@dl.ac.uk)
641 (gud-def gud-break "file \"%d%f\";stop at %l"
642 "\C-b" "Set breakpoint at current line."))
644 (gud-def gud-break "file \"%d%f\"\nstop at %l"
645 "\C-b" "Set breakpoint at current line.")))
647 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
648 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
649 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
650 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
651 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
652 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
653 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
654 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
656 (setq comint-prompt-regexp "^[^)\n]*dbx) *")
657 (setq paragraph-start comint-prompt-regexp)
658 (run-hooks 'dbx-mode-hook)
661 ;; ======================================================================
662 ;; xdb (HP PARISC debugger) functions
664 ;;; History of argument lists passed to xdb.
665 (defvar gud-xdb-history nil)
667 (defvar gud-xdb-directories nil
668 "*A list of directories that xdb should search for source code.
669 If nil, only source files in the program directory
670 will be known to xdb.
672 The file names should be absolute, or relative to the directory
673 containing the executable being debugged.")
675 (defun gud-xdb-massage-args (file args)
676 (nconc (let ((directories gud-xdb-directories)
679 (setq result (cons (car directories) (cons "-d" result)))
680 (setq directories (cdr directories)))
681 (nreverse (cons file result)))
684 (defun gud-xdb-file-name (f)
685 "Transform a relative pathname to a full pathname in xdb mode"
687 (if (file-exists-p f)
688 (setq result (expand-file-name f))
689 (let ((directories gud-xdb-directories))
691 (let ((path (concat (car directories) "/" f)))
692 (if (file-exists-p path)
693 (setq result (expand-file-name path)
695 (setq directories (cdr directories)))))
698 ;; xdb does not print the lines all at once, so we have to accumulate them
699 (defun gud-xdb-marker-filter (string)
701 (if (or (string-match comint-prompt-regexp string)
702 (string-match ".*\012" string))
703 (setq result (concat gud-marker-acc string)
705 (setq gud-marker-acc (concat gud-marker-acc string)))
707 (if (or (string-match "\\([^\n \t:]+\\): [^:]+: \\([0-9]+\\):" result)
708 (string-match "[^: \t]+:[ \t]+\\([^:]+\\): [^:]+: \\([0-9]+\\):"
710 (let ((line (string-to-int
711 (substring result (match-beginning 2) (match-end 2))))
712 (file (gud-xdb-file-name
713 (substring result (match-beginning 1) (match-end 1)))))
715 (setq gud-last-frame (cons file line))))))
718 (defun gud-xdb-find-file (f)
719 (let ((realf (gud-xdb-file-name f)))
720 (if realf (find-file-noselect realf))))
723 (defun xdb (command-line)
724 "Run xdb on program FILE in buffer *gud-FILE*.
725 The directory containing FILE becomes the initial working directory
726 and source-file directory for your debugger.
728 You can set the variable 'gud-xdb-directories' to a list of program source
729 directories if your program contains sources from more than one directory."
731 (list (read-from-minibuffer "Run xdb (like this): "
732 (if (consp gud-xdb-history)
733 (car gud-xdb-history)
736 '(gud-xdb-history . 1))))
737 (gud-overload-functions '((gud-massage-args . gud-xdb-massage-args)
738 (gud-marker-filter . gud-xdb-marker-filter)
739 (gud-find-file . gud-xdb-find-file)))
741 (gud-common-init command-line)
743 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
744 (gud-def gud-tbreak "b %f:%l\\t" "\C-t"
745 "Set temporary breakpoint at current line.")
746 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
747 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
748 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
749 (gud-def gud-cont "c" "\C-r" "Continue with display.")
750 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
751 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
752 (gud-def gud-finish "bu\\t" "\C-f" "Finish executing current function.")
753 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
755 (setq comint-prompt-regexp "^>")
756 (setq paragraph-start comint-prompt-regexp)
757 (run-hooks 'xdb-mode-hook))
759 ;; ======================================================================
762 ;;; History of argument lists passed to perldb.
763 (defvar gud-perldb-history nil)
765 (defun gud-perldb-massage-args (file args)
766 (cons "-d" (cons file (cons "-emacs" args))))
768 ;; There's no guarantee that Emacs will hand the filter the entire
769 ;; marker at once; it could be broken up across several strings. We
770 ;; might even receive a big chunk with several markers in it. If we
771 ;; receive a chunk of text which looks like it might contain the
772 ;; beginning of a marker, we save it here between calls to the
774 (defvar gud-perldb-marker-acc "")
776 (defun gud-perldb-marker-filter (string)
778 (setq gud-marker-acc (concat gud-marker-acc string))
781 ;; Process all the complete markers in this chunk.
782 (while (string-match "^\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
786 ;; Extract the frame position from the marker.
788 (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
789 (string-to-int (substring gud-marker-acc
793 ;; Append any text before the marker to the output we're going
794 ;; to return - we don't include the marker in this text.
795 output (concat output
796 (substring gud-marker-acc 0 (match-beginning 0)))
798 ;; Set the accumulator to the remaining text.
799 gud-marker-acc (substring gud-marker-acc (match-end 0))))
801 ;; Does the remaining text look like it might end with the
802 ;; beginning of another marker? If it does, then keep it in
803 ;; gud-marker-acc until we receive the rest of it. Since we
804 ;; know the full marker regexp above failed, it's pretty simple to
805 ;; test for marker starts.
806 (if (string-match "^\032.*\\'" gud-marker-acc)
808 ;; Everything before the potential marker start can be output.
809 (setq output (concat output (substring gud-marker-acc
810 0 (match-beginning 0))))
812 ;; Everything after, we save, to combine with later input.
814 (substring gud-marker-acc (match-beginning 0))))
816 (setq output (concat output gud-marker-acc)
821 (defun gud-perldb-find-file (f)
822 (find-file-noselect f))
825 (defun perldb (command-line)
826 "Run perldb on program FILE in buffer *gud-FILE*.
827 The directory containing FILE becomes the initial working directory
828 and source-file directory for your debugger."
830 (list (read-from-minibuffer "Run perldb (like this): "
831 (if (consp gud-perldb-history)
832 (car gud-perldb-history)
835 '(gud-perldb-history . 1))))
836 (gud-overload-functions '((gud-massage-args . gud-perldb-massage-args)
837 (gud-marker-filter . gud-perldb-marker-filter)
838 (gud-find-file . gud-perldb-find-file)
841 (gud-common-init command-line)
843 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
844 (gud-def gud-remove "d %l" "\C-d" "Remove breakpoint at current line")
845 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
846 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
847 (gud-def gud-cont "c" "\C-r" "Continue with display.")
848 ; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
849 ; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
850 ; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
851 (gud-def gud-print "%e" "\C-p" "Evaluate perl expression at point.")
853 (setq comint-prompt-regexp "^ DB<[0-9]+> ")
854 (setq paragraph-start comint-prompt-regexp)
855 (run-hooks 'perldb-mode-hook)
859 ;; End of debugger-specific information
863 ;;; When we send a command to the debugger via gud-call, it's annoying
864 ;;; to see the command and the new prompt inserted into the debugger's
865 ;;; buffer; we have other ways of knowing the command has completed.
867 ;;; If the buffer looks like this:
868 ;;; --------------------
869 ;;; (gdb) set args foo bar
871 ;;; --------------------
872 ;;; (the -!- marks the location of point), and we type `C-x SPC' in a
873 ;;; source file to set a breakpoint, we want the buffer to end up like
875 ;;; --------------------
876 ;;; (gdb) set args foo bar
877 ;;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
879 ;;; --------------------
880 ;;; Essentially, the old prompt is deleted, and the command's output
881 ;;; and the new prompt take its place.
883 ;;; Not echoing the command is easy enough; you send it directly using
884 ;;; process-send-string, and it never enters the buffer. However,
885 ;;; getting rid of the old prompt is trickier; you don't want to do it
886 ;;; when you send the command, since that will result in an annoying
887 ;;; flicker as the prompt is deleted, redisplay occurs while Emacs
888 ;;; waits for a response from the debugger, and the new prompt is
889 ;;; inserted. Instead, we'll wait until we actually get some output
890 ;;; from the subprocess before we delete the prompt. If the command
891 ;;; produced no output other than a new prompt, that prompt will most
892 ;;; likely be in the first chunk of output received, so we will delete
893 ;;; the prompt and then replace it with an identical one. If the
894 ;;; command produces output, the prompt is moving anyway, so the
895 ;;; flicker won't be annoying.
897 ;;; So - when we want to delete the prompt upon receipt of the next
898 ;;; chunk of debugger output, we position gud-delete-prompt-marker at
899 ;;; the start of the prompt; the process filter will notice this, and
900 ;;; delete all text between it and the process output marker. If
901 ;;; gud-delete-prompt-marker points nowhere, we leave the current
903 (defvar gud-delete-prompt-marker nil)
907 "Major mode for interacting with an inferior debugger process.
909 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
910 or M-x xdb. Each entry point finishes by executing a hook; `gdb-mode-hook',
911 `sdb-mode-hook', `dbx-mode-hook' or `xdb-mode-hook' respectively.
913 After startup, the following commands are available in both the GUD
914 interaction buffer and any source buffer GUD visits due to a breakpoint stop
917 \\[gud-break] sets a breakpoint at the current file and line. In the
918 GUD buffer, the current file and line are those of the last breakpoint or
919 step. In a source buffer, they are the buffer's file and current line.
921 \\[gud-remove] removes breakpoints on the current file and line.
923 \\[gud-refresh] displays in the source window the last line referred to
926 \\[gud-step], \\[gud-next], and \\[gud-stepi] do a step-one-line,
927 step-one-line (not entering function calls), and step-one-instruction
928 and then update the source window with the current file and position.
929 \\[gud-cont] continues execution.
931 \\[gud-print] tries to find the largest C lvalue or function-call expression
932 around point, and sends it to the debugger for value display.
934 The above commands are common to all supported debuggers except xdb which
935 does not support stepping instructions.
937 Under gdb, sdb and xdb, \\[gud-tbreak] behaves exactly like \\[gud-break],
938 except that the breakpoint is temporary; that is, it is removed when
939 execution stops on it.
941 Under gdb, dbx, and xdb, \\[gud-up] pops up through an enclosing stack
942 frame. \\[gud-down] drops back down through one.
944 If you are using gdb or xdb, \\[gud-finish] runs execution to the return from
945 the current function and stops.
947 All the keystrokes above are accessible in the GUD buffer
948 with the prefix C-c, and in all buffers through the prefix C-x C-a.
950 All pre-defined functions for which the concept make sense repeat
951 themselves the appropriate number of times if you give a prefix
954 You may use the `gud-def' macro in the initialization hook to define other
957 Other commands for interacting with the debugger process are inherited from
958 comint mode, which see."
961 (setq major-mode 'gud-mode)
962 (setq mode-name "Debugger")
963 (setq mode-line-process '(":%s"))
964 (use-local-map (copy-keymap comint-mode-map))
965 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
966 (make-local-variable 'gud-last-frame)
967 (setq gud-last-frame nil)
968 (make-local-variable 'comint-prompt-regexp)
969 (make-local-variable 'paragraph-start)
970 (make-local-variable 'gud-delete-prompt-marker)
971 (setq gud-delete-prompt-marker (make-marker))
972 (run-hooks 'gud-mode-hook)
975 ;; Chop STRING into words separated by SPC or TAB and return a list of them.
976 (defun gud-chop-words (string)
978 (len (length string))
981 (if (memq (aref string i) '(?\t ? ))
983 (setq words (cons (substring string beg i) words)
985 (while (and (< beg len) (memq (aref string beg) '(?\t ? )))
990 (setq words (cons (substring string beg) words)))
993 ;; Perform initializations common to all debuggers.
994 (defun gud-common-init (command-line)
995 (let* ((words (gud-chop-words command-line))
996 (program (car words))
997 (file-word (let ((w (cdr words)))
998 (while (and w (= ?- (aref (car w) 0)))
1001 (args (delq file-word (cdr words)))
1002 (file (and file-word
1003 (expand-file-name (substitute-in-file-name file-word))))
1004 (filepart (and file-word (file-name-nondirectory file))))
1005 (switch-to-buffer (concat "*gud-" filepart "*"))
1006 (and file-word (setq default-directory (file-name-directory file)))
1007 (or (bolp) (newline))
1008 (insert "Current directory is " default-directory "\n")
1009 (apply 'make-comint (concat "gud-" filepart) program nil
1010 (if file-word (gud-massage-args file args))))
1012 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
1013 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
1017 (defun gud-set-buffer ()
1018 (cond ((eq major-mode 'gud-mode)
1019 (setq gud-comint-buffer (current-buffer)))))
1021 ;; These functions are responsible for inserting output from your debugger
1022 ;; into the buffer. The hard work is done by the method that is
1023 ;; the value of gud-marker-filter.
1025 (defun gud-filter (proc string)
1026 ;; Here's where the actual buffer insertion is done
1027 (let ((inhibit-quit t)
1030 (set-buffer (process-buffer proc))
1031 ;; If we have been so requested, delete the debugger prompt.
1032 (if (marker-buffer gud-delete-prompt-marker)
1034 (delete-region (process-mark proc) gud-delete-prompt-marker)
1035 (set-marker gud-delete-prompt-marker nil)))
1036 ;; Save the process output, checking for source file markers.
1037 (setq output (gud-marker-filter string))
1038 ;; Check for a filename-and-line number.
1039 ;; Don't display the specified file
1040 ;; unless (1) point is at or after the position where output appears
1041 ;; and (2) this buffer is on the screen.
1042 (if (and gud-last-frame
1043 (>= (point) (process-mark proc))
1044 (get-buffer-window (current-buffer)))
1045 (gud-display-frame))
1046 ;; Let the comint filter do the actual insertion.
1047 ;; That lets us inherit various comint features.
1048 (comint-output-filter proc output))))
1050 (defun gud-sentinel (proc msg)
1051 (cond ((null (buffer-name (process-buffer proc)))
1053 ;; Stop displaying an arrow in a source file.
1054 (setq overlay-arrow-position nil)
1055 (set-process-buffer proc nil))
1056 ((memq (process-status proc) '(signal exit))
1057 ;; Stop displaying an arrow in a source file.
1058 (setq overlay-arrow-position nil)
1059 ;; Fix the mode line.
1060 (setq mode-line-process
1062 (symbol-name (process-status proc))))
1063 (let* ((obuf (current-buffer)))
1064 ;; save-excursion isn't the right thing if
1065 ;; process-buffer is current-buffer
1068 ;; Write something in *compilation* and hack its mode line,
1069 (set-buffer (process-buffer proc))
1070 ;; Force mode line redisplay soon
1071 (set-buffer-modified-p (buffer-modified-p))
1073 (insert ?\n mode-name " " msg)
1075 (goto-char (point-max))
1076 (insert ?\n mode-name " " msg)))
1077 ;; If buffer and mode line will show that the process
1078 ;; is dead, we can delete it now. Otherwise it
1079 ;; will stay around until M-x list-processes.
1080 (delete-process proc))
1081 ;; Restore old buffer, but don't restore old point
1082 ;; if obuf is the gud buffer.
1083 (set-buffer obuf))))))
1085 (defun gud-display-frame ()
1086 "Find and obey the last filename-and-line marker from the debugger.
1087 Obeying it means displaying in another window the specified file and line."
1092 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
1093 (setq gud-last-last-frame gud-last-frame
1094 gud-last-frame nil))))
1096 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
1097 ;; and that its line LINE is visible.
1098 ;; Put the overlay-arrow on the line LINE in that buffer.
1099 ;; Most of the trickiness in here comes from wanting to preserve the current
1100 ;; region-restriction if that's possible. We use an explicit display-buffer
1101 ;; to get around the fact that this is called inside a save-excursion.
1103 (defun gud-display-line (true-file line)
1104 (let* ((buffer (gud-find-file true-file))
1105 (window (display-buffer buffer))
1107 ;;; (if (equal buffer (current-buffer))
1109 ;;; (setq buffer-read-only nil))
1111 ;;; (setq buffer-read-only t)
1117 (setq overlay-arrow-string "=>")
1118 (or overlay-arrow-position
1119 (setq overlay-arrow-position (make-marker)))
1120 (set-marker overlay-arrow-position (point) (current-buffer)))
1121 (cond ((or (< pos (point-min)) (> pos (point-max)))
1124 (set-window-point window overlay-arrow-position)))
1126 ;;; The gud-call function must do the right thing whether its invoking
1127 ;;; keystroke is from the GUD buffer itself (via major-mode binding)
1128 ;;; or a C buffer. In the former case, we want to supply data from
1129 ;;; gud-last-frame. Here's how we do it:
1131 (defun gud-format-command (str arg)
1132 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
1133 (frame (or gud-last-frame gud-last-last-frame))
1135 (while (and str (string-match "\\([^%]*\\)%\\([adeflp]\\)" str))
1136 (let ((key (string-to-char (substring str (match-beginning 2))))
1140 (setq subst (file-name-nondirectory (if insource
1144 (setq subst (file-name-directory (if insource
1148 (setq subst (if insource
1151 (save-restriction (widen)
1152 (1+ (count-lines 1 (point)))))
1155 (setq subst (find-c-expr)))
1157 (setq subst (gud-read-address)))
1159 (setq subst (if arg (int-to-string arg) ""))))
1160 (setq result (concat result
1161 (substring str (match-beginning 1) (match-end 1))
1163 (setq str (substring str (match-end 2))))
1164 ;; There might be text left in STR when the loop ends.
1165 (concat result str)))
1167 (defun gud-read-address ()
1168 "Return a string containing the core-address found in the buffer at point."
1170 (let ((pt (point)) found begin)
1171 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
1173 (found (forward-char 2)
1174 (buffer-substring found
1175 (progn (re-search-forward "[^0-9a-f]")
1178 (t (setq begin (progn (re-search-backward "[^0-9]")
1182 (re-search-forward "[^0-9]")
1184 (buffer-substring begin (point)))))))
1186 (defun gud-call (fmt &optional arg)
1187 (let ((msg (gud-format-command fmt arg)))
1188 (message "Command: %s" msg)
1190 (gud-basic-call msg)))
1192 (defun gud-basic-call (command)
1193 "Invoke the debugger COMMAND displaying source in other window."
1196 (let ((command (concat command "\n"))
1197 (proc (get-buffer-process gud-comint-buffer)))
1199 ;; Arrange for the current prompt to get deleted.
1201 (set-buffer gud-comint-buffer)
1202 (goto-char (process-mark proc))
1204 (if (looking-at comint-prompt-regexp)
1205 (set-marker gud-delete-prompt-marker (point))))
1206 (process-send-string proc command)))
1208 (defun gud-refresh (&optional arg)
1209 "Fix up a possibly garbled display, and redraw the arrow."
1212 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
1213 (gud-display-frame))
1215 ;;; Code for parsing expressions out of C code. The single entry point is
1216 ;;; find-c-expr, which tries to return an lvalue expression from around point.
1218 ;;; The rest of this file is a hacked version of gdbsrc.el by
1219 ;;; Debby Ayers <ayers@asc.slb.com>,
1220 ;;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
1222 (defun find-c-expr ()
1223 "Returns the C expr that surrounds point."
1226 (let ((p) (expr) (test-expr))
1228 (setq expr (expr-cur))
1229 (setq test-expr (expr-prev))
1230 (while (expr-compound test-expr expr)
1231 (setq expr (cons (car test-expr) (cdr expr)))
1232 (goto-char (car expr))
1233 (setq test-expr (expr-prev)))
1235 (setq test-expr (expr-next))
1236 (while (expr-compound expr test-expr)
1237 (setq expr (cons (car expr) (cdr test-expr)))
1238 (setq test-expr (expr-next))
1240 (buffer-substring (car expr) (cdr expr)))))
1243 "Returns the expr that point is in; point is set to beginning of expr.
1244 The expr is represented as a cons cell, where the car specifies the point in
1245 the current buffer that marks the beginning of the expr and the cdr specifies
1246 the character after the end of the expr."
1247 (let ((p (point)) (begin) (end))
1248 (expr-backward-sexp)
1249 (setq begin (point))
1263 (defun expr-backward-sexp ()
1264 "Version of `backward-sexp' that catches errors."
1269 (defun expr-forward-sexp ()
1270 "Version of `forward-sexp' that catches errors."
1276 "Returns the previous expr, point is set to beginning of that expr.
1277 The expr is represented as a cons cell, where the car specifies the point in
1278 the current buffer that marks the beginning of the expr and the cdr specifies
1279 the character after the end of the expr"
1280 (let ((begin) (end))
1281 (expr-backward-sexp)
1282 (setq begin (point))
1289 "Returns the following expr, point is set to beginning of that expr.
1290 The expr is represented as a cons cell, where the car specifies the point in
1291 the current buffer that marks the beginning of the expr and the cdr specifies
1292 the character after the end of the expr."
1293 (let ((begin) (end))
1297 (expr-backward-sexp)
1298 (setq begin (point))
1301 (defun expr-compound-sep (span-start span-end)
1302 "Returns '.' for '->' & '.', returns ' ' for white space,
1303 returns '?' for other punctuation."
1306 (while (< span-start span-end)
1307 (setq syntax (char-syntax (char-after span-start)))
1310 ((= syntax ?.) (setq syntax (char-after span-start))
1312 ((= syntax ?.) (setq result ?.))
1313 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
1315 (setq span-start (+ span-start 1)))
1316 (t (setq span-start span-end)
1317 (setq result ??)))))
1318 (setq span-start (+ span-start 1)))
1321 (defun expr-compound (first second)
1322 "Non-nil if concatenating FIRST and SECOND makes a single C token.
1323 The two exprs are represented as a cons cells, where the car
1324 specifies the point in the current buffer that marks the beginning of the
1325 expr and the cdr specifies the character after the end of the expr.
1326 Link exprs of the form:
1333 (let ((span-start (cdr first))
1334 (span-end (car second))
1336 (setq syntax (expr-compound-sep span-start span-end))
1338 ((= (car first) (car second)) nil)
1339 ((= (cdr first) (cdr second)) nil)
1342 (setq span-start (char-after (- span-start 1)))
1343 (setq span-end (char-after span-end))
1345 ((= span-start ?) ) t )
1346 ((= span-start ?] ) t )
1347 ((= span-end ?( ) t )
1348 ((= span-end ?[ ) t )
1355 ;;; gud.el ends here