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