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