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