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