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