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