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