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