1 ;;; gud.el --- Grand Unified Debugger mode for running GDB and other debuggers
3 ;; Copyright (C) 1992-1996, 1998, 2000-2011 Free Software Foundation, Inc.
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
7 ;; Keywords: unix, tools
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; The ancestral gdb.el was by W. Schelter <wfs@rascal.ics.utexas.edu>.
27 ;; It was later rewritten by rms. Some ideas were due to Masanobu. Grand
28 ;; Unification (sdb/dbx support) by Eric S. Raymond <esr@thyrsus.com> Barry
29 ;; Warsaw <bwarsaw@cen.com> hacked the mode to use comint.el. Shane Hartman
30 ;; <shane@spr.com> added support for xdb (HPUX debugger). Rick Sladkey
31 ;; <jrs@world.std.com> wrote the GDB command completion code. Dave Love
32 ;; <d.love@dl.ac.uk> added the IRIX kluge, re-implemented the Mips-ish variant
33 ;; and added a menu. Brian D. Carlstrom <bdc@ai.mit.edu> combined the IRIX
34 ;; kluge with the gud-xdb-directories hack producing gud-dbx-directories.
35 ;; Derek L. Davies <ddavies@world.std.com> added support for jdb (Java
40 (eval-when-compile (require 'cl
)) ; for case macro
44 (defvar gdb-active-process
)
45 (defvar gdb-define-alist
)
46 (defvar gdb-macro-info
)
47 (defvar gdb-show-changed-values
)
48 (defvar gdb-source-window
)
50 (defvar gdb-speedbar-auto-raise
)
51 (defvar gud-tooltip-mode
)
53 (defvar hl-line-sticky-flag
)
57 ;; ======================================================================
58 ;; GUD commands must be visible in C buffers visited by GUD
61 "Grand Unified Debugger mode for gdb and other debuggers under Emacs.
62 Supported debuggers include gdb, sdb, dbx, xdb, perldb, pdb (Python) and jdb."
67 (defcustom gud-key-prefix
"\C-x\C-a"
68 "Prefix of all GUD commands valid in C buffers."
72 (global-set-key (concat gud-key-prefix
"\C-l") 'gud-refresh
)
73 (define-key ctl-x-map
" " 'gud-break
) ;; backward compatibility hack
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
)
80 (defun gud-marker-filter (&rest args
)
81 (apply gud-marker-filter args
))
83 (defvar gud-minor-mode nil
)
84 (put 'gud-minor-mode
'permanent-local t
)
86 (defvar gud-comint-buffer nil
)
88 (defvar gud-keep-buffer nil
)
90 (defun gud-symbol (sym &optional soft minor-mode
)
91 "Return the symbol used for SYM in MINOR-MODE.
92 MINOR-MODE defaults to `gud-minor-mode'.
93 The symbol returned is `gud-<MINOR-MODE>-<SYM>'.
94 If SOFT is non-nil, returns nil if the symbol doesn't already exist."
95 (unless (or minor-mode gud-minor-mode
) (error "Gud internal error"))
96 (funcall (if soft
'intern-soft
'intern
)
97 (format "gud-%s-%s" (or minor-mode gud-minor-mode
) sym
)))
99 (defun gud-val (sym &optional minor-mode
)
100 "Return the value of `gud-symbol' SYM. Default to nil."
101 (let ((sym (gud-symbol sym t minor-mode
)))
102 (if (boundp sym
) (symbol-value sym
))))
104 (defvar gud-running nil
105 "Non-nil if debugged program is running.
106 Used to grey out relevant toolbar icons.")
108 (defvar gud-target-name
"--unknown--"
109 "The apparent name of the program being debugged in a gud buffer.")
111 ;; Use existing Info buffer, if possible.
112 (defun gud-goto-info ()
113 "Go to relevant Emacs info node."
115 (let ((same-window-regexps same-window-regexps
)
116 (display-buffer-reuse-frames t
))
120 (if (eq (window-buffer window
) (get-buffer "*info*"))
122 (setq same-window-regexps nil
)
123 (throw 'info-found nil
))))
125 (select-frame (make-frame)))
126 (if (eq gud-minor-mode
'gdbmi
)
127 (info "(emacs)GDB Graphical Interface")
128 (info "(emacs)Debuggers"))))
130 (defun gud-tool-bar-item-visible-no-fringe ()
131 (not (or (eq (buffer-local-value 'major-mode
(window-buffer)) 'speedbar-mode
)
132 (eq (buffer-local-value 'major-mode
(window-buffer)) 'gdb-memory-mode
)
133 (and (eq gud-minor-mode
'gdbmi
)
134 (> (car (window-fringes)) 0)))))
136 (declare-function gdb-gud-context-command
"gdb-mi.el")
138 (defun gud-stop-subjob ()
140 (with-current-buffer gud-comint-buffer
141 (cond ((string-equal gud-target-name
"emacs")
142 (comint-stop-subjob))
143 ((eq gud-minor-mode
'jdb
)
144 (gud-call "suspend"))
145 ((eq gud-minor-mode
'gdbmi
)
146 (gud-call (gdb-gud-context-command "-exec-interrupt")))
148 (comint-interrupt-subjob)))))
150 (easy-mmode-defmap gud-menu-map
151 '(([help] "Info (debugger)" . gud-goto-info)
152 ([tooltips] menu-item "Show GUD tooltips" gud-tooltip-mode
153 :enable (and (not emacs-basic-display)
155 (fboundp 'x-show-tip))
156 :visible (memq gud-minor-mode
157 '(gdbmi dbx sdb xdb pdb))
158 :button (:toggle . gud-tooltip-mode))
159 ([refresh] "Refresh" . gud-refresh)
160 ([run] menu-item "Run" gud-run
161 :enable (not gud-running)
162 :visible (memq gud-minor-mode '(gdbmi gdb dbx jdb)))
163 ([go] menu-item (if gdb-active-process "Continue" "Run") gud-go
164 :visible (and (eq gud-minor-mode 'gdbmi)
166 ([stop] menu-item "Stop" gud-stop-subjob
167 :visible (or (not (memq gud-minor-mode '(gdbmi pdb)))
169 ([until] menu-item "Continue to selection" gud-until
170 :enable (not gud-running)
171 :visible (and (memq gud-minor-mode '(gdbmi gdb perldb))
172 (gud-tool-bar-item-visible-no-fringe)))
173 ([remove] menu-item "Remove Breakpoint" gud-remove
174 :enable (not gud-running)
175 :visible (gud-tool-bar-item-visible-no-fringe))
176 ([tbreak] menu-item "Temporary Breakpoint" gud-tbreak
177 :enable (not gud-running)
178 :visible (memq gud-minor-mode
179 '(gdbmi gdb sdb xdb)))
180 ([break] menu-item "Set Breakpoint" gud-break
181 :enable (not gud-running)
182 :visible (gud-tool-bar-item-visible-no-fringe))
183 ([up] menu-item "Up Stack" gud-up
184 :enable (not gud-running)
185 :visible (memq gud-minor-mode
186 '(gdbmi gdb dbx xdb jdb pdb)))
187 ([down] menu-item "Down Stack" gud-down
188 :enable (not gud-running)
189 :visible (memq gud-minor-mode
190 '(gdbmi gdb dbx xdb jdb pdb)))
191 ([pp] menu-item "Print S-expression" gud-pp
192 :enable (and (not gud-running)
194 :visible (and (string-equal
196 'gud-target-name gud-comint-buffer) "emacs")
197 (eq gud-minor-mode 'gdbmi)))
198 ([print*] menu-item (if (eq gud-minor-mode 'jdb)
200 "Print Dereference") gud-pstar
201 :enable (not gud-running)
202 :visible (memq gud-minor-mode '(gdbmi gdb jdb)))
203 ([print] menu-item "Print Expression" gud-print
204 :enable (not gud-running))
205 ([watch] menu-item "Watch Expression" gud-watch
206 :enable (not gud-running)
207 :visible (eq gud-minor-mode 'gdbmi))
208 ([finish] menu-item "Finish Function" gud-finish
209 :enable (not gud-running)
210 :visible (memq gud-minor-mode
211 '(gdbmi gdb xdb jdb pdb)))
212 ([stepi] menu-item "Step Instruction" gud-stepi
213 :enable (not gud-running)
214 :visible (memq gud-minor-mode '(gdbmi gdb dbx)))
215 ([nexti] menu-item "Next Instruction" gud-nexti
216 :enable (not gud-running)
217 :visible (memq gud-minor-mode '(gdbmi gdb dbx)))
218 ([step] menu-item "Step Line" gud-step
219 :enable (not gud-running))
220 ([next] menu-item "Next Line" gud-next
221 :enable (not gud-running))
222 ([cont] menu-item "Continue" gud-cont
223 :enable (not gud-running)
224 :visible (not (eq gud-minor-mode 'gdbmi))))
225 "Menu for `gud-mode'."
228 (easy-mmode-defmap gud-minor-mode-map
230 `(([menu-bar debug] . ("Gud" . ,gud-menu-map)))
231 ;; Get tool bar like functionality from the menu bar on a text only
233 (unless window-system
235 . (,(propertize "down" 'face 'font-lock-doc-face) . gud-down))
237 . (,(propertize "up" 'face 'font-lock-doc-face) . gud-up))
239 . (,(propertize "finish" 'face 'font-lock-doc-face) . gud-finish))
241 . (,(propertize "step" 'face 'font-lock-doc-face) . gud-step))
243 . (,(propertize "next" 'face 'font-lock-doc-face) . gud-next))
244 ([menu-bar until] menu-item
245 ,(propertize "until" 'face 'font-lock-doc-face) gud-until
246 :visible (memq gud-minor-mode '(gdbmi gdb perldb)))
247 ([menu-bar cont] menu-item
248 ,(propertize "cont" 'face 'font-lock-doc-face) gud-cont
249 :visible (not (eq gud-minor-mode 'gdbmi)))
250 ([menu-bar run] menu-item
251 ,(propertize "run" 'face 'font-lock-doc-face) gud-run
252 :visible (memq gud-minor-mode '(gdbmi gdb dbx jdb)))
253 ([menu-bar go] menu-item
254 ,(propertize " go " 'face 'font-lock-doc-face) gud-go
255 :visible (and (eq gud-minor-mode 'gdbmi)
257 ([menu-bar stop] menu-item
258 ,(propertize "stop" 'face 'font-lock-doc-face) gud-stop-subjob
259 :visible (or (and (eq gud-minor-mode 'gdbmi)
261 (not (eq gud-minor-mode 'gdbmi))))
263 . (,(propertize "print" 'face 'font-lock-doc-face) . gud-print))
264 ([menu-bar tools] . undefined)
265 ([menu-bar buffer] . undefined)
266 ([menu-bar options] . undefined)
267 ([menu-bar edit] . undefined)
268 ([menu-bar file] . undefined))))
269 "Map used in visited files.")
271 (let ((m (assq 'gud-minor-mode minor-mode-map-alist)))
272 (if m (setcdr m gud-minor-mode-map)
273 (push (cons 'gud-minor-mode gud-minor-mode-map) minor-mode-map-alist)))
276 ;; Will inherit from comint-mode via define-derived-mode.
278 "`gud-mode' keymap.")
280 (defvar gud-tool-bar-map
281 (let ((map (make-sparse-keymap)))
282 (dolist (x '((gud-break . "gud/break")
283 (gud-remove . "gud/remove")
284 (gud-print . "gud/print")
285 (gud-pstar . "gud/pstar")
287 (gud-watch . "gud/watch")
288 (gud-run . "gud/run")
290 (gud-stop-subjob . "gud/stop")
291 (gud-cont . "gud/cont")
292 (gud-until . "gud/until")
293 (gud-next . "gud/next")
294 (gud-step . "gud/step")
295 (gud-finish . "gud/finish")
296 (gud-nexti . "gud/nexti")
297 (gud-stepi . "gud/stepi")
299 (gud-down . "gud/down")
300 (gud-goto-info . "info"))
302 (tool-bar-local-item-from-menu
303 (car x) (cdr x) map gud-minor-mode-map))))
305 (defun gud-file-name (f)
306 "Transform a relative file name to an absolute file name.
307 Uses `gud-<MINOR-MODE>-directories' to find the source files."
308 ;; When `default-directory' is a remote file name, prepend its
309 ;; remote part to f, which is the local file name. Fortunately,
310 ;; `file-remote-p' returns exactly this remote file name part (or
312 (setq f (concat (or (file-remote-p default-directory) "") f))
313 (if (file-exists-p f) (expand-file-name f)
314 (let ((directories (gud-val 'directories))
317 (let ((path (expand-file-name f (car directories))))
318 (if (file-exists-p path)
321 (setq directories (cdr directories)))
324 (declare-function gdb-create-define-alist "gdb-mi" ())
326 (defun gud-find-file (file)
327 ;; Don't get confused by double slashes in the name that comes from GDB.
328 (while (string-match "//+" file)
329 (setq file (replace-match "/" t t file)))
330 (let ((minor-mode gud-minor-mode)
331 (buf (funcall (or gud-find-file 'gud-file-name) file)))
333 (setq buf (and (file-readable-p buf) (find-file-noselect buf 'nowarn))))
335 ;; Copy `gud-minor-mode' to the found buffer to turn on the menu.
336 (with-current-buffer buf
337 (set (make-local-variable 'gud-minor-mode) minor-mode)
338 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
339 (when (and gud-tooltip-mode
340 (eq gud-minor-mode 'gdbmi))
341 (make-local-variable 'gdb-define-alist)
342 (unless gdb-define-alist (gdb-create-define-alist))
343 (add-hook 'after-save-hook 'gdb-create-define-alist nil t))
344 (make-local-variable 'gud-keep-buffer))
347 ;; ======================================================================
348 ;; command definition
350 ;; This macro is used below to define some basic debugger interface commands.
351 ;; Of course you may use `gud-def' with any other debugger command, including
352 ;; user defined ones.
354 ;; A macro call like (gud-def FUNC CMD KEY DOC) expands to a form
355 ;; which defines FUNC to send the command CMD to the debugger, gives
356 ;; it the docstring DOC, and binds that function to KEY in the GUD
357 ;; major mode. The function is also bound in the global keymap with the
360 (defmacro gud-def (func cmd key &optional doc)
361 "Define FUNC to be a command sending CMD and bound to KEY, with
362 optional doc string DOC. Certain %-escapes in the string arguments
363 are interpreted specially if present. These are:
365 %f -- Name (without directory) of current source file.
366 %F -- Name (without directory or extension) of current source file.
367 %d -- Directory of current source file.
368 %l -- Number of current source line.
369 %e -- Text of the C lvalue or function-call expression surrounding point.
370 %a -- Text of the hexadecimal address surrounding point.
371 %p -- Prefix argument to the command (if any) as a number.
372 %c -- Fully qualified class name derived from the expression
373 surrounding point (jdb only).
375 The `current' source file is the file of the current buffer (if
376 we're in a C file) or the source file current at the last break or
377 step (if we're in the GUD buffer).
378 The `current' line is that of the current buffer (if we're in a
379 source file) or the source line number at the last break or step (if
380 we're in the GUD buffer)."
382 (defalias ',func (lambda (arg)
383 ,@(if doc (list doc))
385 (if (not gud-running)
389 ,(if key `(local-set-key ,(concat "\C-c" key) ',func))
390 ,(if key `(global-set-key (vconcat gud-key-prefix ,key) ',func))))
392 ;; Where gud-display-frame should put the debugging arrow; a cons of
393 ;; (filename . line-number). This is set by the marker-filter, which scans
394 ;; the debugger's output for indications of the current program counter.
395 (defvar gud-last-frame nil)
397 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
398 ;; the last frame, even if it's been called before and gud-last-frame has
400 (defvar gud-last-last-frame nil)
402 ;; All debugger-specific information is collected here.
403 ;; Here's how it works, in case you ever need to add a debugger to the mode.
405 ;; Each entry must define the following at startup:
408 ;; comint-prompt-regexp
409 ;; gud-<name>-massage-args
410 ;; gud-<name>-marker-filter
411 ;; gud-<name>-find-file
413 ;; The job of the massage-args method is to modify the given list of
414 ;; debugger arguments before running the debugger.
416 ;; The job of the marker-filter method is to detect file/line markers in
417 ;; strings and set the global gud-last-frame to indicate what display
418 ;; action (if any) should be triggered by the marker. Note that only
419 ;; whatever the method *returns* is displayed in the buffer; thus, you
420 ;; can filter the debugger's output, interpreting some and passing on
423 ;; The job of the find-file method is to visit and return the buffer indicated
424 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
427 ;; ======================================================================
428 ;; speedbar support functions and variables.
429 (eval-when-compile (require 'speedbar)) ;For speedbar-with-attached-buffer.
431 (defvar gud-last-speedbar-stackframe nil
432 "Description of the currently displayed GUD stack.
433 The value t means that there is no stack, and we are in display-file mode.")
435 (defvar gud-speedbar-key-map nil
436 "Keymap used when in the buffers display mode.")
438 (defun gud-speedbar-item-info ()
439 "Display the data type of the watch expression element."
440 (let ((var (nth (- (line-number-at-pos (point)) 2) gdb-var-list)))
442 (speedbar-message "%s: %s" (nth 7 var) (nth 3 var))
443 (speedbar-message "%s" (nth 3 var)))))
445 (defun gud-install-speedbar-variables ()
446 "Install those variables used by speedbar to enhance gud/gdb."
447 (if gud-speedbar-key-map
449 (setq gud-speedbar-key-map (speedbar-make-specialized-keymap))
451 (define-key gud-speedbar-key-map "j" 'speedbar-edit-line)
452 (define-key gud-speedbar-key-map "e" 'speedbar-edit-line)
453 (define-key gud-speedbar-key-map "\C-m" 'speedbar-edit-line)
454 (define-key gud-speedbar-key-map " " 'speedbar-toggle-line-expansion)
455 (define-key gud-speedbar-key-map "D" 'gdb-var-delete)
456 (define-key gud-speedbar-key-map "p" 'gud-pp))
458 (speedbar-add-expansion-list '("GUD" gud-speedbar-menu-items
460 gud-expansion-speedbar-buttons))
463 'speedbar-mode-functions-list
464 '("GUD" (speedbar-item-info . gud-speedbar-item-info)
465 (speedbar-line-directory . ignore))))
467 (defvar gud-speedbar-menu-items
468 '(["Jump to stack frame" speedbar-edit-line
469 :visible (not (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
471 ["Edit value" speedbar-edit-line
472 :visible (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
474 ["Delete expression" gdb-var-delete
475 :visible (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
477 ["Auto raise frame" gdb-speedbar-auto-raise
478 :style toggle :selected gdb-speedbar-auto-raise
479 :visible (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
482 :visible (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
484 ["Binary" (gdb-var-set-format "binary") t]
485 ["Natural" (gdb-var-set-format "natural") t]
486 ["Hexadecimal" (gdb-var-set-format "hexadecimal") t]))
487 "Additional menu items to add to the speedbar frame.")
489 ;; Make sure our special speedbar mode is loaded
490 (if (featurep 'speedbar)
491 (gud-install-speedbar-variables)
492 (add-hook 'speedbar-load-hook 'gud-install-speedbar-variables))
494 (defun gud-expansion-speedbar-buttons (_directory _zero)
495 "Wrapper for call to `speedbar-add-expansion-list'.
496 DIRECTORY and ZERO are not used, but are required by the caller."
497 (gud-speedbar-buttons gud-comint-buffer))
499 (defun gud-speedbar-buttons (buffer)
500 "Create a speedbar display based on the current state of GUD.
501 If the GUD BUFFER is not running a supported debugger, then turn
502 off the specialized speedbar mode. BUFFER is not used, but is
503 required by the caller."
504 (when (and gud-comint-buffer
505 ;; gud-comint-buffer might be killed
506 (buffer-name gud-comint-buffer))
507 (let* ((minor-mode (with-current-buffer buffer gud-minor-mode))
508 (window (get-buffer-window (current-buffer) 0))
509 (start (window-start window))
510 (p (window-point window)))
512 ((eq minor-mode 'gdbmi)
514 (insert "Watch Expressions:\n")
515 (let ((var-list gdb-var-list) parent)
517 (let* (char (depth 0) (start 0) (var (car var-list))
518 (varnum (car var)) (expr (nth 1 var))
519 (type (if (nth 3 var) (nth 3 var) " "))
520 (value (nth 4 var)) (status (nth 5 var))
521 (has-more (nth 6 var)))
523 0 (length expr) 'face font-lock-variable-name-face expr)
525 0 (length type) 'face font-lock-type-face type)
526 (while (string-match "\\." varnum start)
527 (setq depth (1+ depth)
528 start (1+ (match-beginning 0))))
529 (if (eq depth 0) (setq parent nil))
530 (if (and (or (not has-more) (string-equal has-more "0"))
531 (or (equal (nth 2 var) "0")
532 (and (equal (nth 2 var) "1")
533 (string-match "char \\*$" type)) ))
534 (speedbar-make-tag-line
536 (concat expr "\t" value)
537 (if (or parent (eq status 'out-of-scope))
540 (if gdb-show-changed-values
541 (or parent (case status
542 (changed 'font-lock-warning-face)
543 (out-of-scope 'shadow)
547 (if (eq status 'out-of-scope) (setq parent 'shadow))
548 (if (and (nth 1 var-list)
549 (string-match (concat varnum "\\.")
550 (car (nth 1 var-list))))
553 (if (string-match "\\*$\\|\\*&$" type)
554 (speedbar-make-tag-line
556 'gdb-speedbar-expand-node varnum
557 (concat expr "\t" type "\t" value)
558 (if (or parent (eq status 'out-of-scope))
561 (if gdb-show-changed-values
562 (or parent (case status
563 (changed 'font-lock-warning-face)
564 (out-of-scope 'shadow)
568 (speedbar-make-tag-line
570 'gdb-speedbar-expand-node varnum
571 (concat expr "\t" type)
573 (if (and (or parent status) gdb-show-changed-values)
576 (setq var-list (cdr var-list)))))
577 (t (unless (and (save-excursion
578 (goto-char (point-min))
579 (looking-at "Current Stack:"))
580 (equal gud-last-last-frame gud-last-speedbar-stackframe))
581 (let ((gud-frame-list
582 (cond ((eq minor-mode 'gdb)
583 (gud-gdb-get-stackframe buffer))
584 ;; Add more debuggers here!
585 (t (speedbar-remove-localized-speedbar-support buffer)
588 (if (not gud-frame-list)
589 (insert "No Stack frames\n")
590 (insert "Current Stack:\n"))
591 (dolist (frame gud-frame-list)
592 (insert (nth 1 frame) ":\n")
593 (if (= (length frame) 2)
595 (speedbar-insert-button (car frame)
596 'speedbar-directory-face
598 (speedbar-insert-button
601 'speedbar-highlight-face
602 (cond ((memq minor-mode '(gdbmi gdb))
603 'gud-gdb-goto-stackframe)
604 (t (error "Should never be here")))
606 (setq gud-last-speedbar-stackframe gud-last-last-frame))))
607 (set-window-start window start)
608 (set-window-point window p))))
611 ;; ======================================================================
614 ;; History of argument lists passed to gdb.
615 (defvar gud-gdb-history nil)
617 (defcustom gud-gud-gdb-command-name "gdb --fullname"
618 "Default command to run an executable under GDB in text command mode.
619 The option \"--fullname\" must be included in this value."
623 (defvar gud-gdb-marker-regexp
624 ;; This used to use path-separator instead of ":";
625 ;; however, we found that on both Windows 32 and MSDOS
626 ;; a colon is correct here.
627 (concat "\032\032\\(.:?[^" ":" "\n]*\\)" ":"
628 "\\([0-9]*\\)" ":" ".*\n"))
630 ;; There's no guarantee that Emacs will hand the filter the entire
631 ;; marker at once; it could be broken up across several strings. We
632 ;; might even receive a big chunk with several markers in it. If we
633 ;; receive a chunk of text which looks like it might contain the
634 ;; beginning of a marker, we save it here between calls to the
636 (defvar gud-marker-acc "")
637 (make-variable-buffer-local 'gud-marker-acc)
639 (defun gud-gdb-marker-filter (string)
640 (setq gud-marker-acc (concat gud-marker-acc string))
643 ;; Process all the complete markers in this chunk.
644 (while (string-match gud-gdb-marker-regexp gud-marker-acc)
647 ;; Extract the frame position from the marker.
648 gud-last-frame (cons (match-string 1 gud-marker-acc)
649 (string-to-number (match-string 2 gud-marker-acc)))
651 ;; Append any text before the marker to the output we're going
652 ;; to return - we don't include the marker in this text.
653 output (concat output
654 (substring gud-marker-acc 0 (match-beginning 0)))
656 ;; Set the accumulator to the remaining text.
657 gud-marker-acc (substring gud-marker-acc (match-end 0))))
659 (while (string-match "\n\032\032\\(.*\\)\n" gud-marker-acc)
661 ;; Append any text before the marker to the output we're going
662 ;; to return - we don't include the marker in this text.
663 output (concat output
664 (substring gud-marker-acc 0 (match-beginning 0)))
666 ;; Set the accumulator to the remaining text.
668 gud-marker-acc (substring gud-marker-acc (match-end 0))))
670 ;; Does the remaining text look like it might end with the
671 ;; beginning of another marker? If it does, then keep it in
672 ;; gud-marker-acc until we receive the rest of it. Since we
673 ;; know the full marker regexp above failed, it's pretty simple to
674 ;; test for marker starts.
675 (if (string-match "\n\\(\032.*\\)?\\'" gud-marker-acc)
677 ;; Everything before the potential marker start can be output.
678 (setq output (concat output (substring gud-marker-acc
679 0 (match-beginning 0))))
681 ;; Everything after, we save, to combine with later input.
683 (substring gud-marker-acc (match-beginning 0))))
685 (setq output (concat output gud-marker-acc)
690 (easy-mmode-defmap gud-minibuffer-local-map
691 '(("\C-i" . comint-dynamic-complete-filename))
692 "Keymap for minibuffer prompting of gud startup command."
693 :inherit minibuffer-local-map)
695 (defun gud-query-cmdline (minor-mode &optional init)
696 (let* ((hist-sym (gud-symbol 'history nil minor-mode))
697 (cmd-name (gud-val 'command-name minor-mode)))
698 (unless (boundp hist-sym) (set hist-sym nil))
699 (read-from-minibuffer
700 (format "Run %s (like this): " minor-mode)
701 (or (car-safe (symbol-value hist-sym))
702 (concat (or cmd-name (symbol-name minor-mode))
706 (dolist (f (directory-files default-directory) file)
707 (if (and (file-executable-p f)
708 (not (file-directory-p f))
710 (file-newer-than-file-p f file)))
712 gud-minibuffer-local-map nil
715 (defvar gdb-first-prompt t)
717 (defvar gud-filter-pending-text nil
718 "Non-nil means this is text that has been saved for later in `gud-filter'.")
720 ;; If in gdb mode, gdb-mi is loaded.
721 (declare-function gdb-restore-windows "gdb-mi" ())
723 ;; The old gdb command (text command mode). The new one is in gdb-mi.el.
725 (defun gud-gdb (command-line)
726 "Run gdb on program FILE in buffer *gud-FILE*.
727 The directory containing FILE becomes the initial working
728 directory and source-file directory for your debugger."
729 (interactive (list (gud-query-cmdline 'gud-gdb)))
731 (when (and gud-comint-buffer
732 (buffer-name gud-comint-buffer)
733 (get-buffer-process gud-comint-buffer)
734 (with-current-buffer gud-comint-buffer (eq gud-minor-mode 'gdbmi)))
735 (gdb-restore-windows)
737 "Multiple debugging requires restarting in text command mode"))
739 (gud-common-init command-line nil 'gud-gdb-marker-filter)
740 (set (make-local-variable 'gud-minor-mode) 'gdb)
742 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
743 (gud-def gud-tbreak "tbreak %f:%l" "\C-t"
744 "Set temporary breakpoint at current line.")
745 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
746 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
747 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
748 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
749 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
750 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
751 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
753 (progn (gud-call "tbreak %f:%l") (gud-call "jump %f:%l"))
754 "\C-j" "Set execution address to current line.")
756 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
757 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
758 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
759 (gud-def gud-pstar "print* %e" nil
760 "Evaluate C dereferenced pointer expression at point.")
762 ;; For debugging Emacs only.
763 (gud-def gud-pv "pv1 %e" "\C-v" "Print the value of the lisp variable.")
765 (gud-def gud-until "until %l" "\C-u" "Continue to current line.")
766 (gud-def gud-run "run" nil "Run the program.")
768 (add-hook 'completion-at-point-functions #'gud-gdb-completion-at-point
770 (local-set-key "\C-i" 'completion-at-point)
771 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
772 (setq paragraph-start comint-prompt-regexp)
773 (setq gdb-first-prompt t)
774 (setq gud-running nil)
775 (setq gud-filter-pending-text nil)
776 (run-hooks 'gud-gdb-mode-hook))
778 ;; One of the nice features of GDB is its impressive support for
779 ;; context-sensitive command completion. We preserve that feature
780 ;; in the GUD buffer by using a GDB command designed just for Emacs.
782 ;; The completion process filter indicates when it is finished.
783 (defvar gud-gdb-fetch-lines-in-progress)
785 ;; Since output may arrive in fragments we accumulate partials strings here.
786 (defvar gud-gdb-fetch-lines-string)
788 ;; We need to know how much of the completion to chop off.
789 (defvar gud-gdb-fetch-lines-break)
791 ;; The completion list is constructed by the process filter.
792 (defvar gud-gdb-fetched-lines)
794 (defun gud-gdb-completions (context command)
795 "Completion table for GDB commands.
796 COMMAND is the prefix for which we seek completion.
797 CONTEXT is the text before COMMAND on the line."
798 (let* ((start (- (point) (field-beginning)))
800 (gud-gdb-run-command-fetch-lines (concat "complete " context command)
802 ;; From string-match above.
804 ;; `gud-gdb-run-command-fetch-lines' has some nasty side-effects on the
805 ;; buffer (via `gud-delete-prompt-marker'): it removes the prompt and then
806 ;; re-adds it later, thus messing up markers and overlays along the way.
807 ;; This is a problem for completion-in-region which uses an overlay to
809 ;; So we restore completion-in-region's field if needed.
810 ;; FIXME: change gud-gdb-run-command-fetch-lines so it doesn't modify the
812 (when (/= start (- (point) (field-beginning)))
813 (dolist (ol (overlays-at (1- (point))))
814 (when (eq (overlay-get ol 'field) 'completion)
815 (move-overlay ol (- (point) start) (overlay-end ol)))))
816 ;; Protect against old versions of GDB.
818 (string-match "^Undefined command: \"complete\"" (car complete-list))
819 (error "This version of GDB doesn't support the `complete' command"))
820 ;; Sort the list like readline.
821 (setq complete-list (sort complete-list (function string-lessp)))
822 ;; Remove duplicates.
823 (let ((first complete-list)
824 (second (cdr complete-list)))
826 (if (string-equal (car first) (car second))
827 (setcdr first (setq second (cdr second)))
829 second (cdr second)))))
830 ;; Add a trailing single quote if there is a unique completion
831 ;; and it contains an odd number of unquoted single quotes.
832 (and (= (length complete-list) 1)
833 (let ((str (car complete-list))
836 (while (string-match "\\([^'\\]\\|\\\\'\\)*'" str pos)
837 (setq count (1+ count)
839 (and (= (mod count 2) 1)
840 (setq complete-list (list (concat str "'"))))))
843 (defun gud-gdb-completion-at-point ()
844 "Return the data to complete the GDB command before point."
848 (skip-chars-backward "^ " (comint-line-beginning-position))
851 (completion-table-dynamic
852 (apply-partially #'gud-gdb-completions
853 (buffer-substring (comint-line-beginning-position)
856 ;; (defun gud-gdb-complete-command ()
857 ;; "Perform completion on the GDB command preceding point.
858 ;; This is implemented using the GDB `complete' command which isn't
859 ;; available with older versions of GDB."
861 ;; (apply #'completion-in-region (gud-gdb-completion-at-point)))
863 ;; The completion process filter is installed temporarily to slurp the
864 ;; output of GDB up to the next prompt and build the completion list.
865 (defun gud-gdb-fetch-lines-filter (string filter)
866 "Filter used to read the list of lines output by a command.
867 STRING is the output to filter.
868 It is passed through FILTER before we look at it."
869 (setq string (funcall filter string))
870 (setq string (concat gud-gdb-fetch-lines-string string))
871 (while (string-match "\n" string)
872 (push (substring string gud-gdb-fetch-lines-break (match-beginning 0))
873 gud-gdb-fetched-lines)
874 (setq string (substring string (match-end 0))))
875 (if (string-match comint-prompt-regexp string)
877 (setq gud-gdb-fetch-lines-in-progress nil)
880 (setq gud-gdb-fetch-lines-string string)
883 ;; gdb speedbar functions
885 (defun gud-gdb-goto-stackframe (_text token _indent)
886 "Goto the stackframe described by TEXT, TOKEN, and INDENT."
887 (speedbar-with-attached-buffer
888 (gud-basic-call (concat "server frame " (nth 1 token)))
891 (defvar gud-gdb-fetched-stack-frame nil
892 "Stack frames we are fetching from GDB.")
894 ;(defun gud-gdb-get-scope-data (text token indent)
895 ; ;; checkdoc-params: (indent)
896 ; "Fetch data associated with a stack frame, and expand/contract it.
897 ;Data to do this is retrieved from TEXT and TOKEN."
898 ; (let ((args nil) (scope nil))
899 ; (gud-gdb-run-command-fetch-lines "info args")
901 ; (gud-gdb-run-command-fetch-lines "info local")
905 (defun gud-gdb-get-stackframe (buffer)
906 "Extract the current stack frame out of the GUD GDB BUFFER."
908 (fetched-stack-frame-list
909 (gud-gdb-run-command-fetch-lines "server backtrace" buffer)))
910 (if (and (car fetched-stack-frame-list)
911 (string-match "No stack" (car fetched-stack-frame-list)))
912 ;; Go into some other mode???
914 (dolist (e fetched-stack-frame-list)
915 (let ((name nil) (num nil))
917 (string-match "^#\\([0-9]+\\) +[0-9a-fx]+ in \\([:0-9a-zA-Z_]+\\) (" e)
918 (string-match "^#\\([0-9]+\\) +\\([:0-9a-zA-Z_]+\\) (" e)))
919 (if (not (string-match
920 "at \\([-0-9a-zA-Z_/.]+\\):\\([0-9]+\\)$" e))
923 (list (nth 0 (car newlst))
926 (match-string 2 e))))
927 (setq num (match-string 1 e)
928 name (match-string 2 e))
932 "at \\([-0-9a-zA-Z_/.]+\\):\\([0-9]+\\)$" e)
933 (list name num (match-string 1 e)
939 ;(defun gud-gdb-selected-frame-info (buffer)
940 ; "Learn GDB information for the currently selected stack frame in BUFFER."
943 (defun gud-gdb-run-command-fetch-lines (command buffer &optional skip)
944 "Run COMMAND, and return the list of lines it outputs.
945 BUFFER is the current buffer which may be the GUD buffer in which to run.
946 SKIP is the number of chars to skip on each line, it defaults to 0."
947 (with-current-buffer gud-comint-buffer
948 (if (and (eq gud-comint-buffer buffer)
950 (goto-char (point-max))
952 (not (looking-at comint-prompt-regexp))))
954 ;; Much of this copied from GDB complete, but I'm grabbing the stack
956 (let ((gud-gdb-fetch-lines-in-progress t)
957 (gud-gdb-fetched-lines nil)
958 (gud-gdb-fetch-lines-string nil)
959 (gud-gdb-fetch-lines-break (or skip 0))
962 (gud-gdb-fetch-lines-filter string ',gud-marker-filter))))
963 ;; Issue the command to GDB.
964 (gud-basic-call command)
966 (while gud-gdb-fetch-lines-in-progress
967 (accept-process-output (get-buffer-process gud-comint-buffer)))
968 (nreverse gud-gdb-fetched-lines)))))
971 ;; ======================================================================
974 ;; History of argument lists passed to sdb.
975 (defvar gud-sdb-history nil)
977 (defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
978 "If nil, we're on a System V Release 4 and don't need the tags hack.")
980 (defvar gud-sdb-lastfile nil)
982 (defun gud-sdb-marker-filter (string)
984 (if gud-marker-acc (concat gud-marker-acc string) string))
986 ;; Process all complete markers in this chunk
989 ;; System V Release 3.2 uses this format
990 ((string-match "\\(^\\|\n\\)\\*?\\(0x\\w* in \\)?\\([^:\n]*\\):\\([0-9]*\\):.*\n"
991 gud-marker-acc start)
993 (cons (match-string 3 gud-marker-acc)
994 (string-to-number (match-string 4 gud-marker-acc)))))
995 ;; System V Release 4.0 quite often clumps two lines together
996 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
997 gud-marker-acc start)
998 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc))
1000 (cons gud-sdb-lastfile
1001 (string-to-number (match-string 3 gud-marker-acc)))))
1002 ;; System V Release 4.0
1003 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n"
1004 gud-marker-acc start)
1005 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc)))
1006 ((and gud-sdb-lastfile (string-match "^\\([0-9]+\\):"
1007 gud-marker-acc start))
1008 (setq gud-last-frame
1009 (cons gud-sdb-lastfile
1010 (string-to-number (match-string 1 gud-marker-acc)))))
1012 (setq gud-sdb-lastfile nil)))
1013 (setq start (match-end 0)))
1015 ;; Search for the last incomplete line in this chunk
1016 (while (string-match "\n" gud-marker-acc start)
1017 (setq start (match-end 0)))
1019 ;; If we have an incomplete line, store it in gud-marker-acc.
1020 (setq gud-marker-acc (substring gud-marker-acc (or start 0))))
1023 (defun gud-sdb-find-file (f)
1024 (if gud-sdb-needs-tags (find-tag-noselect f) (find-file-noselect f)))
1027 (defun sdb (command-line)
1028 "Run sdb on program FILE in buffer *gud-FILE*.
1029 The directory containing FILE becomes the initial working directory
1030 and source-file directory for your debugger."
1031 (interactive (list (gud-query-cmdline 'sdb)))
1033 (if gud-sdb-needs-tags (require 'etags))
1034 (if (and gud-sdb-needs-tags
1035 (not (and (boundp 'tags-file-name)
1036 (stringp tags-file-name)
1037 (file-exists-p tags-file-name))))
1038 (error "The sdb support requires a valid tags table to work"))
1040 (gud-common-init command-line nil 'gud-sdb-marker-filter 'gud-sdb-find-file)
1041 (set (make-local-variable 'gud-minor-mode) 'sdb)
1043 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
1044 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
1045 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
1046 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
1047 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
1048 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1049 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1050 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
1052 (setq comint-prompt-regexp "\\(^\\|\n\\)\\*")
1053 (setq paragraph-start comint-prompt-regexp)
1054 (run-hooks 'sdb-mode-hook)
1057 ;; ======================================================================
1060 ;; History of argument lists passed to dbx.
1061 (defvar gud-dbx-history nil)
1063 (defcustom gud-dbx-directories nil
1064 "*A list of directories that dbx should search for source code.
1065 If nil, only source files in the program directory
1066 will be known to dbx.
1068 The file names should be absolute, or relative to the directory
1069 containing the executable being debugged."
1070 :type '(choice (const :tag "Current Directory" nil)
1075 (defun gud-dbx-massage-args (_file args)
1076 (nconc (let ((directories gud-dbx-directories)
1079 (setq result (cons (car directories) (cons "-I" result)))
1080 (setq directories (cdr directories)))
1084 (defun gud-dbx-marker-filter (string)
1085 (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
1088 ;; Process all complete markers in this chunk.
1089 (while (or (string-match
1090 "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
1091 gud-marker-acc start)
1093 "signal .* in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
1094 gud-marker-acc start))
1095 (setq gud-last-frame
1096 (cons (match-string 2 gud-marker-acc)
1097 (string-to-number (match-string 1 gud-marker-acc)))
1098 start (match-end 0)))
1100 ;; Search for the last incomplete line in this chunk
1101 (while (string-match "\n" gud-marker-acc start)
1102 (setq start (match-end 0)))
1104 ;; If the incomplete line APPEARS to begin with another marker, keep it
1105 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1106 ;; unnecessary concat during the next call.
1107 (setq gud-marker-acc
1108 (if (string-match "\\(stopped\\|signal\\)" gud-marker-acc start)
1109 (substring gud-marker-acc (match-beginning 0))
1113 ;; Functions for Mips-style dbx. Given the option `-emacs', documented in
1114 ;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
1116 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
1117 ;; We haven't tested gud on this system:
1118 (string-match "^mips-[^-]*-riscos" system-configuration)
1119 ;; It's documented on OSF/1.3
1120 (string-match "^mips-[^-]*-osf1" system-configuration)
1121 (string-match "^alpha[^-]*-[^-]*-osf" system-configuration))
1122 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
1124 (defvar gud-dbx-command-name
1125 (concat "dbx" (if gud-mips-p " -emacs")))
1127 ;; This is just like the gdb one except for the regexps since we need to cope
1128 ;; with an optional breakpoint number in [] before the ^Z^Z
1129 (defun gud-mipsdbx-marker-filter (string)
1130 (setq gud-marker-acc (concat gud-marker-acc string))
1133 ;; Process all the complete markers in this chunk.
1134 (while (string-match
1135 ;; This is like th gdb marker but with an optional
1136 ;; leading break point number like `[1] '
1137 "[][ 0-9]*\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
1141 ;; Extract the frame position from the marker.
1143 (cons (match-string 1 gud-marker-acc)
1144 (string-to-number (match-string 2 gud-marker-acc)))
1146 ;; Append any text before the marker to the output we're going
1147 ;; to return - we don't include the marker in this text.
1148 output (concat output
1149 (substring gud-marker-acc 0 (match-beginning 0)))
1151 ;; Set the accumulator to the remaining text.
1152 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1154 ;; Does the remaining text look like it might end with the
1155 ;; beginning of another marker? If it does, then keep it in
1156 ;; gud-marker-acc until we receive the rest of it. Since we
1157 ;; know the full marker regexp above failed, it's pretty simple to
1158 ;; test for marker starts.
1159 (if (string-match "[][ 0-9]*\032.*\\'" gud-marker-acc)
1161 ;; Everything before the potential marker start can be output.
1162 (setq output (concat output (substring gud-marker-acc
1163 0 (match-beginning 0))))
1165 ;; Everything after, we save, to combine with later input.
1166 (setq gud-marker-acc
1167 (substring gud-marker-acc (match-beginning 0))))
1169 (setq output (concat output gud-marker-acc)
1174 ;; The dbx in IRIX is a pain. It doesn't print the file name when
1175 ;; stopping at a breakpoint (but you do get it from the `up' and
1176 ;; `down' commands...). The only way to extract the information seems
1177 ;; to be with a `file' command, although the current line number is
1178 ;; available in $curline. Thus we have to look for output which
1179 ;; appears to indicate a breakpoint. Then we prod the dbx sub-process
1180 ;; to output the information we want with a combination of the
1181 ;; `printf' and `file' commands as a pseudo marker which we can
1182 ;; recognise next time through the marker-filter. This would be like
1183 ;; the gdb marker but you can't get the file name without a newline...
1184 ;; Note that gud-remove won't work since Irix dbx expects a breakpoint
1185 ;; number rather than a line number etc. Maybe this could be made to
1186 ;; work by listing all the breakpoints and picking the one(s) with the
1187 ;; correct line number, but life's too short.
1188 ;; d.love@dl.ac.uk (Dave Love) can be blamed for this
1191 (and (string-match "^mips-[^-]*-irix" system-configuration)
1192 (not (string-match "irix[6-9]\\.[1-9]" system-configuration)))
1193 "Non-nil to assume the interface appropriate for IRIX dbx.
1194 This works in IRIX 4, 5 and 6, but `gud-dbx-use-stopformat-p' provides
1195 a better solution in 6.1 upwards.")
1196 (defvar gud-dbx-use-stopformat-p
1197 (string-match "irix[6-9]\\.[1-9]" system-configuration)
1198 "Non-nil to use the dbx feature present at least from Irix 6.1
1199 whereby $stopformat=1 produces an output format compatible with
1200 `gud-dbx-marker-filter'.")
1201 ;; [Irix dbx seems to be a moving target. The dbx output changed
1202 ;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
1203 ;; the output from `up' is no longer spotted by gud (and it's probably
1204 ;; not distinctive enough to try to match it -- use C-<, C->
1205 ;; exclusively) . For 5.3 and 6.0, the $curline variable changed to
1206 ;; `long long'(why?!), so the printf stuff needed changing. The line
1207 ;; number was cast to `long' as a compromise between the new `long
1208 ;; long' and the original `int'. This is reported not to work in 6.2,
1209 ;; so it's changed back to int -- don't make your sources too long.
1210 ;; From Irix6.1 (but not 6.0?) dbx supports an undocumented feature
1211 ;; whereby `set $stopformat=1' reportedly produces output compatible
1212 ;; with `gud-dbx-marker-filter', which we prefer.
1214 ;; The process filter is also somewhat
1215 ;; unreliable, sometimes not spotting the markers; I don't know
1216 ;; whether there's anything that can be done about that. It would be
1217 ;; much better if SGI could be persuaded to (re?)instate the MIPS
1218 ;; -emacs flag for gdb-like output (which ought to be possible as most
1219 ;; of the communication I've had over it has been from sgi.com).]
1221 ;; this filter is influenced by the xdb one rather than the gdb one
1222 (defun gud-irixdbx-marker-filter (string)
1223 (let (result (case-fold-search nil))
1224 (if (or (string-match comint-prompt-regexp string)
1225 (string-match ".*\012" string))
1226 (setq result (concat gud-marker-acc string)
1228 (setq gud-marker-acc (concat gud-marker-acc string)))
1231 ;; look for breakpoint or signal indication e.g.:
1232 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
1233 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
1234 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
1236 "^\\(\\[[0-9]+] \\)?Process +[0-9]+ ([^)]*) [^[]+\\[[^]\n]*]\n"
1238 ;; prod dbx into printing out the line number and file
1239 ;; name in a form we can grok as below
1240 (process-send-string (get-buffer-process gud-comint-buffer)
1241 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1242 ;; look for result of, say, "up" e.g.:
1243 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
1244 ;; (this will also catch one of the lines printed by "where")
1246 "^[^ ][^[]*\\[\"\\([^\"]+\\)\":\\([0-9]+\\), [^]]+]\n"
1248 (let ((file (match-string 1 result)))
1249 (if (file-exists-p file)
1250 (setq gud-last-frame
1251 (cons (match-string 1 result)
1252 (string-to-number (match-string 2 result))))))
1254 ((string-match ; kluged-up marker as above
1255 "\032\032\\([0-9]*\\):\\(.*\\)\n" result)
1256 (let ((file (gud-file-name (match-string 2 result))))
1257 (if (and file (file-exists-p file))
1258 (setq gud-last-frame
1260 (string-to-number (match-string 1 result))))))
1261 (setq result (substring result 0 (match-beginning 0))))))
1264 ;; There are a couple of differences between DG's dbx output and normal
1265 ;; dbx output which make it nontrivial to integrate this into the
1266 ;; standard dbx-marker-filter (mainly, there are a different number of
1267 ;; backreferences). The markers look like:
1269 ;; (0) Stopped at line 10, routine main(argc=1, argv=0xeffff0e0), file t.c
1271 ;; from breakpoints (the `(0)' there isn't constant, it's the breakpoint
1274 ;; Stopped at line 13, routine main(argc=1, argv=0xeffff0e0), file t.c
1278 ;; Frame 21, line 974, routine command_loop(), file keyboard.c
1280 ;; from up/down/where.
1282 (defun gud-dguxdbx-marker-filter (string)
1283 (setq gud-marker-acc (if gud-marker-acc
1284 (concat gud-marker-acc string)
1286 (let ((re (concat "^\\(\\(([0-9]+) \\)?Stopped at\\|Frame [0-9]+,\\)"
1287 " line \\([0-9]+\\), routine .*, file \\([^ \t\n]+\\)"))
1289 ;; Process all complete markers in this chunk.
1290 (while (string-match re gud-marker-acc start)
1291 (setq gud-last-frame
1292 (cons (match-string 4 gud-marker-acc)
1293 (string-to-number (match-string 3 gud-marker-acc)))
1294 start (match-end 0)))
1296 ;; Search for the last incomplete line in this chunk
1297 (while (string-match "\n" gud-marker-acc start)
1298 (setq start (match-end 0)))
1300 ;; If the incomplete line APPEARS to begin with another marker, keep it
1301 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1302 ;; unnecessary concat during the next call.
1303 (setq gud-marker-acc
1304 (if (string-match "Stopped\\|Frame" gud-marker-acc start)
1305 (substring gud-marker-acc (match-beginning 0))
1310 (defun dbx (command-line)
1311 "Run dbx on program FILE in buffer *gud-FILE*.
1312 The directory containing FILE becomes the initial working directory
1313 and source-file directory for your debugger."
1314 (interactive (list (gud-query-cmdline 'dbx)))
1318 (gud-common-init command-line nil 'gud-mipsdbx-marker-filter))
1320 (gud-common-init command-line 'gud-dbx-massage-args
1321 'gud-irixdbx-marker-filter))
1323 (gud-common-init command-line 'gud-dbx-massage-args
1324 'gud-dbx-marker-filter)))
1326 (set (make-local-variable 'gud-minor-mode) 'dbx)
1330 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1331 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1332 (gud-def gud-break "stop at \"%f\":%l"
1333 "\C-b" "Set breakpoint at current line.")
1334 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
1336 (gud-def gud-break "stop at \"%d%f\":%l"
1337 "\C-b" "Set breakpoint at current line.")
1338 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1339 (gud-def gud-up "up %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1340 "<" "Up (numeric arg) stack frames.")
1341 (gud-def gud-down "down %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1342 ">" "Down (numeric arg) stack frames.")
1343 ;; Make dbx give out the source location info that we need.
1344 (process-send-string (get-buffer-process gud-comint-buffer)
1345 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1347 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1348 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1349 (gud-def gud-break "file \"%d%f\"\nstop at %l"
1350 "\C-b" "Set breakpoint at current line.")
1351 (if gud-dbx-use-stopformat-p
1352 (process-send-string (get-buffer-process gud-comint-buffer)
1353 "set $stopformat=1\n"))))
1355 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
1356 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
1357 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
1358 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
1359 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
1360 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
1361 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
1362 (gud-def gud-run "run" nil "Run the program.")
1364 (setq comint-prompt-regexp "^[^)\n]*dbx) *")
1365 (setq paragraph-start comint-prompt-regexp)
1366 (run-hooks 'dbx-mode-hook)
1369 ;; ======================================================================
1370 ;; xdb (HP PARISC debugger) functions
1372 ;; History of argument lists passed to xdb.
1373 (defvar gud-xdb-history nil)
1375 (defcustom gud-xdb-directories nil
1376 "*A list of directories that xdb should search for source code.
1377 If nil, only source files in the program directory
1378 will be known to xdb.
1380 The file names should be absolute, or relative to the directory
1381 containing the executable being debugged."
1382 :type '(choice (const :tag "Current Directory" nil)
1387 (defun gud-xdb-massage-args (_file args)
1388 (nconc (let ((directories gud-xdb-directories)
1391 (setq result (cons (car directories) (cons "-d" result)))
1392 (setq directories (cdr directories)))
1396 ;; xdb does not print the lines all at once, so we have to accumulate them
1397 (defun gud-xdb-marker-filter (string)
1399 (if (or (string-match comint-prompt-regexp string)
1400 (string-match ".*\012" string))
1401 (setq result (concat gud-marker-acc string)
1403 (setq gud-marker-acc (concat gud-marker-acc string)))
1405 (if (or (string-match "\\([^\n \t:]+\\): [^:]+: \\([0-9]+\\)[: ]"
1407 (string-match "[^: \t]+:[ \t]+\\([^:]+\\): [^:]+: \\([0-9]+\\):"
1409 (let ((line (string-to-number (match-string 2 result)))
1410 (file (gud-file-name (match-string 1 result))))
1412 (setq gud-last-frame (cons file line))))))
1416 (defun xdb (command-line)
1417 "Run xdb on program FILE in buffer *gud-FILE*.
1418 The directory containing FILE becomes the initial working directory
1419 and source-file directory for your debugger.
1421 You can set the variable `gud-xdb-directories' to a list of program source
1422 directories if your program contains sources from more than one directory."
1423 (interactive (list (gud-query-cmdline 'xdb)))
1425 (gud-common-init command-line 'gud-xdb-massage-args
1426 'gud-xdb-marker-filter)
1427 (set (make-local-variable 'gud-minor-mode) 'xdb)
1429 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
1430 (gud-def gud-tbreak "b %f:%l\\t" "\C-t"
1431 "Set temporary breakpoint at current line.")
1432 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
1433 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
1434 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1435 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1436 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1437 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1438 (gud-def gud-finish "bu\\t" "\C-f" "Finish executing current function.")
1439 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
1441 (setq comint-prompt-regexp "^>")
1442 (setq paragraph-start comint-prompt-regexp)
1443 (run-hooks 'xdb-mode-hook))
1445 ;; ======================================================================
1448 ;; History of argument lists passed to perldb.
1449 (defvar gud-perldb-history nil)
1451 (defun gud-perldb-massage-args (_file args)
1452 "Convert a command line as would be typed normally to run perldb
1453 into one that invokes an Emacs-enabled debugging session.
1454 \"-emacs\" is inserted where it will be $ARGV[0] (see perl5db.pl)."
1455 ;; FIXME: what if the command is `make perldb' and doesn't accept those extra
1457 (let* ((new-args nil)
1459 (shift (lambda () (push (pop args) new-args))))
1461 ;; Pass all switches and -e scripts through.
1463 (string-match "^-" (car args))
1464 (not (equal "-" (car args)))
1465 (not (equal "--" (car args))))
1466 (when (equal "-e" (car args))
1467 ;; -e goes with the next arg, so shift one extra.
1469 ;; -e as the last arg is an error in Perl.
1470 (error "No code specified for -e"))
1476 (string-match "^-" (car args)))
1477 (error "Can't use stdin as the script to debug"))
1478 ;; This is the program name.
1481 ;; If -e specified, make sure there is a -- so -emacs is not taken
1483 (if (and args (equal "--" (car args)))
1485 (and seen-e (push "--" new-args)))
1487 (push "-emacs" new-args)
1491 (nreverse new-args)))
1493 ;; There's no guarantee that Emacs will hand the filter the entire
1494 ;; marker at once; it could be broken up across several strings. We
1495 ;; might even receive a big chunk with several markers in it. If we
1496 ;; receive a chunk of text which looks like it might contain the
1497 ;; beginning of a marker, we save it here between calls to the
1499 (defun gud-perldb-marker-filter (string)
1500 (setq gud-marker-acc (concat gud-marker-acc string))
1503 ;; Process all the complete markers in this chunk.
1504 (while (string-match "\032\032\\(\\([a-zA-Z]:\\)?[^:\n]*\\):\\([0-9]*\\):.*\n"
1508 ;; Extract the frame position from the marker.
1510 (cons (match-string 1 gud-marker-acc)
1511 (string-to-number (match-string 3 gud-marker-acc)))
1513 ;; Append any text before the marker to the output we're going
1514 ;; to return - we don't include the marker in this text.
1515 output (concat output
1516 (substring gud-marker-acc 0 (match-beginning 0)))
1518 ;; Set the accumulator to the remaining text.
1519 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1521 ;; Does the remaining text look like it might end with the
1522 ;; beginning of another marker? If it does, then keep it in
1523 ;; gud-marker-acc until we receive the rest of it. Since we
1524 ;; know the full marker regexp above failed, it's pretty simple to
1525 ;; test for marker starts.
1526 (if (string-match "\032.*\\'" gud-marker-acc)
1528 ;; Everything before the potential marker start can be output.
1529 (setq output (concat output (substring gud-marker-acc
1530 0 (match-beginning 0))))
1532 ;; Everything after, we save, to combine with later input.
1533 (setq gud-marker-acc
1534 (substring gud-marker-acc (match-beginning 0))))
1536 (setq output (concat output gud-marker-acc)
1541 (defcustom gud-perldb-command-name "perl -d"
1542 "Default command to execute a Perl script under debugger."
1547 (defun perldb (command-line)
1548 "Run perldb on program FILE in buffer *gud-FILE*.
1549 The directory containing FILE becomes the initial working directory
1550 and source-file directory for your debugger."
1552 (list (gud-query-cmdline 'perldb
1553 (concat (or (buffer-file-name) "-e 0") " "))))
1555 (gud-common-init command-line 'gud-perldb-massage-args
1556 'gud-perldb-marker-filter)
1557 (set (make-local-variable 'gud-minor-mode) 'perldb)
1559 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
1560 (gud-def gud-remove "B %l" "\C-d" "Remove breakpoint at current line")
1561 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
1562 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
1563 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1564 ; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
1565 ; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
1566 ; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
1567 (gud-def gud-print "p %e" "\C-p" "Evaluate perl expression at point.")
1568 (gud-def gud-until "c %l" "\C-u" "Continue to current line.")
1571 (setq comint-prompt-regexp "^ DB<+[0-9]+>+ ")
1572 (setq paragraph-start comint-prompt-regexp)
1573 (run-hooks 'perldb-mode-hook))
1575 ;; ======================================================================
1576 ;; pdb (Python debugger) functions
1578 ;; History of argument lists passed to pdb.
1579 (defvar gud-pdb-history nil)
1581 ;; Last group is for return value, e.g. "> test.py(2)foo()->None"
1582 ;; Either file or function name may be omitted: "> <string>(0)?()"
1583 (defvar gud-pdb-marker-regexp
1584 "^> \\([-a-zA-Z0-9_/.:\\]*\\|<string>\\)(\\([0-9]+\\))\\([a-zA-Z0-9_]*\\|\\?\\|<module>\\)()\\(->[^\n]*\\)?\n")
1585 (defvar gud-pdb-marker-regexp-file-group 1)
1586 (defvar gud-pdb-marker-regexp-line-group 2)
1587 (defvar gud-pdb-marker-regexp-fnname-group 3)
1589 (defvar gud-pdb-marker-regexp-start "^> ")
1591 ;; There's no guarantee that Emacs will hand the filter the entire
1592 ;; marker at once; it could be broken up across several strings. We
1593 ;; might even receive a big chunk with several markers in it. If we
1594 ;; receive a chunk of text which looks like it might contain the
1595 ;; beginning of a marker, we save it here between calls to the
1597 (defun gud-pdb-marker-filter (string)
1598 (setq gud-marker-acc (concat gud-marker-acc string))
1601 ;; Process all the complete markers in this chunk.
1602 (while (string-match gud-pdb-marker-regexp gud-marker-acc)
1605 ;; Extract the frame position from the marker.
1607 (let ((file (match-string gud-pdb-marker-regexp-file-group
1609 (line (string-to-number
1610 (match-string gud-pdb-marker-regexp-line-group
1612 (if (string-equal file "<string>")
1616 ;; Output everything instead of the below
1617 output (concat output (substring gud-marker-acc 0 (match-end 0)))
1618 ;; ;; Append any text before the marker to the output we're going
1619 ;; ;; to return - we don't include the marker in this text.
1620 ;; output (concat output
1621 ;; (substring gud-marker-acc 0 (match-beginning 0)))
1623 ;; Set the accumulator to the remaining text.
1624 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1626 ;; Does the remaining text look like it might end with the
1627 ;; beginning of another marker? If it does, then keep it in
1628 ;; gud-marker-acc until we receive the rest of it. Since we
1629 ;; know the full marker regexp above failed, it's pretty simple to
1630 ;; test for marker starts.
1631 (if (string-match gud-pdb-marker-regexp-start gud-marker-acc)
1633 ;; Everything before the potential marker start can be output.
1634 (setq output (concat output (substring gud-marker-acc
1635 0 (match-beginning 0))))
1637 ;; Everything after, we save, to combine with later input.
1638 (setq gud-marker-acc
1639 (substring gud-marker-acc (match-beginning 0))))
1641 (setq output (concat output gud-marker-acc)
1646 (defcustom gud-pdb-command-name "pdb"
1647 "File name for executing the Python debugger.
1648 This should be an executable on your path, or an absolute file name."
1653 (defun pdb (command-line)
1654 "Run pdb on program FILE in buffer `*gud-FILE*'.
1655 The directory containing FILE becomes the initial working directory
1656 and source-file directory for your debugger."
1658 (list (gud-query-cmdline 'pdb)))
1660 (gud-common-init command-line nil 'gud-pdb-marker-filter)
1661 (set (make-local-variable 'gud-minor-mode) 'pdb)
1663 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
1664 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
1665 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
1666 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
1667 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
1668 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1669 (gud-def gud-up "up" "<" "Up one stack frame.")
1670 (gud-def gud-down "down" ">" "Down one stack frame.")
1671 (gud-def gud-print "p %e" "\C-p" "Evaluate Python expression at point.")
1673 (gud-def gud-statement "! %e" "\C-e" "Execute Python statement at point.")
1675 ;; (setq comint-prompt-regexp "^(.*pdb[+]?) *")
1676 (setq comint-prompt-regexp "^(Pdb) *")
1677 (setq paragraph-start comint-prompt-regexp)
1678 (run-hooks 'pdb-mode-hook))
1680 ;; ======================================================================
1684 ;; AUTHOR: Derek Davies <ddavies@world.std.com>
1685 ;; Zoltan Kemenczy <zoltan@ieee.org;zkemenczy@rim.net>
1687 ;; CREATED: Sun Feb 22 10:46:38 1998 Derek Davies.
1688 ;; UPDATED: Nov 11, 2001 Zoltan Kemenczy
1689 ;; Dec 10, 2002 Zoltan Kemenczy - added nested class support
1691 ;; INVOCATION NOTES:
1693 ;; You invoke jdb-mode with:
1697 ;; It responds with:
1699 ;; Run jdb (like this): jdb
1701 ;; type any jdb switches followed by the name of the class you'd like to debug.
1702 ;; Supply a fully qualfied classname (these do not have the ".class" extension)
1703 ;; for the name of the class to debug (e.g. "COM.the-kind.ddavies.CoolClass").
1704 ;; See the known problems section below for restrictions when specifying jdb
1705 ;; command line switches (search forward for '-classpath').
1707 ;; You should see something like the following:
1709 ;; Current directory is ~/src/java/hello/
1710 ;; Initializing jdb...
1711 ;; 0xed2f6628:class(hello)
1714 ;; To set an initial breakpoint try:
1716 ;; > stop in hello.main
1717 ;; Breakpoint set in hello.main
1720 ;; To execute the program type:
1725 ;; Breakpoint hit: running ...
1726 ;; hello.main (hello:12)
1728 ;; Type M-n to step over the current line and M-s to step into it. That,
1729 ;; along with the JDB 'help' command should get you started. The 'quit'
1730 ;; JDB command will get out out of the debugger. There is some truly
1731 ;; pathetic JDB documentation available at:
1733 ;; http://java.sun.com/products/jdk/1.1/debugging/
1735 ;; KNOWN PROBLEMS AND FIXME's:
1737 ;; Not sure what happens with inner classes ... haven't tried them.
1739 ;; Does not grok UNICODE id's. Only ASCII id's are supported.
1741 ;; You must not put whitespace between "-classpath" and the path to
1742 ;; search for java classes even though it is required when invoking jdb
1743 ;; from the command line. See gud-jdb-massage-args for details.
1744 ;; The same applies for "-sourcepath".
1746 ;; Note: The following applies only if `gud-jdb-use-classpath' is nil;
1747 ;; refer to the documentation of `gud-jdb-use-classpath' and
1748 ;; `gud-jdb-classpath',`gud-jdb-sourcepath' variables for information
1749 ;; on using the classpath for locating java source files.
1751 ;; If any of the source files in the directories listed in
1752 ;; gud-jdb-directories won't parse you'll have problems. Make sure
1753 ;; every file ending in ".java" in these directories parses without error.
1755 ;; All the .java files in the directories in gud-jdb-directories are
1756 ;; syntactically analyzed each time gud jdb is invoked. It would be
1757 ;; nice to keep as much information as possible between runs. It would
1758 ;; be really nice to analyze the files only as neccessary (when the
1759 ;; source needs to be displayed.) I'm not sure to what extent the former
1760 ;; can be accomplished and I'm not sure the latter can be done at all
1761 ;; since I don't know of any general way to tell which .class files are
1762 ;; defined by which .java file without analyzing all the .java files.
1763 ;; If anyone knows why JavaSoft didn't put the source file names in
1764 ;; debuggable .class files please clue me in so I find something else
1765 ;; to be spiteful and bitter about.
1767 ;; ======================================================================
1768 ;; gud jdb variables and functions
1770 (defcustom gud-jdb-command-name "jdb"
1771 "Command that executes the Java debugger."
1775 (defcustom gud-jdb-use-classpath t
1776 "If non-nil, search for Java source files in classpath directories.
1777 The list of directories to search is the value of `gud-jdb-classpath'.
1778 The file pathname is obtained by converting the fully qualified
1779 class information output by jdb to a relative pathname and appending
1780 it to `gud-jdb-classpath' element by element until a match is found.
1782 This method has a significant jdb startup time reduction advantage
1783 since it does not require the scanning of all `gud-jdb-directories'
1784 and parsing all Java files for class information.
1786 Set to nil to use `gud-jdb-directories' to scan java sources for
1787 class information on jdb startup (original method)."
1791 (defvar gud-jdb-classpath nil
1792 "Java/jdb classpath directories list.
1793 If `gud-jdb-use-classpath' is non-nil, gud-jdb derives the `gud-jdb-classpath'
1794 list automatically using the following methods in sequence
1795 \(with subsequent successful steps overriding the results of previous
1798 1) Read the CLASSPATH environment variable,
1799 2) Read any \"-classpath\" argument used to run jdb,
1800 or detected in jdb output (e.g. if jdb is run by a script
1801 that echoes the actual jdb command before starting jdb),
1802 3) Send a \"classpath\" command to jdb and scan jdb output for
1803 classpath information if jdb is invoked with an \"-attach\" (to
1804 an already running VM) argument (This case typically does not
1805 have a \"-classpath\" command line argument - that is provided
1806 to the VM when it is started).
1808 Note that method 3 cannot be used with oldjdb (or Java 1 jdb) since
1809 those debuggers do not support the classpath command. Use 1) or 2).")
1811 (defvar gud-jdb-sourcepath nil
1812 "Directory list provided by an (optional) \"-sourcepath\" option to jdb.
1813 This list is prepended to `gud-jdb-classpath' to form the complete
1814 list of directories searched for source files.")
1816 (defvar gud-marker-acc-max-length 4000
1817 "Maximum number of debugger output characters to keep.
1818 This variable limits the size of `gud-marker-acc' which holds
1819 the most recent debugger output history while searching for
1820 source file information.")
1822 (defvar gud-jdb-history nil
1823 "History of argument lists passed to jdb.")
1826 ;; List of Java source file directories.
1827 (defvar gud-jdb-directories (list ".")
1828 "*A list of directories that gud jdb should search for source code.
1829 The file names should be absolute, or relative to the current
1832 The set of .java files residing in the directories listed are
1833 syntactically analyzed to determine the classes they define and the
1834 packages in which these classes belong. In this way gud jdb maps the
1835 package-qualified class names output by the jdb debugger to the source
1836 file from which the class originated. This allows gud mode to keep
1837 the source code display in sync with the debugging session.")
1839 (defvar gud-jdb-source-files nil
1840 "List of the java source files for this debugging session.")
1842 ;; Association list of fully qualified class names (package + class name)
1843 ;; and their source files.
1844 (defvar gud-jdb-class-source-alist nil
1845 "Association list of fully qualified class names and source files.")
1847 ;; This is used to hold a source file during analysis.
1848 (defvar gud-jdb-analysis-buffer nil)
1850 (defvar gud-jdb-classpath-string nil
1851 "Holds temporary classpath values.")
1853 (defun gud-jdb-build-source-files-list (path extn)
1854 "Return a list of java source files (absolute paths).
1855 PATH gives the directories in which to search for files with
1856 extension EXTN. Normally EXTN is given as the regular expression
1858 (apply 'nconc (mapcar (lambda (d)
1859 (when (file-directory-p d)
1860 (directory-files d t extn nil)))
1863 ;; Move point past whitespace.
1864 (defun gud-jdb-skip-whitespace ()
1865 (skip-chars-forward " \n\r\t\014"))
1867 ;; Move point past a "// <eol>" type of comment.
1868 (defun gud-jdb-skip-single-line-comment ()
1871 ;; Move point past a "/* */" or "/** */" type of comment.
1872 (defun gud-jdb-skip-traditional-or-documentation-comment ()
1876 (if (eq (following-char) ?*)
1880 (if (eq (following-char) ?/)
1883 (throw 'break nil)))))
1886 ;; Move point past any number of consecutive whitespace chars and/or comments.
1887 (defun gud-jdb-skip-whitespace-and-comments ()
1888 (gud-jdb-skip-whitespace)
1893 (gud-jdb-skip-single-line-comment)
1894 (gud-jdb-skip-whitespace))
1895 ((looking-at "/\\*")
1896 (gud-jdb-skip-traditional-or-documentation-comment)
1897 (gud-jdb-skip-whitespace))
1898 (t (throw 'done nil))))))
1900 ;; Move point past things that are id-like. The intent is to skip regular
1901 ;; id's, such as class or interface names as well as package and interface
1903 (defun gud-jdb-skip-id-ish-thing ()
1904 (skip-chars-forward "^ /\n\r\t\014,;{"))
1906 ;; Move point past a string literal.
1907 (defun gud-jdb-skip-string-literal ()
1910 ((eq (following-char) ?\\)
1912 ((eq (following-char) ?\042))))
1916 ;; Move point past a character literal.
1917 (defun gud-jdb-skip-character-literal ()
1921 (if (eq (following-char) ?\\)
1923 (not (eq (following-char) ?\')))
1927 ;; Move point past the following block. There may be (legal) cruft before
1928 ;; the block's opening brace. There must be a block or it's the end of life
1929 ;; in petticoat junction.
1930 (defun gud-jdb-skip-block ()
1932 ;; Find the begining of the block.
1934 (not (eq (following-char) ?{))
1936 ;; Skip any constructs that can harbor literal block delimiter
1937 ;; characters and/or the delimiters for the constructs themselves.
1940 (gud-jdb-skip-single-line-comment))
1941 ((looking-at "/\\*")
1942 (gud-jdb-skip-traditional-or-documentation-comment))
1943 ((eq (following-char) ?\042)
1944 (gud-jdb-skip-string-literal))
1945 ((eq (following-char) ?\')
1946 (gud-jdb-skip-character-literal))
1947 (t (forward-char))))
1949 ;; Now at the begining of the block.
1952 ;; Skip over the body of the block as well as the final brace.
1953 (let ((open-level 1))
1954 (while (not (eq open-level 0))
1957 (gud-jdb-skip-single-line-comment))
1958 ((looking-at "/\\*")
1959 (gud-jdb-skip-traditional-or-documentation-comment))
1960 ((eq (following-char) ?\042)
1961 (gud-jdb-skip-string-literal))
1962 ((eq (following-char) ?\')
1963 (gud-jdb-skip-character-literal))
1964 ((eq (following-char) ?{)
1965 (setq open-level (+ open-level 1))
1967 ((eq (following-char) ?})
1968 (setq open-level (- open-level 1))
1970 (t (forward-char))))))
1972 ;; Find the package and class definitions in Java source file FILE. Assumes
1973 ;; that FILE contains a legal Java program. BUF is a scratch buffer used
1974 ;; to hold the source during analysis.
1975 (defun gud-jdb-analyze-source (buf file)
1978 (insert-file-contents file nil nil nil t)
1983 (gud-jdb-skip-whitespace)
1987 ;; Any number of semi's following a block is legal. Move point
1988 ;; past them. Note that comments and whitespace may be
1989 ;; interspersed as well.
1990 ((eq (following-char) ?\073)
1993 ;; Move point past a single line comment.
1995 (gud-jdb-skip-single-line-comment))
1997 ;; Move point past a traditional or documentation comment.
1998 ((looking-at "/\\*")
1999 (gud-jdb-skip-traditional-or-documentation-comment))
2001 ;; Move point past a package statement, but save the PackageName.
2002 ((looking-at "package")
2004 (gud-jdb-skip-whitespace-and-comments)
2006 (gud-jdb-skip-id-ish-thing)
2007 (setq p (concat (buffer-substring s (point)) "."))
2008 (gud-jdb-skip-whitespace-and-comments)
2009 (if (eq (following-char) ?\073)
2012 ;; Move point past an import statement.
2013 ((looking-at "import")
2015 (gud-jdb-skip-whitespace-and-comments)
2016 (gud-jdb-skip-id-ish-thing)
2017 (gud-jdb-skip-whitespace-and-comments)
2018 (if (eq (following-char) ?\073)
2021 ;; Move point past the various kinds of ClassModifiers.
2022 ((looking-at "public")
2024 ((looking-at "abstract")
2026 ((looking-at "final")
2029 ;; Move point past a ClassDeclaraction, but save the class
2031 ((looking-at "class")
2033 (gud-jdb-skip-whitespace-and-comments)
2035 (gud-jdb-skip-id-ish-thing)
2037 l (nconc l (list (concat p (buffer-substring s (point)))))))
2038 (gud-jdb-skip-block))
2040 ;; Move point past an interface statement.
2041 ((looking-at "interface")
2043 (gud-jdb-skip-block))
2045 ;; Anything else means the input is invalid.
2047 (message "Error parsing file %s." file)
2048 (throw 'abort nil))))))
2051 (defun gud-jdb-build-class-source-alist-for-file (file)
2055 (gud-jdb-analyze-source gud-jdb-analysis-buffer file)))
2057 ;; Return an alist of fully qualified classes and the source files
2058 ;; holding their definitions. SOURCES holds a list of all the source
2059 ;; files to examine.
2060 (defun gud-jdb-build-class-source-alist (sources)
2061 (setq gud-jdb-analysis-buffer (get-buffer-create " *gud-jdb-scratch*"))
2066 'gud-jdb-build-class-source-alist-for-file
2068 (kill-buffer gud-jdb-analysis-buffer)
2069 (setq gud-jdb-analysis-buffer nil)))
2071 ;; Change what was given in the minibuffer to something that can be used to
2072 ;; invoke the debugger.
2073 (defun gud-jdb-massage-args (_file args)
2074 ;; The jdb executable must have whitespace between "-classpath" and
2075 ;; its value while gud-common-init expects all switch values to
2076 ;; follow the switch keyword without intervening whitespace. We
2077 ;; require that when the user enters the "-classpath" switch in the
2078 ;; EMACS minibuffer that they do so without the intervening
2079 ;; whitespace. This function adds it back (it's called after
2080 ;; gud-common-init). There are more switches like this (for
2081 ;; instance "-host" and "-password") but I don't care about them
2084 (let (massaged-args user-error)
2086 (while (and args (not user-error))
2088 ((setq user-error (string-match "-classpath$" (car args))))
2089 ((setq user-error (string-match "-sourcepath$" (car args))))
2090 ((string-match "-classpath\\(.+\\)" (car args))
2092 (append massaged-args
2094 (setq gud-jdb-classpath-string
2095 (match-string 1 (car args)))))))
2096 ((string-match "-sourcepath\\(.+\\)" (car args))
2098 (append massaged-args
2100 (setq gud-jdb-sourcepath
2101 (match-string 1 (car args)))))))
2102 (t (setq massaged-args (append massaged-args (list (car args))))))
2103 (setq args (cdr args)))
2105 ;; By this point the current directory is all screwed up. Maybe we
2106 ;; could fix things and re-invoke gud-common-init, but for now I think
2107 ;; issueing the error is good enough.
2110 (kill-buffer (current-buffer))
2111 (error "Error: Omit whitespace between '-classpath or -sourcepath' and its value")))
2114 ;; Search for an association with P, a fully qualified class name, in
2115 ;; gud-jdb-class-source-alist. The asssociation gives the fully
2116 ;; qualified file name of the source file which produced the class.
2117 (defun gud-jdb-find-source-file (p)
2118 (cdr (assoc p gud-jdb-class-source-alist)))
2120 ;; Note: Reset to this value every time a prompt is seen
2121 (defvar gud-jdb-lowest-stack-level 999)
2123 (defun gud-jdb-find-source-using-classpath (p)
2124 "Find source file corresponding to fully qualified class P.
2125 Convert P from jdb's output, converted to a pathname
2126 relative to a classpath directory."
2129 (;; Replace dots with slashes and append ".java" to generate file
2130 ;; name relative to classpath
2133 (mapconcat 'identity
2135 ;; Eliminate any subclass references in the class
2136 ;; name string. These start with a "$"
2138 (if (string-match "$.*" x)
2139 (replace-match "" t t x) p))
2143 (cplist (append gud-jdb-sourcepath gud-jdb-classpath))
2146 (not (setq found-file
2148 (concat (car cplist) "/" filename)))))
2149 (setq cplist (cdr cplist)))
2150 (if found-file (concat (car cplist) "/" filename)))))
2152 (defun gud-jdb-find-source (_string)
2153 "Alias for function used to locate source files.
2154 Set to `gud-jdb-find-source-using-classpath' or `gud-jdb-find-source-file'
2155 during jdb initialization depending on the value of
2156 `gud-jdb-use-classpath'."
2159 (defun gud-jdb-parse-classpath-string (string)
2160 "Parse the classpath list and convert each item to an absolute pathname."
2161 (mapcar (lambda (s) (if (string-match "[/\\]$" s)
2162 (replace-match "" nil nil s) s))
2163 (mapcar 'file-truename
2166 (concat "[ \t\n\r,\"" path-separator "]+")))))
2168 ;; See comentary for other debugger's marker filters - there you will find
2169 ;; important notes about STRING.
2170 (defun gud-jdb-marker-filter (string)
2172 ;; Build up the accumulator.
2173 (setq gud-marker-acc
2175 (concat gud-marker-acc string)
2178 ;; Look for classpath information until gud-jdb-classpath-string is found
2179 ;; (interactive, multiple settings of classpath from jdb
2180 ;; not supported/followed)
2181 (if (and gud-jdb-use-classpath
2182 (not gud-jdb-classpath-string)
2183 (or (string-match "classpath:[ \t[]+\\([^]]+\\)" gud-marker-acc)
2184 (string-match "-classpath[ \t\"]+\\([^ \"]+\\)" gud-marker-acc)))
2185 (setq gud-jdb-classpath
2186 (gud-jdb-parse-classpath-string
2187 (setq gud-jdb-classpath-string
2188 (match-string 1 gud-marker-acc)))))
2190 ;; We process STRING from left to right. Each time through the
2191 ;; following loop we process at most one marker. After we've found a
2192 ;; marker, delete gud-marker-acc up to and including the match
2194 ;; Process each complete marker in the input.
2197 ;; Do we see a marker?
2199 ;; jdb puts out a string of the following form when it
2200 ;; hits a breakpoint:
2202 ;; <fully-qualified-class><method> (<class>:<line-number>)
2204 ;; <fully-qualified-class>'s are composed of Java ID's
2205 ;; separated by periods. <method> and <class> are
2206 ;; also Java ID's. <method> begins with a period and
2207 ;; may contain less-than and greater-than (constructors,
2208 ;; for instance, are called <init> in the symbol table.)
2209 ;; Java ID's begin with a letter followed by letters
2210 ;; and/or digits. The set of letters includes underscore
2213 ;; The first group matches <fully-qualified-class>,
2214 ;; the second group matches <class> and the third group
2215 ;; matches <line-number>. We don't care about using
2216 ;; <method> so we don't "group" it.
2218 ;; FIXME: Java ID's are UNICODE strings, this matches ASCII
2221 ;; The ".," in the last square-bracket are necessary because
2222 ;; of Sun's total disrespect for backwards compatibility in
2223 ;; reported line numbers from jdb - starting in 1.4.0 they
2224 ;; print line numbers using LOCALE, inserting a comma or a
2225 ;; period at the thousands positions (how ingenious!).
2227 "\\(\\[[0-9]+] \\)*\\([a-zA-Z0-9.$_]+\\)\\.[a-zA-Z0-9$_<>(),]+ \
2228 \\(([a-zA-Z0-9.$_]+:\\|line=\\)\\([0-9.,]+\\)"
2231 ;; A good marker is one that:
2232 ;; 1) does not have a "[n] " prefix (not part of a stack backtrace)
2233 ;; 2) does have an "[n] " prefix and n is the lowest prefix seen
2234 ;; since the last prompt
2235 ;; Figure out the line on which to position the debugging arrow.
2236 ;; Return the info as a cons of the form:
2238 ;; (<file-name> . <line-number>) .
2239 (if (if (match-beginning 1)
2241 (setq n (string-to-number (substring
2243 (1+ (match-beginning 1))
2244 (- (match-end 1) 2))))
2245 (if (< n gud-jdb-lowest-stack-level)
2246 (progn (setq gud-jdb-lowest-stack-level n) t)))
2248 (if (setq file-found
2249 (gud-jdb-find-source (match-string 2 gud-marker-acc)))
2250 (setq gud-last-frame
2254 ((numstr (match-string 4 gud-marker-acc)))
2255 (if (string-match "[.,]" numstr)
2256 (replace-match "" nil nil numstr)
2258 (message "Could not find source file.")))
2260 ;; Set the accumulator to the remaining text.
2261 (setq gud-marker-acc (substring gud-marker-acc (match-end 0))))
2263 (if (string-match comint-prompt-regexp gud-marker-acc)
2264 (setq gud-jdb-lowest-stack-level 999)))
2266 ;; Do not allow gud-marker-acc to grow without bound. If the source
2267 ;; file information is not within the last 3/4
2268 ;; gud-marker-acc-max-length characters, well,...
2269 (if (> (length gud-marker-acc) gud-marker-acc-max-length)
2270 (setq gud-marker-acc
2271 (substring gud-marker-acc
2272 (- (/ (* gud-marker-acc-max-length 3) 4)))))
2274 ;; We don't filter any debugger output so just return what we were given.
2277 (defvar gud-jdb-command-name "jdb" "Command that executes the Java debugger.")
2280 (defun jdb (command-line)
2281 "Run jdb with command line COMMAND-LINE in a buffer.
2282 The buffer is named \"*gud*\" if no initial class is given or
2283 \"*gud-<initial-class-basename>*\" if there is. If the \"-classpath\"
2284 switch is given, omit all whitespace between it and its value.
2286 See `gud-jdb-use-classpath' and `gud-jdb-classpath' documentation for
2287 information on how jdb accesses source files. Alternatively (if
2288 `gud-jdb-use-classpath' is nil), see `gud-jdb-directories' for the
2289 original source file access method.
2291 For general information about commands available to control jdb from
2292 gud, see `gud-mode'."
2294 (list (gud-query-cmdline 'jdb)))
2295 (setq gud-jdb-classpath nil)
2296 (setq gud-jdb-sourcepath nil)
2298 ;; Set gud-jdb-classpath from the CLASSPATH environment variable,
2299 ;; if CLASSPATH is set.
2300 (setq gud-jdb-classpath-string (or (getenv "CLASSPATH") "."))
2301 (if gud-jdb-classpath-string
2302 (setq gud-jdb-classpath
2303 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2304 (setq gud-jdb-classpath-string nil) ; prepare for next
2306 (gud-common-init command-line 'gud-jdb-massage-args
2307 'gud-jdb-marker-filter)
2308 (set (make-local-variable 'gud-minor-mode) 'jdb)
2310 ;; If a -classpath option was provided, set gud-jdb-classpath
2311 (if gud-jdb-classpath-string
2312 (setq gud-jdb-classpath
2313 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2314 (setq gud-jdb-classpath-string nil) ; prepare for next
2315 ;; If a -sourcepath option was provided, parse it
2316 (if gud-jdb-sourcepath
2317 (setq gud-jdb-sourcepath
2318 (gud-jdb-parse-classpath-string gud-jdb-sourcepath)))
2320 (gud-def gud-break "stop at %c:%l" "\C-b" "Set breakpoint at current line.")
2321 (gud-def gud-remove "clear %c:%l" "\C-d" "Remove breakpoint at current line")
2322 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2323 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2324 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
2325 (gud-def gud-finish "step up" "\C-f" "Continue until current method returns.")
2326 (gud-def gud-up "up\C-Mwhere" "<" "Up one stack frame.")
2327 (gud-def gud-down "down\C-Mwhere" ">" "Up one stack frame.")
2328 (gud-def gud-run "run" nil "Run the program.") ;if VM start using jdb
2329 (gud-def gud-print "print %e" "\C-p" "Print value of expression at point.")
2330 (gud-def gud-pstar "dump %e" nil "Print all object information at point.")
2332 (setq comint-prompt-regexp "^> \\|^[^ ]+\\[[0-9]+\\] ")
2333 (setq paragraph-start comint-prompt-regexp)
2334 (run-hooks 'jdb-mode-hook)
2336 (if gud-jdb-use-classpath
2337 ;; Get the classpath information from the debugger
2339 (if (string-match "-attach" command-line)
2340 (gud-call "classpath"))
2341 (fset 'gud-jdb-find-source
2342 'gud-jdb-find-source-using-classpath))
2344 ;; Else create and bind the class/source association list as well
2345 ;; as the source file list.
2346 (setq gud-jdb-class-source-alist
2347 (gud-jdb-build-class-source-alist
2348 (setq gud-jdb-source-files
2349 (gud-jdb-build-source-files-list gud-jdb-directories
2351 (fset 'gud-jdb-find-source 'gud-jdb-find-source-file)))
2354 ;; End of debugger-specific information
2358 ;; When we send a command to the debugger via gud-call, it's annoying
2359 ;; to see the command and the new prompt inserted into the debugger's
2360 ;; buffer; we have other ways of knowing the command has completed.
2362 ;; If the buffer looks like this:
2363 ;; --------------------
2364 ;; (gdb) set args foo bar
2366 ;; --------------------
2367 ;; (the -!- marks the location of point), and we type `C-x SPC' in a
2368 ;; source file to set a breakpoint, we want the buffer to end up like
2370 ;; --------------------
2371 ;; (gdb) set args foo bar
2372 ;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
2374 ;; --------------------
2375 ;; Essentially, the old prompt is deleted, and the command's output
2376 ;; and the new prompt take its place.
2378 ;; Not echoing the command is easy enough; you send it directly using
2379 ;; process-send-string, and it never enters the buffer. However,
2380 ;; getting rid of the old prompt is trickier; you don't want to do it
2381 ;; when you send the command, since that will result in an annoying
2382 ;; flicker as the prompt is deleted, redisplay occurs while Emacs
2383 ;; waits for a response from the debugger, and the new prompt is
2384 ;; inserted. Instead, we'll wait until we actually get some output
2385 ;; from the subprocess before we delete the prompt. If the command
2386 ;; produced no output other than a new prompt, that prompt will most
2387 ;; likely be in the first chunk of output received, so we will delete
2388 ;; the prompt and then replace it with an identical one. If the
2389 ;; command produces output, the prompt is moving anyway, so the
2390 ;; flicker won't be annoying.
2392 ;; So - when we want to delete the prompt upon receipt of the next
2393 ;; chunk of debugger output, we position gud-delete-prompt-marker at
2394 ;; the start of the prompt; the process filter will notice this, and
2395 ;; delete all text between it and the process output marker. If
2396 ;; gud-delete-prompt-marker points nowhere, we leave the current
2398 (defvar gud-delete-prompt-marker nil)
2401 (put 'gud-mode 'mode-class 'special)
2403 (define-derived-mode gud-mode comint-mode "Debugger"
2404 "Major mode for interacting with an inferior debugger process.
2406 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
2407 M-x perldb, M-x xdb, or M-x jdb. Each entry point finishes by executing a
2408 hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook',
2409 `perldb-mode-hook', `xdb-mode-hook', or `jdb-mode-hook' respectively.
2411 After startup, the following commands are available in both the GUD
2412 interaction buffer and any source buffer GUD visits due to a breakpoint stop
2415 \\[gud-break] sets a breakpoint at the current file and line. In the
2416 GUD buffer, the current file and line are those of the last breakpoint or
2417 step. In a source buffer, they are the buffer's file and current line.
2419 \\[gud-remove] removes breakpoints on the current file and line.
2421 \\[gud-refresh] displays in the source window the last line referred to
2424 \\[gud-step], \\[gud-next], and \\[gud-stepi] do a step-one-line,
2425 step-one-line (not entering function calls), and step-one-instruction
2426 and then update the source window with the current file and position.
2427 \\[gud-cont] continues execution.
2429 \\[gud-print] tries to find the largest C lvalue or function-call expression
2430 around point, and sends it to the debugger for value display.
2432 The above commands are common to all supported debuggers except xdb which
2433 does not support stepping instructions.
2435 Under gdb, sdb and xdb, \\[gud-tbreak] behaves exactly like \\[gud-break],
2436 except that the breakpoint is temporary; that is, it is removed when
2437 execution stops on it.
2439 Under gdb, dbx, and xdb, \\[gud-up] pops up through an enclosing stack
2440 frame. \\[gud-down] drops back down through one.
2442 If you are using gdb or xdb, \\[gud-finish] runs execution to the return from
2443 the current function and stops.
2445 All the keystrokes above are accessible in the GUD buffer
2446 with the prefix C-c, and in all buffers through the prefix C-x C-a.
2448 All pre-defined functions for which the concept make sense repeat
2449 themselves the appropriate number of times if you give a prefix
2452 You may use the `gud-def' macro in the initialization hook to define other
2455 Other commands for interacting with the debugger process are inherited from
2456 comint mode, which see."
2457 (setq mode-line-process '(":%s"))
2458 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
2459 (set (make-local-variable 'gud-last-frame) nil)
2460 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
2461 (make-local-variable 'comint-prompt-regexp)
2462 ;; Don't put repeated commands in command history many times.
2463 (set (make-local-variable 'comint-input-ignoredups) t)
2464 (make-local-variable 'paragraph-start)
2465 (set (make-local-variable 'gud-delete-prompt-marker) (make-marker))
2466 (add-hook 'kill-buffer-hook 'gud-kill-buffer-hook nil t))
2468 ;; Cause our buffers to be displayed, by default,
2469 ;; in the selected window.
2470 ;;;###autoload (add-hook 'same-window-regexps (purecopy "\\*gud-.*\\*\\(\\|<[0-9]+>\\)"))
2472 (defcustom gud-chdir-before-run t
2473 "Non-nil if GUD should `cd' to the debugged executable."
2477 (declare-function tramp-file-name-localname "tramp" (vec))
2478 (declare-function tramp-dissect-file-name "tramp" (name &optional nodefault))
2480 ;; Perform initializations common to all debuggers.
2481 ;; The first arg is the specified command line,
2482 ;; which starts with the program to debug.
2483 ;; The other three args specify the values to use
2484 ;; for local variables in the debugger buffer.
2485 (defun gud-common-init (command-line massage-args marker-filter
2486 &optional find-file)
2487 (let* ((words (split-string-and-unquote command-line))
2488 (program (car words))
2489 (dir default-directory)
2490 ;; Extract the file name from WORDS
2491 ;; and put t in its place.
2492 ;; Later on we will put the modified file name arg back there.
2493 (file-word (let ((w (cdr words)))
2494 (while (and w (= ?- (aref (car w) 0)))
2500 (and file-word (substitute-in-file-name file-word)))
2502 ;; If a directory was specified, expand the file name.
2503 ;; Otherwise, don't expand it, so GDB can use the PATH.
2504 ;; A file name without directory is literally valid
2505 ;; only if the file exists in ., and in that case,
2506 ;; omitting the expansion here has no visible effect.
2507 (file (and file-word
2508 (if (file-name-directory file-subst)
2509 (expand-file-name file-subst)
2511 (filepart (and file-word (concat "-" (file-name-nondirectory file))))
2512 (existing-buffer (get-buffer (concat "*gud" filepart "*"))))
2513 (pop-to-buffer (concat "*gud" filepart "*"))
2514 (when (and existing-buffer (get-buffer-process existing-buffer))
2515 (error "This program is already being debugged"))
2516 ;; Set the dir, in case the buffer already existed with a different dir.
2517 (setq default-directory dir)
2518 ;; Set default-directory to the file's directory.
2520 gud-chdir-before-run
2521 ;; Don't set default-directory if no directory was specified.
2522 ;; In that case, either the file is found in the current directory,
2523 ;; in which case this setq is a no-op,
2524 ;; or it is found by searching PATH,
2525 ;; in which case we don't know what directory it was found in.
2526 (file-name-directory file)
2527 (setq default-directory (file-name-directory file)))
2528 (or (bolp) (newline))
2529 (insert "Current directory is " default-directory "\n")
2530 ;; Put the substituted and expanded file name back in its place.
2532 (while (and w (not (eq (car w) t)))
2536 (if (file-remote-p file)
2537 ;; Tramp has already been loaded if we are here.
2538 (setq file (tramp-file-name-localname
2539 (tramp-dissect-file-name file)))
2541 (apply 'make-comint (concat "gud" filepart) program nil
2542 (if massage-args (funcall massage-args file args) args))
2543 ;; Since comint clobbered the mode, we don't set it until now.
2545 (set (make-local-variable 'gud-target-name)
2546 (and file-word (file-name-nondirectory file))))
2547 (set (make-local-variable 'gud-marker-filter) marker-filter)
2548 (if find-file (set (make-local-variable 'gud-find-file) find-file))
2549 (setq gud-last-last-frame nil)
2551 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
2552 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
2555 (defun gud-set-buffer ()
2556 (when (derived-mode-p 'gud-mode)
2557 (setq gud-comint-buffer (current-buffer))))
2559 (defvar gud-filter-defer-flag nil
2560 "Non-nil means don't process anything from the debugger right now.
2561 It is saved for when this flag is not set.")
2563 ;; These functions are responsible for inserting output from your debugger
2564 ;; into the buffer. The hard work is done by the method that is
2565 ;; the value of gud-marker-filter.
2567 (defun gud-filter (proc string)
2568 ;; Here's where the actual buffer insertion is done
2569 (let (output process-window)
2570 (if (buffer-name (process-buffer proc))
2571 (if gud-filter-defer-flag
2572 ;; If we can't process any text now,
2573 ;; save it for later.
2574 (setq gud-filter-pending-text
2575 (concat (or gud-filter-pending-text "") string))
2577 ;; If we have to ask a question during the processing,
2578 ;; defer any additional text that comes from the debugger
2579 ;; during that time.
2580 (let ((gud-filter-defer-flag t))
2581 ;; Process now any text we previously saved up.
2582 (if gud-filter-pending-text
2583 (setq string (concat gud-filter-pending-text string)
2584 gud-filter-pending-text nil))
2586 (with-current-buffer (process-buffer proc)
2587 ;; If we have been so requested, delete the debugger prompt.
2590 (if (marker-buffer gud-delete-prompt-marker)
2591 (let ((inhibit-read-only t))
2592 (delete-region (process-mark proc)
2593 gud-delete-prompt-marker)
2594 (comint-update-fence)
2595 (set-marker gud-delete-prompt-marker nil)))
2596 ;; Save the process output, checking for source file markers.
2597 (setq output (gud-marker-filter string))
2598 ;; Check for a filename-and-line number.
2599 ;; Don't display the specified file
2600 ;; unless (1) point is at or after the position where output appears
2601 ;; and (2) this buffer is on the screen.
2602 (setq process-window
2604 (>= (point) (process-mark proc))
2605 (get-buffer-window (current-buffer)))))
2607 ;; Let the comint filter do the actual insertion.
2608 ;; That lets us inherit various comint features.
2609 (comint-output-filter proc output))
2611 ;; Put the arrow on the source line.
2612 ;; This must be outside of the save-excursion
2613 ;; in case the source file is our current buffer.
2615 (with-selected-window process-window
2616 (gud-display-frame))
2617 ;; We have to be in the proper buffer, (process-buffer proc),
2618 ;; but not in a save-excursion, because that would restore point.
2619 (with-current-buffer (process-buffer proc)
2620 (gud-display-frame))))
2622 ;; If we deferred text that arrived during this processing,
2624 (if gud-filter-pending-text
2625 (gud-filter proc ""))))))
2627 (defvar gud-minor-mode-type nil)
2628 (defvar gud-overlay-arrow-position nil)
2629 (add-to-list 'overlay-arrow-variable-list 'gud-overlay-arrow-position)
2631 (declare-function gdb-reset "gdb-mi" ())
2633 (defun gud-sentinel (proc msg)
2634 (cond ((null (buffer-name (process-buffer proc)))
2636 ;; Stop displaying an arrow in a source file.
2637 (setq gud-overlay-arrow-position nil)
2638 (set-process-buffer proc nil)
2639 (if (and (boundp 'speedbar-frame)
2640 (string-equal speedbar-initial-expansion-list-name "GUD"))
2641 (speedbar-change-initial-expansion-list
2642 speedbar-previously-used-expansion-list-name))
2643 (if (eq gud-minor-mode-type 'gdbmi)
2646 ((memq (process-status proc) '(signal exit))
2647 ;; Stop displaying an arrow in a source file.
2648 (setq gud-overlay-arrow-position nil)
2649 (if (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
2653 (let* ((obuf (current-buffer)))
2654 ;; save-excursion isn't the right thing if
2655 ;; process-buffer is current-buffer
2658 ;; Write something in the GUD buffer and hack its mode line,
2659 (set-buffer (process-buffer proc))
2660 ;; Fix the mode line.
2661 (setq mode-line-process
2663 (symbol-name (process-status proc))))
2664 (force-mode-line-update)
2666 (insert ?\n mode-name " " msg)
2668 (goto-char (point-max))
2669 (insert ?\n mode-name " " msg)))
2670 ;; If buffer and mode line will show that the process
2671 ;; is dead, we can delete it now. Otherwise it
2672 ;; will stay around until M-x list-processes.
2673 (delete-process proc))
2674 ;; Restore old buffer, but don't restore old point
2675 ;; if obuf is the gud buffer.
2676 (set-buffer obuf))))))
2678 (defun gud-kill-buffer-hook ()
2679 (setq gud-minor-mode-type gud-minor-mode)
2682 (kill-process (get-buffer-process (current-buffer)))
2683 (delete-process (get-process "gdb-inferior")))
2687 (dolist (buffer (buffer-list))
2688 (unless (eq buffer gud-comint-buffer)
2689 (with-current-buffer buffer
2690 (when gud-minor-mode
2691 (setq gud-minor-mode nil)
2692 (kill-local-variable 'tool-bar-map))))))
2694 (defun gud-display-frame ()
2695 "Find and obey the last filename-and-line marker from the debugger.
2696 Obeying it means displaying in another window the specified file and line."
2698 (when gud-last-frame
2700 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
2701 (setq gud-last-last-frame gud-last-frame
2702 gud-last-frame nil)))
2704 (declare-function global-hl-line-highlight "hl-line" ())
2705 (declare-function hl-line-highlight "hl-line" ())
2706 (declare-function gdb-display-source-buffer "gdb-mi" (buffer))
2707 (declare-function gdb-display-buffer "gdb-mi" (buf dedicated &optional size))
2709 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
2710 ;; and that its line LINE is visible.
2711 ;; Put the overlay-arrow on the line LINE in that buffer.
2712 ;; Most of the trickiness in here comes from wanting to preserve the current
2713 ;; region-restriction if that's possible. We use an explicit display-buffer
2714 ;; to get around the fact that this is called inside a save-excursion.
2716 (defun gud-display-line (true-file line)
2717 (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
2719 (with-current-buffer gud-comint-buffer
2720 (gud-find-file true-file)))
2722 (or (get-buffer-window buffer)
2723 (if (eq gud-minor-mode 'gdbmi)
2724 (or (if (get-buffer-window buffer 'visible)
2725 (display-buffer buffer nil 'visible))
2726 (unless (gdb-display-source-buffer buffer)
2727 (gdb-display-buffer buffer nil 'visible))))
2728 (display-buffer buffer))))
2732 (with-current-buffer buffer
2733 (unless (or (verify-visited-file-modtime buffer) gud-keep-buffer)
2735 (format "File %s changed on disk. Reread from disk? "
2738 (setq gud-keep-buffer t)))
2741 (goto-char (point-min))
2742 (forward-line (1- line))
2744 (or gud-overlay-arrow-position
2745 (setq gud-overlay-arrow-position (make-marker)))
2746 (set-marker gud-overlay-arrow-position (point) (current-buffer))
2747 ;; If they turned on hl-line, move the hl-line highlight to
2748 ;; the arrow's line.
2749 (when (featurep 'hl-line)
2751 (global-hl-line-mode
2752 (global-hl-line-highlight))
2753 ((and hl-line-mode hl-line-sticky-flag)
2754 (hl-line-highlight)))))
2755 (cond ((or (< pos (point-min)) (> pos (point-max)))
2759 (set-window-point window gud-overlay-arrow-position)
2760 (if (eq gud-minor-mode 'gdbmi)
2761 (setq gdb-source-window window)))))))
2763 ;; The gud-call function must do the right thing whether its invoking
2764 ;; keystroke is from the GUD buffer itself (via major-mode binding)
2765 ;; or a C buffer. In the former case, we want to supply data from
2766 ;; gud-last-frame. Here's how we do it:
2768 (defun gud-format-command (str arg)
2769 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
2770 (frame (or gud-last-frame gud-last-last-frame))
2773 (let ((case-fold-search nil))
2774 (string-match "\\([^%]*\\)%\\([adefFlpc]\\)" str)))
2775 (let ((key (string-to-char (match-string 2 str)))
2779 (setq subst (file-name-nondirectory (if insource
2783 (setq subst (file-name-sans-extension
2784 (file-name-nondirectory (if insource
2788 (setq subst (file-name-directory (if insource
2792 (setq subst (int-to-string
2796 (+ (count-lines (point-min) (point))
2800 (setq subst (gud-find-expr)))
2802 (setq subst (gud-read-address)))
2812 (+ (count-lines (point-min) (point))
2816 (setq subst (if arg (int-to-string arg)))))
2817 (setq result (concat result (match-string 1 str) subst)))
2818 (setq str (substring str (match-end 2))))
2819 ;; There might be text left in STR when the loop ends.
2820 (concat result str)))
2822 (defun gud-read-address ()
2823 "Return a string containing the core-address found in the buffer at point."
2826 (let ((pt (point)) found begin)
2827 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
2829 (found (forward-char 2)
2830 (buffer-substring found
2831 (progn (re-search-forward "[^0-9a-f]")
2834 (t (setq begin (progn (re-search-backward "[^0-9]")
2838 (re-search-forward "[^0-9]")
2840 (buffer-substring begin (point))))))))
2842 (defun gud-call (fmt &optional arg)
2843 (let ((msg (gud-format-command fmt arg)))
2844 (message "Command: %s" msg)
2846 (gud-basic-call msg)))
2848 (defun gud-basic-call (command)
2849 "Invoke the debugger COMMAND displaying source in other window."
2852 (let ((proc (get-buffer-process gud-comint-buffer)))
2853 (or proc (error "Current buffer has no process"))
2854 ;; Arrange for the current prompt to get deleted.
2855 (with-current-buffer gud-comint-buffer
2859 (if (marker-position gud-delete-prompt-marker)
2860 ;; We get here when printing an expression.
2861 (goto-char gud-delete-prompt-marker)
2862 (goto-char (process-mark proc))
2864 (if (looking-at comint-prompt-regexp)
2865 (set-marker gud-delete-prompt-marker (point)))
2866 (if (eq gud-minor-mode 'gdbmi)
2867 (apply comint-input-sender (list proc command))
2868 (process-send-string proc (concat command "\n"))))))))
2870 (defun gud-refresh (&optional arg)
2871 "Fix up a possibly garbled display, and redraw the arrow."
2873 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
2877 ;; Code for parsing expressions out of C or Fortran code. The single entry
2878 ;; point is gud-find-expr, which tries to return an lvalue expression from
2881 (defvar gud-find-expr-function 'gud-find-c-expr)
2883 (defun gud-find-expr (&rest args)
2884 (let ((expr (if (and transient-mark-mode mark-active)
2885 (buffer-substring (region-beginning) (region-end))
2886 (apply gud-find-expr-function args))))
2888 (if (string-match "\n" expr)
2889 (error "Expression must not include a newline"))
2890 (with-current-buffer gud-comint-buffer
2892 (goto-char (process-mark (get-buffer-process gud-comint-buffer)))
2894 (when (looking-at comint-prompt-regexp)
2895 (set-marker gud-delete-prompt-marker (point))
2896 (set-marker-insertion-type gud-delete-prompt-marker t))
2897 (unless (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
2899 (insert (concat expr " = "))))))
2902 ;; The next eight functions are hacked from gdbsrc.el by
2903 ;; Debby Ayers <ayers@asc.slb.com>,
2904 ;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
2906 (defun gud-find-c-expr ()
2907 "Returns the expr that surrounds point."
2911 (expr (gud-innermost-expr))
2912 (test-expr (gud-prev-expr)))
2913 (while (and test-expr (gud-expr-compound test-expr expr))
2914 (let ((prev-expr expr))
2915 (setq expr (cons (car test-expr) (cdr expr)))
2916 (goto-char (car expr))
2917 (setq test-expr (gud-prev-expr))
2918 ;; If we just pasted on the condition of an if or while,
2919 ;; throw it away again.
2920 (if (member (buffer-substring (car test-expr) (cdr test-expr))
2921 '("if" "while" "for"))
2925 (setq test-expr (gud-next-expr))
2926 (while (gud-expr-compound expr test-expr)
2927 (setq expr (cons (car expr) (cdr test-expr)))
2928 (setq test-expr (gud-next-expr)))
2929 (buffer-substring (car expr) (cdr expr)))))
2931 (defun gud-innermost-expr ()
2932 "Returns the smallest expr that point is in; move point to beginning of it.
2933 The expr is represented as a cons cell, where the car specifies the point in
2934 the current buffer that marks the beginning of the expr and the cdr specifies
2935 the character after the end of the expr."
2936 (let ((p (point)) begin end)
2938 (setq begin (point))
2951 (defun gud-backward-sexp ()
2952 "Version of `backward-sexp' that catches errors."
2957 (defun gud-forward-sexp ()
2958 "Version of `forward-sexp' that catches errors."
2963 (defun gud-prev-expr ()
2964 "Returns the previous expr, point is set to beginning of that expr.
2965 The expr is represented as a cons cell, where the car specifies the point in
2966 the current buffer that marks the beginning of the expr and the cdr specifies
2967 the character after the end of the expr"
2968 (let ((begin) (end))
2970 (setq begin (point))
2976 (defun gud-next-expr ()
2977 "Returns the following expr, point is set to beginning of that expr.
2978 The expr is represented as a cons cell, where the car specifies the point in
2979 the current buffer that marks the beginning of the expr and the cdr specifies
2980 the character after the end of the expr."
2981 (let ((begin) (end))
2986 (setq begin (point))
2989 (defun gud-expr-compound-sep (span-start span-end)
2990 "Scan from SPAN-START to SPAN-END for punctuation characters.
2991 If `->' is found, return `?.'. If `.' is found, return `?.'.
2992 If any other punctuation is found, return `??'.
2993 If no punctuation is found, return `? '."
2996 (while (< span-start span-end)
2997 (setq syntax (char-syntax (char-after span-start)))
3000 ((= syntax ?.) (setq syntax (char-after span-start))
3002 ((= syntax ?.) (setq result ?.))
3003 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
3005 (setq span-start (+ span-start 1)))
3006 (t (setq span-start span-end)
3007 (setq result ??)))))
3008 (setq span-start (+ span-start 1)))
3011 (defun gud-expr-compound (first second)
3012 "Non-nil if concatenating FIRST and SECOND makes a single C expression.
3013 The two exprs are represented as a cons cells, where the car
3014 specifies the point in the current buffer that marks the beginning of the
3015 expr and the cdr specifies the character after the end of the expr.
3016 Link exprs of the form:
3023 (let ((span-start (cdr first))
3024 (span-end (car second))
3026 (setq syntax (gud-expr-compound-sep span-start span-end))
3028 ((= (car first) (car second)) nil)
3029 ((= (cdr first) (cdr second)) nil)
3032 (setq span-start (char-after (- span-start 1)))
3033 (setq span-end (char-after span-end))
3035 ((= span-start ?)) t)
3036 ((= span-start ?]) t)
3043 (declare-function c-langelem-sym "cc-defs" (langelem))
3044 (declare-function c-langelem-pos "cc-defs" (langelem))
3045 (declare-function syntax-symbol "gud" (x))
3046 (declare-function syntax-point "gud" (x))
3048 (defun gud-find-class (f _line)
3049 "Find fully qualified class in file F at line LINE.
3050 This function uses the `gud-jdb-classpath' (and optional
3051 `gud-jdb-sourcepath') list(s) to derive a file
3052 pathname relative to its classpath directory. The values in
3053 `gud-jdb-classpath' are assumed to have been converted to absolute
3054 pathname standards using file-truename.
3055 If F is visited by a buffer and its mode is CC-mode(Java),
3056 syntactic information of LINE is used to find the enclosing (nested)
3057 class string which is appended to the top level
3058 class of the file (using s to separate nested class ids)."
3059 ;; Convert f to a standard representation and remove suffix
3060 (if (and gud-jdb-use-classpath (or gud-jdb-classpath gud-jdb-sourcepath))
3062 (let ((cplist (append gud-jdb-sourcepath gud-jdb-classpath))
3063 (fbuffer (get-file-buffer f))
3065 ;; Syntax-symbol returns the symbol of the *first* element
3066 ;; in the syntactical analysis result list, syntax-point
3067 ;; returns the buffer position of same
3068 (syntax-symbol (lambda (x) (c-langelem-sym (car x))))
3069 (syntax-point (lambda (x) (c-langelem-pos (car x)))))
3070 (setq f (file-name-sans-extension (file-truename f)))
3071 ;; Search through classpath list for an entry that is
3073 (while (and cplist (not class-found))
3074 (if (string-match (car cplist) f)
3076 (mapconcat 'identity
3078 (substring f (+ (match-end 0) 1))
3080 (setq cplist (cdr cplist)))
3081 ;; if f is visited by a java(cc-mode) buffer, walk up the
3082 ;; syntactic information chain and collect any 'inclass
3083 ;; symbols until 'topmost-intro is reached to find out if
3084 ;; point is within a nested class
3085 ;; FIXME: Yuck!!! cc-mode should provide a function instead.
3086 (if (and fbuffer (equal (symbol-file 'java-mode) "cc-mode"))
3087 (with-current-buffer fbuffer
3088 (let ((nclass) (syntax))
3089 ;; While the c-syntactic information does not start
3090 ;; with the 'topmost-intro symbol, there may be
3091 ;; nested classes...
3092 (while (not (eq 'topmost-intro
3093 (funcall syntax-symbol (c-guess-basic-syntax))))
3094 ;; Check if the current position c-syntactic
3095 ;; analysis has 'inclass
3096 (setq syntax (c-guess-basic-syntax))
3098 (and (not (eq 'inclass (funcall syntax-symbol syntax)))
3100 (setq syntax (cdr syntax)))
3101 (if (eq 'inclass (funcall syntax-symbol syntax))
3103 (goto-char (funcall syntax-point syntax))
3104 ;; Now we're at the beginning of a class
3105 ;; definition. Find class name
3107 "[A-Za-z0-9 \t\n]*?class[ \t\n]+\\([^ \t\n]+\\)")
3109 (append (list (match-string-no-properties 1))
3111 (setq syntax (c-guess-basic-syntax))
3112 (while (and (not (funcall syntax-point syntax)) (cdr syntax))
3113 (setq syntax (cdr syntax)))
3114 (goto-char (funcall syntax-point syntax))
3116 (string-match (concat (car nclass) "$") class-found)
3118 (replace-match (mapconcat 'identity nclass "$")
3119 t t class-found)))))
3120 (if (not class-found)
3121 (message "gud-find-class: class for file %s not found!" f))
3123 ;; Not using classpath - try class/source association list
3124 (let ((class-found (rassoc f gud-jdb-class-source-alist)))
3127 (message "gud-find-class: class for file %s not found in gud-jdb-class-source-alist!" f)
3131 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3132 ;;; GDB script mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3133 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3135 (defvar gdb-script-mode-syntax-table
3136 (let ((st (make-syntax-table)))
3137 (modify-syntax-entry ?' "\"" st)
3138 (modify-syntax-entry ?# "<" st)
3139 (modify-syntax-entry ?\n ">" st)
3142 (defvar gdb-script-font-lock-keywords
3143 '(("^define\\s-+\\(\\(\\w\\|\\s_\\)+\\)" (1 font-lock-function-name-face))
3144 ("\\$\\(\\w+\\)" (1 font-lock-variable-name-face))
3145 ("^\\s-*\\(\\w\\(\\w\\|\\s_\\)*\\)" (1 font-lock-keyword-face))))
3147 (defconst gdb-script-syntax-propertize-function
3148 (syntax-propertize-rules
3149 ("^document\\s-.*\\(\n\\)" (1 "< b"))
3152 (when (and (> (match-beginning 0) (point-min))
3153 (eq 1 (nth 7 (save-excursion
3154 (syntax-ppss (1- (match-beginning 0)))))))
3155 ;; We change the \n in front, which is more difficult, but results
3156 ;; in better highlighting. If the doc is empty, the single \n is
3157 ;; both the beginning and the end of the docstring, which can't be
3158 ;; expressed in syntax-tables. Instead, we place the "> b" after
3159 ;; placing the "< b", so the start marker is overwritten by the
3160 ;; termination marker and in the end Emacs simply considers that
3161 ;; there's no docstring at all, which is fine.
3162 (put-text-property (1- (match-beginning 0)) (match-beginning 0)
3163 'syntax-table (eval-when-compile
3164 (string-to-syntax "> b")))
3165 ;; Make sure that rehighlighting the previous line won't erase our
3166 ;; syntax-table property and that modifying `end' will.
3167 (put-text-property (1- (match-beginning 0)) (match-end 0)
3168 'syntax-multiline t)))))))
3170 (defun gdb-script-font-lock-syntactic-face (state)
3172 ((nth 3 state) font-lock-string-face)
3173 ((nth 7 state) font-lock-doc-face)
3174 (t font-lock-comment-face)))
3176 (defvar gdb-script-basic-indent 2)
3178 (defun gdb-script-skip-to-head ()
3179 "We're just in front of an `end' and we need to go to its head."
3180 (while (and (re-search-backward "^\\s-*\\(\\(end\\)\\|define\\|document\\|if\\|while\\|commands\\)\\>" nil 'move)
3182 (gdb-script-skip-to-head)))
3184 (defun gdb-script-calculate-indentation ()
3186 ((looking-at "end\\>")
3187 (gdb-script-skip-to-head)
3188 (current-indentation))
3189 ((looking-at "else\\>")
3190 (while (and (re-search-backward "^\\s-*\\(if\\|\\(end\\)\\)\\>" nil 'move)
3192 (gdb-script-skip-to-head))
3193 (current-indentation))
3195 (forward-comment (- (point-max)))
3197 (skip-chars-forward " \t")
3198 (+ (current-indentation)
3199 (if (looking-at "\\(if\\|while\\|define\\|else\\|commands\\)\\>")
3200 gdb-script-basic-indent 0)))))
3202 (defun gdb-script-indent-line ()
3203 "Indent current line of GDB script."
3205 (if (and (eq (get-text-property (point) 'face) font-lock-doc-face)
3208 (skip-chars-forward " \t")
3209 (not (looking-at "end\\>"))))
3211 (let* ((savep (point))
3212 (indent (condition-case nil
3215 (skip-chars-forward " \t")
3216 (if (>= (point) savep) (setq savep nil))
3217 (max (gdb-script-calculate-indentation) 0))
3220 (save-excursion (indent-line-to indent))
3221 (indent-line-to indent)))))
3223 ;; Derived from cfengine.el.
3224 (defun gdb-script-beginning-of-defun ()
3225 "`beginning-of-defun' function for Gdb script mode.
3226 Treats actions as defuns."
3227 (unless (<= (current-column) (current-indentation))
3229 (if (re-search-backward "^define \\|^document " nil t)
3231 (goto-char (point-min)))
3234 ;; Derived from cfengine.el.
3235 (defun gdb-script-end-of-defun ()
3236 "`end-of-defun' function for Gdb script mode.
3237 Treats actions as defuns."
3239 (if (re-search-forward "^end" nil t)
3241 (goto-char (point-max)))
3245 (define-derived-mode gdb-script-mode prog-mode "GDB-Script"
3246 "Major mode for editing GDB scripts."
3247 (set (make-local-variable 'comment-start) "#")
3248 (set (make-local-variable 'comment-start-skip) "#+\\s-*")
3249 (set (make-local-variable 'outline-regexp) "[ \t]")
3250 (set (make-local-variable 'imenu-generic-expression)
3251 '((nil "^define[ \t]+\\(\\w+\\)" 1)))
3252 (set (make-local-variable 'indent-line-function) 'gdb-script-indent-line)
3253 (set (make-local-variable 'beginning-of-defun-function)
3254 #'gdb-script-beginning-of-defun)
3255 (set (make-local-variable 'end-of-defun-function)
3256 #'gdb-script-end-of-defun)
3257 (set (make-local-variable 'font-lock-defaults)
3258 '(gdb-script-font-lock-keywords nil nil ((?_ . "w")) nil
3259 (font-lock-syntactic-face-function
3260 . gdb-script-font-lock-syntactic-face)))
3261 ;; Recognize docstrings.
3262 (set (make-local-variable 'syntax-propertize-function)
3263 gdb-script-syntax-propertize-function)
3264 (add-hook 'syntax-propertize-extend-region-functions
3265 #'syntax-propertize-multiline 'append 'local))
3268 ;;; tooltips for GUD
3270 ;;; Customizable settings
3273 (define-minor-mode gud-tooltip-mode
3274 "Toggle the display of GUD tooltips."
3279 (if gud-tooltip-mode
3281 (add-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3282 (add-hook 'pre-command-hook 'tooltip-hide)
3283 (add-hook 'tooltip-functions 'gud-tooltip-tips)
3284 (define-key global-map [mouse-movement] 'gud-tooltip-mouse-motion))
3285 (unless tooltip-mode (remove-hook 'pre-command-hook 'tooltip-hide)
3286 (remove-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3287 (remove-hook 'tooltip-functions 'gud-tooltip-tips)
3288 (define-key global-map [mouse-movement] 'ignore)))
3289 (gud-tooltip-activate-mouse-motions-if-enabled)
3290 (if (and gud-comint-buffer
3291 (buffer-name gud-comint-buffer); gud-comint-buffer might be killed
3292 (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
3294 (if gud-tooltip-mode
3296 (dolist (buffer (buffer-list))
3297 (unless (eq buffer gud-comint-buffer)
3298 (with-current-buffer buffer
3299 (when (and (eq gud-minor-mode 'gdbmi)
3300 (not (string-match "\\`\\*.+\\*\\'"
3302 (make-local-variable 'gdb-define-alist)
3303 (gdb-create-define-alist)
3304 (add-hook 'after-save-hook
3305 'gdb-create-define-alist nil t))))))
3306 (kill-local-variable 'gdb-define-alist)
3307 (remove-hook 'after-save-hook 'gdb-create-define-alist t))))
3309 (define-obsolete-variable-alias 'tooltip-gud-modes
3310 'gud-tooltip-modes "22.1")
3312 (defcustom gud-tooltip-modes '(gud-mode c-mode c++-mode fortran-mode
3314 "List of modes for which to enable GUD tooltips."
3319 (define-obsolete-variable-alias 'tooltip-gud-display
3320 'gud-tooltip-display "22.1")
3322 (defcustom gud-tooltip-display
3323 '((eq (tooltip-event-buffer gud-tooltip-event)
3324 (marker-buffer gud-overlay-arrow-position)))
3325 "List of forms determining where GUD tooltips are displayed.
3327 Forms in the list are combined with AND. The default is to display
3328 only tooltips in the buffer containing the overlay arrow."
3333 (defcustom gud-tooltip-echo-area nil
3334 "Use the echo area instead of frames for GUD tooltips."
3339 ;;; Reacting on mouse movements
3341 (defun gud-tooltip-change-major-mode ()
3342 "Function added to `change-major-mode-hook' when tooltip mode is on."
3343 (add-hook 'post-command-hook 'gud-tooltip-activate-mouse-motions-if-enabled))
3345 (defun gud-tooltip-activate-mouse-motions-if-enabled ()
3346 "Reconsider for all buffers whether mouse motion events are desired."
3347 (remove-hook 'post-command-hook
3348 'gud-tooltip-activate-mouse-motions-if-enabled)
3349 (dolist (buffer (buffer-list))
3350 (with-current-buffer buffer
3351 (if (and gud-tooltip-mode
3352 (memq major-mode gud-tooltip-modes))
3353 (gud-tooltip-activate-mouse-motions t)
3354 (gud-tooltip-activate-mouse-motions nil)))))
3356 (defvar gud-tooltip-mouse-motions-active nil
3357 "Locally t in a buffer if tooltip processing of mouse motion is enabled.")
3359 ;; We don't set track-mouse globally because this is a big redisplay
3360 ;; problem in buffers having a pre-command-hook or such installed,
3361 ;; which does a set-buffer, like the summary buffer of Gnus. Calling
3362 ;; set-buffer prevents redisplay optimizations, so every mouse motion
3363 ;; would be accompanied by a full redisplay.
3365 (defun gud-tooltip-activate-mouse-motions (activatep)
3366 "Activate/deactivate mouse motion events for the current buffer.
3367 ACTIVATEP non-nil means activate mouse motion events."
3370 (set (make-local-variable 'gud-tooltip-mouse-motions-active) t)
3371 (set (make-local-variable 'track-mouse) t))
3372 (when gud-tooltip-mouse-motions-active
3373 (kill-local-variable 'gud-tooltip-mouse-motions-active)
3374 (kill-local-variable 'track-mouse))))
3376 (defvar tooltip-last-mouse-motion-event)
3377 (declare-function tooltip-hide "tooltip" (&optional ignored-arg))
3378 (declare-function tooltip-start-delayed-tip "tooltip" ())
3380 (defun gud-tooltip-mouse-motion (event)
3381 "Command handler for mouse movement events in `global-map'."
3384 (when (car (mouse-pixel-position))
3385 (setq tooltip-last-mouse-motion-event (copy-sequence event))
3386 (tooltip-start-delayed-tip)))
3390 (defvar gud-tooltip-original-filter nil
3391 "Process filter to restore after GUD output has been received.")
3393 (defvar gud-tooltip-dereference nil
3394 "Non-nil means print expressions with a `*' in front of them.
3395 For C this would dereference a pointer expression.")
3397 (defvar gud-tooltip-event nil
3398 "The mouse movement event that led to a tooltip display.
3399 This event can be examined by forms in `gud-tooltip-display'.")
3401 (defun gud-tooltip-dereference (&optional arg)
3402 "Toggle whether tooltips should show `* expr' or `expr'.
3403 With arg, dereference expr if ARG is positive, otherwise do not derereference."
3405 (setq gud-tooltip-dereference
3407 (not gud-tooltip-dereference)
3408 (> (prefix-numeric-value arg) 0)))
3409 (message "Dereferencing is now %s."
3410 (if gud-tooltip-dereference "on" "off")))
3412 (define-obsolete-function-alias 'tooltip-gud-toggle-dereference
3413 'gud-tooltip-dereference "22.1")
3414 (defvar tooltip-use-echo-area)
3415 (declare-function tooltip-show "tooltip" (text &optional use-echo-area))
3416 (declare-function tooltip-strip-prompt "tooltip" (process output))
3418 ; This will only display data that comes in one chunk.
3419 ; Larger arrays (say 400 elements) are displayed in
3420 ; the tooltip incompletely and spill over into the gud buffer.
3421 ; Switching the process-filter creates timing problems and
3422 ; it may be difficult to do better. Using GDB/MI as in
3423 ; gdb-mi.el gets round this problem.
3424 (defun gud-tooltip-process-output (process output)
3425 "Process debugger output and show it in a tooltip window."
3426 (set-process-filter process gud-tooltip-original-filter)
3427 (tooltip-show (tooltip-strip-prompt process output)
3428 (or gud-tooltip-echo-area tooltip-use-echo-area)))
3430 (defun gud-tooltip-print-command (expr)
3431 "Return a suitable command to print the expression EXPR."
3432 (case gud-minor-mode
3433 (gdbmi (concat "-data-evaluate-expression " expr))
3434 (dbx (concat "print " expr))
3435 ((xdb pdb) (concat "p " expr))
3436 (sdb (concat expr "/"))))
3438 (declare-function gdb-input "gdb-mi" (item))
3439 (declare-function tooltip-expr-to-print "tooltip" (event))
3440 (declare-function tooltip-event-buffer "tooltip" (event))
3442 (defun gud-tooltip-tips (event)
3443 "Show tip for identifier or selection under the mouse.
3444 The mouse must either point at an identifier or inside a selected
3445 region for the tip window to be shown. If `gud-tooltip-dereference' is t,
3446 add a `*' in front of the printed expression. In the case of a C program
3447 controlled by GDB, show the associated #define directives when program is
3450 This function must return nil if it doesn't handle EVENT."
3452 (when (and (eventp event)
3455 (buffer-name gud-comint-buffer); might be killed
3456 (setq process (get-buffer-process gud-comint-buffer))
3457 (posn-point (event-end event))
3458 (or (and (eq gud-minor-mode 'gdbmi) (not gdb-active-process))
3459 (progn (setq gud-tooltip-event event)
3460 (eval (cons 'and gud-tooltip-display)))))
3461 (let ((expr (tooltip-expr-to-print event)))
3463 (if (and (eq gud-minor-mode 'gdbmi)
3464 (not gdb-active-process))
3466 (with-current-buffer (tooltip-event-buffer event)
3467 (let ((define-elt (assoc expr gdb-define-alist)))
3468 (unless (null define-elt)
3471 (or gud-tooltip-echo-area tooltip-use-echo-area))
3473 (when gud-tooltip-dereference
3474 (setq expr (concat "*" expr)))
3475 (let ((cmd (gud-tooltip-print-command expr)))
3476 (when (and gud-tooltip-mode (eq gud-minor-mode 'gdb))
3477 (gud-tooltip-mode -1)
3478 (message-box "Using GUD tooltips in this mode is unsafe\n\
3479 so they have been disabled."))
3480 (unless (null cmd) ; CMD can be nil if unknown debugger
3481 (if (eq gud-minor-mode 'gdbmi)
3485 "server macro expand " expr "\n")
3486 `(lambda () (gdb-tooltip-print-1 ,expr))))
3488 (list (concat cmd "\n")
3489 `(lambda () (gdb-tooltip-print ,expr)))))
3490 (setq gud-tooltip-original-filter (process-filter process))
3491 (set-process-filter process 'gud-tooltip-process-output)
3492 (gud-basic-call cmd))
3497 ;;; gud.el ends here