1 ;;; gud.el --- Grand Unified Debugger mode for running GDB and other debuggers
3 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
5 ;; Keywords: unix, tools
7 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 2000, 2001, 2002, 2003,
8 ;; 2004, 2005, 2006 Free Software Foundation, Inc.
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 2, or (at your option)
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; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
29 ;; The ancestral gdb.el was by W. Schelter <wfs@rascal.ics.utexas.edu> It was
30 ;; later rewritten by rms. Some ideas were due to Masanobu. Grand
31 ;; Unification (sdb/dbx support) by Eric S. Raymond <esr@thyrsus.com> Barry
32 ;; Warsaw <bwarsaw@cen.com> hacked the mode to use comint.el. Shane Hartman
33 ;; <shane@spr.com> added support for xdb (HPUX debugger). Rick Sladkey
34 ;; <jrs@world.std.com> wrote the GDB command completion code. Dave Love
35 ;; <d.love@dl.ac.uk> added the IRIX kluge, re-implemented the Mips-ish variant
36 ;; and added a menu. Brian D. Carlstrom <bdc@ai.mit.edu> combined the IRIX
37 ;; kluge with the gud-xdb-directories hack producing gud-dbx-directories.
38 ;; Derek L. Davies <ddavies@world.std.com> added support for jdb (Java
43 (eval-when-compile (require 'cl)) ; for case macro
47 (defvar gdb-active-process)
48 (defvar gdb-define-alist)
49 (defvar gdb-macro-info)
50 (defvar gdb-server-prefix)
51 (defvar gdb-show-changed-values)
52 (defvar gdb-force-update)
54 (defvar gdb-speedbar-auto-raise)
57 ;; ======================================================================
58 ;; GUD commands must be visible in C buffers visited by GUD
61 "Grand Unified Debugger mode for gdb and other debuggers under Emacs.
62 Supported debuggers include gdb, sdb, dbx, xdb, perldb, pdb (Python), jdb, and bash."
67 (defcustom gud-key-prefix "\C-x\C-a"
68 "Prefix of all GUD commands valid in C buffers."
72 (global-set-key (concat gud-key-prefix "\C-l") 'gud-refresh)
73 (define-key ctl-x-map " " 'gud-break) ;; backward compatibility hack
75 (defvar gud-marker-filter nil)
76 (put 'gud-marker-filter 'permanent-local t)
77 (defvar gud-find-file nil)
78 (put 'gud-find-file 'permanent-local t)
80 (defun gud-marker-filter (&rest args)
81 (apply gud-marker-filter args))
83 (defvar gud-minor-mode nil)
84 (put 'gud-minor-mode 'permanent-local t)
86 (defvar gud-keep-buffer nil)
88 (defun gud-symbol (sym &optional soft minor-mode)
89 "Return the symbol used for SYM in MINOR-MODE.
90 MINOR-MODE defaults to `gud-minor-mode.
91 The symbol returned is `gud-<MINOR-MODE>-<SYM>'.
92 If SOFT is non-nil, returns nil if the symbol doesn't already exist."
93 (unless (or minor-mode gud-minor-mode) (error "Gud internal error"))
94 (funcall (if soft 'intern-soft 'intern)
95 (format "gud-%s-%s" (or minor-mode gud-minor-mode) sym)))
97 (defun gud-val (sym &optional minor-mode)
98 "Return the value of `gud-symbol' SYM. Default to nil."
99 (let ((sym (gud-symbol sym t minor-mode)))
100 (if (boundp sym) (symbol-value sym))))
102 (defvar gud-running nil
103 "Non-nil if debuggee is running.
104 Used to grey out relevant togolbar icons.")
106 ;; Use existing Info buffer, if possible.
107 (defun gud-goto-info ()
108 "Go to relevant Emacs info node."
110 (let ((same-window-regexps same-window-regexps)
111 (display-buffer-reuse-frames t))
115 (if (eq (window-buffer window) (get-buffer "*info*"))
117 (setq same-window-regexps nil)
118 (throw 'info-found nil))))
120 (select-frame (make-frame)))
121 (if (memq gud-minor-mode '(gdbmi gdba))
122 (info "(emacs)GDB Graphical Interface")
123 (info "(emacs)Debuggers"))))
125 (defun gud-tool-bar-item-visible-no-fringe ()
126 (not (or (eq (buffer-local-value 'major-mode (window-buffer)) 'speedbar-mode)
127 (and (memq gud-minor-mode '(gdbmi gdba))
128 (> (car (window-fringes)) 0)))))
130 (defun gud-stop-subjob ()
133 (buffer-local-value 'gud-target-name gud-comint-buffer) "emacs")
135 (comint-interrupt-subjob)))
137 (easy-mmode-defmap gud-menu-map
138 '(([help] "Info" . gud-goto-info)
139 ([tooltips] menu-item "Toggle GUD tooltips" gud-tooltip-mode
140 :enable (and (not emacs-basic-display)
142 (fboundp 'x-show-tip))
143 :button (:toggle . gud-tooltip-mode))
144 ([refresh] "Refresh" . gud-refresh)
145 ([run] menu-item "Run" gud-run
146 :enable (and (not gud-running)
147 (memq gud-minor-mode '(gdbmi gdb dbx jdb)))
148 :visible (not (eq gud-minor-mode 'gdba)))
149 ([go] menu-item "Run/Continue" gud-go
150 :visible (and (not gud-running)
151 (eq gud-minor-mode 'gdba)))
152 ([stop] menu-item "Stop" gud-stop-subjob
153 :visible (or (not (eq gud-minor-mode 'gdba))
155 (eq gud-minor-mode 'gdba))))
156 ([until] menu-item "Continue to selection" gud-until
157 :enable (and (not gud-running)
158 (memq gud-minor-mode '(gdbmi gdba gdb perldb)))
159 :visible (gud-tool-bar-item-visible-no-fringe))
160 ([remove] menu-item "Remove Breakpoint" gud-remove
161 :enable (not gud-running)
162 :visible (gud-tool-bar-item-visible-no-fringe))
163 ([tbreak] menu-item "Temporary Breakpoint" gud-tbreak
164 :enable (memq gud-minor-mode
165 '(gdbmi gdba gdb sdb xdb bashdb)))
166 ([break] menu-item "Set Breakpoint" gud-break
167 :enable (not gud-running)
168 :visible (gud-tool-bar-item-visible-no-fringe))
169 ([up] menu-item "Up Stack" gud-up
170 :enable (and (not gud-running)
172 '(gdbmi gdba gdb dbx xdb jdb pdb bashdb))))
173 ([down] menu-item "Down Stack" gud-down
174 :enable (and (not gud-running)
176 '(gdbmi gdba gdb dbx xdb jdb pdb bashdb))))
177 ([pp] menu-item "Print the emacs s-expression" gud-pp
178 :enable (and (not gud-running)
180 :visible (and (string-equal
182 'gud-target-name gud-comint-buffer) "emacs")
183 (eq gud-minor-mode 'gdba)))
184 ([print*] menu-item "Print Dereference" gud-pstar
185 :enable (and (not gud-running)
186 (memq gud-minor-mode '(gdbmi gdba gdb))))
187 ([print] menu-item "Print Expression" gud-print
188 :enable (not gud-running))
189 ([watch] menu-item "Watch Expression" gud-watch
190 :enable (and (not gud-running)
191 (memq gud-minor-mode '(gdbmi gdba))))
192 ([finish] menu-item "Finish Function" gud-finish
193 :enable (and (not gud-running)
195 '(gdbmi gdba gdb xdb jdb pdb bashdb))))
196 ([stepi] menu-item "Step Instruction" gud-stepi
197 :enable (and (not gud-running)
198 (memq gud-minor-mode '(gdbmi gdba gdb dbx))))
199 ([nexti] menu-item "Next Instruction" gud-nexti
200 :enable (and (not gud-running)
201 (memq gud-minor-mode '(gdbmi gdba gdb dbx))))
202 ([step] menu-item "Step Line" gud-step
203 :enable (not gud-running))
204 ([next] menu-item "Next Line" gud-next
205 :enable (not gud-running))
206 ([cont] menu-item "Continue" gud-cont
207 :enable (not gud-running)
208 :visible (not (eq gud-minor-mode 'gdba))))
209 "Menu for `gud-mode'."
212 (easy-mmode-defmap gud-minor-mode-map
213 `(([menu-bar debug] . ("Gud" . ,gud-menu-map)))
214 "Map used in visited files.")
216 (let ((m (assq 'gud-minor-mode minor-mode-map-alist)))
217 (if m (setcdr m gud-minor-mode-map)
218 (push (cons 'gud-minor-mode gud-minor-mode-map) minor-mode-map-alist)))
221 ;; Will inherit from comint-mode via define-derived-mode.
223 "`gud-mode' keymap.")
225 (defvar gud-tool-bar-map
226 (if (display-graphic-p)
227 (let ((map (make-sparse-keymap)))
228 (dolist (x '((gud-break . "gud/break")
229 (gud-remove . "gud/remove")
230 (gud-print . "gud/print")
231 (gud-pstar . "gud/pstar")
233 (gud-watch . "gud/watch")
234 (gud-run . "gud/run")
236 (gud-stop-subjob . "gud/stop")
237 ;; gud-s, gud-si etc. instead of gud-step,
238 ;; gud-stepi, to avoid file-name clashes on DOS
240 (gud-cont . "gud/cont")
241 (gud-until . "gud/until")
242 (gud-next . "gud/next")
243 (gud-step . "gud/step")
244 (gud-finish . "gud/finish")
245 (gud-nexti . "gud/nexti")
246 (gud-stepi . "gud/stepi")
248 (gud-down . "gud/down")
249 (gud-goto-info . "info"))
251 (tool-bar-local-item-from-menu
252 (car x) (cdr x) map gud-minor-mode-map)))))
254 (defun gud-file-name (f)
255 "Transform a relative file name to an absolute file name.
256 Uses `gud-<MINOR-MODE>-directories' to find the source files."
257 (if (file-exists-p f) (expand-file-name f)
258 (let ((directories (gud-val 'directories))
261 (let ((path (expand-file-name f (car directories))))
262 (if (file-exists-p path)
265 (setq directories (cdr directories)))
268 (defun gud-find-file (file)
269 ;; Don't get confused by double slashes in the name that comes from GDB.
270 (while (string-match "//+" file)
271 (setq file (replace-match "/" t t file)))
272 (let ((minor-mode gud-minor-mode)
273 (buf (funcall (or gud-find-file 'gud-file-name) file)))
275 (setq buf (and (file-readable-p buf) (find-file-noselect buf 'nowarn))))
277 ;; Copy `gud-minor-mode' to the found buffer to turn on the menu.
278 (with-current-buffer buf
279 (set (make-local-variable 'gud-minor-mode) minor-mode)
280 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
281 (when (and gud-tooltip-mode
282 (memq gud-minor-mode '(gdbmi gdba)))
283 (make-local-variable 'gdb-define-alist)
284 (unless gdb-define-alist (gdb-create-define-alist))
285 (add-hook 'after-save-hook 'gdb-create-define-alist nil t))
286 (make-local-variable 'gud-keep-buffer))
289 ;; ======================================================================
290 ;; command definition
292 ;; This macro is used below to define some basic debugger interface commands.
293 ;; Of course you may use `gud-def' with any other debugger command, including
294 ;; user defined ones.
296 ;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
297 ;; which defines FUNC to send the command NAME to the debugger, gives
298 ;; it the docstring DOC, and binds that function to KEY in the GUD
299 ;; major mode. The function is also bound in the global keymap with the
302 (defmacro gud-def (func cmd key &optional doc)
303 "Define FUNC to be a command sending STR and bound to KEY, with
304 optional doc string DOC. Certain %-escapes in the string arguments
305 are interpreted specially if present. These are:
307 %f name (without directory) of current source file.
308 %F name (without directory or extension) of current source file.
309 %d directory of current source file.
310 %l number of current source line
311 %e text of the C lvalue or function-call expression surrounding point.
312 %a text of the hexadecimal address surrounding point
313 %p prefix argument to the command (if any) as a number
315 The `current' source file is the file of the current buffer (if
316 we're in a C file) or the source file current at the last break or
317 step (if we're in the GUD buffer).
318 The `current' line is that of the current buffer (if we're in a
319 source file) or the source line number at the last break or step (if
320 we're in the GUD buffer)."
323 ,@(if doc (list doc))
328 ,(if key `(local-set-key ,(concat "\C-c" key) ',func))
329 ,(if key `(global-set-key (vconcat gud-key-prefix ,key) ',func))))
331 ;; Where gud-display-frame should put the debugging arrow; a cons of
332 ;; (filename . line-number). This is set by the marker-filter, which scans
333 ;; the debugger's output for indications of the current program counter.
334 (defvar gud-last-frame nil)
336 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
337 ;; the last frame, even if it's been called before and gud-last-frame has
339 (defvar gud-last-last-frame nil)
341 ;; All debugger-specific information is collected here.
342 ;; Here's how it works, in case you ever need to add a debugger to the mode.
344 ;; Each entry must define the following at startup:
347 ;; comint-prompt-regexp
348 ;; gud-<name>-massage-args
349 ;; gud-<name>-marker-filter
350 ;; gud-<name>-find-file
352 ;; The job of the massage-args method is to modify the given list of
353 ;; debugger arguments before running the debugger.
355 ;; The job of the marker-filter method is to detect file/line markers in
356 ;; strings and set the global gud-last-frame to indicate what display
357 ;; action (if any) should be triggered by the marker. Note that only
358 ;; whatever the method *returns* is displayed in the buffer; thus, you
359 ;; can filter the debugger's output, interpreting some and passing on
362 ;; The job of the find-file method is to visit and return the buffer indicated
363 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
366 ;; ======================================================================
367 ;; speedbar support functions and variables.
368 (eval-when-compile (require 'speedbar)) ;For speedbar-with-attached-buffer.
370 (defvar gud-last-speedbar-stackframe nil
371 "Description of the currently displayed GUD stack.
372 t means that there is no stack, and we are in display-file mode.")
374 (defvar gud-speedbar-key-map nil
375 "Keymap used when in the buffers display mode.")
377 (defun gud-speedbar-item-info ()
378 "Display the data type of the watch expression element."
379 (let ((var (nth (- (line-number-at-pos (point)) 2) gdb-var-list)))
381 (speedbar-message "%s" (nth 3 var)))))
383 (defun gud-install-speedbar-variables ()
384 "Install those variables used by speedbar to enhance gud/gdb."
385 (if gud-speedbar-key-map
387 (setq gud-speedbar-key-map (speedbar-make-specialized-keymap))
389 (define-key gud-speedbar-key-map "j" 'speedbar-edit-line)
390 (define-key gud-speedbar-key-map "e" 'speedbar-edit-line)
391 (define-key gud-speedbar-key-map "\C-m" 'speedbar-edit-line)
392 (define-key gud-speedbar-key-map " " 'speedbar-toggle-line-expansion)
393 (define-key gud-speedbar-key-map "[" 'speedbar-expand-line-descendants)
394 (define-key gud-speedbar-key-map "]" 'speedbar-contract-line-descendants)
395 (define-key gud-speedbar-key-map "D" 'gdb-var-delete)
396 (define-key gud-speedbar-key-map "p" 'gud-pp))
398 (speedbar-add-expansion-list '("GUD" gud-speedbar-menu-items
400 gud-expansion-speedbar-buttons))
403 'speedbar-mode-functions-list
404 '("GUD" (speedbar-item-info . gud-speedbar-item-info)
405 (speedbar-line-directory . ignore))))
407 (defvar gud-speedbar-menu-items
408 '(["Jump to stack frame" speedbar-edit-line
409 :visible (with-current-buffer gud-comint-buffer
410 (not (memq gud-minor-mode '(gdbmi gdba))))]
411 ["Edit value" speedbar-edit-line
412 :visible (with-current-buffer gud-comint-buffer
413 (memq gud-minor-mode '(gdbmi gdba)))]
414 ["Delete expression" gdb-var-delete
415 (with-current-buffer gud-comint-buffer
416 (memq gud-minor-mode '(gdbmi gdba)))]
417 ["Auto raise frame" gdb-speedbar-auto-raise
418 :style toggle :selected gdb-speedbar-auto-raise
419 :visible (with-current-buffer gud-comint-buffer
420 (memq gud-minor-mode '(gdbmi gdba)))])
421 "Additional menu items to add to the speedbar frame.")
423 ;; Make sure our special speedbar mode is loaded
424 (if (featurep 'speedbar)
425 (gud-install-speedbar-variables)
426 (add-hook 'speedbar-load-hook 'gud-install-speedbar-variables))
428 (defun gud-expansion-speedbar-buttons (directory zero)
429 "Wrapper for call to speedbar-add-expansion-list. DIRECTORY and
430 ZERO are not used, but are required by the caller."
431 (gud-speedbar-buttons gud-comint-buffer))
433 (defun gud-speedbar-buttons (buffer)
434 "Create a speedbar display based on the current state of GUD.
435 If the GUD BUFFER is not running a supported debugger, then turn
436 off the specialized speedbar mode. BUFFER is not used, but are
437 required by the caller."
438 (when (and gud-comint-buffer
439 ;; gud-comint-buffer might be killed
440 (buffer-name gud-comint-buffer))
441 (let* ((minor-mode (with-current-buffer buffer gud-minor-mode))
442 (window (get-buffer-window (current-buffer) 0))
443 (p (window-point window)))
445 ((memq minor-mode '(gdbmi gdba))
446 (when (or gdb-force-update
448 (goto-char (point-min))
449 (let ((case-fold-search t))
450 (looking-at "Watch Expressions:")))))
452 (insert "Watch Expressions:\n")
453 (if gdb-speedbar-auto-raise
454 (raise-frame speedbar-frame))
455 (let ((var-list gdb-var-list) parent)
457 (let* (char (depth 0) (start 0) (var (car var-list))
458 (varnum (nth 1 var)) (status (nth 5 var)))
459 (while (string-match "\\." varnum start)
460 (setq depth (1+ depth)
461 start (1+ (match-beginning 0))))
462 (if (eq depth 0) (setq parent nil))
463 (if (or (equal (nth 2 var) "0")
464 (and (equal (nth 2 var) "1")
465 (string-match "char \\*$" (nth 3 var))))
466 (speedbar-make-tag-line
468 (concat (car var) "\t" (nth 4 var))
469 (if (or parent (eq status 'out-of-scope))
472 (if gdb-show-changed-values
473 (or parent (case status
474 (changed 'font-lock-warning-face)
475 (out-of-scope 'shadow)
478 (if (eq status 'out-of-scope) (setq parent 'shadow))
479 (if (and (cadr var-list)
480 (string-match (concat varnum "\\.")
481 (cadr (cadr var-list))))
484 (if (string-match "\\*$" (nth 3 var))
485 (speedbar-make-tag-line
487 'gdb-speedbar-expand-node varnum
488 (concat (car var) "\t"
491 (if (or parent status 'out-of-scope)
494 (if (and status gdb-show-changed-values)
497 (speedbar-make-tag-line
499 'gdb-speedbar-expand-node varnum
500 (concat (car var) "\t" (nth 3 var))
502 (if (and (nth 5 var) gdb-show-changed-values) 'shadow nil)
504 (setq var-list (cdr var-list))))
505 (setq gdb-force-update nil)))
506 (t (unless (and (save-excursion
507 (goto-char (point-min))
508 (looking-at "Current Stack:"))
509 (equal gud-last-last-frame gud-last-speedbar-stackframe))
510 (let ((gud-frame-list
511 (cond ((eq minor-mode 'gdb)
512 (gud-gdb-get-stackframe buffer))
513 ;; Add more debuggers here!
514 (t (speedbar-remove-localized-speedbar-support buffer)
517 (if (not gud-frame-list)
518 (insert "No Stack frames\n")
519 (insert "Current Stack:\n"))
520 (dolist (frame gud-frame-list)
521 (insert (nth 1 frame) ":\n")
522 (if (= (length frame) 2)
524 (speedbar-insert-button (car frame)
525 'speedbar-directory-face
527 (speedbar-insert-button
530 'speedbar-highlight-face
531 (cond ((memq minor-mode '(gdbmi gdba gdb))
532 'gud-gdb-goto-stackframe)
533 (t (error "Should never be here")))
535 (setq gud-last-speedbar-stackframe gud-last-last-frame))))
536 (set-window-point window p))))
539 ;; ======================================================================
542 ;; History of argument lists passed to gdb.
543 (defvar gud-gdb-history nil)
545 (defcustom gud-gdb-command-name "gdb --annotate=3"
546 "Default command to execute an executable under the GDB debugger."
550 (defvar gud-gdb-marker-regexp
551 ;; This used to use path-separator instead of ":";
552 ;; however, we found that on both Windows 32 and MSDOS
553 ;; a colon is correct here.
554 (concat "\032\032\\(.:?[^" ":" "\n]*\\)" ":"
555 "\\([0-9]*\\)" ":" ".*\n"))
557 ;; There's no guarantee that Emacs will hand the filter the entire
558 ;; marker at once; it could be broken up across several strings. We
559 ;; might even receive a big chunk with several markers in it. If we
560 ;; receive a chunk of text which looks like it might contain the
561 ;; beginning of a marker, we save it here between calls to the
563 (defvar gud-marker-acc "")
564 (make-variable-buffer-local 'gud-marker-acc)
566 (defun gud-gdb-marker-filter (string)
567 (setq gud-marker-acc (concat gud-marker-acc string))
570 ;; Process all the complete markers in this chunk.
571 (while (string-match gud-gdb-marker-regexp gud-marker-acc)
574 ;; Extract the frame position from the marker.
575 gud-last-frame (cons (match-string 1 gud-marker-acc)
576 (string-to-number (match-string 2 gud-marker-acc)))
578 ;; Append any text before the marker to the output we're going
579 ;; to return - we don't include the marker in this text.
580 output (concat output
581 (substring gud-marker-acc 0 (match-beginning 0)))
583 ;; Set the accumulator to the remaining text.
584 gud-marker-acc (substring gud-marker-acc (match-end 0))))
586 ;; Check for annotations and change gud-minor-mode to 'gdba if
588 (while (string-match "\n\032\032\\(.*\\)\n" gud-marker-acc)
589 (let ((match (match-string 1 gud-marker-acc)))
591 ;; Pick up stopped annotation if attaching to process.
592 (if (string-equal match "stopped") (setq gdb-active-process t))
594 ;; Using annotations, switch to gud-gdba-marker-filter.
595 (when (string-equal match "prompt")
600 ;; Append any text before the marker to the output we're going
601 ;; to return - we don't include the marker in this text.
602 output (concat output
603 (substring gud-marker-acc 0 (match-beginning 0)))
605 ;; Set the accumulator to the remaining text.
607 gud-marker-acc (substring gud-marker-acc (match-end 0)))
609 ;; Pick up any errors that occur before first prompt annotation.
610 (if (string-equal match "error-begin")
611 (put-text-property 0 (length gud-marker-acc)
612 'face font-lock-warning-face
615 ;; Does the remaining text look like it might end with the
616 ;; beginning of another marker? If it does, then keep it in
617 ;; gud-marker-acc until we receive the rest of it. Since we
618 ;; know the full marker regexp above failed, it's pretty simple to
619 ;; test for marker starts.
620 (if (string-match "\n\\(\032.*\\)?\\'" gud-marker-acc)
622 ;; Everything before the potential marker start can be output.
623 (setq output (concat output (substring gud-marker-acc
624 0 (match-beginning 0))))
626 ;; Everything after, we save, to combine with later input.
628 (substring gud-marker-acc (match-beginning 0))))
630 (setq output (concat output gud-marker-acc)
635 (easy-mmode-defmap gud-minibuffer-local-map
636 '(("\C-i" . comint-dynamic-complete-filename))
637 "Keymap for minibuffer prompting of gud startup command."
638 :inherit minibuffer-local-map)
640 (defun gud-query-cmdline (minor-mode &optional init)
641 (let* ((hist-sym (gud-symbol 'history nil minor-mode))
642 (cmd-name (gud-val 'command-name minor-mode)))
643 (unless (boundp hist-sym) (set hist-sym nil))
644 (read-from-minibuffer
645 (format "Run %s (like this): " minor-mode)
646 (or (car-safe (symbol-value hist-sym))
647 (concat (or cmd-name (symbol-name minor-mode))
651 (dolist (f (directory-files default-directory) file)
652 (if (and (file-executable-p f)
653 (not (file-directory-p f))
655 (file-newer-than-file-p f file)))
657 gud-minibuffer-local-map nil
660 (defvar gdb-first-prompt t)
662 (defvar gud-filter-pending-text nil
663 "Non-nil means this is text that has been saved for later in `gud-filter'.")
666 (defun gdb (command-line)
667 "Run gdb on program FILE in buffer *gud-FILE*.
668 The directory containing FILE becomes the initial working
669 directory and source-file directory for your debugger. By
670 default this command starts GDB using a graphical interface. See
671 `gdba' for more information.
673 To run GDB in text command mode, set `gud-gdb-command-name' to
674 \"gdb --fullname\" and include the pathname, if necessary."
675 (interactive (list (gud-query-cmdline 'gdb)))
677 (if (and gud-comint-buffer
678 (buffer-name gud-comint-buffer)
679 (with-current-buffer gud-comint-buffer (eq gud-minor-mode 'gdba)))
680 (error "Multiple debugging is only supported with \"gdb --fullname\""))
682 (gud-common-init command-line nil 'gud-gdb-marker-filter)
683 (set (make-local-variable 'gud-minor-mode) 'gdb)
685 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
686 (gud-def gud-tbreak "tbreak %f:%l" "\C-t"
687 "Set temporary breakpoint at current line.")
688 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
689 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
690 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
691 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
692 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
693 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
694 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
696 (progn (gud-call "tbreak %f:%l") (gud-call "jump %f:%l"))
697 "\C-j" "Set execution address to current line.")
699 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
700 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
701 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
702 (gud-def gud-pstar "print* %e" nil
703 "Evaluate C dereferenced pointer expression at point.")
705 ;; For debugging Emacs only.
706 (gud-def gud-pv "pv1 %e" "\C-v" "Print the value of the lisp variable.")
708 (gud-def gud-until "until %l" "\C-u" "Continue to current line.")
709 (gud-def gud-run "run" nil "Run the program.")
711 (local-set-key "\C-i" 'gud-gdb-complete-command)
712 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
713 (setq paragraph-start comint-prompt-regexp)
714 (setq gdb-first-prompt t)
715 (setq gud-filter-pending-text nil)
716 (run-hooks 'gdb-mode-hook))
718 ;; One of the nice features of GDB is its impressive support for
719 ;; context-sensitive command completion. We preserve that feature
720 ;; in the GUD buffer by using a GDB command designed just for Emacs.
722 ;; The completion process filter indicates when it is finished.
723 (defvar gud-gdb-fetch-lines-in-progress)
725 ;; Since output may arrive in fragments we accumulate partials strings here.
726 (defvar gud-gdb-fetch-lines-string)
728 ;; We need to know how much of the completion to chop off.
729 (defvar gud-gdb-fetch-lines-break)
731 ;; The completion list is constructed by the process filter.
732 (defvar gud-gdb-fetched-lines)
734 (defvar gud-comint-buffer nil)
736 (defun gud-gdb-complete-command ()
737 "Perform completion on the GDB command preceding point.
738 This is implemented using the GDB `complete' command which isn't
739 available with older versions of GDB."
742 (command (buffer-substring (comint-line-beginning-position) end))
744 ;; Find the word break. This match will always succeed.
745 (and (string-match "\\(\\`\\| \\)\\([^ ]*\\)\\'" command)
746 (substring command (match-beginning 2))))
748 (gud-gdb-run-command-fetch-lines (concat "complete " command)
750 ;; From string-match above.
751 (match-beginning 2))))
752 ;; Protect against old versions of GDB.
754 (string-match "^Undefined command: \"complete\"" (car complete-list))
755 (error "This version of GDB doesn't support the `complete' command"))
756 ;; Sort the list like readline.
757 (setq complete-list (sort complete-list (function string-lessp)))
758 ;; Remove duplicates.
759 (let ((first complete-list)
760 (second (cdr complete-list)))
762 (if (string-equal (car first) (car second))
763 (setcdr first (setq second (cdr second)))
765 second (cdr second)))))
766 ;; Add a trailing single quote if there is a unique completion
767 ;; and it contains an odd number of unquoted single quotes.
768 (and (= (length complete-list) 1)
769 (let ((str (car complete-list))
772 (while (string-match "\\([^'\\]\\|\\\\'\\)*'" str pos)
773 (setq count (1+ count)
775 (and (= (mod count 2) 1)
776 (setq complete-list (list (concat str "'"))))))
777 ;; Let comint handle the rest.
778 (comint-dynamic-simple-complete command-word complete-list)))
780 ;; The completion process filter is installed temporarily to slurp the
781 ;; output of GDB up to the next prompt and build the completion list.
782 (defun gud-gdb-fetch-lines-filter (string filter)
783 "Filter used to read the list of lines output by a command.
784 STRING is the output to filter.
785 It is passed through FILTER before we look at it."
786 (setq string (funcall filter string))
787 (setq string (concat gud-gdb-fetch-lines-string string))
788 (while (string-match "\n" string)
789 (push (substring string gud-gdb-fetch-lines-break (match-beginning 0))
790 gud-gdb-fetched-lines)
791 (setq string (substring string (match-end 0))))
792 (if (string-match comint-prompt-regexp string)
794 (setq gud-gdb-fetch-lines-in-progress nil)
797 (setq gud-gdb-fetch-lines-string string)
800 ;; gdb speedbar functions
802 (defun gud-gdb-goto-stackframe (text token indent)
803 "Goto the stackframe described by TEXT, TOKEN, and INDENT."
804 (speedbar-with-attached-buffer
805 (gud-basic-call (concat "server frame " (nth 1 token)))
808 (defvar gud-gdb-fetched-stack-frame nil
809 "Stack frames we are fetching from GDB.")
811 ;(defun gud-gdb-get-scope-data (text token indent)
812 ; ;; checkdoc-params: (indent)
813 ; "Fetch data associated with a stack frame, and expand/contract it.
814 ;Data to do this is retrieved from TEXT and TOKEN."
815 ; (let ((args nil) (scope nil))
816 ; (gud-gdb-run-command-fetch-lines "info args")
818 ; (gud-gdb-run-command-fetch-lines "info local")
822 (defun gud-gdb-get-stackframe (buffer)
823 "Extract the current stack frame out of the GUD GDB BUFFER."
825 (fetched-stack-frame-list
826 (gud-gdb-run-command-fetch-lines "server backtrace" buffer)))
827 (if (and (car fetched-stack-frame-list)
828 (string-match "No stack" (car fetched-stack-frame-list)))
829 ;; Go into some other mode???
831 (dolist (e fetched-stack-frame-list)
832 (let ((name nil) (num nil))
834 (string-match "^#\\([0-9]+\\) +[0-9a-fx]+ in \\([:0-9a-zA-Z_]+\\) (" e)
835 (string-match "^#\\([0-9]+\\) +\\([:0-9a-zA-Z_]+\\) (" e)))
836 (if (not (string-match
837 "at \\([-0-9a-zA-Z_.]+\\):\\([0-9]+\\)$" e))
840 (list (nth 0 (car newlst))
843 (match-string 2 e))))
844 (setq num (match-string 1 e)
845 name (match-string 2 e))
849 "at \\([-0-9a-zA-Z_.]+\\):\\([0-9]+\\)$" e)
850 (list name num (match-string 1 e)
856 ;(defun gud-gdb-selected-frame-info (buffer)
857 ; "Learn GDB information for the currently selected stack frame in BUFFER."
860 (defun gud-gdb-run-command-fetch-lines (command buffer &optional skip)
861 "Run COMMAND, and return the list of lines it outputs.
862 BUFFER is the GUD buffer in which to run the command.
863 SKIP is the number of chars to skip on each lines, it defaults to 0."
864 (with-current-buffer buffer
866 (goto-char (point-max))
868 (not (looking-at comint-prompt-regexp)))
870 ;; Much of this copied from GDB complete, but I'm grabbing the stack
872 (let ((gud-gdb-fetch-lines-in-progress t)
873 (gud-gdb-fetched-lines nil)
874 (gud-gdb-fetch-lines-string nil)
875 (gud-gdb-fetch-lines-break (or skip 0))
877 `(lambda (string) (gud-gdb-fetch-lines-filter string ',gud-marker-filter))))
878 ;; Issue the command to GDB.
879 (gud-basic-call command)
881 (while gud-gdb-fetch-lines-in-progress
882 (accept-process-output (get-buffer-process buffer)))
883 (nreverse gud-gdb-fetched-lines)))))
886 ;; ======================================================================
889 ;; History of argument lists passed to sdb.
890 (defvar gud-sdb-history nil)
892 (defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
893 "If nil, we're on a System V Release 4 and don't need the tags hack.")
895 (defvar gud-sdb-lastfile nil)
897 (defun gud-sdb-marker-filter (string)
899 (if gud-marker-acc (concat gud-marker-acc string) string))
901 ;; Process all complete markers in this chunk
904 ;; System V Release 3.2 uses this format
905 ((string-match "\\(^\\|\n\\)\\*?\\(0x\\w* in \\)?\\([^:\n]*\\):\\([0-9]*\\):.*\n"
906 gud-marker-acc start)
908 (cons (match-string 3 gud-marker-acc)
909 (string-to-number (match-string 4 gud-marker-acc)))))
910 ;; System V Release 4.0 quite often clumps two lines together
911 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
912 gud-marker-acc start)
913 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc))
915 (cons gud-sdb-lastfile
916 (string-to-number (match-string 3 gud-marker-acc)))))
917 ;; System V Release 4.0
918 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n"
919 gud-marker-acc start)
920 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc)))
921 ((and gud-sdb-lastfile (string-match "^\\([0-9]+\\):"
922 gud-marker-acc start))
924 (cons gud-sdb-lastfile
925 (string-to-number (match-string 1 gud-marker-acc)))))
927 (setq gud-sdb-lastfile nil)))
928 (setq start (match-end 0)))
930 ;; Search for the last incomplete line in this chunk
931 (while (string-match "\n" gud-marker-acc start)
932 (setq start (match-end 0)))
934 ;; If we have an incomplete line, store it in gud-marker-acc.
935 (setq gud-marker-acc (substring gud-marker-acc (or start 0))))
938 (defun gud-sdb-find-file (f)
939 (if gud-sdb-needs-tags (find-tag-noselect f) (find-file-noselect f)))
942 (defun sdb (command-line)
943 "Run sdb on program FILE in buffer *gud-FILE*.
944 The directory containing FILE becomes the initial working directory
945 and source-file directory for your debugger."
946 (interactive (list (gud-query-cmdline 'sdb)))
948 (if gud-sdb-needs-tags (require 'etags))
949 (if (and gud-sdb-needs-tags
950 (not (and (boundp 'tags-file-name)
951 (stringp tags-file-name)
952 (file-exists-p tags-file-name))))
953 (error "The sdb support requires a valid tags table to work"))
955 (gud-common-init command-line nil 'gud-sdb-marker-filter 'gud-sdb-find-file)
956 (set (make-local-variable 'gud-minor-mode) 'sdb)
958 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
959 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
960 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
961 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
962 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
963 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
964 (gud-def gud-cont "c" "\C-r" "Continue with display.")
965 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
967 (setq comint-prompt-regexp "\\(^\\|\n\\)\\*")
968 (setq paragraph-start comint-prompt-regexp)
969 (run-hooks 'sdb-mode-hook)
972 ;; ======================================================================
975 ;; History of argument lists passed to dbx.
976 (defvar gud-dbx-history nil)
978 (defcustom gud-dbx-directories nil
979 "*A list of directories that dbx should search for source code.
980 If nil, only source files in the program directory
981 will be known to dbx.
983 The file names should be absolute, or relative to the directory
984 containing the executable being debugged."
985 :type '(choice (const :tag "Current Directory" nil)
990 (defun gud-dbx-massage-args (file args)
991 (nconc (let ((directories gud-dbx-directories)
994 (setq result (cons (car directories) (cons "-I" result)))
995 (setq directories (cdr directories)))
999 (defun gud-dbx-marker-filter (string)
1000 (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
1003 ;; Process all complete markers in this chunk.
1004 (while (or (string-match
1005 "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
1006 gud-marker-acc start)
1008 "signal .* in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
1009 gud-marker-acc start))
1010 (setq gud-last-frame
1011 (cons (match-string 2 gud-marker-acc)
1012 (string-to-number (match-string 1 gud-marker-acc)))
1013 start (match-end 0)))
1015 ;; Search for the last incomplete line in this chunk
1016 (while (string-match "\n" gud-marker-acc start)
1017 (setq start (match-end 0)))
1019 ;; If the incomplete line APPEARS to begin with another marker, keep it
1020 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1021 ;; unnecessary concat during the next call.
1022 (setq gud-marker-acc
1023 (if (string-match "\\(stopped\\|signal\\)" gud-marker-acc start)
1024 (substring gud-marker-acc (match-beginning 0))
1028 ;; Functions for Mips-style dbx. Given the option `-emacs', documented in
1029 ;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
1031 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
1032 ;; We haven't tested gud on this system:
1033 (string-match "^mips-[^-]*-riscos" system-configuration)
1034 ;; It's documented on OSF/1.3
1035 (string-match "^mips-[^-]*-osf1" system-configuration)
1036 (string-match "^alpha[^-]*-[^-]*-osf" system-configuration))
1037 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
1039 (defvar gud-dbx-command-name
1040 (concat "dbx" (if gud-mips-p " -emacs")))
1042 ;; This is just like the gdb one except for the regexps since we need to cope
1043 ;; with an optional breakpoint number in [] before the ^Z^Z
1044 (defun gud-mipsdbx-marker-filter (string)
1045 (setq gud-marker-acc (concat gud-marker-acc string))
1048 ;; Process all the complete markers in this chunk.
1049 (while (string-match
1050 ;; This is like th gdb marker but with an optional
1051 ;; leading break point number like `[1] '
1052 "[][ 0-9]*\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
1056 ;; Extract the frame position from the marker.
1058 (cons (match-string 1 gud-marker-acc)
1059 (string-to-number (match-string 2 gud-marker-acc)))
1061 ;; Append any text before the marker to the output we're going
1062 ;; to return - we don't include the marker in this text.
1063 output (concat output
1064 (substring gud-marker-acc 0 (match-beginning 0)))
1066 ;; Set the accumulator to the remaining text.
1067 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1069 ;; Does the remaining text look like it might end with the
1070 ;; beginning of another marker? If it does, then keep it in
1071 ;; gud-marker-acc until we receive the rest of it. Since we
1072 ;; know the full marker regexp above failed, it's pretty simple to
1073 ;; test for marker starts.
1074 (if (string-match "[][ 0-9]*\032.*\\'" gud-marker-acc)
1076 ;; Everything before the potential marker start can be output.
1077 (setq output (concat output (substring gud-marker-acc
1078 0 (match-beginning 0))))
1080 ;; Everything after, we save, to combine with later input.
1081 (setq gud-marker-acc
1082 (substring gud-marker-acc (match-beginning 0))))
1084 (setq output (concat output gud-marker-acc)
1089 ;; The dbx in IRIX is a pain. It doesn't print the file name when
1090 ;; stopping at a breakpoint (but you do get it from the `up' and
1091 ;; `down' commands...). The only way to extract the information seems
1092 ;; to be with a `file' command, although the current line number is
1093 ;; available in $curline. Thus we have to look for output which
1094 ;; appears to indicate a breakpoint. Then we prod the dbx sub-process
1095 ;; to output the information we want with a combination of the
1096 ;; `printf' and `file' commands as a pseudo marker which we can
1097 ;; recognise next time through the marker-filter. This would be like
1098 ;; the gdb marker but you can't get the file name without a newline...
1099 ;; Note that gud-remove won't work since Irix dbx expects a breakpoint
1100 ;; number rather than a line number etc. Maybe this could be made to
1101 ;; work by listing all the breakpoints and picking the one(s) with the
1102 ;; correct line number, but life's too short.
1103 ;; d.love@dl.ac.uk (Dave Love) can be blamed for this
1106 (and (string-match "^mips-[^-]*-irix" system-configuration)
1107 (not (string-match "irix[6-9]\\.[1-9]" system-configuration)))
1108 "Non-nil to assume the interface appropriate for IRIX dbx.
1109 This works in IRIX 4, 5 and 6, but `gud-dbx-use-stopformat-p' provides
1110 a better solution in 6.1 upwards.")
1111 (defvar gud-dbx-use-stopformat-p
1112 (string-match "irix[6-9]\\.[1-9]" system-configuration)
1113 "Non-nil to use the dbx feature present at least from Irix 6.1
1114 whereby $stopformat=1 produces an output format compatiable with
1115 `gud-dbx-marker-filter'.")
1116 ;; [Irix dbx seems to be a moving target. The dbx output changed
1117 ;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
1118 ;; the output from `up' is no longer spotted by gud (and it's probably
1119 ;; not distinctive enough to try to match it -- use C-<, C->
1120 ;; exclusively) . For 5.3 and 6.0, the $curline variable changed to
1121 ;; `long long'(why?!), so the printf stuff needed changing. The line
1122 ;; number was cast to `long' as a compromise between the new `long
1123 ;; long' and the original `int'. This is reported not to work in 6.2,
1124 ;; so it's changed back to int -- don't make your sources too long.
1125 ;; From Irix6.1 (but not 6.0?) dbx supports an undocumented feature
1126 ;; whereby `set $stopformat=1' reportedly produces output compatible
1127 ;; with `gud-dbx-marker-filter', which we prefer.
1129 ;; The process filter is also somewhat
1130 ;; unreliable, sometimes not spotting the markers; I don't know
1131 ;; whether there's anything that can be done about that. It would be
1132 ;; much better if SGI could be persuaded to (re?)instate the MIPS
1133 ;; -emacs flag for gdb-like output (which ought to be possible as most
1134 ;; of the communication I've had over it has been from sgi.com).]
1136 ;; this filter is influenced by the xdb one rather than the gdb one
1137 (defun gud-irixdbx-marker-filter (string)
1138 (let (result (case-fold-search nil))
1139 (if (or (string-match comint-prompt-regexp string)
1140 (string-match ".*\012" string))
1141 (setq result (concat gud-marker-acc string)
1143 (setq gud-marker-acc (concat gud-marker-acc string)))
1146 ;; look for breakpoint or signal indication e.g.:
1147 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
1148 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
1149 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
1151 "^\\(\\[[0-9]+] \\)?Process +[0-9]+ ([^)]*) [^[]+\\[[^]\n]*]\n"
1153 ;; prod dbx into printing out the line number and file
1154 ;; name in a form we can grok as below
1155 (process-send-string (get-buffer-process gud-comint-buffer)
1156 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1157 ;; look for result of, say, "up" e.g.:
1158 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
1159 ;; (this will also catch one of the lines printed by "where")
1161 "^[^ ][^[]*\\[\"\\([^\"]+\\)\":\\([0-9]+\\), [^]]+]\n"
1163 (let ((file (match-string 1 result)))
1164 (if (file-exists-p file)
1165 (setq gud-last-frame
1166 (cons (match-string 1 result)
1167 (string-to-number (match-string 2 result))))))
1169 ((string-match ; kluged-up marker as above
1170 "\032\032\\([0-9]*\\):\\(.*\\)\n" result)
1171 (let ((file (gud-file-name (match-string 2 result))))
1172 (if (and file (file-exists-p file))
1173 (setq gud-last-frame
1175 (string-to-number (match-string 1 result))))))
1176 (setq result (substring result 0 (match-beginning 0))))))
1179 (defvar gud-dgux-p (string-match "-dgux" system-configuration)
1180 "Non-nil means to assume the interface approriate for DG/UX dbx.
1181 This was tested using R4.11.")
1183 ;; There are a couple of differences between DG's dbx output and normal
1184 ;; dbx output which make it nontrivial to integrate this into the
1185 ;; standard dbx-marker-filter (mainly, there are a different number of
1186 ;; backreferences). The markers look like:
1188 ;; (0) Stopped at line 10, routine main(argc=1, argv=0xeffff0e0), file t.c
1190 ;; from breakpoints (the `(0)' there isn't constant, it's the breakpoint
1193 ;; Stopped at line 13, routine main(argc=1, argv=0xeffff0e0), file t.c
1197 ;; Frame 21, line 974, routine command_loop(), file keyboard.c
1199 ;; from up/down/where.
1201 (defun gud-dguxdbx-marker-filter (string)
1202 (setq gud-marker-acc (if gud-marker-acc
1203 (concat gud-marker-acc string)
1205 (let ((re (concat "^\\(\\(([0-9]+) \\)?Stopped at\\|Frame [0-9]+,\\)"
1206 " line \\([0-9]+\\), routine .*, file \\([^ \t\n]+\\)"))
1208 ;; Process all complete markers in this chunk.
1209 (while (string-match re gud-marker-acc start)
1210 (setq gud-last-frame
1211 (cons (match-string 4 gud-marker-acc)
1212 (string-to-number (match-string 3 gud-marker-acc)))
1213 start (match-end 0)))
1215 ;; Search for the last incomplete line in this chunk
1216 (while (string-match "\n" gud-marker-acc start)
1217 (setq start (match-end 0)))
1219 ;; If the incomplete line APPEARS to begin with another marker, keep it
1220 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1221 ;; unnecessary concat during the next call.
1222 (setq gud-marker-acc
1223 (if (string-match "Stopped\\|Frame" gud-marker-acc start)
1224 (substring gud-marker-acc (match-beginning 0))
1229 (defun dbx (command-line)
1230 "Run dbx on program FILE in buffer *gud-FILE*.
1231 The directory containing FILE becomes the initial working directory
1232 and source-file directory for your debugger."
1233 (interactive (list (gud-query-cmdline 'dbx)))
1237 (gud-common-init command-line nil 'gud-mipsdbx-marker-filter))
1239 (gud-common-init command-line 'gud-dbx-massage-args
1240 'gud-irixdbx-marker-filter))
1242 (gud-common-init command-line 'gud-dbx-massage-args
1243 'gud-dguxdbx-marker-filter))
1245 (gud-common-init command-line 'gud-dbx-massage-args
1246 'gud-dbx-marker-filter)))
1248 (set (make-local-variable 'gud-minor-mode) 'dbx)
1252 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1253 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1254 (gud-def gud-break "stop at \"%f\":%l"
1255 "\C-b" "Set breakpoint at current line.")
1256 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
1258 (gud-def gud-break "stop at \"%d%f\":%l"
1259 "\C-b" "Set breakpoint at current line.")
1260 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1261 (gud-def gud-up "up %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1262 "<" "Up (numeric arg) stack frames.")
1263 (gud-def gud-down "down %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1264 ">" "Down (numeric arg) stack frames.")
1265 ;; Make dbx give out the source location info that we need.
1266 (process-send-string (get-buffer-process gud-comint-buffer)
1267 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1269 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1270 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1271 (gud-def gud-break "file \"%d%f\"\nstop at %l"
1272 "\C-b" "Set breakpoint at current line.")
1273 (if gud-dbx-use-stopformat-p
1274 (process-send-string (get-buffer-process gud-comint-buffer)
1275 "set $stopformat=1\n"))))
1277 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
1278 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
1279 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
1280 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
1281 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
1282 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
1283 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
1284 (gud-def gud-run "run" nil "Run the program.")
1286 (setq comint-prompt-regexp "^[^)\n]*dbx) *")
1287 (setq paragraph-start comint-prompt-regexp)
1288 (run-hooks 'dbx-mode-hook)
1291 ;; ======================================================================
1292 ;; xdb (HP PARISC debugger) functions
1294 ;; History of argument lists passed to xdb.
1295 (defvar gud-xdb-history nil)
1297 (defcustom gud-xdb-directories nil
1298 "*A list of directories that xdb should search for source code.
1299 If nil, only source files in the program directory
1300 will be known to xdb.
1302 The file names should be absolute, or relative to the directory
1303 containing the executable being debugged."
1304 :type '(choice (const :tag "Current Directory" nil)
1309 (defun gud-xdb-massage-args (file args)
1310 (nconc (let ((directories gud-xdb-directories)
1313 (setq result (cons (car directories) (cons "-d" result)))
1314 (setq directories (cdr directories)))
1318 ;; xdb does not print the lines all at once, so we have to accumulate them
1319 (defun gud-xdb-marker-filter (string)
1321 (if (or (string-match comint-prompt-regexp string)
1322 (string-match ".*\012" string))
1323 (setq result (concat gud-marker-acc string)
1325 (setq gud-marker-acc (concat gud-marker-acc string)))
1327 (if (or (string-match "\\([^\n \t:]+\\): [^:]+: \\([0-9]+\\)[: ]"
1329 (string-match "[^: \t]+:[ \t]+\\([^:]+\\): [^:]+: \\([0-9]+\\):"
1331 (let ((line (string-to-number (match-string 2 result)))
1332 (file (gud-file-name (match-string 1 result))))
1334 (setq gud-last-frame (cons file line))))))
1338 (defun xdb (command-line)
1339 "Run xdb on program FILE in buffer *gud-FILE*.
1340 The directory containing FILE becomes the initial working directory
1341 and source-file directory for your debugger.
1343 You can set the variable `gud-xdb-directories' to a list of program source
1344 directories if your program contains sources from more than one directory."
1345 (interactive (list (gud-query-cmdline 'xdb)))
1347 (gud-common-init command-line 'gud-xdb-massage-args
1348 'gud-xdb-marker-filter)
1349 (set (make-local-variable 'gud-minor-mode) 'xdb)
1351 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
1352 (gud-def gud-tbreak "b %f:%l\\t" "\C-t"
1353 "Set temporary breakpoint at current line.")
1354 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
1355 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
1356 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1357 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1358 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1359 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1360 (gud-def gud-finish "bu\\t" "\C-f" "Finish executing current function.")
1361 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
1363 (setq comint-prompt-regexp "^>")
1364 (setq paragraph-start comint-prompt-regexp)
1365 (run-hooks 'xdb-mode-hook))
1367 ;; ======================================================================
1370 ;; History of argument lists passed to perldb.
1371 (defvar gud-perldb-history nil)
1373 (defun gud-perldb-massage-args (file args)
1374 "Convert a command line as would be typed normally to run perldb
1375 into one that invokes an Emacs-enabled debugging session.
1376 \"-emacs\" is inserted where it will be $ARGV[0] (see perl5db.pl)."
1377 ;; FIXME: what if the command is `make perldb' and doesn't accept those extra
1379 (let* ((new-args nil)
1381 (shift (lambda () (push (pop args) new-args))))
1383 ;; Pass all switches and -e scripts through.
1385 (string-match "^-" (car args))
1386 (not (equal "-" (car args)))
1387 (not (equal "--" (car args))))
1388 (when (equal "-e" (car args))
1389 ;; -e goes with the next arg, so shift one extra.
1391 ;; -e as the last arg is an error in Perl.
1392 (error "No code specified for -e"))
1398 (string-match "^-" (car args)))
1399 (error "Can't use stdin as the script to debug"))
1400 ;; This is the program name.
1403 ;; If -e specified, make sure there is a -- so -emacs is not taken
1405 (if (and args (equal "--" (car args)))
1407 (and seen-e (push "--" new-args)))
1409 (push "-emacs" new-args)
1413 (nreverse new-args)))
1415 ;; There's no guarantee that Emacs will hand the filter the entire
1416 ;; marker at once; it could be broken up across several strings. We
1417 ;; might even receive a big chunk with several markers in it. If we
1418 ;; receive a chunk of text which looks like it might contain the
1419 ;; beginning of a marker, we save it here between calls to the
1421 (defun gud-perldb-marker-filter (string)
1422 (setq gud-marker-acc (concat gud-marker-acc string))
1425 ;; Process all the complete markers in this chunk.
1426 (while (string-match "\032\032\\(\\([a-zA-Z]:\\)?[^:\n]*\\):\\([0-9]*\\):.*\n"
1430 ;; Extract the frame position from the marker.
1432 (cons (match-string 1 gud-marker-acc)
1433 (string-to-number (match-string 3 gud-marker-acc)))
1435 ;; Append any text before the marker to the output we're going
1436 ;; to return - we don't include the marker in this text.
1437 output (concat output
1438 (substring gud-marker-acc 0 (match-beginning 0)))
1440 ;; Set the accumulator to the remaining text.
1441 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1443 ;; Does the remaining text look like it might end with the
1444 ;; beginning of another marker? If it does, then keep it in
1445 ;; gud-marker-acc until we receive the rest of it. Since we
1446 ;; know the full marker regexp above failed, it's pretty simple to
1447 ;; test for marker starts.
1448 (if (string-match "\032.*\\'" gud-marker-acc)
1450 ;; Everything before the potential marker start can be output.
1451 (setq output (concat output (substring gud-marker-acc
1452 0 (match-beginning 0))))
1454 ;; Everything after, we save, to combine with later input.
1455 (setq gud-marker-acc
1456 (substring gud-marker-acc (match-beginning 0))))
1458 (setq output (concat output gud-marker-acc)
1463 (defcustom gud-perldb-command-name "perl -d"
1464 "Default command to execute a Perl script under debugger."
1469 (defun perldb (command-line)
1470 "Run perldb on program FILE in buffer *gud-FILE*.
1471 The directory containing FILE becomes the initial working directory
1472 and source-file directory for your debugger."
1474 (list (gud-query-cmdline 'perldb
1475 (concat (or (buffer-file-name) "-e 0") " "))))
1477 (gud-common-init command-line 'gud-perldb-massage-args
1478 'gud-perldb-marker-filter)
1479 (set (make-local-variable 'gud-minor-mode) 'perldb)
1481 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
1482 (gud-def gud-remove "B %l" "\C-d" "Remove breakpoint at current line")
1483 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
1484 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
1485 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1486 ; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
1487 ; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
1488 ; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
1489 (gud-def gud-print "p %e" "\C-p" "Evaluate perl expression at point.")
1490 (gud-def gud-until "c %l" "\C-u" "Continue to current line.")
1493 (setq comint-prompt-regexp "^ DB<+[0-9]+>+ ")
1494 (setq paragraph-start comint-prompt-regexp)
1495 (run-hooks 'perldb-mode-hook))
1497 ;; ======================================================================
1498 ;; pdb (Python debugger) functions
1500 ;; History of argument lists passed to pdb.
1501 (defvar gud-pdb-history nil)
1503 ;; Last group is for return value, e.g. "> test.py(2)foo()->None"
1504 ;; Either file or function name may be omitted: "> <string>(0)?()"
1505 (defvar gud-pdb-marker-regexp
1506 "^> \\([-a-zA-Z0-9_/.:\\]*\\|<string>\\)(\\([0-9]+\\))\\([a-zA-Z0-9_]*\\|\\?\\)()\\(->[^\n]*\\)?\n")
1507 (defvar gud-pdb-marker-regexp-file-group 1)
1508 (defvar gud-pdb-marker-regexp-line-group 2)
1509 (defvar gud-pdb-marker-regexp-fnname-group 3)
1511 (defvar gud-pdb-marker-regexp-start "^> ")
1513 ;; There's no guarantee that Emacs will hand the filter the entire
1514 ;; marker at once; it could be broken up across several strings. We
1515 ;; might even receive a big chunk with several markers in it. If we
1516 ;; receive a chunk of text which looks like it might contain the
1517 ;; beginning of a marker, we save it here between calls to the
1519 (defun gud-pdb-marker-filter (string)
1520 (setq gud-marker-acc (concat gud-marker-acc string))
1523 ;; Process all the complete markers in this chunk.
1524 (while (string-match gud-pdb-marker-regexp gud-marker-acc)
1527 ;; Extract the frame position from the marker.
1529 (let ((file (match-string gud-pdb-marker-regexp-file-group
1531 (line (string-to-number
1532 (match-string gud-pdb-marker-regexp-line-group
1534 (if (string-equal file "<string>")
1538 ;; Output everything instead of the below
1539 output (concat output (substring gud-marker-acc 0 (match-end 0)))
1540 ;; ;; Append any text before the marker to the output we're going
1541 ;; ;; to return - we don't include the marker in this text.
1542 ;; output (concat output
1543 ;; (substring gud-marker-acc 0 (match-beginning 0)))
1545 ;; Set the accumulator to the remaining text.
1546 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1548 ;; Does the remaining text look like it might end with the
1549 ;; beginning of another marker? If it does, then keep it in
1550 ;; gud-marker-acc until we receive the rest of it. Since we
1551 ;; know the full marker regexp above failed, it's pretty simple to
1552 ;; test for marker starts.
1553 (if (string-match gud-pdb-marker-regexp-start gud-marker-acc)
1555 ;; Everything before the potential marker start can be output.
1556 (setq output (concat output (substring gud-marker-acc
1557 0 (match-beginning 0))))
1559 ;; Everything after, we save, to combine with later input.
1560 (setq gud-marker-acc
1561 (substring gud-marker-acc (match-beginning 0))))
1563 (setq output (concat output gud-marker-acc)
1568 (defcustom gud-pdb-command-name "pdb"
1569 "File name for executing the Python debugger.
1570 This should be an executable on your path, or an absolute file name."
1575 (defun pdb (command-line)
1576 "Run pdb on program FILE in buffer `*gud-FILE*'.
1577 The directory containing FILE becomes the initial working directory
1578 and source-file directory for your debugger."
1580 (list (gud-query-cmdline 'pdb)))
1582 (gud-common-init command-line nil 'gud-pdb-marker-filter)
1583 (set (make-local-variable 'gud-minor-mode) 'pdb)
1585 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
1586 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
1587 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
1588 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
1589 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
1590 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1591 (gud-def gud-up "up" "<" "Up one stack frame.")
1592 (gud-def gud-down "down" ">" "Down one stack frame.")
1593 (gud-def gud-print "p %e" "\C-p" "Evaluate Python expression at point.")
1595 (gud-def gud-statement "! %e" "\C-e" "Execute Python statement at point.")
1597 ;; (setq comint-prompt-regexp "^(.*pdb[+]?) *")
1598 (setq comint-prompt-regexp "^(Pdb) *")
1599 (setq paragraph-start comint-prompt-regexp)
1600 (run-hooks 'pdb-mode-hook))
1602 ;; ======================================================================
1606 ;; AUTHOR: Derek Davies <ddavies@world.std.com>
1607 ;; Zoltan Kemenczy <zoltan@ieee.org;zkemenczy@rim.net>
1609 ;; CREATED: Sun Feb 22 10:46:38 1998 Derek Davies.
1610 ;; UPDATED: Nov 11, 2001 Zoltan Kemenczy
1611 ;; Dec 10, 2002 Zoltan Kemenczy - added nested class support
1613 ;; INVOCATION NOTES:
1615 ;; You invoke jdb-mode with:
1619 ;; It responds with:
1621 ;; Run jdb (like this): jdb
1623 ;; type any jdb switches followed by the name of the class you'd like to debug.
1624 ;; Supply a fully qualfied classname (these do not have the ".class" extension)
1625 ;; for the name of the class to debug (e.g. "COM.the-kind.ddavies.CoolClass").
1626 ;; See the known problems section below for restrictions when specifying jdb
1627 ;; command line switches (search forward for '-classpath').
1629 ;; You should see something like the following:
1631 ;; Current directory is ~/src/java/hello/
1632 ;; Initializing jdb...
1633 ;; 0xed2f6628:class(hello)
1636 ;; To set an initial breakpoint try:
1638 ;; > stop in hello.main
1639 ;; Breakpoint set in hello.main
1642 ;; To execute the program type:
1647 ;; Breakpoint hit: running ...
1648 ;; hello.main (hello:12)
1650 ;; Type M-n to step over the current line and M-s to step into it. That,
1651 ;; along with the JDB 'help' command should get you started. The 'quit'
1652 ;; JDB command will get out out of the debugger. There is some truly
1653 ;; pathetic JDB documentation available at:
1655 ;; http://java.sun.com/products/jdk/1.1/debugging/
1657 ;; KNOWN PROBLEMS AND FIXME's:
1659 ;; Not sure what happens with inner classes ... haven't tried them.
1661 ;; Does not grok UNICODE id's. Only ASCII id's are supported.
1663 ;; You must not put whitespace between "-classpath" and the path to
1664 ;; search for java classes even though it is required when invoking jdb
1665 ;; from the command line. See gud-jdb-massage-args for details.
1666 ;; The same applies for "-sourcepath".
1668 ;; Note: The following applies only if `gud-jdb-use-classpath' is nil;
1669 ;; refer to the documentation of `gud-jdb-use-classpath' and
1670 ;; `gud-jdb-classpath',`gud-jdb-sourcepath' variables for information
1671 ;; on using the classpath for locating java source files.
1673 ;; If any of the source files in the directories listed in
1674 ;; gud-jdb-directories won't parse you'll have problems. Make sure
1675 ;; every file ending in ".java" in these directories parses without error.
1677 ;; All the .java files in the directories in gud-jdb-directories are
1678 ;; syntactically analyzed each time gud jdb is invoked. It would be
1679 ;; nice to keep as much information as possible between runs. It would
1680 ;; be really nice to analyze the files only as neccessary (when the
1681 ;; source needs to be displayed.) I'm not sure to what extent the former
1682 ;; can be accomplished and I'm not sure the latter can be done at all
1683 ;; since I don't know of any general way to tell which .class files are
1684 ;; defined by which .java file without analyzing all the .java files.
1685 ;; If anyone knows why JavaSoft didn't put the source file names in
1686 ;; debuggable .class files please clue me in so I find something else
1687 ;; to be spiteful and bitter about.
1689 ;; ======================================================================
1690 ;; gud jdb variables and functions
1692 (defcustom gud-jdb-command-name "jdb"
1693 "Command that executes the Java debugger."
1697 (defcustom gud-jdb-use-classpath t
1698 "If non-nil, search for Java source files in classpath directories.
1699 The list of directories to search is the value of `gud-jdb-classpath'.
1700 The file pathname is obtained by converting the fully qualified
1701 class information output by jdb to a relative pathname and appending
1702 it to `gud-jdb-classpath' element by element until a match is found.
1704 This method has a significant jdb startup time reduction advantage
1705 since it does not require the scanning of all `gud-jdb-directories'
1706 and parsing all Java files for class information.
1708 Set to nil to use `gud-jdb-directories' to scan java sources for
1709 class information on jdb startup (original method)."
1713 (defvar gud-jdb-classpath nil
1714 "Java/jdb classpath directories list.
1715 If `gud-jdb-use-classpath' is non-nil, gud-jdb derives the `gud-jdb-classpath'
1716 list automatically using the following methods in sequence
1717 \(with subsequent successful steps overriding the results of previous
1720 1) Read the CLASSPATH environment variable,
1721 2) Read any \"-classpath\" argument used to run jdb,
1722 or detected in jdb output (e.g. if jdb is run by a script
1723 that echoes the actual jdb command before starting jdb)
1724 3) Send a \"classpath\" command to jdb and scan jdb output for
1725 classpath information if jdb is invoked with an \"-attach\" (to
1726 an already running VM) argument (This case typically does not
1727 have a \"-classpath\" command line argument - that is provided
1728 to the VM when it is started).
1730 Note that method 3 cannot be used with oldjdb (or Java 1 jdb) since
1731 those debuggers do not support the classpath command. Use 1) or 2).")
1733 (defvar gud-jdb-sourcepath nil
1734 "Directory list provided by an (optional) \"-sourcepath\" option to jdb.
1735 This list is prepended to `gud-jdb-classpath' to form the complete
1736 list of directories searched for source files.")
1738 (defvar gud-marker-acc-max-length 4000
1739 "Maximum number of debugger output characters to keep.
1740 This variable limits the size of `gud-marker-acc' which holds
1741 the most recent debugger output history while searching for
1742 source file information.")
1744 (defvar gud-jdb-history nil
1745 "History of argument lists passed to jdb.")
1748 ;; List of Java source file directories.
1749 (defvar gud-jdb-directories (list ".")
1750 "*A list of directories that gud jdb should search for source code.
1751 The file names should be absolute, or relative to the current
1754 The set of .java files residing in the directories listed are
1755 syntactically analyzed to determine the classes they define and the
1756 packages in which these classes belong. In this way gud jdb maps the
1757 package-qualified class names output by the jdb debugger to the source
1758 file from which the class originated. This allows gud mode to keep
1759 the source code display in sync with the debugging session.")
1761 (defvar gud-jdb-source-files nil
1762 "List of the java source files for this debugging session.")
1764 ;; Association list of fully qualified class names (package + class name)
1765 ;; and their source files.
1766 (defvar gud-jdb-class-source-alist nil
1767 "Association list of fully qualified class names and source files.")
1769 ;; This is used to hold a source file during analysis.
1770 (defvar gud-jdb-analysis-buffer nil)
1772 (defvar gud-jdb-classpath-string nil
1773 "Holds temporary classpath values.")
1775 (defun gud-jdb-build-source-files-list (path extn)
1776 "Return a list of java source files (absolute paths).
1777 PATH gives the directories in which to search for files with
1778 extension EXTN. Normally EXTN is given as the regular expression
1780 (apply 'nconc (mapcar (lambda (d)
1781 (when (file-directory-p d)
1782 (directory-files d t extn nil)))
1785 ;; Move point past whitespace.
1786 (defun gud-jdb-skip-whitespace ()
1787 (skip-chars-forward " \n\r\t\014"))
1789 ;; Move point past a "// <eol>" type of comment.
1790 (defun gud-jdb-skip-single-line-comment ()
1793 ;; Move point past a "/* */" or "/** */" type of comment.
1794 (defun gud-jdb-skip-traditional-or-documentation-comment ()
1798 (if (eq (following-char) ?*)
1802 (if (eq (following-char) ?/)
1805 (throw 'break nil)))))
1808 ;; Move point past any number of consecutive whitespace chars and/or comments.
1809 (defun gud-jdb-skip-whitespace-and-comments ()
1810 (gud-jdb-skip-whitespace)
1815 (gud-jdb-skip-single-line-comment)
1816 (gud-jdb-skip-whitespace))
1817 ((looking-at "/\\*")
1818 (gud-jdb-skip-traditional-or-documentation-comment)
1819 (gud-jdb-skip-whitespace))
1820 (t (throw 'done nil))))))
1822 ;; Move point past things that are id-like. The intent is to skip regular
1823 ;; id's, such as class or interface names as well as package and interface
1825 (defun gud-jdb-skip-id-ish-thing ()
1826 (skip-chars-forward "^ /\n\r\t\014,;{"))
1828 ;; Move point past a string literal.
1829 (defun gud-jdb-skip-string-literal ()
1832 ((eq (following-char) ?\\)
1834 ((eq (following-char) ?\042))))
1838 ;; Move point past a character literal.
1839 (defun gud-jdb-skip-character-literal ()
1843 (if (eq (following-char) ?\\)
1845 (not (eq (following-char) ?\')))
1849 ;; Move point past the following block. There may be (legal) cruft before
1850 ;; the block's opening brace. There must be a block or it's the end of life
1851 ;; in petticoat junction.
1852 (defun gud-jdb-skip-block ()
1854 ;; Find the begining of the block.
1856 (not (eq (following-char) ?{))
1858 ;; Skip any constructs that can harbor literal block delimiter
1859 ;; characters and/or the delimiters for the constructs themselves.
1862 (gud-jdb-skip-single-line-comment))
1863 ((looking-at "/\\*")
1864 (gud-jdb-skip-traditional-or-documentation-comment))
1865 ((eq (following-char) ?\042)
1866 (gud-jdb-skip-string-literal))
1867 ((eq (following-char) ?\')
1868 (gud-jdb-skip-character-literal))
1869 (t (forward-char))))
1871 ;; Now at the begining of the block.
1874 ;; Skip over the body of the block as well as the final brace.
1875 (let ((open-level 1))
1876 (while (not (eq open-level 0))
1879 (gud-jdb-skip-single-line-comment))
1880 ((looking-at "/\\*")
1881 (gud-jdb-skip-traditional-or-documentation-comment))
1882 ((eq (following-char) ?\042)
1883 (gud-jdb-skip-string-literal))
1884 ((eq (following-char) ?\')
1885 (gud-jdb-skip-character-literal))
1886 ((eq (following-char) ?{)
1887 (setq open-level (+ open-level 1))
1889 ((eq (following-char) ?})
1890 (setq open-level (- open-level 1))
1892 (t (forward-char))))))
1894 ;; Find the package and class definitions in Java source file FILE. Assumes
1895 ;; that FILE contains a legal Java program. BUF is a scratch buffer used
1896 ;; to hold the source during analysis.
1897 (defun gud-jdb-analyze-source (buf file)
1900 (insert-file-contents file nil nil nil t)
1905 (gud-jdb-skip-whitespace)
1909 ;; Any number of semi's following a block is legal. Move point
1910 ;; past them. Note that comments and whitespace may be
1911 ;; interspersed as well.
1912 ((eq (following-char) ?\073)
1915 ;; Move point past a single line comment.
1917 (gud-jdb-skip-single-line-comment))
1919 ;; Move point past a traditional or documentation comment.
1920 ((looking-at "/\\*")
1921 (gud-jdb-skip-traditional-or-documentation-comment))
1923 ;; Move point past a package statement, but save the PackageName.
1924 ((looking-at "package")
1926 (gud-jdb-skip-whitespace-and-comments)
1928 (gud-jdb-skip-id-ish-thing)
1929 (setq p (concat (buffer-substring s (point)) "."))
1930 (gud-jdb-skip-whitespace-and-comments)
1931 (if (eq (following-char) ?\073)
1934 ;; Move point past an import statement.
1935 ((looking-at "import")
1937 (gud-jdb-skip-whitespace-and-comments)
1938 (gud-jdb-skip-id-ish-thing)
1939 (gud-jdb-skip-whitespace-and-comments)
1940 (if (eq (following-char) ?\073)
1943 ;; Move point past the various kinds of ClassModifiers.
1944 ((looking-at "public")
1946 ((looking-at "abstract")
1948 ((looking-at "final")
1951 ;; Move point past a ClassDeclaraction, but save the class
1953 ((looking-at "class")
1955 (gud-jdb-skip-whitespace-and-comments)
1957 (gud-jdb-skip-id-ish-thing)
1959 l (nconc l (list (concat p (buffer-substring s (point)))))))
1960 (gud-jdb-skip-block))
1962 ;; Move point past an interface statement.
1963 ((looking-at "interface")
1965 (gud-jdb-skip-block))
1967 ;; Anything else means the input is invalid.
1969 (message "Error parsing file %s." file)
1970 (throw 'abort nil))))))
1973 (defun gud-jdb-build-class-source-alist-for-file (file)
1977 (gud-jdb-analyze-source gud-jdb-analysis-buffer file)))
1979 ;; Return an alist of fully qualified classes and the source files
1980 ;; holding their definitions. SOURCES holds a list of all the source
1981 ;; files to examine.
1982 (defun gud-jdb-build-class-source-alist (sources)
1983 (setq gud-jdb-analysis-buffer (get-buffer-create " *gud-jdb-scratch*"))
1988 'gud-jdb-build-class-source-alist-for-file
1990 (kill-buffer gud-jdb-analysis-buffer)
1991 (setq gud-jdb-analysis-buffer nil)))
1993 ;; Change what was given in the minibuffer to something that can be used to
1994 ;; invoke the debugger.
1995 (defun gud-jdb-massage-args (file args)
1996 ;; The jdb executable must have whitespace between "-classpath" and
1997 ;; its value while gud-common-init expects all switch values to
1998 ;; follow the switch keyword without intervening whitespace. We
1999 ;; require that when the user enters the "-classpath" switch in the
2000 ;; EMACS minibuffer that they do so without the intervening
2001 ;; whitespace. This function adds it back (it's called after
2002 ;; gud-common-init). There are more switches like this (for
2003 ;; instance "-host" and "-password") but I don't care about them
2006 (let (massaged-args user-error)
2008 (while (and args (not user-error))
2010 ((setq user-error (string-match "-classpath$" (car args))))
2011 ((setq user-error (string-match "-sourcepath$" (car args))))
2012 ((string-match "-classpath\\(.+\\)" (car args))
2014 (append massaged-args
2016 (setq gud-jdb-classpath-string
2017 (match-string 1 (car args)))))))
2018 ((string-match "-sourcepath\\(.+\\)" (car args))
2020 (append massaged-args
2022 (setq gud-jdb-sourcepath
2023 (match-string 1 (car args)))))))
2024 (t (setq massaged-args (append massaged-args (list (car args))))))
2025 (setq args (cdr args)))
2027 ;; By this point the current directory is all screwed up. Maybe we
2028 ;; could fix things and re-invoke gud-common-init, but for now I think
2029 ;; issueing the error is good enough.
2032 (kill-buffer (current-buffer))
2033 (error "Error: Omit whitespace between '-classpath or -sourcepath' and its value")))
2036 ;; Search for an association with P, a fully qualified class name, in
2037 ;; gud-jdb-class-source-alist. The asssociation gives the fully
2038 ;; qualified file name of the source file which produced the class.
2039 (defun gud-jdb-find-source-file (p)
2040 (cdr (assoc p gud-jdb-class-source-alist)))
2042 ;; Note: Reset to this value every time a prompt is seen
2043 (defvar gud-jdb-lowest-stack-level 999)
2045 (defun gud-jdb-find-source-using-classpath (p)
2046 "Find source file corresponding to fully qualified class p.
2047 Convert p from jdb's output, converted to a pathname
2048 relative to a classpath directory."
2051 (;; Replace dots with slashes and append ".java" to generate file
2052 ;; name relative to classpath
2055 (mapconcat 'identity
2057 ;; Eliminate any subclass references in the class
2058 ;; name string. These start with a "$"
2060 (if (string-match "$.*" x)
2061 (replace-match "" t t x) p))
2065 (cplist (append gud-jdb-sourcepath gud-jdb-classpath))
2068 (not (setq found-file
2070 (concat (car cplist) "/" filename)))))
2071 (setq cplist (cdr cplist)))
2072 (if found-file (concat (car cplist) "/" filename)))))
2074 (defun gud-jdb-find-source (string)
2075 "Alias for function used to locate source files.
2076 Set to `gud-jdb-find-source-using-classpath' or `gud-jdb-find-source-file'
2077 during jdb initialization depending on the value of
2078 `gud-jdb-use-classpath'."
2081 (defun gud-jdb-parse-classpath-string (string)
2082 "Parse the classpath list and convert each item to an absolute pathname."
2083 (mapcar (lambda (s) (if (string-match "[/\\]$" s)
2084 (replace-match "" nil nil s) s))
2085 (mapcar 'file-truename
2088 (concat "[ \t\n\r,\"" path-separator "]+")))))
2090 ;; See comentary for other debugger's marker filters - there you will find
2091 ;; important notes about STRING.
2092 (defun gud-jdb-marker-filter (string)
2094 ;; Build up the accumulator.
2095 (setq gud-marker-acc
2097 (concat gud-marker-acc string)
2100 ;; Look for classpath information until gud-jdb-classpath-string is found
2101 ;; (interactive, multiple settings of classpath from jdb
2102 ;; not supported/followed)
2103 (if (and gud-jdb-use-classpath
2104 (not gud-jdb-classpath-string)
2105 (or (string-match "classpath:[ \t[]+\\([^]]+\\)" gud-marker-acc)
2106 (string-match "-classpath[ \t\"]+\\([^ \"]+\\)" gud-marker-acc)))
2107 (setq gud-jdb-classpath
2108 (gud-jdb-parse-classpath-string
2109 (setq gud-jdb-classpath-string
2110 (match-string 1 gud-marker-acc)))))
2112 ;; We process STRING from left to right. Each time through the
2113 ;; following loop we process at most one marker. After we've found a
2114 ;; marker, delete gud-marker-acc up to and including the match
2116 ;; Process each complete marker in the input.
2119 ;; Do we see a marker?
2121 ;; jdb puts out a string of the following form when it
2122 ;; hits a breakpoint:
2124 ;; <fully-qualified-class><method> (<class>:<line-number>)
2126 ;; <fully-qualified-class>'s are composed of Java ID's
2127 ;; separated by periods. <method> and <class> are
2128 ;; also Java ID's. <method> begins with a period and
2129 ;; may contain less-than and greater-than (constructors,
2130 ;; for instance, are called <init> in the symbol table.)
2131 ;; Java ID's begin with a letter followed by letters
2132 ;; and/or digits. The set of letters includes underscore
2135 ;; The first group matches <fully-qualified-class>,
2136 ;; the second group matches <class> and the third group
2137 ;; matches <line-number>. We don't care about using
2138 ;; <method> so we don't "group" it.
2140 ;; FIXME: Java ID's are UNICODE strings, this matches ASCII
2143 ;; The ".," in the last square-bracket are necessary because
2144 ;; of Sun's total disrespect for backwards compatibility in
2145 ;; reported line numbers from jdb - starting in 1.4.0 they
2146 ;; print line numbers using LOCALE, inserting a comma or a
2147 ;; period at the thousands positions (how ingenious!).
2149 "\\(\[[0-9]+\] \\)*\\([a-zA-Z0-9.$_]+\\)\\.[a-zA-Z0-9$_<>(),]+ \
2150 \\(([a-zA-Z0-9.$_]+:\\|line=\\)\\([0-9.,]+\\)"
2153 ;; A good marker is one that:
2154 ;; 1) does not have a "[n] " prefix (not part of a stack backtrace)
2155 ;; 2) does have an "[n] " prefix and n is the lowest prefix seen
2156 ;; since the last prompt
2157 ;; Figure out the line on which to position the debugging arrow.
2158 ;; Return the info as a cons of the form:
2160 ;; (<file-name> . <line-number>) .
2161 (if (if (match-beginning 1)
2163 (setq n (string-to-number (substring
2165 (1+ (match-beginning 1))
2166 (- (match-end 1) 2))))
2167 (if (< n gud-jdb-lowest-stack-level)
2168 (progn (setq gud-jdb-lowest-stack-level n) t)))
2170 (if (setq file-found
2171 (gud-jdb-find-source (match-string 2 gud-marker-acc)))
2172 (setq gud-last-frame
2176 ((numstr (match-string 4 gud-marker-acc)))
2177 (if (string-match "[.,]" numstr)
2178 (replace-match "" nil nil numstr)
2180 (message "Could not find source file.")))
2182 ;; Set the accumulator to the remaining text.
2183 (setq gud-marker-acc (substring gud-marker-acc (match-end 0))))
2185 (if (string-match comint-prompt-regexp gud-marker-acc)
2186 (setq gud-jdb-lowest-stack-level 999)))
2188 ;; Do not allow gud-marker-acc to grow without bound. If the source
2189 ;; file information is not within the last 3/4
2190 ;; gud-marker-acc-max-length characters, well,...
2191 (if (> (length gud-marker-acc) gud-marker-acc-max-length)
2192 (setq gud-marker-acc
2193 (substring gud-marker-acc
2194 (- (/ (* gud-marker-acc-max-length 3) 4)))))
2196 ;; We don't filter any debugger output so just return what we were given.
2199 (defvar gud-jdb-command-name "jdb" "Command that executes the Java debugger.")
2202 (defun jdb (command-line)
2203 "Run jdb with command line COMMAND-LINE in a buffer.
2204 The buffer is named \"*gud*\" if no initial class is given or
2205 \"*gud-<initial-class-basename>*\" if there is. If the \"-classpath\"
2206 switch is given, omit all whitespace between it and its value.
2208 See `gud-jdb-use-classpath' and `gud-jdb-classpath' documentation for
2209 information on how jdb accesses source files. Alternatively (if
2210 `gud-jdb-use-classpath' is nil), see `gud-jdb-directories' for the
2211 original source file access method.
2213 For general information about commands available to control jdb from
2214 gud, see `gud-mode'."
2216 (list (gud-query-cmdline 'jdb)))
2217 (setq gud-jdb-classpath nil)
2218 (setq gud-jdb-sourcepath nil)
2220 ;; Set gud-jdb-classpath from the CLASSPATH environment variable,
2221 ;; if CLASSPATH is set.
2222 (setq gud-jdb-classpath-string (getenv "CLASSPATH"))
2223 (if gud-jdb-classpath-string
2224 (setq gud-jdb-classpath
2225 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2226 (setq gud-jdb-classpath-string nil) ; prepare for next
2228 (gud-common-init command-line 'gud-jdb-massage-args
2229 'gud-jdb-marker-filter)
2230 (set (make-local-variable 'gud-minor-mode) 'jdb)
2232 ;; If a -classpath option was provided, set gud-jdb-classpath
2233 (if gud-jdb-classpath-string
2234 (setq gud-jdb-classpath
2235 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2236 (setq gud-jdb-classpath-string nil) ; prepare for next
2237 ;; If a -sourcepath option was provided, parse it
2238 (if gud-jdb-sourcepath
2239 (setq gud-jdb-sourcepath
2240 (gud-jdb-parse-classpath-string gud-jdb-sourcepath)))
2242 (gud-def gud-break "stop at %c:%l" "\C-b" "Set breakpoint at current line.")
2243 (gud-def gud-remove "clear %c:%l" "\C-d" "Remove breakpoint at current line")
2244 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2245 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2246 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
2247 (gud-def gud-finish "step up" "\C-f" "Continue until current method returns.")
2248 (gud-def gud-up "up\C-Mwhere" "<" "Up one stack frame.")
2249 (gud-def gud-down "down\C-Mwhere" ">" "Up one stack frame.")
2250 (gud-def gud-run "run" nil "Run the program.") ;if VM start using jdb
2252 (setq comint-prompt-regexp "^> \\|^[^ ]+\\[[0-9]+\\] ")
2253 (setq paragraph-start comint-prompt-regexp)
2254 (run-hooks 'jdb-mode-hook)
2256 (if gud-jdb-use-classpath
2257 ;; Get the classpath information from the debugger
2259 (if (string-match "-attach" command-line)
2260 (gud-call "classpath"))
2261 (fset 'gud-jdb-find-source
2262 'gud-jdb-find-source-using-classpath))
2264 ;; Else create and bind the class/source association list as well
2265 ;; as the source file list.
2266 (setq gud-jdb-class-source-alist
2267 (gud-jdb-build-class-source-alist
2268 (setq gud-jdb-source-files
2269 (gud-jdb-build-source-files-list gud-jdb-directories
2271 (fset 'gud-jdb-find-source 'gud-jdb-find-source-file)))
2274 ;; ======================================================================
2276 ;; BASHDB support. See http://bashdb.sourceforge.net
2278 ;; AUTHOR: Rocky Bernstein <rocky@panix.com>
2280 ;; CREATED: Sun Nov 10 10:46:38 2002 Rocky Bernstein.
2282 ;; INVOCATION NOTES:
2284 ;; You invoke bashdb-mode with:
2286 ;; M-x bashdb <enter>
2288 ;; It responds with:
2290 ;; Run bashdb (like this): bash
2293 ;; History of argument lists passed to bashdb.
2294 (defvar gud-bashdb-history nil)
2296 ;; Convert a command line as would be typed normally to run a script
2297 ;; into one that invokes an Emacs-enabled debugging session.
2298 ;; "--debugger" in inserted as the first switch.
2300 ;; There's no guarantee that Emacs will hand the filter the entire
2301 ;; marker at once; it could be broken up across several strings. We
2302 ;; might even receive a big chunk with several markers in it. If we
2303 ;; receive a chunk of text which looks like it might contain the
2304 ;; beginning of a marker, we save it here between calls to the
2306 (defun gud-bashdb-marker-filter (string)
2307 (setq gud-marker-acc (concat gud-marker-acc string))
2310 ;; Process all the complete markers in this chunk.
2311 ;; Format of line looks like this:
2312 ;; (/etc/init.d/ntp.init:16):
2313 ;; but we also allow DOS drive letters
2314 ;; (d:/etc/init.d/ntp.init:16):
2315 (while (string-match "\\(^\\|\n\\)(\\(\\([a-zA-Z]:\\)?[^:\n]*\\):\\([0-9]*\\)):.*\n"
2319 ;; Extract the frame position from the marker.
2321 (cons (match-string 2 gud-marker-acc)
2322 (string-to-number (match-string 4 gud-marker-acc)))
2324 ;; Append any text before the marker to the output we're going
2325 ;; to return - we don't include the marker in this text.
2326 output (concat output
2327 (substring gud-marker-acc 0 (match-beginning 0)))
2329 ;; Set the accumulator to the remaining text.
2330 gud-marker-acc (substring gud-marker-acc (match-end 0))))
2332 ;; Does the remaining text look like it might end with the
2333 ;; beginning of another marker? If it does, then keep it in
2334 ;; gud-marker-acc until we receive the rest of it. Since we
2335 ;; know the full marker regexp above failed, it's pretty simple to
2336 ;; test for marker starts.
2337 (if (string-match "\032.*\\'" gud-marker-acc)
2339 ;; Everything before the potential marker start can be output.
2340 (setq output (concat output (substring gud-marker-acc
2341 0 (match-beginning 0))))
2343 ;; Everything after, we save, to combine with later input.
2344 (setq gud-marker-acc
2345 (substring gud-marker-acc (match-beginning 0))))
2347 (setq output (concat output gud-marker-acc)
2352 (defcustom gud-bashdb-command-name "bash --debugger"
2353 "File name for executing bash debugger."
2358 (defun bashdb (command-line)
2359 "Run bashdb on program FILE in buffer *gud-FILE*.
2360 The directory containing FILE becomes the initial working directory
2361 and source-file directory for your debugger."
2363 (list (read-from-minibuffer "Run bashdb (like this): "
2364 (if (consp gud-bashdb-history)
2365 (car gud-bashdb-history)
2366 (concat gud-bashdb-command-name
2368 gud-minibuffer-local-map nil
2369 '(gud-bashdb-history . 1))))
2371 (gud-common-init command-line nil 'gud-bashdb-marker-filter)
2373 (set (make-local-variable 'gud-minor-mode) 'bashdb)
2375 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
2376 (gud-def gud-tbreak "tbreak %l" "\C-t" "Set temporary breakpoint at current line.")
2377 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
2378 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2379 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2380 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
2381 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
2382 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
2383 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
2384 (gud-def gud-print "x %e" "\C-p" "Evaluate BASH expression at point.")
2387 (gud-def gud-statement "eval %e" "\C-e" "Execute BASH statement at point.")
2389 (setq comint-prompt-regexp "^bashdb<+(*[0-9]+)*>+ ")
2390 (setq paragraph-start comint-prompt-regexp)
2391 (run-hooks 'bashdb-mode-hook)
2395 ;; End of debugger-specific information
2399 ;; When we send a command to the debugger via gud-call, it's annoying
2400 ;; to see the command and the new prompt inserted into the debugger's
2401 ;; buffer; we have other ways of knowing the command has completed.
2403 ;; If the buffer looks like this:
2404 ;; --------------------
2405 ;; (gdb) set args foo bar
2407 ;; --------------------
2408 ;; (the -!- marks the location of point), and we type `C-x SPC' in a
2409 ;; source file to set a breakpoint, we want the buffer to end up like
2411 ;; --------------------
2412 ;; (gdb) set args foo bar
2413 ;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
2415 ;; --------------------
2416 ;; Essentially, the old prompt is deleted, and the command's output
2417 ;; and the new prompt take its place.
2419 ;; Not echoing the command is easy enough; you send it directly using
2420 ;; process-send-string, and it never enters the buffer. However,
2421 ;; getting rid of the old prompt is trickier; you don't want to do it
2422 ;; when you send the command, since that will result in an annoying
2423 ;; flicker as the prompt is deleted, redisplay occurs while Emacs
2424 ;; waits for a response from the debugger, and the new prompt is
2425 ;; inserted. Instead, we'll wait until we actually get some output
2426 ;; from the subprocess before we delete the prompt. If the command
2427 ;; produced no output other than a new prompt, that prompt will most
2428 ;; likely be in the first chunk of output received, so we will delete
2429 ;; the prompt and then replace it with an identical one. If the
2430 ;; command produces output, the prompt is moving anyway, so the
2431 ;; flicker won't be annoying.
2433 ;; So - when we want to delete the prompt upon receipt of the next
2434 ;; chunk of debugger output, we position gud-delete-prompt-marker at
2435 ;; the start of the prompt; the process filter will notice this, and
2436 ;; delete all text between it and the process output marker. If
2437 ;; gud-delete-prompt-marker points nowhere, we leave the current
2439 (defvar gud-delete-prompt-marker nil)
2442 (put 'gud-mode 'mode-class 'special)
2444 (define-derived-mode gud-mode comint-mode "Debugger"
2445 "Major mode for interacting with an inferior debugger process.
2447 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
2448 M-x perldb, M-x xdb, or M-x jdb. Each entry point finishes by executing a
2449 hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook',
2450 `perldb-mode-hook', `xdb-mode-hook', or `jdb-mode-hook' respectively.
2452 After startup, the following commands are available in both the GUD
2453 interaction buffer and any source buffer GUD visits due to a breakpoint stop
2456 \\[gud-break] sets a breakpoint at the current file and line. In the
2457 GUD buffer, the current file and line are those of the last breakpoint or
2458 step. In a source buffer, they are the buffer's file and current line.
2460 \\[gud-remove] removes breakpoints on the current file and line.
2462 \\[gud-refresh] displays in the source window the last line referred to
2465 \\[gud-step], \\[gud-next], and \\[gud-stepi] do a step-one-line,
2466 step-one-line (not entering function calls), and step-one-instruction
2467 and then update the source window with the current file and position.
2468 \\[gud-cont] continues execution.
2470 \\[gud-print] tries to find the largest C lvalue or function-call expression
2471 around point, and sends it to the debugger for value display.
2473 The above commands are common to all supported debuggers except xdb which
2474 does not support stepping instructions.
2476 Under gdb, sdb and xdb, \\[gud-tbreak] behaves exactly like \\[gud-break],
2477 except that the breakpoint is temporary; that is, it is removed when
2478 execution stops on it.
2480 Under gdb, dbx, and xdb, \\[gud-up] pops up through an enclosing stack
2481 frame. \\[gud-down] drops back down through one.
2483 If you are using gdb or xdb, \\[gud-finish] runs execution to the return from
2484 the current function and stops.
2486 All the keystrokes above are accessible in the GUD buffer
2487 with the prefix C-c, and in all buffers through the prefix C-x C-a.
2489 All pre-defined functions for which the concept make sense repeat
2490 themselves the appropriate number of times if you give a prefix
2493 You may use the `gud-def' macro in the initialization hook to define other
2496 Other commands for interacting with the debugger process are inherited from
2497 comint mode, which see."
2498 (setq mode-line-process '(":%s"))
2499 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
2500 (set (make-local-variable 'gud-last-frame) nil)
2501 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
2502 (make-local-variable 'comint-prompt-regexp)
2503 ;; Don't put repeated commands in command history many times.
2504 (set (make-local-variable 'comint-input-ignoredups) t)
2505 (make-local-variable 'paragraph-start)
2506 (set (make-local-variable 'gud-delete-prompt-marker) (make-marker))
2507 (add-hook 'kill-buffer-hook 'gud-kill-buffer-hook nil t))
2509 ;; Cause our buffers to be displayed, by default,
2510 ;; in the selected window.
2511 ;;;###autoload (add-hook 'same-window-regexps "\\*gud-.*\\*\\(\\|<[0-9]+>\\)")
2513 (defcustom gud-chdir-before-run t
2514 "Non-nil if GUD should `cd' to the debugged executable."
2518 (defvar gud-target-name "--unknown--"
2519 "The apparent name of the program being debugged in a gud buffer.")
2521 ;; Perform initializations common to all debuggers.
2522 ;; The first arg is the specified command line,
2523 ;; which starts with the program to debug.
2524 ;; The other three args specify the values to use
2525 ;; for local variables in the debugger buffer.
2526 (defun gud-common-init (command-line massage-args marker-filter
2527 &optional find-file)
2528 (let* ((words (split-string command-line))
2529 (program (car words))
2530 (dir default-directory)
2531 ;; Extract the file name from WORDS
2532 ;; and put t in its place.
2533 ;; Later on we will put the modified file name arg back there.
2534 (file-word (let ((w (cdr words)))
2535 (while (and w (= ?- (aref (car w) 0)))
2541 (and file-word (substitute-in-file-name file-word)))
2543 ;; If a directory was specified, expand the file name.
2544 ;; Otherwise, don't expand it, so GDB can use the PATH.
2545 ;; A file name without directory is literally valid
2546 ;; only if the file exists in ., and in that case,
2547 ;; omitting the expansion here has no visible effect.
2548 (file (and file-word
2549 (if (file-name-directory file-subst)
2550 (expand-file-name file-subst)
2552 (filepart (and file-word (concat "-" (file-name-nondirectory file))))
2553 (existing-buffer (get-buffer (concat "*gud" filepart "*"))))
2554 (pop-to-buffer (concat "*gud" filepart "*"))
2555 (when (and existing-buffer (get-buffer-process existing-buffer))
2556 (error "This program is already running under gdb"))
2557 ;; Set the dir, in case the buffer already existed with a different dir.
2558 (setq default-directory dir)
2559 ;; Set default-directory to the file's directory.
2561 gud-chdir-before-run
2562 ;; Don't set default-directory if no directory was specified.
2563 ;; In that case, either the file is found in the current directory,
2564 ;; in which case this setq is a no-op,
2565 ;; or it is found by searching PATH,
2566 ;; in which case we don't know what directory it was found in.
2567 (file-name-directory file)
2568 (setq default-directory (file-name-directory file)))
2569 (or (bolp) (newline))
2570 (insert "Current directory is " default-directory "\n")
2571 ;; Put the substituted and expanded file name back in its place.
2573 (while (and w (not (eq (car w) t)))
2577 (apply 'make-comint (concat "gud" filepart) program nil
2578 (if massage-args (funcall massage-args file args) args))
2579 ;; Since comint clobbered the mode, we don't set it until now.
2581 (set (make-local-variable 'gud-target-name)
2582 (and file-word (file-name-nondirectory file))))
2583 (set (make-local-variable 'gud-marker-filter) marker-filter)
2584 (if find-file (set (make-local-variable 'gud-find-file) find-file))
2585 (setq gud-running nil)
2586 (setq gud-last-last-frame nil)
2588 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
2589 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
2592 (defun gud-set-buffer ()
2593 (when (eq major-mode 'gud-mode)
2594 (setq gud-comint-buffer (current-buffer))))
2596 (defvar gud-filter-defer-flag nil
2597 "Non-nil means don't process anything from the debugger right now.
2598 It is saved for when this flag is not set.")
2600 ;; These functions are responsible for inserting output from your debugger
2601 ;; into the buffer. The hard work is done by the method that is
2602 ;; the value of gud-marker-filter.
2604 (defun gud-filter (proc string)
2605 ;; Here's where the actual buffer insertion is done
2606 (let (output process-window)
2607 (if (buffer-name (process-buffer proc))
2608 (if gud-filter-defer-flag
2609 ;; If we can't process any text now,
2610 ;; save it for later.
2611 (setq gud-filter-pending-text
2612 (concat (or gud-filter-pending-text "") string))
2614 ;; If we have to ask a question during the processing,
2615 ;; defer any additional text that comes from the debugger
2616 ;; during that time.
2617 (let ((gud-filter-defer-flag t))
2618 ;; Process now any text we previously saved up.
2619 (if gud-filter-pending-text
2620 (setq string (concat gud-filter-pending-text string)
2621 gud-filter-pending-text nil))
2623 (with-current-buffer (process-buffer proc)
2624 ;; If we have been so requested, delete the debugger prompt.
2627 (if (marker-buffer gud-delete-prompt-marker)
2628 (let ((inhibit-read-only t))
2629 (delete-region (process-mark proc)
2630 gud-delete-prompt-marker)
2631 (comint-update-fence)
2632 (set-marker gud-delete-prompt-marker nil)))
2633 ;; Save the process output, checking for source file markers.
2634 (setq output (gud-marker-filter string))
2635 ;; Check for a filename-and-line number.
2636 ;; Don't display the specified file
2637 ;; unless (1) point is at or after the position where output appears
2638 ;; and (2) this buffer is on the screen.
2639 (setq process-window
2641 (>= (point) (process-mark proc))
2642 (get-buffer-window (current-buffer)))))
2644 ;; Let the comint filter do the actual insertion.
2645 ;; That lets us inherit various comint features.
2646 (comint-output-filter proc output))
2648 ;; Put the arrow on the source line.
2649 ;; This must be outside of the save-excursion
2650 ;; in case the source file is our current buffer.
2652 (with-selected-window process-window
2653 (gud-display-frame))
2654 ;; We have to be in the proper buffer, (process-buffer proc),
2655 ;; but not in a save-excursion, because that would restore point.
2656 (with-current-buffer (process-buffer proc)
2657 (gud-display-frame))))
2659 ;; If we deferred text that arrived during this processing,
2661 (if gud-filter-pending-text
2662 (gud-filter proc ""))))))
2664 (defvar gud-minor-mode-type nil)
2665 (defvar gud-overlay-arrow-position nil)
2666 (add-to-list 'overlay-arrow-variable-list 'gud-overlay-arrow-position)
2668 (defun gud-sentinel (proc msg)
2669 (cond ((null (buffer-name (process-buffer proc)))
2671 ;; Stop displaying an arrow in a source file.
2672 (setq gud-overlay-arrow-position nil)
2673 (set-process-buffer proc nil)
2674 (if (and (boundp 'speedbar-frame)
2675 (string-equal speedbar-initial-expansion-list-name "GUD"))
2676 (speedbar-change-initial-expansion-list
2677 speedbar-previously-used-expansion-list-name))
2678 (if (memq gud-minor-mode-type '(gdbmi gdba))
2681 ((memq (process-status proc) '(signal exit))
2682 ;; Stop displaying an arrow in a source file.
2683 (setq gud-overlay-arrow-position nil)
2684 (with-current-buffer gud-comint-buffer
2685 (if (memq gud-minor-mode-type '(gdbmi gdba))
2688 (let* ((obuf (current-buffer)))
2689 ;; save-excursion isn't the right thing if
2690 ;; process-buffer is current-buffer
2693 ;; Write something in *compilation* and hack its mode line,
2694 (set-buffer (process-buffer proc))
2695 ;; Fix the mode line.
2696 (setq mode-line-process
2698 (symbol-name (process-status proc))))
2699 (force-mode-line-update)
2701 (insert ?\n mode-name " " msg)
2703 (goto-char (point-max))
2704 (insert ?\n mode-name " " msg)))
2705 ;; If buffer and mode line will show that the process
2706 ;; is dead, we can delete it now. Otherwise it
2707 ;; will stay around until M-x list-processes.
2708 (delete-process proc))
2709 ;; Restore old buffer, but don't restore old point
2710 ;; if obuf is the gud buffer.
2711 (set-buffer obuf))))))
2713 (defun gud-kill-buffer-hook ()
2714 (setq gud-minor-mode-type gud-minor-mode)
2716 (kill-process (get-buffer-process (current-buffer)))
2720 (dolist (buffer (buffer-list))
2721 (unless (eq buffer gud-comint-buffer)
2722 (with-current-buffer buffer
2723 (when gud-minor-mode
2724 (setq gud-minor-mode nil)
2725 (kill-local-variable 'tool-bar-map))))))
2727 (defun gud-display-frame ()
2728 "Find and obey the last filename-and-line marker from the debugger.
2729 Obeying it means displaying in another window the specified file and line."
2731 (when gud-last-frame
2733 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
2734 (setq gud-last-last-frame gud-last-frame
2735 gud-last-frame nil)))
2737 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
2738 ;; and that its line LINE is visible.
2739 ;; Put the overlay-arrow on the line LINE in that buffer.
2740 ;; Most of the trickiness in here comes from wanting to preserve the current
2741 ;; region-restriction if that's possible. We use an explicit display-buffer
2742 ;; to get around the fact that this is called inside a save-excursion.
2744 (defun gud-display-line (true-file line)
2745 (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
2747 (with-current-buffer gud-comint-buffer
2748 (gud-find-file true-file)))
2749 (window (and buffer (or (get-buffer-window buffer)
2750 (display-buffer buffer))))
2752 (message "%s %s" (current-buffer) buffer)
2755 (with-current-buffer buffer
2756 (unless (or (verify-visited-file-modtime buffer) gud-keep-buffer)
2758 (format "File %s changed on disk. Reread from disk? "
2761 (setq gud-keep-buffer t)))
2766 (or gud-overlay-arrow-position
2767 (setq gud-overlay-arrow-position (make-marker)))
2768 (set-marker gud-overlay-arrow-position (point) (current-buffer))
2769 ;; If they turned on hl-line, move the hl-line highlight to
2770 ;; the arrow's line.
2771 (when (featurep 'hl-line)
2773 (global-hl-line-mode
2774 (global-hl-line-highlight))
2775 ((and hl-line-mode hl-line-sticky-flag)
2776 (hl-line-highlight)))))
2777 (cond ((or (< pos (point-min)) (> pos (point-max)))
2780 (if window (set-window-point window gud-overlay-arrow-position))))))
2782 ;; The gud-call function must do the right thing whether its invoking
2783 ;; keystroke is from the GUD buffer itself (via major-mode binding)
2784 ;; or a C buffer. In the former case, we want to supply data from
2785 ;; gud-last-frame. Here's how we do it:
2787 (defun gud-format-command (str arg)
2788 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
2789 (frame (or gud-last-frame gud-last-last-frame))
2791 (while (and str (string-match "\\([^%]*\\)%\\([adeflpc]\\)" str))
2792 (let ((key (string-to-char (match-string 2 str)))
2796 (setq subst (file-name-nondirectory (if insource
2800 (setq subst (file-name-sans-extension
2801 (file-name-nondirectory (if insource
2805 (setq subst (file-name-directory (if insource
2809 (setq subst (int-to-string
2813 (+ (count-lines (point-min) (point))
2817 (setq subst (gud-find-expr)))
2819 (setq subst (gud-read-address)))
2829 (+ (count-lines (point-min) (point))
2833 (setq subst (if arg (int-to-string arg)))))
2834 (setq result (concat result (match-string 1 str) subst)))
2835 (setq str (substring str (match-end 2))))
2836 ;; There might be text left in STR when the loop ends.
2837 (concat result str)))
2839 (defun gud-read-address ()
2840 "Return a string containing the core-address found in the buffer at point."
2843 (let ((pt (point)) found begin)
2844 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
2846 (found (forward-char 2)
2847 (buffer-substring found
2848 (progn (re-search-forward "[^0-9a-f]")
2851 (t (setq begin (progn (re-search-backward "[^0-9]")
2855 (re-search-forward "[^0-9]")
2857 (buffer-substring begin (point))))))))
2859 (defun gud-call (fmt &optional arg)
2860 (let ((msg (gud-format-command fmt arg)))
2861 (message "Command: %s" msg)
2863 (gud-basic-call msg)))
2865 (defun gud-basic-call (command)
2866 "Invoke the debugger COMMAND displaying source in other window."
2869 (let ((proc (get-buffer-process gud-comint-buffer)))
2870 (or proc (error "Current buffer has no process"))
2871 ;; Arrange for the current prompt to get deleted.
2873 (set-buffer gud-comint-buffer)
2876 (goto-char (process-mark proc))
2878 (if (looking-at comint-prompt-regexp)
2879 (set-marker gud-delete-prompt-marker (point)))
2880 (if (memq gud-minor-mode '(gdbmi gdba))
2881 (apply comint-input-sender (list proc command))
2882 (process-send-string proc (concat command "\n")))))))
2884 (defun gud-refresh (&optional arg)
2885 "Fix up a possibly garbled display, and redraw the arrow."
2887 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
2891 ;; Code for parsing expressions out of C or Fortran code. The single entry
2892 ;; point is gud-find-expr, which tries to return an lvalue expression from
2895 (defvar gud-find-expr-function 'gud-find-c-expr)
2897 (defun gud-find-expr (&rest args)
2898 (apply gud-find-expr-function args))
2900 ;; The next eight functions are hacked from gdbsrc.el by
2901 ;; Debby Ayers <ayers@asc.slb.com>,
2902 ;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
2904 (defun gud-find-c-expr ()
2905 "Returns the expr that surrounds point."
2909 (expr (gud-innermost-expr))
2910 (test-expr (gud-prev-expr)))
2911 (while (and test-expr (gud-expr-compound test-expr expr))
2912 (let ((prev-expr expr))
2913 (setq expr (cons (car test-expr) (cdr expr)))
2914 (goto-char (car expr))
2915 (setq test-expr (gud-prev-expr))
2916 ;; If we just pasted on the condition of an if or while,
2917 ;; throw it away again.
2918 (if (member (buffer-substring (car test-expr) (cdr test-expr))
2919 '("if" "while" "for"))
2923 (setq test-expr (gud-next-expr))
2924 (while (gud-expr-compound expr test-expr)
2925 (setq expr (cons (car expr) (cdr test-expr)))
2926 (setq test-expr (gud-next-expr)))
2927 (buffer-substring (car expr) (cdr expr)))))
2929 (defun gud-innermost-expr ()
2930 "Returns the smallest expr that point is in; move point to beginning of it.
2931 The expr is represented as a cons cell, where the car specifies the point in
2932 the current buffer that marks the beginning of the expr and the cdr specifies
2933 the character after the end of the expr."
2934 (let ((p (point)) begin end)
2936 (setq begin (point))
2949 (defun gud-backward-sexp ()
2950 "Version of `backward-sexp' that catches errors."
2955 (defun gud-forward-sexp ()
2956 "Version of `forward-sexp' that catches errors."
2961 (defun gud-prev-expr ()
2962 "Returns the previous expr, point is set to beginning of that expr.
2963 The expr is represented as a cons cell, where the car specifies the point in
2964 the current buffer that marks the beginning of the expr and the cdr specifies
2965 the character after the end of the expr"
2966 (let ((begin) (end))
2968 (setq begin (point))
2974 (defun gud-next-expr ()
2975 "Returns the following expr, point is set to beginning of that expr.
2976 The expr is represented as a cons cell, where the car specifies the point in
2977 the current buffer that marks the beginning of the expr and the cdr specifies
2978 the character after the end of the expr."
2979 (let ((begin) (end))
2984 (setq begin (point))
2987 (defun gud-expr-compound-sep (span-start span-end)
2988 "Scan from SPAN-START to SPAN-END for punctuation characters.
2989 If `->' is found, return `?.'. If `.' is found, return `?.'.
2990 If any other punctuation is found, return `??'.
2991 If no punctuation is found, return `? '."
2994 (while (< span-start span-end)
2995 (setq syntax (char-syntax (char-after span-start)))
2998 ((= syntax ?.) (setq syntax (char-after span-start))
3000 ((= syntax ?.) (setq result ?.))
3001 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
3003 (setq span-start (+ span-start 1)))
3004 (t (setq span-start span-end)
3005 (setq result ??)))))
3006 (setq span-start (+ span-start 1)))
3009 (defun gud-expr-compound (first second)
3010 "Non-nil if concatenating FIRST and SECOND makes a single C expression.
3011 The two exprs are represented as a cons cells, where the car
3012 specifies the point in the current buffer that marks the beginning of the
3013 expr and the cdr specifies the character after the end of the expr.
3014 Link exprs of the form:
3021 (let ((span-start (cdr first))
3022 (span-end (car second))
3024 (setq syntax (gud-expr-compound-sep span-start span-end))
3026 ((= (car first) (car second)) nil)
3027 ((= (cdr first) (cdr second)) nil)
3030 (setq span-start (char-after (- span-start 1)))
3031 (setq span-end (char-after span-end))
3033 ((= span-start ?)) t)
3034 ((= span-start ?]) t)
3040 (defun gud-find-class (f line)
3041 "Find fully qualified class in file F at line LINE.
3042 This function uses the `gud-jdb-classpath' (and optional
3043 `gud-jdb-sourcepath') list(s) to derive a file
3044 pathname relative to its classpath directory. The values in
3045 `gud-jdb-classpath' are assumed to have been converted to absolute
3046 pathname standards using file-truename.
3047 If F is visited by a buffer and its mode is CC-mode(Java),
3048 syntactic information of LINE is used to find the enclosing (nested)
3049 class string which is appended to the top level
3050 class of the file (using s to separate nested class ids)."
3051 ;; Convert f to a standard representation and remove suffix
3052 (if (and gud-jdb-use-classpath (or gud-jdb-classpath gud-jdb-sourcepath))
3054 (let ((cplist (append gud-jdb-sourcepath gud-jdb-classpath))
3055 (fbuffer (get-file-buffer f))
3056 syntax-symbol syntax-point class-found)
3057 (setq f (file-name-sans-extension (file-truename f)))
3058 ;; Syntax-symbol returns the symbol of the *first* element
3059 ;; in the syntactical analysis result list, syntax-point
3060 ;; returns the buffer position of same
3061 (fset 'syntax-symbol (lambda (x) (c-langelem-sym (car x))))
3062 (fset 'syntax-point (lambda (x) (c-langelem-pos (car x))))
3063 ;; Search through classpath list for an entry that is
3065 (while (and cplist (not class-found))
3066 (if (string-match (car cplist) f)
3068 (mapconcat 'identity
3070 (substring f (+ (match-end 0) 1))
3072 (setq cplist (cdr cplist)))
3073 ;; if f is visited by a java(cc-mode) buffer, walk up the
3074 ;; syntactic information chain and collect any 'inclass
3075 ;; symbols until 'topmost-intro is reached to find out if
3076 ;; point is within a nested class
3077 (if (and fbuffer (equal (symbol-file 'java-mode) "cc-mode"))
3079 (set-buffer fbuffer)
3080 (let ((nclass) (syntax))
3081 ;; While the c-syntactic information does not start
3082 ;; with the 'topmost-intro symbol, there may be
3083 ;; nested classes...
3084 (while (not (eq 'topmost-intro
3085 (syntax-symbol (c-guess-basic-syntax))))
3086 ;; Check if the current position c-syntactic
3087 ;; analysis has 'inclass
3088 (setq syntax (c-guess-basic-syntax))
3090 (and (not (eq 'inclass (syntax-symbol syntax)))
3092 (setq syntax (cdr syntax)))
3093 (if (eq 'inclass (syntax-symbol syntax))
3095 (goto-char (syntax-point syntax))
3096 ;; Now we're at the beginning of a class
3097 ;; definition. Find class name
3099 "[A-Za-z0-9 \t\n]*?class[ \t\n]+\\([^ \t\n]+\\)")
3101 (append (list (match-string-no-properties 1))
3103 (setq syntax (c-guess-basic-syntax))
3104 (while (and (not (syntax-point syntax)) (cdr syntax))
3105 (setq syntax (cdr syntax)))
3106 (goto-char (syntax-point syntax))
3108 (string-match (concat (car nclass) "$") class-found)
3110 (replace-match (mapconcat 'identity nclass "$")
3111 t t class-found)))))
3112 (if (not class-found)
3113 (message "gud-find-class: class for file %s not found!" f))
3115 ;; Not using classpath - try class/source association list
3116 (let ((class-found (rassoc f gud-jdb-class-source-alist)))
3119 (message "gud-find-class: class for file %s not found in gud-jdb-class-source-alist!" f)
3123 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3124 ;;; GDB script mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3125 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3127 (defvar gdb-script-mode-syntax-table
3128 (let ((st (make-syntax-table)))
3129 (modify-syntax-entry ?' "\"" st)
3130 (modify-syntax-entry ?# "<" st)
3131 (modify-syntax-entry ?\n ">" st)
3134 (defvar gdb-script-font-lock-keywords
3135 '(("^define\\s-+\\(\\(\\w\\|\\s_\\)+\\)" (1 font-lock-function-name-face))
3136 ("\\$\\(\\w+\\)" (1 font-lock-variable-name-face))
3137 ("^\\s-*\\(\\(\\w\\|\\s_\\)+\\)" (1 font-lock-keyword-face))))
3139 ;; FIXME: The keyword "end" associated with "document"
3140 ;; should have font-lock-keyword-face (currently font-lock-doc-face).
3141 (defvar gdb-script-font-lock-syntactic-keywords
3142 '(("^document\\s-.*\\(\n\\)" (1 "< b"))
3143 ;; It would be best to change the \n in front, but it's more difficult.
3144 ("^en\\(d\\)\\>" (1 "> b"))))
3146 (defun gdb-script-font-lock-syntactic-face (state)
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)
3158 (gdb-script-skip-to-head)))
3160 (defun gdb-script-calculate-indentation ()
3162 ((looking-at "end\\>")
3163 (gdb-script-skip-to-head)
3164 (current-indentation))
3165 ((looking-at "else\\>")
3166 (while (and (re-search-backward "^\\s-*\\(if\\|\\(end\\)\\)\\>" nil 'move)
3168 (gdb-script-skip-to-head))
3169 (current-indentation))
3171 (forward-comment (- (point-max)))
3173 (skip-chars-forward " \t")
3174 (+ (current-indentation)
3175 (if (looking-at "\\(if\\|while\\|define\\|else\\|commands\\)\\>")
3176 gdb-script-basic-indent 0)))))
3178 (defun gdb-script-indent-line ()
3179 "Indent current line of GDB script."
3181 (if (and (eq (get-text-property (point) 'face) font-lock-doc-face)
3184 (skip-chars-forward " \t")
3185 (not (looking-at "end\\>"))))
3187 (let* ((savep (point))
3188 (indent (condition-case nil
3191 (skip-chars-forward " \t")
3192 (if (>= (point) savep) (setq savep nil))
3193 (max (gdb-script-calculate-indentation) 0))
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))
3205 (if (re-search-backward "^define \\|^document " nil t)
3207 (goto-char (point-min)))
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."
3215 (if (re-search-forward "^end" nil t)
3217 (goto-char (point-max)))
3221 (add-to-list 'auto-mode-alist '("/\\.gdbinit" . gdb-script-mode))
3224 (define-derived-mode gdb-script-mode nil "GDB-Script"
3225 "Major mode for editing GDB scripts"
3226 (set (make-local-variable 'comment-start) "#")
3227 (set (make-local-variable 'comment-start-skip) "#+\\s-*")
3228 (set (make-local-variable 'outline-regexp) "[ \t]")
3229 (set (make-local-variable 'imenu-generic-expression)
3230 '((nil "^define[ \t]+\\(\\w+\\)" 1)))
3231 (set (make-local-variable 'indent-line-function) 'gdb-script-indent-line)
3232 (set (make-local-variable 'beginning-of-defun-function)
3233 #'gdb-script-beginning-of-defun)
3234 (set (make-local-variable 'end-of-defun-function)
3235 #'gdb-script-end-of-defun)
3236 (set (make-local-variable 'font-lock-defaults)
3237 '(gdb-script-font-lock-keywords nil nil ((?_ . "w")) nil
3238 (font-lock-syntactic-keywords
3239 . gdb-script-font-lock-syntactic-keywords)
3240 (font-lock-syntactic-face-function
3241 . gdb-script-font-lock-syntactic-face))))
3244 ;;; tooltips for GUD
3246 ;;; Customizable settings
3248 (define-minor-mode gud-tooltip-mode
3249 "Toggle the display of GUD tooltips."
3254 (if gud-tooltip-mode
3256 (add-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3257 (add-hook 'pre-command-hook 'tooltip-hide)
3258 (add-hook 'tooltip-hook 'gud-tooltip-tips)
3259 (define-key global-map [mouse-movement] 'gud-tooltip-mouse-motion))
3260 (unless tooltip-mode (remove-hook 'pre-command-hook 'tooltip-hide)
3261 (remove-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3262 (remove-hook 'tooltip-hook 'gud-tooltip-tips)
3263 (define-key global-map [mouse-movement] 'ignore)))
3264 (gud-tooltip-activate-mouse-motions-if-enabled)
3267 (buffer-name gud-comint-buffer); gud-comint-buffer might be killed
3268 (with-current-buffer gud-comint-buffer
3269 (memq gud-minor-mode '(gdbmi gdba))))
3270 (if gud-tooltip-mode
3272 (dolist (buffer (buffer-list))
3273 (unless (eq buffer gud-comint-buffer)
3274 (with-current-buffer buffer
3275 (when (and (memq gud-minor-mode '(gdbmi gdba))
3276 (not (string-match "\\`\\*.+\\*\\'"
3278 (make-local-variable 'gdb-define-alist)
3279 (gdb-create-define-alist)
3280 (add-hook 'after-save-hook
3281 'gdb-create-define-alist nil t))))))
3282 (kill-local-variable 'gdb-define-alist)
3283 (remove-hook 'after-save-hook 'gdb-create-define-alist t))))
3285 (defcustom gud-tooltip-modes '(gud-mode c-mode c++-mode fortran-mode)
3286 "List of modes for which to enable GUD tooltips."
3291 (defcustom gud-tooltip-display
3292 '((eq (tooltip-event-buffer gud-tooltip-event)
3293 (marker-buffer gud-overlay-arrow-position)))
3294 "List of forms determining where GUD tooltips are displayed.
3296 Forms in the list are combined with AND. The default is to display
3297 only tooltips in the buffer containing the overlay arrow."
3302 (defcustom gud-tooltip-echo-area nil
3303 "Use the echo area instead of frames for GUD tooltips."
3308 (define-obsolete-variable-alias 'tooltip-gud-modes
3309 'gud-tooltip-modes "22.1")
3310 (define-obsolete-variable-alias 'tooltip-gud-display
3311 'gud-tooltip-display "22.1")
3313 ;;; Reacting on mouse movements
3315 (defun gud-tooltip-change-major-mode ()
3316 "Function added to `change-major-mode-hook' when tooltip mode is on."
3317 (add-hook 'post-command-hook 'gud-tooltip-activate-mouse-motions-if-enabled))
3319 (defun gud-tooltip-activate-mouse-motions-if-enabled ()
3320 "Reconsider for all buffers whether mouse motion events are desired."
3321 (remove-hook 'post-command-hook
3322 'gud-tooltip-activate-mouse-motions-if-enabled)
3323 (dolist (buffer (buffer-list))
3326 (if (and gud-tooltip-mode
3327 (memq major-mode gud-tooltip-modes))
3328 (gud-tooltip-activate-mouse-motions t)
3329 (gud-tooltip-activate-mouse-motions nil)))))
3331 (defvar gud-tooltip-mouse-motions-active nil
3332 "Locally t in a buffer if tooltip processing of mouse motion is enabled.")
3334 (defun gud-tooltip-activate-mouse-motions (activatep)
3335 "Activate/deactivate mouse motion events for the current buffer.
3336 ACTIVATEP non-nil means activate mouse motion events."
3339 (make-local-variable 'gud-tooltip-mouse-motions-active)
3340 (setq gud-tooltip-mouse-motions-active t)
3341 (make-local-variable 'track-mouse)
3342 (setq track-mouse t))
3343 (when gud-tooltip-mouse-motions-active
3344 (kill-local-variable 'gud-tooltip-mouse-motions-active)
3345 (kill-local-variable 'track-mouse))))
3347 (defun gud-tooltip-mouse-motion (event)
3348 "Command handler for mouse movement events in `global-map'."
3351 (when (car (mouse-pixel-position))
3352 (setq tooltip-last-mouse-motion-event (copy-sequence event))
3353 (tooltip-start-delayed-tip)))
3357 (defvar gud-tooltip-original-filter nil
3358 "Process filter to restore after GUD output has been received.")
3360 (defvar gud-tooltip-dereference nil
3361 "Non-nil means print expressions with a `*' in front of them.
3362 For C this would dereference a pointer expression.")
3364 (defvar gud-tooltip-event nil
3365 "The mouse movement event that led to a tooltip display.
3366 This event can be examined by forms in GUD-TOOLTIP-DISPLAY.")
3368 (defun gud-tooltip-dereference ()
3369 "Toggle whether tooltips should show `* expr' or `expr'.
3370 With arg, dereference expr iff arg is positive."
3372 (setq gud-tooltip-dereference
3374 (not gud-tooltip-dereference)
3375 (> (prefix-numeric-value arg) 0)))
3376 (message "Dereferencing is now %s."
3377 (if gud-tooltip-dereference "on" "off")))
3379 (define-obsolete-function-alias 'tooltip-gud-toggle-dereference
3380 'gud-tooltip-dereference "22.1")
3382 ; This will only display data that comes in one chunk.
3383 ; Larger arrays (say 400 elements) are displayed in
3384 ; the tooltip incompletely and spill over into the gud buffer.
3385 ; Switching the process-filter creates timing problems and
3386 ; it may be difficult to do better. Using annotations as in
3387 ; gdb-ui.el gets round this problem.
3388 (defun gud-tooltip-process-output (process output)
3389 "Process debugger output and show it in a tooltip window."
3390 (set-process-filter process gud-tooltip-original-filter)
3391 (tooltip-show (tooltip-strip-prompt process output)
3392 (or gud-tooltip-echo-area tooltip-use-echo-area)))
3394 (defun gud-tooltip-print-command (expr)
3395 "Return a suitable command to print the expression EXPR."
3396 (case gud-minor-mode
3397 (gdba (concat "server print " expr))
3398 ((dbx gdbmi) (concat "print " expr))
3399 (xdb (concat "p " expr))
3400 (sdb (concat expr "/"))
3403 (defun gud-tooltip-tips (event)
3404 "Show tip for identifier or selection under the mouse.
3405 The mouse must either point at an identifier or inside a selected
3406 region for the tip window to be shown. If gud-tooltip-dereference is t,
3407 add a `*' in front of the printed expression. In the case of a C program
3408 controlled by GDB, show the associated #define directives when program is
3411 This function must return nil if it doesn't handle EVENT."
3413 (when (and (eventp event)
3416 (buffer-name gud-comint-buffer); might be killed
3417 (setq process (get-buffer-process gud-comint-buffer))
3418 (posn-point (event-end event))
3419 (or (and (eq gud-minor-mode 'gdba) (not gdb-active-process))
3420 (progn (setq gud-tooltip-event event)
3421 (eval (cons 'and gud-tooltip-display)))))
3422 (let ((expr (tooltip-expr-to-print event)))
3424 (if (and (eq gud-minor-mode 'gdba)
3425 (not gdb-active-process))
3427 (with-current-buffer
3428 (window-buffer (let ((mouse (mouse-position)))
3429 (window-at (cadr mouse)
3431 (let ((define-elt (assoc expr gdb-define-alist)))
3432 (unless (null define-elt)
3435 (or gud-tooltip-echo-area tooltip-use-echo-area))
3437 (when gud-tooltip-dereference
3438 (setq expr (concat "*" expr)))
3439 (let ((cmd (gud-tooltip-print-command expr)))
3440 (when (and gud-tooltip-mode (eq gud-minor-mode 'gdb))
3441 (gud-tooltip-mode -1)
3442 (message-box "Using GUD tooltips in this mode is unsafe\n\
3443 so they have been disabled."))
3444 (unless (null cmd) ; CMD can be nil if unknown debugger
3445 (if (memq gud-minor-mode '(gdba gdbmi))
3449 gdb-server-prefix "macro expand " expr "\n")
3450 `(lambda () (gdb-tooltip-print-1 ,expr))))
3452 (list (concat cmd "\n") 'gdb-tooltip-print)))
3453 (setq gud-tooltip-original-filter (process-filter process))
3454 (set-process-filter process 'gud-tooltip-process-output)
3455 (gud-basic-call cmd))
3460 ;;; arch-tag: 6d990948-df65-461a-be39-1c7fb83ac4c4
3461 ;;; gud.el ends here