1 ;;; gud.el --- Grand Unified Debugger mode for running GDB and other debuggers
3 ;; Copyright (C) 1992-1996, 1998, 2000-2014 Free Software Foundation,
6 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
7 ;; Maintainer: emacs-devel@gnu.org
8 ;; Keywords: unix, tools
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; The ancestral gdb.el was by W. Schelter <wfs@rascal.ics.utexas.edu>.
28 ;; It was later rewritten by rms. Some ideas were due to Masanobu. Grand
29 ;; Unification (sdb/dbx support) by Eric S. Raymond <esr@thyrsus.com> Barry
30 ;; Warsaw <bwarsaw@cen.com> hacked the mode to use comint.el. Shane Hartman
31 ;; <shane@spr.com> added support for xdb (HPUX debugger). Rick Sladkey
32 ;; <jrs@world.std.com> wrote the GDB command completion code. Dave Love
33 ;; <d.love@dl.ac.uk> added the IRIX kluge, re-implemented the Mips-ish variant
34 ;; and added a menu. Brian D. Carlstrom <bdc@ai.mit.edu> combined the IRIX
35 ;; kluge with the gud-xdb-directories hack producing gud-dbx-directories.
36 ;; Derek L. Davies <ddavies@world.std.com> added support for jdb (Java
43 (defvar gdb-active-process
)
44 (defvar gdb-define-alist
)
45 (defvar gdb-macro-info
)
46 (defvar gdb-show-changed-values
)
47 (defvar gdb-source-window
)
50 (defvar hl-line-sticky-flag
)
53 ;; ======================================================================
54 ;; GUD commands must be visible in C buffers visited by GUD
57 "The \"Grand Unified Debugger\" interface.
58 Supported debuggers include gdb, sdb, dbx, xdb, perldb,
59 pdb (Python), and jdb."
64 (defcustom gud-key-prefix
"\C-x\C-a"
65 "Prefix of all GUD commands valid in C buffers."
69 (global-set-key (vconcat gud-key-prefix
"\C-l") 'gud-refresh
)
70 ;; (define-key ctl-x-map " " 'gud-break); backward compatibility hack
72 (defvar gud-marker-filter nil
)
73 (put 'gud-marker-filter
'permanent-local t
)
74 (defvar gud-find-file nil
)
75 (put 'gud-find-file
'permanent-local t
)
77 (defun gud-marker-filter (&rest args
)
78 (apply gud-marker-filter args
))
80 (defvar gud-minor-mode nil
)
81 (put 'gud-minor-mode
'permanent-local t
)
83 (defvar gud-comint-buffer nil
)
85 (defvar gud-keep-buffer nil
)
87 (defun gud-symbol (sym &optional soft minor-mode
)
88 "Return the symbol used for SYM in MINOR-MODE.
89 MINOR-MODE defaults to `gud-minor-mode'.
90 The symbol returned is `gud-<MINOR-MODE>-<SYM>'.
91 If SOFT is non-nil, returns nil if the symbol doesn't already exist."
92 (unless (or minor-mode gud-minor-mode
) (error "Gud internal error"))
93 (funcall (if soft
'intern-soft
'intern
)
94 (format "gud-%s-%s" (or minor-mode gud-minor-mode
) sym
)))
96 (defun gud-val (sym &optional minor-mode
)
97 "Return the value of `gud-symbol' SYM. Default to nil."
98 (let ((sym (gud-symbol sym t minor-mode
)))
99 (if (boundp sym
) (symbol-value sym
))))
101 (defvar gud-running nil
102 "Non-nil if debugged program is running.
103 Used to gray out relevant toolbar icons.")
105 (defvar gud-target-name
"--unknown--"
106 "The apparent name of the program being debugged in a gud buffer.")
108 ;; Use existing Info buffer, if possible.
109 (defun gud-goto-info ()
110 "Go to relevant Emacs info node."
112 (if (eq gud-minor-mode
'gdbmi
)
113 (info-other-window "(emacs)GDB Graphical Interface")
114 (info-other-window "(emacs)Debuggers")))
116 (defun gud-tool-bar-item-visible-no-fringe ()
117 (not (or (eq (buffer-local-value 'major-mode
(window-buffer)) 'speedbar-mode
)
118 (eq (buffer-local-value 'major-mode
(window-buffer)) 'gdb-memory-mode
)
119 (and (eq gud-minor-mode
'gdbmi
)
120 (> (car (window-fringes)) 0)))))
122 (declare-function gdb-gud-context-command
"gdb-mi.el")
124 (defun gud-stop-subjob ()
126 (with-current-buffer gud-comint-buffer
127 (cond ((string-equal gud-target-name
"emacs")
128 (comint-stop-subjob))
129 ((eq gud-minor-mode
'jdb
)
130 (gud-call "suspend"))
131 ((eq gud-minor-mode
'gdbmi
)
132 (gud-call (gdb-gud-context-command "-exec-interrupt")))
134 (comint-interrupt-subjob)))))
136 (easy-mmode-defmap gud-menu-map
137 '(([help] "Info (debugger)" . gud-goto-info)
138 ([tooltips] menu-item "Show GUD tooltips" gud-tooltip-mode
139 :enable (and (not emacs-basic-display)
141 (fboundp 'x-show-tip))
142 :visible (memq gud-minor-mode
143 '(gdbmi dbx sdb xdb pdb))
144 :button (:toggle . gud-tooltip-mode))
145 ([refresh] "Refresh" . gud-refresh)
146 ([run] menu-item "Run" gud-run
147 :enable (not gud-running)
148 :visible (memq gud-minor-mode '(gdbmi gdb dbx jdb)))
149 ([go] menu-item (if (bound-and-true-p gdb-active-process)
150 "Continue" "Run") gud-go
151 :visible (and (eq gud-minor-mode 'gdbmi)
153 ([stop] menu-item "Stop" gud-stop-subjob
154 :visible (or (not (memq gud-minor-mode '(gdbmi pdb)))
156 ([until] menu-item "Continue to selection" gud-until
157 :enable (not gud-running)
158 :visible (and (memq gud-minor-mode '(gdbmi gdb perldb))
159 (gud-tool-bar-item-visible-no-fringe)))
160 ([remove] menu-item "Remove Breakpoint" gud-remove
161 :enable (not gud-running)
162 :visible (gud-tool-bar-item-visible-no-fringe))
163 ([tbreak] menu-item "Temporary Breakpoint" gud-tbreak
164 :enable (not gud-running)
165 :visible (memq gud-minor-mode
166 '(gdbmi gdb sdb xdb)))
167 ([break] menu-item "Set Breakpoint" gud-break
168 :enable (not gud-running)
169 :visible (gud-tool-bar-item-visible-no-fringe))
170 ([up] menu-item "Up Stack" gud-up
171 :enable (not gud-running)
172 :visible (memq gud-minor-mode
173 '(gdbmi gdb dbx xdb jdb pdb)))
174 ([down] menu-item "Down Stack" gud-down
175 :enable (not gud-running)
176 :visible (memq gud-minor-mode
177 '(gdbmi gdb dbx xdb jdb pdb)))
178 ([pp] menu-item "Print S-expression" gud-pp
179 :enable (and (not gud-running)
180 (bound-and-true-p gdb-active-process))
181 :visible (and (string-equal
183 'gud-target-name gud-comint-buffer) "emacs")
184 (eq gud-minor-mode 'gdbmi)))
185 ([print*] menu-item (if (eq gud-minor-mode 'jdb)
187 "Print Dereference") gud-pstar
188 :enable (not gud-running)
189 :visible (memq gud-minor-mode '(gdbmi gdb jdb)))
190 ([print] menu-item "Print Expression" gud-print
191 :enable (not gud-running))
192 ([watch] menu-item "Watch Expression" gud-watch
193 :enable (not gud-running)
194 :visible (eq gud-minor-mode 'gdbmi))
195 ([finish] menu-item "Finish Function" gud-finish
196 :enable (not gud-running)
197 :visible (memq gud-minor-mode
198 '(gdbmi gdb xdb jdb pdb)))
199 ([stepi] menu-item "Step Instruction" gud-stepi
200 :enable (not gud-running)
201 :visible (memq gud-minor-mode '(gdbmi gdb dbx)))
202 ([nexti] menu-item "Next Instruction" gud-nexti
203 :enable (not gud-running)
204 :visible (memq gud-minor-mode '(gdbmi gdb dbx)))
205 ([step] menu-item "Step Line" gud-step
206 :enable (not gud-running))
207 ([next] menu-item "Next Line" gud-next
208 :enable (not gud-running))
209 ([cont] menu-item "Continue" gud-cont
210 :enable (not gud-running)
211 :visible (not (eq gud-minor-mode 'gdbmi))))
212 "Menu for `gud-mode'."
215 (easy-mmode-defmap gud-minor-mode-map
217 `(([menu-bar debug] . ("Gud" . ,gud-menu-map)))
218 ;; Get tool bar like functionality from the menu bar on a text only
220 (unless window-system
222 . (,(propertize "down" 'face 'font-lock-doc-face) . gud-down))
224 . (,(propertize "up" 'face 'font-lock-doc-face) . gud-up))
226 . (,(propertize "finish" 'face 'font-lock-doc-face) . gud-finish))
228 . (,(propertize "step" 'face 'font-lock-doc-face) . gud-step))
230 . (,(propertize "next" 'face 'font-lock-doc-face) . gud-next))
231 ([menu-bar until] menu-item
232 ,(propertize "until" 'face 'font-lock-doc-face) gud-until
233 :visible (memq gud-minor-mode '(gdbmi gdb perldb)))
234 ([menu-bar cont] menu-item
235 ,(propertize "cont" 'face 'font-lock-doc-face) gud-cont
236 :visible (not (eq gud-minor-mode 'gdbmi)))
237 ([menu-bar run] menu-item
238 ,(propertize "run" 'face 'font-lock-doc-face) gud-run
239 :visible (memq gud-minor-mode '(gdbmi gdb dbx jdb)))
240 ([menu-bar go] menu-item
241 ,(propertize " go " 'face 'font-lock-doc-face) gud-go
242 :visible (and (eq gud-minor-mode 'gdbmi)
244 ([menu-bar stop] menu-item
245 ,(propertize "stop" 'face 'font-lock-doc-face) gud-stop-subjob
246 :visible (or (and (eq gud-minor-mode 'gdbmi)
248 (not (eq gud-minor-mode 'gdbmi))))
250 . (,(propertize "print" 'face 'font-lock-doc-face) . gud-print))
251 ([menu-bar tools] . undefined)
252 ([menu-bar buffer] . undefined)
253 ([menu-bar options] . undefined)
254 ([menu-bar edit] . undefined)
255 ([menu-bar file] . undefined))))
256 "Map used in visited files.")
258 (let ((m (assq 'gud-minor-mode minor-mode-map-alist)))
259 (if m (setcdr m gud-minor-mode-map)
260 (push (cons 'gud-minor-mode gud-minor-mode-map) minor-mode-map-alist)))
263 ;; Will inherit from comint-mode via define-derived-mode.
265 "`gud-mode' keymap.")
267 (defvar gud-tool-bar-map
268 (let ((map (make-sparse-keymap)))
269 (dolist (x '((gud-break . "gud/break")
270 (gud-remove . "gud/remove")
271 (gud-print . "gud/print")
272 (gud-pstar . "gud/pstar")
274 (gud-watch . "gud/watch")
275 (gud-run . "gud/run")
277 (gud-stop-subjob . "gud/stop")
278 (gud-cont . "gud/cont")
279 (gud-until . "gud/until")
280 (gud-next . "gud/next")
281 (gud-step . "gud/step")
282 (gud-finish . "gud/finish")
283 (gud-nexti . "gud/nexti")
284 (gud-stepi . "gud/stepi")
286 (gud-down . "gud/down")
287 (gud-goto-info . "info"))
289 (tool-bar-local-item-from-menu
290 (car x) (cdr x) map gud-minor-mode-map))))
292 (defun gud-file-name (f)
293 "Transform a relative file name to an absolute file name.
294 Uses `gud-<MINOR-MODE>-directories' to find the source files."
295 ;; When `default-directory' is a remote file name, prepend its
296 ;; remote part to f, which is the local file name. Fortunately,
297 ;; `file-remote-p' returns exactly this remote file name part (or
299 (setq f (concat (or (file-remote-p default-directory) "") f))
300 (if (file-exists-p f) (expand-file-name f)
301 (let ((directories (gud-val 'directories))
304 (let ((path (expand-file-name f (car directories))))
305 (if (file-exists-p path)
308 (setq directories (cdr directories)))
311 (declare-function gdb-create-define-alist "gdb-mi" ())
313 (defun gud-find-file (file)
314 ;; Don't get confused by double slashes in the name that comes from GDB.
315 (while (string-match "//+" file)
316 (setq file (replace-match "/" t t file)))
317 (let ((minor-mode gud-minor-mode)
318 (buf (funcall (or gud-find-file 'gud-file-name) file)))
320 (setq buf (and (file-readable-p buf) (find-file-noselect buf 'nowarn))))
322 ;; Copy `gud-minor-mode' to the found buffer to turn on the menu.
323 (with-current-buffer buf
324 (setq-local gud-minor-mode minor-mode)
325 (if (boundp 'tool-bar-map) ; not --without-x
326 (setq-local tool-bar-map gud-tool-bar-map))
327 (when (and gud-tooltip-mode
328 (eq gud-minor-mode 'gdbmi))
329 (make-local-variable 'gdb-define-alist)
330 (unless gdb-define-alist (gdb-create-define-alist))
331 (add-hook 'after-save-hook 'gdb-create-define-alist nil t))
332 (make-local-variable 'gud-keep-buffer))
335 ;; ======================================================================
336 ;; command definition
338 ;; This macro is used below to define some basic debugger interface commands.
339 ;; Of course you may use `gud-def' with any other debugger command, including
340 ;; user defined ones.
342 ;; A macro call like (gud-def FUNC CMD KEY DOC) expands to a form
343 ;; which defines FUNC to send the command CMD to the debugger, gives
344 ;; it the docstring DOC, and binds that function to KEY in the GUD
345 ;; major mode. The function is also bound in the global keymap with the
348 (defmacro gud-def (func cmd key &optional doc)
349 "Define FUNC to be a command sending CMD and bound to KEY, with
350 optional doc string DOC. Certain %-escapes in the string arguments
351 are interpreted specially if present. These are:
353 %f -- Name (without directory) of current source file.
354 %F -- Name (without directory or extension) of current source file.
355 %d -- Directory of current source file.
356 %l -- Number of current source line.
357 %e -- Text of the C lvalue or function-call expression surrounding point.
358 %a -- Text of the hexadecimal address surrounding point.
359 %p -- Prefix argument to the command (if any) as a number.
360 %c -- Fully qualified class name derived from the expression
361 surrounding point (jdb only).
363 The `current' source file is the file of the current buffer (if
364 we're in a C file) or the source file current at the last break or
365 step (if we're in the GUD buffer).
366 The `current' line is that of the current buffer (if we're in a
367 source file) or the source line number at the last break or step (if
368 we're in the GUD buffer)."
370 (defalias ',func (lambda (arg)
371 ,@(if doc (list doc))
373 (if (not gud-running)
377 ,(if key `(local-set-key ,(concat "\C-c" key) ',func))
378 ,(if key `(global-set-key (vconcat gud-key-prefix ,key) ',func))))
380 ;; Where gud-display-frame should put the debugging arrow; a cons of
381 ;; (filename . line-number). This is set by the marker-filter, which scans
382 ;; the debugger's output for indications of the current program counter.
383 (defvar gud-last-frame nil)
385 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
386 ;; the last frame, even if it's been called before and gud-last-frame has
388 (defvar gud-last-last-frame nil)
390 ;; All debugger-specific information is collected here.
391 ;; Here's how it works, in case you ever need to add a debugger to the mode.
393 ;; Each entry must define the following at startup:
396 ;; comint-prompt-regexp
397 ;; gud-<name>-massage-args
398 ;; gud-<name>-marker-filter
399 ;; gud-<name>-find-file
401 ;; The job of the massage-args method is to modify the given list of
402 ;; debugger arguments before running the debugger.
404 ;; The job of the marker-filter method is to detect file/line markers in
405 ;; strings and set the global gud-last-frame to indicate what display
406 ;; action (if any) should be triggered by the marker. Note that only
407 ;; whatever the method *returns* is displayed in the buffer; thus, you
408 ;; can filter the debugger's output, interpreting some and passing on
411 ;; The job of the find-file method is to visit and return the buffer indicated
412 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
415 ;; ======================================================================
416 ;; speedbar support functions and variables.
417 (eval-when-compile (require 'dframe)) ; for dframe-with-attached-buffer
419 (defvar gud-last-speedbar-stackframe nil
420 "Description of the currently displayed GUD stack.
421 The value t means that there is no stack, and we are in display-file mode.")
423 (defvar gud-speedbar-key-map nil
424 "Keymap used when in the buffers display mode.")
426 ;; At runtime, will be pulled in as a require of speedbar.
427 (declare-function dframe-message "dframe" (fmt &rest args))
429 (defun gud-speedbar-item-info ()
430 "Display the data type of the watch expression element."
431 (let ((var (nth (- (line-number-at-pos (point)) 2) gdb-var-list)))
433 (dframe-message "%s: %s" (nth 7 var) (nth 3 var))
434 (dframe-message "%s" (nth 3 var)))))
436 (declare-function speedbar-make-specialized-keymap "speedbar" ())
437 (declare-function speedbar-add-expansion-list "speedbar" (new-list))
438 (defvar speedbar-mode-functions-list)
440 (defun gud-install-speedbar-variables ()
441 "Install those variables used by speedbar to enhance gud/gdb."
442 (unless gud-speedbar-key-map
443 (setq gud-speedbar-key-map (speedbar-make-specialized-keymap))
444 (define-key gud-speedbar-key-map "j" 'speedbar-edit-line)
445 (define-key gud-speedbar-key-map "e" 'speedbar-edit-line)
446 (define-key gud-speedbar-key-map "\C-m" 'speedbar-edit-line)
447 (define-key gud-speedbar-key-map " " 'speedbar-toggle-line-expansion)
448 (define-key gud-speedbar-key-map "D" 'gdb-var-delete)
449 (define-key gud-speedbar-key-map "p" 'gud-pp))
451 (speedbar-add-expansion-list '("GUD" gud-speedbar-menu-items
453 gud-expansion-speedbar-buttons))
456 'speedbar-mode-functions-list
457 '("GUD" (speedbar-item-info . gud-speedbar-item-info)
458 (speedbar-line-directory . ignore))))
460 (defvar gud-speedbar-menu-items
461 '(["Jump to stack frame" speedbar-edit-line
462 :visible (not (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
464 ["Edit value" speedbar-edit-line
465 :visible (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
467 ["Delete expression" gdb-var-delete
468 :visible (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
470 ["Auto raise frame" gdb-speedbar-auto-raise
471 :style toggle :selected gdb-speedbar-auto-raise
472 :visible (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
475 :visible (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
477 ["Binary" (gdb-var-set-format "binary") t]
478 ["Natural" (gdb-var-set-format "natural") t]
479 ["Hexadecimal" (gdb-var-set-format "hexadecimal") t]))
480 "Additional menu items to add to the speedbar frame.")
482 ;; Make sure our special speedbar mode is loaded
483 (if (featurep 'speedbar)
484 (gud-install-speedbar-variables)
485 (add-hook 'speedbar-load-hook 'gud-install-speedbar-variables))
487 (defun gud-expansion-speedbar-buttons (_directory _zero)
488 "Wrapper for call to `speedbar-add-expansion-list'.
489 DIRECTORY and ZERO are not used, but are required by the caller."
490 (gud-speedbar-buttons gud-comint-buffer))
492 (declare-function speedbar-make-tag-line "speedbar"
493 (type char func data tag tfunc tdata tface depth))
494 (declare-function speedbar-remove-localized-speedbar-support "speedbar"
496 (declare-function speedbar-insert-button "speedbar"
497 (text face mouse function &optional token prevline))
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 (pcase 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 (pcase 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 ;; One of the nice features of GDB is its impressive support for
721 ;; context-sensitive command completion. We preserve that feature
722 ;; in the GUD buffer by using a GDB command designed just for Emacs.
724 (defvar gud-gdb-completion-function nil
725 "Completion function for GDB commands.
726 It receives two arguments: COMMAND, the prefix for which we seek
727 completion; and CONTEXT, the text before COMMAND on the line.
728 It should return a list of completion strings.")
730 ;; If in gdb mode, gdb-mi is loaded.
731 (declare-function gdb-restore-windows "gdb-mi" ())
733 ;; The old gdb command (text command mode). The new one is in gdb-mi.el.
735 (defun gud-gdb (command-line)
736 "Run gdb on program FILE in buffer *gud-FILE*.
737 The directory containing FILE becomes the initial working
738 directory and source-file directory for your debugger."
739 (interactive (list (gud-query-cmdline 'gud-gdb)))
741 (when (and gud-comint-buffer
742 (buffer-name gud-comint-buffer)
743 (get-buffer-process gud-comint-buffer)
744 (with-current-buffer gud-comint-buffer (eq gud-minor-mode 'gdbmi)))
745 (gdb-restore-windows)
747 "Multiple debugging requires restarting in text command mode"))
749 (gud-common-init command-line nil 'gud-gdb-marker-filter)
750 (set (make-local-variable 'gud-minor-mode) 'gdb)
752 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
753 (gud-def gud-tbreak "tbreak %f:%l" "\C-t"
754 "Set temporary breakpoint at current line.")
755 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
756 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
757 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
758 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
759 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
760 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
761 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
763 (progn (gud-call "tbreak %f:%l") (gud-call "jump %f:%l"))
764 "\C-j" "Set execution address to current line.")
766 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
767 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
768 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
769 (gud-def gud-pstar "print* %e" nil
770 "Evaluate C dereferenced pointer expression at point.")
772 ;; For debugging Emacs only.
773 (gud-def gud-pv "pv %e" "\C-v" "Print the value of the lisp variable.")
775 (gud-def gud-until "until %l" "\C-u" "Continue to current line.")
776 (gud-def gud-run "run" nil "Run the program.")
778 (add-hook 'completion-at-point-functions #'gud-gdb-completion-at-point
780 (set (make-local-variable 'gud-gdb-completion-function) 'gud-gdb-completions)
782 (local-set-key "\C-i" 'completion-at-point)
783 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
784 (setq paragraph-start comint-prompt-regexp)
785 (setq gdb-first-prompt t)
786 (setq gud-running nil)
787 (setq gud-filter-pending-text nil)
788 (run-hooks 'gud-gdb-mode-hook))
790 ;; The completion process filter indicates when it is finished.
791 (defvar gud-gdb-fetch-lines-in-progress)
793 ;; Since output may arrive in fragments we accumulate partials strings here.
794 (defvar gud-gdb-fetch-lines-string)
796 ;; We need to know how much of the completion to chop off.
797 (defvar gud-gdb-fetch-lines-break)
799 ;; The completion list is constructed by the process filter.
800 (defvar gud-gdb-fetched-lines)
802 (defun gud-gdb-completions (context command)
803 "Completion table for GDB commands.
804 COMMAND is the prefix for which we seek completion.
805 CONTEXT is the text before COMMAND on the line."
806 (let* ((start (- (point) (field-beginning)))
808 (gud-gdb-run-command-fetch-lines (concat "complete " context command)
810 ;; From string-match above.
812 ;; Protect against old versions of GDB.
814 (string-match "^Undefined command: \"complete\"" (car complete-list))
815 (error "This version of GDB doesn't support the `complete' command"))
816 (gud-gdb-completions-1 complete-list)))
818 ;; This function is also used by `gud-gdbmi-completions'.
819 (defun gud-gdb-completions-1 (complete-list)
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))
850 ;; FIXME: `gud-gdb-run-command-fetch-lines' has some nasty side-effects on
851 ;; the buffer (via `gud-delete-prompt-marker'): it removes the prompt and
852 ;; then re-adds it later, thus messing up markers and overlays along the
854 ;; We use an "insert-before" marker for `start', since it's typically right
855 ;; after the prompt, which works around the problem, but is a hack (and
856 ;; comes with other downsides, e.g. if completion adds text at `start').
857 (list (copy-marker start t) end
858 (completion-table-dynamic
859 (apply-partially gud-gdb-completion-function
860 (buffer-substring (comint-line-beginning-position)
863 ;; (defun gud-gdb-complete-command ()
864 ;; "Perform completion on the GDB command preceding point.
865 ;; This is implemented using the GDB `complete' command which isn't
866 ;; available with older versions of GDB."
868 ;; (apply #'completion-in-region (gud-gdb-completion-at-point)))
870 ;; The completion process filter is installed temporarily to slurp the
871 ;; output of GDB up to the next prompt and build the completion list.
872 (defun gud-gdb-fetch-lines-filter (string)
873 "Filter used to read the list of lines output by a command.
874 STRING is the output to filter.
875 It is passed through `gud-gdb-marker-filter' before we look at it."
876 (setq string (gud-gdb-marker-filter string))
877 (setq string (concat gud-gdb-fetch-lines-string string))
878 (while (string-match "\n" string)
879 (push (substring string gud-gdb-fetch-lines-break (match-beginning 0))
880 gud-gdb-fetched-lines)
881 (setq string (substring string (match-end 0))))
882 (if (string-match comint-prompt-regexp string)
884 (setq gud-gdb-fetch-lines-in-progress nil)
887 (setq gud-gdb-fetch-lines-string string)
890 ;; gdb speedbar functions
892 ;; Part of the macro expansion of dframe-with-attached-buffer.
893 ;; At runtime, will be pulled in as a require of speedbar.
894 (declare-function dframe-select-attached-frame "dframe" (&optional frame))
895 (declare-function dframe-maybee-jump-to-attached-frame "dframe" ())
897 (defun gud-gdb-goto-stackframe (_text token _indent)
898 "Goto the stackframe described by TEXT, TOKEN, and INDENT."
899 (dframe-with-attached-buffer
900 (gud-basic-call (concat "server frame " (nth 1 token)))
903 (defvar gud-gdb-fetched-stack-frame nil
904 "Stack frames we are fetching from GDB.")
906 (defun gud-gdb-get-stackframe (buffer)
907 "Extract the current stack frame out of the GUD GDB BUFFER."
909 (fetched-stack-frame-list
910 (gud-gdb-run-command-fetch-lines "server backtrace" buffer)))
911 (if (and (car fetched-stack-frame-list)
912 (string-match "No stack" (car fetched-stack-frame-list)))
913 ;; Go into some other mode???
915 (dolist (e fetched-stack-frame-list)
916 (let ((name nil) (num nil))
918 (string-match "^#\\([0-9]+\\) +[0-9a-fx]+ in \\([:0-9a-zA-Z_]+\\) (" e)
919 (string-match "^#\\([0-9]+\\) +\\([:0-9a-zA-Z_]+\\) (" e)))
920 (if (not (string-match
921 "at \\([-0-9a-zA-Z_/.]+\\):\\([0-9]+\\)$" e))
924 (list (nth 0 (car newlst))
927 (match-string 2 e))))
928 (setq num (match-string 1 e)
929 name (match-string 2 e))
933 "at \\([-0-9a-zA-Z_/.]+\\):\\([0-9]+\\)$" e)
934 (list name num (match-string 1 e)
940 ;(defun gud-gdb-selected-frame-info (buffer)
941 ; "Learn GDB information for the currently selected stack frame in BUFFER."
944 (defun gud-gdb-run-command-fetch-lines (command buffer &optional skip)
945 "Run COMMAND, and return the list of lines it outputs.
946 BUFFER is the current buffer which may be the GUD buffer in which to run.
947 SKIP is the number of chars to skip on each line, it defaults to 0."
948 (with-current-buffer gud-comint-buffer
949 (unless (and (eq gud-comint-buffer buffer)
951 (goto-char (point-max))
953 (not (looking-at comint-prompt-regexp))))
954 (let ((gud-gdb-fetch-lines-in-progress t)
955 (gud-gdb-fetched-lines nil)
956 (gud-gdb-fetch-lines-string nil)
957 (gud-gdb-fetch-lines-break (or skip 0))
958 (gud-marker-filter #'gud-gdb-fetch-lines-filter))
959 ;; Issue the command to GDB.
960 (gud-basic-call command)
962 (while gud-gdb-fetch-lines-in-progress
963 (accept-process-output (get-buffer-process gud-comint-buffer)))
964 (nreverse gud-gdb-fetched-lines)))))
967 ;; ======================================================================
970 ;; History of argument lists passed to sdb.
971 (defvar gud-sdb-history nil)
973 (defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
974 "If nil, we're on a System V Release 4 and don't need the tags hack.")
976 (defvar gud-sdb-lastfile nil)
978 (defun gud-sdb-marker-filter (string)
980 (if gud-marker-acc (concat gud-marker-acc string) string))
982 ;; Process all complete markers in this chunk
985 ;; System V Release 3.2 uses this format
986 ((string-match "\\(^\\|\n\\)\\*?\\(0x\\w* in \\)?\\([^:\n]*\\):\\([0-9]*\\):.*\n"
987 gud-marker-acc start)
989 (cons (match-string 3 gud-marker-acc)
990 (string-to-number (match-string 4 gud-marker-acc)))))
991 ;; System V Release 4.0 quite often clumps two lines together
992 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
993 gud-marker-acc start)
994 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc))
996 (cons gud-sdb-lastfile
997 (string-to-number (match-string 3 gud-marker-acc)))))
998 ;; System V Release 4.0
999 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n"
1000 gud-marker-acc start)
1001 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc)))
1002 ((and gud-sdb-lastfile (string-match "^\\([0-9]+\\):"
1003 gud-marker-acc start))
1004 (setq gud-last-frame
1005 (cons gud-sdb-lastfile
1006 (string-to-number (match-string 1 gud-marker-acc)))))
1008 (setq gud-sdb-lastfile nil)))
1009 (setq start (match-end 0)))
1011 ;; Search for the last incomplete line in this chunk
1012 (while (string-match "\n" gud-marker-acc start)
1013 (setq start (match-end 0)))
1015 ;; If we have an incomplete line, store it in gud-marker-acc.
1016 (setq gud-marker-acc (substring gud-marker-acc (or start 0))))
1019 (defun gud-sdb-find-file (f)
1020 (if gud-sdb-needs-tags (find-tag-noselect f) (find-file-noselect f)))
1023 (defun sdb (command-line)
1024 "Run sdb on program FILE in buffer *gud-FILE*.
1025 The directory containing FILE becomes the initial working directory
1026 and source-file directory for your debugger."
1027 (interactive (list (gud-query-cmdline 'sdb)))
1029 (if gud-sdb-needs-tags (require 'etags))
1030 (if (and gud-sdb-needs-tags
1031 (not (and (boundp 'tags-file-name)
1032 (stringp tags-file-name)
1033 (file-exists-p tags-file-name))))
1034 (error "The sdb support requires a valid tags table to work"))
1036 (gud-common-init command-line nil 'gud-sdb-marker-filter 'gud-sdb-find-file)
1037 (set (make-local-variable 'gud-minor-mode) 'sdb)
1039 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
1040 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
1041 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
1042 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
1043 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
1044 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1045 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1046 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
1048 (setq comint-prompt-regexp "\\(^\\|\n\\)\\*")
1049 (setq paragraph-start comint-prompt-regexp)
1050 (run-hooks 'sdb-mode-hook)
1053 ;; ======================================================================
1056 ;; History of argument lists passed to dbx.
1057 (defvar gud-dbx-history nil)
1059 (defcustom gud-dbx-directories nil
1060 "A list of directories that dbx should search for source code.
1061 If nil, only source files in the program directory
1062 will be known to dbx.
1064 The file names should be absolute, or relative to the directory
1065 containing the executable being debugged."
1066 :type '(choice (const :tag "Current Directory" nil)
1071 (defun gud-dbx-massage-args (_file args)
1072 (nconc (let ((directories gud-dbx-directories)
1075 (setq result (cons (car directories) (cons "-I" result)))
1076 (setq directories (cdr directories)))
1080 (defun gud-dbx-marker-filter (string)
1081 (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
1084 ;; Process all complete markers in this chunk.
1085 (while (or (string-match
1086 "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
1087 gud-marker-acc start)
1089 "signal .* in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
1090 gud-marker-acc start))
1091 (setq gud-last-frame
1092 (cons (match-string 2 gud-marker-acc)
1093 (string-to-number (match-string 1 gud-marker-acc)))
1094 start (match-end 0)))
1096 ;; Search for the last incomplete line in this chunk
1097 (while (string-match "\n" gud-marker-acc start)
1098 (setq start (match-end 0)))
1100 ;; If the incomplete line APPEARS to begin with another marker, keep it
1101 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1102 ;; unnecessary concat during the next call.
1103 (setq gud-marker-acc
1104 (if (string-match "\\(stopped\\|signal\\)" gud-marker-acc start)
1105 (substring gud-marker-acc (match-beginning 0))
1109 ;; Functions for Mips-style dbx. Given the option `-emacs', documented in
1110 ;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
1112 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
1113 ;; We haven't tested gud on this system:
1114 (string-match "^mips-[^-]*-riscos" system-configuration)
1115 ;; It's documented on OSF/1.3
1116 (string-match "^mips-[^-]*-osf1" system-configuration)
1117 (string-match "^alpha[^-]*-[^-]*-osf" system-configuration))
1118 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
1120 (defvar gud-dbx-command-name
1121 (concat "dbx" (if gud-mips-p " -emacs")))
1123 ;; This is just like the gdb one except for the regexps since we need to cope
1124 ;; with an optional breakpoint number in [] before the ^Z^Z
1125 (defun gud-mipsdbx-marker-filter (string)
1126 (setq gud-marker-acc (concat gud-marker-acc string))
1129 ;; Process all the complete markers in this chunk.
1130 (while (string-match
1131 ;; This is like th gdb marker but with an optional
1132 ;; leading break point number like `[1] '
1133 "[][ 0-9]*\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
1137 ;; Extract the frame position from the marker.
1139 (cons (match-string 1 gud-marker-acc)
1140 (string-to-number (match-string 2 gud-marker-acc)))
1142 ;; Append any text before the marker to the output we're going
1143 ;; to return - we don't include the marker in this text.
1144 output (concat output
1145 (substring gud-marker-acc 0 (match-beginning 0)))
1147 ;; Set the accumulator to the remaining text.
1148 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1150 ;; Does the remaining text look like it might end with the
1151 ;; beginning of another marker? If it does, then keep it in
1152 ;; gud-marker-acc until we receive the rest of it. Since we
1153 ;; know the full marker regexp above failed, it's pretty simple to
1154 ;; test for marker starts.
1155 (if (string-match "[][ 0-9]*\032.*\\'" gud-marker-acc)
1157 ;; Everything before the potential marker start can be output.
1158 (setq output (concat output (substring gud-marker-acc
1159 0 (match-beginning 0))))
1161 ;; Everything after, we save, to combine with later input.
1162 (setq gud-marker-acc
1163 (substring gud-marker-acc (match-beginning 0))))
1165 (setq output (concat output gud-marker-acc)
1170 ;; The dbx in IRIX is a pain. It doesn't print the file name when
1171 ;; stopping at a breakpoint (but you do get it from the `up' and
1172 ;; `down' commands...). The only way to extract the information seems
1173 ;; to be with a `file' command, although the current line number is
1174 ;; available in $curline. Thus we have to look for output which
1175 ;; appears to indicate a breakpoint. Then we prod the dbx sub-process
1176 ;; to output the information we want with a combination of the
1177 ;; `printf' and `file' commands as a pseudo marker which we can
1178 ;; recognize next time through the marker-filter. This would be like
1179 ;; the gdb marker but you can't get the file name without a newline...
1180 ;; Note that gud-remove won't work since Irix dbx expects a breakpoint
1181 ;; number rather than a line number etc. Maybe this could be made to
1182 ;; work by listing all the breakpoints and picking the one(s) with the
1183 ;; correct line number, but life's too short.
1184 ;; d.love@dl.ac.uk (Dave Love) can be blamed for this
1187 (and (string-match "^mips-[^-]*-irix" system-configuration)
1188 (not (string-match "irix[6-9]\\.[1-9]" system-configuration)))
1189 "Non-nil to assume the interface appropriate for IRIX dbx.
1190 This works in IRIX 4, 5 and 6, but `gud-dbx-use-stopformat-p' provides
1191 a better solution in 6.1 upwards.")
1192 (defvar gud-dbx-use-stopformat-p
1193 (string-match "irix[6-9]\\.[1-9]" system-configuration)
1194 "Non-nil to use the dbx feature present at least from Irix 6.1
1195 whereby $stopformat=1 produces an output format compatible with
1196 `gud-dbx-marker-filter'.")
1197 ;; [Irix dbx seems to be a moving target. The dbx output changed
1198 ;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
1199 ;; the output from `up' is no longer spotted by gud (and it's probably
1200 ;; not distinctive enough to try to match it -- use C-<, C->
1201 ;; exclusively) . For 5.3 and 6.0, the $curline variable changed to
1202 ;; `long long'(why?!), so the printf stuff needed changing. The line
1203 ;; number was cast to `long' as a compromise between the new `long
1204 ;; long' and the original `int'. This is reported not to work in 6.2,
1205 ;; so it's changed back to int -- don't make your sources too long.
1206 ;; From Irix6.1 (but not 6.0?) dbx supports an undocumented feature
1207 ;; whereby `set $stopformat=1' reportedly produces output compatible
1208 ;; with `gud-dbx-marker-filter', which we prefer.
1210 ;; The process filter is also somewhat
1211 ;; unreliable, sometimes not spotting the markers; I don't know
1212 ;; whether there's anything that can be done about that. It would be
1213 ;; much better if SGI could be persuaded to (re?)instate the MIPS
1214 ;; -emacs flag for gdb-like output (which ought to be possible as most
1215 ;; of the communication I've had over it has been from sgi.com).]
1217 ;; this filter is influenced by the xdb one rather than the gdb one
1218 (defun gud-irixdbx-marker-filter (string)
1219 (let (result (case-fold-search nil))
1220 (if (or (string-match comint-prompt-regexp string)
1221 (string-match ".*\012" string))
1222 (setq result (concat gud-marker-acc string)
1224 (setq gud-marker-acc (concat gud-marker-acc string)))
1227 ;; look for breakpoint or signal indication e.g.:
1228 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
1229 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
1230 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
1232 "^\\(\\[[0-9]+] \\)?Process +[0-9]+ ([^)]*) [^[]+\\[[^]\n]*]\n"
1234 ;; prod dbx into printing out the line number and file
1235 ;; name in a form we can grok as below
1236 (process-send-string (get-buffer-process gud-comint-buffer)
1237 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1238 ;; look for result of, say, "up" e.g.:
1239 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
1240 ;; (this will also catch one of the lines printed by "where")
1242 "^[^ ][^[]*\\[\"\\([^\"]+\\)\":\\([0-9]+\\), [^]]+]\n"
1244 (let ((file (match-string 1 result)))
1245 (if (file-exists-p file)
1246 (setq gud-last-frame
1247 (cons (match-string 1 result)
1248 (string-to-number (match-string 2 result))))))
1250 ((string-match ; kluged-up marker as above
1251 "\032\032\\([0-9]*\\):\\(.*\\)\n" result)
1252 (let ((file (gud-file-name (match-string 2 result))))
1253 (if (and file (file-exists-p file))
1254 (setq gud-last-frame
1256 (string-to-number (match-string 1 result))))))
1257 (setq result (substring result 0 (match-beginning 0))))))
1260 ;; There are a couple of differences between DG's dbx output and normal
1261 ;; dbx output which make it nontrivial to integrate this into the
1262 ;; standard dbx-marker-filter (mainly, there are a different number of
1263 ;; backreferences). The markers look like:
1265 ;; (0) Stopped at line 10, routine main(argc=1, argv=0xeffff0e0), file t.c
1267 ;; from breakpoints (the `(0)' there isn't constant, it's the breakpoint
1270 ;; Stopped at line 13, routine main(argc=1, argv=0xeffff0e0), file t.c
1274 ;; Frame 21, line 974, routine command_loop(), file keyboard.c
1276 ;; from up/down/where.
1278 (defun gud-dguxdbx-marker-filter (string)
1279 (setq gud-marker-acc (if gud-marker-acc
1280 (concat gud-marker-acc string)
1282 (let ((re (concat "^\\(\\(([0-9]+) \\)?Stopped at\\|Frame [0-9]+,\\)"
1283 " line \\([0-9]+\\), routine .*, file \\([^ \t\n]+\\)"))
1285 ;; Process all complete markers in this chunk.
1286 (while (string-match re gud-marker-acc start)
1287 (setq gud-last-frame
1288 (cons (match-string 4 gud-marker-acc)
1289 (string-to-number (match-string 3 gud-marker-acc)))
1290 start (match-end 0)))
1292 ;; Search for the last incomplete line in this chunk
1293 (while (string-match "\n" gud-marker-acc start)
1294 (setq start (match-end 0)))
1296 ;; If the incomplete line APPEARS to begin with another marker, keep it
1297 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1298 ;; unnecessary concat during the next call.
1299 (setq gud-marker-acc
1300 (if (string-match "Stopped\\|Frame" gud-marker-acc start)
1301 (substring gud-marker-acc (match-beginning 0))
1306 (defun dbx (command-line)
1307 "Run dbx on program FILE in buffer *gud-FILE*.
1308 The directory containing FILE becomes the initial working directory
1309 and source-file directory for your debugger."
1310 (interactive (list (gud-query-cmdline 'dbx)))
1314 (gud-common-init command-line nil 'gud-mipsdbx-marker-filter))
1316 (gud-common-init command-line 'gud-dbx-massage-args
1317 'gud-irixdbx-marker-filter))
1319 (gud-common-init command-line 'gud-dbx-massage-args
1320 'gud-dbx-marker-filter)))
1322 (set (make-local-variable 'gud-minor-mode) 'dbx)
1326 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1327 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1328 (gud-def gud-break "stop at \"%f\":%l"
1329 "\C-b" "Set breakpoint at current line.")
1330 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
1332 (gud-def gud-break "stop at \"%d%f\":%l"
1333 "\C-b" "Set breakpoint at current line.")
1334 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1335 (gud-def gud-up "up %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1336 "<" "Up (numeric arg) stack frames.")
1337 (gud-def gud-down "down %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1338 ">" "Down (numeric arg) stack frames.")
1339 ;; Make dbx give out the source location info that we need.
1340 (process-send-string (get-buffer-process gud-comint-buffer)
1341 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1343 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1344 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1345 (gud-def gud-break "file \"%d%f\"\nstop at %l"
1346 "\C-b" "Set breakpoint at current line.")
1347 (if gud-dbx-use-stopformat-p
1348 (process-send-string (get-buffer-process gud-comint-buffer)
1349 "set $stopformat=1\n"))))
1351 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
1352 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
1353 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
1354 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
1355 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
1356 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
1357 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
1358 (gud-def gud-run "run" nil "Run the program.")
1360 (setq comint-prompt-regexp "^[^)\n]*dbx) *")
1361 (setq paragraph-start comint-prompt-regexp)
1362 (run-hooks 'dbx-mode-hook)
1365 ;; ======================================================================
1366 ;; xdb (HP PA-RISC debugger) functions
1368 ;; History of argument lists passed to xdb.
1369 (defvar gud-xdb-history nil)
1371 (defcustom gud-xdb-directories nil
1372 "A list of directories that xdb should search for source code.
1373 If nil, only source files in the program directory
1374 will be known to xdb.
1376 The file names should be absolute, or relative to the directory
1377 containing the executable being debugged."
1378 :type '(choice (const :tag "Current Directory" nil)
1383 (defun gud-xdb-massage-args (_file args)
1384 (nconc (let ((directories gud-xdb-directories)
1387 (setq result (cons (car directories) (cons "-d" result)))
1388 (setq directories (cdr directories)))
1392 ;; xdb does not print the lines all at once, so we have to accumulate them
1393 (defun gud-xdb-marker-filter (string)
1395 (if (or (string-match comint-prompt-regexp string)
1396 (string-match ".*\012" string))
1397 (setq result (concat gud-marker-acc string)
1399 (setq gud-marker-acc (concat gud-marker-acc string)))
1401 (if (or (string-match "\\([^\n \t:]+\\): [^:]+: \\([0-9]+\\)[: ]"
1403 (string-match "[^: \t]+:[ \t]+\\([^:]+\\): [^:]+: \\([0-9]+\\):"
1405 (let ((line (string-to-number (match-string 2 result)))
1406 (file (gud-file-name (match-string 1 result))))
1408 (setq gud-last-frame (cons file line))))))
1412 (defun xdb (command-line)
1413 "Run xdb on program FILE in buffer *gud-FILE*.
1414 The directory containing FILE becomes the initial working directory
1415 and source-file directory for your debugger.
1417 You can set the variable `gud-xdb-directories' to a list of program source
1418 directories if your program contains sources from more than one directory."
1419 (interactive (list (gud-query-cmdline 'xdb)))
1421 (gud-common-init command-line 'gud-xdb-massage-args
1422 'gud-xdb-marker-filter)
1423 (set (make-local-variable 'gud-minor-mode) 'xdb)
1425 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
1426 (gud-def gud-tbreak "b %f:%l\\t" "\C-t"
1427 "Set temporary breakpoint at current line.")
1428 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
1429 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
1430 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1431 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1432 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1433 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1434 (gud-def gud-finish "bu\\t" "\C-f" "Finish executing current function.")
1435 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
1437 (setq comint-prompt-regexp "^>")
1438 (setq paragraph-start comint-prompt-regexp)
1439 (run-hooks 'xdb-mode-hook))
1441 ;; ======================================================================
1444 ;; History of argument lists passed to perldb.
1445 (defvar gud-perldb-history nil)
1447 (defun gud-perldb-massage-args (_file args)
1448 "Convert a command line as would be typed normally to run perldb
1449 into one that invokes an Emacs-enabled debugging session.
1450 \"-emacs\" is inserted where it will be $ARGV[0] (see perl5db.pl)."
1451 ;; FIXME: what if the command is `make perldb' and doesn't accept those extra
1453 (let* ((new-args nil)
1455 (shift (lambda () (push (pop args) new-args))))
1457 ;; Pass all switches and -e scripts through.
1459 (string-match "^-" (car args))
1460 (not (equal "-" (car args)))
1461 (not (equal "--" (car args))))
1462 (when (equal "-e" (car args))
1463 ;; -e goes with the next arg, so shift one extra.
1465 ;; -e as the last arg is an error in Perl.
1466 (error "No code specified for -e"))
1472 (string-match "^-" (car args)))
1473 (error "Can't use stdin as the script to debug"))
1474 ;; This is the program name.
1477 ;; If -e specified, make sure there is a -- so -emacs is not taken
1479 (if (and args (equal "--" (car args)))
1481 (and seen-e (push "--" new-args)))
1483 (push "-emacs" new-args)
1487 (nreverse new-args)))
1489 ;; There's no guarantee that Emacs will hand the filter the entire
1490 ;; marker at once; it could be broken up across several strings. We
1491 ;; might even receive a big chunk with several markers in it. If we
1492 ;; receive a chunk of text which looks like it might contain the
1493 ;; beginning of a marker, we save it here between calls to the
1495 (defun gud-perldb-marker-filter (string)
1496 (setq gud-marker-acc (concat gud-marker-acc string))
1499 ;; Process all the complete markers in this chunk.
1501 ;; Here I match the string coming out of perldb.
1502 ;; The strings can look like any of
1504 ;; "\032\032/tmp/tst.pl:6:0\n"
1505 ;; "\032\032(eval 5)[/tmp/tst.pl:6]:3:0\n"
1506 ;; "\032\032(eval 17)[Basic/Core/Core.pm.PL (i.e. PDL::Core.pm):2931]:1:0\n"
1508 ;; From those I want the filename and the line number. First I look for
1509 ;; the eval case. If that doesn't match, I look for the "normal" case.
1513 (let ((file-re "\\(?:[a-zA-Z]:\\)?[^:\n]*"))
1514 (concat "\032\032\\(?:"
1517 "\\(" file-re "\\)" ; Filename.
1518 "\\(?: (i\\.e\\. [^)]*)\\)?"
1519 ":\\([0-9]*\\)\\]") ; Line number.
1522 "\\(?1:" file-re "\\)" ; Filename.
1523 ":\\(?2:[0-9]*\\)") ; Line number.
1528 ;; Extract the frame position from the marker.
1530 (cons (match-string 1 gud-marker-acc)
1531 (string-to-number (match-string 2 gud-marker-acc)))
1533 ;; Append any text before the marker to the output we're going
1534 ;; to return - we don't include the marker in this text.
1535 output (concat output
1536 (substring gud-marker-acc 0 (match-beginning 0)))
1538 ;; Set the accumulator to the remaining text.
1539 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1541 ;; Does the remaining text look like it might end with the
1542 ;; beginning of another marker? If it does, then keep it in
1543 ;; gud-marker-acc until we receive the rest of it. Since we
1544 ;; know the full marker regexp above failed, it's pretty simple to
1545 ;; test for marker starts.
1546 (if (string-match "\032.*\\'" gud-marker-acc)
1548 ;; Everything before the potential marker start can be output.
1549 (setq output (concat output (substring gud-marker-acc
1550 0 (match-beginning 0))))
1552 ;; Everything after, we save, to combine with later input.
1553 (setq gud-marker-acc
1554 (substring gud-marker-acc (match-beginning 0))))
1556 (setq output (concat output gud-marker-acc)
1561 (defcustom gud-perldb-command-name "perl -d"
1562 "Default command to execute a Perl script under debugger."
1567 (defun perldb (command-line)
1568 "Run perldb on program FILE in buffer *gud-FILE*.
1569 The directory containing FILE becomes the initial working directory
1570 and source-file directory for your debugger."
1572 (list (gud-query-cmdline 'perldb
1573 (concat (or (buffer-file-name) "-e 0") " "))))
1575 (gud-common-init command-line 'gud-perldb-massage-args
1576 'gud-perldb-marker-filter)
1577 (set (make-local-variable 'gud-minor-mode) 'perldb)
1579 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
1580 (gud-def gud-remove "B %l" "\C-d" "Remove breakpoint at current line")
1581 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
1582 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
1583 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1584 ; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
1585 ; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
1586 ; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
1587 (gud-def gud-print "p %e" "\C-p" "Evaluate perl expression at point.")
1588 (gud-def gud-until "c %l" "\C-u" "Continue to current line.")
1591 (setq comint-prompt-regexp "^ DB<+[0-9]+>+ ")
1592 (setq paragraph-start comint-prompt-regexp)
1593 (run-hooks 'perldb-mode-hook))
1595 ;; ======================================================================
1596 ;; pdb (Python debugger) functions
1598 ;; History of argument lists passed to pdb.
1599 (defvar gud-pdb-history nil)
1601 ;; Last group is for return value, e.g. "> test.py(2)foo()->None"
1602 ;; Either file or function name may be omitted: "> <string>(0)?()"
1603 (defvar gud-pdb-marker-regexp
1604 "^> \\([-a-zA-Z0-9_/.:\\]*\\|<string>\\)(\\([0-9]+\\))\\([a-zA-Z0-9_]*\\|\\?\\|<module>\\)()\\(->[^\n\r]*\\)?[\n\r]")
1606 (defvar gud-pdb-marker-regexp-file-group 1)
1607 (defvar gud-pdb-marker-regexp-line-group 2)
1608 (defvar gud-pdb-marker-regexp-fnname-group 3)
1610 (defvar gud-pdb-marker-regexp-start "^> ")
1612 ;; There's no guarantee that Emacs will hand the filter the entire
1613 ;; marker at once; it could be broken up across several strings. We
1614 ;; might even receive a big chunk with several markers in it. If we
1615 ;; receive a chunk of text which looks like it might contain the
1616 ;; beginning of a marker, we save it here between calls to the
1618 (defun gud-pdb-marker-filter (string)
1619 (setq gud-marker-acc (concat gud-marker-acc string))
1622 ;; Process all the complete markers in this chunk.
1623 (while (string-match gud-pdb-marker-regexp gud-marker-acc)
1626 ;; Extract the frame position from the marker.
1628 (let ((file (match-string gud-pdb-marker-regexp-file-group
1630 (line (string-to-number
1631 (match-string gud-pdb-marker-regexp-line-group
1633 (if (string-equal file "<string>")
1637 ;; Output everything instead of the below
1638 output (concat output (substring gud-marker-acc 0 (match-end 0)))
1639 ;; ;; Append any text before the marker to the output we're going
1640 ;; ;; to return - we don't include the marker in this text.
1641 ;; output (concat output
1642 ;; (substring gud-marker-acc 0 (match-beginning 0)))
1644 ;; Set the accumulator to the remaining text.
1645 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1647 ;; Does the remaining text look like it might end with the
1648 ;; beginning of another marker? If it does, then keep it in
1649 ;; gud-marker-acc until we receive the rest of it. Since we
1650 ;; know the full marker regexp above failed, it's pretty simple to
1651 ;; test for marker starts.
1652 (if (string-match gud-pdb-marker-regexp-start gud-marker-acc)
1654 ;; Everything before the potential marker start can be output.
1655 (setq output (concat output (substring gud-marker-acc
1656 0 (match-beginning 0))))
1658 ;; Everything after, we save, to combine with later input.
1659 (setq gud-marker-acc
1660 (substring gud-marker-acc (match-beginning 0))))
1662 (setq output (concat output gud-marker-acc)
1667 (defcustom gud-pdb-command-name "pdb"
1668 "File name for executing the Python debugger.
1669 This should be an executable on your path, or an absolute file name."
1674 (defun pdb (command-line)
1675 "Run pdb on program FILE in buffer `*gud-FILE*'.
1676 The directory containing FILE becomes the initial working directory
1677 and source-file directory for your debugger."
1679 (list (gud-query-cmdline 'pdb)))
1681 (gud-common-init command-line nil 'gud-pdb-marker-filter)
1682 (set (make-local-variable 'gud-minor-mode) 'pdb)
1684 (gud-def gud-break "break %d%f:%l" "\C-b" "Set breakpoint at current line.")
1685 (gud-def gud-remove "clear %d%f:%l" "\C-d" "Remove breakpoint at current line")
1686 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
1687 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
1688 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
1689 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1690 (gud-def gud-up "up" "<" "Up one stack frame.")
1691 (gud-def gud-down "down" ">" "Down one stack frame.")
1692 (gud-def gud-print "p %e" "\C-p" "Evaluate Python expression at point.")
1694 (gud-def gud-statement "! %e" "\C-e" "Execute Python statement at point.")
1696 ;; (setq comint-prompt-regexp "^(.*pdb[+]?) *")
1697 (setq comint-prompt-regexp "^(Pdb) *")
1698 (setq paragraph-start comint-prompt-regexp)
1699 (run-hooks 'pdb-mode-hook))
1701 ;; ======================================================================
1705 ;; AUTHOR: Derek Davies <ddavies@world.std.com>
1706 ;; Zoltan Kemenczy <zoltan@ieee.org;zkemenczy@rim.net>
1708 ;; CREATED: Sun Feb 22 10:46:38 1998 Derek Davies.
1709 ;; UPDATED: Nov 11, 2001 Zoltan Kemenczy
1710 ;; Dec 10, 2002 Zoltan Kemenczy - added nested class support
1712 ;; INVOCATION NOTES:
1714 ;; You invoke jdb-mode with:
1718 ;; It responds with:
1720 ;; Run jdb (like this): jdb
1722 ;; type any jdb switches followed by the name of the class you'd like to debug.
1723 ;; Supply a fully qualified classname (these don't have the ".class" extension)
1724 ;; for the name of the class to debug (e.g. "COM.the-kind.ddavies.CoolClass").
1725 ;; See the known problems section below for restrictions when specifying jdb
1726 ;; command line switches (search forward for '-classpath').
1728 ;; You should see something like the following:
1730 ;; Current directory is ~/src/java/hello/
1731 ;; Initializing jdb...
1732 ;; 0xed2f6628:class(hello)
1735 ;; To set an initial breakpoint try:
1737 ;; > stop in hello.main
1738 ;; Breakpoint set in hello.main
1741 ;; To execute the program type:
1746 ;; Breakpoint hit: running ...
1747 ;; hello.main (hello:12)
1749 ;; Type M-n to step over the current line and M-s to step into it. That,
1750 ;; along with the JDB 'help' command should get you started. The 'quit'
1751 ;; JDB command will get out out of the debugger. There is some truly
1752 ;; pathetic JDB documentation available at:
1754 ;; http://java.sun.com/products/jdk/1.1/debugging/
1756 ;; KNOWN PROBLEMS AND FIXME's:
1758 ;; Not sure what happens with inner classes ... haven't tried them.
1760 ;; Does not grok UNICODE id's. Only ASCII id's are supported.
1762 ;; You must not put whitespace between "-classpath" and the path to
1763 ;; search for java classes even though it is required when invoking jdb
1764 ;; from the command line. See gud-jdb-massage-args for details.
1765 ;; The same applies for "-sourcepath".
1767 ;; Note: The following applies only if `gud-jdb-use-classpath' is nil;
1768 ;; refer to the documentation of `gud-jdb-use-classpath' and
1769 ;; `gud-jdb-classpath',`gud-jdb-sourcepath' variables for information
1770 ;; on using the classpath for locating java source files.
1772 ;; If any of the source files in the directories listed in
1773 ;; gud-jdb-directories won't parse you'll have problems. Make sure
1774 ;; every file ending in ".java" in these directories parses without error.
1776 ;; All the .java files in the directories in gud-jdb-directories are
1777 ;; syntactically analyzed each time gud jdb is invoked. It would be
1778 ;; nice to keep as much information as possible between runs. It would
1779 ;; be really nice to analyze the files only as necessary (when the
1780 ;; source needs to be displayed.) I'm not sure to what extent the former
1781 ;; can be accomplished and I'm not sure the latter can be done at all
1782 ;; since I don't know of any general way to tell which .class files are
1783 ;; defined by which .java file without analyzing all the .java files.
1784 ;; If anyone knows why JavaSoft didn't put the source file names in
1785 ;; debuggable .class files please clue me in so I find something else
1786 ;; to be spiteful and bitter about.
1788 ;; ======================================================================
1789 ;; gud jdb variables and functions
1791 (defcustom gud-jdb-command-name "jdb"
1792 "Command that executes the Java debugger."
1796 (defcustom gud-jdb-use-classpath t
1797 "If non-nil, search for Java source files in classpath directories.
1798 The list of directories to search is the value of `gud-jdb-classpath'.
1799 The file pathname is obtained by converting the fully qualified
1800 class information output by jdb to a relative pathname and appending
1801 it to `gud-jdb-classpath' element by element until a match is found.
1803 This method has a significant jdb startup time reduction advantage
1804 since it does not require the scanning of all `gud-jdb-directories'
1805 and parsing all Java files for class information.
1807 Set to nil to use `gud-jdb-directories' to scan java sources for
1808 class information on jdb startup (original method)."
1812 (defvar gud-jdb-classpath nil
1813 "Java/jdb classpath directories list.
1814 If `gud-jdb-use-classpath' is non-nil, gud-jdb derives the `gud-jdb-classpath'
1815 list automatically using the following methods in sequence
1816 \(with subsequent successful steps overriding the results of previous
1819 1) Read the CLASSPATH environment variable,
1820 2) Read any \"-classpath\" argument used to run jdb,
1821 or detected in jdb output (e.g. if jdb is run by a script
1822 that echoes the actual jdb command before starting jdb),
1823 3) Send a \"classpath\" command to jdb and scan jdb output for
1824 classpath information if jdb is invoked with an \"-attach\" (to
1825 an already running VM) argument (This case typically does not
1826 have a \"-classpath\" command line argument - that is provided
1827 to the VM when it is started).
1829 Note that method 3 cannot be used with oldjdb (or Java 1 jdb) since
1830 those debuggers do not support the classpath command. Use 1) or 2).")
1832 (defvar gud-jdb-sourcepath nil
1833 "Directory list provided by an (optional) \"-sourcepath\" option to jdb.
1834 This list is prepended to `gud-jdb-classpath' to form the complete
1835 list of directories searched for source files.")
1837 (defvar gud-marker-acc-max-length 4000
1838 "Maximum number of debugger output characters to keep.
1839 This variable limits the size of `gud-marker-acc' which holds
1840 the most recent debugger output history while searching for
1841 source file information.")
1843 (defvar gud-jdb-history nil
1844 "History of argument lists passed to jdb.")
1847 ;; List of Java source file directories.
1848 (defvar gud-jdb-directories (list ".")
1849 "A list of directories that gud jdb should search for source code.
1850 The file names should be absolute, or relative to the current
1853 The set of .java files residing in the directories listed are
1854 syntactically analyzed to determine the classes they define and the
1855 packages in which these classes belong. In this way gud jdb maps the
1856 package-qualified class names output by the jdb debugger to the source
1857 file from which the class originated. This allows gud mode to keep
1858 the source code display in sync with the debugging session.")
1860 (defvar gud-jdb-source-files nil
1861 "List of the java source files for this debugging session.")
1863 ;; Association list of fully qualified class names (package + class name)
1864 ;; and their source files.
1865 (defvar gud-jdb-class-source-alist nil
1866 "Association list of fully qualified class names and source files.")
1868 ;; This is used to hold a source file during analysis.
1869 (defvar gud-jdb-analysis-buffer nil)
1871 (defvar gud-jdb-classpath-string nil
1872 "Holds temporary classpath values.")
1874 (defun gud-jdb-build-source-files-list (path extn)
1875 "Return a list of java source files (absolute paths).
1876 PATH gives the directories in which to search for files with
1877 extension EXTN. Normally EXTN is given as the regular expression
1879 (apply 'nconc (mapcar (lambda (d)
1880 (when (file-directory-p d)
1881 (directory-files d t extn nil)))
1884 ;; Move point past whitespace.
1885 (defun gud-jdb-skip-whitespace ()
1886 (skip-chars-forward " \n\r\t\014"))
1888 ;; Move point past a "// <eol>" type of comment.
1889 (defun gud-jdb-skip-single-line-comment ()
1892 ;; Move point past a "/* */" or "/** */" type of comment.
1893 (defun gud-jdb-skip-traditional-or-documentation-comment ()
1897 (if (eq (following-char) ?*)
1901 (if (eq (following-char) ?/)
1904 (throw 'break nil)))))
1907 ;; Move point past any number of consecutive whitespace chars and/or comments.
1908 (defun gud-jdb-skip-whitespace-and-comments ()
1909 (gud-jdb-skip-whitespace)
1914 (gud-jdb-skip-single-line-comment)
1915 (gud-jdb-skip-whitespace))
1916 ((looking-at "/\\*")
1917 (gud-jdb-skip-traditional-or-documentation-comment)
1918 (gud-jdb-skip-whitespace))
1919 (t (throw 'done nil))))))
1921 ;; Move point past things that are id-like. The intent is to skip regular
1922 ;; id's, such as class or interface names as well as package and interface
1924 (defun gud-jdb-skip-id-ish-thing ()
1925 (skip-chars-forward "^ /\n\r\t\014,;{"))
1927 ;; Move point past a string literal.
1928 (defun gud-jdb-skip-string-literal ()
1931 ((eq (following-char) ?\\)
1933 ((eq (following-char) ?\042))))
1937 ;; Move point past a character literal.
1938 (defun gud-jdb-skip-character-literal ()
1942 (if (eq (following-char) ?\\)
1944 (not (eq (following-char) ?\')))
1948 ;; Move point past the following block. There may be (legal) cruft before
1949 ;; the block's opening brace. There must be a block or it's the end of life
1950 ;; in petticoat junction.
1951 (defun gud-jdb-skip-block ()
1953 ;; Find the beginning of the block.
1955 (not (eq (following-char) ?{))
1957 ;; Skip any constructs that can harbor literal block delimiter
1958 ;; characters and/or the delimiters for the constructs themselves.
1961 (gud-jdb-skip-single-line-comment))
1962 ((looking-at "/\\*")
1963 (gud-jdb-skip-traditional-or-documentation-comment))
1964 ((eq (following-char) ?\042)
1965 (gud-jdb-skip-string-literal))
1966 ((eq (following-char) ?\')
1967 (gud-jdb-skip-character-literal))
1968 (t (forward-char))))
1970 ;; Now at the beginning of the block.
1973 ;; Skip over the body of the block as well as the final brace.
1974 (let ((open-level 1))
1975 (while (not (eq open-level 0))
1978 (gud-jdb-skip-single-line-comment))
1979 ((looking-at "/\\*")
1980 (gud-jdb-skip-traditional-or-documentation-comment))
1981 ((eq (following-char) ?\042)
1982 (gud-jdb-skip-string-literal))
1983 ((eq (following-char) ?\')
1984 (gud-jdb-skip-character-literal))
1985 ((eq (following-char) ?{)
1986 (setq open-level (+ open-level 1))
1988 ((eq (following-char) ?})
1989 (setq open-level (- open-level 1))
1991 (t (forward-char))))))
1993 ;; Find the package and class definitions in Java source file FILE. Assumes
1994 ;; that FILE contains a legal Java program. BUF is a scratch buffer used
1995 ;; to hold the source during analysis.
1996 (defun gud-jdb-analyze-source (buf file)
1999 (insert-file-contents file nil nil nil t)
2004 (gud-jdb-skip-whitespace)
2008 ;; Any number of semi's following a block is legal. Move point
2009 ;; past them. Note that comments and whitespace may be
2010 ;; interspersed as well.
2011 ((eq (following-char) ?\073)
2014 ;; Move point past a single line comment.
2016 (gud-jdb-skip-single-line-comment))
2018 ;; Move point past a traditional or documentation comment.
2019 ((looking-at "/\\*")
2020 (gud-jdb-skip-traditional-or-documentation-comment))
2022 ;; Move point past a package statement, but save the PackageName.
2023 ((looking-at "package")
2025 (gud-jdb-skip-whitespace-and-comments)
2027 (gud-jdb-skip-id-ish-thing)
2028 (setq p (concat (buffer-substring s (point)) "."))
2029 (gud-jdb-skip-whitespace-and-comments)
2030 (if (eq (following-char) ?\073)
2033 ;; Move point past an import statement.
2034 ((looking-at "import")
2036 (gud-jdb-skip-whitespace-and-comments)
2037 (gud-jdb-skip-id-ish-thing)
2038 (gud-jdb-skip-whitespace-and-comments)
2039 (if (eq (following-char) ?\073)
2042 ;; Move point past the various kinds of ClassModifiers.
2043 ((looking-at "public")
2045 ((looking-at "abstract")
2047 ((looking-at "final")
2050 ;; Move point past a ClassDeclaration, but save the class
2052 ((looking-at "class")
2054 (gud-jdb-skip-whitespace-and-comments)
2056 (gud-jdb-skip-id-ish-thing)
2058 l (nconc l (list (concat p (buffer-substring s (point)))))))
2059 (gud-jdb-skip-block))
2061 ;; Move point past an interface statement.
2062 ((looking-at "interface")
2064 (gud-jdb-skip-block))
2066 ;; Anything else means the input is invalid.
2068 (message "Error parsing file %s." file)
2069 (throw 'abort nil))))))
2072 (defun gud-jdb-build-class-source-alist-for-file (file)
2076 (gud-jdb-analyze-source gud-jdb-analysis-buffer file)))
2078 ;; Return an alist of fully qualified classes and the source files
2079 ;; holding their definitions. SOURCES holds a list of all the source
2080 ;; files to examine.
2081 (defun gud-jdb-build-class-source-alist (sources)
2082 (setq gud-jdb-analysis-buffer (get-buffer-create " *gud-jdb-scratch*"))
2087 'gud-jdb-build-class-source-alist-for-file
2089 (kill-buffer gud-jdb-analysis-buffer)
2090 (setq gud-jdb-analysis-buffer nil)))
2092 ;; Change what was given in the minibuffer to something that can be used to
2093 ;; invoke the debugger.
2094 (defun gud-jdb-massage-args (_file args)
2095 ;; The jdb executable must have whitespace between "-classpath" and
2096 ;; its value while gud-common-init expects all switch values to
2097 ;; follow the switch keyword without intervening whitespace. We
2098 ;; require that when the user enters the "-classpath" switch in the
2099 ;; EMACS minibuffer that they do so without the intervening
2100 ;; whitespace. This function adds it back (it's called after
2101 ;; gud-common-init). There are more switches like this (for
2102 ;; instance "-host" and "-password") but I don't care about them
2105 (let (massaged-args user-error)
2107 (while (and args (not user-error))
2109 ((setq user-error (string-match "-classpath$" (car args))))
2110 ((setq user-error (string-match "-sourcepath$" (car args))))
2111 ((string-match "-classpath\\(.+\\)" (car args))
2113 (append massaged-args
2115 (setq gud-jdb-classpath-string
2116 (match-string 1 (car args)))))))
2117 ((string-match "-sourcepath\\(.+\\)" (car args))
2119 (append massaged-args
2121 (setq gud-jdb-sourcepath
2122 (match-string 1 (car args)))))))
2123 (t (setq massaged-args (append massaged-args (list (car args))))))
2124 (setq args (cdr args)))
2126 ;; By this point the current directory is all screwed up. Maybe we
2127 ;; could fix things and re-invoke gud-common-init, but for now I think
2128 ;; issuing the error is good enough.
2131 (kill-buffer (current-buffer))
2132 (error "Error: Omit whitespace between '-classpath or -sourcepath' and its value")))
2135 ;; Search for an association with P, a fully qualified class name, in
2136 ;; gud-jdb-class-source-alist. The association gives the fully
2137 ;; qualified file name of the source file which produced the class.
2138 (defun gud-jdb-find-source-file (p)
2139 (cdr (assoc p gud-jdb-class-source-alist)))
2141 ;; Note: Reset to this value every time a prompt is seen
2142 (defvar gud-jdb-lowest-stack-level 999)
2144 (defun gud-jdb-find-source-using-classpath (p)
2145 "Find source file corresponding to fully qualified class P.
2146 Convert P from jdb's output, converted to a pathname
2147 relative to a classpath directory."
2150 (;; Replace dots with slashes and append ".java" to generate file
2151 ;; name relative to classpath
2154 (mapconcat 'identity
2156 ;; Eliminate any subclass references in the class
2157 ;; name string. These start with a "$"
2158 (if (string-match "$.*" p)
2159 (replace-match "" t t p) p)
2162 (cplist (append gud-jdb-sourcepath gud-jdb-classpath))
2165 (not (setq found-file
2167 (concat (car cplist) "/" filename)))))
2168 (setq cplist (cdr cplist)))
2169 (if found-file (concat (car cplist) "/" filename)))))
2171 (defun gud-jdb-find-source (_string)
2172 "Alias for function used to locate source files.
2173 Set to `gud-jdb-find-source-using-classpath' or `gud-jdb-find-source-file'
2174 during jdb initialization depending on the value of
2175 `gud-jdb-use-classpath'."
2178 (defun gud-jdb-parse-classpath-string (string)
2179 "Parse the classpath list and convert each item to an absolute pathname."
2180 (mapcar (lambda (s) (if (string-match "[/\\]$" s)
2181 (replace-match "" nil nil s) s))
2182 (mapcar 'file-truename
2185 (concat "[ \t\n\r,\"" path-separator "]+")))))
2187 ;; See commentary for other debugger's marker filters - there you will find
2188 ;; important notes about STRING.
2189 (defun gud-jdb-marker-filter (string)
2191 ;; Build up the accumulator.
2192 (setq gud-marker-acc
2194 (concat gud-marker-acc string)
2197 ;; Look for classpath information until gud-jdb-classpath-string is found
2198 ;; (interactive, multiple settings of classpath from jdb
2199 ;; not supported/followed)
2200 (if (and gud-jdb-use-classpath
2201 (not gud-jdb-classpath-string)
2202 (or (string-match "classpath:[ \t[]+\\([^]]+\\)" gud-marker-acc)
2203 (string-match "-classpath[ \t\"]+\\([^ \"]+\\)" gud-marker-acc)))
2204 (setq gud-jdb-classpath
2205 (gud-jdb-parse-classpath-string
2206 (setq gud-jdb-classpath-string
2207 (match-string 1 gud-marker-acc)))))
2209 ;; We process STRING from left to right. Each time through the
2210 ;; following loop we process at most one marker. After we've found a
2211 ;; marker, delete gud-marker-acc up to and including the match
2213 ;; Process each complete marker in the input.
2216 ;; Do we see a marker?
2218 ;; jdb puts out a string of the following form when it
2219 ;; hits a breakpoint:
2221 ;; <fully-qualified-class><method> (<class>:<line-number>)
2223 ;; <fully-qualified-class>'s are composed of Java ID's
2224 ;; separated by periods. <method> and <class> are
2225 ;; also Java ID's. <method> begins with a period and
2226 ;; may contain less-than and greater-than (constructors,
2227 ;; for instance, are called <init> in the symbol table.)
2228 ;; Java ID's begin with a letter followed by letters
2229 ;; and/or digits. The set of letters includes underscore
2232 ;; The first group matches <fully-qualified-class>,
2233 ;; the second group matches <class> and the third group
2234 ;; matches <line-number>. We don't care about using
2235 ;; <method> so we don't "group" it.
2237 ;; FIXME: Java ID's are UNICODE strings, this matches ASCII
2240 ;; The ".," in the last square-bracket are necessary because
2241 ;; of Sun's total disrespect for backwards compatibility in
2242 ;; reported line numbers from jdb - starting in 1.4.0 they
2243 ;; print line numbers using LOCALE, inserting a comma or a
2244 ;; period at the thousands positions (how ingenious!).
2246 "\\(\\[[0-9]+] \\)*\\([a-zA-Z0-9.$_]+\\)\\.[a-zA-Z0-9$_<>(),]+ \
2247 \\(([a-zA-Z0-9.$_]+:\\|line=\\)\\([0-9.,]+\\)"
2250 ;; A good marker is one that:
2251 ;; 1) does not have a "[n] " prefix (not part of a stack backtrace)
2252 ;; 2) does have an "[n] " prefix and n is the lowest prefix seen
2253 ;; since the last prompt
2254 ;; Figure out the line on which to position the debugging arrow.
2255 ;; Return the info as a cons of the form:
2257 ;; (<file-name> . <line-number>) .
2258 (if (if (match-beginning 1)
2260 (setq n (string-to-number (substring
2262 (1+ (match-beginning 1))
2263 (- (match-end 1) 2))))
2264 (if (< n gud-jdb-lowest-stack-level)
2265 (progn (setq gud-jdb-lowest-stack-level n) t)))
2267 (if (setq file-found
2268 (gud-jdb-find-source (match-string 2 gud-marker-acc)))
2269 (setq gud-last-frame
2273 ((numstr (match-string 4 gud-marker-acc)))
2274 (if (string-match "[.,]" numstr)
2275 (replace-match "" nil nil numstr)
2277 (message "Could not find source file.")))
2279 ;; Set the accumulator to the remaining text.
2280 (setq gud-marker-acc (substring gud-marker-acc (match-end 0))))
2282 (if (string-match comint-prompt-regexp gud-marker-acc)
2283 (setq gud-jdb-lowest-stack-level 999)))
2285 ;; Do not allow gud-marker-acc to grow without bound. If the source
2286 ;; file information is not within the last 3/4
2287 ;; gud-marker-acc-max-length characters, well,...
2288 (if (> (length gud-marker-acc) gud-marker-acc-max-length)
2289 (setq gud-marker-acc
2290 (substring gud-marker-acc
2291 (- (/ (* gud-marker-acc-max-length 3) 4)))))
2293 ;; We don't filter any debugger output so just return what we were given.
2296 (defvar gud-jdb-command-name "jdb" "Command that executes the Java debugger.")
2299 (defun jdb (command-line)
2300 "Run jdb with command line COMMAND-LINE in a buffer.
2301 The buffer is named \"*gud*\" if no initial class is given or
2302 \"*gud-<initial-class-basename>*\" if there is. If the \"-classpath\"
2303 switch is given, omit all whitespace between it and its value.
2305 See `gud-jdb-use-classpath' and `gud-jdb-classpath' documentation for
2306 information on how jdb accesses source files. Alternatively (if
2307 `gud-jdb-use-classpath' is nil), see `gud-jdb-directories' for the
2308 original source file access method.
2310 For general information about commands available to control jdb from
2311 gud, see `gud-mode'."
2313 (list (gud-query-cmdline 'jdb)))
2314 (setq gud-jdb-classpath nil)
2315 (setq gud-jdb-sourcepath nil)
2317 ;; Set gud-jdb-classpath from the CLASSPATH environment variable,
2318 ;; if CLASSPATH is set.
2319 (setq gud-jdb-classpath-string (or (getenv "CLASSPATH") "."))
2320 (if gud-jdb-classpath-string
2321 (setq gud-jdb-classpath
2322 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2323 (setq gud-jdb-classpath-string nil) ; prepare for next
2325 (gud-common-init command-line 'gud-jdb-massage-args
2326 'gud-jdb-marker-filter)
2327 (set (make-local-variable 'gud-minor-mode) 'jdb)
2329 ;; If a -classpath option was provided, set gud-jdb-classpath
2330 (if gud-jdb-classpath-string
2331 (setq gud-jdb-classpath
2332 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2333 (setq gud-jdb-classpath-string nil) ; prepare for next
2334 ;; If a -sourcepath option was provided, parse it
2335 (if gud-jdb-sourcepath
2336 (setq gud-jdb-sourcepath
2337 (gud-jdb-parse-classpath-string gud-jdb-sourcepath)))
2339 (gud-def gud-break "stop at %c:%l" "\C-b" "Set breakpoint at current line.")
2340 (gud-def gud-remove "clear %c:%l" "\C-d" "Remove breakpoint at current line")
2341 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2342 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2343 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
2344 (gud-def gud-finish "step up" "\C-f" "Continue until current method returns.")
2345 (gud-def gud-up "up\C-Mwhere" "<" "Up one stack frame.")
2346 (gud-def gud-down "down\C-Mwhere" ">" "Up one stack frame.")
2347 (gud-def gud-run "run" nil "Run the program.") ;if VM start using jdb
2348 (gud-def gud-print "print %e" "\C-p" "Print value of expression at point.")
2349 (gud-def gud-pstar "dump %e" nil "Print all object information at point.")
2351 (setq comint-prompt-regexp "^> \\|^[^ ]+\\[[0-9]+\\] ")
2352 (setq paragraph-start comint-prompt-regexp)
2353 (run-hooks 'jdb-mode-hook)
2355 (if gud-jdb-use-classpath
2356 ;; Get the classpath information from the debugger
2358 (if (string-match "-attach" command-line)
2359 (gud-call "classpath"))
2360 (fset 'gud-jdb-find-source
2361 'gud-jdb-find-source-using-classpath))
2363 ;; Else create and bind the class/source association list as well
2364 ;; as the source file list.
2365 (setq gud-jdb-class-source-alist
2366 (gud-jdb-build-class-source-alist
2367 (setq gud-jdb-source-files
2368 (gud-jdb-build-source-files-list gud-jdb-directories
2370 (fset 'gud-jdb-find-source 'gud-jdb-find-source-file)))
2373 ;; End of debugger-specific information
2377 ;; When we send a command to the debugger via gud-call, it's annoying
2378 ;; to see the command and the new prompt inserted into the debugger's
2379 ;; buffer; we have other ways of knowing the command has completed.
2381 ;; If the buffer looks like this:
2382 ;; --------------------
2383 ;; (gdb) set args foo bar
2385 ;; --------------------
2386 ;; (the -!- marks the location of point), and we type `C-x SPC' in a
2387 ;; source file to set a breakpoint, we want the buffer to end up like
2389 ;; --------------------
2390 ;; (gdb) set args foo bar
2391 ;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
2393 ;; --------------------
2394 ;; Essentially, the old prompt is deleted, and the command's output
2395 ;; and the new prompt take its place.
2397 ;; Not echoing the command is easy enough; you send it directly using
2398 ;; process-send-string, and it never enters the buffer. However,
2399 ;; getting rid of the old prompt is trickier; you don't want to do it
2400 ;; when you send the command, since that will result in an annoying
2401 ;; flicker as the prompt is deleted, redisplay occurs while Emacs
2402 ;; waits for a response from the debugger, and the new prompt is
2403 ;; inserted. Instead, we'll wait until we actually get some output
2404 ;; from the subprocess before we delete the prompt. If the command
2405 ;; produced no output other than a new prompt, that prompt will most
2406 ;; likely be in the first chunk of output received, so we will delete
2407 ;; the prompt and then replace it with an identical one. If the
2408 ;; command produces output, the prompt is moving anyway, so the
2409 ;; flicker won't be annoying.
2411 ;; So - when we want to delete the prompt upon receipt of the next
2412 ;; chunk of debugger output, we position gud-delete-prompt-marker at
2413 ;; the start of the prompt; the process filter will notice this, and
2414 ;; delete all text between it and the process output marker. If
2415 ;; gud-delete-prompt-marker points nowhere, we leave the current
2417 (defvar gud-delete-prompt-marker nil)
2420 (put 'gud-mode 'mode-class 'special)
2422 (define-derived-mode gud-mode comint-mode "Debugger"
2423 "Major mode for interacting with an inferior debugger process.
2425 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
2426 M-x perldb, M-x xdb, or M-x jdb. Each entry point finishes by executing a
2427 hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook',
2428 `perldb-mode-hook', `xdb-mode-hook', or `jdb-mode-hook' respectively.
2430 After startup, the following commands are available in both the GUD
2431 interaction buffer and any source buffer GUD visits due to a breakpoint stop
2434 \\[gud-break] sets a breakpoint at the current file and line. In the
2435 GUD buffer, the current file and line are those of the last breakpoint or
2436 step. In a source buffer, they are the buffer's file and current line.
2438 \\[gud-remove] removes breakpoints on the current file and line.
2440 \\[gud-refresh] displays in the source window the last line referred to
2443 \\[gud-step], \\[gud-next], and \\[gud-stepi] do a step-one-line,
2444 step-one-line (not entering function calls), and step-one-instruction
2445 and then update the source window with the current file and position.
2446 \\[gud-cont] continues execution.
2448 \\[gud-print] tries to find the largest C lvalue or function-call expression
2449 around point, and sends it to the debugger for value display.
2451 The above commands are common to all supported debuggers except xdb which
2452 does not support stepping instructions.
2454 Under gdb, sdb and xdb, \\[gud-tbreak] behaves exactly like \\[gud-break],
2455 except that the breakpoint is temporary; that is, it is removed when
2456 execution stops on it.
2458 Under gdb, dbx, and xdb, \\[gud-up] pops up through an enclosing stack
2459 frame. \\[gud-down] drops back down through one.
2461 If you are using gdb or xdb, \\[gud-finish] runs execution to the return from
2462 the current function and stops.
2464 All the keystrokes above are accessible in the GUD buffer
2465 with the prefix C-c, and in all buffers through the prefix C-x C-a.
2467 All pre-defined functions for which the concept make sense repeat
2468 themselves the appropriate number of times if you give a prefix
2471 You may use the `gud-def' macro in the initialization hook to define other
2474 Other commands for interacting with the debugger process are inherited from
2475 comint mode, which see."
2476 (setq mode-line-process '(":%s"))
2477 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
2478 (set (make-local-variable 'gud-last-frame) nil)
2479 (if (boundp 'tool-bar-map) ; not --without-x
2480 (setq-local tool-bar-map gud-tool-bar-map))
2481 (make-local-variable 'comint-prompt-regexp)
2482 ;; Don't put repeated commands in command history many times.
2483 (set (make-local-variable 'comint-input-ignoredups) t)
2484 (make-local-variable 'paragraph-start)
2485 (set (make-local-variable 'gud-delete-prompt-marker) (make-marker))
2486 (add-hook 'kill-buffer-hook 'gud-kill-buffer-hook nil t))
2488 (defcustom gud-chdir-before-run t
2489 "Non-nil if GUD should `cd' to the debugged executable."
2493 (declare-function tramp-file-name-localname "tramp" (vec))
2494 (declare-function tramp-dissect-file-name "tramp" (name &optional nodefault))
2496 ;; Perform initializations common to all debuggers.
2497 ;; The first arg is the specified command line,
2498 ;; which starts with the program to debug.
2499 ;; The other three args specify the values to use
2500 ;; for local variables in the debugger buffer.
2501 (defun gud-common-init (command-line massage-args marker-filter
2502 &optional find-file)
2503 (let* ((words (split-string-and-unquote command-line))
2504 (program (car words))
2505 (dir default-directory)
2506 ;; Extract the file name from WORDS
2507 ;; and put t in its place.
2508 ;; Later on we will put the modified file name arg back there.
2509 (file-word (let ((w (cdr words)))
2510 (while (and w (= ?- (aref (car w) 0)))
2516 (and file-word (substitute-in-file-name file-word)))
2518 ;; If a directory was specified, expand the file name.
2519 ;; Otherwise, don't expand it, so GDB can use the PATH.
2520 ;; A file name without directory is literally valid
2521 ;; only if the file exists in ., and in that case,
2522 ;; omitting the expansion here has no visible effect.
2523 (file (and file-word
2524 (if (file-name-directory file-subst)
2525 (expand-file-name file-subst)
2527 (filepart (and file-word (concat "-" (file-name-nondirectory file))))
2528 (existing-buffer (get-buffer (concat "*gud" filepart "*"))))
2529 (switch-to-buffer (concat "*gud" filepart "*"))
2530 (when (and existing-buffer (get-buffer-process existing-buffer))
2531 (error "This program is already being debugged"))
2532 ;; Set the dir, in case the buffer already existed with a different dir.
2533 (setq default-directory dir)
2534 ;; Set default-directory to the file's directory.
2536 gud-chdir-before-run
2537 ;; Don't set default-directory if no directory was specified.
2538 ;; In that case, either the file is found in the current directory,
2539 ;; in which case this setq is a no-op,
2540 ;; or it is found by searching PATH,
2541 ;; in which case we don't know what directory it was found in.
2542 (file-name-directory file)
2543 (setq default-directory (file-name-directory file)))
2544 (or (bolp) (newline))
2545 (insert "Current directory is " default-directory "\n")
2546 ;; Put the substituted and expanded file name back in its place.
2548 (while (and w (not (eq (car w) t)))
2552 (if (file-remote-p file)
2553 ;; Tramp has already been loaded if we are here.
2554 (setq file (tramp-file-name-localname
2555 (tramp-dissect-file-name file)))
2557 (apply 'make-comint (concat "gud" filepart) program nil
2558 (if massage-args (funcall massage-args file args) args))
2559 ;; Since comint clobbered the mode, we don't set it until now.
2561 (set (make-local-variable 'gud-target-name)
2562 (and file-word (file-name-nondirectory file))))
2563 (set (make-local-variable 'gud-marker-filter) marker-filter)
2564 (if find-file (set (make-local-variable 'gud-find-file) find-file))
2565 (setq gud-last-last-frame nil)
2567 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
2568 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
2571 (defun gud-set-buffer ()
2572 (when (derived-mode-p 'gud-mode)
2573 (setq gud-comint-buffer (current-buffer))))
2575 (defvar gud-filter-defer-flag nil
2576 "Non-nil means don't process anything from the debugger right now.
2577 It is saved for when this flag is not set.")
2579 ;; These functions are responsible for inserting output from your debugger
2580 ;; into the buffer. The hard work is done by the method that is
2581 ;; the value of gud-marker-filter.
2583 (defun gud-filter (proc string)
2584 ;; Here's where the actual buffer insertion is done
2585 (let (output process-window)
2586 (if (buffer-name (process-buffer proc))
2587 (if gud-filter-defer-flag
2588 ;; If we can't process any text now,
2589 ;; save it for later.
2590 (setq gud-filter-pending-text
2591 (concat (or gud-filter-pending-text "") string))
2593 ;; If we have to ask a question during the processing,
2594 ;; defer any additional text that comes from the debugger
2595 ;; during that time.
2596 (let ((gud-filter-defer-flag t))
2597 ;; Process now any text we previously saved up.
2598 (if gud-filter-pending-text
2599 (setq string (concat gud-filter-pending-text string)
2600 gud-filter-pending-text nil))
2602 (with-current-buffer (process-buffer proc)
2603 ;; If we have been so requested, delete the debugger prompt.
2606 (if (marker-buffer gud-delete-prompt-marker)
2607 (let ((inhibit-read-only t))
2608 (delete-region (process-mark proc)
2609 gud-delete-prompt-marker)
2610 (comint-update-fence)
2611 (set-marker gud-delete-prompt-marker nil)))
2612 ;; Save the process output, checking for source file markers.
2613 (setq output (gud-marker-filter string))
2614 ;; Check for a filename-and-line number.
2615 ;; Don't display the specified file
2616 ;; unless (1) point is at or after the position where output appears
2617 ;; and (2) this buffer is on the screen.
2618 (setq process-window
2620 (>= (point) (process-mark proc))
2621 (get-buffer-window (current-buffer)))))
2623 ;; Let the comint filter do the actual insertion.
2624 ;; That lets us inherit various comint features.
2625 (comint-output-filter proc output))
2627 ;; Put the arrow on the source line.
2628 ;; This must be outside of the save-excursion
2629 ;; in case the source file is our current buffer.
2631 (with-selected-window process-window
2632 (gud-display-frame))
2633 ;; We have to be in the proper buffer, (process-buffer proc),
2634 ;; but not in a save-excursion, because that would restore point.
2635 (with-current-buffer (process-buffer proc)
2636 (gud-display-frame))))
2638 ;; If we deferred text that arrived during this processing,
2640 (if gud-filter-pending-text
2641 (gud-filter proc ""))))))
2643 (defvar gud-minor-mode-type nil)
2644 (defvar gud-overlay-arrow-position nil)
2645 (add-to-list 'overlay-arrow-variable-list 'gud-overlay-arrow-position)
2647 (declare-function gdb-reset "gdb-mi" ())
2648 (declare-function speedbar-change-initial-expansion-list "speedbar" (new))
2649 (defvar speedbar-previously-used-expansion-list-name)
2651 (defun gud-sentinel (proc msg)
2652 (cond ((null (buffer-name (process-buffer proc)))
2654 ;; Stop displaying an arrow in a source file.
2655 (setq gud-overlay-arrow-position nil)
2656 (set-process-buffer proc nil)
2657 (if (and (boundp 'speedbar-initial-expansion-list-name)
2658 (string-equal speedbar-initial-expansion-list-name "GUD"))
2659 (speedbar-change-initial-expansion-list
2660 speedbar-previously-used-expansion-list-name))
2661 (if (eq gud-minor-mode-type 'gdbmi)
2664 ((memq (process-status proc) '(signal exit))
2665 ;; Stop displaying an arrow in a source file.
2666 (setq gud-overlay-arrow-position nil)
2667 (if (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
2671 (let* ((obuf (current-buffer)))
2672 ;; save-excursion isn't the right thing if
2673 ;; process-buffer is current-buffer
2676 ;; Write something in the GUD buffer and hack its mode line,
2677 (set-buffer (process-buffer proc))
2678 ;; Fix the mode line.
2679 (setq mode-line-process
2681 (symbol-name (process-status proc))))
2682 (force-mode-line-update)
2684 (insert ?\n mode-name " " msg)
2686 (goto-char (point-max))
2687 (insert ?\n mode-name " " msg)))
2688 ;; If buffer and mode line will show that the process
2689 ;; is dead, we can delete it now. Otherwise it
2690 ;; will stay around until M-x list-processes.
2691 (delete-process proc))
2692 ;; Restore old buffer, but don't restore old point
2693 ;; if obuf is the gud buffer.
2694 (set-buffer obuf))))))
2696 (defun gud-kill-buffer-hook ()
2697 (setq gud-minor-mode-type gud-minor-mode)
2700 (kill-process (get-buffer-process (current-buffer)))
2701 (delete-process (get-process "gdb-inferior")))
2705 (dolist (buffer (buffer-list))
2706 (unless (eq buffer gud-comint-buffer)
2707 (with-current-buffer buffer
2708 (when gud-minor-mode
2709 (setq gud-minor-mode nil)
2710 (kill-local-variable 'tool-bar-map))))))
2712 (defun gud-display-frame ()
2713 "Find and obey the last filename-and-line marker from the debugger.
2714 Obeying it means displaying in another window the specified file and line."
2716 (when gud-last-frame
2718 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
2719 (setq gud-last-last-frame gud-last-frame
2720 gud-last-frame nil)))
2722 (declare-function global-hl-line-highlight "hl-line" ())
2723 (declare-function hl-line-highlight "hl-line" ())
2724 (declare-function gdb-display-source-buffer "gdb-mi" (buffer))
2726 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
2727 ;; and that its line LINE is visible.
2728 ;; Put the overlay-arrow on the line LINE in that buffer.
2729 ;; Most of the trickiness in here comes from wanting to preserve the current
2730 ;; region-restriction if that's possible. We use an explicit display-buffer
2731 ;; to get around the fact that this is called inside a save-excursion.
2733 (defun gud-display-line (true-file line)
2734 (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
2736 (with-current-buffer gud-comint-buffer
2737 (gud-find-file true-file)))
2739 (or (get-buffer-window buffer)
2740 (display-buffer buffer))))
2743 (with-current-buffer buffer
2744 (unless (or (verify-visited-file-modtime buffer) gud-keep-buffer)
2746 (format "File %s changed on disk. Reread from disk? "
2749 (setq gud-keep-buffer t)))
2752 (goto-char (point-min))
2753 (forward-line (1- line))
2755 (or gud-overlay-arrow-position
2756 (setq gud-overlay-arrow-position (make-marker)))
2757 (set-marker gud-overlay-arrow-position (point) (current-buffer))
2758 ;; If they turned on hl-line, move the hl-line highlight to
2759 ;; the arrow's line.
2760 (when (featurep 'hl-line)
2762 (global-hl-line-mode
2763 (global-hl-line-highlight))
2764 ((and hl-line-mode hl-line-sticky-flag)
2765 (hl-line-highlight)))))
2766 (cond ((or (< pos (point-min)) (> pos (point-max)))
2770 (set-window-point window gud-overlay-arrow-position)
2771 (if (eq gud-minor-mode 'gdbmi)
2772 (setq gdb-source-window window))))))
2774 ;; The gud-call function must do the right thing whether its invoking
2775 ;; keystroke is from the GUD buffer itself (via major-mode binding)
2776 ;; or a C buffer. In the former case, we want to supply data from
2777 ;; gud-last-frame. Here's how we do it:
2779 (defun gud-format-command (str arg)
2780 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
2781 (frame (or gud-last-frame gud-last-last-frame))
2784 (let ((case-fold-search nil))
2785 (string-match "\\([^%]*\\)%\\([adefFlpc]\\)" str)))
2786 (let ((key (string-to-char (match-string 2 str)))
2790 (setq subst (file-name-nondirectory (if insource
2794 (setq subst (file-name-base (if insource
2798 (setq subst (file-name-directory (if insource
2802 (setq subst (int-to-string
2806 (+ (count-lines (point-min) (point))
2810 (setq subst (gud-find-expr)))
2812 (setq subst (gud-read-address)))
2822 (+ (count-lines (point-min) (point))
2826 (setq subst (if arg (int-to-string arg)))))
2827 (setq result (concat result (match-string 1 str) subst)))
2828 (setq str (substring str (match-end 2))))
2829 ;; There might be text left in STR when the loop ends.
2830 (concat result str)))
2832 (defun gud-read-address ()
2833 "Return a string containing the core-address found in the buffer at point."
2836 (let ((pt (point)) found begin)
2837 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
2839 (found (forward-char 2)
2840 (buffer-substring found
2841 (progn (re-search-forward "[^0-9a-f]")
2844 (t (setq begin (progn (re-search-backward "[^0-9]")
2848 (re-search-forward "[^0-9]")
2850 (buffer-substring begin (point))))))))
2852 (defun gud-call (fmt &optional arg)
2853 (let ((msg (gud-format-command fmt arg)))
2854 (message "Command: %s" msg)
2856 (gud-basic-call msg)))
2858 (defun gud-basic-call (command)
2859 "Invoke the debugger COMMAND displaying source in other window."
2862 (let ((proc (get-buffer-process gud-comint-buffer)))
2863 (or proc (error "Current buffer has no process"))
2864 ;; Arrange for the current prompt to get deleted.
2865 (with-current-buffer gud-comint-buffer
2869 (if (marker-position gud-delete-prompt-marker)
2870 ;; We get here when printing an expression.
2871 (goto-char gud-delete-prompt-marker)
2872 (goto-char (process-mark proc))
2874 (if (looking-at comint-prompt-regexp)
2875 (set-marker gud-delete-prompt-marker (point)))
2876 (if (eq gud-minor-mode 'gdbmi)
2877 (apply comint-input-sender (list proc command))
2878 (process-send-string proc (concat command "\n"))))))))
2880 (defun gud-refresh (&optional arg)
2881 "Fix up a possibly garbled display, and redraw the arrow."
2883 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
2887 ;; Code for parsing expressions out of C or Fortran code. The single entry
2888 ;; point is gud-find-expr, which tries to return an lvalue expression from
2891 (defvar gud-find-expr-function 'gud-find-c-expr)
2893 (defun gud-find-expr (&rest args)
2894 (let ((expr (if (and transient-mark-mode mark-active)
2895 (buffer-substring (region-beginning) (region-end))
2896 (apply gud-find-expr-function args))))
2898 (if (string-match "\n" expr)
2899 (error "Expression must not include a newline"))
2900 (with-current-buffer gud-comint-buffer
2902 (goto-char (process-mark (get-buffer-process gud-comint-buffer)))
2904 (when (looking-at comint-prompt-regexp)
2905 (set-marker gud-delete-prompt-marker (point))
2906 (set-marker-insertion-type gud-delete-prompt-marker t))
2907 (unless (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
2909 (insert (concat expr " = "))))))
2912 ;; The next eight functions are hacked from gdbsrc.el by
2913 ;; Debby Ayers <ayers@asc.slb.com>,
2914 ;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
2916 (defun gud-find-c-expr ()
2917 "Returns the expr that surrounds point."
2921 (expr (gud-innermost-expr))
2922 (test-expr (gud-prev-expr)))
2923 (while (and test-expr (gud-expr-compound test-expr expr))
2924 (let ((prev-expr expr))
2925 (setq expr (cons (car test-expr) (cdr expr)))
2926 (goto-char (car expr))
2927 (setq test-expr (gud-prev-expr))
2928 ;; If we just pasted on the condition of an if or while,
2929 ;; throw it away again.
2930 (if (member (buffer-substring (car test-expr) (cdr test-expr))
2931 '("if" "while" "for"))
2935 (setq test-expr (gud-next-expr))
2936 (while (gud-expr-compound expr test-expr)
2937 (setq expr (cons (car expr) (cdr test-expr)))
2938 (setq test-expr (gud-next-expr)))
2939 (buffer-substring (car expr) (cdr expr)))))
2941 (defun gud-innermost-expr ()
2942 "Returns the smallest expr that point is in; move point to beginning of it.
2943 The expr is represented as a cons cell, where the car specifies the point in
2944 the current buffer that marks the beginning of the expr and the cdr specifies
2945 the character after the end of the expr."
2946 (let ((p (point)) begin end)
2948 (setq begin (point))
2961 (defun gud-backward-sexp ()
2962 "Version of `backward-sexp' that catches errors."
2967 (defun gud-forward-sexp ()
2968 "Version of `forward-sexp' that catches errors."
2973 (defun gud-prev-expr ()
2974 "Returns the previous expr, point is set to beginning of that expr.
2975 The expr is represented as a cons cell, where the car specifies the point in
2976 the current buffer that marks the beginning of the expr and the cdr specifies
2977 the character after the end of the expr"
2978 (let ((begin) (end))
2980 (setq begin (point))
2986 (defun gud-next-expr ()
2987 "Returns the following expr, point is set to beginning of that expr.
2988 The expr is represented as a cons cell, where the car specifies the point in
2989 the current buffer that marks the beginning of the expr and the cdr specifies
2990 the character after the end of the expr."
2991 (let ((begin) (end))
2996 (setq begin (point))
2999 (defun gud-expr-compound-sep (span-start span-end)
3000 "Scan from SPAN-START to SPAN-END for punctuation characters.
3001 If `->' is found, return `?.'. If `.' is found, return `?.'.
3002 If any other punctuation is found, return `??'.
3003 If no punctuation is found, return `? '."
3006 (while (< span-start span-end)
3007 (setq syntax (char-syntax (char-after span-start)))
3010 ((= syntax ?.) (setq syntax (char-after span-start))
3012 ((= syntax ?.) (setq result ?.))
3013 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
3015 (setq span-start (+ span-start 1)))
3016 (t (setq span-start span-end)
3017 (setq result ??)))))
3018 (setq span-start (+ span-start 1)))
3021 (defun gud-expr-compound (first second)
3022 "Non-nil if concatenating FIRST and SECOND makes a single C expression.
3023 The two exprs are represented as a cons cells, where the car
3024 specifies the point in the current buffer that marks the beginning of the
3025 expr and the cdr specifies the character after the end of the expr.
3026 Link exprs of the form:
3033 (let ((span-start (cdr first))
3034 (span-end (car second))
3036 (setq syntax (gud-expr-compound-sep span-start span-end))
3038 ((= (car first) (car second)) nil)
3039 ((= (cdr first) (cdr second)) nil)
3042 (setq span-start (char-after (- span-start 1)))
3043 (setq span-end (char-after span-end))
3045 ((= span-start ?)) t)
3046 ((= span-start ?]) t)
3053 (declare-function c-langelem-sym "cc-defs" (langelem))
3054 (declare-function c-langelem-pos "cc-defs" (langelem))
3056 (defun gud-find-class (f _line)
3057 "Find fully qualified class in file F at line LINE.
3058 This function uses the `gud-jdb-classpath' (and optional
3059 `gud-jdb-sourcepath') list(s) to derive a file
3060 pathname relative to its classpath directory. The values in
3061 `gud-jdb-classpath' are assumed to have been converted to absolute
3062 pathname standards using file-truename.
3063 If F is visited by a buffer and its mode is CC-mode(Java),
3064 syntactic information of LINE is used to find the enclosing (nested)
3065 class string which is appended to the top level
3066 class of the file (using s to separate nested class ids)."
3067 ;; Convert f to a standard representation and remove suffix
3068 (if (and gud-jdb-use-classpath (or gud-jdb-classpath gud-jdb-sourcepath))
3070 (let ((cplist (append gud-jdb-sourcepath gud-jdb-classpath))
3071 (fbuffer (get-file-buffer f))
3073 ;; Syntax-symbol returns the symbol of the *first* element
3074 ;; in the syntactical analysis result list, syntax-point
3075 ;; returns the buffer position of same
3076 (syntax-symbol (lambda (x) (c-langelem-sym (car x))))
3077 (syntax-point (lambda (x) (c-langelem-pos (car x)))))
3078 (setq f (file-name-sans-extension (file-truename f)))
3079 ;; Search through classpath list for an entry that is
3081 (while (and cplist (not class-found))
3082 (if (string-match (car cplist) f)
3084 (mapconcat 'identity
3086 (substring f (+ (match-end 0) 1))
3088 (setq cplist (cdr cplist)))
3089 ;; if f is visited by a java(cc-mode) buffer, walk up the
3090 ;; syntactic information chain and collect any 'inclass
3091 ;; symbols until 'topmost-intro is reached to find out if
3092 ;; point is within a nested class
3093 ;; FIXME: Yuck!!! cc-mode should provide a function instead.
3094 (if (and fbuffer (equal (symbol-file 'java-mode) "cc-mode"))
3095 (with-current-buffer fbuffer
3096 (let ((nclass) (syntax))
3097 ;; While the c-syntactic information does not start
3098 ;; with the 'topmost-intro symbol, there may be
3099 ;; nested classes...
3100 (while (not (eq 'topmost-intro
3101 (funcall syntax-symbol (c-guess-basic-syntax))))
3102 ;; Check if the current position c-syntactic
3103 ;; analysis has 'inclass
3104 (setq syntax (c-guess-basic-syntax))
3106 (and (not (eq 'inclass (funcall syntax-symbol syntax)))
3108 (setq syntax (cdr syntax)))
3109 (if (eq 'inclass (funcall syntax-symbol syntax))
3111 (goto-char (funcall syntax-point syntax))
3112 ;; Now we're at the beginning of a class
3113 ;; definition. Find class name
3115 "[A-Za-z0-9 \t\n]*?class[ \t\n]+\\([^ \t\n]+\\)")
3117 (append (list (match-string-no-properties 1))
3119 (setq syntax (c-guess-basic-syntax))
3120 (while (and (not (funcall syntax-point syntax)) (cdr syntax))
3121 (setq syntax (cdr syntax)))
3122 (goto-char (funcall syntax-point syntax))
3124 (string-match (concat (car nclass) "$") class-found)
3126 (replace-match (mapconcat 'identity nclass "$")
3127 t t class-found)))))
3128 (if (not class-found)
3129 (message "gud-find-class: class for file %s not found!" f))
3131 ;; Not using classpath - try class/source association list
3132 (let ((class-found (rassoc f gud-jdb-class-source-alist)))
3135 (message "gud-find-class: class for file %s not found in gud-jdb-class-source-alist!" f)
3139 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3140 ;;; GDB script mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3141 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3143 (defvar gdb-script-mode-syntax-table
3144 (let ((st (make-syntax-table)))
3145 (modify-syntax-entry ?' "\"" st)
3146 (modify-syntax-entry ?# "<" st)
3147 (modify-syntax-entry ?\n ">" st)
3150 (defvar gdb-script-font-lock-keywords
3151 '(("^define\\s-+\\(\\(\\w\\|\\s_\\)+\\)" (1 font-lock-function-name-face))
3152 ("\\$\\(\\w+\\)" (1 font-lock-variable-name-face))
3153 ("^\\s-*\\(\\w\\(\\w\\|\\s_\\)*\\)" (1 font-lock-keyword-face))))
3155 (defconst gdb-script-syntax-propertize-function
3156 (syntax-propertize-rules
3157 ("^document\\s-.*\\(\n\\)" (1 "< b"))
3160 (when (and (> (match-beginning 0) (point-min))
3161 (eq 1 (nth 7 (save-excursion
3162 (syntax-ppss (1- (match-beginning 0)))))))
3163 ;; We change the \n in front, which is more difficult, but results
3164 ;; in better highlighting. If the doc is empty, the single \n is
3165 ;; both the beginning and the end of the docstring, which can't be
3166 ;; expressed in syntax-tables. Instead, we place the "> b" after
3167 ;; placing the "< b", so the start marker is overwritten by the
3168 ;; termination marker and in the end Emacs simply considers that
3169 ;; there's no docstring at all, which is fine.
3170 (put-text-property (1- (match-beginning 0)) (match-beginning 0)
3171 'syntax-table (eval-when-compile
3172 (string-to-syntax "> b")))
3173 ;; Make sure that rehighlighting the previous line won't erase our
3174 ;; syntax-table property and that modifying `end' will.
3175 (put-text-property (1- (match-beginning 0)) (match-end 0)
3176 'syntax-multiline t)))))))
3178 (defun gdb-script-font-lock-syntactic-face (state)
3180 ((nth 3 state) font-lock-string-face)
3181 ((nth 7 state) font-lock-doc-face)
3182 (t font-lock-comment-face)))
3184 (defvar gdb-script-basic-indent 2)
3186 (defun gdb-script-skip-to-head ()
3187 "We're just in front of an `end' and we need to go to its head."
3188 (while (and (re-search-backward "^\\s-*\\(\\(end\\)\\|define\\|document\\|if\\|while\\|commands\\)\\>" nil 'move)
3190 (gdb-script-skip-to-head)))
3192 (defun gdb-script-calculate-indentation ()
3194 ((looking-at "end\\>")
3195 (gdb-script-skip-to-head)
3196 (current-indentation))
3197 ((looking-at "else\\>")
3198 (while (and (re-search-backward "^\\s-*\\(if\\|\\(end\\)\\)\\>" nil 'move)
3200 (gdb-script-skip-to-head))
3201 (current-indentation))
3203 (forward-comment (- (point-max)))
3205 (skip-chars-forward " \t")
3206 (+ (current-indentation)
3207 (if (looking-at "\\(if\\|while\\|define\\|else\\|commands\\)\\>")
3208 gdb-script-basic-indent 0)))))
3210 (defun gdb-script-indent-line ()
3211 "Indent current line of GDB script."
3213 (if (and (eq (get-text-property (point) 'face) font-lock-doc-face)
3216 (skip-chars-forward " \t")
3217 (not (looking-at "end\\>"))))
3219 (let* ((savep (point))
3220 (indent (condition-case nil
3223 (skip-chars-forward " \t")
3224 (if (>= (point) savep) (setq savep nil))
3225 (max (gdb-script-calculate-indentation) 0))
3228 (save-excursion (indent-line-to indent))
3229 (indent-line-to indent)))))
3231 ;; Derived from cfengine.el.
3232 (defun gdb-script-beginning-of-defun ()
3233 "`beginning-of-defun' function for Gdb script mode.
3234 Treats actions as defuns."
3235 (unless (<= (current-column) (current-indentation))
3237 (if (re-search-backward "^define \\|^document " nil t)
3239 (goto-char (point-min)))
3242 ;; Derived from cfengine.el.
3243 (defun gdb-script-end-of-defun ()
3244 "`end-of-defun' function for Gdb script mode.
3245 Treats actions as defuns."
3247 (if (re-search-forward "^end" nil t)
3249 (goto-char (point-max)))
3253 (define-derived-mode gdb-script-mode prog-mode "GDB-Script"
3254 "Major mode for editing GDB scripts."
3255 (set (make-local-variable 'comment-start) "#")
3256 (set (make-local-variable 'comment-start-skip) "#+\\s-*")
3257 (set (make-local-variable 'outline-regexp) "[ \t]")
3258 (set (make-local-variable 'imenu-generic-expression)
3259 '((nil "^define[ \t]+\\(\\w+\\)" 1)))
3260 (set (make-local-variable 'indent-line-function) 'gdb-script-indent-line)
3261 (set (make-local-variable 'beginning-of-defun-function)
3262 #'gdb-script-beginning-of-defun)
3263 (set (make-local-variable 'end-of-defun-function)
3264 #'gdb-script-end-of-defun)
3265 (set (make-local-variable 'font-lock-defaults)
3266 '(gdb-script-font-lock-keywords nil nil ((?_ . "w")) nil
3267 (font-lock-syntactic-face-function
3268 . gdb-script-font-lock-syntactic-face)))
3269 ;; Recognize docstrings.
3270 (set (make-local-variable 'syntax-propertize-function)
3271 gdb-script-syntax-propertize-function)
3272 (add-hook 'syntax-propertize-extend-region-functions
3273 #'syntax-propertize-multiline 'append 'local))
3276 ;;; tooltips for GUD
3278 ;;; Customizable settings
3280 (defvar tooltip-mode)
3283 (define-minor-mode gud-tooltip-mode
3284 "Toggle the display of GUD tooltips.
3285 With a prefix argument ARG, enable the feature if ARG is
3286 positive, and disable it otherwise. If called from Lisp, enable
3287 it if ARG is omitted or nil."
3292 (if gud-tooltip-mode
3294 (add-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3295 (add-hook 'pre-command-hook 'tooltip-hide)
3296 (add-hook 'tooltip-functions 'gud-tooltip-tips)
3297 (define-key global-map [mouse-movement] 'gud-tooltip-mouse-motion))
3298 (unless tooltip-mode (remove-hook 'pre-command-hook 'tooltip-hide)
3299 (remove-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3300 (remove-hook 'tooltip-functions 'gud-tooltip-tips)
3301 (define-key global-map [mouse-movement] 'ignore)))
3302 (gud-tooltip-activate-mouse-motions-if-enabled)
3303 (if (and gud-comint-buffer
3304 (buffer-name gud-comint-buffer); gud-comint-buffer might be killed
3305 (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
3307 (if gud-tooltip-mode
3309 (dolist (buffer (buffer-list))
3310 (unless (eq buffer gud-comint-buffer)
3311 (with-current-buffer buffer
3312 (when (and (eq gud-minor-mode 'gdbmi)
3313 (not (string-match "\\`\\*.+\\*\\'"
3315 (make-local-variable 'gdb-define-alist)
3316 (gdb-create-define-alist)
3317 (add-hook 'after-save-hook
3318 'gdb-create-define-alist nil t))))))
3319 (kill-local-variable 'gdb-define-alist)
3320 (remove-hook 'after-save-hook 'gdb-create-define-alist t))))
3322 (define-obsolete-variable-alias 'tooltip-gud-modes
3323 'gud-tooltip-modes "22.1")
3325 (defcustom gud-tooltip-modes '(gud-mode c-mode c++-mode fortran-mode
3327 "List of modes for which to enable GUD tooltips."
3332 (define-obsolete-variable-alias 'tooltip-gud-display
3333 'gud-tooltip-display "22.1")
3335 (defcustom gud-tooltip-display
3336 '((eq (tooltip-event-buffer gud-tooltip-event)
3337 (marker-buffer gud-overlay-arrow-position)))
3338 "List of forms determining where GUD tooltips are displayed.
3340 Forms in the list are combined with AND. The default is to display
3341 only tooltips in the buffer containing the overlay arrow."
3346 (defcustom gud-tooltip-echo-area nil
3347 "Use the echo area instead of frames for GUD tooltips."
3352 (make-obsolete-variable 'gud-tooltip-echo-area
3353 "disable Tooltip mode instead" "24.4" 'set)
3355 ;;; Reacting on mouse movements
3357 (defun gud-tooltip-change-major-mode ()
3358 "Function added to `change-major-mode-hook' when tooltip mode is on."
3359 (add-hook 'post-command-hook 'gud-tooltip-activate-mouse-motions-if-enabled))
3361 (defun gud-tooltip-activate-mouse-motions-if-enabled ()
3362 "Reconsider for all buffers whether mouse motion events are desired."
3363 (remove-hook 'post-command-hook
3364 'gud-tooltip-activate-mouse-motions-if-enabled)
3365 (dolist (buffer (buffer-list))
3366 (with-current-buffer buffer
3367 (if (and gud-tooltip-mode
3368 (memq major-mode gud-tooltip-modes))
3369 (gud-tooltip-activate-mouse-motions t)
3370 (gud-tooltip-activate-mouse-motions nil)))))
3372 (defvar gud-tooltip-mouse-motions-active nil
3373 "Locally t in a buffer if tooltip processing of mouse motion is enabled.")
3375 ;; We don't set track-mouse globally because this is a big redisplay
3376 ;; problem in buffers having a pre-command-hook or such installed,
3377 ;; which does a set-buffer, like the summary buffer of Gnus. Calling
3378 ;; set-buffer prevents redisplay optimizations, so every mouse motion
3379 ;; would be accompanied by a full redisplay.
3381 (defun gud-tooltip-activate-mouse-motions (activatep)
3382 "Activate/deactivate mouse motion events for the current buffer.
3383 ACTIVATEP non-nil means activate mouse motion events."
3386 (set (make-local-variable 'gud-tooltip-mouse-motions-active) t)
3387 (set (make-local-variable 'track-mouse) t))
3388 (when gud-tooltip-mouse-motions-active
3389 (kill-local-variable 'gud-tooltip-mouse-motions-active)
3390 (kill-local-variable 'track-mouse))))
3392 (defvar tooltip-last-mouse-motion-event)
3393 (declare-function tooltip-hide "tooltip" (&optional ignored-arg))
3394 (declare-function tooltip-start-delayed-tip "tooltip" ())
3396 (defun gud-tooltip-mouse-motion (event)
3397 "Command handler for mouse movement events in `global-map'."
3400 (when (car (mouse-pixel-position))
3401 (setq tooltip-last-mouse-motion-event (copy-sequence event))
3402 (tooltip-start-delayed-tip)))
3406 (defvar gud-tooltip-dereference nil
3407 "Non-nil means print expressions with a `*' in front of them.
3408 For C this would dereference a pointer expression.")
3410 (defvar gud-tooltip-event nil
3411 "The mouse movement event that led to a tooltip display.
3412 This event can be examined by forms in `gud-tooltip-display'.")
3414 (defun gud-tooltip-dereference (&optional arg)
3415 "Toggle whether tooltips should show `* expr' or `expr'.
3416 With arg, dereference expr if ARG is positive, otherwise do not dereference."
3418 (setq gud-tooltip-dereference
3420 (not gud-tooltip-dereference)
3421 (> (prefix-numeric-value arg) 0)))
3422 (message "Dereferencing is now %s."
3423 (if gud-tooltip-dereference "on" "off")))
3425 (define-obsolete-function-alias 'tooltip-gud-toggle-dereference
3426 'gud-tooltip-dereference "22.1")
3427 (defvar tooltip-use-echo-area)
3428 (declare-function tooltip-show "tooltip" (text &optional use-echo-area))
3429 (declare-function tooltip-strip-prompt "tooltip" (process output))
3431 ; This will only display data that comes in one chunk.
3432 ; Larger arrays (say 400 elements) are displayed in
3433 ; the tooltip incompletely and spill over into the gud buffer.
3434 ; Switching the process-filter creates timing problems and
3435 ; it may be difficult to do better. Using GDB/MI as in
3436 ; gdb-mi.el gets around this problem.
3437 (defun gud-tooltip-process-output (process output)
3438 "Process debugger output and show it in a tooltip window."
3439 (remove-function (process-filter process) #'gud-tooltip-process-output)
3440 (tooltip-show (tooltip-strip-prompt process output)
3441 (or gud-tooltip-echo-area tooltip-use-echo-area
3442 (not tooltip-mode))))
3444 (defun gud-tooltip-print-command (expr)
3445 "Return a suitable command to print the expression EXPR."
3446 (pcase gud-minor-mode
3447 (`gdbmi (concat "-data-evaluate-expression \"" expr "\""))
3448 (`dbx (concat "print " expr))
3449 ((or `xdb `pdb) (concat "p " expr))
3450 (`sdb (concat expr "/"))))
3452 (declare-function gdb-input "gdb-mi" (command handler &optional trigger))
3453 (declare-function tooltip-expr-to-print "tooltip" (event))
3454 (declare-function tooltip-event-buffer "tooltip" (event))
3456 (defun gud-tooltip-tips (event)
3457 "Show tip for identifier or selection under the mouse.
3458 The mouse must either point at an identifier or inside a selected
3459 region for the tip window to be shown. If `gud-tooltip-dereference' is t,
3460 add a `*' in front of the printed expression. In the case of a C program
3461 controlled by GDB, show the associated #define directives when program is
3464 This function must return nil if it doesn't handle EVENT."
3466 (when (and (eventp event)
3469 (buffer-name gud-comint-buffer); might be killed
3470 (setq process (get-buffer-process gud-comint-buffer))
3471 (posn-point (event-end event))
3472 (or (and (eq gud-minor-mode 'gdbmi) (not gdb-active-process))
3473 (progn (setq gud-tooltip-event event)
3474 (eval (cons 'and gud-tooltip-display)))))
3475 (let ((expr (tooltip-expr-to-print event)))
3477 (if (and (eq gud-minor-mode 'gdbmi)
3478 (not gdb-active-process))
3480 (with-current-buffer (tooltip-event-buffer event)
3481 (let ((define-elt (assoc expr gdb-define-alist)))
3482 (unless (null define-elt)
3485 (or gud-tooltip-echo-area tooltip-use-echo-area
3486 (not tooltip-mode)))
3488 (when gud-tooltip-dereference
3489 (setq expr (concat "*" expr)))
3490 (let ((cmd (gud-tooltip-print-command expr)))
3491 (when (and gud-tooltip-mode (eq gud-minor-mode 'gdb))
3492 (gud-tooltip-mode -1)
3493 ;; The blank before the newline is for MS-Windows,
3494 ;; whose emulation of message box removes newlines and
3495 ;; displays a single long line.
3496 (message-box "Using GUD tooltips in this mode is unsafe \n\
3497 so they have been disabled."))
3498 (unless (null cmd) ; CMD can be nil if unknown debugger
3499 (if (eq gud-minor-mode 'gdbmi)
3503 "server macro expand " expr "\n")
3504 `(lambda () (gdb-tooltip-print-1 ,expr)))
3507 `(lambda () (gdb-tooltip-print ,expr))))
3508 (add-function :override (process-filter process)
3509 #'gud-tooltip-process-output)
3510 (gud-basic-call cmd))
3515 ;;; gud.el ends here