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