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