| blob | 7be667ba8ba4d566a11f1bc82c55f838b35d5daf |
1 ;;; gud.el --- Grand Unified Debugger mode for gdb, sdb, or dbx under Emacs
3 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
4 ;; Version: 1.3
5 ;; Keywords: unix, tools
7 ;; Copyright (C) 1992, 1993 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
23 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25 ;;; Commentary:
27 ;; The ancestral gdb.el was by W. Schelter <wfs@rascal.ics.utexas.edu>
28 ;; It was later rewritten by rms. Some ideas were due to Masanobu.
29 ;; Grand Unification (sdb/dbx support) by Eric S. Raymond <esr@thyrsus.com>
30 ;; The overloading code was then rewritten by Barry Warsaw <bwarsaw@cen.com>,
31 ;; who also hacked the mode to use comint.el.
33 ;;; Code:
38 ;; ======================================================================
39 ;; GUD commands must be visible in C buffers visited by GUD
47 ;; ======================================================================
48 ;; the overloading mechanism
51 "Overload functions defined in GUD-OVERLOAD-ALIST.
52 This association list has elements of the form
53 (ORIGINAL-FUNCTION-NAME OVERLOAD-FUNCTION)"
56 gud-overload-alist))
67 ;; ======================================================================
68 ;; command definition
70 ;; This macro is used below to define some basic debugger interface commands.
71 ;; Of course you may use `gud-def' with any other debugger command, including
72 ;; user defined ones.
74 ;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
75 ;; which defines FUNC to send the command NAME to the debugger, gives
76 ;; it the docstring DOC, and binds that function to KEY in the GUD
77 ;; major mode. The function is also bound in the global keymap with the
78 ;; GUD prefix.
81 "Define FUNC to be a command sending STR and bound to KEY, with
82 optional doc string DOC. Certain %-escapes in the string arguments
83 are interpreted specially if present. These are:
85 %f name of current source file.
86 %l number of current source line
87 %e text of the C lvalue or function-call expression surrounding point.
88 %a text of the hexadecimal address surrounding point
89 %p prefix argument to the command (if any) as a number
91 The `current' source file is the file of the current buffer (if
92 we're in a C file) or the source file current at the last break or
93 step (if we're in the GUD buffer).
94 The `current' line is that of the current buffer (if we're in a
95 source file) or the source line number at the last break or step (if
96 we're in the GUD buffer)."
112 ;; Where gud-display-frame should put the debugging arrow. This is
113 ;; set by the marker-filter, which scans the debugger's output for
114 ;; indications of the current program counter.
117 ;; All debugger-specific information is collected here.
118 ;; Here's how it works, in case you ever need to add a debugger to the mode.
119 ;;
120 ;; Each entry must define the following at startup:
121 ;;
122 ;;<name>
123 ;; comint-prompt-regexp
124 ;; gud-<name>-debugger-startup
125 ;; gud-<name>-marker-filter
126 ;; gud-<name>-find-file
127 ;;
128 ;; The job of the startup-command method is to fire up a copy of the debugger,
129 ;; given a list of debugger arguments.
130 ;;
131 ;; The job of the marker-filter method is to detect file/line markers in
132 ;; strings and set the global gud-last-frame to indicate what display
133 ;; action (if any) should be triggered by the marker. Note that only
134 ;; whetever the method *returns* is displayed in the buffer; thus, you
135 ;; can filter the debugger's output, interpreting some and passing on
136 ;; the rest.
137 ;;
138 ;; The job of the find-file method is to visit and return the buffer indicated
139 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
140 ;; something else.
142 ;; ======================================================================
143 ;; gdb functions
156 ;; this computation means the ^Z^Z-initiated marker in the
157 ;; input string is never emitted.
161 ))
162 string))
167 ;;;###autoload
169 "Run gdb on program FILE in buffer *gud-FILE*.
170 The directory containing FILE becomes the initial working directory
171 and source-file directory for your debugger."
176 ))
194 )
197 ;; ======================================================================
198 ;; sdb functions
210 ;; System V Release 3.2 uses this format
212 string)
218 ;; System V Release 4.0
220 string)
226 gud-sdb-lastfile
231 string)
238 ;;;###autoload
240 "Run sdb on program FILE in buffer *gud-FILE*.
241 The directory containing FILE becomes the initial working directory
242 and source-file directory for your debugger."
250 ))
265 )
267 ;; ======================================================================
268 ;; dbx functions
281 string)
286 ;;;###autoload
288 "Run dbx on program FILE in buffer *gud-FILE*.
289 The directory containing FILE becomes the initial working directory
290 and source-file directory for your debugger."
295 ))
312 )
314 ;;
315 ;; End of debugger-specific information
316 ;;
318 ;;; When we send a command to the debugger via gud-call, it's annoying
319 ;;; to see the command and the new prompt inserted into the debugger's
320 ;;; buffer; we have other ways of knowing the command has completed.
321 ;;;
322 ;;; If the buffer looks like this:
323 ;;; --------------------
324 ;;; (gdb) set args foo bar
325 ;;; (gdb) -!-
326 ;;; --------------------
327 ;;; (the -!- marks the location of point), and we type `C-x SPC' in a
328 ;;; source file to set a breakpoint, we want the buffer to end up like
329 ;;; this:
330 ;;; --------------------
331 ;;; (gdb) set args foo bar
332 ;;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
333 ;;; (gdb) -!-
334 ;;; --------------------
335 ;;; Essentially, the old prompt is deleted, and the command's output
336 ;;; and the new prompt take its place.
337 ;;;
338 ;;; Not echoing the command is easy enough; you send it directly using
339 ;;; process-send-string, and it never enters the buffer. However,
340 ;;; getting rid of the old prompt is trickier; you don't want to do it
341 ;;; when you send the command, since that will result in an annoying
342 ;;; flicker as the prompt is deleted, redisplay occurs while Emacs
343 ;;; waits for a response from the debugger, and the new prompt is
344 ;;; inserted. Instead, we'll wait until we actually get some output
345 ;;; from the subprocess before we delete the prompt. If the command
346 ;;; produced no output other than a new prompt, that prompt will most
347 ;;; likely be in the first chunk of output received, so we will delete
348 ;;; the prompt and then replace it with an identical one. If the
349 ;;; command produces output, the prompt is moving anyway, so the
350 ;;; flicker won't be annoying.
351 ;;;
352 ;;; So - when we want to delete the prompt upon receipt of the next
353 ;;; chunk of debugger output, we position gud-delete-prompt-marker at
354 ;;; the start of the prompt; the process filter will notice this, and
355 ;;; delete all text between it and the process output marker. If
356 ;;; gud-delete-prompt-marker points nowhere, we leave the current
357 ;;; prompt alone.
360 \f
362 "Major mode for interacting with an inferior debugger process.
364 You start it up with one of the commands M-x gdb, M-x sdb, or
365 M-x dbx. Each entry point finishes by executing a hook; gdb-mode-hook,
366 sdb-mode-hook or dbx-mode-hook respectively.
368 After startup, the following commands are available in both the GUD
369 interaction buffer and any source buffer GUD visits due to a breakpoint stop
370 or step operation:
373 GUD buffer, the current file and line are those of the last breakpoint or
374 step. In a source buffer, they are the buffer's file and current line.
379 in the gud buffer.
382 step-one-line (not entering function calls), and step-one-instruction
383 and then update the source window with the current file and position.
387 around point, and sends it to the debugger for value display.
389 The above commands are common to all supported debuggers.
392 except that the breakpoint is temporary; that is, it is removed when
393 execution stops on it.
399 the current function and stops.
401 All the keystrokes above have synonyms (in the GUD buffer only) with
402 a prefix of C-c (this is for backward compatibility with old gdb.el).
404 All pre-defined functions for which the concept make sense repeat
405 themselves the appropriate number of times if you give a prefix
406 argument.
408 You may use the gud-def macro in the initialization hook to define other
409 commands.
411 Other commands for interacting with the debugger process are inherited from
412 comint mode, which see."
425 )
430 ;; Perform initializations common to all debuggers
431 ;; There *must* be a cleaner way to lex the arglist...
464 )
470 ;; These functions are responsible for inserting output from your debugger
471 ;; into the buffer. The hard work is done by the method that is
472 ;; the value of gud-marker-filter.
475 ;; Here's where the actual buffer insertion is done
482 ;; If we have been so requested, delete the debugger prompt.
490 ;; Check for a filename-and-line number.
491 ;; Don't display the specified file
492 ;; unless (1) point is at or after the position where output appears
493 ;; and (2) this buffer is on the screen.
502 ;; buffer killed
503 ;; Stop displaying an arrow in a source file.
507 ;; Stop displaying an arrow in a source file.
509 ;; Fix the mode line.
514 ;; save-excursion isn't the right thing if
515 ;; process-buffer is current-buffer
518 ;; Write something in *compilation* and hack its mode line,
520 ;; Force mode line redisplay soon
527 ;; If buffer and mode line will show that the process
528 ;; is dead, we can delete it now. Otherwise it
529 ;; will stay around until M-x list-processes.
531 ;; Restore old buffer, but don't restore old point
532 ;; if obuf is the gud buffer.
536 "Find and obey the last filename-and-line marker from the debugger.
537 Obeying it means displaying in another window the specified file and line."
545 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
546 ;; and that its line LINE is visible.
547 ;; Put the overlay-arrow on the line LINE in that buffer.
548 ;; Most of the trickiness in here comes from wanting to preserve the current
549 ;; region-restriction if that's possible. We use an explicit display-buffer
550 ;; to get around the fact that this is called inside a save-excursion.
556 ;;; (if (equal buffer (current-buffer))
557 ;;; nil
558 ;;; (setq buffer-read-only nil))
560 ;;; (setq buffer-read-only t)
575 ;;; The gud-call function must do the right thing whether its invoking
576 ;;; keystroke is from the GUD buffer itself (via major-mode binding)
577 ;;; or a C buffer. In the former case, we want to supply data from
578 ;;; gud-last-frame. Here's how we do it:
619 )
620 str
621 )
624 "Return a string containing the core-address found in the buffer at point."
649 "Invoke the debugger COMMAND displaying source in other window."
655 ;; Arrange for the current prompt to get deleted.
665 "Fix up a possibly garbled display, and redraw the arrow."
670 ;;; Code for parsing expressions out of C code. The single entry point is
671 ;;; find-c-expr, which tries to return an lvalue expression from around point.
672 ;;;
673 ;;; The rest of this file is a hacked version of gdbsrc.el by
674 ;;; Debby Ayers <ayers@asc.slb.com>,
675 ;;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
676 ;;; ??? We're waiting on papers from these people
679 "Returns the C expr that surrounds point."
690 )
696 )
698 )
699 )
700 )
703 "Returns the expr that point is in; point is set to beginning of expr.
704 The expr is represented as a cons cell, where the car specifies the point in
705 the current buffer that marks the beginning of the expr and the cdr specifies
706 the character after the end of the expr"
718 )
719 )
722 )
723 )
726 "Version of backward-sexp that catches errors"
732 "Version of forward-sexp that catches errors"
738 "Returns the previous expr, point is set to beginning of that expr.
739 The expr is represented as a cons cell, where the car specifies the point in
740 the current buffer that marks the beginning of the expr and the cdr specifies
741 the character after the end of the expr"
751 "Returns the following expr, point is set to beginning of that expr.
752 The expr is represented as a cons cell, where the car specifies the point in
753 the current buffer that marks the beginning of the expr and the cdr specifies
754 the character after the end of the expr"
762 )
763 )
766 "Returns '.' for '->' & '.', returns ' ' for white space,
767 returns '?' for other puctuation."
783 result
784 )
785 )
788 "Returns non-nil if the concatenation of two exprs results in a single C
789 token. The two exprs are represented as a cons cells, where the car
790 specifies the point in the current buffer that marks the beginning of the
791 expr and the cdr specifies the character after the end of the expr
792 Link exprs of the form:
793 Expr -> Expr
794 Expr . Expr
795 Expr (Expr)
796 Expr [Expr]
797 (Expr) Expr
798 [Expr] Expr"
816 )
818 )
819 )
821 ;;; There appears to be a bug in the byte compiler somewhere near macro
822 ;;; handling that (a) generates a spurious message about gud-key-prefix
823 ;;; when the global-set-key clause in gud-def is compiled, (b) generates
824 ;;; incorrect bytecode for gud-def. The symptom of this incorrectness
825 ;;; is that loading gud.elc brings in a compiled gud-def that doesn't
826 ;;; properly perform both global (C-x C-a) and local (C-c) bindings.
827 ;;; The workaround is to always load from source. Consequently, we try
828 ;;; to disable byte-compilation here.
829 ;;;
830 ;;; Local Variables:
831 ;;; no-byte-compile: t
832 ;;; End:
834 ;;; gud.el ends here