| blob | aaf289667779b99b033880a887d61bc507d3c5c4 |
1 ;;; gud.el --- Grand Unified Debugger mode for gdb, sdb, dbx, or xdb
2 ;;; under Emacs
4 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
5 ;; Maintainer: FSF
6 ;; Version: 1.3
7 ;; Keywords: unix, tools
9 ;; Copyright (C) 1992, 1993 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)
16 ;; any later version.
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.
27 ;;; Commentary:
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.
37 ;;; Code:
42 ;; ======================================================================
43 ;; GUD commands must be visible in C buffers visited by GUD
51 ;; ======================================================================
52 ;; the overloading mechanism
55 "Overload functions defined in GUD-OVERLOAD-ALIST.
56 This association list has elements of the form
57 (ORIGINAL-FUNCTION-NAME OVERLOAD-FUNCTION)"
60 gud-overload-alist))
70 \f
71 ;; ======================================================================
72 ;; command definition
74 ;; This macro is used below to define some basic debugger interface commands.
75 ;; Of course you may use `gud-def' with any other debugger command, including
76 ;; user defined ones.
78 ;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
79 ;; which defines FUNC to send the command NAME to the debugger, gives
80 ;; it the docstring DOC, and binds that function to KEY in the GUD
81 ;; major mode. The function is also bound in the global keymap with the
82 ;; GUD prefix.
85 "Define FUNC to be a command sending STR and bound to KEY, with
86 optional doc string DOC. Certain %-escapes in the string arguments
87 are interpreted specially if present. These are:
89 %f name (without directory) of current source file.
90 %d directory of current source file.
91 %l number of current source line
92 %e text of the C lvalue or function-call expression surrounding point.
93 %a text of the hexadecimal address surrounding point
94 %p prefix argument to the command (if any) as a number
96 The `current' source file is the file of the current buffer (if
97 we're in a C file) or the source file current at the last break or
98 step (if we're in the GUD buffer).
99 The `current' line is that of the current buffer (if we're in a
100 source file) or the source line number at the last break or step (if
101 we're in the GUD buffer)."
117 ;; Where gud-display-frame should put the debugging arrow. This is
118 ;; set by the marker-filter, which scans the debugger's output for
119 ;; indications of the current program counter.
122 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
123 ;; the last frame, even if it's been called before and gud-last-frame has
124 ;; been set to nil.
127 ;; All debugger-specific information is collected here.
128 ;; Here's how it works, in case you ever need to add a debugger to the mode.
129 ;;
130 ;; Each entry must define the following at startup:
131 ;;
132 ;;<name>
133 ;; comint-prompt-regexp
134 ;; gud-<name>-massage-args
135 ;; gud-<name>-marker-filter
136 ;; gud-<name>-find-file
137 ;;
138 ;; The job of the massage-args method is to modify the given list of
139 ;; debugger arguments before running the debugger.
140 ;;
141 ;; The job of the marker-filter method is to detect file/line markers in
142 ;; strings and set the global gud-last-frame to indicate what display
143 ;; action (if any) should be triggered by the marker. Note that only
144 ;; whatever the method *returns* is displayed in the buffer; thus, you
145 ;; can filter the debugger's output, interpreting some and passing on
146 ;; the rest.
147 ;;
148 ;; The job of the find-file method is to visit and return the buffer indicated
149 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
150 ;; something else.
151 \f
152 ;; ======================================================================
153 ;; gdb functions
155 ;;; History of argument lists passed to gdb.
161 ;; There's no guarantee that Emacs will hand the filter the entire
162 ;; marker at once; it could be broken up across several strings. We
163 ;; might even receive a big chunk with several markers in it. If we
164 ;; receive a chunk of text which looks like it might contain the
165 ;; beginning of a marker, we save it here between calls to the
166 ;; filter.
174 ;; Process all the complete markers in this chunk.
176 gud-gdb-marker-acc)
179 ;; Extract the frame position from the marker.
180 gud-last-frame
186 ;; Append any text before the marker to the output we're going
187 ;; to return - we don't include the marker in this text.
191 ;; Set the accumulator to the remaining text.
194 ;; Does the remaining text look like it might end with the
195 ;; beginning of another marker? If it does, then keep it in
196 ;; gud-gdb-marker-acc until we receive the rest of it. Since we
197 ;; know the full marker regexp above failed, it's pretty simple to
198 ;; test for marker starts.
201 ;; Everything before the potential marker start can be output.
205 ;; Everything after, we save, to combine with later input.
212 output)))
220 ()
225 ;;;###autoload
227 "Run gdb on program FILE in buffer *gud-FILE*.
228 The directory containing FILE becomes the initial working directory
229 and source-file directory for your debugger."
235 gdb-minibuffer-local-map nil
240 ))
260 )
262 ;; One of the nice features of GDB is its impressive support for
263 ;; context-sensitive command completion. We preserve that feature
264 ;; in the GUD buffer by using a GDB command designed just for Emacs.
266 ;; The completion process filter indicates when it is finished.
269 ;; Since output may arrive in fragments we accumulate partials strings here.
272 ;; We need to know how much of the completion to chop off.
275 ;; The completion list is constructed by the process filter.
281 "Perform completion on the GDB command preceding point.
282 This is implemented using the GDB `complete' command which isn't
283 available with older versions of GDB."
291 command-word)
292 ;; Find the word break. This match will always succeed.
298 ;; Temporarily install our filter function.
301 ;; Issue the command to GDB.
304 gud-gdb-complete-string nil
305 gud-gdb-complete-list nil)
306 ;; Slurp the output.
309 ;; Restore the old filter function.
311 ;; Protect against old versions of GDB.
316 ;; Sort the list like readline.
319 ;; Remove duplicates.
327 ;; Let comint handle the rest.
330 ;; The completion process filter is installed temporarily to slurp the
331 ;; output of GDB up to the next prompt and build the completion list.
337 gud-gdb-complete-list))
342 string)
347 \f
348 ;; ======================================================================
349 ;; sdb functions
351 ;;; History of argument lists passed to sdb.
364 ;; System V Release 3.2 uses this format
366 string)
372 ;; System V Release 4.0
374 string)
380 gud-sdb-lastfile
385 string)
392 ;;;###autoload
394 "Run sdb on program FILE in buffer *gud-FILE*.
395 The directory containing FILE becomes the initial working directory
396 and source-file directory for your debugger."
402 nil nil
410 ))
426 )
427 \f
428 ;; ======================================================================
429 ;; dbx functions
431 ;;; History of argument lists passed to dbx.
440 string)
443 string))
449 string)
451 ;; Functions for dbx on Mips/Ultrix.
452 ;; This is very similar to the code for gdb. The trick is to start dbx
453 ;; with the (undocumented) option `-emacs'.
455 ;; Are we running on a Mips system under Ultrix?
461 ;; There's no guarantee that Emacs will hand the filter the entire
462 ;; marker at once; it could be broken up across several strings. We
463 ;; might even receive a big chunk with several markers in it. If we
464 ;; receive a chunk of text which looks like it might contain the
465 ;; beginning of a marker, we save it here between calls to the
466 ;; filter.
474 ;; Process all the complete markers in this chunk.
477 gud-mipsdbx-marker-acc)
480 ;; Extract the frame position from the marker.
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.
493 ;; Set the accumulator to the remaining text.
497 ;; Does the remaining text look like it might end with the
498 ;; beginning of another marker? If it does, then keep it in
499 ;; gud-mipsdbx-marker-acc until we receive the rest of it.
500 ;; Since we know the full marker regexp above failed, it's pretty
501 ;; simple to test for marker starts.
504 ;; Everything before the potential marker start can be output.
507 ;; Everything after, we save, to combine with later input.
513 output)))
518 ;;;###autoload
520 "Run dbx on program FILE in buffer *gud-FILE*.
521 The directory containing FILE becomes the initial working directory
522 and source-file directory for your debugger."
528 nil nil
565 )
566 \f
567 ;; ======================================================================
568 ;; xdb (HP PARISC debugger) functions
570 ;;; History of argument lists passed to xdb.
574 "*A list of directories that xdb should search for source code.
575 If nil, only source files in the program directory
576 will be known to xdb.
578 The file names should be absolute, or relative to the directory
588 args))
591 "Transform a relative pathname to a full pathname in xdb mode"
600 directories nil)))
602 result))
604 ;; xdb does not print the lines all at once, so we have to accumulate them
617 result))
630 ;;;###autoload
632 "Run xdb on program FILE in buffer *gud-FILE*.
633 The directory containing FILE becomes the initial working directory
634 and source-file directory for your debugger.
636 You can set the variable 'gud-xdb-directories' to a list of program source
637 directories if your program contains sources from more than one directory."
643 nil nil
668 \f
669 ;; ======================================================================
670 ;; perldb functions
672 ;;; History of argument lists passed to perldb.
678 ;; There's no guarantee that Emacs will hand the filter the entire
679 ;; marker at once; it could be broken up across several strings. We
680 ;; might even receive a big chunk with several markers in it. If we
681 ;; receive a chunk of text which looks like it might contain the
682 ;; beginning of a marker, we save it here between calls to the
683 ;; filter.
691 ;; Process all the complete markers in this chunk.
693 gud-perldb-marker-acc)
696 ;; Extract the frame position from the marker.
697 gud-last-frame
703 ;; Append any text before the marker to the output we're going
704 ;; to return - we don't include the marker in this text.
708 ;; Set the accumulator to the remaining text.
711 ;; Does the remaining text look like it might end with the
712 ;; beginning of another marker? If it does, then keep it in
713 ;; gud-perldb-marker-acc until we receive the rest of it. Since we
714 ;; know the full marker regexp above failed, it's pretty simple to
715 ;; test for marker starts.
718 ;; Everything before the potential marker start can be output.
722 ;; Everything after, we save, to combine with later input.
729 output)))
734 ;;;###autoload
736 "Run perldb on program FILE in buffer *gud-FILE*.
737 The directory containing FILE becomes the initial working directory
738 and source-file directory for your debugger."
744 nil nil
749 ))
758 ; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
759 ; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
760 ; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
766 )
768 ;;
769 ;; End of debugger-specific information
770 ;;
772 \f
773 ;;; When we send a command to the debugger via gud-call, it's annoying
774 ;;; to see the command and the new prompt inserted into the debugger's
775 ;;; buffer; we have other ways of knowing the command has completed.
776 ;;;
777 ;;; If the buffer looks like this:
778 ;;; --------------------
779 ;;; (gdb) set args foo bar
780 ;;; (gdb) -!-
781 ;;; --------------------
782 ;;; (the -!- marks the location of point), and we type `C-x SPC' in a
783 ;;; source file to set a breakpoint, we want the buffer to end up like
784 ;;; this:
785 ;;; --------------------
786 ;;; (gdb) set args foo bar
787 ;;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
788 ;;; (gdb) -!-
789 ;;; --------------------
790 ;;; Essentially, the old prompt is deleted, and the command's output
791 ;;; and the new prompt take its place.
792 ;;;
793 ;;; Not echoing the command is easy enough; you send it directly using
794 ;;; process-send-string, and it never enters the buffer. However,
795 ;;; getting rid of the old prompt is trickier; you don't want to do it
796 ;;; when you send the command, since that will result in an annoying
797 ;;; flicker as the prompt is deleted, redisplay occurs while Emacs
798 ;;; waits for a response from the debugger, and the new prompt is
799 ;;; inserted. Instead, we'll wait until we actually get some output
800 ;;; from the subprocess before we delete the prompt. If the command
801 ;;; produced no output other than a new prompt, that prompt will most
802 ;;; likely be in the first chunk of output received, so we will delete
803 ;;; the prompt and then replace it with an identical one. If the
804 ;;; command produces output, the prompt is moving anyway, so the
805 ;;; flicker won't be annoying.
806 ;;;
807 ;;; So - when we want to delete the prompt upon receipt of the next
808 ;;; chunk of debugger output, we position gud-delete-prompt-marker at
809 ;;; the start of the prompt; the process filter will notice this, and
810 ;;; delete all text between it and the process output marker. If
811 ;;; gud-delete-prompt-marker points nowhere, we leave the current
812 ;;; prompt alone.
815 \f
817 "Major mode for interacting with an inferior debugger process.
819 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
820 or M-x xdb. Each entry point finishes by executing a hook; `gdb-mode-hook',
821 `sdb-mode-hook', `dbx-mode-hook' or `xdb-mode-hook' respectively.
823 After startup, the following commands are available in both the GUD
824 interaction buffer and any source buffer GUD visits due to a breakpoint stop
825 or step operation:
828 GUD buffer, the current file and line are those of the last breakpoint or
829 step. In a source buffer, they are the buffer's file and current line.
834 in the gud buffer.
837 step-one-line (not entering function calls), and step-one-instruction
838 and then update the source window with the current file and position.
842 around point, and sends it to the debugger for value display.
844 The above commands are common to all supported debuggers except xdb which
845 does not support stepping instructions.
848 except that the breakpoint is temporary; that is, it is removed when
849 execution stops on it.
855 the current function and stops.
857 All the keystrokes above are accessible in the GUD buffer
858 with the prefix C-c, and in all buffers through the prefix C-x C-a.
860 All pre-defined functions for which the concept make sense repeat
861 themselves the appropriate number of times if you give a prefix
862 argument.
864 You may use the `gud-def' macro in the initialization hook to define other
865 commands.
867 Other commands for interacting with the debugger process are inherited from
868 comint mode, which see."
883 )
885 ;; Chop STRING into words separated by SPC or TAB and return a list of them.
903 ;; Perform initializations common to all debuggers.
925 )
931 ;; These functions are responsible for inserting output from your debugger
932 ;; into the buffer. The hard work is done by the method that is
933 ;; the value of gud-marker-filter.
936 ;; Here's where the actual buffer insertion is done
938 output)
941 ;; If we have been so requested, delete the debugger prompt.
946 ;; Save the process output, checking for source file markers.
948 ;; Check for a filename-and-line number.
949 ;; Don't display the specified file
950 ;; unless (1) point is at or after the position where output appears
951 ;; and (2) this buffer is on the screen.
956 ;; Let the comint filter do the actual insertion.
957 ;; That lets us inherit various comint features.
962 ;; buffer killed
963 ;; Stop displaying an arrow in a source file.
967 ;; Stop displaying an arrow in a source file.
969 ;; Fix the mode line.
974 ;; save-excursion isn't the right thing if
975 ;; process-buffer is current-buffer
978 ;; Write something in *compilation* and hack its mode line,
980 ;; Force mode line redisplay soon
987 ;; If buffer and mode line will show that the process
988 ;; is dead, we can delete it now. Otherwise it
989 ;; will stay around until M-x list-processes.
991 ;; Restore old buffer, but don't restore old point
992 ;; if obuf is the gud buffer.
996 "Find and obey the last filename-and-line marker from the debugger.
997 Obeying it means displaying in another window the specified file and line."
1004 gud-last-frame nil))))
1006 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
1007 ;; and that its line LINE is visible.
1008 ;; Put the overlay-arrow on the line LINE in that buffer.
1009 ;; Most of the trickiness in here comes from wanting to preserve the current
1010 ;; region-restriction if that's possible. We use an explicit display-buffer
1011 ;; to get around the fact that this is called inside a save-excursion.
1017 ;;; (if (equal buffer (current-buffer))
1018 ;;; nil
1019 ;;; (setq buffer-read-only nil))
1021 ;;; (setq buffer-read-only t)
1036 ;;; The gud-call function must do the right thing whether its invoking
1037 ;;; keystroke is from the GUD buffer itself (via major-mode binding)
1038 ;;; or a C buffer. In the former case, we want to supply data from
1039 ;;; gud-last-frame. Here's how we do it:
1044 result)
1047 subst)
1072 subst)))
1074 ;; There might be text left in STR when the loop ends.
1078 "Return a string containing the core-address found in the buffer at point."
1103 "Invoke the debugger COMMAND displaying source in other window."
1109 ;; Arrange for the current prompt to get deleted.
1119 "Fix up a possibly garbled display, and redraw the arrow."
1124 \f
1125 ;;; Code for parsing expressions out of C code. The single entry point is
1126 ;;; find-c-expr, which tries to return an lvalue expression from around point.
1127 ;;;
1128 ;;; The rest of this file is a hacked version of gdbsrc.el by
1129 ;;; Debby Ayers <ayers@asc.slb.com>,
1130 ;;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
1133 "Returns the C expr that surrounds point."
1149 )
1153 "Returns the expr that point is in; point is set to beginning of expr.
1154 The expr is represented as a cons cell, where the car specifies the point in
1155 the current buffer that marks the beginning of the expr and the cdr specifies
1156 the character after the end of the expr."
1168 )
1169 )
1174 "Version of `backward-sexp' that catches errors."
1180 "Version of `forward-sexp' that catches errors."
1186 "Returns the previous expr, point is set to beginning of that expr.
1187 The expr is represented as a cons cell, where the car specifies the point in
1188 the current buffer that marks the beginning of the expr and the cdr specifies
1189 the character after the end of the expr"
1199 "Returns the following expr, point is set to beginning of that expr.
1200 The expr is represented as a cons cell, where the car specifies the point in
1201 the current buffer that marks the beginning of the expr and the cdr specifies
1202 the character after the end of the expr."
1212 "Returns '.' for '->' & '.', returns ' ' for white space,
1213 returns '?' for other punctuation."
1229 result))
1232 "Non-nil if concatenating FIRST and SECOND makes a single C token.
1233 The two exprs are represented as a cons cells, where the car
1234 specifies the point in the current buffer that marks the beginning of the
1235 expr and the cdr specifies the character after the end of the expr.
1236 Link exprs of the form:
1237 Expr -> Expr
1238 Expr . Expr
1239 Expr (Expr)
1240 Expr [Expr]
1241 (Expr) Expr
1242 [Expr] Expr"
1260 )
1265 ;;; gud.el ends here