(vc-start-entry): Prevent lossage when doing a mass checkin from
[bpt/emacs.git] / lisp / gud.el
CommitLineData
6496f3d2
RS
1;;; gud.el --- Grand Unified Debugger mode for gdb, sdb, dbx, or xdb
2;;; under Emacs
f961a17c 3
ee0155df 4;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
8ba194fc 5;; Maintainer: FSF
f961a17c
ER
6;; Keywords: unix, tools
7
f8c25f1b 8;; Copyright (C) 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
13b80a60
ER
9
10;; This file is part of GNU Emacs.
11
12;; GNU Emacs is free software; you can redistribute it and/or modify
13;; it under the terms of the GNU General Public License as published by
24d725c2 14;; the Free Software Foundation; either version 2, or (at your option)
13b80a60
ER
15;; any later version.
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
23;; along with GNU Emacs; see the file COPYING. If not, write to
24;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25
f961a17c
ER
26;;; Commentary:
27
13b80a60 28;; The ancestral gdb.el was by W. Schelter <wfs@rascal.ics.utexas.edu>
24d725c2 29;; It was later rewritten by rms. Some ideas were due to Masanobu.
f961a17c 30;; Grand Unification (sdb/dbx support) by Eric S. Raymond <esr@thyrsus.com>
13b80a60 31;; The overloading code was then rewritten by Barry Warsaw <bwarsaw@cen.com>,
6496f3d2 32;; who also hacked the mode to use comint.el. Shane Hartman <shane@spr.com>
0e0de659 33;; added support for xdb (HPUX debugger). Rick Sladkey <jrs@world.std.com>
f266485d 34;; wrote the GDB command completion code. Dave Love <d.love@dl.ac.uk>
2291bfaa
RS
35;; added the IRIX kluge, re-implemented the Mips-ish variant and added
36;; a menu.
13b80a60 37
f961a17c
ER
38;;; Code:
39
13b80a60 40(require 'comint)
e8a57935 41(require 'etags)
13b80a60 42
ee0155df 43;; ======================================================================
5b08a462 44;; GUD commands must be visible in C buffers visited by GUD
ee0155df 45
45025813 46(defvar gud-key-prefix "\C-x\C-a"
5b08a462 47 "Prefix of all GUD commands valid in C buffers.")
ee0155df 48
5b08a462 49(global-set-key (concat gud-key-prefix "\C-l") 'gud-refresh)
16776e8d 50(define-key ctl-x-map " " 'gud-break) ;; backward compatibility hack
ee0155df 51
ee97eac3
RS
52(defvar gud-marker-filter nil)
53(put 'gud-marker-filter 'permanent-local t)
54(defvar gud-find-file nil)
55(put 'gud-find-file 'permanent-local t)
56
ee97eac3
RS
57(defun gud-marker-filter (&rest args)
58 (apply gud-marker-filter args))
59
60(defun gud-find-file (file)
61 ;; Don't get confused by double slashes in the name that comes from GDB.
62 (while (string-match "//+" file)
63 (setq file (replace-match "/" t t file)))
64 (funcall gud-find-file file))
9bb4544b
RS
65
66;; Keymap definitions for menu bar entries common to all debuggers and
67;; slots for debugger-dependent ones in sensible places. (Defined here
68;; before use.)
69(defvar gud-menu-map (make-sparse-keymap "Gud") nil)
70(define-key gud-menu-map [refresh] '("Refresh" . gud-refresh))
b3ede706 71(define-key gud-menu-map [remove] '("Remove Breakpoint" . gud-remove))
9bb4544b 72(define-key gud-menu-map [tbreak] nil) ; gdb, sdb and xdb
b3ede706 73(define-key gud-menu-map [break] '("Set Breakpoint" . gud-break))
9bb4544b
RS
74(define-key gud-menu-map [up] nil) ; gdb, dbx, and xdb
75(define-key gud-menu-map [down] nil) ; gdb, dbx, and xdb
b3ede706 76(define-key gud-menu-map [print] '("Print Expression" . gud-print))
9bb4544b 77(define-key gud-menu-map [finish] nil) ; gdb or xdb
b3ede706
KH
78(define-key gud-menu-map [stepi] '("Step Instruction" . gud-stepi))
79(define-key gud-menu-map [step] '("Step Line" . gud-step))
80(define-key gud-menu-map [next] '("Next Line" . gud-next))
9bb4544b 81(define-key gud-menu-map [cont] '("Continue" . gud-cont))
575661b1 82\f
ee0155df
ER
83;; ======================================================================
84;; command definition
13b80a60
ER
85
86;; This macro is used below to define some basic debugger interface commands.
f961a17c 87;; Of course you may use `gud-def' with any other debugger command, including
6bde8427
JB
88;; user defined ones.
89
90;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
91;; which defines FUNC to send the command NAME to the debugger, gives
ee0155df 92;; it the docstring DOC, and binds that function to KEY in the GUD
5b08a462
ER
93;; major mode. The function is also bound in the global keymap with the
94;; GUD prefix.
ee0155df
ER
95
96(defmacro gud-def (func cmd key &optional doc)
97 "Define FUNC to be a command sending STR and bound to KEY, with
98optional doc string DOC. Certain %-escapes in the string arguments
99are interpreted specially if present. These are:
100
7f359a21
RS
101 %f name (without directory) of current source file.
102 %d directory of current source file.
ee0155df
ER
103 %l number of current source line
104 %e text of the C lvalue or function-call expression surrounding point.
105 %a text of the hexadecimal address surrounding point
106 %p prefix argument to the command (if any) as a number
107
5b08a462
ER
108 The `current' source file is the file of the current buffer (if
109we're in a C file) or the source file current at the last break or
110step (if we're in the GUD buffer).
111 The `current' line is that of the current buffer (if we're in a
112source file) or the source line number at the last break or step (if
113we're in the GUD buffer)."
ee0155df
ER
114 (list 'progn
115 (list 'defun func '(arg)
116 (or doc "")
117 '(interactive "p")
118 (list 'gud-call cmd 'arg))
119 (if key
dd8e46c7
RS
120 (list 'define-key
121 '(current-local-map)
122 (concat "\C-c" key)
123 (list 'quote func)))
124 (if key
125 (list 'global-set-key
2352cbea 126 (list 'concat 'gud-key-prefix key)
dd8e46c7 127 (list 'quote func)))))
13b80a60 128
d840a865
JB
129;; Where gud-display-frame should put the debugging arrow. This is
130;; set by the marker-filter, which scans the debugger's output for
ee0155df 131;; indications of the current program counter.
d840a865
JB
132(defvar gud-last-frame nil)
133
32ab4c10
JB
134;; Used by gud-refresh, which should cause gud-display-frame to redisplay
135;; the last frame, even if it's been called before and gud-last-frame has
136;; been set to nil.
7447c37a 137(defvar gud-last-last-frame nil)
32ab4c10 138
ee0155df
ER
139;; All debugger-specific information is collected here.
140;; Here's how it works, in case you ever need to add a debugger to the mode.
13b80a60
ER
141;;
142;; Each entry must define the following at startup:
143;;
144;;<name>
145;; comint-prompt-regexp
a223b10d 146;; gud-<name>-massage-args
13b80a60 147;; gud-<name>-marker-filter
ee0155df 148;; gud-<name>-find-file
13b80a60 149;;
a223b10d
RM
150;; The job of the massage-args method is to modify the given list of
151;; debugger arguments before running the debugger.
10a4c11f
JB
152;;
153;; The job of the marker-filter method is to detect file/line markers in
154;; strings and set the global gud-last-frame to indicate what display
155;; action (if any) should be triggered by the marker. Note that only
eb8c3be9 156;; whatever the method *returns* is displayed in the buffer; thus, you
10a4c11f
JB
157;; can filter the debugger's output, interpreting some and passing on
158;; the rest.
159;;
ee0155df 160;; The job of the find-file method is to visit and return the buffer indicated
10a4c11f 161;; by the car of gud-tag-frame. This may be a file name, a tag name, or
2291bfaa 162;; something else. It would be good if it also copied the Gud menubar entry.
575661b1 163\f
13b80a60
ER
164;; ======================================================================
165;; gdb functions
166
f6376199
JB
167;;; History of argument lists passed to gdb.
168(defvar gud-gdb-history nil)
169
a223b10d 170(defun gud-gdb-massage-args (file args)
dfbd82a6 171 (cons "-fullname" args))
13b80a60 172
dfb7d195
KH
173(defvar gud-gdb-marker-regexp
174 (concat "\032\032\\([^" path-separator "\n]*\\)" path-separator
175 "\\([0-9]*\\)" path-separator ".*\n"))
176
768c29d0
JB
177;; There's no guarantee that Emacs will hand the filter the entire
178;; marker at once; it could be broken up across several strings. We
179;; might even receive a big chunk with several markers in it. If we
180;; receive a chunk of text which looks like it might contain the
181;; beginning of a marker, we save it here between calls to the
182;; filter.
f266485d 183(defvar gud-marker-acc "")
0d29cfe9 184(make-variable-buffer-local 'gud-marker-acc)
768c29d0 185
ee0155df 186(defun gud-gdb-marker-filter (string)
bed6a98d
RS
187 (setq gud-marker-acc (concat gud-marker-acc string))
188 (let ((output ""))
189
190 ;; Process all the complete markers in this chunk.
dfb7d195 191 (while (string-match gud-gdb-marker-regexp gud-marker-acc)
bed6a98d
RS
192 (setq
193
194 ;; Extract the frame position from the marker.
195 gud-last-frame
196 (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
197 (string-to-int (substring gud-marker-acc
198 (match-beginning 2)
199 (match-end 2))))
200
201 ;; Append any text before the marker to the output we're going
202 ;; to return - we don't include the marker in this text.
203 output (concat output
204 (substring gud-marker-acc 0 (match-beginning 0)))
205
206 ;; Set the accumulator to the remaining text.
207 gud-marker-acc (substring gud-marker-acc (match-end 0))))
208
209 ;; Does the remaining text look like it might end with the
210 ;; beginning of another marker? If it does, then keep it in
211 ;; gud-marker-acc until we receive the rest of it. Since we
212 ;; know the full marker regexp above failed, it's pretty simple to
213 ;; test for marker starts.
214 (if (string-match "\032.*\\'" gud-marker-acc)
215 (progn
216 ;; Everything before the potential marker start can be output.
217 (setq output (concat output (substring gud-marker-acc
218 0 (match-beginning 0))))
219
220 ;; Everything after, we save, to combine with later input.
221 (setq gud-marker-acc
222 (substring gud-marker-acc (match-beginning 0))))
223
224 (setq output (concat output gud-marker-acc)
225 gud-marker-acc ""))
226
227 output))
13b80a60 228
23a3aa0a
RS
229(defun gud-new-keymap (map)
230 "Return a new keymap which inherits from MAP and has name `Gud'."
231 (nconc (make-sparse-keymap "Gud") map))
232
07fc7c8a
KH
233(defun gud-make-debug-menu ()
234 "Make sure the current local map has a [menu-bar debug] submap.
235If it doesn't, replace it with a new map that inherits it,
236and create such a submap in that new map."
e0316300
RS
237 (if (and (current-local-map)
238 (lookup-key (current-local-map) [menu-bar debug]))
07fc7c8a
KH
239 nil
240 (use-local-map (gud-new-keymap (current-local-map)))
241 (define-key (current-local-map) [menu-bar debug]
242 (cons "Gud" (gud-new-keymap gud-menu-map)))))
243
ee0155df 244(defun gud-gdb-find-file (f)
9bb4544b
RS
245 (save-excursion
246 (let ((buf (find-file-noselect f)))
247 (set-buffer buf)
07fc7c8a 248 (gud-make-debug-menu)
9bb4544b 249 (local-set-key [menu-bar debug tbreak]
b3ede706
KH
250 '("Temporary Breakpoint" . gud-tbreak))
251 (local-set-key [menu-bar debug finish] '("Finish Function" . gud-finish))
252 (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
253 (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
9bb4544b 254 buf)))
13b80a60 255
e886137a
KH
256(defvar gdb-minibuffer-local-map nil
257 "Keymap for minibuffer prompting of gdb startup command.")
258(if gdb-minibuffer-local-map
259 ()
260 (setq gdb-minibuffer-local-map (copy-keymap minibuffer-local-map))
261 (define-key
262 gdb-minibuffer-local-map "\C-i" 'comint-dynamic-complete-filename))
263
10a4c11f 264;;;###autoload
a223b10d 265(defun gdb (command-line)
13b80a60
ER
266 "Run gdb on program FILE in buffer *gud-FILE*.
267The directory containing FILE becomes the initial working directory
268and source-file directory for your debugger."
f6376199 269 (interactive
a223b10d 270 (list (read-from-minibuffer "Run gdb (like this): "
f6376199
JB
271 (if (consp gud-gdb-history)
272 (car gud-gdb-history)
a223b10d 273 "gdb ")
e886137a 274 gdb-minibuffer-local-map nil
f6376199 275 '(gud-gdb-history . 1))))
ee0155df 276
ee97eac3
RS
277 (gud-common-init command-line 'gud-gdb-massage-args
278 'gud-gdb-marker-filter 'gud-gdb-find-file)
5b08a462 279
dd8e46c7 280 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
2fb419e1 281 (gud-def gud-tbreak "tbreak %f:%l" "\C-t" "Set temporary breakpoint at current line.")
23a3aa0a 282 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
dd8e46c7
RS
283 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
284 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
285 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
286 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
287 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
ee0155df
ER
288 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
289 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
dd8e46c7 290 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
ee0155df 291
0e0de659 292 (local-set-key "\C-i" 'gud-gdb-complete-command)
b3ede706
KH
293 (local-set-key [menu-bar debug tbreak] '("Temporary Breakpoint" . gud-tbreak))
294 (local-set-key [menu-bar debug finish] '("Finish Function" . gud-finish))
295 (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
296 (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
13b80a60 297 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
f54877b2 298 (setq paragraph-start comint-prompt-regexp)
13b80a60
ER
299 (run-hooks 'gdb-mode-hook)
300 )
301
0e0de659
RS
302;; One of the nice features of GDB is its impressive support for
303;; context-sensitive command completion. We preserve that feature
304;; in the GUD buffer by using a GDB command designed just for Emacs.
305
306;; The completion process filter indicates when it is finished.
307(defvar gud-gdb-complete-in-progress)
308
309;; Since output may arrive in fragments we accumulate partials strings here.
310(defvar gud-gdb-complete-string)
311
312;; We need to know how much of the completion to chop off.
313(defvar gud-gdb-complete-break)
314
315;; The completion list is constructed by the process filter.
316(defvar gud-gdb-complete-list)
317
30df2a53
RS
318(defvar gud-comint-buffer nil)
319
0e0de659
RS
320(defun gud-gdb-complete-command ()
321 "Perform completion on the GDB command preceding point.
322This is implemented using the GDB `complete' command which isn't
323available with older versions of GDB."
324 (interactive)
325 (let* ((end (point))
326 (command (save-excursion
327 (beginning-of-line)
328 (and (looking-at comint-prompt-regexp)
329 (goto-char (match-end 0)))
330 (buffer-substring (point) end)))
331 command-word)
332 ;; Find the word break. This match will always succeed.
333 (string-match "\\(\\`\\| \\)\\([^ ]*\\)\\'" command)
334 (setq gud-gdb-complete-break (match-beginning 2)
335 command-word (substring command gud-gdb-complete-break))
ee97eac3
RS
336 ;; Temporarily install our filter function.
337 (let ((gud-marker-filter 'gud-gdb-complete-filter))
338 ;; Issue the command to GDB.
339 (gud-basic-call (concat "complete " command))
340 (setq gud-gdb-complete-in-progress t
341 gud-gdb-complete-string nil
342 gud-gdb-complete-list nil)
343 ;; Slurp the output.
344 (while gud-gdb-complete-in-progress
345 (accept-process-output (get-buffer-process gud-comint-buffer))))
0e0de659
RS
346 ;; Protect against old versions of GDB.
347 (and gud-gdb-complete-list
348 (string-match "^Undefined command: \"complete\""
349 (car gud-gdb-complete-list))
350 (error "This version of GDB doesn't support the `complete' command."))
351 ;; Sort the list like readline.
352 (setq gud-gdb-complete-list
353 (sort gud-gdb-complete-list (function string-lessp)))
354 ;; Remove duplicates.
355 (let ((first gud-gdb-complete-list)
356 (second (cdr gud-gdb-complete-list)))
357 (while second
358 (if (string-equal (car first) (car second))
359 (setcdr first (setq second (cdr second)))
360 (setq first second
361 second (cdr second)))))
fd63b4f4
KH
362 ;; Add a trailing single quote if there is a unique completion
363 ;; and it contains an odd number of unquoted single quotes.
364 (and (= (length gud-gdb-complete-list) 1)
365 (let ((str (car gud-gdb-complete-list))
366 (pos 0)
367 (count 0))
368 (while (string-match "\\([^'\\]\\|\\\\'\\)*'" str pos)
369 (setq count (1+ count)
370 pos (match-end 0)))
371 (and (= (mod count 2) 1)
372 (setq gud-gdb-complete-list (list (concat str "'"))))))
0e0de659
RS
373 ;; Let comint handle the rest.
374 (comint-dynamic-simple-complete command-word gud-gdb-complete-list)))
375
376;; The completion process filter is installed temporarily to slurp the
377;; output of GDB up to the next prompt and build the completion list.
378(defun gud-gdb-complete-filter (string)
379 (setq string (concat gud-gdb-complete-string string))
380 (while (string-match "\n" string)
381 (setq gud-gdb-complete-list
382 (cons (substring string gud-gdb-complete-break (match-beginning 0))
383 gud-gdb-complete-list))
384 (setq string (substring string (match-end 0))))
385 (if (string-match comint-prompt-regexp string)
386 (progn
387 (setq gud-gdb-complete-in-progress nil)
388 string)
389 (progn
390 (setq gud-gdb-complete-string string)
391 "")))
392
575661b1 393\f
13b80a60
ER
394;; ======================================================================
395;; sdb functions
396
f6376199
JB
397;;; History of argument lists passed to sdb.
398(defvar gud-sdb-history nil)
399
ee0155df
ER
400(defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
401 "If nil, we're on a System V Release 4 and don't need the tags hack.")
402
403(defvar gud-sdb-lastfile nil)
404
dfbd82a6 405(defun gud-sdb-massage-args (file args) args)
13b80a60 406
ee0155df 407(defun gud-sdb-marker-filter (string)
7f629252
RS
408 (setq gud-marker-acc
409 (if gud-marker-acc (concat gud-marker-acc string) string))
410 (let (start)
411 ;; Process all complete markers in this chunk
412 (while
413 (cond
414 ;; System V Release 3.2 uses this format
415 ((string-match "\\(^0x\\w* in \\|^\\|\n\\)\\([^:\n]*\\):\\([0-9]*\\):.*\n"
416 gud-marker-acc start)
417 (setq gud-last-frame
418 (cons
419 (substring gud-marker-acc (match-beginning 2) (match-end 2))
420 (string-to-int
421 (substring gud-marker-acc (match-beginning 3) (match-end 3))))))
422 ;; System V Release 4.0 quite often clumps two lines together
423 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
424 gud-marker-acc start)
425 (setq gud-sdb-lastfile
426 (substring gud-marker-acc (match-beginning 2) (match-end 2)))
427 (setq gud-last-frame
428 (cons
429 gud-sdb-lastfile
430 (string-to-int
431 (substring gud-marker-acc (match-beginning 3) (match-end 3))))))
432 ;; System V Release 4.0
433 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n"
434 gud-marker-acc start)
435 (setq gud-sdb-lastfile
436 (substring gud-marker-acc (match-beginning 2) (match-end 2))))
437 ((and gud-sdb-lastfile (string-match "^\\([0-9]+\\):"
438 gud-marker-acc start))
439 (setq gud-last-frame
440 (cons
441 gud-sdb-lastfile
442 (string-to-int
443 (substring gud-marker-acc (match-beginning 1) (match-end 1))))))
444 (t
445 (setq gud-sdb-lastfile nil)))
446 (setq start (match-end 0)))
447
448 ;; Search for the last incomplete line in this chunk
449 (while (string-match "\n" gud-marker-acc start)
450 (setq start (match-end 0)))
451
452 ;; If we have an incomplete line, store it in gud-marker-acc.
453 ;; Otherwise clear gud-marker-acc. to avoid an
454 ;; unnecessary concat when this function runs next.
455 (setq gud-marker-acc
456 (if (= start (length gud-marker-acc))
457 (substring gud-marker-acc start)
458 nil)))
13b80a60
ER
459 string)
460
ee0155df 461(defun gud-sdb-find-file (f)
9bb4544b
RS
462 (save-excursion
463 (let ((buf (if gud-sdb-needs-tags
464 (find-tag-noselect f)
465 (find-file-noselect f))))
466 (set-buffer buf)
07fc7c8a 467 (gud-make-debug-menu)
b3ede706 468 (local-set-key [menu-bar debug tbreak] '("Temporary Breakpoint" . gud-tbreak))
9bb4544b 469 buf)))
13b80a60 470
10a4c11f 471;;;###autoload
a223b10d 472(defun sdb (command-line)
13b80a60
ER
473 "Run sdb on program FILE in buffer *gud-FILE*.
474The directory containing FILE becomes the initial working directory
475and source-file directory for your debugger."
f6376199 476 (interactive
a223b10d 477 (list (read-from-minibuffer "Run sdb (like this): "
f6376199
JB
478 (if (consp gud-sdb-history)
479 (car gud-sdb-history)
a223b10d 480 "sdb ")
f6376199
JB
481 nil nil
482 '(gud-sdb-history . 1))))
ee0155df 483 (if (and gud-sdb-needs-tags
e290aebb
RS
484 (not (and (boundp 'tags-file-name)
485 (stringp tags-file-name)
486 (file-exists-p tags-file-name))))
13b80a60 487 (error "The sdb support requires a valid tags table to work."))
13b80a60 488
ee97eac3
RS
489 (gud-common-init command-line 'gud-sdb-massage-args
490 'gud-sdb-marker-filter 'gud-sdb-find-file)
5b08a462 491
dd8e46c7
RS
492 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
493 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
494 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
495 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
496 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
497 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
498 (gud-def gud-cont "c" "\C-r" "Continue with display.")
499 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
13b80a60 500
6bde8427 501 (setq comint-prompt-regexp "\\(^\\|\n\\)\\*")
f54877b2 502 (setq paragraph-start comint-prompt-regexp)
2291bfaa 503 (local-set-key [menu-bar debug tbreak]
b3ede706 504 '("Temporary Breakpoint" . gud-tbreak))
13b80a60
ER
505 (run-hooks 'sdb-mode-hook)
506 )
575661b1 507\f
13b80a60
ER
508;; ======================================================================
509;; dbx functions
510
f6376199
JB
511;;; History of argument lists passed to dbx.
512(defvar gud-dbx-history nil)
513
dfbd82a6 514(defun gud-dbx-massage-args (file args) args)
13b80a60 515
ee0155df 516(defun gud-dbx-marker-filter (string)
7f629252
RS
517 (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
518
519 (let (start)
520 ;; Process all complete markers in this chunk.
521 (while (or (string-match
522 "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
523 gud-marker-acc start)
524 (string-match
525 "signal .* in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
526 gud-marker-acc start))
13b80a60
ER
527 (setq gud-last-frame
528 (cons
7f629252 529 (substring gud-marker-acc (match-beginning 2) (match-end 2))
13b80a60 530 (string-to-int
7f629252
RS
531 (substring gud-marker-acc (match-beginning 1) (match-end 1))))
532 start (match-end 0)))
533
534 ;; Search for the last incomplete line in this chunk
535 (while (string-match "\n" gud-marker-acc start)
536 (setq start (match-end 0)))
537
538 ;; If the incomplete line APPEARS to begin with another marker, keep it
539 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
540 ;; unnecessary concat during the next call.
541 (setq gud-marker-acc
542 (if (string-match "\\(stopped\\|signal\\)" gud-marker-acc start)
543 (substring gud-marker-acc (match-beginning 0))
544 nil)))
13b80a60
ER
545 string)
546
f266485d
RS
547;; Functions for Mips-style dbx. Given the option `-emacs', documented in
548;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
549(defvar gud-mips-p
550 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
551 ;; We haven't tested gud on this system:
552 (string-match "^mips-[^-]*-riscos" system-configuration)
553 ;; It's documented on OSF/1.3
9f24ea14
RS
554 (string-match "^mips-[^-]*-osf1" system-configuration)
555 (string-match "^alpha-[^-]*-osf" system-configuration))
f266485d 556 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
13eaa026
RS
557
558(defun gud-mipsdbx-massage-args (file args)
dfbd82a6 559 (cons "-emacs" args))
13eaa026 560
f266485d
RS
561;; This is just like the gdb one except for the regexps since we need to cope
562;; with an optional breakpoint number in [] before the ^Z^Z
13eaa026 563(defun gud-mipsdbx-marker-filter (string)
bed6a98d
RS
564 (setq gud-marker-acc (concat gud-marker-acc string))
565 (let ((output ""))
566
567 ;; Process all the complete markers in this chunk.
568 (while (string-match
569 ;; This is like th gdb marker but with an optional
570 ;; leading break point number like `[1] '
571 "[][ 0-9]*\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
572 gud-marker-acc)
573 (setq
574
575 ;; Extract the frame position from the marker.
576 gud-last-frame
577 (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
578 (string-to-int (substring gud-marker-acc
579 (match-beginning 2)
580 (match-end 2))))
581
582 ;; Append any text before the marker to the output we're going
583 ;; to return - we don't include the marker in this text.
584 output (concat output
585 (substring gud-marker-acc 0 (match-beginning 0)))
586
587 ;; Set the accumulator to the remaining text.
588 gud-marker-acc (substring gud-marker-acc (match-end 0))))
589
590 ;; Does the remaining text look like it might end with the
591 ;; beginning of another marker? If it does, then keep it in
592 ;; gud-marker-acc until we receive the rest of it. Since we
593 ;; know the full marker regexp above failed, it's pretty simple to
594 ;; test for marker starts.
595 (if (string-match "[][ 0-9]*\032.*\\'" gud-marker-acc)
596 (progn
597 ;; Everything before the potential marker start can be output.
598 (setq output (concat output (substring gud-marker-acc
599 0 (match-beginning 0))))
600
601 ;; Everything after, we save, to combine with later input.
602 (setq gud-marker-acc
603 (substring gud-marker-acc (match-beginning 0))))
604
605 (setq output (concat output gud-marker-acc)
606 gud-marker-acc ""))
607
608 output))
13eaa026 609
f266485d
RS
610;; The dbx in IRIX is a pain. It doesn't print the file name when
611;; stopping at a breakpoint (but you do get it from the `up' and
612;; `down' commands...). The only way to extract the information seems
613;; to be with a `file' command, although the current line number is
614;; available in $curline. Thus we have to look for output which
615;; appears to indicate a breakpoint. Then we prod the dbx sub-process
616;; to output the information we want with a combination of the
617;; `printf' and `file' commands as a pseudo marker which we can
618;; recognise next time through the marker-filter. This would be like
619;; the gdb marker but you can't get the file name without a newline...
620;; Note that gud-remove won't work since Irix dbx expects a breakpoint
621;; number rather than a line number etc. Maybe this could be made to
622;; work by listing all the breakpoints and picking the one(s) with the
623;; correct line number, but life's too short.
624;; d.love@dl.ac.uk (Dave Love) can be blamed for this
625
626(defvar gud-irix-p (string-match "^mips-[^-]*-irix" system-configuration)
627 "Non-nil to assume the interface appropriate for IRIX dbx.
2fb419e1
RS
628This works in IRIX 4, 5 and 6.")
629;; [Irix dbx seems to be a moving target. The dbx output changed
630;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
631;; the output from `up' is no longer spotted by gud (and it's probably
632;; not distinctive enough to try to match it -- use C-<, C->
633;; exclusively) . For 5.3 and 6.0, the $curline variable changed to
634;; `long long'(why?!), so the printf stuff needed changing. The line
635;; number is cast to `long' as a compromise between the new `long
636;; long' and the original `int'. The process filter is also somewhat
637;; unreliable, sometimes not spotting the markers; I don't know
638;; whether there's anything that can be done about that. It would be
639;; much better if SGI could be persuaded to (re?)instate the MIPS
640;; -emacs flag for gdb-like output (which ought to be possible as most
641;; of the communication I've had over it has been from sgi.com).]
f266485d
RS
642
643;; this filter is influenced by the xdb one rather than the gdb one
644(defun gud-irixdbx-marker-filter (string)
bed6a98d
RS
645 (let (result (case-fold-search nil))
646 (if (or (string-match comint-prompt-regexp string)
647 (string-match ".*\012" string))
648 (setq result (concat gud-marker-acc string)
649 gud-marker-acc "")
650 (setq gud-marker-acc (concat gud-marker-acc string)))
651 (if result
652 (cond
653 ;; look for breakpoint or signal indication e.g.:
654 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
655 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
656 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
657 ((string-match
658 "^\\(\\[[0-9]+] \\)?Process +[0-9]+ ([^)]*) [^[]+\\[[^]\n]*]\n"
659 result)
660 ;; prod dbx into printing out the line number and file
661 ;; name in a form we can grok as below
662 (process-send-string (get-buffer-process gud-comint-buffer)
e802811f 663 "printf \"\032\032%1d:\",(long)$curline;file\n"))
bed6a98d
RS
664 ;; look for result of, say, "up" e.g.:
665 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
666 ;; (this will also catch one of the lines printed by "where")
667 ((string-match
668 "^[^ ][^[]*\\[\"\\([^\"]+\\)\":\\([0-9]+\\), [^]]+]\n"
669 result)
670 (let ((file (substring result (match-beginning 1)
671 (match-end 1))))
672 (if (file-exists-p file)
673 (setq gud-last-frame
674 (cons
675 (substring
676 result (match-beginning 1) (match-end 1))
677 (string-to-int
678 (substring
679 result (match-beginning 2) (match-end 2)))))))
680 result)
681 ((string-match ; kluged-up marker as above
682 "\032\032\\([0-9]*\\):\\(.*\\)\n" result)
683 (let ((file (substring result (match-beginning 2) (match-end 2))))
684 (if (file-exists-p file)
685 (setq gud-last-frame
686 (cons
687 file
688 (string-to-int
689 (substring
690 result (match-beginning 1) (match-end 1)))))))
691 (setq result (substring result 0 (match-beginning 0))))))
692 (or result "")))
f266485d 693
ee0155df 694(defun gud-dbx-find-file (f)
9bb4544b
RS
695 (save-excursion
696 (let ((buf (find-file-noselect f)))
697 (set-buffer buf)
07fc7c8a 698 (gud-make-debug-menu)
b3ede706
KH
699 (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
700 (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
9bb4544b 701 buf)))
13b80a60 702
10a4c11f 703;;;###autoload
a223b10d 704(defun dbx (command-line)
13b80a60
ER
705 "Run dbx on program FILE in buffer *gud-FILE*.
706The directory containing FILE becomes the initial working directory
707and source-file directory for your debugger."
f6376199 708 (interactive
a223b10d 709 (list (read-from-minibuffer "Run dbx (like this): "
f6376199
JB
710 (if (consp gud-dbx-history)
711 (car gud-dbx-history)
a223b10d 712 "dbx ")
f6376199
JB
713 nil nil
714 '(gud-dbx-history . 1))))
13eaa026 715
ee97eac3
RS
716 (cond
717 (gud-mips-p
718 (gud-common-init command-line 'gud-mipsdbx-massage-args
719 'gud-mipsdbx-marker-filter 'gud-dbx-find-file))
720 (gud-irix-p
721 (gud-common-init command-line 'gud-dbx-massage-args
722 'gud-irixdbx-marker-filter 'gud-dbx-find-file))
723 (t
724 (gud-common-init command-line 'gud-dbx-massage-args
725 'gud-dbx-marker-filter 'gud-dbx-find-file)))
5b08a462 726
13eaa026 727 (cond
f266485d 728 (gud-mips-p
2fb419e1
RS
729 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
730 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
13eaa026
RS
731 (gud-def gud-break "stop at \"%f\":%l"
732 "\C-b" "Set breakpoint at current line.")
733 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
f266485d
RS
734 (gud-irix-p
735 (gud-def gud-break "stop at \"%d%f\":%l"
736 "\C-b" "Set breakpoint at current line.")
737 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
2fb419e1
RS
738 (gud-def gud-up "up %p; printf \"\032\032%1ld:\",(long)$curline;file\n"
739 "<" "Up (numeric arg) stack frames.")
740 (gud-def gud-down "down %p; printf \"\032\032%1ld:\",(long)$curline;file\n"
741 ">" "Down (numeric arg) stack frames.")
f266485d
RS
742 ;; Make dbx give out the source location info that we need.
743 (process-send-string (get-buffer-process gud-comint-buffer)
e802811f 744 "printf \"\032\032%1d:\",(long)$curline;file\n"))
13eaa026 745 (t
2fb419e1
RS
746 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
747 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
13eaa026
RS
748 (gud-def gud-break "file \"%d%f\"\nstop at %l"
749 "\C-b" "Set breakpoint at current line.")))
750
dd8e46c7
RS
751 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
752 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
753 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
754 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
755 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
dd8e46c7 756 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
ee0155df 757
13eaa026 758 (setq comint-prompt-regexp "^[^)\n]*dbx) *")
f54877b2 759 (setq paragraph-start comint-prompt-regexp)
b3ede706
KH
760 (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
761 (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
13b80a60
ER
762 (run-hooks 'dbx-mode-hook)
763 )
575661b1 764\f
6496f3d2
RS
765;; ======================================================================
766;; xdb (HP PARISC debugger) functions
767
f6376199
JB
768;;; History of argument lists passed to xdb.
769(defvar gud-xdb-history nil)
770
fce222c7
RS
771(defvar gud-xdb-directories nil
772 "*A list of directories that xdb should search for source code.
773If nil, only source files in the program directory
774will be known to xdb.
775
776The file names should be absolute, or relative to the directory
777containing the executable being debugged.")
778
a223b10d
RM
779(defun gud-xdb-massage-args (file args)
780 (nconc (let ((directories gud-xdb-directories)
781 (result nil))
782 (while directories
783 (setq result (cons (car directories) (cons "-d" result)))
784 (setq directories (cdr directories)))
dfbd82a6 785 (nreverse result))
a223b10d 786 args))
6496f3d2
RS
787
788(defun gud-xdb-file-name (f)
789 "Transform a relative pathname to a full pathname in xdb mode"
790 (let ((result nil))
791 (if (file-exists-p f)
792 (setq result (expand-file-name f))
fce222c7
RS
793 (let ((directories gud-xdb-directories))
794 (while directories
795 (let ((path (concat (car directories) "/" f)))
6496f3d2
RS
796 (if (file-exists-p path)
797 (setq result (expand-file-name path)
fce222c7
RS
798 directories nil)))
799 (setq directories (cdr directories)))))
6496f3d2
RS
800 result))
801
802;; xdb does not print the lines all at once, so we have to accumulate them
6496f3d2
RS
803(defun gud-xdb-marker-filter (string)
804 (let (result)
805 (if (or (string-match comint-prompt-regexp string)
806 (string-match ".*\012" string))
f266485d
RS
807 (setq result (concat gud-marker-acc string)
808 gud-marker-acc "")
809 (setq gud-marker-acc (concat gud-marker-acc string)))
6496f3d2
RS
810 (if result
811 (if (or (string-match "\\([^\n \t:]+\\): [^:]+: \\([0-9]+\\):" result)
812 (string-match "[^: \t]+:[ \t]+\\([^:]+\\): [^:]+: \\([0-9]+\\):"
813 result))
814 (let ((line (string-to-int
815 (substring result (match-beginning 2) (match-end 2))))
816 (file (gud-xdb-file-name
817 (substring result (match-beginning 1) (match-end 1)))))
818 (if file
819 (setq gud-last-frame (cons file line))))))
820 (or result "")))
821
6496f3d2 822(defun gud-xdb-find-file (f)
9bb4544b
RS
823 (save-excursion
824 (let ((realf (gud-xdb-file-name f)))
825 (if realf
826 (let ((buf (find-file-noselect realf)))
827 (set-buffer buf)
07fc7c8a 828 (gud-make-debug-menu)
9bb4544b 829 (local-set-key [menu-bar debug tbreak]
b3ede706 830 '("Temporary Breakpoint" . gud-tbreak))
9bb4544b 831 (local-set-key [menu-bar debug finish]
b3ede706
KH
832 '("Finish Function" . gud-finish))
833 (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
834 (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
9bb4544b
RS
835 buf)
836 nil))))
6496f3d2
RS
837
838;;;###autoload
a223b10d 839(defun xdb (command-line)
6496f3d2
RS
840 "Run xdb on program FILE in buffer *gud-FILE*.
841The directory containing FILE becomes the initial working directory
842and source-file directory for your debugger.
843
fce222c7 844You can set the variable 'gud-xdb-directories' to a list of program source
6496f3d2 845directories if your program contains sources from more than one directory."
f6376199 846 (interactive
a223b10d 847 (list (read-from-minibuffer "Run xdb (like this): "
f6376199
JB
848 (if (consp gud-xdb-history)
849 (car gud-xdb-history)
a223b10d 850 "xdb ")
f6376199
JB
851 nil nil
852 '(gud-xdb-history . 1))))
6496f3d2 853
ee97eac3
RS
854 (gud-common-init command-line 'gud-xdb-massage-args
855 'gud-xdb-marker-filter 'gud-xdb-find-file)
6496f3d2
RS
856
857 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
858 (gud-def gud-tbreak "b %f:%l\\t" "\C-t"
859 "Set temporary breakpoint at current line.")
860 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
861 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
862 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
863 (gud-def gud-cont "c" "\C-r" "Continue with display.")
864 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
865 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
866 (gud-def gud-finish "bu\\t" "\C-f" "Finish executing current function.")
867 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
868
869 (setq comint-prompt-regexp "^>")
f54877b2 870 (setq paragraph-start comint-prompt-regexp)
b3ede706
KH
871 (local-set-key [menu-bar debug tbreak] '("Temporary Breakpoint" . gud-tbreak))
872 (local-set-key [menu-bar debug finish] '("Finish Function" . gud-finish))
873 (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
874 (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
6496f3d2 875 (run-hooks 'xdb-mode-hook))
575661b1
RS
876\f
877;; ======================================================================
878;; perldb functions
879
880;;; History of argument lists passed to perldb.
881(defvar gud-perldb-history nil)
882
883(defun gud-perldb-massage-args (file args)
d3e6dae7 884 (cons "-d" (cons (car args) (cons "-emacs" (cdr args)))))
575661b1
RS
885
886;; There's no guarantee that Emacs will hand the filter the entire
887;; marker at once; it could be broken up across several strings. We
888;; might even receive a big chunk with several markers in it. If we
889;; receive a chunk of text which looks like it might contain the
890;; beginning of a marker, we save it here between calls to the
891;; filter.
892(defvar gud-perldb-marker-acc "")
893
894(defun gud-perldb-marker-filter (string)
bed6a98d
RS
895 (setq gud-marker-acc (concat gud-marker-acc string))
896 (let ((output ""))
897
898 ;; Process all the complete markers in this chunk.
899 (while (string-match "\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
900 gud-marker-acc)
901 (setq
902
903 ;; Extract the frame position from the marker.
904 gud-last-frame
905 (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
906 (string-to-int (substring gud-marker-acc
907 (match-beginning 2)
908 (match-end 2))))
909
910 ;; Append any text before the marker to the output we're going
911 ;; to return - we don't include the marker in this text.
912 output (concat output
913 (substring gud-marker-acc 0 (match-beginning 0)))
914
915 ;; Set the accumulator to the remaining text.
916 gud-marker-acc (substring gud-marker-acc (match-end 0))))
917
918 ;; Does the remaining text look like it might end with the
919 ;; beginning of another marker? If it does, then keep it in
920 ;; gud-marker-acc until we receive the rest of it. Since we
921 ;; know the full marker regexp above failed, it's pretty simple to
922 ;; test for marker starts.
923 (if (string-match "\032.*\\'" gud-marker-acc)
924 (progn
925 ;; Everything before the potential marker start can be output.
926 (setq output (concat output (substring gud-marker-acc
927 0 (match-beginning 0))))
928
929 ;; Everything after, we save, to combine with later input.
930 (setq gud-marker-acc
931 (substring gud-marker-acc (match-beginning 0))))
932
933 (setq output (concat output gud-marker-acc)
934 gud-marker-acc ""))
935
936 output))
575661b1
RS
937
938(defun gud-perldb-find-file (f)
9bb4544b
RS
939 (save-excursion
940 (let ((buf (find-file-noselect f)))
941 (set-buffer buf)
39cf49be 942 (gud-make-debug-menu)
9bb4544b 943 buf)))
575661b1
RS
944
945;;;###autoload
946(defun perldb (command-line)
947 "Run perldb on program FILE in buffer *gud-FILE*.
948The directory containing FILE becomes the initial working directory
949and source-file directory for your debugger."
950 (interactive
951 (list (read-from-minibuffer "Run perldb (like this): "
952 (if (consp gud-perldb-history)
953 (car gud-perldb-history)
2c32e5c6 954 "perl ")
575661b1
RS
955 nil nil
956 '(gud-perldb-history . 1))))
575661b1 957
ee97eac3
RS
958 (gud-common-init command-line 'gud-perldb-massage-args
959 'gud-perldb-marker-filter 'gud-perldb-find-file)
575661b1 960
2c32e5c6
RS
961 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
962 (gud-def gud-remove "d %l" "\C-d" "Remove breakpoint at current line")
963 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
964 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
965 (gud-def gud-cont "c" "\C-r" "Continue with display.")
966; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
967; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
968; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
969 (gud-def gud-print "%e" "\C-p" "Evaluate perl expression at point.")
970
971 (setq comint-prompt-regexp "^ DB<[0-9]+> ")
f54877b2 972 (setq paragraph-start comint-prompt-regexp)
2c32e5c6 973 (run-hooks 'perldb-mode-hook)
575661b1 974 )
6496f3d2 975
13b80a60
ER
976;;
977;; End of debugger-specific information
10a4c11f 978;;
13b80a60 979
575661b1 980\f
53eb3a97
JB
981;;; When we send a command to the debugger via gud-call, it's annoying
982;;; to see the command and the new prompt inserted into the debugger's
983;;; buffer; we have other ways of knowing the command has completed.
984;;;
985;;; If the buffer looks like this:
986;;; --------------------
987;;; (gdb) set args foo bar
988;;; (gdb) -!-
989;;; --------------------
990;;; (the -!- marks the location of point), and we type `C-x SPC' in a
991;;; source file to set a breakpoint, we want the buffer to end up like
992;;; this:
993;;; --------------------
994;;; (gdb) set args foo bar
995;;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
996;;; (gdb) -!-
997;;; --------------------
998;;; Essentially, the old prompt is deleted, and the command's output
999;;; and the new prompt take its place.
1000;;;
1001;;; Not echoing the command is easy enough; you send it directly using
1002;;; process-send-string, and it never enters the buffer. However,
1003;;; getting rid of the old prompt is trickier; you don't want to do it
1004;;; when you send the command, since that will result in an annoying
1005;;; flicker as the prompt is deleted, redisplay occurs while Emacs
1006;;; waits for a response from the debugger, and the new prompt is
1007;;; inserted. Instead, we'll wait until we actually get some output
1008;;; from the subprocess before we delete the prompt. If the command
1009;;; produced no output other than a new prompt, that prompt will most
1010;;; likely be in the first chunk of output received, so we will delete
1011;;; the prompt and then replace it with an identical one. If the
1012;;; command produces output, the prompt is moving anyway, so the
1013;;; flicker won't be annoying.
1014;;;
1015;;; So - when we want to delete the prompt upon receipt of the next
1016;;; chunk of debugger output, we position gud-delete-prompt-marker at
1017;;; the start of the prompt; the process filter will notice this, and
1018;;; delete all text between it and the process output marker. If
1019;;; gud-delete-prompt-marker points nowhere, we leave the current
1020;;; prompt alone.
1021(defvar gud-delete-prompt-marker nil)
1022
13b80a60
ER
1023\f
1024(defun gud-mode ()
1025 "Major mode for interacting with an inferior debugger process.
24d725c2 1026
6496f3d2
RS
1027 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
1028or M-x xdb. Each entry point finishes by executing a hook; `gdb-mode-hook',
1029`sdb-mode-hook', `dbx-mode-hook' or `xdb-mode-hook' respectively.
24d725c2 1030
ee0155df
ER
1031After startup, the following commands are available in both the GUD
1032interaction buffer and any source buffer GUD visits due to a breakpoint stop
1033or step operation:
13b80a60 1034
ee0155df
ER
1035\\[gud-break] sets a breakpoint at the current file and line. In the
1036GUD buffer, the current file and line are those of the last breakpoint or
1037step. In a source buffer, they are the buffer's file and current line.
1038
45025813
ER
1039\\[gud-remove] removes breakpoints on the current file and line.
1040
ee0155df 1041\\[gud-refresh] displays in the source window the last line referred to
24d725c2 1042in the gud buffer.
13b80a60 1043
ee0155df
ER
1044\\[gud-step], \\[gud-next], and \\[gud-stepi] do a step-one-line,
1045step-one-line (not entering function calls), and step-one-instruction
1046and then update the source window with the current file and position.
1047\\[gud-cont] continues execution.
13b80a60 1048
ee0155df
ER
1049\\[gud-print] tries to find the largest C lvalue or function-call expression
1050around point, and sends it to the debugger for value display.
24d725c2 1051
6496f3d2
RS
1052The above commands are common to all supported debuggers except xdb which
1053does not support stepping instructions.
24d725c2 1054
6496f3d2 1055Under gdb, sdb and xdb, \\[gud-tbreak] behaves exactly like \\[gud-break],
ee0155df
ER
1056except that the breakpoint is temporary; that is, it is removed when
1057execution stops on it.
24d725c2 1058
6496f3d2 1059Under gdb, dbx, and xdb, \\[gud-up] pops up through an enclosing stack
ee0155df 1060frame. \\[gud-down] drops back down through one.
24d725c2 1061
6496f3d2 1062If you are using gdb or xdb, \\[gud-finish] runs execution to the return from
ee0155df 1063the current function and stops.
24d725c2 1064
dcec1a3b
RS
1065All the keystrokes above are accessible in the GUD buffer
1066with the prefix C-c, and in all buffers through the prefix C-x C-a.
45025813 1067
ee0155df
ER
1068All pre-defined functions for which the concept make sense repeat
1069themselves the appropriate number of times if you give a prefix
1070argument.
13b80a60 1071
dcec1a3b 1072You may use the `gud-def' macro in the initialization hook to define other
ee0155df 1073commands.
13b80a60 1074
24d725c2
ER
1075Other commands for interacting with the debugger process are inherited from
1076comint mode, which see."
13b80a60
ER
1077 (interactive)
1078 (comint-mode)
13b80a60
ER
1079 (setq major-mode 'gud-mode)
1080 (setq mode-name "Debugger")
0b358e64 1081 (setq mode-line-process '(":%s"))
07fc7c8a
KH
1082 (use-local-map comint-mode-map)
1083 (gud-make-debug-menu)
2b64612d 1084 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
13b80a60
ER
1085 (make-local-variable 'gud-last-frame)
1086 (setq gud-last-frame nil)
1087 (make-local-variable 'comint-prompt-regexp)
f54877b2 1088 (make-local-variable 'paragraph-start)
53eb3a97
JB
1089 (make-local-variable 'gud-delete-prompt-marker)
1090 (setq gud-delete-prompt-marker (make-marker))
ee97eac3 1091 (run-hooks 'gud-mode-hook))
13b80a60 1092
a223b10d
RM
1093;; Chop STRING into words separated by SPC or TAB and return a list of them.
1094(defun gud-chop-words (string)
1095 (let ((i 0) (beg 0)
1096 (len (length string))
1097 (words nil))
1098 (while (< i len)
1099 (if (memq (aref string i) '(?\t ? ))
1100 (progn
1101 (setq words (cons (substring string beg i) words)
1102 beg (1+ i))
1103 (while (and (< beg len) (memq (aref string beg) '(?\t ? )))
1104 (setq beg (1+ beg)))
1105 (setq i (1+ beg)))
1106 (setq i (1+ i))))
1107 (if (< beg len)
1108 (setq words (cons (substring string beg) words)))
1109 (nreverse words)))
1110
1111;; Perform initializations common to all debuggers.
ee97eac3
RS
1112;; The first arg is the specified command line,
1113;; which starts with the program to debug.
1114;; The other three args specify the values to use
1115;; for local variables in the debugger buffer.
1116(defun gud-common-init (command-line massage-args marker-filter find-file)
a223b10d
RM
1117 (let* ((words (gud-chop-words command-line))
1118 (program (car words))
dfbd82a6
RS
1119 ;; Extract the file name from WORDS
1120 ;; and put t in its place.
1121 ;; Later on we will put the modified file name arg back there.
a223b10d
RM
1122 (file-word (let ((w (cdr words)))
1123 (while (and w (= ?- (aref (car w) 0)))
1124 (setq w (cdr w)))
c27c1042
KH
1125 (and w
1126 (prog1 (car w)
1127 (setcar w t)))))
0ec5b01d
RS
1128 (file-subst
1129 (and file-word (substitute-in-file-name file-word)))
dfbd82a6 1130 (args (cdr words))
0ec5b01d
RS
1131 ;; If a directory was specified, expand the file name.
1132 ;; Otherwise, don't expand it, so GDB can use the PATH.
1133 ;; A file name without directory is literally valid
1134 ;; only if the file exists in ., and in that case,
1135 ;; omitting the expansion here has no visible effect.
52b85866 1136 (file (and file-word
0ec5b01d
RS
1137 (if (file-name-directory file-subst)
1138 (expand-file-name file-subst)
1139 file-subst)))
c27c1042
KH
1140 (filepart (and file-word (concat "-" (file-name-nondirectory file)))))
1141 (switch-to-buffer (concat "*gud" filepart "*"))
0ec5b01d
RS
1142 ;; Set default-directory to the file's directory.
1143 (and file-word
1144 ;; Don't set default-directory if no directory was specified.
1145 ;; In that case, either the file is found in the current directory,
1146 ;; in which case this setq is a no-op,
1147 ;; or it is found by searching PATH,
1148 ;; in which case we don't know what directory it was found in.
1149 (file-name-directory file)
1150 (setq default-directory (file-name-directory file)))
ee97eac3
RS
1151 (or (bolp) (newline))
1152 (insert "Current directory is " default-directory "\n")
dfbd82a6
RS
1153 ;; Put the substituted and expanded file name back in its place.
1154 (let ((w args))
1155 (while (and w (not (eq (car w) t)))
1156 (setq w (cdr w)))
c27c1042
KH
1157 (if w
1158 (setcar w file)))
1159 (apply 'make-comint (concat "gud" filepart) program nil
2b1ffa34 1160 (funcall massage-args file args)))
ee97eac3 1161 ;; Since comint clobbered the mode, we don't set it until now.
13b80a60 1162 (gud-mode)
ee97eac3
RS
1163 (make-local-variable 'gud-marker-filter)
1164 (setq gud-marker-filter marker-filter)
1165 (make-local-variable 'gud-find-file)
1166 (setq gud-find-file find-file)
1167
13b80a60
ER
1168 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
1169 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
13b80a60
ER
1170 (gud-set-buffer)
1171 )
1172
1173(defun gud-set-buffer ()
1174 (cond ((eq major-mode 'gud-mode)
ee0155df
ER
1175 (setq gud-comint-buffer (current-buffer)))))
1176
1177;; These functions are responsible for inserting output from your debugger
1178;; into the buffer. The hard work is done by the method that is
1179;; the value of gud-marker-filter.
13b80a60 1180
ee0155df 1181(defun gud-filter (proc string)
13b80a60 1182 ;; Here's where the actual buffer insertion is done
c561a0cb
RS
1183 (let (output)
1184 (if (buffer-name (process-buffer proc))
1185 (save-excursion
1186 (set-buffer (process-buffer proc))
1187 ;; If we have been so requested, delete the debugger prompt.
1188 (if (marker-buffer gud-delete-prompt-marker)
1189 (progn
1190 (delete-region (process-mark proc) gud-delete-prompt-marker)
1191 (set-marker gud-delete-prompt-marker nil)))
1192 ;; Save the process output, checking for source file markers.
1193 (setq output (gud-marker-filter string))
1194 ;; Check for a filename-and-line number.
1195 ;; Don't display the specified file
1196 ;; unless (1) point is at or after the position where output appears
1197 ;; and (2) this buffer is on the screen.
1198 (if (and gud-last-frame
1199 (>= (point) (process-mark proc))
1200 (get-buffer-window (current-buffer)))
1201 (gud-display-frame))
1202 ;; Let the comint filter do the actual insertion.
1203 ;; That lets us inherit various comint features.
1204 (comint-output-filter proc output)))))
13b80a60
ER
1205
1206(defun gud-sentinel (proc msg)
1207 (cond ((null (buffer-name (process-buffer proc)))
1208 ;; buffer killed
1209 ;; Stop displaying an arrow in a source file.
1210 (setq overlay-arrow-position nil)
1211 (set-process-buffer proc nil))
1212 ((memq (process-status proc) '(signal exit))
1213 ;; Stop displaying an arrow in a source file.
1214 (setq overlay-arrow-position nil)
1215 ;; Fix the mode line.
1216 (setq mode-line-process
0b358e64 1217 (concat ":"
13b80a60
ER
1218 (symbol-name (process-status proc))))
1219 (let* ((obuf (current-buffer)))
1220 ;; save-excursion isn't the right thing if
1221 ;; process-buffer is current-buffer
1222 (unwind-protect
1223 (progn
1224 ;; Write something in *compilation* and hack its mode line,
1225 (set-buffer (process-buffer proc))
e726eb56 1226 (force-mode-line-update)
13b80a60
ER
1227 (if (eobp)
1228 (insert ?\n mode-name " " msg)
1229 (save-excursion
1230 (goto-char (point-max))
1231 (insert ?\n mode-name " " msg)))
1232 ;; If buffer and mode line will show that the process
1233 ;; is dead, we can delete it now. Otherwise it
1234 ;; will stay around until M-x list-processes.
1235 (delete-process proc))
1236 ;; Restore old buffer, but don't restore old point
1237 ;; if obuf is the gud buffer.
1238 (set-buffer obuf))))))
1239
13b80a60
ER
1240(defun gud-display-frame ()
1241 "Find and obey the last filename-and-line marker from the debugger.
1242Obeying it means displaying in another window the specified file and line."
1243 (interactive)
1244 (if gud-last-frame
ee0155df 1245 (progn
13b80a60
ER
1246 (gud-set-buffer)
1247 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
32ab4c10
JB
1248 (setq gud-last-last-frame gud-last-frame
1249 gud-last-frame nil))))
13b80a60
ER
1250
1251;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
1252;; and that its line LINE is visible.
1253;; Put the overlay-arrow on the line LINE in that buffer.
ee0155df
ER
1254;; Most of the trickiness in here comes from wanting to preserve the current
1255;; region-restriction if that's possible. We use an explicit display-buffer
1256;; to get around the fact that this is called inside a save-excursion.
13b80a60
ER
1257
1258(defun gud-display-line (true-file line)
8f6c93e2
RS
1259 (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
1260 (buffer (gud-find-file true-file))
ee0155df 1261 (window (display-buffer buffer))
13b80a60 1262 (pos))
dd8e46c7
RS
1263;;; (if (equal buffer (current-buffer))
1264;;; nil
1265;;; (setq buffer-read-only nil))
13b80a60 1266 (save-excursion
dd8e46c7 1267;;; (setq buffer-read-only t)
13b80a60
ER
1268 (set-buffer buffer)
1269 (save-restriction
1270 (widen)
1271 (goto-line line)
1272 (setq pos (point))
1273 (setq overlay-arrow-string "=>")
1274 (or overlay-arrow-position
1275 (setq overlay-arrow-position (make-marker)))
1276 (set-marker overlay-arrow-position (point) (current-buffer)))
1277 (cond ((or (< pos (point-min)) (> pos (point-max)))
1278 (widen)
1279 (goto-char pos))))
1280 (set-window-point window overlay-arrow-position)))
53eb3a97 1281
ee0155df
ER
1282;;; The gud-call function must do the right thing whether its invoking
1283;;; keystroke is from the GUD buffer itself (via major-mode binding)
5b08a462
ER
1284;;; or a C buffer. In the former case, we want to supply data from
1285;;; gud-last-frame. Here's how we do it:
13b80a60 1286
ee0155df 1287(defun gud-format-command (str arg)
13eaa026
RS
1288 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
1289 (frame (or gud-last-frame gud-last-last-frame))
1290 result)
1291 (while (and str (string-match "\\([^%]*\\)%\\([adeflp]\\)" str))
1292 (let ((key (string-to-char (substring str (match-beginning 2))))
1293 subst)
1294 (cond
1295 ((eq key ?f)
1296 (setq subst (file-name-nondirectory (if insource
1297 (buffer-file-name)
1298 (car frame)))))
1299 ((eq key ?d)
1300 (setq subst (file-name-directory (if insource
7f359a21 1301 (buffer-file-name)
13eaa026
RS
1302 (car frame)))))
1303 ((eq key ?l)
1304 (setq subst (if insource
1305 (save-excursion
1306 (beginning-of-line)
1307 (save-restriction (widen)
1308 (1+ (count-lines 1 (point)))))
1309 (cdr frame))))
1310 ((eq key ?e)
1311 (setq subst (find-c-expr)))
1312 ((eq key ?a)
1313 (setq subst (gud-read-address)))
1314 ((eq key ?p)
1315 (setq subst (if arg (int-to-string arg) ""))))
1316 (setq result (concat result
1317 (substring str (match-beginning 1) (match-end 1))
1318 subst)))
1319 (setq str (substring str (match-end 2))))
1320 ;; There might be text left in STR when the loop ends.
1321 (concat result str)))
13b80a60 1322
6bde8427 1323(defun gud-read-address ()
13b80a60
ER
1324 "Return a string containing the core-address found in the buffer at point."
1325 (save-excursion
6bde8427 1326 (let ((pt (point)) found begin)
ee0155df 1327 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
6bde8427
JB
1328 (cond
1329 (found (forward-char 2)
1330 (buffer-substring found
1331 (progn (re-search-forward "[^0-9a-f]")
1332 (forward-char -1)
1333 (point))))
1334 (t (setq begin (progn (re-search-backward "[^0-9]")
1335 (forward-char 1)
1336 (point)))
1337 (forward-char 1)
1338 (re-search-forward "[^0-9]")
1339 (forward-char -1)
1340 (buffer-substring begin (point)))))))
13b80a60 1341
ee0155df
ER
1342(defun gud-call (fmt &optional arg)
1343 (let ((msg (gud-format-command fmt arg)))
1344 (message "Command: %s" msg)
1345 (sit-for 0)
1346 (gud-basic-call msg)))
13b80a60 1347
ee0155df
ER
1348(defun gud-basic-call (command)
1349 "Invoke the debugger COMMAND displaying source in other window."
1350 (interactive)
1351 (gud-set-buffer)
1352 (let ((command (concat command "\n"))
1353 (proc (get-buffer-process gud-comint-buffer)))
4b8b296e 1354 (or proc (error "Current buffer has no process"))
ee0155df
ER
1355 ;; Arrange for the current prompt to get deleted.
1356 (save-excursion
1357 (set-buffer gud-comint-buffer)
1358 (goto-char (process-mark proc))
1359 (beginning-of-line)
1360 (if (looking-at comint-prompt-regexp)
1361 (set-marker gud-delete-prompt-marker (point))))
1362 (process-send-string proc command)))
1363
1364(defun gud-refresh (&optional arg)
1365 "Fix up a possibly garbled display, and redraw the arrow."
13b80a60 1366 (interactive "P")
ee0155df 1367 (recenter arg)
32ab4c10 1368 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
ee0155df 1369 (gud-display-frame))
dcec1a3b 1370\f
ee0155df
ER
1371;;; Code for parsing expressions out of C code. The single entry point is
1372;;; find-c-expr, which tries to return an lvalue expression from around point.
1373;;;
1374;;; The rest of this file is a hacked version of gdbsrc.el by
1375;;; Debby Ayers <ayers@asc.slb.com>,
1376;;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
ee0155df
ER
1377
1378(defun find-c-expr ()
1379 "Returns the C expr that surrounds point."
1380 (interactive)
1381 (save-excursion
1382 (let ((p) (expr) (test-expr))
1383 (setq p (point))
1384 (setq expr (expr-cur))
1385 (setq test-expr (expr-prev))
1386 (while (expr-compound test-expr expr)
1387 (setq expr (cons (car test-expr) (cdr expr)))
1388 (goto-char (car expr))
dcec1a3b 1389 (setq test-expr (expr-prev)))
ee0155df
ER
1390 (goto-char p)
1391 (setq test-expr (expr-next))
1392 (while (expr-compound expr test-expr)
1393 (setq expr (cons (car expr) (cdr test-expr)))
1394 (setq test-expr (expr-next))
1395 )
dcec1a3b 1396 (buffer-substring (car expr) (cdr expr)))))
ee0155df
ER
1397
1398(defun expr-cur ()
1399 "Returns the expr that point is in; point is set to beginning of expr.
1400The expr is represented as a cons cell, where the car specifies the point in
1401the current buffer that marks the beginning of the expr and the cdr specifies
dcec1a3b 1402the character after the end of the expr."
ee0155df 1403 (let ((p (point)) (begin) (end))
dcec1a3b 1404 (expr-backward-sexp)
ee0155df 1405 (setq begin (point))
dcec1a3b 1406 (expr-forward-sexp)
ee0155df
ER
1407 (setq end (point))
1408 (if (>= p end)
1409 (progn
1410 (setq begin p)
1411 (goto-char p)
dcec1a3b 1412 (expr-forward-sexp)
ee0155df
ER
1413 (setq end (point))
1414 )
1415 )
1416 (goto-char begin)
dcec1a3b 1417 (cons begin end)))
ee0155df 1418
dcec1a3b
RS
1419(defun expr-backward-sexp ()
1420 "Version of `backward-sexp' that catches errors."
ee0155df
ER
1421 (condition-case nil
1422 (backward-sexp)
1423 (error t)))
1424
dcec1a3b
RS
1425(defun expr-forward-sexp ()
1426 "Version of `forward-sexp' that catches errors."
ee0155df
ER
1427 (condition-case nil
1428 (forward-sexp)
1429 (error t)))
1430
1431(defun expr-prev ()
1432 "Returns the previous expr, point is set to beginning of that expr.
1433The expr is represented as a cons cell, where the car specifies the point in
1434the current buffer that marks the beginning of the expr and the cdr specifies
1435the character after the end of the expr"
1436 (let ((begin) (end))
dcec1a3b 1437 (expr-backward-sexp)
ee0155df 1438 (setq begin (point))
dcec1a3b 1439 (expr-forward-sexp)
ee0155df
ER
1440 (setq end (point))
1441 (goto-char begin)
1442 (cons begin end)))
1443
1444(defun expr-next ()
1445 "Returns the following expr, point is set to beginning of that expr.
1446The expr is represented as a cons cell, where the car specifies the point in
1447the current buffer that marks the beginning of the expr and the cdr specifies
dcec1a3b 1448the character after the end of the expr."
ee0155df 1449 (let ((begin) (end))
dcec1a3b
RS
1450 (expr-forward-sexp)
1451 (expr-forward-sexp)
ee0155df 1452 (setq end (point))
dcec1a3b 1453 (expr-backward-sexp)
ee0155df 1454 (setq begin (point))
dcec1a3b 1455 (cons begin end)))
ee0155df
ER
1456
1457(defun expr-compound-sep (span-start span-end)
1458 "Returns '.' for '->' & '.', returns ' ' for white space,
eb8c3be9 1459returns '?' for other punctuation."
ee0155df
ER
1460 (let ((result ? )
1461 (syntax))
1462 (while (< span-start span-end)
1463 (setq syntax (char-syntax (char-after span-start)))
1464 (cond
1465 ((= syntax ? ) t)
1466 ((= syntax ?.) (setq syntax (char-after span-start))
1467 (cond
1468 ((= syntax ?.) (setq result ?.))
1469 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
1470 (setq result ?.)
1471 (setq span-start (+ span-start 1)))
1472 (t (setq span-start span-end)
1473 (setq result ??)))))
1474 (setq span-start (+ span-start 1)))
dcec1a3b 1475 result))
ee0155df
ER
1476
1477(defun expr-compound (first second)
dcec1a3b
RS
1478 "Non-nil if concatenating FIRST and SECOND makes a single C token.
1479The two exprs are represented as a cons cells, where the car
ee0155df 1480specifies the point in the current buffer that marks the beginning of the
dcec1a3b 1481expr and the cdr specifies the character after the end of the expr.
ee0155df
ER
1482Link exprs of the form:
1483 Expr -> Expr
1484 Expr . Expr
1485 Expr (Expr)
1486 Expr [Expr]
1487 (Expr) Expr
1488 [Expr] Expr"
1489 (let ((span-start (cdr first))
1490 (span-end (car second))
1491 (syntax))
1492 (setq syntax (expr-compound-sep span-start span-end))
1493 (cond
1494 ((= (car first) (car second)) nil)
1495 ((= (cdr first) (cdr second)) nil)
1496 ((= syntax ?.) t)
1497 ((= syntax ? )
1498 (setq span-start (char-after (- span-start 1)))
1499 (setq span-end (char-after span-end))
1500 (cond
1501 ((= span-start ?) ) t )
1502 ((= span-start ?] ) t )
1503 ((= span-end ?( ) t )
1504 ((= span-end ?[ ) t )
1505 (t nil))
1506 )
dcec1a3b 1507 (t nil))))
5b08a462 1508
96f4e22e
RM
1509(provide 'gud)
1510
f961a17c 1511;;; gud.el ends here