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