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