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