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