*** empty log message ***
[bpt/emacs.git] / lisp / progmodes / gud.el
CommitLineData
0f9c2d46
JB
1;;; gud.el --- Grand Unified Debugger mode for running GDB and other debuggers
2
3;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
4;; Maintainer: FSF
5;; Keywords: unix, tools
6
0a0157ba 7;; Copyright (C) 1992,93,94,95,96,1998,2000,02,03,04,05 Free Software Foundation, Inc.
0f9c2d46
JB
8
9;; This file is part of GNU Emacs.
10
11;; GNU Emacs is free software; you can redistribute it and/or modify
12;; it under the terms of the GNU General Public License as published by
13;; the Free Software Foundation; either version 2, or (at your option)
14;; any later version.
15
16;; GNU Emacs is distributed in the hope that it will be useful,
17;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19;; GNU General Public License for more details.
20
21;; You should have received a copy of the GNU General Public License
22;; along with GNU Emacs; see the file COPYING. If not, write to the
3a35cf56
LK
23;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24;; Boston, MA 02110-1301, USA.
0f9c2d46
JB
25
26;;; Commentary:
27
be820e8d
NR
28;; The ancestral gdb.el was by W. Schelter <wfs@rascal.ics.utexas.edu> It was
29;; later rewritten by rms. Some ideas were due to Masanobu. Grand
30;; Unification (sdb/dbx support) by Eric S. Raymond <esr@thyrsus.com> Barry
31;; Warsaw <bwarsaw@cen.com> hacked the mode to use comint.el. Shane Hartman
32;; <shane@spr.com> added support for xdb (HPUX debugger). Rick Sladkey
33;; <jrs@world.std.com> wrote the GDB command completion code. Dave Love
34;; <d.love@dl.ac.uk> added the IRIX kluge, re-implemented the Mips-ish variant
35;; and added a menu. Brian D. Carlstrom <bdc@ai.mit.edu> combined the IRIX
36;; kluge with the gud-xdb-directories hack producing gud-dbx-directories.
37;; Derek L. Davies <ddavies@world.std.com> added support for jdb (Java
38;; debugger.)
0f9c2d46
JB
39
40;;; Code:
41
ce38ddb8
NR
42(eval-when-compile (require 'cl)) ; for case macro
43
0f9c2d46
JB
44(require 'comint)
45(require 'etags)
67bb20fa 46(require 'font-lock)
0f9c2d46
JB
47
48;; ======================================================================
49;; GUD commands must be visible in C buffers visited by GUD
50
51(defgroup gud nil
52 "Grand Unified Debugger mode for gdb and other debuggers under Emacs.
53Supported debuggers include gdb, sdb, dbx, xdb, perldb, pdb (Python), jdb, and bash."
54 :group 'unix
55 :group 'tools)
56
57
58(defcustom gud-key-prefix "\C-x\C-a"
59 "Prefix of all GUD commands valid in C buffers."
60 :type 'string
61 :group 'gud)
62
63(global-set-key (concat gud-key-prefix "\C-l") 'gud-refresh)
64(define-key ctl-x-map " " 'gud-break) ;; backward compatibility hack
65
66(defvar gud-marker-filter nil)
67(put 'gud-marker-filter 'permanent-local t)
68(defvar gud-find-file nil)
69(put 'gud-find-file 'permanent-local t)
70
71(defun gud-marker-filter (&rest args)
72 (apply gud-marker-filter args))
73
74(defvar gud-minor-mode nil)
75(put 'gud-minor-mode 'permanent-local t)
76
77(defvar gud-keep-buffer nil)
78
79(defun gud-symbol (sym &optional soft minor-mode)
80 "Return the symbol used for SYM in MINOR-MODE.
81MINOR-MODE defaults to `gud-minor-mode.
82The symbol returned is `gud-<MINOR-MODE>-<SYM>'.
83If SOFT is non-nil, returns nil if the symbol doesn't already exist."
84 (unless (or minor-mode gud-minor-mode) (error "Gud internal error"))
85 (funcall (if soft 'intern-soft 'intern)
86 (format "gud-%s-%s" (or minor-mode gud-minor-mode) sym)))
87
88(defun gud-val (sym &optional minor-mode)
89 "Return the value of `gud-symbol' SYM. Default to nil."
90 (let ((sym (gud-symbol sym t minor-mode)))
91 (if (boundp sym) (symbol-value sym))))
92
93(defvar gud-running nil
94 "Non-nil if debuggee is running.
f6579c71 95Used to grey out relevant togolbar icons.")
0f9c2d46 96
f6579c71 97;; Use existing Info buffer, if possible.
ed941a3c
NR
98(defun gud-goto-info ()
99 "Go to relevant Emacs info node."
100 (interactive)
f6579c71
NR
101 (let ((same-window-regexps same-window-regexps)
102 (display-buffer-reuse-frames t))
103 (catch 'info-found
104 (walk-windows
105 '(lambda (window)
106 (if (eq (window-buffer window) (get-buffer "*info*"))
107 (progn
108 (setq same-window-regexps nil)
109 (throw 'info-found nil))))
110 nil 0)
f6579c71
NR
111 (select-frame (make-frame)))
112 (if (memq gud-minor-mode '(gdbmi gdba))
be820e8d
NR
113 (info "(emacs)GDB Graphical Interface")
114 (info "(emacs)Debuggers"))))
ed941a3c 115
0f9c2d46 116(easy-mmode-defmap gud-menu-map
4e518230 117 '(([help] "Info" . gud-goto-info)
ce38ddb8 118 ([tooltips] menu-item "Toggle GUD tooltips" gud-tooltip-mode
12b47dbf
NR
119 :enable (and (not emacs-basic-display)
120 (display-graphic-p)
121 (fboundp 'x-show-tip))
ce38ddb8 122 :button (:toggle . gud-tooltip-mode))
adbb5567 123 ([refresh] "Refresh" . gud-refresh)
0f9c2d46 124 ([run] menu-item "Run" gud-run
129adb6f
NR
125 :enable (and (not gud-running)
126 (memq gud-minor-mode '(gdbmi gdba gdb dbx jdb))))
1dd52b82 127 ([until] menu-item "Continue to selection" gud-until
129adb6f
NR
128 :enable (and (not gud-running)
129 (memq gud-minor-mode '(gdbmi gdba gdb perldb))))
0f9c2d46 130 ([remove] menu-item "Remove Breakpoint" gud-remove
129adb6f 131 :enable (not gud-running))
0f9c2d46 132 ([tbreak] menu-item "Temporary Breakpoint" gud-tbreak
129adb6f 133 :enable (memq gud-minor-mode '(gdbmi gdba gdb sdb xdb bashdb)))
0f9c2d46 134 ([break] menu-item "Set Breakpoint" gud-break
129adb6f 135 :enable (not gud-running))
0f9c2d46 136 ([up] menu-item "Up Stack" gud-up
129adb6f
NR
137 :enable (and (not gud-running)
138 (memq gud-minor-mode
139 '(gdbmi gdba gdb dbx xdb jdb pdb bashdb))))
0f9c2d46 140 ([down] menu-item "Down Stack" gud-down
129adb6f
NR
141 :enable (and (not gud-running)
142 (memq gud-minor-mode
143 '(gdbmi gdba gdb dbx xdb jdb pdb bashdb))))
32759db5
NR
144 ([print*] menu-item "Print Dereference" gud-pstar
145 :enable (and (not gud-running)
146 (memq gud-minor-mode '(gdbmi gdba gdb))))
0f9c2d46
JB
147 ([print] menu-item "Print Expression" gud-print
148 :enable (not gud-running))
187c0c40 149 ([watch] menu-item "Watch Expression" gud-watch
129adb6f
NR
150 :enable (and (not gud-running)
151 (memq gud-minor-mode '(gdbmi gdba))))
0f9c2d46
JB
152 ([finish] menu-item "Finish Function" gud-finish
153 :enable (and (not gud-running)
154 (memq gud-minor-mode
129adb6f 155 '(gdbmi gdba gdb xdb jdb pdb bashdb))))
0f9c2d46
JB
156 ([stepi] menu-item "Step Instruction" gud-stepi
157 :enable (and (not gud-running)
129adb6f 158 (memq gud-minor-mode '(gdbmi gdba gdb dbx))))
0f9c2d46
JB
159 ([nexti] menu-item "Next Instruction" gud-nexti
160 :enable (and (not gud-running)
129adb6f 161 (memq gud-minor-mode '(gdbmi gdba gdb dbx))))
0f9c2d46
JB
162 ([step] menu-item "Step Line" gud-step
163 :enable (not gud-running))
164 ([next] menu-item "Next Line" gud-next
165 :enable (not gud-running))
166 ([cont] menu-item "Continue" gud-cont
167 :enable (not gud-running)))
168 "Menu for `gud-mode'."
169 :name "Gud")
170
171(easy-mmode-defmap gud-minor-mode-map
172 `(([menu-bar debug] . ("Gud" . ,gud-menu-map)))
173 "Map used in visited files.")
174
175(let ((m (assq 'gud-minor-mode minor-mode-map-alist)))
176 (if m (setcdr m gud-minor-mode-map)
177 (push (cons 'gud-minor-mode gud-minor-mode-map) minor-mode-map-alist)))
178
179(defvar gud-mode-map
180 ;; Will inherit from comint-mode via define-derived-mode.
181 (make-sparse-keymap)
182 "`gud-mode' keymap.")
183
184(defvar gud-tool-bar-map
185 (if (display-graphic-p)
186 (let ((map (make-sparse-keymap)))
187 (dolist (x '((gud-break . "gud-break")
188 (gud-remove . "gud-remove")
189 (gud-print . "gud-print")
32759db5 190 (gud-pstar . "gud-pstar")
187c0c40 191 (gud-watch . "gud-watch")
0f9c2d46 192 (gud-cont . "gud-cont")
32759db5
NR
193 (gud-until . "gud-until")
194 (gud-finish . "gud-finish")
195 (gud-run . "gud-run")
74c942de
EZ
196 ;; gud-s, gud-si etc. instead of gud-step,
197 ;; gud-stepi, to avoid file-name clashes on DOS
198 ;; 8+3 filesystems.
74c942de 199 (gud-next . "gud-n")
32759db5 200 (gud-step . "gud-s")
74c942de 201 (gud-nexti . "gud-ni")
32759db5 202 (gud-stepi . "gud-si")
0f9c2d46 203 (gud-up . "gud-up")
adbb5567 204 (gud-down . "gud-down")
ed941a3c 205 (gud-goto-info . "info"))
0f9c2d46
JB
206 map)
207 (tool-bar-local-item-from-menu
208 (car x) (cdr x) map gud-minor-mode-map)))))
209
210(defun gud-file-name (f)
211 "Transform a relative file name to an absolute file name.
212Uses `gud-<MINOR-MODE>-directories' to find the source files."
213 (if (file-exists-p f) (expand-file-name f)
214 (let ((directories (gud-val 'directories))
215 (result nil))
216 (while directories
217 (let ((path (expand-file-name f (car directories))))
218 (if (file-exists-p path)
219 (setq result path
220 directories nil)))
221 (setq directories (cdr directories)))
222 result)))
223
224(defun gud-find-file (file)
225 ;; Don't get confused by double slashes in the name that comes from GDB.
226 (while (string-match "//+" file)
227 (setq file (replace-match "/" t t file)))
228 (let ((minor-mode gud-minor-mode)
229 (buf (funcall (or gud-find-file 'gud-file-name) file)))
230 (when (stringp buf)
231 (setq buf (and (file-readable-p buf) (find-file-noselect buf 'nowarn))))
232 (when buf
233 ;; Copy `gud-minor-mode' to the found buffer to turn on the menu.
234 (with-current-buffer buf
235 (set (make-local-variable 'gud-minor-mode) minor-mode)
236 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
ce38ddb8
NR
237 (when (and gud-tooltip-mode
238 (memq gud-minor-mode '(gdbmi gdba)))
0d2794e3
NR
239 (make-local-variable 'gdb-define-alist)
240 (unless gdb-define-alist (gdb-create-define-alist))
241 (add-hook 'after-save-hook 'gdb-create-define-alist nil t))
0f9c2d46
JB
242 (make-local-variable 'gud-keep-buffer))
243 buf)))
244\f
245;; ======================================================================
246;; command definition
247
248;; This macro is used below to define some basic debugger interface commands.
249;; Of course you may use `gud-def' with any other debugger command, including
250;; user defined ones.
251
252;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
253;; which defines FUNC to send the command NAME to the debugger, gives
254;; it the docstring DOC, and binds that function to KEY in the GUD
255;; major mode. The function is also bound in the global keymap with the
256;; GUD prefix.
257
258(defmacro gud-def (func cmd key &optional doc)
259 "Define FUNC to be a command sending STR and bound to KEY, with
260optional doc string DOC. Certain %-escapes in the string arguments
261are interpreted specially if present. These are:
262
263 %f name (without directory) of current source file.
264 %F name (without directory or extension) of current source file.
265 %d directory of current source file.
266 %l number of current source line
267 %e text of the C lvalue or function-call expression surrounding point.
268 %a text of the hexadecimal address surrounding point
269 %p prefix argument to the command (if any) as a number
270
271 The `current' source file is the file of the current buffer (if
272we're in a C file) or the source file current at the last break or
273step (if we're in the GUD buffer).
274 The `current' line is that of the current buffer (if we're in a
275source file) or the source line number at the last break or step (if
276we're in the GUD buffer)."
277 `(progn
278 (defun ,func (arg)
279 ,@(if doc (list doc))
280 (interactive "p")
281 ,(if (stringp cmd)
282 `(gud-call ,cmd arg)
283 cmd))
284 ,(if key `(local-set-key ,(concat "\C-c" key) ',func))
285 ,(if key `(global-set-key (vconcat gud-key-prefix ,key) ',func))))
286
287;; Where gud-display-frame should put the debugging arrow; a cons of
288;; (filename . line-number). This is set by the marker-filter, which scans
289;; the debugger's output for indications of the current program counter.
290(defvar gud-last-frame nil)
291
292;; Used by gud-refresh, which should cause gud-display-frame to redisplay
293;; the last frame, even if it's been called before and gud-last-frame has
294;; been set to nil.
295(defvar gud-last-last-frame nil)
296
297;; All debugger-specific information is collected here.
298;; Here's how it works, in case you ever need to add a debugger to the mode.
299;;
300;; Each entry must define the following at startup:
301;;
302;;<name>
303;; comint-prompt-regexp
304;; gud-<name>-massage-args
305;; gud-<name>-marker-filter
306;; gud-<name>-find-file
307;;
308;; The job of the massage-args method is to modify the given list of
309;; debugger arguments before running the debugger.
310;;
311;; The job of the marker-filter method is to detect file/line markers in
312;; strings and set the global gud-last-frame to indicate what display
313;; action (if any) should be triggered by the marker. Note that only
314;; whatever the method *returns* is displayed in the buffer; thus, you
315;; can filter the debugger's output, interpreting some and passing on
316;; the rest.
317;;
318;; The job of the find-file method is to visit and return the buffer indicated
319;; by the car of gud-tag-frame. This may be a file name, a tag name, or
320;; something else.
321\f
322;; ======================================================================
323;; speedbar support functions and variables.
324(eval-when-compile (require 'speedbar)) ;For speedbar-with-attached-buffer.
325
326(defvar gud-last-speedbar-buffer nil
327 "The last GUD buffer used.")
328
329(defvar gud-last-speedbar-stackframe nil
330 "Description of the currently displayed GUD stack.
331t means that there is no stack, and we are in display-file mode.")
332
333(defvar gud-speedbar-key-map nil
334 "Keymap used when in the buffers display mode.")
335
336(defun gud-install-speedbar-variables ()
337 "Install those variables used by speedbar to enhance gud/gdb."
338 (if gud-speedbar-key-map
339 nil
340 (setq gud-speedbar-key-map (speedbar-make-specialized-keymap))
341
342 (define-key gud-speedbar-key-map "j" 'speedbar-edit-line)
343 (define-key gud-speedbar-key-map "e" 'speedbar-edit-line)
4ff07782
NR
344 (define-key gud-speedbar-key-map "\C-m" 'speedbar-edit-line)
345 (define-key gud-speedbar-key-map "D" 'gdb-var-delete)))
346
0f9c2d46
JB
347
348(defvar gud-speedbar-menu-items
349 ;; Note to self. Add expand, and turn off items when not available.
be820e8d 350 '(["Jump to stack frame" speedbar-edit-line
129adb6f
NR
351 (with-current-buffer gud-comint-buffer
352 (not (memq gud-minor-mode '(gdbmi gdba))))]
be820e8d 353 ["Edit value" speedbar-edit-line
129adb6f
NR
354 (with-current-buffer gud-comint-buffer
355 (not (memq gud-minor-mode '(gdbmi gdba))))]
be820e8d 356 ["Delete expression" gdb-var-delete
129adb6f
NR
357 (with-current-buffer gud-comint-buffer
358 (not (memq gud-minor-mode '(gdbmi gdba))))])
0f9c2d46
JB
359 "Additional menu items to add to the speedbar frame.")
360
361;; Make sure our special speedbar mode is loaded
362(if (featurep 'speedbar)
363 (gud-install-speedbar-variables)
364 (add-hook 'speedbar-load-hook 'gud-install-speedbar-variables))
365
366(defun gud-speedbar-buttons (buffer)
367 "Create a speedbar display based on the current state of GUD.
368If the GUD BUFFER is not running a supported debugger, then turn
369off the specialized speedbar mode."
187c0c40 370 (let ((minor-mode (with-current-buffer buffer gud-minor-mode)))
d7af3230 371 (cond
129adb6f 372 ((memq minor-mode '(gdbmi gdba))
187c0c40 373 (when (or gdb-var-changed
d7af3230 374 (not (save-excursion
187c0c40
NR
375 (goto-char (point-min))
376 (let ((case-fold-search t))
377 (looking-at "Watch Expressions:")))))
79148a5b 378 (erase-buffer)
187c0c40
NR
379 (insert "Watch Expressions:\n")
380 (let ((var-list gdb-var-list))
381 (while var-list
382 (let* ((depth 0) (start 0) (char ?+)
383 (var (car var-list)) (varnum (nth 1 var)))
384 (while (string-match "\\." varnum start)
385 (setq depth (1+ depth)
386 start (1+ (match-beginning 0))))
387 (if (equal (nth 2 var) "0")
388 (speedbar-make-tag-line 'bracket ?? nil nil
79148a5b
NR
389 (concat (car var) "\t" (nth 4 var))
390 'gdb-edit-value
d7af3230
NR
391 nil
392 (if (and (nth 5 var)
79148a5b
NR
393 gdb-show-changed-values)
394 'font-lock-warning-face
395 nil) depth)
187c0c40
NR
396 (if (and (cadr var-list)
397 (string-match varnum (cadr (cadr var-list))))
398 (setq char ?-))
399 (speedbar-make-tag-line 'bracket char
400 'gdb-speedbar-expand-node varnum
79148a5b 401 (concat (car var) "\t" (nth 3 var))
4ff07782 402 nil nil nil depth)))
187c0c40
NR
403 (setq var-list (cdr var-list))))
404 (setq gdb-var-changed nil)))
d7af3230 405 (t (if (and (save-excursion
187c0c40
NR
406 (goto-char (point-min))
407 (looking-at "Current Stack"))
408 (equal gud-last-last-frame gud-last-speedbar-stackframe))
409 nil
410 (setq gud-last-speedbar-buffer buffer)
411 (let ((gud-frame-list
412 (cond ((eq minor-mode 'gdb)
413 (gud-gdb-get-stackframe buffer))
414 ;; Add more debuggers here!
415 (t (speedbar-remove-localized-speedbar-support buffer)
416 nil))))
417 (erase-buffer)
418 (if (not gud-frame-list)
419 (insert "No Stack frames\n")
420 (insert "Current Stack:\n"))
421 (dolist (frame gud-frame-list)
422 (insert (nth 1 frame) ":\n")
423 (if (= (length frame) 2)
424 (progn
425; (speedbar-insert-button "[?]"
426; 'speedbar-button-face
427; nil nil nil t)
428 (speedbar-insert-button (car frame)
429 'speedbar-directory-face
430 nil nil nil t))
431; (speedbar-insert-button "[+]"
0f9c2d46 432; 'speedbar-button-face
187c0c40
NR
433; 'speedbar-highlight-face
434; 'gud-gdb-get-scope-data
435; frame t)
436 (speedbar-insert-button (car frame)
437 'speedbar-file-face
438 'speedbar-highlight-face
129adb6f 439 (cond ((memq minor-mode '(gdbmi gdba gdb))
187c0c40
NR
440 'gud-gdb-goto-stackframe)
441 (t (error "Should never be here")))
442 frame t)))
443; (let ((selected-frame
444; (cond ((eq ff 'gud-gdb-find-file)
445; (gud-gdb-selected-frame-info buffer))
446; (t (error "Should never be here"))))))
447 )
448 (setq gud-last-speedbar-stackframe gud-last-last-frame))))))
0f9c2d46
JB
449
450\f
451;; ======================================================================
452;; gdb functions
453
454;; History of argument lists passed to gdb.
455(defvar gud-gdb-history nil)
456
d7af3230 457(defcustom gud-gdb-command-name "gdb --annotate=3"
0f9c2d46
JB
458 "Default command to execute an executable under the GDB debugger."
459 :type 'string
460 :group 'gud)
461
462(defvar gud-gdb-marker-regexp
463 ;; This used to use path-separator instead of ":";
464 ;; however, we found that on both Windows 32 and MSDOS
465 ;; a colon is correct here.
466 (concat "\032\032\\(.:?[^" ":" "\n]*\\)" ":"
467 "\\([0-9]*\\)" ":" ".*\n"))
468
469;; There's no guarantee that Emacs will hand the filter the entire
470;; marker at once; it could be broken up across several strings. We
471;; might even receive a big chunk with several markers in it. If we
472;; receive a chunk of text which looks like it might contain the
473;; beginning of a marker, we save it here between calls to the
474;; filter.
475(defvar gud-marker-acc "")
476(make-variable-buffer-local 'gud-marker-acc)
477
478(defun gud-gdb-marker-filter (string)
479 (setq gud-marker-acc (concat gud-marker-acc string))
480 (let ((output ""))
481
482 ;; Process all the complete markers in this chunk.
483 (while (string-match gud-gdb-marker-regexp gud-marker-acc)
484 (setq
485
486 ;; Extract the frame position from the marker.
487 gud-last-frame (cons (match-string 1 gud-marker-acc)
0d2794e3 488 (string-to-number (match-string 2 gud-marker-acc)))
0f9c2d46
JB
489
490 ;; Append any text before the marker to the output we're going
491 ;; to return - we don't include the marker in this text.
492 output (concat output
493 (substring gud-marker-acc 0 (match-beginning 0)))
494
495 ;; Set the accumulator to the remaining text.
496 gud-marker-acc (substring gud-marker-acc (match-end 0))))
497
4ff07782
NR
498 ;; Check for annotations and change gud-minor-mode to 'gdba if
499 ;; they are found.
d7af3230 500 (while (string-match "\n\032\032\\(.*\\)\n" gud-marker-acc)
823d2235
NR
501 (let ((match (match-string 1 gud-marker-acc)))
502 (when (string-equal match "prompt")
503 (require 'gdb-ui)
504 (gdb-prompt nil))
505
506 (setq
507 ;; Append any text before the marker to the output we're going
508 ;; to return - we don't include the marker in this text.
509 output (concat output
510 (substring gud-marker-acc 0 (match-beginning 0)))
511
512 ;; Set the accumulator to the remaining text.
513
514 gud-marker-acc (substring gud-marker-acc (match-end 0)))
515 (if (string-equal match "error-begin")
516 (put-text-property 0 (length gud-marker-acc)
517 'face font-lock-warning-face
518 gud-marker-acc))))
d7af3230 519
0f9c2d46
JB
520 ;; Does the remaining text look like it might end with the
521 ;; beginning of another marker? If it does, then keep it in
522 ;; gud-marker-acc until we receive the rest of it. Since we
523 ;; know the full marker regexp above failed, it's pretty simple to
524 ;; test for marker starts.
034de736 525 (if (string-match "\n\\(\032.*\\)?\\'" gud-marker-acc)
0f9c2d46
JB
526 (progn
527 ;; Everything before the potential marker start can be output.
528 (setq output (concat output (substring gud-marker-acc
529 0 (match-beginning 0))))
530
531 ;; Everything after, we save, to combine with later input.
532 (setq gud-marker-acc
533 (substring gud-marker-acc (match-beginning 0))))
534
535 (setq output (concat output gud-marker-acc)
536 gud-marker-acc ""))
537
538 output))
539
540(easy-mmode-defmap gud-minibuffer-local-map
541 '(("\C-i" . comint-dynamic-complete-filename))
542 "Keymap for minibuffer prompting of gud startup command."
543 :inherit minibuffer-local-map)
544
545(defun gud-query-cmdline (minor-mode &optional init)
546 (let* ((hist-sym (gud-symbol 'history nil minor-mode))
547 (cmd-name (gud-val 'command-name minor-mode)))
548 (unless (boundp hist-sym) (set hist-sym nil))
549 (read-from-minibuffer
550 (format "Run %s (like this): " minor-mode)
551 (or (car-safe (symbol-value hist-sym))
552 (concat (or cmd-name (symbol-name minor-mode))
553 " "
554 (or init
555 (let ((file nil))
556 (dolist (f (directory-files default-directory) file)
557 (if (and (file-executable-p f)
558 (not (file-directory-p f))
559 (or (not file)
560 (file-newer-than-file-p f file)))
561 (setq file f)))))))
562 gud-minibuffer-local-map nil
563 hist-sym)))
564
9f1d9ee4 565(defvar gdb-first-prompt t)
d7af3230 566
63cc3b09
NR
567(defvar gud-filter-pending-text nil
568 "Non-nil means this is text that has been saved for later in `gud-filter'.")
569
0f9c2d46
JB
570;;;###autoload
571(defun gdb (command-line)
572 "Run gdb on program FILE in buffer *gud-FILE*.
573The directory containing FILE becomes the initial working directory
574and source-file directory for your debugger."
575 (interactive (list (gud-query-cmdline 'gdb)))
576
577 (gud-common-init command-line nil 'gud-gdb-marker-filter)
578 (set (make-local-variable 'gud-minor-mode) 'gdb)
579
580 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
581 (gud-def gud-tbreak "tbreak %f:%l" "\C-t" "Set temporary breakpoint at current line.")
582 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
583 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
584 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
585 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
586 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
587 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
588 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
589 (gud-def gud-jump "tbreak %f:%l\njump %f:%l" "\C-j" "Relocate execution address to line at point in source buffer.")
590
591 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
592 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
593 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
32759db5
NR
594 (gud-def gud-pstar "print* %e" nil
595 "Evaluate C dereferenced pointer expression at point.")
0f9c2d46
JB
596 (gud-def gud-until "until %l" "\C-u" "Continue to current line.")
597 (gud-def gud-run "run" nil "Run the program.")
598
599 (local-set-key "\C-i" 'gud-gdb-complete-command)
600 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
601 (setq paragraph-start comint-prompt-regexp)
9f1d9ee4 602 (setq gdb-first-prompt t)
63cc3b09 603 (setq gud-filter-pending-text nil)
d7af3230 604 (run-hooks 'gdb-mode-hook))
0f9c2d46
JB
605
606;; One of the nice features of GDB is its impressive support for
607;; context-sensitive command completion. We preserve that feature
608;; in the GUD buffer by using a GDB command designed just for Emacs.
609
610;; The completion process filter indicates when it is finished.
611(defvar gud-gdb-fetch-lines-in-progress)
612
613;; Since output may arrive in fragments we accumulate partials strings here.
614(defvar gud-gdb-fetch-lines-string)
615
616;; We need to know how much of the completion to chop off.
617(defvar gud-gdb-fetch-lines-break)
618
619;; The completion list is constructed by the process filter.
620(defvar gud-gdb-fetched-lines)
621
622(defvar gud-comint-buffer nil)
623
624(defun gud-gdb-complete-command ()
625 "Perform completion on the GDB command preceding point.
626This is implemented using the GDB `complete' command which isn't
627available with older versions of GDB."
628 (interactive)
629 (let* ((end (point))
630 (command (buffer-substring (comint-line-beginning-position) end))
631 (command-word
632 ;; Find the word break. This match will always succeed.
633 (and (string-match "\\(\\`\\| \\)\\([^ ]*\\)\\'" command)
634 (substring command (match-beginning 2))))
635 (complete-list
636 (gud-gdb-run-command-fetch-lines (concat "complete " command)
637 (current-buffer)
638 ;; From string-match above.
639 (match-beginning 2))))
640 ;; Protect against old versions of GDB.
641 (and complete-list
642 (string-match "^Undefined command: \"complete\"" (car complete-list))
643 (error "This version of GDB doesn't support the `complete' command"))
644 ;; Sort the list like readline.
645 (setq complete-list (sort complete-list (function string-lessp)))
646 ;; Remove duplicates.
647 (let ((first complete-list)
648 (second (cdr complete-list)))
649 (while second
650 (if (string-equal (car first) (car second))
651 (setcdr first (setq second (cdr second)))
652 (setq first second
653 second (cdr second)))))
654 ;; Add a trailing single quote if there is a unique completion
655 ;; and it contains an odd number of unquoted single quotes.
656 (and (= (length complete-list) 1)
657 (let ((str (car complete-list))
658 (pos 0)
659 (count 0))
660 (while (string-match "\\([^'\\]\\|\\\\'\\)*'" str pos)
661 (setq count (1+ count)
662 pos (match-end 0)))
663 (and (= (mod count 2) 1)
664 (setq complete-list (list (concat str "'"))))))
665 ;; Let comint handle the rest.
666 (comint-dynamic-simple-complete command-word complete-list)))
667
668;; The completion process filter is installed temporarily to slurp the
669;; output of GDB up to the next prompt and build the completion list.
670(defun gud-gdb-fetch-lines-filter (string filter)
671 "Filter used to read the list of lines output by a command.
672STRING is the output to filter.
673It is passed through FILTER before we look at it."
674 (setq string (funcall filter string))
675 (setq string (concat gud-gdb-fetch-lines-string string))
676 (while (string-match "\n" string)
677 (push (substring string gud-gdb-fetch-lines-break (match-beginning 0))
678 gud-gdb-fetched-lines)
679 (setq string (substring string (match-end 0))))
680 (if (string-match comint-prompt-regexp string)
681 (progn
682 (setq gud-gdb-fetch-lines-in-progress nil)
683 string)
684 (progn
685 (setq gud-gdb-fetch-lines-string string)
686 "")))
687
688;; gdb speedbar functions
689
690(defun gud-gdb-goto-stackframe (text token indent)
691 "Goto the stackframe described by TEXT, TOKEN, and INDENT."
692 (speedbar-with-attached-buffer
693 (gud-basic-call (concat "server frame " (nth 1 token)))
694 (sit-for 1)))
695
696(defvar gud-gdb-fetched-stack-frame nil
697 "Stack frames we are fetching from GDB.")
698
699;(defun gud-gdb-get-scope-data (text token indent)
700; ;; checkdoc-params: (indent)
701; "Fetch data associated with a stack frame, and expand/contract it.
702;Data to do this is retrieved from TEXT and TOKEN."
703; (let ((args nil) (scope nil))
704; (gud-gdb-run-command-fetch-lines "info args")
705;
706; (gud-gdb-run-command-fetch-lines "info local")
707;
708; ))
709
710(defun gud-gdb-get-stackframe (buffer)
711 "Extract the current stack frame out of the GUD GDB BUFFER."
712 (let ((newlst nil)
713 (fetched-stack-frame-list
714 (gud-gdb-run-command-fetch-lines "server backtrace" buffer)))
715 (if (and (car fetched-stack-frame-list)
716 (string-match "No stack" (car fetched-stack-frame-list)))
717 ;; Go into some other mode???
718 nil
719 (dolist (e fetched-stack-frame-list)
720 (let ((name nil) (num nil))
721 (if (not (or
722 (string-match "^#\\([0-9]+\\) +[0-9a-fx]+ in \\([:0-9a-zA-Z_]+\\) (" e)
723 (string-match "^#\\([0-9]+\\) +\\([:0-9a-zA-Z_]+\\) (" e)))
724 (if (not (string-match
725 "at \\([-0-9a-zA-Z_.]+\\):\\([0-9]+\\)$" e))
726 nil
727 (setcar newlst
728 (list (nth 0 (car newlst))
729 (nth 1 (car newlst))
730 (match-string 1 e)
731 (match-string 2 e))))
732 (setq num (match-string 1 e)
733 name (match-string 2 e))
734 (setq newlst
735 (cons
736 (if (string-match
737 "at \\([-0-9a-zA-Z_.]+\\):\\([0-9]+\\)$" e)
738 (list name num (match-string 1 e)
739 (match-string 2 e))
740 (list name num))
741 newlst)))))
742 (nreverse newlst))))
743
744;(defun gud-gdb-selected-frame-info (buffer)
745; "Learn GDB information for the currently selected stack frame in BUFFER."
746; )
747
748(defun gud-gdb-run-command-fetch-lines (command buffer &optional skip)
749 "Run COMMAND, and return the list of lines it outputs.
750BUFFER is the GUD buffer in which to run the command.
751SKIP is the number of chars to skip on each lines, it defaults to 0."
752 (with-current-buffer buffer
753 (if (save-excursion
754 (goto-char (point-max))
755 (forward-line 0)
756 (not (looking-at comint-prompt-regexp)))
757 nil
758 ;; Much of this copied from GDB complete, but I'm grabbing the stack
759 ;; frame instead.
760 (let ((gud-gdb-fetch-lines-in-progress t)
761 (gud-gdb-fetched-lines nil)
762 (gud-gdb-fetch-lines-string nil)
763 (gud-gdb-fetch-lines-break (or skip 0))
764 (gud-marker-filter
765 `(lambda (string) (gud-gdb-fetch-lines-filter string ',gud-marker-filter))))
766 ;; Issue the command to GDB.
767 (gud-basic-call command)
768 ;; Slurp the output.
769 (while gud-gdb-fetch-lines-in-progress
770 (accept-process-output (get-buffer-process buffer)))
771 (nreverse gud-gdb-fetched-lines)))))
772
773\f
774;; ======================================================================
775;; sdb functions
776
777;; History of argument lists passed to sdb.
778(defvar gud-sdb-history nil)
779
780(defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
781 "If nil, we're on a System V Release 4 and don't need the tags hack.")
782
783(defvar gud-sdb-lastfile nil)
784
785(defun gud-sdb-marker-filter (string)
786 (setq gud-marker-acc
787 (if gud-marker-acc (concat gud-marker-acc string) string))
788 (let (start)
789 ;; Process all complete markers in this chunk
790 (while
791 (cond
792 ;; System V Release 3.2 uses this format
793 ((string-match "\\(^\\|\n\\)\\*?\\(0x\\w* in \\)?\\([^:\n]*\\):\\([0-9]*\\):.*\n"
794 gud-marker-acc start)
795 (setq gud-last-frame
796 (cons (match-string 3 gud-marker-acc)
0d2794e3 797 (string-to-number (match-string 4 gud-marker-acc)))))
0f9c2d46
JB
798 ;; System V Release 4.0 quite often clumps two lines together
799 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
800 gud-marker-acc start)
801 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc))
802 (setq gud-last-frame
803 (cons gud-sdb-lastfile
0d2794e3 804 (string-to-number (match-string 3 gud-marker-acc)))))
0f9c2d46
JB
805 ;; System V Release 4.0
806 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n"
807 gud-marker-acc start)
808 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc)))
809 ((and gud-sdb-lastfile (string-match "^\\([0-9]+\\):"
810 gud-marker-acc start))
811 (setq gud-last-frame
812 (cons gud-sdb-lastfile
0d2794e3 813 (string-to-number (match-string 1 gud-marker-acc)))))
0f9c2d46
JB
814 (t
815 (setq gud-sdb-lastfile nil)))
816 (setq start (match-end 0)))
817
818 ;; Search for the last incomplete line in this chunk
819 (while (string-match "\n" gud-marker-acc start)
820 (setq start (match-end 0)))
821
822 ;; If we have an incomplete line, store it in gud-marker-acc.
823 (setq gud-marker-acc (substring gud-marker-acc (or start 0))))
824 string)
825
826(defun gud-sdb-find-file (f)
827 (if gud-sdb-needs-tags (find-tag-noselect f) (find-file-noselect f)))
828
829;;;###autoload
830(defun sdb (command-line)
831 "Run sdb on program FILE in buffer *gud-FILE*.
832The directory containing FILE becomes the initial working directory
833and source-file directory for your debugger."
834 (interactive (list (gud-query-cmdline 'sdb)))
835
836 (if (and gud-sdb-needs-tags
837 (not (and (boundp 'tags-file-name)
838 (stringp tags-file-name)
839 (file-exists-p tags-file-name))))
840 (error "The sdb support requires a valid tags table to work"))
841
842 (gud-common-init command-line nil 'gud-sdb-marker-filter 'gud-sdb-find-file)
843 (set (make-local-variable 'gud-minor-mode) 'sdb)
844
845 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
846 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
847 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
848 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
849 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
850 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
851 (gud-def gud-cont "c" "\C-r" "Continue with display.")
852 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
853
854 (setq comint-prompt-regexp "\\(^\\|\n\\)\\*")
855 (setq paragraph-start comint-prompt-regexp)
856 (run-hooks 'sdb-mode-hook)
857 )
858\f
859;; ======================================================================
860;; dbx functions
861
862;; History of argument lists passed to dbx.
863(defvar gud-dbx-history nil)
864
865(defcustom gud-dbx-directories nil
866 "*A list of directories that dbx should search for source code.
867If nil, only source files in the program directory
868will be known to dbx.
869
870The file names should be absolute, or relative to the directory
871containing the executable being debugged."
872 :type '(choice (const :tag "Current Directory" nil)
873 (repeat :value ("")
874 directory))
875 :group 'gud)
876
877(defun gud-dbx-massage-args (file args)
878 (nconc (let ((directories gud-dbx-directories)
879 (result nil))
880 (while directories
881 (setq result (cons (car directories) (cons "-I" result)))
882 (setq directories (cdr directories)))
883 (nreverse result))
884 args))
885
886(defun gud-dbx-marker-filter (string)
887 (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
888
889 (let (start)
890 ;; Process all complete markers in this chunk.
891 (while (or (string-match
892 "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
893 gud-marker-acc start)
894 (string-match
895 "signal .* in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
896 gud-marker-acc start))
897 (setq gud-last-frame
898 (cons (match-string 2 gud-marker-acc)
0d2794e3 899 (string-to-number (match-string 1 gud-marker-acc)))
0f9c2d46
JB
900 start (match-end 0)))
901
902 ;; Search for the last incomplete line in this chunk
903 (while (string-match "\n" gud-marker-acc start)
904 (setq start (match-end 0)))
905
906 ;; If the incomplete line APPEARS to begin with another marker, keep it
907 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
908 ;; unnecessary concat during the next call.
909 (setq gud-marker-acc
910 (if (string-match "\\(stopped\\|signal\\)" gud-marker-acc start)
911 (substring gud-marker-acc (match-beginning 0))
912 nil)))
913 string)
914
915;; Functions for Mips-style dbx. Given the option `-emacs', documented in
916;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
917(defvar gud-mips-p
918 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
919 ;; We haven't tested gud on this system:
920 (string-match "^mips-[^-]*-riscos" system-configuration)
921 ;; It's documented on OSF/1.3
922 (string-match "^mips-[^-]*-osf1" system-configuration)
923 (string-match "^alpha[^-]*-[^-]*-osf" system-configuration))
924 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
925
926(defvar gud-dbx-command-name
927 (concat "dbx" (if gud-mips-p " -emacs")))
928
929;; This is just like the gdb one except for the regexps since we need to cope
930;; with an optional breakpoint number in [] before the ^Z^Z
931(defun gud-mipsdbx-marker-filter (string)
932 (setq gud-marker-acc (concat gud-marker-acc string))
933 (let ((output ""))
934
935 ;; Process all the complete markers in this chunk.
936 (while (string-match
937 ;; This is like th gdb marker but with an optional
938 ;; leading break point number like `[1] '
939 "[][ 0-9]*\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
940 gud-marker-acc)
941 (setq
942
943 ;; Extract the frame position from the marker.
944 gud-last-frame
945 (cons (match-string 1 gud-marker-acc)
0d2794e3 946 (string-to-number (match-string 2 gud-marker-acc)))
0f9c2d46
JB
947
948 ;; Append any text before the marker to the output we're going
949 ;; to return - we don't include the marker in this text.
950 output (concat output
951 (substring gud-marker-acc 0 (match-beginning 0)))
952
953 ;; Set the accumulator to the remaining text.
954 gud-marker-acc (substring gud-marker-acc (match-end 0))))
955
956 ;; Does the remaining text look like it might end with the
957 ;; beginning of another marker? If it does, then keep it in
958 ;; gud-marker-acc until we receive the rest of it. Since we
959 ;; know the full marker regexp above failed, it's pretty simple to
960 ;; test for marker starts.
961 (if (string-match "[][ 0-9]*\032.*\\'" gud-marker-acc)
962 (progn
963 ;; Everything before the potential marker start can be output.
964 (setq output (concat output (substring gud-marker-acc
965 0 (match-beginning 0))))
966
967 ;; Everything after, we save, to combine with later input.
968 (setq gud-marker-acc
969 (substring gud-marker-acc (match-beginning 0))))
970
971 (setq output (concat output gud-marker-acc)
972 gud-marker-acc ""))
973
974 output))
975
976;; The dbx in IRIX is a pain. It doesn't print the file name when
977;; stopping at a breakpoint (but you do get it from the `up' and
978;; `down' commands...). The only way to extract the information seems
979;; to be with a `file' command, although the current line number is
980;; available in $curline. Thus we have to look for output which
981;; appears to indicate a breakpoint. Then we prod the dbx sub-process
982;; to output the information we want with a combination of the
983;; `printf' and `file' commands as a pseudo marker which we can
984;; recognise next time through the marker-filter. This would be like
985;; the gdb marker but you can't get the file name without a newline...
986;; Note that gud-remove won't work since Irix dbx expects a breakpoint
987;; number rather than a line number etc. Maybe this could be made to
988;; work by listing all the breakpoints and picking the one(s) with the
989;; correct line number, but life's too short.
990;; d.love@dl.ac.uk (Dave Love) can be blamed for this
991
992(defvar gud-irix-p
993 (and (string-match "^mips-[^-]*-irix" system-configuration)
994 (not (string-match "irix[6-9]\\.[1-9]" system-configuration)))
995 "Non-nil to assume the interface appropriate for IRIX dbx.
996This works in IRIX 4, 5 and 6, but `gud-dbx-use-stopformat-p' provides
997a better solution in 6.1 upwards.")
998(defvar gud-dbx-use-stopformat-p
999 (string-match "irix[6-9]\\.[1-9]" system-configuration)
1000 "Non-nil to use the dbx feature present at least from Irix 6.1
1001 whereby $stopformat=1 produces an output format compatiable with
1002 `gud-dbx-marker-filter'.")
1003;; [Irix dbx seems to be a moving target. The dbx output changed
1004;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
1005;; the output from `up' is no longer spotted by gud (and it's probably
1006;; not distinctive enough to try to match it -- use C-<, C->
1007;; exclusively) . For 5.3 and 6.0, the $curline variable changed to
1008;; `long long'(why?!), so the printf stuff needed changing. The line
1009;; number was cast to `long' as a compromise between the new `long
1010;; long' and the original `int'. This is reported not to work in 6.2,
1011;; so it's changed back to int -- don't make your sources too long.
1012;; From Irix6.1 (but not 6.0?) dbx supports an undocumented feature
1013;; whereby `set $stopformat=1' reportedly produces output compatible
1014;; with `gud-dbx-marker-filter', which we prefer.
1015
1016;; The process filter is also somewhat
1017;; unreliable, sometimes not spotting the markers; I don't know
1018;; whether there's anything that can be done about that. It would be
1019;; much better if SGI could be persuaded to (re?)instate the MIPS
1020;; -emacs flag for gdb-like output (which ought to be possible as most
1021;; of the communication I've had over it has been from sgi.com).]
1022
1023;; this filter is influenced by the xdb one rather than the gdb one
1024(defun gud-irixdbx-marker-filter (string)
1025 (let (result (case-fold-search nil))
1026 (if (or (string-match comint-prompt-regexp string)
1027 (string-match ".*\012" string))
1028 (setq result (concat gud-marker-acc string)
1029 gud-marker-acc "")
1030 (setq gud-marker-acc (concat gud-marker-acc string)))
1031 (if result
1032 (cond
1033 ;; look for breakpoint or signal indication e.g.:
1034 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
1035 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
1036 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
1037 ((string-match
1038 "^\\(\\[[0-9]+] \\)?Process +[0-9]+ ([^)]*) [^[]+\\[[^]\n]*]\n"
1039 result)
1040 ;; prod dbx into printing out the line number and file
1041 ;; name in a form we can grok as below
1042 (process-send-string (get-buffer-process gud-comint-buffer)
1043 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1044 ;; look for result of, say, "up" e.g.:
1045 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
1046 ;; (this will also catch one of the lines printed by "where")
1047 ((string-match
1048 "^[^ ][^[]*\\[\"\\([^\"]+\\)\":\\([0-9]+\\), [^]]+]\n"
1049 result)
1050 (let ((file (match-string 1 result)))
1051 (if (file-exists-p file)
1052 (setq gud-last-frame
1053 (cons (match-string 1 result)
0d2794e3 1054 (string-to-number (match-string 2 result))))))
0f9c2d46
JB
1055 result)
1056 ((string-match ; kluged-up marker as above
1057 "\032\032\\([0-9]*\\):\\(.*\\)\n" result)
1058 (let ((file (gud-file-name (match-string 2 result))))
1059 (if (and file (file-exists-p file))
1060 (setq gud-last-frame
1061 (cons file
0d2794e3 1062 (string-to-number (match-string 1 result))))))
0f9c2d46
JB
1063 (setq result (substring result 0 (match-beginning 0))))))
1064 (or result "")))
1065
1066(defvar gud-dgux-p (string-match "-dgux" system-configuration)
1067 "Non-nil means to assume the interface approriate for DG/UX dbx.
1068This was tested using R4.11.")
1069
1070;; There are a couple of differences between DG's dbx output and normal
1071;; dbx output which make it nontrivial to integrate this into the
1072;; standard dbx-marker-filter (mainly, there are a different number of
1073;; backreferences). The markers look like:
1074;;
1075;; (0) Stopped at line 10, routine main(argc=1, argv=0xeffff0e0), file t.c
1076;;
1077;; from breakpoints (the `(0)' there isn't constant, it's the breakpoint
1078;; number), and
1079;;
1080;; Stopped at line 13, routine main(argc=1, argv=0xeffff0e0), file t.c
1081;;
1082;; from signals and
1083;;
1084;; Frame 21, line 974, routine command_loop(), file keyboard.c
1085;;
1086;; from up/down/where.
1087
1088(defun gud-dguxdbx-marker-filter (string)
1089 (setq gud-marker-acc (if gud-marker-acc
1090 (concat gud-marker-acc string)
1091 string))
1092 (let ((re (concat "^\\(\\(([0-9]+) \\)?Stopped at\\|Frame [0-9]+,\\)"
1093 " line \\([0-9]+\\), routine .*, file \\([^ \t\n]+\\)"))
1094 start)
1095 ;; Process all complete markers in this chunk.
1096 (while (string-match re gud-marker-acc start)
1097 (setq gud-last-frame
1098 (cons (match-string 4 gud-marker-acc)
0d2794e3 1099 (string-to-number (match-string 3 gud-marker-acc)))
0f9c2d46
JB
1100 start (match-end 0)))
1101
1102 ;; Search for the last incomplete line in this chunk
1103 (while (string-match "\n" gud-marker-acc start)
1104 (setq start (match-end 0)))
1105
1106 ;; If the incomplete line APPEARS to begin with another marker, keep it
1107 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1108 ;; unnecessary concat during the next call.
1109 (setq gud-marker-acc
1110 (if (string-match "Stopped\\|Frame" gud-marker-acc start)
1111 (substring gud-marker-acc (match-beginning 0))
1112 nil)))
1113 string)
1114
1115;;;###autoload
1116(defun dbx (command-line)
1117 "Run dbx on program FILE in buffer *gud-FILE*.
1118The directory containing FILE becomes the initial working directory
1119and source-file directory for your debugger."
1120 (interactive (list (gud-query-cmdline 'dbx)))
1121
1122 (cond
1123 (gud-mips-p
1124 (gud-common-init command-line nil 'gud-mipsdbx-marker-filter))
1125 (gud-irix-p
1126 (gud-common-init command-line 'gud-dbx-massage-args
1127 'gud-irixdbx-marker-filter))
1128 (gud-dgux-p
1129 (gud-common-init command-line 'gud-dbx-massage-args
1130 'gud-dguxdbx-marker-filter))
1131 (t
1132 (gud-common-init command-line 'gud-dbx-massage-args
1133 'gud-dbx-marker-filter)))
1134
1135 (set (make-local-variable 'gud-minor-mode) 'dbx)
1136
1137 (cond
1138 (gud-mips-p
1139 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1140 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1141 (gud-def gud-break "stop at \"%f\":%l"
1142 "\C-b" "Set breakpoint at current line.")
1143 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
1144 (gud-irix-p
1145 (gud-def gud-break "stop at \"%d%f\":%l"
1146 "\C-b" "Set breakpoint at current line.")
1147 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1148 (gud-def gud-up "up %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1149 "<" "Up (numeric arg) stack frames.")
1150 (gud-def gud-down "down %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1151 ">" "Down (numeric arg) stack frames.")
1152 ;; Make dbx give out the source location info that we need.
1153 (process-send-string (get-buffer-process gud-comint-buffer)
1154 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1155 (t
1156 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1157 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1158 (gud-def gud-break "file \"%d%f\"\nstop at %l"
1159 "\C-b" "Set breakpoint at current line.")
1160 (if gud-dbx-use-stopformat-p
1161 (process-send-string (get-buffer-process gud-comint-buffer)
1162 "set $stopformat=1\n"))))
1163
1164 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
1165 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
1166 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
1167 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
deaef289 1168 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
0f9c2d46
JB
1169 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
1170 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
deaef289 1171 (gud-def gud-run "run" nil "Run the program.")
0f9c2d46
JB
1172
1173 (setq comint-prompt-regexp "^[^)\n]*dbx) *")
1174 (setq paragraph-start comint-prompt-regexp)
1175 (run-hooks 'dbx-mode-hook)
1176 )
1177\f
1178;; ======================================================================
1179;; xdb (HP PARISC debugger) functions
1180
1181;; History of argument lists passed to xdb.
1182(defvar gud-xdb-history nil)
1183
1184(defcustom gud-xdb-directories nil
1185 "*A list of directories that xdb should search for source code.
1186If nil, only source files in the program directory
1187will be known to xdb.
1188
1189The file names should be absolute, or relative to the directory
1190containing the executable being debugged."
1191 :type '(choice (const :tag "Current Directory" nil)
1192 (repeat :value ("")
1193 directory))
1194 :group 'gud)
1195
1196(defun gud-xdb-massage-args (file args)
1197 (nconc (let ((directories gud-xdb-directories)
1198 (result nil))
1199 (while directories
1200 (setq result (cons (car directories) (cons "-d" result)))
1201 (setq directories (cdr directories)))
1202 (nreverse result))
1203 args))
1204
1205;; xdb does not print the lines all at once, so we have to accumulate them
1206(defun gud-xdb-marker-filter (string)
1207 (let (result)
1208 (if (or (string-match comint-prompt-regexp string)
1209 (string-match ".*\012" string))
1210 (setq result (concat gud-marker-acc string)
1211 gud-marker-acc "")
1212 (setq gud-marker-acc (concat gud-marker-acc string)))
1213 (if result
1214 (if (or (string-match "\\([^\n \t:]+\\): [^:]+: \\([0-9]+\\)[: ]"
1215 result)
1216 (string-match "[^: \t]+:[ \t]+\\([^:]+\\): [^:]+: \\([0-9]+\\):"
1217 result))
0d2794e3 1218 (let ((line (string-to-number (match-string 2 result)))
0f9c2d46
JB
1219 (file (gud-file-name (match-string 1 result))))
1220 (if file
1221 (setq gud-last-frame (cons file line))))))
1222 (or result "")))
1223
1224;;;###autoload
1225(defun xdb (command-line)
1226 "Run xdb on program FILE in buffer *gud-FILE*.
1227The directory containing FILE becomes the initial working directory
1228and source-file directory for your debugger.
1229
490f67f8 1230You can set the variable `gud-xdb-directories' to a list of program source
0f9c2d46
JB
1231directories if your program contains sources from more than one directory."
1232 (interactive (list (gud-query-cmdline 'xdb)))
1233
1234 (gud-common-init command-line 'gud-xdb-massage-args
1235 'gud-xdb-marker-filter)
1236 (set (make-local-variable 'gud-minor-mode) 'xdb)
1237
1238 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
1239 (gud-def gud-tbreak "b %f:%l\\t" "\C-t"
1240 "Set temporary breakpoint at current line.")
1241 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
1242 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
1243 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1244 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1245 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1246 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1247 (gud-def gud-finish "bu\\t" "\C-f" "Finish executing current function.")
1248 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
1249
1250 (setq comint-prompt-regexp "^>")
1251 (setq paragraph-start comint-prompt-regexp)
1252 (run-hooks 'xdb-mode-hook))
1253\f
1254;; ======================================================================
1255;; perldb functions
1256
1257;; History of argument lists passed to perldb.
1258(defvar gud-perldb-history nil)
1259
1260(defun gud-perldb-massage-args (file args)
1261 "Convert a command line as would be typed normally to run perldb
1262into one that invokes an Emacs-enabled debugging session.
1263\"-emacs\" is inserted where it will be $ARGV[0] (see perl5db.pl)."
1264 ;; FIXME: what if the command is `make perldb' and doesn't accept those extra
1265 ;; arguments ?
1266 (let* ((new-args nil)
1267 (seen-e nil)
1268 (shift (lambda () (push (pop args) new-args))))
1269
1270 ;; Pass all switches and -e scripts through.
1271 (while (and args
1272 (string-match "^-" (car args))
1273 (not (equal "-" (car args)))
1274 (not (equal "--" (car args))))
1275 (when (equal "-e" (car args))
1276 ;; -e goes with the next arg, so shift one extra.
1277 (or (funcall shift)
1278 ;; -e as the last arg is an error in Perl.
1279 (error "No code specified for -e"))
1280 (setq seen-e t))
1281 (funcall shift))
1282
1283 (unless seen-e
1284 (if (or (not args)
1285 (string-match "^-" (car args)))
1286 (error "Can't use stdin as the script to debug"))
1287 ;; This is the program name.
1288 (funcall shift))
1289
1290 ;; If -e specified, make sure there is a -- so -emacs is not taken
1291 ;; as -e macs.
1292 (if (and args (equal "--" (car args)))
1293 (funcall shift)
1294 (and seen-e (push "--" new-args)))
1295
1296 (push "-emacs" new-args)
1297 (while args
1298 (funcall shift))
1299
1300 (nreverse new-args)))
1301
1302;; There's no guarantee that Emacs will hand the filter the entire
1303;; marker at once; it could be broken up across several strings. We
1304;; might even receive a big chunk with several markers in it. If we
1305;; receive a chunk of text which looks like it might contain the
1306;; beginning of a marker, we save it here between calls to the
1307;; filter.
1308(defun gud-perldb-marker-filter (string)
1309 (setq gud-marker-acc (concat gud-marker-acc string))
1310 (let ((output ""))
1311
1312 ;; Process all the complete markers in this chunk.
1313 (while (string-match "\032\032\\(\\([a-zA-Z]:\\)?[^:\n]*\\):\\([0-9]*\\):.*\n"
1314 gud-marker-acc)
1315 (setq
1316
1317 ;; Extract the frame position from the marker.
1318 gud-last-frame
1319 (cons (match-string 1 gud-marker-acc)
0d2794e3 1320 (string-to-number (match-string 3 gud-marker-acc)))
0f9c2d46
JB
1321
1322 ;; Append any text before the marker to the output we're going
1323 ;; to return - we don't include the marker in this text.
1324 output (concat output
1325 (substring gud-marker-acc 0 (match-beginning 0)))
1326
1327 ;; Set the accumulator to the remaining text.
1328 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1329
1330 ;; Does the remaining text look like it might end with the
1331 ;; beginning of another marker? If it does, then keep it in
1332 ;; gud-marker-acc until we receive the rest of it. Since we
1333 ;; know the full marker regexp above failed, it's pretty simple to
1334 ;; test for marker starts.
1335 (if (string-match "\032.*\\'" gud-marker-acc)
1336 (progn
1337 ;; Everything before the potential marker start can be output.
1338 (setq output (concat output (substring gud-marker-acc
1339 0 (match-beginning 0))))
1340
1341 ;; Everything after, we save, to combine with later input.
1342 (setq gud-marker-acc
1343 (substring gud-marker-acc (match-beginning 0))))
1344
1345 (setq output (concat output gud-marker-acc)
1346 gud-marker-acc ""))
1347
1348 output))
1349
1350(defcustom gud-perldb-command-name "perl -d"
1351 "Default command to execute a Perl script under debugger."
1352 :type 'string
1353 :group 'gud)
1354
1355;;;###autoload
1356(defun perldb (command-line)
1357 "Run perldb on program FILE in buffer *gud-FILE*.
1358The directory containing FILE becomes the initial working directory
1359and source-file directory for your debugger."
1360 (interactive
1361 (list (gud-query-cmdline 'perldb
1362 (concat (or (buffer-file-name) "-e 0") " "))))
1363
1364 (gud-common-init command-line 'gud-perldb-massage-args
1365 'gud-perldb-marker-filter)
1366 (set (make-local-variable 'gud-minor-mode) 'perldb)
1367
1368 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
1dd52b82 1369 (gud-def gud-remove "B %l" "\C-d" "Remove breakpoint at current line")
0f9c2d46
JB
1370 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
1371 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
1372 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1373; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
1374; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
1375; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
8a7bc7b8 1376 (gud-def gud-print "p %e" "\C-p" "Evaluate perl expression at point.")
1dd52b82
NR
1377 (gud-def gud-until "c %l" "\C-u" "Continue to current line.")
1378
0f9c2d46
JB
1379
1380 (setq comint-prompt-regexp "^ DB<+[0-9]+>+ ")
1381 (setq paragraph-start comint-prompt-regexp)
1382 (run-hooks 'perldb-mode-hook))
1383\f
1384;; ======================================================================
1385;; pdb (Python debugger) functions
1386
1387;; History of argument lists passed to pdb.
1388(defvar gud-pdb-history nil)
1389
1390;; Last group is for return value, e.g. "> test.py(2)foo()->None"
1391;; Either file or function name may be omitted: "> <string>(0)?()"
1392(defvar gud-pdb-marker-regexp
1393 "^> \\([-a-zA-Z0-9_/.:\\]*\\|<string>\\)(\\([0-9]+\\))\\([a-zA-Z0-9_]*\\|\\?\\)()\\(->[^\n]*\\)?\n")
1394(defvar gud-pdb-marker-regexp-file-group 1)
1395(defvar gud-pdb-marker-regexp-line-group 2)
1396(defvar gud-pdb-marker-regexp-fnname-group 3)
1397
1398(defvar gud-pdb-marker-regexp-start "^> ")
1399
1400;; There's no guarantee that Emacs will hand the filter the entire
1401;; marker at once; it could be broken up across several strings. We
1402;; might even receive a big chunk with several markers in it. If we
1403;; receive a chunk of text which looks like it might contain the
1404;; beginning of a marker, we save it here between calls to the
1405;; filter.
1406(defun gud-pdb-marker-filter (string)
1407 (setq gud-marker-acc (concat gud-marker-acc string))
1408 (let ((output ""))
1409
1410 ;; Process all the complete markers in this chunk.
1411 (while (string-match gud-pdb-marker-regexp gud-marker-acc)
1412 (setq
1413
1414 ;; Extract the frame position from the marker.
1415 gud-last-frame
1416 (let ((file (match-string gud-pdb-marker-regexp-file-group
1417 gud-marker-acc))
0d2794e3 1418 (line (string-to-number
0f9c2d46
JB
1419 (match-string gud-pdb-marker-regexp-line-group
1420 gud-marker-acc))))
1421 (if (string-equal file "<string>")
1422 gud-last-frame
1423 (cons file line)))
1424
1425 ;; Output everything instead of the below
1426 output (concat output (substring gud-marker-acc 0 (match-end 0)))
1427;; ;; Append any text before the marker to the output we're going
1428;; ;; to return - we don't include the marker in this text.
1429;; output (concat output
1430;; (substring gud-marker-acc 0 (match-beginning 0)))
1431
1432 ;; Set the accumulator to the remaining text.
1433 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1434
1435 ;; Does the remaining text look like it might end with the
1436 ;; beginning of another marker? If it does, then keep it in
1437 ;; gud-marker-acc until we receive the rest of it. Since we
1438 ;; know the full marker regexp above failed, it's pretty simple to
1439 ;; test for marker starts.
1440 (if (string-match gud-pdb-marker-regexp-start gud-marker-acc)
1441 (progn
1442 ;; Everything before the potential marker start can be output.
1443 (setq output (concat output (substring gud-marker-acc
1444 0 (match-beginning 0))))
1445
1446 ;; Everything after, we save, to combine with later input.
1447 (setq gud-marker-acc
1448 (substring gud-marker-acc (match-beginning 0))))
1449
1450 (setq output (concat output gud-marker-acc)
1451 gud-marker-acc ""))
1452
1453 output))
1454
6f120f70 1455(defcustom gud-pdb-command-name "pdb"
0f9c2d46
JB
1456 "File name for executing the Python debugger.
1457This should be an executable on your path, or an absolute file name."
1458 :type 'string
1459 :group 'gud)
1460
1461;;;###autoload
1462(defun pdb (command-line)
1463 "Run pdb on program FILE in buffer `*gud-FILE*'.
1464The directory containing FILE becomes the initial working directory
1465and source-file directory for your debugger."
1466 (interactive
1467 (list (gud-query-cmdline 'pdb)))
1468
1469 (gud-common-init command-line nil 'gud-pdb-marker-filter)
1470 (set (make-local-variable 'gud-minor-mode) 'pdb)
1471
1472 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
1473 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
1474 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
1475 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
1476 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
1477 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1478 (gud-def gud-up "up" "<" "Up one stack frame.")
1479 (gud-def gud-down "down" ">" "Down one stack frame.")
1480 (gud-def gud-print "p %e" "\C-p" "Evaluate Python expression at point.")
1481 ;; Is this right?
1482 (gud-def gud-statement "! %e" "\C-e" "Execute Python statement at point.")
1483
1484 ;; (setq comint-prompt-regexp "^(.*pdb[+]?) *")
1485 (setq comint-prompt-regexp "^(Pdb) *")
1486 (setq paragraph-start comint-prompt-regexp)
1487 (run-hooks 'pdb-mode-hook))
1488\f
1489;; ======================================================================
1490;;
1491;; JDB support.
1492;;
1493;; AUTHOR: Derek Davies <ddavies@world.std.com>
1494;; Zoltan Kemenczy <zoltan@ieee.org;zkemenczy@rim.net>
1495;;
1496;; CREATED: Sun Feb 22 10:46:38 1998 Derek Davies.
1497;; UPDATED: Nov 11, 2001 Zoltan Kemenczy
1498;; Dec 10, 2002 Zoltan Kemenczy - added nested class support
1499;;
1500;; INVOCATION NOTES:
1501;;
1502;; You invoke jdb-mode with:
1503;;
1504;; M-x jdb <enter>
1505;;
1506;; It responds with:
1507;;
1508;; Run jdb (like this): jdb
1509;;
1510;; type any jdb switches followed by the name of the class you'd like to debug.
1511;; Supply a fully qualfied classname (these do not have the ".class" extension)
1512;; for the name of the class to debug (e.g. "COM.the-kind.ddavies.CoolClass").
1513;; See the known problems section below for restrictions when specifying jdb
1514;; command line switches (search forward for '-classpath').
1515;;
1516;; You should see something like the following:
1517;;
1518;; Current directory is ~/src/java/hello/
1519;; Initializing jdb...
1520;; 0xed2f6628:class(hello)
1521;; >
1522;;
1523;; To set an initial breakpoint try:
1524;;
1525;; > stop in hello.main
1526;; Breakpoint set in hello.main
1527;; >
1528;;
1529;; To execute the program type:
1530;;
1531;; > run
1532;; run hello
1533;;
1534;; Breakpoint hit: running ...
1535;; hello.main (hello:12)
1536;;
1537;; Type M-n to step over the current line and M-s to step into it. That,
1538;; along with the JDB 'help' command should get you started. The 'quit'
1539;; JDB command will get out out of the debugger. There is some truly
1540;; pathetic JDB documentation available at:
1541;;
1542;; http://java.sun.com/products/jdk/1.1/debugging/
1543;;
1544;; KNOWN PROBLEMS AND FIXME's:
1545;;
1546;; Not sure what happens with inner classes ... haven't tried them.
1547;;
1548;; Does not grok UNICODE id's. Only ASCII id's are supported.
1549;;
1550;; You must not put whitespace between "-classpath" and the path to
1551;; search for java classes even though it is required when invoking jdb
1552;; from the command line. See gud-jdb-massage-args for details.
1553;; The same applies for "-sourcepath".
1554;;
1555;; Note: The following applies only if `gud-jdb-use-classpath' is nil;
1556;; refer to the documentation of `gud-jdb-use-classpath' and
1557;; `gud-jdb-classpath',`gud-jdb-sourcepath' variables for information
1558;; on using the classpath for locating java source files.
1559;;
1560;; If any of the source files in the directories listed in
1561;; gud-jdb-directories won't parse you'll have problems. Make sure
1562;; every file ending in ".java" in these directories parses without error.
1563;;
1564;; All the .java files in the directories in gud-jdb-directories are
1565;; syntactically analyzed each time gud jdb is invoked. It would be
1566;; nice to keep as much information as possible between runs. It would
1567;; be really nice to analyze the files only as neccessary (when the
1568;; source needs to be displayed.) I'm not sure to what extent the former
1569;; can be accomplished and I'm not sure the latter can be done at all
1570;; since I don't know of any general way to tell which .class files are
1571;; defined by which .java file without analyzing all the .java files.
1572;; If anyone knows why JavaSoft didn't put the source file names in
1573;; debuggable .class files please clue me in so I find something else
1574;; to be spiteful and bitter about.
1575;;
1576;; ======================================================================
1577;; gud jdb variables and functions
1578
1579(defcustom gud-jdb-command-name "jdb"
1580 "Command that executes the Java debugger."
1581 :type 'string
1582 :group 'gud)
1583
1584(defcustom gud-jdb-use-classpath t
1585 "If non-nil, search for Java source files in classpath directories.
1586The list of directories to search is the value of `gud-jdb-classpath'.
1587The file pathname is obtained by converting the fully qualified
1588class information output by jdb to a relative pathname and appending
1589it to `gud-jdb-classpath' element by element until a match is found.
1590
1591This method has a significant jdb startup time reduction advantage
1592since it does not require the scanning of all `gud-jdb-directories'
1593and parsing all Java files for class information.
1594
1595Set to nil to use `gud-jdb-directories' to scan java sources for
1596class information on jdb startup (original method)."
1597 :type 'boolean
1598 :group 'gud)
1599
1600(defvar gud-jdb-classpath nil
1601 "Java/jdb classpath directories list.
1602If `gud-jdb-use-classpath' is non-nil, gud-jdb derives the `gud-jdb-classpath'
1603list automatically using the following methods in sequence
1604\(with subsequent successful steps overriding the results of previous
1605steps):
1606
16071) Read the CLASSPATH environment variable,
16082) Read any \"-classpath\" argument used to run jdb,
1609 or detected in jdb output (e.g. if jdb is run by a script
1610 that echoes the actual jdb command before starting jdb)
16113) Send a \"classpath\" command to jdb and scan jdb output for
1612 classpath information if jdb is invoked with an \"-attach\" (to
1613 an already running VM) argument (This case typically does not
1614 have a \"-classpath\" command line argument - that is provided
1615 to the VM when it is started).
1616
1617Note that method 3 cannot be used with oldjdb (or Java 1 jdb) since
1618those debuggers do not support the classpath command. Use 1) or 2).")
1619
1620(defvar gud-jdb-sourcepath nil
1621 "Directory list provided by an (optional) \"-sourcepath\" option to jdb.
1622This list is prepended to `gud-jdb-classpath' to form the complete
1623list of directories searched for source files.")
1624
1625(defvar gud-marker-acc-max-length 4000
1626 "Maximum number of debugger output characters to keep.
1627This variable limits the size of `gud-marker-acc' which holds
1628the most recent debugger output history while searching for
1629source file information.")
1630
1631(defvar gud-jdb-history nil
1632"History of argument lists passed to jdb.")
1633
1634
1635;; List of Java source file directories.
1636(defvar gud-jdb-directories (list ".")
1637 "*A list of directories that gud jdb should search for source code.
1638The file names should be absolute, or relative to the current
1639directory.
1640
1641The set of .java files residing in the directories listed are
1642syntactically analyzed to determine the classes they define and the
1643packages in which these classes belong. In this way gud jdb maps the
1644package-qualified class names output by the jdb debugger to the source
1645file from which the class originated. This allows gud mode to keep
1646the source code display in sync with the debugging session.")
1647
1648(defvar gud-jdb-source-files nil
1649"List of the java source files for this debugging session.")
1650
1651;; Association list of fully qualified class names (package + class name)
1652;; and their source files.
1653(defvar gud-jdb-class-source-alist nil
1654"Association list of fully qualified class names and source files.")
1655
1656;; This is used to hold a source file during analysis.
1657(defvar gud-jdb-analysis-buffer nil)
1658
1659(defvar gud-jdb-classpath-string nil
1660"Holds temporary classpath values.")
1661
1662(defun gud-jdb-build-source-files-list (path extn)
1663"Return a list of java source files (absolute paths).
1664PATH gives the directories in which to search for files with
1665extension EXTN. Normally EXTN is given as the regular expression
1666 \"\\.java$\" ."
1667 (apply 'nconc (mapcar (lambda (d)
1668 (when (file-directory-p d)
1669 (directory-files d t extn nil)))
1670 path)))
1671
1672;; Move point past whitespace.
1673(defun gud-jdb-skip-whitespace ()
1674 (skip-chars-forward " \n\r\t\014"))
1675
1676;; Move point past a "// <eol>" type of comment.
1677(defun gud-jdb-skip-single-line-comment ()
1678 (end-of-line))
1679
1680;; Move point past a "/* */" or "/** */" type of comment.
1681(defun gud-jdb-skip-traditional-or-documentation-comment ()
1682 (forward-char 2)
1683 (catch 'break
1684 (while (not (eobp))
1685 (if (eq (following-char) ?*)
1686 (progn
1687 (forward-char)
1688 (if (not (eobp))
1689 (if (eq (following-char) ?/)
1690 (progn
1691 (forward-char)
1692 (throw 'break nil)))))
1693 (forward-char)))))
1694
1695;; Move point past any number of consecutive whitespace chars and/or comments.
1696(defun gud-jdb-skip-whitespace-and-comments ()
1697 (gud-jdb-skip-whitespace)
1698 (catch 'done
1699 (while t
1700 (cond
1701 ((looking-at "//")
1702 (gud-jdb-skip-single-line-comment)
1703 (gud-jdb-skip-whitespace))
1704 ((looking-at "/\\*")
1705 (gud-jdb-skip-traditional-or-documentation-comment)
1706 (gud-jdb-skip-whitespace))
1707 (t (throw 'done nil))))))
1708
1709;; Move point past things that are id-like. The intent is to skip regular
1710;; id's, such as class or interface names as well as package and interface
1711;; names.
1712(defun gud-jdb-skip-id-ish-thing ()
1713 (skip-chars-forward "^ /\n\r\t\014,;{"))
1714
1715;; Move point past a string literal.
1716(defun gud-jdb-skip-string-literal ()
1717 (forward-char)
1718 (while (not (cond
1719 ((eq (following-char) ?\\)
1720 (forward-char))
1721 ((eq (following-char) ?\042))))
1722 (forward-char))
1723 (forward-char))
1724
1725;; Move point past a character literal.
1726(defun gud-jdb-skip-character-literal ()
1727 (forward-char)
1728 (while
1729 (progn
1730 (if (eq (following-char) ?\\)
1731 (forward-char 2))
1732 (not (eq (following-char) ?\')))
1733 (forward-char))
1734 (forward-char))
1735
1736;; Move point past the following block. There may be (legal) cruft before
1737;; the block's opening brace. There must be a block or it's the end of life
1738;; in petticoat junction.
1739(defun gud-jdb-skip-block ()
1740
1741 ;; Find the begining of the block.
1742 (while
1743 (not (eq (following-char) ?{))
1744
1745 ;; Skip any constructs that can harbor literal block delimiter
1746 ;; characters and/or the delimiters for the constructs themselves.
1747 (cond
1748 ((looking-at "//")
1749 (gud-jdb-skip-single-line-comment))
1750 ((looking-at "/\\*")
1751 (gud-jdb-skip-traditional-or-documentation-comment))
1752 ((eq (following-char) ?\042)
1753 (gud-jdb-skip-string-literal))
1754 ((eq (following-char) ?\')
1755 (gud-jdb-skip-character-literal))
1756 (t (forward-char))))
1757
1758 ;; Now at the begining of the block.
1759 (forward-char)
1760
1761 ;; Skip over the body of the block as well as the final brace.
1762 (let ((open-level 1))
1763 (while (not (eq open-level 0))
1764 (cond
1765 ((looking-at "//")
1766 (gud-jdb-skip-single-line-comment))
1767 ((looking-at "/\\*")
1768 (gud-jdb-skip-traditional-or-documentation-comment))
1769 ((eq (following-char) ?\042)
1770 (gud-jdb-skip-string-literal))
1771 ((eq (following-char) ?\')
1772 (gud-jdb-skip-character-literal))
1773 ((eq (following-char) ?{)
1774 (setq open-level (+ open-level 1))
1775 (forward-char))
1776 ((eq (following-char) ?})
1777 (setq open-level (- open-level 1))
1778 (forward-char))
1779 (t (forward-char))))))
1780
1781;; Find the package and class definitions in Java source file FILE. Assumes
1782;; that FILE contains a legal Java program. BUF is a scratch buffer used
1783;; to hold the source during analysis.
1784(defun gud-jdb-analyze-source (buf file)
1785 (let ((l nil))
1786 (set-buffer buf)
1787 (insert-file-contents file nil nil nil t)
1788 (goto-char 0)
1789 (catch 'abort
1790 (let ((p ""))
1791 (while (progn
1792 (gud-jdb-skip-whitespace)
1793 (not (eobp)))
1794 (cond
1795
1796 ;; Any number of semi's following a block is legal. Move point
1797 ;; past them. Note that comments and whitespace may be
1798 ;; interspersed as well.
1799 ((eq (following-char) ?\073)
1800 (forward-char))
1801
1802 ;; Move point past a single line comment.
1803 ((looking-at "//")
1804 (gud-jdb-skip-single-line-comment))
1805
1806 ;; Move point past a traditional or documentation comment.
1807 ((looking-at "/\\*")
1808 (gud-jdb-skip-traditional-or-documentation-comment))
1809
1810 ;; Move point past a package statement, but save the PackageName.
1811 ((looking-at "package")
1812 (forward-char 7)
1813 (gud-jdb-skip-whitespace-and-comments)
1814 (let ((s (point)))
1815 (gud-jdb-skip-id-ish-thing)
1816 (setq p (concat (buffer-substring s (point)) "."))
1817 (gud-jdb-skip-whitespace-and-comments)
1818 (if (eq (following-char) ?\073)
1819 (forward-char))))
1820
1821 ;; Move point past an import statement.
1822 ((looking-at "import")
1823 (forward-char 6)
1824 (gud-jdb-skip-whitespace-and-comments)
1825 (gud-jdb-skip-id-ish-thing)
1826 (gud-jdb-skip-whitespace-and-comments)
1827 (if (eq (following-char) ?\073)
1828 (forward-char)))
1829
1830 ;; Move point past the various kinds of ClassModifiers.
1831 ((looking-at "public")
1832 (forward-char 6))
1833 ((looking-at "abstract")
1834 (forward-char 8))
1835 ((looking-at "final")
1836 (forward-char 5))
1837
1838 ;; Move point past a ClassDeclaraction, but save the class
1839 ;; Identifier.
1840 ((looking-at "class")
1841 (forward-char 5)
1842 (gud-jdb-skip-whitespace-and-comments)
1843 (let ((s (point)))
1844 (gud-jdb-skip-id-ish-thing)
1845 (setq
1846 l (nconc l (list (concat p (buffer-substring s (point)))))))
1847 (gud-jdb-skip-block))
1848
1849 ;; Move point past an interface statement.
1850 ((looking-at "interface")
1851 (forward-char 9)
1852 (gud-jdb-skip-block))
1853
1854 ;; Anything else means the input is invalid.
1855 (t
1856 (message (format "Error parsing file %s." file))
1857 (throw 'abort nil))))))
1858 l))
1859
1860(defun gud-jdb-build-class-source-alist-for-file (file)
1861 (mapcar
1862 (lambda (c)
1863 (cons c file))
1864 (gud-jdb-analyze-source gud-jdb-analysis-buffer file)))
1865
1866;; Return an alist of fully qualified classes and the source files
1867;; holding their definitions. SOURCES holds a list of all the source
1868;; files to examine.
1869(defun gud-jdb-build-class-source-alist (sources)
1870 (setq gud-jdb-analysis-buffer (get-buffer-create " *gud-jdb-scratch*"))
1871 (prog1
1872 (apply
1873 'nconc
1874 (mapcar
1875 'gud-jdb-build-class-source-alist-for-file
1876 sources))
1877 (kill-buffer gud-jdb-analysis-buffer)
1878 (setq gud-jdb-analysis-buffer nil)))
1879
1880;; Change what was given in the minibuffer to something that can be used to
1881;; invoke the debugger.
1882(defun gud-jdb-massage-args (file args)
1883 ;; The jdb executable must have whitespace between "-classpath" and
1884 ;; its value while gud-common-init expects all switch values to
1885 ;; follow the switch keyword without intervening whitespace. We
1886 ;; require that when the user enters the "-classpath" switch in the
1887 ;; EMACS minibuffer that they do so without the intervening
1888 ;; whitespace. This function adds it back (it's called after
1889 ;; gud-common-init). There are more switches like this (for
1890 ;; instance "-host" and "-password") but I don't care about them
1891 ;; yet.
1892 (if args
1893 (let (massaged-args user-error)
1894
1895 (while (and args (not user-error))
1896 (cond
1897 ((setq user-error (string-match "-classpath$" (car args))))
1898 ((setq user-error (string-match "-sourcepath$" (car args))))
1899 ((string-match "-classpath\\(.+\\)" (car args))
1900 (setq massaged-args
1901 (append massaged-args
1902 (list "-classpath"
1903 (setq gud-jdb-classpath-string
1904 (match-string 1 (car args)))))))
1905 ((string-match "-sourcepath\\(.+\\)" (car args))
1906 (setq massaged-args
1907 (append massaged-args
1908 (list "-sourcepath"
1909 (setq gud-jdb-sourcepath
1910 (match-string 1 (car args)))))))
1911 (t (setq massaged-args (append massaged-args (list (car args))))))
1912 (setq args (cdr args)))
1913
1914 ;; By this point the current directory is all screwed up. Maybe we
1915 ;; could fix things and re-invoke gud-common-init, but for now I think
1916 ;; issueing the error is good enough.
1917 (if user-error
1918 (progn
1919 (kill-buffer (current-buffer))
1920 (error "Error: Omit whitespace between '-classpath or -sourcepath' and its value")))
1921 massaged-args)))
1922
1923;; Search for an association with P, a fully qualified class name, in
1924;; gud-jdb-class-source-alist. The asssociation gives the fully
1925;; qualified file name of the source file which produced the class.
1926(defun gud-jdb-find-source-file (p)
1927 (cdr (assoc p gud-jdb-class-source-alist)))
1928
1929;; Note: Reset to this value every time a prompt is seen
1930(defvar gud-jdb-lowest-stack-level 999)
1931
1932(defun gud-jdb-find-source-using-classpath (p)
1933"Find source file corresponding to fully qualified class p.
1934Convert p from jdb's output, converted to a pathname
1935relative to a classpath directory."
1936 (save-match-data
1937 (let
1938 (;; Replace dots with slashes and append ".java" to generate file
1939 ;; name relative to classpath
1940 (filename
1941 (concat
1942 (mapconcat 'identity
1943 (split-string
1944 ;; Eliminate any subclass references in the class
1945 ;; name string. These start with a "$"
1946 ((lambda (x)
1947 (if (string-match "$.*" x)
1948 (replace-match "" t t x) p))
1949 p)
1950 "\\.") "/")
1951 ".java"))
1952 (cplist (append gud-jdb-sourcepath gud-jdb-classpath))
1953 found-file)
1954 (while (and cplist
1955 (not (setq found-file
1956 (file-readable-p
1957 (concat (car cplist) "/" filename)))))
1958 (setq cplist (cdr cplist)))
1959 (if found-file (concat (car cplist) "/" filename)))))
1960
1961(defun gud-jdb-find-source (string)
1962"Alias for function used to locate source files.
1963Set to `gud-jdb-find-source-using-classpath' or `gud-jdb-find-source-file'
1964during jdb initialization depending on the value of
1965`gud-jdb-use-classpath'."
1966nil)
1967
1968(defun gud-jdb-parse-classpath-string (string)
1969"Parse the classpath list and convert each item to an absolute pathname."
1970 (mapcar (lambda (s) (if (string-match "[/\\]$" s)
1971 (replace-match "" nil nil s) s))
1972 (mapcar 'file-truename
1973 (split-string
1974 string
1975 (concat "[ \t\n\r,\"" path-separator "]+")))))
1976
1977;; See comentary for other debugger's marker filters - there you will find
1978;; important notes about STRING.
1979(defun gud-jdb-marker-filter (string)
1980
1981 ;; Build up the accumulator.
1982 (setq gud-marker-acc
1983 (if gud-marker-acc
1984 (concat gud-marker-acc string)
1985 string))
1986
1987 ;; Look for classpath information until gud-jdb-classpath-string is found
1988 ;; (interactive, multiple settings of classpath from jdb
1989 ;; not supported/followed)
1990 (if (and gud-jdb-use-classpath
1991 (not gud-jdb-classpath-string)
1992 (or (string-match "classpath:[ \t[]+\\([^]]+\\)" gud-marker-acc)
1993 (string-match "-classpath[ \t\"]+\\([^ \"]+\\)" gud-marker-acc)))
1994 (setq gud-jdb-classpath
1995 (gud-jdb-parse-classpath-string
1996 (setq gud-jdb-classpath-string
1997 (match-string 1 gud-marker-acc)))))
1998
1999 ;; We process STRING from left to right. Each time through the
2000 ;; following loop we process at most one marker. After we've found a
2001 ;; marker, delete gud-marker-acc up to and including the match
2002 (let (file-found)
2003 ;; Process each complete marker in the input.
2004 (while
2005
2006 ;; Do we see a marker?
2007 (string-match
2008 ;; jdb puts out a string of the following form when it
2009 ;; hits a breakpoint:
2010 ;;
2011 ;; <fully-qualified-class><method> (<class>:<line-number>)
2012 ;;
2013 ;; <fully-qualified-class>'s are composed of Java ID's
2014 ;; separated by periods. <method> and <class> are
2015 ;; also Java ID's. <method> begins with a period and
2016 ;; may contain less-than and greater-than (constructors,
2017 ;; for instance, are called <init> in the symbol table.)
2018 ;; Java ID's begin with a letter followed by letters
2019 ;; and/or digits. The set of letters includes underscore
2020 ;; and dollar sign.
2021 ;;
2022 ;; The first group matches <fully-qualified-class>,
2023 ;; the second group matches <class> and the third group
2024 ;; matches <line-number>. We don't care about using
2025 ;; <method> so we don't "group" it.
2026 ;;
2027 ;; FIXME: Java ID's are UNICODE strings, this matches ASCII
2028 ;; ID's only.
2029 ;;
a0c3f8bc
NR
2030 ;; The ".," in the last square-bracket are necessary because
2031 ;; of Sun's total disrespect for backwards compatibility in
0f9c2d46 2032 ;; reported line numbers from jdb - starting in 1.4.0 they
a0c3f8bc
NR
2033 ;; print line numbers using LOCALE, inserting a comma or a
2034 ;; period at the thousands positions (how ingenious!).
0f9c2d46
JB
2035
2036 "\\(\[[0-9]+\] \\)*\\([a-zA-Z0-9.$_]+\\)\\.[a-zA-Z0-9$_<>(),]+ \
a0c3f8bc 2037\\(([a-zA-Z0-9.$_]+:\\|line=\\)\\([0-9.,]+\\)"
0f9c2d46
JB
2038 gud-marker-acc)
2039
2040 ;; A good marker is one that:
2041 ;; 1) does not have a "[n] " prefix (not part of a stack backtrace)
2042 ;; 2) does have an "[n] " prefix and n is the lowest prefix seen
2043 ;; since the last prompt
2044 ;; Figure out the line on which to position the debugging arrow.
2045 ;; Return the info as a cons of the form:
2046 ;;
2047 ;; (<file-name> . <line-number>) .
2048 (if (if (match-beginning 1)
2049 (let (n)
0d2794e3 2050 (setq n (string-to-number (substring
0f9c2d46
JB
2051 gud-marker-acc
2052 (1+ (match-beginning 1))
2053 (- (match-end 1) 2))))
2054 (if (< n gud-jdb-lowest-stack-level)
2055 (progn (setq gud-jdb-lowest-stack-level n) t)))
2056 t)
2057 (if (setq file-found
2058 (gud-jdb-find-source (match-string 2 gud-marker-acc)))
2059 (setq gud-last-frame
2060 (cons file-found
0d2794e3 2061 (string-to-number
0f9c2d46
JB
2062 (let
2063 ((numstr (match-string 4 gud-marker-acc)))
a0c3f8bc 2064 (if (string-match "[.,]" numstr)
0f9c2d46
JB
2065 (replace-match "" nil nil numstr)
2066 numstr)))))
2067 (message "Could not find source file.")))
2068
2069 ;; Set the accumulator to the remaining text.
2070 (setq gud-marker-acc (substring gud-marker-acc (match-end 0))))
2071
2072 (if (string-match comint-prompt-regexp gud-marker-acc)
2073 (setq gud-jdb-lowest-stack-level 999)))
2074
2075 ;; Do not allow gud-marker-acc to grow without bound. If the source
2076 ;; file information is not within the last 3/4
2077 ;; gud-marker-acc-max-length characters, well,...
2078 (if (> (length gud-marker-acc) gud-marker-acc-max-length)
2079 (setq gud-marker-acc
2080 (substring gud-marker-acc
2081 (- (/ (* gud-marker-acc-max-length 3) 4)))))
2082
2083 ;; We don't filter any debugger output so just return what we were given.
2084 string)
2085
2086(defvar gud-jdb-command-name "jdb" "Command that executes the Java debugger.")
2087
2088;;;###autoload
2089(defun jdb (command-line)
2090 "Run jdb with command line COMMAND-LINE in a buffer.
2091The buffer is named \"*gud*\" if no initial class is given or
2092\"*gud-<initial-class-basename>*\" if there is. If the \"-classpath\"
2093switch is given, omit all whitespace between it and its value.
2094
2095See `gud-jdb-use-classpath' and `gud-jdb-classpath' documentation for
2096information on how jdb accesses source files. Alternatively (if
2097`gud-jdb-use-classpath' is nil), see `gud-jdb-directories' for the
2098original source file access method.
2099
2100For general information about commands available to control jdb from
2101gud, see `gud-mode'."
2102 (interactive
2103 (list (gud-query-cmdline 'jdb)))
2104 (setq gud-jdb-classpath nil)
2105 (setq gud-jdb-sourcepath nil)
2106
2107 ;; Set gud-jdb-classpath from the CLASSPATH environment variable,
2108 ;; if CLASSPATH is set.
2109 (setq gud-jdb-classpath-string (getenv "CLASSPATH"))
2110 (if gud-jdb-classpath-string
2111 (setq gud-jdb-classpath
2112 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2113 (setq gud-jdb-classpath-string nil) ; prepare for next
2114
2115 (gud-common-init command-line 'gud-jdb-massage-args
2116 'gud-jdb-marker-filter)
2117 (set (make-local-variable 'gud-minor-mode) 'jdb)
2118
2119 ;; If a -classpath option was provided, set gud-jdb-classpath
2120 (if gud-jdb-classpath-string
2121 (setq gud-jdb-classpath
2122 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2123 (setq gud-jdb-classpath-string nil) ; prepare for next
2124 ;; If a -sourcepath option was provided, parse it
2125 (if gud-jdb-sourcepath
2126 (setq gud-jdb-sourcepath
2127 (gud-jdb-parse-classpath-string gud-jdb-sourcepath)))
2128
2129 (gud-def gud-break "stop at %c:%l" "\C-b" "Set breakpoint at current line.")
2130 (gud-def gud-remove "clear %c:%l" "\C-d" "Remove breakpoint at current line")
2131 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2132 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2133 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
2134 (gud-def gud-finish "step up" "\C-f" "Continue until current method returns.")
2135 (gud-def gud-up "up\C-Mwhere" "<" "Up one stack frame.")
2136 (gud-def gud-down "down\C-Mwhere" ">" "Up one stack frame.")
2137 (gud-def gud-run "run" nil "Run the program.") ;if VM start using jdb
2138
2139 (setq comint-prompt-regexp "^> \\|^[^ ]+\\[[0-9]+\\] ")
2140 (setq paragraph-start comint-prompt-regexp)
2141 (run-hooks 'jdb-mode-hook)
2142
2143 (if gud-jdb-use-classpath
2144 ;; Get the classpath information from the debugger
2145 (progn
2146 (if (string-match "-attach" command-line)
2147 (gud-call "classpath"))
2148 (fset 'gud-jdb-find-source
2149 'gud-jdb-find-source-using-classpath))
2150
2151 ;; Else create and bind the class/source association list as well
2152 ;; as the source file list.
2153 (setq gud-jdb-class-source-alist
2154 (gud-jdb-build-class-source-alist
2155 (setq gud-jdb-source-files
2156 (gud-jdb-build-source-files-list gud-jdb-directories
2157 "\\.java$"))))
2158 (fset 'gud-jdb-find-source 'gud-jdb-find-source-file)))
2159\f
2160
2161;; ======================================================================
2162;;
2163;; BASHDB support. See http://bashdb.sourceforge.net
2164;;
2165;; AUTHOR: Rocky Bernstein <rocky@panix.com>
2166;;
2167;; CREATED: Sun Nov 10 10:46:38 2002 Rocky Bernstein.
2168;;
2169;; INVOCATION NOTES:
2170;;
2171;; You invoke bashdb-mode with:
2172;;
2173;; M-x bashdb <enter>
2174;;
2175;; It responds with:
2176;;
2177;; Run bashdb (like this): bash
2178;;
2179
2180;; History of argument lists passed to bashdb.
2181(defvar gud-bashdb-history nil)
2182
2183;; Convert a command line as would be typed normally to run a script
2184;; into one that invokes an Emacs-enabled debugging session.
2185;; "--debugger" in inserted as the first switch.
2186
2187;; There's no guarantee that Emacs will hand the filter the entire
2188;; marker at once; it could be broken up across several strings. We
2189;; might even receive a big chunk with several markers in it. If we
2190;; receive a chunk of text which looks like it might contain the
2191;; beginning of a marker, we save it here between calls to the
2192;; filter.
2193(defun gud-bashdb-marker-filter (string)
2194 (setq gud-marker-acc (concat gud-marker-acc string))
2195 (let ((output ""))
2196
2197 ;; Process all the complete markers in this chunk.
2198 ;; Format of line looks like this:
2199 ;; (/etc/init.d/ntp.init:16):
2200 ;; but we also allow DOS drive letters
2201 ;; (d:/etc/init.d/ntp.init:16):
2202 (while (string-match "\\(^\\|\n\\)(\\(\\([a-zA-Z]:\\)?[^:\n]*\\):\\([0-9]*\\)):.*\n"
2203 gud-marker-acc)
2204 (setq
2205
2206 ;; Extract the frame position from the marker.
2207 gud-last-frame
2208 (cons (match-string 2 gud-marker-acc)
0d2794e3 2209 (string-to-number (match-string 4 gud-marker-acc)))
0f9c2d46
JB
2210
2211 ;; Append any text before the marker to the output we're going
2212 ;; to return - we don't include the marker in this text.
2213 output (concat output
2214 (substring gud-marker-acc 0 (match-beginning 0)))
2215
2216 ;; Set the accumulator to the remaining text.
2217 gud-marker-acc (substring gud-marker-acc (match-end 0))))
2218
2219 ;; Does the remaining text look like it might end with the
2220 ;; beginning of another marker? If it does, then keep it in
2221 ;; gud-marker-acc until we receive the rest of it. Since we
2222 ;; know the full marker regexp above failed, it's pretty simple to
2223 ;; test for marker starts.
2224 (if (string-match "\032.*\\'" gud-marker-acc)
2225 (progn
2226 ;; Everything before the potential marker start can be output.
2227 (setq output (concat output (substring gud-marker-acc
2228 0 (match-beginning 0))))
2229
2230 ;; Everything after, we save, to combine with later input.
2231 (setq gud-marker-acc
2232 (substring gud-marker-acc (match-beginning 0))))
2233
2234 (setq output (concat output gud-marker-acc)
2235 gud-marker-acc ""))
2236
2237 output))
2238
2239(defcustom gud-bashdb-command-name "bash --debugger"
2240 "File name for executing bash debugger."
2241 :type 'string
2242 :group 'gud)
2243
2244;;;###autoload
2245(defun bashdb (command-line)
2246 "Run bashdb on program FILE in buffer *gud-FILE*.
2247The directory containing FILE becomes the initial working directory
2248and source-file directory for your debugger."
2249 (interactive
2250 (list (read-from-minibuffer "Run bashdb (like this): "
2251 (if (consp gud-bashdb-history)
2252 (car gud-bashdb-history)
2253 (concat gud-bashdb-command-name
2254 " "))
2255 gud-minibuffer-local-map nil
2256 '(gud-bashdb-history . 1))))
2257
2258 (gud-common-init command-line nil 'gud-bashdb-marker-filter)
2259
2260 (set (make-local-variable 'gud-minor-mode) 'bashdb)
2261
2262 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
2263 (gud-def gud-tbreak "tbreak %l" "\C-t" "Set temporary breakpoint at current line.")
2264 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
2265 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2266 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2267 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
2268 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
2269 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
2270 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
2271 (gud-def gud-print "x %e" "\C-p" "Evaluate BASH expression at point.")
2272
2273 ;; Is this right?
2274 (gud-def gud-statement "eval %e" "\C-e" "Execute BASH statement at point.")
2275
2276 (setq comint-prompt-regexp "^bashdb<+(*[0-9]+)*>+ ")
2277 (setq paragraph-start comint-prompt-regexp)
2278 (run-hooks 'bashdb-mode-hook)
2279 )
2280
2281;;
2282;; End of debugger-specific information
2283;;
2284
2285\f
2286;; When we send a command to the debugger via gud-call, it's annoying
2287;; to see the command and the new prompt inserted into the debugger's
2288;; buffer; we have other ways of knowing the command has completed.
2289;;
2290;; If the buffer looks like this:
2291;; --------------------
2292;; (gdb) set args foo bar
2293;; (gdb) -!-
2294;; --------------------
2295;; (the -!- marks the location of point), and we type `C-x SPC' in a
2296;; source file to set a breakpoint, we want the buffer to end up like
2297;; this:
2298;; --------------------
2299;; (gdb) set args foo bar
2300;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
2301;; (gdb) -!-
2302;; --------------------
2303;; Essentially, the old prompt is deleted, and the command's output
2304;; and the new prompt take its place.
2305;;
2306;; Not echoing the command is easy enough; you send it directly using
2307;; process-send-string, and it never enters the buffer. However,
2308;; getting rid of the old prompt is trickier; you don't want to do it
2309;; when you send the command, since that will result in an annoying
2310;; flicker as the prompt is deleted, redisplay occurs while Emacs
2311;; waits for a response from the debugger, and the new prompt is
2312;; inserted. Instead, we'll wait until we actually get some output
2313;; from the subprocess before we delete the prompt. If the command
2314;; produced no output other than a new prompt, that prompt will most
2315;; likely be in the first chunk of output received, so we will delete
2316;; the prompt and then replace it with an identical one. If the
2317;; command produces output, the prompt is moving anyway, so the
2318;; flicker won't be annoying.
2319;;
2320;; So - when we want to delete the prompt upon receipt of the next
2321;; chunk of debugger output, we position gud-delete-prompt-marker at
2322;; the start of the prompt; the process filter will notice this, and
2323;; delete all text between it and the process output marker. If
2324;; gud-delete-prompt-marker points nowhere, we leave the current
2325;; prompt alone.
2326(defvar gud-delete-prompt-marker nil)
2327
2328\f
2329(put 'gud-mode 'mode-class 'special)
2330
2331(define-derived-mode gud-mode comint-mode "Debugger"
2332 "Major mode for interacting with an inferior debugger process.
2333
2334 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
2335M-x perldb, M-x xdb, or M-x jdb. Each entry point finishes by executing a
2336hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook',
2337`perldb-mode-hook', `xdb-mode-hook', or `jdb-mode-hook' respectively.
2338
2339After startup, the following commands are available in both the GUD
2340interaction buffer and any source buffer GUD visits due to a breakpoint stop
2341or step operation:
2342
2343\\[gud-break] sets a breakpoint at the current file and line. In the
2344GUD buffer, the current file and line are those of the last breakpoint or
2345step. In a source buffer, they are the buffer's file and current line.
2346
2347\\[gud-remove] removes breakpoints on the current file and line.
2348
2349\\[gud-refresh] displays in the source window the last line referred to
2350in the gud buffer.
2351
2352\\[gud-step], \\[gud-next], and \\[gud-stepi] do a step-one-line,
2353step-one-line (not entering function calls), and step-one-instruction
2354and then update the source window with the current file and position.
2355\\[gud-cont] continues execution.
2356
2357\\[gud-print] tries to find the largest C lvalue or function-call expression
2358around point, and sends it to the debugger for value display.
2359
2360The above commands are common to all supported debuggers except xdb which
2361does not support stepping instructions.
2362
2363Under gdb, sdb and xdb, \\[gud-tbreak] behaves exactly like \\[gud-break],
2364except that the breakpoint is temporary; that is, it is removed when
2365execution stops on it.
2366
2367Under gdb, dbx, and xdb, \\[gud-up] pops up through an enclosing stack
2368frame. \\[gud-down] drops back down through one.
2369
2370If you are using gdb or xdb, \\[gud-finish] runs execution to the return from
2371the current function and stops.
2372
2373All the keystrokes above are accessible in the GUD buffer
2374with the prefix C-c, and in all buffers through the prefix C-x C-a.
2375
2376All pre-defined functions for which the concept make sense repeat
2377themselves the appropriate number of times if you give a prefix
2378argument.
2379
2380You may use the `gud-def' macro in the initialization hook to define other
2381commands.
2382
2383Other commands for interacting with the debugger process are inherited from
2384comint mode, which see."
2385 (setq mode-line-process '(":%s"))
2386 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
2387 (set (make-local-variable 'gud-last-frame) nil)
2388 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
2389 (make-local-variable 'comint-prompt-regexp)
2390 ;; Don't put repeated commands in command history many times.
2391 (set (make-local-variable 'comint-input-ignoredups) t)
2392 (make-local-variable 'paragraph-start)
68b872d2
NR
2393 (set (make-local-variable 'gud-delete-prompt-marker) (make-marker))
2394 (add-hook 'kill-buffer-hook 'gud-kill-buffer-hook nil t))
0f9c2d46
JB
2395
2396;; Cause our buffers to be displayed, by default,
2397;; in the selected window.
2398;;;###autoload (add-hook 'same-window-regexps "\\*gud-.*\\*\\(\\|<[0-9]+>\\)")
2399
2400(defcustom gud-chdir-before-run t
2401 "Non-nil if GUD should `cd' to the debugged executable."
2402 :group 'gud
2403 :type 'boolean)
2404
2405(defvar gud-target-name "--unknown--"
2406 "The apparent name of the program being debugged in a gud buffer.")
2407
2408;; Perform initializations common to all debuggers.
2409;; The first arg is the specified command line,
2410;; which starts with the program to debug.
2411;; The other three args specify the values to use
2412;; for local variables in the debugger buffer.
2413(defun gud-common-init (command-line massage-args marker-filter
2414 &optional find-file)
2415 (let* ((words (split-string command-line))
2416 (program (car words))
2417 (dir default-directory)
2418 ;; Extract the file name from WORDS
2419 ;; and put t in its place.
2420 ;; Later on we will put the modified file name arg back there.
2421 (file-word (let ((w (cdr words)))
2422 (while (and w (= ?- (aref (car w) 0)))
2423 (setq w (cdr w)))
2424 (and w
2425 (prog1 (car w)
2426 (setcar w t)))))
2427 (file-subst
2428 (and file-word (substitute-in-file-name file-word)))
2429 (args (cdr words))
2430 ;; If a directory was specified, expand the file name.
2431 ;; Otherwise, don't expand it, so GDB can use the PATH.
2432 ;; A file name without directory is literally valid
2433 ;; only if the file exists in ., and in that case,
2434 ;; omitting the expansion here has no visible effect.
2435 (file (and file-word
2436 (if (file-name-directory file-subst)
2437 (expand-file-name file-subst)
2438 file-subst)))
5ab26292
NR
2439 (filepart (and file-word (concat "-" (file-name-nondirectory file))))
2440 (existing-buffer (get-buffer (concat "*gud" filepart "*"))))
0f9c2d46 2441 (pop-to-buffer (concat "*gud" filepart "*"))
f9878c26
MB
2442 (when (and existing-buffer (get-buffer-process existing-buffer))
2443 (error "This program is already running under gdb"))
0f9c2d46
JB
2444 ;; Set the dir, in case the buffer already existed with a different dir.
2445 (setq default-directory dir)
2446 ;; Set default-directory to the file's directory.
2447 (and file-word
2448 gud-chdir-before-run
2449 ;; Don't set default-directory if no directory was specified.
2450 ;; In that case, either the file is found in the current directory,
2451 ;; in which case this setq is a no-op,
2452 ;; or it is found by searching PATH,
2453 ;; in which case we don't know what directory it was found in.
2454 (file-name-directory file)
2455 (setq default-directory (file-name-directory file)))
2456 (or (bolp) (newline))
2457 (insert "Current directory is " default-directory "\n")
2458 ;; Put the substituted and expanded file name back in its place.
2459 (let ((w args))
2460 (while (and w (not (eq (car w) t)))
2461 (setq w (cdr w)))
2462 (if w
2463 (setcar w file)))
2464 (apply 'make-comint (concat "gud" filepart) program nil
2465 (if massage-args (funcall massage-args file args) args))
2466 ;; Since comint clobbered the mode, we don't set it until now.
2467 (gud-mode)
2468 (set (make-local-variable 'gud-target-name)
2469 (and file-word (file-name-nondirectory file))))
2470 (set (make-local-variable 'gud-marker-filter) marker-filter)
2471 (if find-file (set (make-local-variable 'gud-find-file) find-file))
2472 (setq gud-running nil)
2473 (setq gud-last-last-frame nil)
2474
2475 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
2476 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
2477 (gud-set-buffer))
2478
2479(defun gud-set-buffer ()
2480 (when (eq major-mode 'gud-mode)
2481 (setq gud-comint-buffer (current-buffer))))
2482
2483(defvar gud-filter-defer-flag nil
2484 "Non-nil means don't process anything from the debugger right now.
2485It is saved for when this flag is not set.")
2486
0f9c2d46
JB
2487;; These functions are responsible for inserting output from your debugger
2488;; into the buffer. The hard work is done by the method that is
2489;; the value of gud-marker-filter.
2490
2491(defun gud-filter (proc string)
2492 ;; Here's where the actual buffer insertion is done
2493 (let (output process-window)
2494 (if (buffer-name (process-buffer proc))
2495 (if gud-filter-defer-flag
2496 ;; If we can't process any text now,
2497 ;; save it for later.
2498 (setq gud-filter-pending-text
2499 (concat (or gud-filter-pending-text "") string))
2500
2501 ;; If we have to ask a question during the processing,
2502 ;; defer any additional text that comes from the debugger
2503 ;; during that time.
2504 (let ((gud-filter-defer-flag t))
2505 ;; Process now any text we previously saved up.
2506 (if gud-filter-pending-text
2507 (setq string (concat gud-filter-pending-text string)
2508 gud-filter-pending-text nil))
2509
2510 (with-current-buffer (process-buffer proc)
2511 ;; If we have been so requested, delete the debugger prompt.
2512 (save-restriction
2513 (widen)
2514 (if (marker-buffer gud-delete-prompt-marker)
2515 (progn
2516 (delete-region (process-mark proc)
2517 gud-delete-prompt-marker)
2518 (set-marker gud-delete-prompt-marker nil)))
2519 ;; Save the process output, checking for source file markers.
2520 (setq output (gud-marker-filter string))
2521 ;; Check for a filename-and-line number.
2522 ;; Don't display the specified file
2523 ;; unless (1) point is at or after the position where output appears
2524 ;; and (2) this buffer is on the screen.
2525 (setq process-window
2526 (and gud-last-frame
2527 (>= (point) (process-mark proc))
2528 (get-buffer-window (current-buffer)))))
2529
2530 ;; Let the comint filter do the actual insertion.
2531 ;; That lets us inherit various comint features.
2532 (comint-output-filter proc output))
2533
2534 ;; Put the arrow on the source line.
2535 ;; This must be outside of the save-excursion
2536 ;; in case the source file is our current buffer.
2537 (if process-window
007c55a4 2538 (with-selected-window process-window
0a0157ba 2539 (gud-display-frame))
0f9c2d46
JB
2540 ;; We have to be in the proper buffer, (process-buffer proc),
2541 ;; but not in a save-excursion, because that would restore point.
3e215e30
RS
2542 (with-current-buffer (process-buffer proc)
2543 (gud-display-frame))))
0f9c2d46
JB
2544
2545 ;; If we deferred text that arrived during this processing,
2546 ;; handle it now.
2547 (if gud-filter-pending-text
2548 (gud-filter proc ""))))))
2549
2550(defvar gud-minor-mode-type nil)
63cc3b09 2551(defvar gud-overlay-arrow-position nil)
63cc3b09 2552(add-to-list 'overlay-arrow-variable-list 'gud-overlay-arrow-position)
0f9c2d46
JB
2553
2554(defun gud-sentinel (proc msg)
2555 (cond ((null (buffer-name (process-buffer proc)))
2556 ;; buffer killed
2557 ;; Stop displaying an arrow in a source file.
63cc3b09 2558 (setq gud-overlay-arrow-position nil)
0f9c2d46 2559 (set-process-buffer proc nil)
129adb6f 2560 (if (memq gud-minor-mode-type '(gdbmi gdba))
0f9c2d46
JB
2561 (gdb-reset)
2562 (gud-reset)))
2563 ((memq (process-status proc) '(signal exit))
2564 ;; Stop displaying an arrow in a source file.
63cc3b09 2565 (setq gud-overlay-arrow-position nil)
0f9c2d46 2566 (with-current-buffer gud-comint-buffer
129adb6f 2567 (if (memq gud-minor-mode-type '(gdbmi gdba))
0f9c2d46
JB
2568 (gdb-reset)
2569 (gud-reset)))
2570 (let* ((obuf (current-buffer)))
2571 ;; save-excursion isn't the right thing if
2572 ;; process-buffer is current-buffer
2573 (unwind-protect
2574 (progn
2575 ;; Write something in *compilation* and hack its mode line,
2576 (set-buffer (process-buffer proc))
2577 ;; Fix the mode line.
2578 (setq mode-line-process
2579 (concat ":"
2580 (symbol-name (process-status proc))))
2581 (force-mode-line-update)
2582 (if (eobp)
2583 (insert ?\n mode-name " " msg)
2584 (save-excursion
2585 (goto-char (point-max))
2586 (insert ?\n mode-name " " msg)))
2587 ;; If buffer and mode line will show that the process
2588 ;; is dead, we can delete it now. Otherwise it
2589 ;; will stay around until M-x list-processes.
2590 (delete-process proc))
2591 ;; Restore old buffer, but don't restore old point
2592 ;; if obuf is the gud buffer.
2593 (set-buffer obuf))))))
2594
2595(defun gud-kill-buffer-hook ()
68b872d2
NR
2596 (setq gud-minor-mode-type gud-minor-mode)
2597 (condition-case nil
2598 (kill-process (get-buffer-process gud-comint-buffer))
2599 (error nil)))
0f9c2d46
JB
2600
2601(defun gud-reset ()
2602 (dolist (buffer (buffer-list))
27149c58
SM
2603 (unless (eq buffer gud-comint-buffer)
2604 (with-current-buffer buffer
2605 (when gud-minor-mode
2606 (setq gud-minor-mode nil)
2607 (kill-local-variable 'tool-bar-map))))))
0f9c2d46
JB
2608
2609(defun gud-display-frame ()
2610 "Find and obey the last filename-and-line marker from the debugger.
2611Obeying it means displaying in another window the specified file and line."
2612 (interactive)
2613 (when gud-last-frame
2614 (gud-set-buffer)
2615 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
2616 (setq gud-last-last-frame gud-last-frame
2617 gud-last-frame nil)))
2618
2619;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
2620;; and that its line LINE is visible.
2621;; Put the overlay-arrow on the line LINE in that buffer.
2622;; Most of the trickiness in here comes from wanting to preserve the current
2623;; region-restriction if that's possible. We use an explicit display-buffer
2624;; to get around the fact that this is called inside a save-excursion.
2625
2626(defun gud-display-line (true-file line)
2627 (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
2628 (buffer
2629 (with-current-buffer gud-comint-buffer
2630 (gud-find-file true-file)))
2631 (window (and buffer (or (get-buffer-window buffer)
1236e386 2632 (display-buffer buffer))))
0f9c2d46
JB
2633 (pos))
2634 (if buffer
2635 (progn
2636 (with-current-buffer buffer
37fdcfbc
NR
2637 (unless (or (verify-visited-file-modtime buffer) gud-keep-buffer)
2638 (if (yes-or-no-p
0f9c2d46
JB
2639 (format "File %s changed on disk. Reread from disk? "
2640 (buffer-name)))
2641 (revert-buffer t t)
37fdcfbc 2642 (setq gud-keep-buffer t)))
0f9c2d46
JB
2643 (save-restriction
2644 (widen)
2645 (goto-line line)
2646 (setq pos (point))
63cc3b09
NR
2647 (or gud-overlay-arrow-position
2648 (setq gud-overlay-arrow-position (make-marker)))
2649 (set-marker gud-overlay-arrow-position (point) (current-buffer)))
0f9c2d46 2650 (cond ((or (< pos (point-min)) (> pos (point-max)))
37fdcfbc
NR
2651 (widen)
2652 (goto-char pos))))
63cc3b09 2653 (if window (set-window-point window gud-overlay-arrow-position))))))
0f9c2d46
JB
2654
2655;; The gud-call function must do the right thing whether its invoking
2656;; keystroke is from the GUD buffer itself (via major-mode binding)
2657;; or a C buffer. In the former case, we want to supply data from
2658;; gud-last-frame. Here's how we do it:
2659
2660(defun gud-format-command (str arg)
2661 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
2662 (frame (or gud-last-frame gud-last-last-frame))
2663 result)
2664 (while (and str (string-match "\\([^%]*\\)%\\([adeflpc]\\)" str))
2665 (let ((key (string-to-char (match-string 2 str)))
2666 subst)
2667 (cond
2668 ((eq key ?f)
2669 (setq subst (file-name-nondirectory (if insource
2670 (buffer-file-name)
2671 (car frame)))))
2672 ((eq key ?F)
2673 (setq subst (file-name-sans-extension
2674 (file-name-nondirectory (if insource
2675 (buffer-file-name)
2676 (car frame))))))
2677 ((eq key ?d)
2678 (setq subst (file-name-directory (if insource
2679 (buffer-file-name)
2680 (car frame)))))
2681 ((eq key ?l)
2682 (setq subst (int-to-string
2683 (if insource
2684 (save-restriction
2685 (widen)
2686 (+ (count-lines (point-min) (point))
2687 (if (bolp) 1 0)))
2688 (cdr frame)))))
2689 ((eq key ?e)
deaef289 2690 (setq subst (gud-find-expr)))
0f9c2d46
JB
2691 ((eq key ?a)
2692 (setq subst (gud-read-address)))
2693 ((eq key ?c)
2694 (setq subst
2695 (gud-find-class
2696 (if insource
2697 (buffer-file-name)
2698 (car frame))
2699 (if insource
2700 (save-restriction
2701 (widen)
2702 (+ (count-lines (point-min) (point))
2703 (if (bolp) 1 0)))
2704 (cdr frame)))))
2705 ((eq key ?p)
2706 (setq subst (if arg (int-to-string arg)))))
2707 (setq result (concat result (match-string 1 str) subst)))
2708 (setq str (substring str (match-end 2))))
2709 ;; There might be text left in STR when the loop ends.
2710 (concat result str)))
2711
2712(defun gud-read-address ()
2713 "Return a string containing the core-address found in the buffer at point."
2714 (save-match-data
2715 (save-excursion
2716 (let ((pt (point)) found begin)
2717 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
2718 (cond
2719 (found (forward-char 2)
2720 (buffer-substring found
2721 (progn (re-search-forward "[^0-9a-f]")
2722 (forward-char -1)
2723 (point))))
2724 (t (setq begin (progn (re-search-backward "[^0-9]")
2725 (forward-char 1)
2726 (point)))
2727 (forward-char 1)
2728 (re-search-forward "[^0-9]")
2729 (forward-char -1)
2730 (buffer-substring begin (point))))))))
2731
2732(defun gud-call (fmt &optional arg)
2733 (let ((msg (gud-format-command fmt arg)))
2734 (message "Command: %s" msg)
2735 (sit-for 0)
2736 (gud-basic-call msg)))
2737
2738(defun gud-basic-call (command)
2739 "Invoke the debugger COMMAND displaying source in other window."
2740 (interactive)
2741 (gud-set-buffer)
2742 (let ((proc (get-buffer-process gud-comint-buffer)))
2743 (or proc (error "Current buffer has no process"))
2744 ;; Arrange for the current prompt to get deleted.
2745 (save-excursion
2746 (set-buffer gud-comint-buffer)
2747 (save-restriction
2748 (widen)
2749 (goto-char (process-mark proc))
2750 (forward-line 0)
2751 (if (looking-at comint-prompt-regexp)
2752 (set-marker gud-delete-prompt-marker (point)))
129adb6f 2753 (if (memq gud-minor-mode '(gdbmi gdba))
0f9c2d46
JB
2754 (apply comint-input-sender (list proc command))
2755 (process-send-string proc (concat command "\n")))))))
2756
2757(defun gud-refresh (&optional arg)
2758 "Fix up a possibly garbled display, and redraw the arrow."
2759 (interactive "P")
2760 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
2761 (gud-display-frame)
2762 (recenter arg))
2763\f
deaef289
NR
2764;; Code for parsing expressions out of C or Fortran code. The single entry
2765;; point is gud-find-expr, which tries to return an lvalue expression from
2766;; around point.
2767
c3f6b2b4 2768(defvar gud-find-expr-function 'gud-find-c-expr)
deaef289
NR
2769
2770(defun gud-find-expr (&rest args)
c3f6b2b4 2771 (apply gud-find-expr-function args))
deaef289
NR
2772
2773;; The next eight functions are hacked from gdbsrc.el by
0f9c2d46
JB
2774;; Debby Ayers <ayers@asc.slb.com>,
2775;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
2776
2777(defun gud-find-c-expr ()
deaef289 2778 "Returns the expr that surrounds point."
0f9c2d46
JB
2779 (interactive)
2780 (save-excursion
deaef289
NR
2781 (let ((p (point))
2782 (expr (gud-innermost-expr))
2783 (test-expr (gud-prev-expr)))
0f9c2d46
JB
2784 (while (and test-expr (gud-expr-compound test-expr expr))
2785 (let ((prev-expr expr))
2786 (setq expr (cons (car test-expr) (cdr expr)))
2787 (goto-char (car expr))
2788 (setq test-expr (gud-prev-expr))
2789 ;; If we just pasted on the condition of an if or while,
2790 ;; throw it away again.
2791 (if (member (buffer-substring (car test-expr) (cdr test-expr))
2792 '("if" "while" "for"))
2793 (setq test-expr nil
2794 expr prev-expr))))
2795 (goto-char p)
2796 (setq test-expr (gud-next-expr))
2797 (while (gud-expr-compound expr test-expr)
2798 (setq expr (cons (car expr) (cdr test-expr)))
2799 (setq test-expr (gud-next-expr)))
2800 (buffer-substring (car expr) (cdr expr)))))
2801
2802(defun gud-innermost-expr ()
2803 "Returns the smallest expr that point is in; move point to beginning of it.
2804The expr is represented as a cons cell, where the car specifies the point in
2805the current buffer that marks the beginning of the expr and the cdr specifies
2806the character after the end of the expr."
2807 (let ((p (point)) begin end)
2808 (gud-backward-sexp)
2809 (setq begin (point))
2810 (gud-forward-sexp)
2811 (setq end (point))
2812 (if (>= p end)
2813 (progn
2814 (setq begin p)
2815 (goto-char p)
2816 (gud-forward-sexp)
2817 (setq end (point)))
2818 )
2819 (goto-char begin)
2820 (cons begin end)))
2821
2822(defun gud-backward-sexp ()
2823 "Version of `backward-sexp' that catches errors."
2824 (condition-case nil
2825 (backward-sexp)
2826 (error t)))
2827
2828(defun gud-forward-sexp ()
2829 "Version of `forward-sexp' that catches errors."
2830 (condition-case nil
2831 (forward-sexp)
2832 (error t)))
2833
2834(defun gud-prev-expr ()
2835 "Returns the previous expr, point is set to beginning of that expr.
2836The expr is represented as a cons cell, where the car specifies the point in
2837the current buffer that marks the beginning of the expr and the cdr specifies
2838the character after the end of the expr"
2839 (let ((begin) (end))
2840 (gud-backward-sexp)
2841 (setq begin (point))
2842 (gud-forward-sexp)
2843 (setq end (point))
2844 (goto-char begin)
2845 (cons begin end)))
2846
2847(defun gud-next-expr ()
2848 "Returns the following expr, point is set to beginning of that expr.
2849The expr is represented as a cons cell, where the car specifies the point in
2850the current buffer that marks the beginning of the expr and the cdr specifies
2851the character after the end of the expr."
2852 (let ((begin) (end))
2853 (gud-forward-sexp)
2854 (gud-forward-sexp)
2855 (setq end (point))
2856 (gud-backward-sexp)
2857 (setq begin (point))
2858 (cons begin end)))
2859
2860(defun gud-expr-compound-sep (span-start span-end)
2861 "Scan from SPAN-START to SPAN-END for punctuation characters.
2862If `->' is found, return `?.'. If `.' is found, return `?.'.
2863If any other punctuation is found, return `??'.
2864If no punctuation is found, return `? '."
2865 (let ((result ?\ )
2866 (syntax))
2867 (while (< span-start span-end)
2868 (setq syntax (char-syntax (char-after span-start)))
2869 (cond
2870 ((= syntax ?\ ) t)
2871 ((= syntax ?.) (setq syntax (char-after span-start))
2872 (cond
2873 ((= syntax ?.) (setq result ?.))
2874 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
2875 (setq result ?.)
2876 (setq span-start (+ span-start 1)))
2877 (t (setq span-start span-end)
2878 (setq result ??)))))
2879 (setq span-start (+ span-start 1)))
2880 result))
2881
2882(defun gud-expr-compound (first second)
2883 "Non-nil if concatenating FIRST and SECOND makes a single C expression.
2884The two exprs are represented as a cons cells, where the car
2885specifies the point in the current buffer that marks the beginning of the
2886expr and the cdr specifies the character after the end of the expr.
2887Link exprs of the form:
2888 Expr -> Expr
2889 Expr . Expr
2890 Expr (Expr)
2891 Expr [Expr]
2892 (Expr) Expr
2893 [Expr] Expr"
2894 (let ((span-start (cdr first))
2895 (span-end (car second))
2896 (syntax))
2897 (setq syntax (gud-expr-compound-sep span-start span-end))
2898 (cond
2899 ((= (car first) (car second)) nil)
2900 ((= (cdr first) (cdr second)) nil)
2901 ((= syntax ?.) t)
2902 ((= syntax ?\ )
deaef289
NR
2903 (setq span-start (char-after (- span-start 1)))
2904 (setq span-end (char-after span-end))
2905 (cond
2906 ((= span-start ?)) t)
2907 ((= span-start ?]) t)
2908 ((= span-end ?() t)
2909 ((= span-end ?[) t)
2910 (t nil)))
0f9c2d46
JB
2911 (t nil))))
2912
2913(defun gud-find-class (f line)
2914 "Find fully qualified class in file F at line LINE.
2915This function uses the `gud-jdb-classpath' (and optional
2916`gud-jdb-sourcepath') list(s) to derive a file
2917pathname relative to its classpath directory. The values in
2918`gud-jdb-classpath' are assumed to have been converted to absolute
2919pathname standards using file-truename.
2920If F is visited by a buffer and its mode is CC-mode(Java),
2921syntactic information of LINE is used to find the enclosing (nested)
2922class string which is appended to the top level
2923class of the file (using s to separate nested class ids)."
2924 ;; Convert f to a standard representation and remove suffix
2925 (if (and gud-jdb-use-classpath (or gud-jdb-classpath gud-jdb-sourcepath))
2926 (save-match-data
2927 (let ((cplist (append gud-jdb-sourcepath gud-jdb-classpath))
2928 (fbuffer (get-file-buffer f))
339a559e 2929 syntax-symbol syntax-point class-found)
0f9c2d46 2930 (setq f (file-name-sans-extension (file-truename f)))
339a559e
NR
2931 ;; Syntax-symbol returns the symbol of the *first* element
2932 ;; in the syntactical analysis result list, syntax-point
2933 ;; returns the buffer position of same
2934 (fset 'syntax-symbol (lambda (x) (c-langelem-sym (car x))))
2935 (fset 'syntax-point (lambda (x) (c-langelem-pos (car x))))
0f9c2d46
JB
2936 ;; Search through classpath list for an entry that is
2937 ;; contained in f
2938 (while (and cplist (not class-found))
2939 (if (string-match (car cplist) f)
2940 (setq class-found
2941 (mapconcat 'identity
2942 (split-string
2943 (substring f (+ (match-end 0) 1))
2944 "/") ".")))
2945 (setq cplist (cdr cplist)))
2946 ;; if f is visited by a java(cc-mode) buffer, walk up the
2947 ;; syntactic information chain and collect any 'inclass
2948 ;; symbols until 'topmost-intro is reached to find out if
2949 ;; point is within a nested class
2950 (if (and fbuffer (equal (symbol-file 'java-mode) "cc-mode"))
2951 (save-excursion
2952 (set-buffer fbuffer)
2953 (let ((nclass) (syntax))
2954 ;; While the c-syntactic information does not start
2955 ;; with the 'topmost-intro symbol, there may be
2956 ;; nested classes...
2957 (while (not (eq 'topmost-intro
339a559e 2958 (syntax-symbol (c-guess-basic-syntax))))
0f9c2d46
JB
2959 ;; Check if the current position c-syntactic
2960 ;; analysis has 'inclass
2961 (setq syntax (c-guess-basic-syntax))
2962 (while
339a559e 2963 (and (not (eq 'inclass (syntax-symbol syntax)))
0f9c2d46
JB
2964 (cdr syntax))
2965 (setq syntax (cdr syntax)))
339a559e 2966 (if (eq 'inclass (syntax-symbol syntax))
0f9c2d46 2967 (progn
339a559e 2968 (goto-char (syntax-point syntax))
0f9c2d46
JB
2969 ;; Now we're at the beginning of a class
2970 ;; definition. Find class name
2971 (looking-at
2972 "[A-Za-z0-9 \t\n]*?class[ \t\n]+\\([^ \t\n]+\\)")
2973 (setq nclass
2974 (append (list (match-string-no-properties 1))
2975 nclass)))
2976 (setq syntax (c-guess-basic-syntax))
339a559e 2977 (while (and (not (syntax-point syntax)) (cdr syntax))
0f9c2d46 2978 (setq syntax (cdr syntax)))
339a559e 2979 (goto-char (syntax-point syntax))
0f9c2d46
JB
2980 ))
2981 (string-match (concat (car nclass) "$") class-found)
2982 (setq class-found
2983 (replace-match (mapconcat 'identity nclass "$")
2984 t t class-found)))))
2985 (if (not class-found)
2986 (message "gud-find-class: class for file %s not found!" f))
2987 class-found))
2988 ;; Not using classpath - try class/source association list
2989 (let ((class-found (rassoc f gud-jdb-class-source-alist)))
2990 (if class-found
2991 (car class-found)
2992 (message "gud-find-class: class for file %s not found in gud-jdb-class-source-alist!" f)
2993 nil))))
2994
0d2794e3 2995\f
0f9c2d46
JB
2996;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2997;;; GDB script mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2998;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2999
3000(defvar gdb-script-mode-syntax-table
3001 (let ((st (make-syntax-table)))
3002 (modify-syntax-entry ?' "\"" st)
3003 (modify-syntax-entry ?# "<" st)
3004 (modify-syntax-entry ?\n ">" st)
3005 st))
3006
3007(defvar gdb-script-font-lock-keywords
c5209376
MY
3008 '(("^define\\s-+\\(\\(\\w\\|\\s_\\)+\\)" (1 font-lock-function-name-face))
3009 ("\\$\\(\\w+\\)" (1 font-lock-variable-name-face))
0f9c2d46
JB
3010 ("^\\s-*\\([a-z]+\\)" (1 font-lock-keyword-face))))
3011
3012(defvar gdb-script-font-lock-syntactic-keywords
3013 '(("^document\\s-.*\\(\n\\)" (1 "< b"))
3014 ;; It would be best to change the \n in front, but it's more difficult.
3015 ("^en\\(d\\)\\>" (1 "> b"))))
3016
3017(defun gdb-script-font-lock-syntactic-face (state)
3018 (cond
3019 ((nth 3 state) font-lock-string-face)
3020 ((nth 7 state) font-lock-doc-face)
3021 (t font-lock-comment-face)))
3022
3023(defvar gdb-script-basic-indent 2)
3024
3025(defun gdb-script-skip-to-head ()
3026 "We're just in front of an `end' and we need to go to its head."
3027 (while (and (re-search-backward "^\\s-*\\(\\(end\\)\\|define\\|document\\|if\\|while\\)\\>" nil 'move)
3028 (match-end 2))
3029 (gdb-script-skip-to-head)))
3030
3031(defun gdb-script-calculate-indentation ()
3032 (cond
3033 ((looking-at "end\\>")
3034 (gdb-script-skip-to-head)
3035 (current-indentation))
3036 ((looking-at "else\\>")
3037 (while (and (re-search-backward "^\\s-*\\(if\\|\\(end\\)\\)\\>" nil 'move)
3038 (match-end 2))
3039 (gdb-script-skip-to-head))
3040 (current-indentation))
3041 (t
3042 (forward-comment (- (point-max)))
3043 (forward-line 0)
3044 (skip-chars-forward " \t")
3045 (+ (current-indentation)
3046 (if (looking-at "\\(if\\|while\\|define\\|else\\)\\>")
3047 gdb-script-basic-indent 0)))))
3048
3049(defun gdb-script-indent-line ()
3050 "Indent current line of GDB script."
3051 (interactive)
3052 (if (and (eq (get-text-property (point) 'face) font-lock-doc-face)
3053 (save-excursion
3054 (forward-line 0)
3055 (skip-chars-forward " \t")
3056 (not (looking-at "end\\>"))))
3057 'noindent
3058 (let* ((savep (point))
3059 (indent (condition-case nil
3060 (save-excursion
3061 (forward-line 0)
3062 (skip-chars-forward " \t")
3063 (if (>= (point) savep) (setq savep nil))
3064 (max (gdb-script-calculate-indentation) 0))
3065 (error 0))))
3066 (if savep
3067 (save-excursion (indent-line-to indent))
3068 (indent-line-to indent)))))
3069
e375517f
MY
3070;; Derived from cfengine.el.
3071(defun gdb-script-beginning-of-defun ()
3072 "`beginning-of-defun' function for Gdb script mode.
3073Treats actions as defuns."
3074 (unless (<= (current-column) (current-indentation))
3075 (end-of-line))
3076 (if (re-search-backward "^define \\|^document " nil t)
3077 (beginning-of-line)
3078 (goto-char (point-min)))
3079 t)
3080
3081;; Derived from cfengine.el.
3082(defun gdb-script-end-of-defun ()
3083 "`end-of-defun' function for Gdb script mode.
3084Treats actions as defuns."
3085 (end-of-line)
3086 (if (re-search-forward "^end" nil t)
3087 (beginning-of-line)
3088 (goto-char (point-max)))
3089 t)
3090
0f9c2d46
JB
3091;;;###autoload
3092(add-to-list 'auto-mode-alist '("/\\.gdbinit" . gdb-script-mode))
3093
3094;;;###autoload
3095(define-derived-mode gdb-script-mode nil "GDB-Script"
3096 "Major mode for editing GDB scripts"
3097 (set (make-local-variable 'comment-start) "#")
3098 (set (make-local-variable 'comment-start-skip) "#+\\s-*")
3099 (set (make-local-variable 'outline-regexp) "[ \t]")
3100 (set (make-local-variable 'imenu-generic-expression)
3101 '((nil "^define[ \t]+\\(\\w+\\)" 1)))
3102 (set (make-local-variable 'indent-line-function) 'gdb-script-indent-line)
e375517f
MY
3103 (set (make-local-variable 'beginning-of-defun-function)
3104 #'gdb-script-beginning-of-defun)
3105 (set (make-local-variable 'end-of-defun-function)
3106 #'gdb-script-end-of-defun)
0f9c2d46
JB
3107 (set (make-local-variable 'font-lock-defaults)
3108 '(gdb-script-font-lock-keywords nil nil ((?_ . "w")) nil
3109 (font-lock-syntactic-keywords
3110 . gdb-script-font-lock-syntactic-keywords)
3111 (font-lock-syntactic-face-function
3112 . gdb-script-font-lock-syntactic-face))))
3113
ce38ddb8
NR
3114\f
3115;;; tooltips for GUD
3116
3117;;; Customizable settings
3118(defcustom gud-tooltip-modes '(gud-mode c-mode c++-mode fortran-mode)
3119 "List of modes for which to enable GUD tips."
3120 :type 'sexp
3121 :tag "GUD modes"
3122 :group 'tooltip)
3123
3124(defcustom gud-tooltip-display
3125 '((eq (tooltip-event-buffer gud-tooltip-event)
3126 (marker-buffer gud-overlay-arrow-position)))
3127 "List of forms determining where GUD tooltips are displayed.
3128
3129Forms in the list are combined with AND. The default is to display
3130only tooltips in the buffer containing the overlay arrow."
3131 :type 'sexp
3132 :tag "GUD buffers predicate"
3133 :group 'tooltip)
3134
3135(defcustom gud-tooltip-echo-area nil
3136 "Use the echo area instead of frames for GUD tooltips."
3137 :type 'boolean
3138 :tag "Use echo area"
3139 :group 'tooltip)
3140
3141(define-obsolete-variable-alias 'tooltip-gud-modes
3142 'gud-tooltip-modes "22.1")
3143(define-obsolete-variable-alias 'tooltip-gud-display
3144 'gud-tooltip-display "22.1")
ce38ddb8
NR
3145
3146;;; Reacting on mouse movements
3147
3148(defun gud-tooltip-change-major-mode ()
3149 "Function added to `change-major-mode-hook' when tooltip mode is on."
3150 (add-hook 'post-command-hook 'gud-tooltip-activate-mouse-motions-if-enabled))
3151
3152(defun gud-tooltip-activate-mouse-motions-if-enabled ()
3153 "Reconsider for all buffers whether mouse motion events are desired."
3154 (remove-hook 'post-command-hook
3155 'gud-tooltip-activate-mouse-motions-if-enabled)
3156 (dolist (buffer (buffer-list))
3157 (save-excursion
3158 (set-buffer buffer)
3159 (if (and gud-tooltip-mode
3160 (memq major-mode gud-tooltip-modes))
3161 (gud-tooltip-activate-mouse-motions t)
3162 (gud-tooltip-activate-mouse-motions nil)))))
3163
3164(defvar gud-tooltip-mouse-motions-active nil
3165 "Locally t in a buffer if tooltip processing of mouse motion is enabled.")
3166
3167(defun gud-tooltip-activate-mouse-motions (activatep)
3168 "Activate/deactivate mouse motion events for the current buffer.
3169ACTIVATEP non-nil means activate mouse motion events."
3170 (if activatep
3171 (progn
3172 (make-local-variable 'gud-tooltip-mouse-motions-active)
3173 (setq gud-tooltip-mouse-motions-active t)
3174 (make-local-variable 'track-mouse)
3175 (setq track-mouse t))
3176 (when gud-tooltip-mouse-motions-active
3177 (kill-local-variable 'gud-tooltip-mouse-motions-active)
3178 (kill-local-variable 'track-mouse))))
3179
3180(defun gud-tooltip-mouse-motion (event)
3181 "Command handler for mouse movement events in `global-map'."
3182 (interactive "e")
3183 (tooltip-hide)
3184 (when (car (mouse-pixel-position))
3185 (setq tooltip-last-mouse-motion-event (copy-sequence event))
3186 (tooltip-start-delayed-tip)))
3187
3188;;; Tips for `gud'
3189
3190(defvar gud-tooltip-original-filter nil
3191 "Process filter to restore after GUD output has been received.")
3192
3193(defvar gud-tooltip-dereference nil
3194 "Non-nil means print expressions with a `*' in front of them.
3195For C this would dereference a pointer expression.")
3196
3197(defvar gud-tooltip-event nil
3198 "The mouse movement event that led to a tooltip display.
3199This event can be examined by forms in GUD-TOOLTIP-DISPLAY.")
3200
be820e8d 3201(defun toggle-gud-tooltip-dereference ()
ce38ddb8
NR
3202 "Toggle whether tooltips should show `* expr' or `expr'."
3203 (interactive)
3204 (setq gud-tooltip-dereference (not gud-tooltip-dereference))
3205 (when (interactive-p)
3206 (message "Dereferencing is now %s."
3207 (if gud-tooltip-dereference "on" "off"))))
3208
3209(define-obsolete-function-alias 'tooltip-gud-toggle-dereference
be820e8d 3210 'toggle-gud-tooltip-dereference "22.1")
ce38ddb8
NR
3211
3212(define-minor-mode gud-tooltip-mode
3213 "Toggle the display of GUD tooltips."
3214 :global t
3215 :group 'gud
df94fa1e 3216 (require 'tooltip)
ce38ddb8
NR
3217 (if gud-tooltip-mode
3218 (progn
3219 (add-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3220 (add-hook 'pre-command-hook 'tooltip-hide)
3221 (add-hook 'tooltip-hook 'gud-tooltip-tips)
3222 (define-key global-map [mouse-movement] 'gud-tooltip-mouse-motion))
3223 (unless tooltip-mode (remove-hook 'pre-command-hook 'tooltip-hide)
2b9688f6 3224 (remove-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
ce38ddb8
NR
3225 (remove-hook 'tooltip-hook 'gud-tooltip-tips)
3226 (define-key global-map [mouse-movement] 'ignore)))
3227 (gud-tooltip-activate-mouse-motions-if-enabled)
3228 (if (with-current-buffer gud-comint-buffer (eq gud-minor-mode 'gdba))
3229 (if gud-tooltip-mode
3230 (progn
3231 (dolist (buffer (buffer-list))
3232 (unless (eq buffer gud-comint-buffer)
3233 (with-current-buffer buffer
3234 (when (and (memq gud-minor-mode '(gdbmi gdba))
3235 (not (string-match "\\`\\*.+\\*\\'"
3236 (buffer-name))))
3237 (make-local-variable 'gdb-define-alist)
3238 (gdb-create-define-alist)
3239 (add-hook 'after-save-hook
3240 'gdb-create-define-alist nil t))))))
3241 (kill-local-variable 'gdb-define-alist)
3242 (remove-hook 'after-save-hook 'gdb-create-define-alist t))))
3243
3244; This will only display data that comes in one chunk.
3245; Larger arrays (say 400 elements) are displayed in
dce4ed29 3246; the tooltip incompletely and spill over into the gud buffer.
ce38ddb8
NR
3247; Switching the process-filter creates timing problems and
3248; it may be difficult to do better. Using annotations as in
3249; gdb-ui.el gets round this problem.
3250(defun gud-tooltip-process-output (process output)
3251 "Process debugger output and show it in a tooltip window."
3252 (set-process-filter process gud-tooltip-original-filter)
3253 (tooltip-show (tooltip-strip-prompt process output)
dce4ed29 3254 (or gud-tooltip-echo-area tooltip-use-echo-area)))
ce38ddb8
NR
3255
3256(defun gud-tooltip-print-command (expr)
3257 "Return a suitable command to print the expression EXPR.
3258If GUD-TOOLTIP-DEREFERENCE is t, also prepend a `*' to EXPR."
3259 (when gud-tooltip-dereference
3260 (setq expr (concat "*" expr)))
3261 (case gud-minor-mode
823d2235
NR
3262 (gdba (concat "server print " expr))
3263 ((dbx gdbmi) (concat "print " expr))
3264 (xdb (concat "p " expr))
3265 (sdb (concat expr "/"))
3266 (perldb expr)))
ce38ddb8
NR
3267
3268(defun gud-tooltip-tips (event)
3269 "Show tip for identifier or selection under the mouse.
3270The mouse must either point at an identifier or inside a selected
3271region for the tip window to be shown. If gud-tooltip-dereference is t,
3272add a `*' in front of the printed expression. In the case of a C program
3273controlled by GDB, show the associated #define directives when program is
3274not executing.
3275
3276This function must return nil if it doesn't handle EVENT."
3277 (let (process)
3278 (when (and (eventp event)
3279 gud-tooltip-mode
3280 (boundp 'gud-comint-buffer)
3281 gud-comint-buffer
3282 (buffer-name gud-comint-buffer); gud-comint-buffer might be killed
3283 (setq process (get-buffer-process gud-comint-buffer))
3284 (posn-point (event-end event))
3285 (or (and (eq gud-minor-mode 'gdba) (not gdb-active-process))
3286 (progn (setq gud-tooltip-event event)
3287 (eval (cons 'and gud-tooltip-display)))))
3288 (let ((expr (tooltip-expr-to-print event)))
3289 (when expr
3290 (if (and (eq gud-minor-mode 'gdba)
3291 (not gdb-active-process))
3292 (progn
3293 (with-current-buffer
3294 (window-buffer (let ((mouse (mouse-position)))
3295 (window-at (cadr mouse)
3296 (cddr mouse))))
3297 (let ((define-elt (assoc expr gdb-define-alist)))
3298 (unless (null define-elt)
dce4ed29
NR
3299 (tooltip-show
3300 (cdr define-elt)
3301 (or gud-tooltip-echo-area tooltip-use-echo-area))
ce38ddb8
NR
3302 expr))))
3303 (let ((cmd (gud-tooltip-print-command expr)))
2b9688f6
NR
3304 (when (and gud-tooltip-mode (eq gud-minor-mode 'gdb))
3305 (gud-tooltip-mode -1)
3306 (message-box "Using GUD tooltips in this mode is unsafe\n\
3307so they have been disabled."))
ce38ddb8 3308 (unless (null cmd) ; CMD can be nil if unknown debugger
df94fa1e
NR
3309 (if (memq gud-minor-mode '(gdba gdbmi))
3310 (if gdb-macro-info
3311 (gdb-enqueue-input
3312 (list (concat
3313 gdb-server-prefix "macro expand " expr "\n")
3314 `(lambda () (gdb-tooltip-print-1 ,expr))))
3315 (gdb-enqueue-input
3316 (list (concat cmd "\n") 'gdb-tooltip-print)))
ce38ddb8
NR
3317 (setq gud-tooltip-original-filter (process-filter process))
3318 (set-process-filter process 'gud-tooltip-process-output)
3319 (gud-basic-call cmd))
3320 expr))))))))
3321
0f9c2d46
JB
3322(provide 'gud)
3323
ab5796a9 3324;;; arch-tag: 6d990948-df65-461a-be39-1c7fb83ac4c4
0f9c2d46 3325;;; gud.el ends here