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