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