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