| blob | 8227b8be97e6cc8b2a5396abcc36726356a99c41 |
1 ;;; gud.el --- Grand Unified Debugger mode for gdb, dbx, etc. under Emacs
3 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
4 ;; Maintainer: FSF
5 ;; Keywords: unix, tools
7 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996 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.
39 ;;; Code:
44 ;; ======================================================================
45 ;; GUD commands must be visible in C buffers visited by GUD
62 ;; Don't get confused by double slashes in the name that comes from GDB.
67 ;; Keymap definitions for menu bar entries common to all debuggers and
68 ;; slots for debugger-dependent ones in sensible places. (Defined here
69 ;; before use.)
72 (define-key gud-menu-map [remove] '("Remove Breakpoint" . gud-remove))
73 (define-key gud-menu-map [tbreak] nil) ; gdb, sdb and xdb
74 (define-key gud-menu-map [break] '("Set Breakpoint" . gud-break))
75 (define-key gud-menu-map [up] nil) ; gdb, dbx, and xdb
76 (define-key gud-menu-map [down] nil) ; gdb, dbx, and xdb
77 (define-key gud-menu-map [print] '("Print Expression" . gud-print))
78 (define-key gud-menu-map [finish] nil) ; gdb or xdb
79 (define-key gud-menu-map [stepi] '("Step Instruction" . gud-stepi))
80 (define-key gud-menu-map [step] '("Step Line" . gud-step))
81 (define-key gud-menu-map [next] '("Next Line" . gud-next))
82 (define-key gud-menu-map [cont] '("Continue" . gud-cont))
83 \f
84 ;; ======================================================================
85 ;; command definition
87 ;; This macro is used below to define some basic debugger interface commands.
88 ;; Of course you may use `gud-def' with any other debugger command, including
89 ;; user defined ones.
91 ;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
92 ;; which defines FUNC to send the command NAME to the debugger, gives
93 ;; it the docstring DOC, and binds that function to KEY in the GUD
94 ;; major mode. The function is also bound in the global keymap with the
95 ;; GUD prefix.
97 (defmacro gud-def (func cmd key &optional doc)
98 "Define FUNC to be a command sending STR and bound to KEY, with
99 optional doc string DOC. Certain %-escapes in the string arguments
100 are interpreted specially if present. These are:
102 %f name (without directory) of current source file.
103 %d directory of current source file.
104 %l number of current source line
105 %e text of the C lvalue or function-call expression surrounding point.
106 %a text of the hexadecimal address surrounding point
107 %p prefix argument to the command (if any) as a number
109 The `current' source file is the file of the current buffer (if
110 we're in a C file) or the source file current at the last break or
111 step (if we're in the GUD buffer).
112 The `current' line is that of the current buffer (if we're in a
113 source file) or the source line number at the last break or step (if
114 we're in the GUD buffer)."
115 (list 'progn
116 (list 'defun func '(arg)
117 (or doc "")
118 '(interactive "p")
119 (list 'gud-call cmd 'arg))
120 (if key
121 (list 'define-key
122 '(current-local-map)
123 (concat "\C-c" key)
124 (list 'quote func)))
125 (if key
126 (list 'global-set-key
127 (list 'concat 'gud-key-prefix key)
128 (list 'quote func)))))
130 ;; Where gud-display-frame should put the debugging arrow. This is
131 ;; set by the marker-filter, which scans the debugger's output for
132 ;; indications of the current program counter.
133 (defvar gud-last-frame nil)
135 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
136 ;; the last frame, even if it's been called before and gud-last-frame has
137 ;; been set to nil.
138 (defvar gud-last-last-frame nil)
140 ;; All debugger-specific information is collected here.
141 ;; Here's how it works, in case you ever need to add a debugger to the mode.
142 ;;
143 ;; Each entry must define the following at startup:
144 ;;
145 ;;<name>
146 ;; comint-prompt-regexp
147 ;; gud-<name>-massage-args
148 ;; gud-<name>-marker-filter
149 ;; gud-<name>-find-file
150 ;;
151 ;; The job of the massage-args method is to modify the given list of
152 ;; debugger arguments before running the debugger.
153 ;;
154 ;; The job of the marker-filter method is to detect file/line markers in
155 ;; strings and set the global gud-last-frame to indicate what display
156 ;; action (if any) should be triggered by the marker. Note that only
157 ;; whatever the method *returns* is displayed in the buffer; thus, you
158 ;; can filter the debugger's output, interpreting some and passing on
159 ;; the rest.
160 ;;
161 ;; The job of the find-file method is to visit and return the buffer indicated
162 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
163 ;; something else. It would be good if it also copied the Gud menubar entry.
164 \f
165 ;; ======================================================================
166 ;; gdb functions
168 ;;; History of argument lists passed to gdb.
169 (defvar gud-gdb-history nil)
171 (defun gud-gdb-massage-args (file args)
172 (cons "-fullname" args))
174 (defvar gud-gdb-marker-regexp
175 ;; This used to use path-separator instead of ":";
176 ;; however, we found that on both Windows 32 and MSDOS
177 ;; a colon is correct here.
181 ;; There's no guarantee that Emacs will hand the filter the entire
182 ;; marker at once; it could be broken up across several strings. We
183 ;; might even receive a big chunk with several markers in it. If we
184 ;; receive a chunk of text which looks like it might contain the
185 ;; beginning of a marker, we save it here between calls to the
186 ;; filter.
187 (defvar gud-marker-acc "")
188 (make-variable-buffer-local 'gud-marker-acc)
190 (defun gud-gdb-marker-filter (string)
191 (setq gud-marker-acc (concat gud-marker-acc string))
192 (let ((output ""))
194 ;; Process all the complete markers in this chunk.
195 (while (string-match gud-gdb-marker-regexp gud-marker-acc)
196 (setq
198 ;; Extract the frame position from the marker.
199 gud-last-frame
200 (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
201 (string-to-int (substring gud-marker-acc
202 (match-beginning 2)
203 (match-end 2))))
205 ;; Append any text before the marker to the output we're going
206 ;; to return - we don't include the marker in this text.
207 output (concat output
208 (substring gud-marker-acc 0 (match-beginning 0)))
210 ;; Set the accumulator to the remaining text.
211 gud-marker-acc (substring gud-marker-acc (match-end 0))))
213 ;; Does the remaining text look like it might end with the
214 ;; beginning of another marker? If it does, then keep it in
215 ;; gud-marker-acc until we receive the rest of it. Since we
216 ;; know the full marker regexp above failed, it's pretty simple to
217 ;; test for marker starts.
219 (progn
220 ;; Everything before the potential marker start can be output.
221 (setq output (concat output (substring gud-marker-acc
222 0 (match-beginning 0))))
224 ;; Everything after, we save, to combine with later input.
225 (setq gud-marker-acc
226 (substring gud-marker-acc (match-beginning 0))))
228 (setq output (concat output gud-marker-acc)
229 gud-marker-acc ""))
231 output))
233 (defun gud-gdb-find-file (f)
234 (save-excursion
235 (let ((buf (find-file-noselect f)))
236 (set-buffer buf)
237 (gud-make-debug-menu)
238 (local-set-key [menu-bar debug tbreak]
239 '("Temporary Breakpoint" . gud-tbreak))
240 (local-set-key [menu-bar debug finish] '("Finish Function" . gud-finish))
241 (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
242 (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
243 buf)))
245 (defvar gdb-minibuffer-local-map nil
246 "Keymap for minibuffer prompting of gdb startup command.")
247 (if gdb-minibuffer-local-map
248 ()
249 (setq gdb-minibuffer-local-map (copy-keymap minibuffer-local-map))
250 (define-key
251 gdb-minibuffer-local-map "\C-i" 'comint-dynamic-complete-filename))
253 ;;;###autoload
254 (defun gdb (command-line)
255 "Run gdb on program FILE in buffer *gud-FILE*.
256 The directory containing FILE becomes the initial working directory
257 and source-file directory for your debugger."
258 (interactive
259 (list (read-from-minibuffer "Run gdb (like this): "
260 (if (consp gud-gdb-history)
261 (car gud-gdb-history)
262 "gdb ")
263 gdb-minibuffer-local-map nil
264 '(gud-gdb-history . 1))))
266 (gud-common-init command-line 'gud-gdb-massage-args
267 'gud-gdb-marker-filter 'gud-gdb-find-file)
269 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
270 (gud-def gud-tbreak "tbreak %f:%l" "\C-t" "Set temporary breakpoint at current line.")
271 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
272 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
273 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
274 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
275 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
276 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
277 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
278 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
279 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
281 (local-set-key "\C-i" 'gud-gdb-complete-command)
282 (local-set-key [menu-bar debug tbreak] '("Temporary Breakpoint" . gud-tbreak))
283 (local-set-key [menu-bar debug finish] '("Finish Function" . gud-finish))
284 (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
285 (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
286 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
287 (setq paragraph-start comint-prompt-regexp)
288 (run-hooks 'gdb-mode-hook)
289 )
291 ;; One of the nice features of GDB is its impressive support for
292 ;; context-sensitive command completion. We preserve that feature
293 ;; in the GUD buffer by using a GDB command designed just for Emacs.
295 ;; The completion process filter indicates when it is finished.
296 (defvar gud-gdb-complete-in-progress)
298 ;; Since output may arrive in fragments we accumulate partials strings here.
299 (defvar gud-gdb-complete-string)
301 ;; We need to know how much of the completion to chop off.
302 (defvar gud-gdb-complete-break)
304 ;; The completion list is constructed by the process filter.
305 (defvar gud-gdb-complete-list)
307 (defvar gud-comint-buffer nil)
309 (defun gud-gdb-complete-command ()
310 "Perform completion on the GDB command preceding point.
311 This is implemented using the GDB `complete' command which isn't
312 available with older versions of GDB."
313 (interactive)
314 (let* ((end (point))
315 (command (save-excursion
316 (beginning-of-line)
317 (and (looking-at comint-prompt-regexp)
318 (goto-char (match-end 0)))
319 (buffer-substring (point) end)))
320 command-word)
321 ;; Find the word break. This match will always succeed.
323 (setq gud-gdb-complete-break (match-beginning 2)
324 command-word (substring command gud-gdb-complete-break))
325 ;; Temporarily install our filter function.
326 (let ((gud-marker-filter 'gud-gdb-complete-filter))
327 ;; Issue the command to GDB.
328 (gud-basic-call (concat "complete " command))
329 (setq gud-gdb-complete-in-progress t
330 gud-gdb-complete-string nil
331 gud-gdb-complete-list nil)
332 ;; Slurp the output.
333 (while gud-gdb-complete-in-progress
334 (accept-process-output (get-buffer-process gud-comint-buffer))))
335 ;; Protect against old versions of GDB.
336 (and gud-gdb-complete-list
338 (car gud-gdb-complete-list))
339 (error "This version of GDB doesn't support the `complete' command."))
340 ;; Sort the list like readline.
341 (setq gud-gdb-complete-list
342 (sort gud-gdb-complete-list (function string-lessp)))
343 ;; Remove duplicates.
344 (let ((first gud-gdb-complete-list)
345 (second (cdr gud-gdb-complete-list)))
346 (while second
347 (if (string-equal (car first) (car second))
348 (setcdr first (setq second (cdr second)))
349 (setq first second
350 second (cdr second)))))
351 ;; Add a trailing single quote if there is a unique completion
352 ;; and it contains an odd number of unquoted single quotes.
353 (and (= (length gud-gdb-complete-list) 1)
354 (let ((str (car gud-gdb-complete-list))
355 (pos 0)
356 (count 0))
358 (setq count (1+ count)
359 pos (match-end 0)))
360 (and (= (mod count 2) 1)
361 (setq gud-gdb-complete-list (list (concat str "'"))))))
362 ;; Let comint handle the rest.
363 (comint-dynamic-simple-complete command-word gud-gdb-complete-list)))
365 ;; The completion process filter is installed temporarily to slurp the
366 ;; output of GDB up to the next prompt and build the completion list.
367 (defun gud-gdb-complete-filter (string)
368 (setq string (concat gud-gdb-complete-string string))
370 (setq gud-gdb-complete-list
371 (cons (substring string gud-gdb-complete-break (match-beginning 0))
372 gud-gdb-complete-list))
373 (setq string (substring string (match-end 0))))
374 (if (string-match comint-prompt-regexp string)
375 (progn
376 (setq gud-gdb-complete-in-progress nil)
377 string)
378 (progn
379 (setq gud-gdb-complete-string string)
380 "")))
382 \f
383 ;; ======================================================================
384 ;; sdb functions
386 ;;; History of argument lists passed to sdb.
387 (defvar gud-sdb-history nil)
389 (defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
390 "If nil, we're on a System V Release 4 and don't need the tags hack.")
392 (defvar gud-sdb-lastfile nil)
394 (defun gud-sdb-massage-args (file args) args)
396 (defun gud-sdb-marker-filter (string)
397 (setq gud-marker-acc
398 (if gud-marker-acc (concat gud-marker-acc string) string))
399 (let (start)
400 ;; Process all complete markers in this chunk
401 (while
402 (cond
403 ;; System V Release 3.2 uses this format
405 gud-marker-acc start)
406 (setq gud-last-frame
407 (cons
408 (substring gud-marker-acc (match-beginning 3) (match-end 3))
409 (string-to-int
410 (substring gud-marker-acc (match-beginning 4) (match-end 4))))))
411 ;; System V Release 4.0 quite often clumps two lines together
412 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
413 gud-marker-acc start)
414 (setq gud-sdb-lastfile
415 (substring gud-marker-acc (match-beginning 2) (match-end 2)))
416 (setq gud-last-frame
417 (cons
418 gud-sdb-lastfile
419 (string-to-int
420 (substring gud-marker-acc (match-beginning 3) (match-end 3))))))
421 ;; System V Release 4.0
423 gud-marker-acc start)
424 (setq gud-sdb-lastfile
425 (substring gud-marker-acc (match-beginning 2) (match-end 2))))
427 gud-marker-acc start))
428 (setq gud-last-frame
429 (cons
430 gud-sdb-lastfile
431 (string-to-int
432 (substring gud-marker-acc (match-beginning 1) (match-end 1))))))
433 (t
434 (setq gud-sdb-lastfile nil)))
435 (setq start (match-end 0)))
437 ;; Search for the last incomplete line in this chunk
439 (setq start (match-end 0)))
441 ;; If we have an incomplete line, store it in gud-marker-acc.
442 (setq gud-marker-acc (substring gud-marker-acc (or start 0))))
443 string)
445 (defun gud-sdb-find-file (f)
446 (save-excursion
447 (let ((buf (if gud-sdb-needs-tags
448 (find-tag-noselect f)
449 (find-file-noselect f))))
450 (set-buffer buf)
451 (gud-make-debug-menu)
452 (local-set-key [menu-bar debug tbreak] '("Temporary Breakpoint" . gud-tbreak))
453 buf)))
455 ;;;###autoload
456 (defun sdb (command-line)
457 "Run sdb on program FILE in buffer *gud-FILE*.
458 The directory containing FILE becomes the initial working directory
459 and source-file directory for your debugger."
460 (interactive
461 (list (read-from-minibuffer "Run sdb (like this): "
462 (if (consp gud-sdb-history)
463 (car gud-sdb-history)
464 "sdb ")
465 nil nil
466 '(gud-sdb-history . 1))))
467 (if (and gud-sdb-needs-tags
468 (not (and (boundp 'tags-file-name)
469 (stringp tags-file-name)
470 (file-exists-p tags-file-name))))
471 (error "The sdb support requires a valid tags table to work."))
473 (gud-common-init command-line 'gud-sdb-massage-args
474 'gud-sdb-marker-filter 'gud-sdb-find-file)
476 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
477 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
478 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
479 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
480 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
481 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
482 (gud-def gud-cont "c" "\C-r" "Continue with display.")
483 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
486 (setq paragraph-start comint-prompt-regexp)
487 (local-set-key [menu-bar debug tbreak]
488 '("Temporary Breakpoint" . gud-tbreak))
489 (run-hooks 'sdb-mode-hook)
490 )
491 \f
492 ;; ======================================================================
493 ;; dbx functions
495 ;;; History of argument lists passed to dbx.
496 (defvar gud-dbx-history nil)
498 (defvar gud-dbx-directories nil
499 "*A list of directories that dbx should search for source code.
500 If nil, only source files in the program directory
501 will be known to dbx.
503 The file names should be absolute, or relative to the directory
504 containing the executable being debugged.")
506 (defun gud-dbx-massage-args (file args)
507 (nconc (let ((directories gud-dbx-directories)
508 (result nil))
509 (while directories
510 (setq result (cons (car directories) (cons "-I" result)))
511 (setq directories (cdr directories)))
512 (nreverse result))
513 args))
515 (defun gud-dbx-file-name (f)
516 "Transform a relative file name to an absolute file name, for dbx."
517 (let ((result nil))
518 (if (file-exists-p f)
519 (setq result (expand-file-name f))
520 (let ((directories gud-dbx-directories))
521 (while directories
522 (let ((path (concat (car directories) "/" f)))
523 (if (file-exists-p path)
524 (setq result (expand-file-name path)
525 directories nil)))
526 (setq directories (cdr directories)))))
527 result))
529 (defun gud-dbx-marker-filter (string)
530 (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
532 (let (start)
533 ;; Process all complete markers in this chunk.
534 (while (or (string-match
536 gud-marker-acc start)
537 (string-match
539 gud-marker-acc start))
540 (setq gud-last-frame
541 (cons
542 (substring gud-marker-acc (match-beginning 2) (match-end 2))
543 (string-to-int
544 (substring gud-marker-acc (match-beginning 1) (match-end 1))))
545 start (match-end 0)))
547 ;; Search for the last incomplete line in this chunk
549 (setq start (match-end 0)))
551 ;; If the incomplete line APPEARS to begin with another marker, keep it
552 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
553 ;; unnecessary concat during the next call.
554 (setq gud-marker-acc
556 (substring gud-marker-acc (match-beginning 0))
557 nil)))
558 string)
560 ;; Functions for Mips-style dbx. Given the option `-emacs', documented in
561 ;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
562 (defvar gud-mips-p
563 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
564 ;; We haven't tested gud on this system:
565 (string-match "^mips-[^-]*-riscos" system-configuration)
566 ;; It's documented on OSF/1.3
567 (string-match "^mips-[^-]*-osf1" system-configuration)
568 (string-match "^alpha-[^-]*-osf" system-configuration))
569 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
571 (defun gud-mipsdbx-massage-args (file args)
572 (cons "-emacs" args))
574 ;; This is just like the gdb one except for the regexps since we need to cope
575 ;; with an optional breakpoint number in [] before the ^Z^Z
576 (defun gud-mipsdbx-marker-filter (string)
577 (setq gud-marker-acc (concat gud-marker-acc string))
578 (let ((output ""))
580 ;; Process all the complete markers in this chunk.
581 (while (string-match
582 ;; This is like th gdb marker but with an optional
583 ;; leading break point number like `[1] '
585 gud-marker-acc)
586 (setq
588 ;; Extract the frame position from the marker.
589 gud-last-frame
590 (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
591 (string-to-int (substring gud-marker-acc
592 (match-beginning 2)
593 (match-end 2))))
595 ;; Append any text before the marker to the output we're going
596 ;; to return - we don't include the marker in this text.
597 output (concat output
598 (substring gud-marker-acc 0 (match-beginning 0)))
600 ;; Set the accumulator to the remaining text.
601 gud-marker-acc (substring gud-marker-acc (match-end 0))))
603 ;; Does the remaining text look like it might end with the
604 ;; beginning of another marker? If it does, then keep it in
605 ;; gud-marker-acc until we receive the rest of it. Since we
606 ;; know the full marker regexp above failed, it's pretty simple to
607 ;; test for marker starts.
609 (progn
610 ;; Everything before the potential marker start can be output.
611 (setq output (concat output (substring gud-marker-acc
612 0 (match-beginning 0))))
614 ;; Everything after, we save, to combine with later input.
615 (setq gud-marker-acc
616 (substring gud-marker-acc (match-beginning 0))))
618 (setq output (concat output gud-marker-acc)
619 gud-marker-acc ""))
621 output))
623 ;; The dbx in IRIX is a pain. It doesn't print the file name when
624 ;; stopping at a breakpoint (but you do get it from the `up' and
625 ;; `down' commands...). The only way to extract the information seems
626 ;; to be with a `file' command, although the current line number is
627 ;; available in $curline. Thus we have to look for output which
628 ;; appears to indicate a breakpoint. Then we prod the dbx sub-process
629 ;; to output the information we want with a combination of the
630 ;; `printf' and `file' commands as a pseudo marker which we can
631 ;; recognise next time through the marker-filter. This would be like
632 ;; the gdb marker but you can't get the file name without a newline...
633 ;; Note that gud-remove won't work since Irix dbx expects a breakpoint
634 ;; number rather than a line number etc. Maybe this could be made to
635 ;; work by listing all the breakpoints and picking the one(s) with the
636 ;; correct line number, but life's too short.
637 ;; d.love@dl.ac.uk (Dave Love) can be blamed for this
639 (defvar gud-irix-p
640 (and (string-match "^mips-[^-]*-irix" system-configuration)
642 "Non-nil to assume the interface appropriate for IRIX dbx.
643 This works in IRIX 4, 5 and 6, but `gud-dbx-use-stopformat-p' provides
644 a better solution in 6.1 upwards.")
645 (defvar gud-dbx-use-stopformat-p
647 "Non-nil to use the dbx feature present at least from Irix 6.1
648 whereby $stopformat=1 produces an output format compatiable with
649 `gud-dbx-marker-filter'.")
650 ;; [Irix dbx seems to be a moving target. The dbx output changed
651 ;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
652 ;; the output from `up' is no longer spotted by gud (and it's probably
653 ;; not distinctive enough to try to match it -- use C-<, C->
654 ;; exclusively) . For 5.3 and 6.0, the $curline variable changed to
655 ;; `long long'(why?!), so the printf stuff needed changing. The line
656 ;; number was cast to `long' as a compromise between the new `long
657 ;; long' and the original `int'. This is reported not to work in 6.2,
658 ;; so it's changed back to int -- don't make your sources too long.
659 ;; From Irix6.1 (but not 6.0?) dbx supports an undocumented feature
660 ;; whereby `set $stopformat=1' reportedly produces output compatible
661 ;; with `gud-dbx-marker-filter', which we prefer.
663 ;; The process filter is also somewhat
664 ;; unreliable, sometimes not spotting the markers; I don't know
665 ;; whether there's anything that can be done about that. It would be
666 ;; much better if SGI could be persuaded to (re?)instate the MIPS
667 ;; -emacs flag for gdb-like output (which ought to be possible as most
668 ;; of the communication I've had over it has been from sgi.com).]
670 ;; this filter is influenced by the xdb one rather than the gdb one
671 (defun gud-irixdbx-marker-filter (string)
672 (let (result (case-fold-search nil))
673 (if (or (string-match comint-prompt-regexp string)
675 (setq result (concat gud-marker-acc string)
676 gud-marker-acc "")
677 (setq gud-marker-acc (concat gud-marker-acc string)))
678 (if result
679 (cond
680 ;; look for breakpoint or signal indication e.g.:
681 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
682 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
683 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
684 ((string-match
686 result)
687 ;; prod dbx into printing out the line number and file
688 ;; name in a form we can grok as below
689 (process-send-string (get-buffer-process gud-comint-buffer)
691 ;; look for result of, say, "up" e.g.:
692 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
693 ;; (this will also catch one of the lines printed by "where")
694 ((string-match
696 result)
697 (let ((file (substring result (match-beginning 1)
698 (match-end 1))))
699 (if (file-exists-p file)
700 (setq gud-last-frame
701 (cons
702 (substring
703 result (match-beginning 1) (match-end 1))
704 (string-to-int
705 (substring
706 result (match-beginning 2) (match-end 2)))))))
707 result)
708 ((string-match ; kluged-up marker as above
710 (let ((file (gud-dbx-file-name
711 (substring result (match-beginning 2) (match-end 2)))))
712 (if (and file (file-exists-p file))
713 (setq gud-last-frame
714 (cons
715 file
716 (string-to-int
717 (substring
718 result (match-beginning 1) (match-end 1)))))))
719 (setq result (substring result 0 (match-beginning 0))))))
720 (or result "")))
722 (defun gud-dbx-find-file (f)
723 (save-excursion
724 (let ((realf (gud-dbx-file-name f)))
725 (if realf
726 (let ((buf (find-file-noselect realf)))
727 (set-buffer buf)
728 (gud-make-debug-menu)
729 (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
730 (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
731 buf)
732 nil))))
734 ;;;###autoload
735 (defun dbx (command-line)
736 "Run dbx 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."
739 (interactive
740 (list (read-from-minibuffer "Run dbx (like this): "
741 (if (consp gud-dbx-history)
742 (car gud-dbx-history)
743 "dbx ")
744 nil nil
745 '(gud-dbx-history . 1))))
747 (cond
748 (gud-mips-p
749 (gud-common-init command-line 'gud-mipsdbx-massage-args
750 'gud-mipsdbx-marker-filter 'gud-dbx-find-file))
751 (gud-irix-p
752 (gud-common-init command-line 'gud-dbx-massage-args
753 'gud-irixdbx-marker-filter 'gud-dbx-find-file))
754 (t
755 (gud-common-init command-line 'gud-dbx-massage-args
756 'gud-dbx-marker-filter 'gud-dbx-find-file)))
758 (cond
759 (gud-mips-p
760 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
761 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
763 "\C-b" "Set breakpoint at current line.")
764 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
765 (gud-irix-p
767 "\C-b" "Set breakpoint at current line.")
768 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
770 "<" "Up (numeric arg) stack frames.")
772 ">" "Down (numeric arg) stack frames.")
773 ;; Make dbx give out the source location info that we need.
774 (process-send-string (get-buffer-process gud-comint-buffer)
776 (gud-dbx-use-stopformat-p
777 (process-send-string (get-buffer-process gud-comint-buffer)
779 (t
780 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
781 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
783 "\C-b" "Set breakpoint at current line.")))
785 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
786 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
787 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
788 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
789 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
790 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
793 (setq paragraph-start comint-prompt-regexp)
794 (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
795 (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
796 (run-hooks 'dbx-mode-hook)
797 )
798 \f
799 ;; ======================================================================
800 ;; xdb (HP PARISC debugger) functions
802 ;;; History of argument lists passed to xdb.
803 (defvar gud-xdb-history nil)
805 (defvar gud-xdb-directories nil
806 "*A list of directories that xdb should search for source code.
807 If nil, only source files in the program directory
808 will be known to xdb.
810 The file names should be absolute, or relative to the directory
811 containing the executable being debugged.")
813 (defun gud-xdb-massage-args (file args)
814 (nconc (let ((directories gud-xdb-directories)
815 (result nil))
816 (while directories
817 (setq result (cons (car directories) (cons "-d" result)))
818 (setq directories (cdr directories)))
819 (nreverse result))
820 args))
822 (defun gud-xdb-file-name (f)
823 "Transform a relative pathname to a full pathname in xdb mode"
824 (let ((result nil))
825 (if (file-exists-p f)
826 (setq result (expand-file-name f))
827 (let ((directories gud-xdb-directories))
828 (while directories
829 (let ((path (concat (car directories) "/" f)))
830 (if (file-exists-p path)
831 (setq result (expand-file-name path)
832 directories nil)))
833 (setq directories (cdr directories)))))
834 result))
836 ;; xdb does not print the lines all at once, so we have to accumulate them
837 (defun gud-xdb-marker-filter (string)
838 (let (result)
839 (if (or (string-match comint-prompt-regexp string)
841 (setq result (concat gud-marker-acc string)
842 gud-marker-acc "")
843 (setq gud-marker-acc (concat gud-marker-acc string)))
844 (if result
846 result)
848 result))
849 (let ((line (string-to-int
850 (substring result (match-beginning 2) (match-end 2))))
851 (file (gud-xdb-file-name
852 (substring result (match-beginning 1) (match-end 1)))))
853 (if file
854 (setq gud-last-frame (cons file line))))))
855 (or result "")))
857 (defun gud-xdb-find-file (f)
858 (save-excursion
859 (let ((realf (gud-xdb-file-name f)))
860 (if realf
861 (let ((buf (find-file-noselect realf)))
862 (set-buffer buf)
863 (gud-make-debug-menu)
864 (local-set-key [menu-bar debug tbreak]
865 '("Temporary Breakpoint" . gud-tbreak))
866 (local-set-key [menu-bar debug finish]
867 '("Finish Function" . gud-finish))
868 (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
869 (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
870 buf)
871 nil))))
873 ;;;###autoload
874 (defun xdb (command-line)
875 "Run xdb on program FILE in buffer *gud-FILE*.
876 The directory containing FILE becomes the initial working directory
877 and source-file directory for your debugger.
879 You can set the variable 'gud-xdb-directories' to a list of program source
880 directories if your program contains sources from more than one directory."
881 (interactive
882 (list (read-from-minibuffer "Run xdb (like this): "
883 (if (consp gud-xdb-history)
884 (car gud-xdb-history)
885 "xdb ")
886 nil nil
887 '(gud-xdb-history . 1))))
889 (gud-common-init command-line 'gud-xdb-massage-args
890 'gud-xdb-marker-filter 'gud-xdb-find-file)
892 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
894 "Set temporary breakpoint at current line.")
895 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
896 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
897 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
898 (gud-def gud-cont "c" "\C-r" "Continue with display.")
899 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
900 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
902 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
904 (setq comint-prompt-regexp "^>")
905 (setq paragraph-start comint-prompt-regexp)
906 (local-set-key [menu-bar debug tbreak] '("Temporary Breakpoint" . gud-tbreak))
907 (local-set-key [menu-bar debug finish] '("Finish Function" . gud-finish))
908 (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
909 (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
910 (run-hooks 'xdb-mode-hook))
911 \f
912 ;; ======================================================================
913 ;; perldb functions
915 ;;; History of argument lists passed to perldb.
916 (defvar gud-perldb-history nil)
918 (defun gud-perldb-massage-args (file args)
919 (cond ((equal (car args) "-e")
920 (cons "-d"
921 (cons (car args)
922 (cons (nth 1 args)
923 (cons "--" (cons "-emacs" (cdr (cdr args))))))))
924 (t
925 (cons "-d" (cons (car args) (cons "-emacs" (cdr args)))))))
927 ;; There's no guarantee that Emacs will hand the filter the entire
928 ;; marker at once; it could be broken up across several strings. We
929 ;; might even receive a big chunk with several markers in it. If we
930 ;; receive a chunk of text which looks like it might contain the
931 ;; beginning of a marker, we save it here between calls to the
932 ;; filter.
933 (defvar gud-perldb-marker-acc "")
935 (defun gud-perldb-marker-filter (string)
936 (setq gud-marker-acc (concat gud-marker-acc string))
937 (let ((output ""))
939 ;; Process all the complete markers in this chunk.
941 gud-marker-acc)
942 (setq
944 ;; Extract the frame position from the marker.
945 gud-last-frame
946 (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
947 (string-to-int (substring gud-marker-acc
948 (match-beginning 3)
949 (match-end 3))))
951 ;; Append any text before the marker to the output we're going
952 ;; to return - we don't include the marker in this text.
953 output (concat output
954 (substring gud-marker-acc 0 (match-beginning 0)))
956 ;; Set the accumulator to the remaining text.
957 gud-marker-acc (substring gud-marker-acc (match-end 0))))
959 ;; Does the remaining text look like it might end with the
960 ;; beginning of another marker? If it does, then keep it in
961 ;; gud-marker-acc until we receive the rest of it. Since we
962 ;; know the full marker regexp above failed, it's pretty simple to
963 ;; test for marker starts.
965 (progn
966 ;; Everything before the potential marker start can be output.
967 (setq output (concat output (substring gud-marker-acc
968 0 (match-beginning 0))))
970 ;; Everything after, we save, to combine with later input.
971 (setq gud-marker-acc
972 (substring gud-marker-acc (match-beginning 0))))
974 (setq output (concat output gud-marker-acc)
975 gud-marker-acc ""))
977 output))
979 (defun gud-perldb-find-file (f)
980 (save-excursion
981 (let ((buf (find-file-noselect f)))
982 (set-buffer buf)
983 (gud-make-debug-menu)
984 buf)))
986 (defvar perldb-command-name "perl"
987 "File name for executing Perl.")
989 ;;;###autoload
990 (defun perldb (command-line)
991 "Run perldb on program FILE in buffer *gud-FILE*.
992 The directory containing FILE becomes the initial working directory
993 and source-file directory for your debugger."
994 (interactive
995 (list (read-from-minibuffer "Run perldb (like this): "
996 (if (consp gud-perldb-history)
997 (car gud-perldb-history)
998 (concat perldb-command-name
999 " "
1000 (or (buffer-file-name)
1001 "-e 0"))
1002 " ")
1003 nil nil
1004 '(gud-perldb-history . 1))))
1006 (gud-common-init command-line 'gud-perldb-massage-args
1007 'gud-perldb-marker-filter 'gud-perldb-find-file)
1009 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
1010 (gud-def gud-remove "d %l" "\C-d" "Remove breakpoint at current line")
1011 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
1012 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
1013 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1014 ; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
1015 ; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
1016 ; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
1017 (gud-def gud-print "%e" "\C-p" "Evaluate perl expression at point.")
1019 (setq comint-prompt-regexp "^ DB<+[0-9]+>+ ")
1020 (setq paragraph-start comint-prompt-regexp)
1021 (run-hooks 'perldb-mode-hook)
1022 )
1024 ;;
1025 ;; End of debugger-specific information
1026 ;;
1028 \f
1029 ;;; When we send a command to the debugger via gud-call, it's annoying
1030 ;;; to see the command and the new prompt inserted into the debugger's
1031 ;;; buffer; we have other ways of knowing the command has completed.
1032 ;;;
1033 ;;; If the buffer looks like this:
1034 ;;; --------------------
1035 ;;; (gdb) set args foo bar
1036 ;;; (gdb) -!-
1037 ;;; --------------------
1038 ;;; (the -!- marks the location of point), and we type `C-x SPC' in a
1039 ;;; source file to set a breakpoint, we want the buffer to end up like
1040 ;;; this:
1041 ;;; --------------------
1042 ;;; (gdb) set args foo bar
1043 ;;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
1044 ;;; (gdb) -!-
1045 ;;; --------------------
1046 ;;; Essentially, the old prompt is deleted, and the command's output
1047 ;;; and the new prompt take its place.
1048 ;;;
1049 ;;; Not echoing the command is easy enough; you send it directly using
1050 ;;; process-send-string, and it never enters the buffer. However,
1051 ;;; getting rid of the old prompt is trickier; you don't want to do it
1052 ;;; when you send the command, since that will result in an annoying
1053 ;;; flicker as the prompt is deleted, redisplay occurs while Emacs
1054 ;;; waits for a response from the debugger, and the new prompt is
1055 ;;; inserted. Instead, we'll wait until we actually get some output
1056 ;;; from the subprocess before we delete the prompt. If the command
1057 ;;; produced no output other than a new prompt, that prompt will most
1058 ;;; likely be in the first chunk of output received, so we will delete
1059 ;;; the prompt and then replace it with an identical one. If the
1060 ;;; command produces output, the prompt is moving anyway, so the
1061 ;;; flicker won't be annoying.
1062 ;;;
1063 ;;; So - when we want to delete the prompt upon receipt of the next
1064 ;;; chunk of debugger output, we position gud-delete-prompt-marker at
1065 ;;; the start of the prompt; the process filter will notice this, and
1066 ;;; delete all text between it and the process output marker. If
1067 ;;; gud-delete-prompt-marker points nowhere, we leave the current
1068 ;;; prompt alone.
1069 (defvar gud-delete-prompt-marker nil)
1071 \f
1072 (defun gud-mode ()
1073 "Major mode for interacting with an inferior debugger process.
1075 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
1076 M-x perldb, or M-x xdb. Each entry point finishes by executing a
1077 hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook',
1078 `perldb-mode-hook', or `xdb-mode-hook' respectively.
1080 After startup, the following commands are available in both the GUD
1081 interaction buffer and any source buffer GUD visits due to a breakpoint stop
1082 or step operation:
1085 GUD buffer, the current file and line are those of the last breakpoint or
1086 step. In a source buffer, they are the buffer's file and current line.
1091 in the gud buffer.
1094 step-one-line (not entering function calls), and step-one-instruction
1095 and then update the source window with the current file and position.
1099 around point, and sends it to the debugger for value display.
1101 The above commands are common to all supported debuggers except xdb which
1102 does not support stepping instructions.
1105 except that the breakpoint is temporary; that is, it is removed when
1106 execution stops on it.
1112 the current function and stops.
1114 All the keystrokes above are accessible in the GUD buffer
1115 with the prefix C-c, and in all buffers through the prefix C-x C-a.
1117 All pre-defined functions for which the concept make sense repeat
1118 themselves the appropriate number of times if you give a prefix
1119 argument.
1121 You may use the `gud-def' macro in the initialization hook to define other
1122 commands.
1124 Other commands for interacting with the debugger process are inherited from
1125 comint mode, which see."
1126 (interactive)
1127 (comint-mode)
1128 (setq major-mode 'gud-mode)
1129 (setq mode-name "Debugger")
1130 (setq mode-line-process '(":%s"))
1131 (use-local-map comint-mode-map)
1132 (gud-make-debug-menu)
1133 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
1134 (make-local-variable 'gud-last-frame)
1135 (setq gud-last-frame nil)
1136 (make-local-variable 'comint-prompt-regexp)
1137 ;; Don't put repeated commands in command history many times.
1138 (make-local-variable 'comint-input-ignoredups)
1139 (setq comint-input-ignoredups t)
1140 (make-local-variable 'paragraph-start)
1141 (make-local-variable 'gud-delete-prompt-marker)
1142 (setq gud-delete-prompt-marker (make-marker))
1143 (run-hooks 'gud-mode-hook))
1145 ;; Chop STRING into words separated by SPC or TAB and return a list of them.
1146 (defun gud-chop-words (string)
1147 (let ((i 0) (beg 0)
1148 (len (length string))
1149 (words nil))
1150 (while (< i len)
1152 (progn
1153 (setq words (cons (substring string beg i) words)
1154 beg (1+ i))
1156 (setq beg (1+ beg)))
1157 (setq i (1+ beg)))
1158 (setq i (1+ i))))
1159 (if (< beg len)
1160 (setq words (cons (substring string beg) words)))
1161 (nreverse words)))
1163 ;; Perform initializations common to all debuggers.
1164 ;; The first arg is the specified command line,
1165 ;; which starts with the program to debug.
1166 ;; The other three args specify the values to use
1167 ;; for local variables in the debugger buffer.
1168 (defun gud-common-init (command-line massage-args marker-filter find-file)
1169 (let* ((words (gud-chop-words command-line))
1170 (program (car words))
1171 ;; Extract the file name from WORDS
1172 ;; and put t in its place.
1173 ;; Later on we will put the modified file name arg back there.
1174 (file-word (let ((w (cdr words)))
1175 (while (and w (= ?- (aref (car w) 0)))
1176 (setq w (cdr w)))
1177 (and w
1178 (prog1 (car w)
1179 (setcar w t)))))
1180 (file-subst
1181 (and file-word (substitute-in-file-name file-word)))
1182 (args (cdr words))
1183 ;; If a directory was specified, expand the file name.
1184 ;; Otherwise, don't expand it, so GDB can use the PATH.
1185 ;; A file name without directory is literally valid
1186 ;; only if the file exists in ., and in that case,
1187 ;; omitting the expansion here has no visible effect.
1188 (file (and file-word
1189 (if (file-name-directory file-subst)
1190 (expand-file-name file-subst)
1191 file-subst)))
1192 (filepart (and file-word (concat "-" (file-name-nondirectory file)))))
1193 (switch-to-buffer (concat "*gud" filepart "*"))
1194 ;; Set default-directory to the file's directory.
1195 (and file-word
1196 ;; Don't set default-directory if no directory was specified.
1197 ;; In that case, either the file is found in the current directory,
1198 ;; in which case this setq is a no-op,
1199 ;; or it is found by searching PATH,
1200 ;; in which case we don't know what directory it was found in.
1201 (file-name-directory file)
1202 (setq default-directory (file-name-directory file)))
1203 (or (bolp) (newline))
1205 ;; Put the substituted and expanded file name back in its place.
1206 (let ((w args))
1207 (while (and w (not (eq (car w) t)))
1208 (setq w (cdr w)))
1209 (if w
1210 (setcar w file)))
1211 (apply 'make-comint (concat "gud" filepart) program nil
1212 (funcall massage-args file args)))
1213 ;; Since comint clobbered the mode, we don't set it until now.
1214 (gud-mode)
1215 (make-local-variable 'gud-marker-filter)
1216 (setq gud-marker-filter marker-filter)
1217 (make-local-variable 'gud-find-file)
1218 (setq gud-find-file find-file)
1220 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
1221 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
1222 (gud-set-buffer)
1223 )
1225 (defun gud-set-buffer ()
1226 (cond ((eq major-mode 'gud-mode)
1227 (setq gud-comint-buffer (current-buffer)))))
1229 (defvar gud-filter-defer-flag nil
1230 "Non-nil means don't process anything from the debugger right now.
1231 It is saved for when this flag is not set.")
1233 (defvar gud-filter-pending-text nil
1234 "Non-nil means this is text that has been saved for later in `gud-filter'.")
1236 ;; These functions are responsible for inserting output from your debugger
1237 ;; into the buffer. The hard work is done by the method that is
1238 ;; the value of gud-marker-filter.
1240 (defun gud-filter (proc string)
1241 ;; Here's where the actual buffer insertion is done
1242 (let (output process-window)
1243 (if (buffer-name (process-buffer proc))
1244 (if gud-filter-defer-flag
1245 ;; If we can't process any text now,
1246 ;; save it for later.
1247 (setq gud-filter-pending-text
1248 (concat (or gud-filter-pending-text "") string))
1250 ;; If we have to ask a question during the processing,
1251 ;; defer any additional text that comes from the debugger
1252 ;; during that time.
1253 (let ((gud-filter-defer-flag t))
1254 ;; Process now any text we previously saved up.
1255 (if gud-filter-pending-text
1256 (setq string (concat gud-filter-pending-text string)
1257 gud-filter-pending-text nil))
1258 (save-excursion
1259 (set-buffer (process-buffer proc))
1260 ;; If we have been so requested, delete the debugger prompt.
1261 (if (marker-buffer gud-delete-prompt-marker)
1262 (progn
1263 (delete-region (process-mark proc) gud-delete-prompt-marker)
1264 (set-marker gud-delete-prompt-marker nil)))
1265 ;; Save the process output, checking for source file markers.
1266 (setq output (gud-marker-filter string))
1267 ;; Check for a filename-and-line number.
1268 ;; Don't display the specified file
1269 ;; unless (1) point is at or after the position where output appears
1270 ;; and (2) this buffer is on the screen.
1271 (setq process-window
1272 (and gud-last-frame
1273 (>= (point) (process-mark proc))
1274 (get-buffer-window (current-buffer))))
1276 ;; Let the comint filter do the actual insertion.
1277 ;; That lets us inherit various comint features.
1278 (comint-output-filter proc output)))
1280 ;; Put the arrow on the source line.
1281 ;; This must be outside of the save-excursion
1282 ;; in case the source file is our current buffer.
1283 (if process-window
1284 (save-selected-window
1285 (select-window process-window)
1286 (gud-display-frame))
1287 ;; We have to be in the proper buffer, (process-buffer proc),
1288 ;; but not in a save-excursion, because that would restore point.
1289 (let ((old-buf (current-buffer)))
1290 (set-buffer (process-buffer proc))
1291 (unwind-protect
1292 (gud-display-frame)
1293 (set-buffer old-buf))))
1295 ;; If we deferred text that arrived during this processing,
1296 ;; handle it now.
1297 (if gud-filter-pending-text
1298 (gud-filter proc ""))))))
1300 (defun gud-sentinel (proc msg)
1301 (cond ((null (buffer-name (process-buffer proc)))
1302 ;; buffer killed
1303 ;; Stop displaying an arrow in a source file.
1304 (setq overlay-arrow-position nil)
1305 (set-process-buffer proc nil))
1306 ((memq (process-status proc) '(signal exit))
1307 ;; Stop displaying an arrow in a source file.
1308 (setq overlay-arrow-position nil)
1309 ;; Fix the mode line.
1310 (setq mode-line-process
1311 (concat ":"
1312 (symbol-name (process-status proc))))
1313 (let* ((obuf (current-buffer)))
1314 ;; save-excursion isn't the right thing if
1315 ;; process-buffer is current-buffer
1316 (unwind-protect
1317 (progn
1318 ;; Write something in *compilation* and hack its mode line,
1319 (set-buffer (process-buffer proc))
1320 (force-mode-line-update)
1321 (if (eobp)
1323 (save-excursion
1324 (goto-char (point-max))
1326 ;; If buffer and mode line will show that the process
1327 ;; is dead, we can delete it now. Otherwise it
1328 ;; will stay around until M-x list-processes.
1329 (delete-process proc))
1330 ;; Restore old buffer, but don't restore old point
1331 ;; if obuf is the gud buffer.
1332 (set-buffer obuf))))))
1334 (defun gud-display-frame ()
1335 "Find and obey the last filename-and-line marker from the debugger.
1336 Obeying it means displaying in another window the specified file and line."
1337 (interactive)
1338 (if gud-last-frame
1339 (progn
1340 (gud-set-buffer)
1341 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
1342 (setq gud-last-last-frame gud-last-frame
1343 gud-last-frame nil))))
1345 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
1346 ;; and that its line LINE is visible.
1347 ;; Put the overlay-arrow on the line LINE in that buffer.
1348 ;; Most of the trickiness in here comes from wanting to preserve the current
1349 ;; region-restriction if that's possible. We use an explicit display-buffer
1350 ;; to get around the fact that this is called inside a save-excursion.
1352 (defun gud-display-line (true-file line)
1353 (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
1354 (buffer
1355 (save-excursion
1356 (or (eq (current-buffer) gud-comint-buffer)
1357 (set-buffer gud-comint-buffer))
1358 (gud-find-file true-file)))
1359 (window (and buffer (or (get-buffer-window buffer)
1360 (display-buffer buffer))))
1361 (pos))
1362 (if buffer
1363 (progn
1364 (save-excursion
1365 (set-buffer buffer)
1366 (save-restriction
1367 (widen)
1368 (goto-line line)
1369 (setq pos (point))
1370 (setq overlay-arrow-string "=>")
1371 (or overlay-arrow-position
1372 (setq overlay-arrow-position (make-marker)))
1373 (set-marker overlay-arrow-position (point) (current-buffer)))
1374 (cond ((or (< pos (point-min)) (> pos (point-max)))
1375 (widen)
1376 (goto-char pos))))
1377 (set-window-point window overlay-arrow-position)))))
1379 ;;; The gud-call function must do the right thing whether its invoking
1380 ;;; keystroke is from the GUD buffer itself (via major-mode binding)
1381 ;;; or a C buffer. In the former case, we want to supply data from
1382 ;;; gud-last-frame. Here's how we do it:
1384 (defun gud-format-command (str arg)
1385 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
1386 (frame (or gud-last-frame gud-last-last-frame))
1387 result)
1389 (let ((key (string-to-char (substring str (match-beginning 2))))
1390 subst)
1391 (cond
1392 ((eq key ?f)
1393 (setq subst (file-name-nondirectory (if insource
1394 (buffer-file-name)
1395 (car frame)))))
1396 ((eq key ?d)
1397 (setq subst (file-name-directory (if insource
1398 (buffer-file-name)
1399 (car frame)))))
1400 ((eq key ?l)
1401 (setq subst (if insource
1402 (save-excursion
1403 (beginning-of-line)
1404 (save-restriction (widen)
1405 (1+ (count-lines 1 (point)))))
1406 (cdr frame))))
1407 ((eq key ?e)
1408 (setq subst (gud-find-c-expr)))
1409 ((eq key ?a)
1410 (setq subst (gud-read-address)))
1411 ((eq key ?p)
1412 (setq subst (if arg (int-to-string arg) ""))))
1413 (setq result (concat result
1414 (substring str (match-beginning 1) (match-end 1))
1415 subst)))
1416 (setq str (substring str (match-end 2))))
1417 ;; There might be text left in STR when the loop ends.
1418 (concat result str)))
1420 (defun gud-read-address ()
1421 "Return a string containing the core-address found in the buffer at point."
1422 (save-excursion
1423 (let ((pt (point)) found begin)
1424 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
1425 (cond
1426 (found (forward-char 2)
1427 (buffer-substring found
1428 (progn (re-search-forward "[^0-9a-f]")
1429 (forward-char -1)
1430 (point))))
1431 (t (setq begin (progn (re-search-backward "[^0-9]")
1432 (forward-char 1)
1433 (point)))
1434 (forward-char 1)
1435 (re-search-forward "[^0-9]")
1436 (forward-char -1)
1437 (buffer-substring begin (point)))))))
1439 (defun gud-call (fmt &optional arg)
1440 (let ((msg (gud-format-command fmt arg)))
1441 (message "Command: %s" msg)
1442 (sit-for 0)
1443 (gud-basic-call msg)))
1445 (defun gud-basic-call (command)
1446 "Invoke the debugger COMMAND displaying source in other window."
1447 (interactive)
1448 (gud-set-buffer)
1450 (proc (get-buffer-process gud-comint-buffer)))
1451 (or proc (error "Current buffer has no process"))
1452 ;; Arrange for the current prompt to get deleted.
1453 (save-excursion
1454 (set-buffer gud-comint-buffer)
1455 (goto-char (process-mark proc))
1456 (beginning-of-line)
1457 (if (looking-at comint-prompt-regexp)
1458 (set-marker gud-delete-prompt-marker (point))))
1459 (process-send-string proc command)))
1461 (defun gud-refresh (&optional arg)
1462 "Fix up a possibly garbled display, and redraw the arrow."
1463 (interactive "P")
1464 (recenter arg)
1465 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
1466 (gud-display-frame))
1467 \f
1469 (defun gud-new-keymap (map)
1470 "Return a new keymap which inherits from MAP and has name `Gud'."
1471 (nconc (make-sparse-keymap "Gud") map))
1473 (defun gud-make-debug-menu ()
1474 "Make sure the current local map has a [menu-bar debug] submap.
1475 If it doesn't, replace it with a new map that inherits it,
1476 and create such a submap in that new map."
1477 (if (and (current-local-map)
1478 (lookup-key (current-local-map) [menu-bar debug]))
1479 nil
1480 (use-local-map (gud-new-keymap (current-local-map)))
1481 (define-key (current-local-map) [menu-bar debug]
1482 (cons "Gud" (gud-new-keymap gud-menu-map)))))
1483 \f
1484 ;;; Code for parsing expressions out of C code. The single entry point is
1485 ;;; find-c-expr, which tries to return an lvalue expression from around point.
1486 ;;;
1487 ;;; The rest of this file is a hacked version of gdbsrc.el by
1488 ;;; Debby Ayers <ayers@asc.slb.com>,
1489 ;;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
1491 (defun gud-find-c-expr ()
1492 "Returns the C expr that surrounds point."
1493 (interactive)
1494 (save-excursion
1495 (let (p expr test-expr)
1496 (setq p (point))
1497 (setq expr (gud-innermost-expr))
1498 (setq test-expr (gud-prev-expr))
1499 (while (and test-expr (gud-expr-compound test-expr expr))
1500 (let ((prev-expr expr))
1501 (setq expr (cons (car test-expr) (cdr expr)))
1502 (goto-char (car expr))
1503 (setq test-expr (gud-prev-expr))
1504 ;; If we just pasted on the condition of an if or while,
1505 ;; throw it away again.
1506 (if (member (buffer-substring (car test-expr) (cdr test-expr))
1507 '("if" "while" "for"))
1508 (setq test-expr nil
1509 expr prev-expr))))
1510 (goto-char p)
1511 (setq test-expr (gud-next-expr))
1512 (while (gud-expr-compound expr test-expr)
1513 (setq expr (cons (car expr) (cdr test-expr)))
1514 (setq test-expr (gud-next-expr))
1515 )
1516 (buffer-substring (car expr) (cdr expr)))))
1518 (defun gud-innermost-expr ()
1519 "Returns the smallest expr that point is in; move point to beginning of it.
1520 The expr is represented as a cons cell, where the car specifies the point in
1521 the current buffer that marks the beginning of the expr and the cdr specifies
1522 the character after the end of the expr."
1523 (let ((p (point)) begin end)
1524 (gud-backward-sexp)
1525 (setq begin (point))
1526 (gud-forward-sexp)
1527 (setq end (point))
1528 (if (>= p end)
1529 (progn
1530 (setq begin p)
1531 (goto-char p)
1532 (gud-forward-sexp)
1533 (setq end (point)))
1534 )
1535 (goto-char begin)
1536 (cons begin end)))
1538 (defun gud-backward-sexp ()
1539 "Version of `backward-sexp' that catches errors."
1540 (condition-case nil
1541 (backward-sexp)
1542 (error t)))
1544 (defun gud-forward-sexp ()
1545 "Version of `forward-sexp' that catches errors."
1546 (condition-case nil
1547 (forward-sexp)
1548 (error t)))
1550 (defun gud-prev-expr ()
1551 "Returns the previous expr, point is set to beginning of that expr.
1552 The expr is represented as a cons cell, where the car specifies the point in
1553 the current buffer that marks the beginning of the expr and the cdr specifies
1554 the character after the end of the expr"
1555 (let ((begin) (end))
1556 (gud-backward-sexp)
1557 (setq begin (point))
1558 (gud-forward-sexp)
1559 (setq end (point))
1560 (goto-char begin)
1561 (cons begin end)))
1563 (defun gud-next-expr ()
1564 "Returns the following expr, point is set to beginning of that expr.
1565 The expr is represented as a cons cell, where the car specifies the point in
1566 the current buffer that marks the beginning of the expr and the cdr specifies
1567 the character after the end of the expr."
1568 (let ((begin) (end))
1569 (gud-forward-sexp)
1570 (gud-forward-sexp)
1571 (setq end (point))
1572 (gud-backward-sexp)
1573 (setq begin (point))
1574 (cons begin end)))
1576 (defun gud-expr-compound-sep (span-start span-end)
1577 "Scan from SPAN-START to SPAN-END for punctuation characters.
1578 If `->' is found, return `?.'. If `.' is found, return `?.'.
1579 If any other punctuation is found, return `??'.
1580 If no punctuation is found, return `? '."
1581 (let ((result ?\ )
1582 (syntax))
1583 (while (< span-start span-end)
1584 (setq syntax (char-syntax (char-after span-start)))
1585 (cond
1586 ((= syntax ?\ ) t)
1587 ((= syntax ?.) (setq syntax (char-after span-start))
1588 (cond
1589 ((= syntax ?.) (setq result ?.))
1590 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
1591 (setq result ?.)
1592 (setq span-start (+ span-start 1)))
1593 (t (setq span-start span-end)
1594 (setq result ??)))))
1595 (setq span-start (+ span-start 1)))
1596 result))
1598 (defun gud-expr-compound (first second)
1599 "Non-nil if concatenating FIRST and SECOND makes a single C expression.
1600 The two exprs are represented as a cons cells, where the car
1601 specifies the point in the current buffer that marks the beginning of the
1602 expr and the cdr specifies the character after the end of the expr.
1603 Link exprs of the form:
1604 Expr -> Expr
1605 Expr . Expr
1606 Expr (Expr)
1607 Expr [Expr]
1608 (Expr) Expr
1609 [Expr] Expr"
1610 (let ((span-start (cdr first))
1611 (span-end (car second))
1612 (syntax))
1613 (setq syntax (gud-expr-compound-sep span-start span-end))
1614 (cond
1615 ((= (car first) (car second)) nil)
1616 ((= (cdr first) (cdr second)) nil)
1617 ((= syntax ?.) t)
1618 ((= syntax ?\ )
1619 (setq span-start (char-after (- span-start 1)))
1620 (setq span-end (char-after span-end))
1621 (cond
1622 ((= span-start ?)) t)
1623 ((= span-start ?]) t)
1624 ((= span-end ?() t)
1625 ((= span-end ?[) t)
1626 (t nil)))
1627 (t nil))))
1629 (provide 'gud)
1631 ;;; gud.el ends here