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 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
48 (defvar gdb-active-process)
49 (defvar gdb-define-alist)
50 (defvar gdb-macro-info)
51 (defvar gdb-server-prefix)
52 (defvar gdb-show-changed-values)
53 (defvar gdb-var-changed)
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)
192 '(gdbmi gdba gdb xdb jdb pdb bashdb))))
193 ([stepi] menu-item "Step Instruction" gud-stepi
194 :enable (and (not gud-running)
195 (memq gud-minor-mode '(gdbmi gdba gdb dbx))))
196 ([nexti] menu-item "Next Instruction" gud-nexti
197 :enable (and (not gud-running)
198 (memq gud-minor-mode '(gdbmi gdba gdb dbx))))
199 ([step] menu-item "Step Line" gud-step
200 :enable (not gud-running))
201 ([next] menu-item "Next Line" gud-next
202 :enable (not gud-running))
203 ([cont] menu-item "Continue" gud-cont
204 :enable (not gud-running)
205 :visible (not (eq gud-minor-mode 'gdba))))
206 "Menu for `gud-mode'."
209 (easy-mmode-defmap gud-minor-mode-map
210 `(([menu-bar debug] . ("Gud" . ,gud-menu-map)))
211 "Map used in visited files.")
213 (let ((m (assq 'gud-minor-mode minor-mode-map-alist)))
214 (if m (setcdr m gud-minor-mode-map)
215 (push (cons 'gud-minor-mode gud-minor-mode-map) minor-mode-map-alist)))
218 ;; Will inherit from comint-mode via define-derived-mode.
220 "`gud-mode' keymap.")
222 (defvar gud-tool-bar-map
223 (if (display-graphic-p)
224 (let ((map (make-sparse-keymap)))
225 (dolist (x '((gud-break . "gud/break")
226 (gud-remove . "gud/remove")
227 (gud-print . "gud/print")
228 (gud-pstar . "gud/pstar")
230 (gud-watch . "gud/watch")
231 (gud-run . "gud/run")
233 (gud-stop-subjob . "gud/stop")
234 ;; gud-s, gud-si etc. instead of gud-step,
235 ;; gud-stepi, to avoid file-name clashes on DOS
237 (gud-cont . "gud/cont")
238 (gud-until . "gud/until")
239 (gud-next . "gud/next")
240 (gud-step . "gud/step")
241 (gud-finish . "gud/finish")
242 (gud-nexti . "gud/nexti")
243 (gud-stepi . "gud/stepi")
245 (gud-down . "gud/down")
246 (gud-goto-info . "info"))
248 (tool-bar-local-item-from-menu
249 (car x) (cdr x) map gud-minor-mode-map)))))
251 (defun gud-file-name (f)
252 "Transform a relative file name to an absolute file name.
253 Uses `gud-<MINOR-MODE>-directories' to find the source files."
254 (if (file-exists-p f) (expand-file-name f)
255 (let ((directories (gud-val 'directories))
258 (let ((path (expand-file-name f (car directories))))
259 (if (file-exists-p path)
262 (setq directories (cdr directories)))
265 (defun gud-find-file (file)
266 ;; Don't get confused by double slashes in the name that comes from GDB.
267 (while (string-match "//+" file)
268 (setq file (replace-match "/" t t file)))
269 (let ((minor-mode gud-minor-mode)
270 (buf (funcall (or gud-find-file 'gud-file-name) file)))
272 (setq buf (and (file-readable-p buf) (find-file-noselect buf 'nowarn))))
274 ;; Copy `gud-minor-mode' to the found buffer to turn on the menu.
275 (with-current-buffer buf
276 (set (make-local-variable 'gud-minor-mode) minor-mode)
277 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
278 (when (and gud-tooltip-mode
279 (memq gud-minor-mode '(gdbmi gdba)))
280 (make-local-variable 'gdb-define-alist)
281 (unless gdb-define-alist (gdb-create-define-alist))
282 (add-hook 'after-save-hook 'gdb-create-define-alist nil t))
283 (make-local-variable 'gud-keep-buffer))
286 ;; ======================================================================
287 ;; command definition
289 ;; This macro is used below to define some basic debugger interface commands.
290 ;; Of course you may use `gud-def' with any other debugger command, including
291 ;; user defined ones.
293 ;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
294 ;; which defines FUNC to send the command NAME to the debugger, gives
295 ;; it the docstring DOC, and binds that function to KEY in the GUD
296 ;; major mode. The function is also bound in the global keymap with the
299 (defmacro gud-def (func cmd key &optional doc)
300 "Define FUNC to be a command sending STR and bound to KEY, with
301 optional doc string DOC. Certain %-escapes in the string arguments
302 are interpreted specially if present. These are:
304 %f name (without directory) of current source file.
305 %F name (without directory or extension) of current source file.
306 %d directory of current source file.
307 %l number of current source line
308 %e text of the C lvalue or function-call expression surrounding point.
309 %a text of the hexadecimal address surrounding point
310 %p prefix argument to the command (if any) as a number
312 The `current' source file is the file of the current buffer (if
313 we're in a C file) or the source file current at the last break or
314 step (if we're in the GUD buffer).
315 The `current' line is that of the current buffer (if we're in a
316 source file) or the source line number at the last break or step (if
317 we're in the GUD buffer)."
320 ,@(if doc (list doc))
325 ,(if key `(local-set-key ,(concat "\C-c" key) ',func))
326 ,(if key `(global-set-key (vconcat gud-key-prefix ,key) ',func))))
328 ;; Where gud-display-frame should put the debugging arrow; a cons of
329 ;; (filename . line-number). This is set by the marker-filter, which scans
330 ;; the debugger's output for indications of the current program counter.
331 (defvar gud-last-frame nil)
333 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
334 ;; the last frame, even if it's been called before and gud-last-frame has
336 (defvar gud-last-last-frame nil)
338 ;; All debugger-specific information is collected here.
339 ;; Here's how it works, in case you ever need to add a debugger to the mode.
341 ;; Each entry must define the following at startup:
344 ;; comint-prompt-regexp
345 ;; gud-<name>-massage-args
346 ;; gud-<name>-marker-filter
347 ;; gud-<name>-find-file
349 ;; The job of the massage-args method is to modify the given list of
350 ;; debugger arguments before running the debugger.
352 ;; The job of the marker-filter method is to detect file/line markers in
353 ;; strings and set the global gud-last-frame to indicate what display
354 ;; action (if any) should be triggered by the marker. Note that only
355 ;; whatever the method *returns* is displayed in the buffer; thus, you
356 ;; can filter the debugger's output, interpreting some and passing on
359 ;; The job of the find-file method is to visit and return the buffer indicated
360 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
363 ;; ======================================================================
364 ;; speedbar support functions and variables.
365 (eval-when-compile (require 'speedbar)) ;For speedbar-with-attached-buffer.
367 (defvar gud-last-speedbar-stackframe nil
368 "Description of the currently displayed GUD stack.
369 t means that there is no stack, and we are in display-file mode.")
371 (defvar gud-speedbar-key-map nil
372 "Keymap used when in the buffers display mode.")
374 (defun gud-speedbar-item-info ()
375 "Display the data type of the watch expression element."
376 (let ((var (nth (- (line-number-at-pos (point)) 2) gdb-var-list)))
378 (speedbar-message "%s" (nth 3 var)))))
380 (defun gud-install-speedbar-variables ()
381 "Install those variables used by speedbar to enhance gud/gdb."
382 (if gud-speedbar-key-map
384 (setq gud-speedbar-key-map (speedbar-make-specialized-keymap))
386 (define-key gud-speedbar-key-map "j" 'speedbar-edit-line)
387 (define-key gud-speedbar-key-map "e" 'speedbar-edit-line)
388 (define-key gud-speedbar-key-map "\C-m" 'speedbar-edit-line)
389 (define-key gud-speedbar-key-map " " 'speedbar-toggle-line-expansion)
390 (define-key gud-speedbar-key-map "[" 'speedbar-expand-line-descendants)
391 (define-key gud-speedbar-key-map "]" 'speedbar-contract-line-descendants)
392 (define-key gud-speedbar-key-map "D" 'gdb-var-delete)
393 (define-key gud-speedbar-key-map "p" 'gud-pp))
395 (speedbar-add-expansion-list '("GUD" gud-speedbar-menu-items
397 gud-expansion-speedbar-buttons))
400 'speedbar-mode-functions-list
401 '("GUD" (speedbar-item-info . gud-speedbar-item-info)
402 (speedbar-line-directory . ignore))))
404 (defvar gud-speedbar-menu-items
405 '(["Jump to stack frame" speedbar-edit-line
406 :visible (with-current-buffer gud-comint-buffer
407 (not (memq gud-minor-mode '(gdbmi gdba))))]
408 ["Edit value" speedbar-edit-line
409 :visible (with-current-buffer gud-comint-buffer
410 (memq gud-minor-mode '(gdbmi gdba)))]
411 ["Delete expression" gdb-var-delete
412 (with-current-buffer gud-comint-buffer
413 (memq gud-minor-mode '(gdbmi gdba)))])
414 "Additional menu items to add to the speedbar frame.")
416 ;; Make sure our special speedbar mode is loaded
417 (if (featurep 'speedbar)
418 (gud-install-speedbar-variables)
419 (add-hook 'speedbar-load-hook 'gud-install-speedbar-variables))
421 (defun gud-expansion-speedbar-buttons (directory zero)
422 "Wrapper for call to speedbar-add-expansion-list. DIRECTORY and
423 ZERO are not used, but are required by the caller."
424 (gud-speedbar-buttons gud-comint-buffer))
426 (defun gud-speedbar-buttons (buffer)
427 "Create a speedbar display based on the current state of GUD.
428 If the GUD BUFFER is not running a supported debugger, then turn
429 off the specialized speedbar mode. BUFFER is not used, but are
430 required by the caller."
431 (when (and (boundp 'gud-comint-buffer)
433 ;; gud-comint-buffer might be killed
434 (buffer-name gud-comint-buffer))
435 (let* ((minor-mode (with-current-buffer buffer gud-minor-mode))
436 (window (get-buffer-window (current-buffer) 0))
437 (p (window-point window)))
439 ((memq minor-mode '(gdbmi gdba))
440 (when (or gdb-var-changed
442 (goto-char (point-min))
443 (let ((case-fold-search t))
444 (looking-at "Watch Expressions:")))))
446 (insert "Watch Expressions:\n")
447 (let ((var-list gdb-var-list))
449 (let* ((depth 0) (start 0) (char ?+)
450 (var (car var-list)) (varnum (nth 1 var)))
451 (while (string-match "\\." varnum start)
452 (setq depth (1+ depth)
453 start (1+ (match-beginning 0))))
454 (if (or (equal (nth 2 var) "0")
455 (and (equal (nth 2 var) "1")
456 (string-match "char \\*" (nth 3 var))))
457 (speedbar-make-tag-line 'bracket ?? nil nil
458 (concat (car var) "\t" (nth 4 var))
462 gdb-show-changed-values)
463 'font-lock-warning-face
465 (if (and (cadr var-list)
466 (string-match varnum (cadr (cadr var-list))))
468 (speedbar-make-tag-line 'bracket char
469 'gdb-speedbar-expand-node varnum
470 (concat (car var) "\t" (nth 3 var))
472 (setq var-list (cdr var-list))))
473 (setq gdb-var-changed nil)))
474 (t (if (and (save-excursion
475 (goto-char (point-min))
476 (looking-at "Current Stack:"))
477 (equal gud-last-last-frame gud-last-speedbar-stackframe))
479 (let ((gud-frame-list
480 (cond ((eq minor-mode 'gdb)
481 (gud-gdb-get-stackframe buffer))
482 ;; Add more debuggers here!
483 (t (speedbar-remove-localized-speedbar-support buffer)
486 (if (not gud-frame-list)
487 (insert "No Stack frames\n")
488 (insert "Current Stack:\n"))
489 (dolist (frame gud-frame-list)
490 (insert (nth 1 frame) ":\n")
491 (if (= (length frame) 2)
493 (speedbar-insert-button (car frame)
494 'speedbar-directory-face
496 (speedbar-insert-button
499 'speedbar-highlight-face
500 (cond ((memq minor-mode '(gdbmi gdba gdb))
501 'gud-gdb-goto-stackframe)
502 (t (error "Should never be here")))
504 (setq gud-last-speedbar-stackframe gud-last-last-frame))))
505 (set-window-point window p))))
508 ;; ======================================================================
511 ;; History of argument lists passed to gdb.
512 (defvar gud-gdb-history nil)
514 (defcustom gud-gdb-command-name "gdb --annotate=3"
515 "Default command to execute an executable under the GDB debugger."
519 (defvar gud-gdb-marker-regexp
520 ;; This used to use path-separator instead of ":";
521 ;; however, we found that on both Windows 32 and MSDOS
522 ;; a colon is correct here.
523 (concat "\032\032\\(.:?[^" ":" "\n]*\\)" ":"
524 "\\([0-9]*\\)" ":" ".*\n"))
526 ;; There's no guarantee that Emacs will hand the filter the entire
527 ;; marker at once; it could be broken up across several strings. We
528 ;; might even receive a big chunk with several markers in it. If we
529 ;; receive a chunk of text which looks like it might contain the
530 ;; beginning of a marker, we save it here between calls to the
532 (defvar gud-marker-acc "")
533 (make-variable-buffer-local 'gud-marker-acc)
535 (defun gud-gdb-marker-filter (string)
536 (setq gud-marker-acc (concat gud-marker-acc string))
539 ;; Process all the complete markers in this chunk.
540 (while (string-match gud-gdb-marker-regexp gud-marker-acc)
543 ;; Extract the frame position from the marker.
544 gud-last-frame (cons (match-string 1 gud-marker-acc)
545 (string-to-number (match-string 2 gud-marker-acc)))
547 ;; Append any text before the marker to the output we're going
548 ;; to return - we don't include the marker in this text.
549 output (concat output
550 (substring gud-marker-acc 0 (match-beginning 0)))
552 ;; Set the accumulator to the remaining text.
553 gud-marker-acc (substring gud-marker-acc (match-end 0))))
555 ;; Check for annotations and change gud-minor-mode to 'gdba if
557 (while (string-match "\n\032\032\\(.*\\)\n" gud-marker-acc)
558 (let ((match (match-string 1 gud-marker-acc)))
559 (when (string-equal match "prompt")
564 ;; Append any text before the marker to the output we're going
565 ;; to return - we don't include the marker in this text.
566 output (concat output
567 (substring gud-marker-acc 0 (match-beginning 0)))
569 ;; Set the accumulator to the remaining text.
571 gud-marker-acc (substring gud-marker-acc (match-end 0)))
572 (if (string-equal match "error-begin")
573 (put-text-property 0 (length gud-marker-acc)
574 'face font-lock-warning-face
577 ;; Does the remaining text look like it might end with the
578 ;; beginning of another marker? If it does, then keep it in
579 ;; gud-marker-acc until we receive the rest of it. Since we
580 ;; know the full marker regexp above failed, it's pretty simple to
581 ;; test for marker starts.
582 (if (string-match "\n\\(\032.*\\)?\\'" gud-marker-acc)
584 ;; Everything before the potential marker start can be output.
585 (setq output (concat output (substring gud-marker-acc
586 0 (match-beginning 0))))
588 ;; Everything after, we save, to combine with later input.
590 (substring gud-marker-acc (match-beginning 0))))
592 (setq output (concat output gud-marker-acc)
597 (easy-mmode-defmap gud-minibuffer-local-map
598 '(("\C-i" . comint-dynamic-complete-filename))
599 "Keymap for minibuffer prompting of gud startup command."
600 :inherit minibuffer-local-map)
602 (defun gud-query-cmdline (minor-mode &optional init)
603 (let* ((hist-sym (gud-symbol 'history nil minor-mode))
604 (cmd-name (gud-val 'command-name minor-mode)))
605 (unless (boundp hist-sym) (set hist-sym nil))
606 (read-from-minibuffer
607 (format "Run %s (like this): " minor-mode)
608 (or (car-safe (symbol-value hist-sym))
609 (concat (or cmd-name (symbol-name minor-mode))
613 (dolist (f (directory-files default-directory) file)
614 (if (and (file-executable-p f)
615 (not (file-directory-p f))
617 (file-newer-than-file-p f file)))
619 gud-minibuffer-local-map nil
622 (defvar gdb-first-prompt t)
624 (defvar gud-filter-pending-text nil
625 "Non-nil means this is text that has been saved for later in `gud-filter'.")
628 (defun gdb (command-line)
629 "Run gdb on program FILE in buffer *gud-FILE*.
630 The directory containing FILE becomes the initial working directory
631 and source-file directory for your debugger."
632 (interactive (list (gud-query-cmdline 'gdb)))
634 (gud-common-init command-line nil 'gud-gdb-marker-filter)
635 (set (make-local-variable 'gud-minor-mode) 'gdb)
637 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
638 (gud-def gud-tbreak "tbreak %f:%l" "\C-t"
639 "Set temporary breakpoint at current line.")
640 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
641 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
642 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
643 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
644 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
645 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
646 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
648 (progn (gud-call "tbreak %f:%l") (gud-call "jump %f:%l"))
649 "\C-j" "Set execution address to current line.")
651 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
652 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
653 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
654 (gud-def gud-pstar "print* %e" nil
655 "Evaluate C dereferenced pointer expression at point.")
657 ;; For debugging Emacs only.
658 (gud-def gud-pv "pv1 %e" "\C-v" "Print the value of the lisp variable.")
660 (gud-def gud-until "until %l" "\C-u" "Continue to current line.")
661 (gud-def gud-run "run" nil "Run the program.")
663 (local-set-key "\C-i" 'gud-gdb-complete-command)
664 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
665 (setq paragraph-start comint-prompt-regexp)
666 (setq gdb-first-prompt t)
667 (setq gud-filter-pending-text nil)
668 (run-hooks 'gdb-mode-hook))
670 ;; One of the nice features of GDB is its impressive support for
671 ;; context-sensitive command completion. We preserve that feature
672 ;; in the GUD buffer by using a GDB command designed just for Emacs.
674 ;; The completion process filter indicates when it is finished.
675 (defvar gud-gdb-fetch-lines-in-progress)
677 ;; Since output may arrive in fragments we accumulate partials strings here.
678 (defvar gud-gdb-fetch-lines-string)
680 ;; We need to know how much of the completion to chop off.
681 (defvar gud-gdb-fetch-lines-break)
683 ;; The completion list is constructed by the process filter.
684 (defvar gud-gdb-fetched-lines)
686 (defvar gud-comint-buffer nil)
688 (defun gud-gdb-complete-command ()
689 "Perform completion on the GDB command preceding point.
690 This is implemented using the GDB `complete' command which isn't
691 available with older versions of GDB."
694 (command (buffer-substring (comint-line-beginning-position) end))
696 ;; Find the word break. This match will always succeed.
697 (and (string-match "\\(\\`\\| \\)\\([^ ]*\\)\\'" command)
698 (substring command (match-beginning 2))))
700 (gud-gdb-run-command-fetch-lines (concat "complete " command)
702 ;; From string-match above.
703 (match-beginning 2))))
704 ;; Protect against old versions of GDB.
706 (string-match "^Undefined command: \"complete\"" (car complete-list))
707 (error "This version of GDB doesn't support the `complete' command"))
708 ;; Sort the list like readline.
709 (setq complete-list (sort complete-list (function string-lessp)))
710 ;; Remove duplicates.
711 (let ((first complete-list)
712 (second (cdr complete-list)))
714 (if (string-equal (car first) (car second))
715 (setcdr first (setq second (cdr second)))
717 second (cdr second)))))
718 ;; Add a trailing single quote if there is a unique completion
719 ;; and it contains an odd number of unquoted single quotes.
720 (and (= (length complete-list) 1)
721 (let ((str (car complete-list))
724 (while (string-match "\\([^'\\]\\|\\\\'\\)*'" str pos)
725 (setq count (1+ count)
727 (and (= (mod count 2) 1)
728 (setq complete-list (list (concat str "'"))))))
729 ;; Let comint handle the rest.
730 (comint-dynamic-simple-complete command-word complete-list)))
732 ;; The completion process filter is installed temporarily to slurp the
733 ;; output of GDB up to the next prompt and build the completion list.
734 (defun gud-gdb-fetch-lines-filter (string filter)
735 "Filter used to read the list of lines output by a command.
736 STRING is the output to filter.
737 It is passed through FILTER before we look at it."
738 (setq string (funcall filter string))
739 (setq string (concat gud-gdb-fetch-lines-string string))
740 (while (string-match "\n" string)
741 (push (substring string gud-gdb-fetch-lines-break (match-beginning 0))
742 gud-gdb-fetched-lines)
743 (setq string (substring string (match-end 0))))
744 (if (string-match comint-prompt-regexp string)
746 (setq gud-gdb-fetch-lines-in-progress nil)
749 (setq gud-gdb-fetch-lines-string string)
752 ;; gdb speedbar functions
754 (defun gud-gdb-goto-stackframe (text token indent)
755 "Goto the stackframe described by TEXT, TOKEN, and INDENT."
756 (speedbar-with-attached-buffer
757 (gud-basic-call (concat "server frame " (nth 1 token)))
760 (defvar gud-gdb-fetched-stack-frame nil
761 "Stack frames we are fetching from GDB.")
763 ;(defun gud-gdb-get-scope-data (text token indent)
764 ; ;; checkdoc-params: (indent)
765 ; "Fetch data associated with a stack frame, and expand/contract it.
766 ;Data to do this is retrieved from TEXT and TOKEN."
767 ; (let ((args nil) (scope nil))
768 ; (gud-gdb-run-command-fetch-lines "info args")
770 ; (gud-gdb-run-command-fetch-lines "info local")
774 (defun gud-gdb-get-stackframe (buffer)
775 "Extract the current stack frame out of the GUD GDB BUFFER."
777 (fetched-stack-frame-list
778 (gud-gdb-run-command-fetch-lines "server backtrace" buffer)))
779 (if (and (car fetched-stack-frame-list)
780 (string-match "No stack" (car fetched-stack-frame-list)))
781 ;; Go into some other mode???
783 (dolist (e fetched-stack-frame-list)
784 (let ((name nil) (num nil))
786 (string-match "^#\\([0-9]+\\) +[0-9a-fx]+ in \\([:0-9a-zA-Z_]+\\) (" e)
787 (string-match "^#\\([0-9]+\\) +\\([:0-9a-zA-Z_]+\\) (" e)))
788 (if (not (string-match
789 "at \\([-0-9a-zA-Z_.]+\\):\\([0-9]+\\)$" e))
792 (list (nth 0 (car newlst))
795 (match-string 2 e))))
796 (setq num (match-string 1 e)
797 name (match-string 2 e))
801 "at \\([-0-9a-zA-Z_.]+\\):\\([0-9]+\\)$" e)
802 (list name num (match-string 1 e)
808 ;(defun gud-gdb-selected-frame-info (buffer)
809 ; "Learn GDB information for the currently selected stack frame in BUFFER."
812 (defun gud-gdb-run-command-fetch-lines (command buffer &optional skip)
813 "Run COMMAND, and return the list of lines it outputs.
814 BUFFER is the GUD buffer in which to run the command.
815 SKIP is the number of chars to skip on each lines, it defaults to 0."
816 (with-current-buffer buffer
818 (goto-char (point-max))
820 (not (looking-at comint-prompt-regexp)))
822 ;; Much of this copied from GDB complete, but I'm grabbing the stack
824 (let ((gud-gdb-fetch-lines-in-progress t)
825 (gud-gdb-fetched-lines nil)
826 (gud-gdb-fetch-lines-string nil)
827 (gud-gdb-fetch-lines-break (or skip 0))
829 `(lambda (string) (gud-gdb-fetch-lines-filter string ',gud-marker-filter))))
830 ;; Issue the command to GDB.
831 (gud-basic-call command)
833 (while gud-gdb-fetch-lines-in-progress
834 (accept-process-output (get-buffer-process buffer)))
835 (nreverse gud-gdb-fetched-lines)))))
838 ;; ======================================================================
841 ;; History of argument lists passed to sdb.
842 (defvar gud-sdb-history nil)
844 (defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
845 "If nil, we're on a System V Release 4 and don't need the tags hack.")
847 (defvar gud-sdb-lastfile nil)
849 (defun gud-sdb-marker-filter (string)
851 (if gud-marker-acc (concat gud-marker-acc string) string))
853 ;; Process all complete markers in this chunk
856 ;; System V Release 3.2 uses this format
857 ((string-match "\\(^\\|\n\\)\\*?\\(0x\\w* in \\)?\\([^:\n]*\\):\\([0-9]*\\):.*\n"
858 gud-marker-acc start)
860 (cons (match-string 3 gud-marker-acc)
861 (string-to-number (match-string 4 gud-marker-acc)))))
862 ;; System V Release 4.0 quite often clumps two lines together
863 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
864 gud-marker-acc start)
865 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc))
867 (cons gud-sdb-lastfile
868 (string-to-number (match-string 3 gud-marker-acc)))))
869 ;; System V Release 4.0
870 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n"
871 gud-marker-acc start)
872 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc)))
873 ((and gud-sdb-lastfile (string-match "^\\([0-9]+\\):"
874 gud-marker-acc start))
876 (cons gud-sdb-lastfile
877 (string-to-number (match-string 1 gud-marker-acc)))))
879 (setq gud-sdb-lastfile nil)))
880 (setq start (match-end 0)))
882 ;; Search for the last incomplete line in this chunk
883 (while (string-match "\n" gud-marker-acc start)
884 (setq start (match-end 0)))
886 ;; If we have an incomplete line, store it in gud-marker-acc.
887 (setq gud-marker-acc (substring gud-marker-acc (or start 0))))
890 (defun gud-sdb-find-file (f)
891 (if gud-sdb-needs-tags (find-tag-noselect f) (find-file-noselect f)))
894 (defun sdb (command-line)
895 "Run sdb on program FILE in buffer *gud-FILE*.
896 The directory containing FILE becomes the initial working directory
897 and source-file directory for your debugger."
898 (interactive (list (gud-query-cmdline 'sdb)))
900 (if gud-sdb-needs-tags (require 'etags))
901 (if (and gud-sdb-needs-tags
902 (not (and (boundp 'tags-file-name)
903 (stringp tags-file-name)
904 (file-exists-p tags-file-name))))
905 (error "The sdb support requires a valid tags table to work"))
907 (gud-common-init command-line nil 'gud-sdb-marker-filter 'gud-sdb-find-file)
908 (set (make-local-variable 'gud-minor-mode) 'sdb)
910 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
911 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
912 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
913 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
914 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
915 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
916 (gud-def gud-cont "c" "\C-r" "Continue with display.")
917 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
919 (setq comint-prompt-regexp "\\(^\\|\n\\)\\*")
920 (setq paragraph-start comint-prompt-regexp)
921 (run-hooks 'sdb-mode-hook)
924 ;; ======================================================================
927 ;; History of argument lists passed to dbx.
928 (defvar gud-dbx-history nil)
930 (defcustom gud-dbx-directories nil
931 "*A list of directories that dbx should search for source code.
932 If nil, only source files in the program directory
933 will be known to dbx.
935 The file names should be absolute, or relative to the directory
936 containing the executable being debugged."
937 :type '(choice (const :tag "Current Directory" nil)
942 (defun gud-dbx-massage-args (file args)
943 (nconc (let ((directories gud-dbx-directories)
946 (setq result (cons (car directories) (cons "-I" result)))
947 (setq directories (cdr directories)))
951 (defun gud-dbx-marker-filter (string)
952 (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
955 ;; Process all complete markers in this chunk.
956 (while (or (string-match
957 "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
958 gud-marker-acc start)
960 "signal .* in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
961 gud-marker-acc start))
963 (cons (match-string 2 gud-marker-acc)
964 (string-to-number (match-string 1 gud-marker-acc)))
965 start (match-end 0)))
967 ;; Search for the last incomplete line in this chunk
968 (while (string-match "\n" gud-marker-acc start)
969 (setq start (match-end 0)))
971 ;; If the incomplete line APPEARS to begin with another marker, keep it
972 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
973 ;; unnecessary concat during the next call.
975 (if (string-match "\\(stopped\\|signal\\)" gud-marker-acc start)
976 (substring gud-marker-acc (match-beginning 0))
980 ;; Functions for Mips-style dbx. Given the option `-emacs', documented in
981 ;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
983 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
984 ;; We haven't tested gud on this system:
985 (string-match "^mips-[^-]*-riscos" system-configuration)
986 ;; It's documented on OSF/1.3
987 (string-match "^mips-[^-]*-osf1" system-configuration)
988 (string-match "^alpha[^-]*-[^-]*-osf" system-configuration))
989 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
991 (defvar gud-dbx-command-name
992 (concat "dbx" (if gud-mips-p " -emacs")))
994 ;; This is just like the gdb one except for the regexps since we need to cope
995 ;; with an optional breakpoint number in [] before the ^Z^Z
996 (defun gud-mipsdbx-marker-filter (string)
997 (setq gud-marker-acc (concat gud-marker-acc string))
1000 ;; Process all the complete markers in this chunk.
1001 (while (string-match
1002 ;; This is like th gdb marker but with an optional
1003 ;; leading break point number like `[1] '
1004 "[][ 0-9]*\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
1008 ;; Extract the frame position from the marker.
1010 (cons (match-string 1 gud-marker-acc)
1011 (string-to-number (match-string 2 gud-marker-acc)))
1013 ;; Append any text before the marker to the output we're going
1014 ;; to return - we don't include the marker in this text.
1015 output (concat output
1016 (substring gud-marker-acc 0 (match-beginning 0)))
1018 ;; Set the accumulator to the remaining text.
1019 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1021 ;; Does the remaining text look like it might end with the
1022 ;; beginning of another marker? If it does, then keep it in
1023 ;; gud-marker-acc until we receive the rest of it. Since we
1024 ;; know the full marker regexp above failed, it's pretty simple to
1025 ;; test for marker starts.
1026 (if (string-match "[][ 0-9]*\032.*\\'" gud-marker-acc)
1028 ;; Everything before the potential marker start can be output.
1029 (setq output (concat output (substring gud-marker-acc
1030 0 (match-beginning 0))))
1032 ;; Everything after, we save, to combine with later input.
1033 (setq gud-marker-acc
1034 (substring gud-marker-acc (match-beginning 0))))
1036 (setq output (concat output gud-marker-acc)
1041 ;; The dbx in IRIX is a pain. It doesn't print the file name when
1042 ;; stopping at a breakpoint (but you do get it from the `up' and
1043 ;; `down' commands...). The only way to extract the information seems
1044 ;; to be with a `file' command, although the current line number is
1045 ;; available in $curline. Thus we have to look for output which
1046 ;; appears to indicate a breakpoint. Then we prod the dbx sub-process
1047 ;; to output the information we want with a combination of the
1048 ;; `printf' and `file' commands as a pseudo marker which we can
1049 ;; recognise next time through the marker-filter. This would be like
1050 ;; the gdb marker but you can't get the file name without a newline...
1051 ;; Note that gud-remove won't work since Irix dbx expects a breakpoint
1052 ;; number rather than a line number etc. Maybe this could be made to
1053 ;; work by listing all the breakpoints and picking the one(s) with the
1054 ;; correct line number, but life's too short.
1055 ;; d.love@dl.ac.uk (Dave Love) can be blamed for this
1058 (and (string-match "^mips-[^-]*-irix" system-configuration)
1059 (not (string-match "irix[6-9]\\.[1-9]" system-configuration)))
1060 "Non-nil to assume the interface appropriate for IRIX dbx.
1061 This works in IRIX 4, 5 and 6, but `gud-dbx-use-stopformat-p' provides
1062 a better solution in 6.1 upwards.")
1063 (defvar gud-dbx-use-stopformat-p
1064 (string-match "irix[6-9]\\.[1-9]" system-configuration)
1065 "Non-nil to use the dbx feature present at least from Irix 6.1
1066 whereby $stopformat=1 produces an output format compatiable with
1067 `gud-dbx-marker-filter'.")
1068 ;; [Irix dbx seems to be a moving target. The dbx output changed
1069 ;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
1070 ;; the output from `up' is no longer spotted by gud (and it's probably
1071 ;; not distinctive enough to try to match it -- use C-<, C->
1072 ;; exclusively) . For 5.3 and 6.0, the $curline variable changed to
1073 ;; `long long'(why?!), so the printf stuff needed changing. The line
1074 ;; number was cast to `long' as a compromise between the new `long
1075 ;; long' and the original `int'. This is reported not to work in 6.2,
1076 ;; so it's changed back to int -- don't make your sources too long.
1077 ;; From Irix6.1 (but not 6.0?) dbx supports an undocumented feature
1078 ;; whereby `set $stopformat=1' reportedly produces output compatible
1079 ;; with `gud-dbx-marker-filter', which we prefer.
1081 ;; The process filter is also somewhat
1082 ;; unreliable, sometimes not spotting the markers; I don't know
1083 ;; whether there's anything that can be done about that. It would be
1084 ;; much better if SGI could be persuaded to (re?)instate the MIPS
1085 ;; -emacs flag for gdb-like output (which ought to be possible as most
1086 ;; of the communication I've had over it has been from sgi.com).]
1088 ;; this filter is influenced by the xdb one rather than the gdb one
1089 (defun gud-irixdbx-marker-filter (string)
1090 (let (result (case-fold-search nil))
1091 (if (or (string-match comint-prompt-regexp string)
1092 (string-match ".*\012" string))
1093 (setq result (concat gud-marker-acc string)
1095 (setq gud-marker-acc (concat gud-marker-acc string)))
1098 ;; look for breakpoint or signal indication e.g.:
1099 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
1100 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
1101 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
1103 "^\\(\\[[0-9]+] \\)?Process +[0-9]+ ([^)]*) [^[]+\\[[^]\n]*]\n"
1105 ;; prod dbx into printing out the line number and file
1106 ;; name in a form we can grok as below
1107 (process-send-string (get-buffer-process gud-comint-buffer)
1108 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1109 ;; look for result of, say, "up" e.g.:
1110 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
1111 ;; (this will also catch one of the lines printed by "where")
1113 "^[^ ][^[]*\\[\"\\([^\"]+\\)\":\\([0-9]+\\), [^]]+]\n"
1115 (let ((file (match-string 1 result)))
1116 (if (file-exists-p file)
1117 (setq gud-last-frame
1118 (cons (match-string 1 result)
1119 (string-to-number (match-string 2 result))))))
1121 ((string-match ; kluged-up marker as above
1122 "\032\032\\([0-9]*\\):\\(.*\\)\n" result)
1123 (let ((file (gud-file-name (match-string 2 result))))
1124 (if (and file (file-exists-p file))
1125 (setq gud-last-frame
1127 (string-to-number (match-string 1 result))))))
1128 (setq result (substring result 0 (match-beginning 0))))))
1131 (defvar gud-dgux-p (string-match "-dgux" system-configuration)
1132 "Non-nil means to assume the interface approriate for DG/UX dbx.
1133 This was tested using R4.11.")
1135 ;; There are a couple of differences between DG's dbx output and normal
1136 ;; dbx output which make it nontrivial to integrate this into the
1137 ;; standard dbx-marker-filter (mainly, there are a different number of
1138 ;; backreferences). The markers look like:
1140 ;; (0) Stopped at line 10, routine main(argc=1, argv=0xeffff0e0), file t.c
1142 ;; from breakpoints (the `(0)' there isn't constant, it's the breakpoint
1145 ;; Stopped at line 13, routine main(argc=1, argv=0xeffff0e0), file t.c
1149 ;; Frame 21, line 974, routine command_loop(), file keyboard.c
1151 ;; from up/down/where.
1153 (defun gud-dguxdbx-marker-filter (string)
1154 (setq gud-marker-acc (if gud-marker-acc
1155 (concat gud-marker-acc string)
1157 (let ((re (concat "^\\(\\(([0-9]+) \\)?Stopped at\\|Frame [0-9]+,\\)"
1158 " line \\([0-9]+\\), routine .*, file \\([^ \t\n]+\\)"))
1160 ;; Process all complete markers in this chunk.
1161 (while (string-match re gud-marker-acc start)
1162 (setq gud-last-frame
1163 (cons (match-string 4 gud-marker-acc)
1164 (string-to-number (match-string 3 gud-marker-acc)))
1165 start (match-end 0)))
1167 ;; Search for the last incomplete line in this chunk
1168 (while (string-match "\n" gud-marker-acc start)
1169 (setq start (match-end 0)))
1171 ;; If the incomplete line APPEARS to begin with another marker, keep it
1172 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1173 ;; unnecessary concat during the next call.
1174 (setq gud-marker-acc
1175 (if (string-match "Stopped\\|Frame" gud-marker-acc start)
1176 (substring gud-marker-acc (match-beginning 0))
1181 (defun dbx (command-line)
1182 "Run dbx on program FILE in buffer *gud-FILE*.
1183 The directory containing FILE becomes the initial working directory
1184 and source-file directory for your debugger."
1185 (interactive (list (gud-query-cmdline 'dbx)))
1189 (gud-common-init command-line nil 'gud-mipsdbx-marker-filter))
1191 (gud-common-init command-line 'gud-dbx-massage-args
1192 'gud-irixdbx-marker-filter))
1194 (gud-common-init command-line 'gud-dbx-massage-args
1195 'gud-dguxdbx-marker-filter))
1197 (gud-common-init command-line 'gud-dbx-massage-args
1198 'gud-dbx-marker-filter)))
1200 (set (make-local-variable 'gud-minor-mode) 'dbx)
1204 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1205 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1206 (gud-def gud-break "stop at \"%f\":%l"
1207 "\C-b" "Set breakpoint at current line.")
1208 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
1210 (gud-def gud-break "stop at \"%d%f\":%l"
1211 "\C-b" "Set breakpoint at current line.")
1212 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1213 (gud-def gud-up "up %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1214 "<" "Up (numeric arg) stack frames.")
1215 (gud-def gud-down "down %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1216 ">" "Down (numeric arg) stack frames.")
1217 ;; Make dbx give out the source location info that we need.
1218 (process-send-string (get-buffer-process gud-comint-buffer)
1219 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1221 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1222 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1223 (gud-def gud-break "file \"%d%f\"\nstop at %l"
1224 "\C-b" "Set breakpoint at current line.")
1225 (if gud-dbx-use-stopformat-p
1226 (process-send-string (get-buffer-process gud-comint-buffer)
1227 "set $stopformat=1\n"))))
1229 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
1230 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
1231 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
1232 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
1233 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
1234 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
1235 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
1236 (gud-def gud-run "run" nil "Run the program.")
1238 (setq comint-prompt-regexp "^[^)\n]*dbx) *")
1239 (setq paragraph-start comint-prompt-regexp)
1240 (run-hooks 'dbx-mode-hook)
1243 ;; ======================================================================
1244 ;; xdb (HP PARISC debugger) functions
1246 ;; History of argument lists passed to xdb.
1247 (defvar gud-xdb-history nil)
1249 (defcustom gud-xdb-directories nil
1250 "*A list of directories that xdb should search for source code.
1251 If nil, only source files in the program directory
1252 will be known to xdb.
1254 The file names should be absolute, or relative to the directory
1255 containing the executable being debugged."
1256 :type '(choice (const :tag "Current Directory" nil)
1261 (defun gud-xdb-massage-args (file args)
1262 (nconc (let ((directories gud-xdb-directories)
1265 (setq result (cons (car directories) (cons "-d" result)))
1266 (setq directories (cdr directories)))
1270 ;; xdb does not print the lines all at once, so we have to accumulate them
1271 (defun gud-xdb-marker-filter (string)
1273 (if (or (string-match comint-prompt-regexp string)
1274 (string-match ".*\012" string))
1275 (setq result (concat gud-marker-acc string)
1277 (setq gud-marker-acc (concat gud-marker-acc string)))
1279 (if (or (string-match "\\([^\n \t:]+\\): [^:]+: \\([0-9]+\\)[: ]"
1281 (string-match "[^: \t]+:[ \t]+\\([^:]+\\): [^:]+: \\([0-9]+\\):"
1283 (let ((line (string-to-number (match-string 2 result)))
1284 (file (gud-file-name (match-string 1 result))))
1286 (setq gud-last-frame (cons file line))))))
1290 (defun xdb (command-line)
1291 "Run xdb on program FILE in buffer *gud-FILE*.
1292 The directory containing FILE becomes the initial working directory
1293 and source-file directory for your debugger.
1295 You can set the variable `gud-xdb-directories' to a list of program source
1296 directories if your program contains sources from more than one directory."
1297 (interactive (list (gud-query-cmdline 'xdb)))
1299 (gud-common-init command-line 'gud-xdb-massage-args
1300 'gud-xdb-marker-filter)
1301 (set (make-local-variable 'gud-minor-mode) 'xdb)
1303 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
1304 (gud-def gud-tbreak "b %f:%l\\t" "\C-t"
1305 "Set temporary breakpoint at current line.")
1306 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
1307 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
1308 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1309 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1310 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1311 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1312 (gud-def gud-finish "bu\\t" "\C-f" "Finish executing current function.")
1313 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
1315 (setq comint-prompt-regexp "^>")
1316 (setq paragraph-start comint-prompt-regexp)
1317 (run-hooks 'xdb-mode-hook))
1319 ;; ======================================================================
1322 ;; History of argument lists passed to perldb.
1323 (defvar gud-perldb-history nil)
1325 (defun gud-perldb-massage-args (file args)
1326 "Convert a command line as would be typed normally to run perldb
1327 into one that invokes an Emacs-enabled debugging session.
1328 \"-emacs\" is inserted where it will be $ARGV[0] (see perl5db.pl)."
1329 ;; FIXME: what if the command is `make perldb' and doesn't accept those extra
1331 (let* ((new-args nil)
1333 (shift (lambda () (push (pop args) new-args))))
1335 ;; Pass all switches and -e scripts through.
1337 (string-match "^-" (car args))
1338 (not (equal "-" (car args)))
1339 (not (equal "--" (car args))))
1340 (when (equal "-e" (car args))
1341 ;; -e goes with the next arg, so shift one extra.
1343 ;; -e as the last arg is an error in Perl.
1344 (error "No code specified for -e"))
1350 (string-match "^-" (car args)))
1351 (error "Can't use stdin as the script to debug"))
1352 ;; This is the program name.
1355 ;; If -e specified, make sure there is a -- so -emacs is not taken
1357 (if (and args (equal "--" (car args)))
1359 (and seen-e (push "--" new-args)))
1361 (push "-emacs" new-args)
1365 (nreverse new-args)))
1367 ;; There's no guarantee that Emacs will hand the filter the entire
1368 ;; marker at once; it could be broken up across several strings. We
1369 ;; might even receive a big chunk with several markers in it. If we
1370 ;; receive a chunk of text which looks like it might contain the
1371 ;; beginning of a marker, we save it here between calls to the
1373 (defun gud-perldb-marker-filter (string)
1374 (setq gud-marker-acc (concat gud-marker-acc string))
1377 ;; Process all the complete markers in this chunk.
1378 (while (string-match "\032\032\\(\\([a-zA-Z]:\\)?[^:\n]*\\):\\([0-9]*\\):.*\n"
1382 ;; Extract the frame position from the marker.
1384 (cons (match-string 1 gud-marker-acc)
1385 (string-to-number (match-string 3 gud-marker-acc)))
1387 ;; Append any text before the marker to the output we're going
1388 ;; to return - we don't include the marker in this text.
1389 output (concat output
1390 (substring gud-marker-acc 0 (match-beginning 0)))
1392 ;; Set the accumulator to the remaining text.
1393 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1395 ;; Does the remaining text look like it might end with the
1396 ;; beginning of another marker? If it does, then keep it in
1397 ;; gud-marker-acc until we receive the rest of it. Since we
1398 ;; know the full marker regexp above failed, it's pretty simple to
1399 ;; test for marker starts.
1400 (if (string-match "\032.*\\'" gud-marker-acc)
1402 ;; Everything before the potential marker start can be output.
1403 (setq output (concat output (substring gud-marker-acc
1404 0 (match-beginning 0))))
1406 ;; Everything after, we save, to combine with later input.
1407 (setq gud-marker-acc
1408 (substring gud-marker-acc (match-beginning 0))))
1410 (setq output (concat output gud-marker-acc)
1415 (defcustom gud-perldb-command-name "perl -d"
1416 "Default command to execute a Perl script under debugger."
1421 (defun perldb (command-line)
1422 "Run perldb on program FILE in buffer *gud-FILE*.
1423 The directory containing FILE becomes the initial working directory
1424 and source-file directory for your debugger."
1426 (list (gud-query-cmdline 'perldb
1427 (concat (or (buffer-file-name) "-e 0") " "))))
1429 (gud-common-init command-line 'gud-perldb-massage-args
1430 'gud-perldb-marker-filter)
1431 (set (make-local-variable 'gud-minor-mode) 'perldb)
1433 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
1434 (gud-def gud-remove "B %l" "\C-d" "Remove breakpoint at current line")
1435 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
1436 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
1437 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1438 ; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
1439 ; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
1440 ; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
1441 (gud-def gud-print "p %e" "\C-p" "Evaluate perl expression at point.")
1442 (gud-def gud-until "c %l" "\C-u" "Continue to current line.")
1445 (setq comint-prompt-regexp "^ DB<+[0-9]+>+ ")
1446 (setq paragraph-start comint-prompt-regexp)
1447 (run-hooks 'perldb-mode-hook))
1449 ;; ======================================================================
1450 ;; pdb (Python debugger) functions
1452 ;; History of argument lists passed to pdb.
1453 (defvar gud-pdb-history nil)
1455 ;; Last group is for return value, e.g. "> test.py(2)foo()->None"
1456 ;; Either file or function name may be omitted: "> <string>(0)?()"
1457 (defvar gud-pdb-marker-regexp
1458 "^> \\([-a-zA-Z0-9_/.:\\]*\\|<string>\\)(\\([0-9]+\\))\\([a-zA-Z0-9_]*\\|\\?\\)()\\(->[^\n]*\\)?\n")
1459 (defvar gud-pdb-marker-regexp-file-group 1)
1460 (defvar gud-pdb-marker-regexp-line-group 2)
1461 (defvar gud-pdb-marker-regexp-fnname-group 3)
1463 (defvar gud-pdb-marker-regexp-start "^> ")
1465 ;; There's no guarantee that Emacs will hand the filter the entire
1466 ;; marker at once; it could be broken up across several strings. We
1467 ;; might even receive a big chunk with several markers in it. If we
1468 ;; receive a chunk of text which looks like it might contain the
1469 ;; beginning of a marker, we save it here between calls to the
1471 (defun gud-pdb-marker-filter (string)
1472 (setq gud-marker-acc (concat gud-marker-acc string))
1475 ;; Process all the complete markers in this chunk.
1476 (while (string-match gud-pdb-marker-regexp gud-marker-acc)
1479 ;; Extract the frame position from the marker.
1481 (let ((file (match-string gud-pdb-marker-regexp-file-group
1483 (line (string-to-number
1484 (match-string gud-pdb-marker-regexp-line-group
1486 (if (string-equal file "<string>")
1490 ;; Output everything instead of the below
1491 output (concat output (substring gud-marker-acc 0 (match-end 0)))
1492 ;; ;; Append any text before the marker to the output we're going
1493 ;; ;; to return - we don't include the marker in this text.
1494 ;; output (concat output
1495 ;; (substring gud-marker-acc 0 (match-beginning 0)))
1497 ;; Set the accumulator to the remaining text.
1498 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1500 ;; Does the remaining text look like it might end with the
1501 ;; beginning of another marker? If it does, then keep it in
1502 ;; gud-marker-acc until we receive the rest of it. Since we
1503 ;; know the full marker regexp above failed, it's pretty simple to
1504 ;; test for marker starts.
1505 (if (string-match gud-pdb-marker-regexp-start gud-marker-acc)
1507 ;; Everything before the potential marker start can be output.
1508 (setq output (concat output (substring gud-marker-acc
1509 0 (match-beginning 0))))
1511 ;; Everything after, we save, to combine with later input.
1512 (setq gud-marker-acc
1513 (substring gud-marker-acc (match-beginning 0))))
1515 (setq output (concat output gud-marker-acc)
1520 (defcustom gud-pdb-command-name "pdb"
1521 "File name for executing the Python debugger.
1522 This should be an executable on your path, or an absolute file name."
1527 (defun pdb (command-line)
1528 "Run pdb on program FILE in buffer `*gud-FILE*'.
1529 The directory containing FILE becomes the initial working directory
1530 and source-file directory for your debugger."
1532 (list (gud-query-cmdline 'pdb)))
1534 (gud-common-init command-line nil 'gud-pdb-marker-filter)
1535 (set (make-local-variable 'gud-minor-mode) 'pdb)
1537 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
1538 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
1539 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
1540 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
1541 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
1542 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1543 (gud-def gud-up "up" "<" "Up one stack frame.")
1544 (gud-def gud-down "down" ">" "Down one stack frame.")
1545 (gud-def gud-print "p %e" "\C-p" "Evaluate Python expression at point.")
1547 (gud-def gud-statement "! %e" "\C-e" "Execute Python statement at point.")
1549 ;; (setq comint-prompt-regexp "^(.*pdb[+]?) *")
1550 (setq comint-prompt-regexp "^(Pdb) *")
1551 (setq paragraph-start comint-prompt-regexp)
1552 (run-hooks 'pdb-mode-hook))
1554 ;; ======================================================================
1558 ;; AUTHOR: Derek Davies <ddavies@world.std.com>
1559 ;; Zoltan Kemenczy <zoltan@ieee.org;zkemenczy@rim.net>
1561 ;; CREATED: Sun Feb 22 10:46:38 1998 Derek Davies.
1562 ;; UPDATED: Nov 11, 2001 Zoltan Kemenczy
1563 ;; Dec 10, 2002 Zoltan Kemenczy - added nested class support
1565 ;; INVOCATION NOTES:
1567 ;; You invoke jdb-mode with:
1571 ;; It responds with:
1573 ;; Run jdb (like this): jdb
1575 ;; type any jdb switches followed by the name of the class you'd like to debug.
1576 ;; Supply a fully qualfied classname (these do not have the ".class" extension)
1577 ;; for the name of the class to debug (e.g. "COM.the-kind.ddavies.CoolClass").
1578 ;; See the known problems section below for restrictions when specifying jdb
1579 ;; command line switches (search forward for '-classpath').
1581 ;; You should see something like the following:
1583 ;; Current directory is ~/src/java/hello/
1584 ;; Initializing jdb...
1585 ;; 0xed2f6628:class(hello)
1588 ;; To set an initial breakpoint try:
1590 ;; > stop in hello.main
1591 ;; Breakpoint set in hello.main
1594 ;; To execute the program type:
1599 ;; Breakpoint hit: running ...
1600 ;; hello.main (hello:12)
1602 ;; Type M-n to step over the current line and M-s to step into it. That,
1603 ;; along with the JDB 'help' command should get you started. The 'quit'
1604 ;; JDB command will get out out of the debugger. There is some truly
1605 ;; pathetic JDB documentation available at:
1607 ;; http://java.sun.com/products/jdk/1.1/debugging/
1609 ;; KNOWN PROBLEMS AND FIXME's:
1611 ;; Not sure what happens with inner classes ... haven't tried them.
1613 ;; Does not grok UNICODE id's. Only ASCII id's are supported.
1615 ;; You must not put whitespace between "-classpath" and the path to
1616 ;; search for java classes even though it is required when invoking jdb
1617 ;; from the command line. See gud-jdb-massage-args for details.
1618 ;; The same applies for "-sourcepath".
1620 ;; Note: The following applies only if `gud-jdb-use-classpath' is nil;
1621 ;; refer to the documentation of `gud-jdb-use-classpath' and
1622 ;; `gud-jdb-classpath',`gud-jdb-sourcepath' variables for information
1623 ;; on using the classpath for locating java source files.
1625 ;; If any of the source files in the directories listed in
1626 ;; gud-jdb-directories won't parse you'll have problems. Make sure
1627 ;; every file ending in ".java" in these directories parses without error.
1629 ;; All the .java files in the directories in gud-jdb-directories are
1630 ;; syntactically analyzed each time gud jdb is invoked. It would be
1631 ;; nice to keep as much information as possible between runs. It would
1632 ;; be really nice to analyze the files only as neccessary (when the
1633 ;; source needs to be displayed.) I'm not sure to what extent the former
1634 ;; can be accomplished and I'm not sure the latter can be done at all
1635 ;; since I don't know of any general way to tell which .class files are
1636 ;; defined by which .java file without analyzing all the .java files.
1637 ;; If anyone knows why JavaSoft didn't put the source file names in
1638 ;; debuggable .class files please clue me in so I find something else
1639 ;; to be spiteful and bitter about.
1641 ;; ======================================================================
1642 ;; gud jdb variables and functions
1644 (defcustom gud-jdb-command-name "jdb"
1645 "Command that executes the Java debugger."
1649 (defcustom gud-jdb-use-classpath t
1650 "If non-nil, search for Java source files in classpath directories.
1651 The list of directories to search is the value of `gud-jdb-classpath'.
1652 The file pathname is obtained by converting the fully qualified
1653 class information output by jdb to a relative pathname and appending
1654 it to `gud-jdb-classpath' element by element until a match is found.
1656 This method has a significant jdb startup time reduction advantage
1657 since it does not require the scanning of all `gud-jdb-directories'
1658 and parsing all Java files for class information.
1660 Set to nil to use `gud-jdb-directories' to scan java sources for
1661 class information on jdb startup (original method)."
1665 (defvar gud-jdb-classpath nil
1666 "Java/jdb classpath directories list.
1667 If `gud-jdb-use-classpath' is non-nil, gud-jdb derives the `gud-jdb-classpath'
1668 list automatically using the following methods in sequence
1669 \(with subsequent successful steps overriding the results of previous
1672 1) Read the CLASSPATH environment variable,
1673 2) Read any \"-classpath\" argument used to run jdb,
1674 or detected in jdb output (e.g. if jdb is run by a script
1675 that echoes the actual jdb command before starting jdb)
1676 3) Send a \"classpath\" command to jdb and scan jdb output for
1677 classpath information if jdb is invoked with an \"-attach\" (to
1678 an already running VM) argument (This case typically does not
1679 have a \"-classpath\" command line argument - that is provided
1680 to the VM when it is started).
1682 Note that method 3 cannot be used with oldjdb (or Java 1 jdb) since
1683 those debuggers do not support the classpath command. Use 1) or 2).")
1685 (defvar gud-jdb-sourcepath nil
1686 "Directory list provided by an (optional) \"-sourcepath\" option to jdb.
1687 This list is prepended to `gud-jdb-classpath' to form the complete
1688 list of directories searched for source files.")
1690 (defvar gud-marker-acc-max-length 4000
1691 "Maximum number of debugger output characters to keep.
1692 This variable limits the size of `gud-marker-acc' which holds
1693 the most recent debugger output history while searching for
1694 source file information.")
1696 (defvar gud-jdb-history nil
1697 "History of argument lists passed to jdb.")
1700 ;; List of Java source file directories.
1701 (defvar gud-jdb-directories (list ".")
1702 "*A list of directories that gud jdb should search for source code.
1703 The file names should be absolute, or relative to the current
1706 The set of .java files residing in the directories listed are
1707 syntactically analyzed to determine the classes they define and the
1708 packages in which these classes belong. In this way gud jdb maps the
1709 package-qualified class names output by the jdb debugger to the source
1710 file from which the class originated. This allows gud mode to keep
1711 the source code display in sync with the debugging session.")
1713 (defvar gud-jdb-source-files nil
1714 "List of the java source files for this debugging session.")
1716 ;; Association list of fully qualified class names (package + class name)
1717 ;; and their source files.
1718 (defvar gud-jdb-class-source-alist nil
1719 "Association list of fully qualified class names and source files.")
1721 ;; This is used to hold a source file during analysis.
1722 (defvar gud-jdb-analysis-buffer nil)
1724 (defvar gud-jdb-classpath-string nil
1725 "Holds temporary classpath values.")
1727 (defun gud-jdb-build-source-files-list (path extn)
1728 "Return a list of java source files (absolute paths).
1729 PATH gives the directories in which to search for files with
1730 extension EXTN. Normally EXTN is given as the regular expression
1732 (apply 'nconc (mapcar (lambda (d)
1733 (when (file-directory-p d)
1734 (directory-files d t extn nil)))
1737 ;; Move point past whitespace.
1738 (defun gud-jdb-skip-whitespace ()
1739 (skip-chars-forward " \n\r\t\014"))
1741 ;; Move point past a "// <eol>" type of comment.
1742 (defun gud-jdb-skip-single-line-comment ()
1745 ;; Move point past a "/* */" or "/** */" type of comment.
1746 (defun gud-jdb-skip-traditional-or-documentation-comment ()
1750 (if (eq (following-char) ?*)
1754 (if (eq (following-char) ?/)
1757 (throw 'break nil)))))
1760 ;; Move point past any number of consecutive whitespace chars and/or comments.
1761 (defun gud-jdb-skip-whitespace-and-comments ()
1762 (gud-jdb-skip-whitespace)
1767 (gud-jdb-skip-single-line-comment)
1768 (gud-jdb-skip-whitespace))
1769 ((looking-at "/\\*")
1770 (gud-jdb-skip-traditional-or-documentation-comment)
1771 (gud-jdb-skip-whitespace))
1772 (t (throw 'done nil))))))
1774 ;; Move point past things that are id-like. The intent is to skip regular
1775 ;; id's, such as class or interface names as well as package and interface
1777 (defun gud-jdb-skip-id-ish-thing ()
1778 (skip-chars-forward "^ /\n\r\t\014,;{"))
1780 ;; Move point past a string literal.
1781 (defun gud-jdb-skip-string-literal ()
1784 ((eq (following-char) ?\\)
1786 ((eq (following-char) ?\042))))
1790 ;; Move point past a character literal.
1791 (defun gud-jdb-skip-character-literal ()
1795 (if (eq (following-char) ?\\)
1797 (not (eq (following-char) ?\')))
1801 ;; Move point past the following block. There may be (legal) cruft before
1802 ;; the block's opening brace. There must be a block or it's the end of life
1803 ;; in petticoat junction.
1804 (defun gud-jdb-skip-block ()
1806 ;; Find the begining of the block.
1808 (not (eq (following-char) ?{))
1810 ;; Skip any constructs that can harbor literal block delimiter
1811 ;; characters and/or the delimiters for the constructs themselves.
1814 (gud-jdb-skip-single-line-comment))
1815 ((looking-at "/\\*")
1816 (gud-jdb-skip-traditional-or-documentation-comment))
1817 ((eq (following-char) ?\042)
1818 (gud-jdb-skip-string-literal))
1819 ((eq (following-char) ?\')
1820 (gud-jdb-skip-character-literal))
1821 (t (forward-char))))
1823 ;; Now at the begining of the block.
1826 ;; Skip over the body of the block as well as the final brace.
1827 (let ((open-level 1))
1828 (while (not (eq open-level 0))
1831 (gud-jdb-skip-single-line-comment))
1832 ((looking-at "/\\*")
1833 (gud-jdb-skip-traditional-or-documentation-comment))
1834 ((eq (following-char) ?\042)
1835 (gud-jdb-skip-string-literal))
1836 ((eq (following-char) ?\')
1837 (gud-jdb-skip-character-literal))
1838 ((eq (following-char) ?{)
1839 (setq open-level (+ open-level 1))
1841 ((eq (following-char) ?})
1842 (setq open-level (- open-level 1))
1844 (t (forward-char))))))
1846 ;; Find the package and class definitions in Java source file FILE. Assumes
1847 ;; that FILE contains a legal Java program. BUF is a scratch buffer used
1848 ;; to hold the source during analysis.
1849 (defun gud-jdb-analyze-source (buf file)
1852 (insert-file-contents file nil nil nil t)
1857 (gud-jdb-skip-whitespace)
1861 ;; Any number of semi's following a block is legal. Move point
1862 ;; past them. Note that comments and whitespace may be
1863 ;; interspersed as well.
1864 ((eq (following-char) ?\073)
1867 ;; Move point past a single line comment.
1869 (gud-jdb-skip-single-line-comment))
1871 ;; Move point past a traditional or documentation comment.
1872 ((looking-at "/\\*")
1873 (gud-jdb-skip-traditional-or-documentation-comment))
1875 ;; Move point past a package statement, but save the PackageName.
1876 ((looking-at "package")
1878 (gud-jdb-skip-whitespace-and-comments)
1880 (gud-jdb-skip-id-ish-thing)
1881 (setq p (concat (buffer-substring s (point)) "."))
1882 (gud-jdb-skip-whitespace-and-comments)
1883 (if (eq (following-char) ?\073)
1886 ;; Move point past an import statement.
1887 ((looking-at "import")
1889 (gud-jdb-skip-whitespace-and-comments)
1890 (gud-jdb-skip-id-ish-thing)
1891 (gud-jdb-skip-whitespace-and-comments)
1892 (if (eq (following-char) ?\073)
1895 ;; Move point past the various kinds of ClassModifiers.
1896 ((looking-at "public")
1898 ((looking-at "abstract")
1900 ((looking-at "final")
1903 ;; Move point past a ClassDeclaraction, but save the class
1905 ((looking-at "class")
1907 (gud-jdb-skip-whitespace-and-comments)
1909 (gud-jdb-skip-id-ish-thing)
1911 l (nconc l (list (concat p (buffer-substring s (point)))))))
1912 (gud-jdb-skip-block))
1914 ;; Move point past an interface statement.
1915 ((looking-at "interface")
1917 (gud-jdb-skip-block))
1919 ;; Anything else means the input is invalid.
1921 (message "Error parsing file %s." file)
1922 (throw 'abort nil))))))
1925 (defun gud-jdb-build-class-source-alist-for-file (file)
1929 (gud-jdb-analyze-source gud-jdb-analysis-buffer file)))
1931 ;; Return an alist of fully qualified classes and the source files
1932 ;; holding their definitions. SOURCES holds a list of all the source
1933 ;; files to examine.
1934 (defun gud-jdb-build-class-source-alist (sources)
1935 (setq gud-jdb-analysis-buffer (get-buffer-create " *gud-jdb-scratch*"))
1940 'gud-jdb-build-class-source-alist-for-file
1942 (kill-buffer gud-jdb-analysis-buffer)
1943 (setq gud-jdb-analysis-buffer nil)))
1945 ;; Change what was given in the minibuffer to something that can be used to
1946 ;; invoke the debugger.
1947 (defun gud-jdb-massage-args (file args)
1948 ;; The jdb executable must have whitespace between "-classpath" and
1949 ;; its value while gud-common-init expects all switch values to
1950 ;; follow the switch keyword without intervening whitespace. We
1951 ;; require that when the user enters the "-classpath" switch in the
1952 ;; EMACS minibuffer that they do so without the intervening
1953 ;; whitespace. This function adds it back (it's called after
1954 ;; gud-common-init). There are more switches like this (for
1955 ;; instance "-host" and "-password") but I don't care about them
1958 (let (massaged-args user-error)
1960 (while (and args (not user-error))
1962 ((setq user-error (string-match "-classpath$" (car args))))
1963 ((setq user-error (string-match "-sourcepath$" (car args))))
1964 ((string-match "-classpath\\(.+\\)" (car args))
1966 (append massaged-args
1968 (setq gud-jdb-classpath-string
1969 (match-string 1 (car args)))))))
1970 ((string-match "-sourcepath\\(.+\\)" (car args))
1972 (append massaged-args
1974 (setq gud-jdb-sourcepath
1975 (match-string 1 (car args)))))))
1976 (t (setq massaged-args (append massaged-args (list (car args))))))
1977 (setq args (cdr args)))
1979 ;; By this point the current directory is all screwed up. Maybe we
1980 ;; could fix things and re-invoke gud-common-init, but for now I think
1981 ;; issueing the error is good enough.
1984 (kill-buffer (current-buffer))
1985 (error "Error: Omit whitespace between '-classpath or -sourcepath' and its value")))
1988 ;; Search for an association with P, a fully qualified class name, in
1989 ;; gud-jdb-class-source-alist. The asssociation gives the fully
1990 ;; qualified file name of the source file which produced the class.
1991 (defun gud-jdb-find-source-file (p)
1992 (cdr (assoc p gud-jdb-class-source-alist)))
1994 ;; Note: Reset to this value every time a prompt is seen
1995 (defvar gud-jdb-lowest-stack-level 999)
1997 (defun gud-jdb-find-source-using-classpath (p)
1998 "Find source file corresponding to fully qualified class p.
1999 Convert p from jdb's output, converted to a pathname
2000 relative to a classpath directory."
2003 (;; Replace dots with slashes and append ".java" to generate file
2004 ;; name relative to classpath
2007 (mapconcat 'identity
2009 ;; Eliminate any subclass references in the class
2010 ;; name string. These start with a "$"
2012 (if (string-match "$.*" x)
2013 (replace-match "" t t x) p))
2017 (cplist (append gud-jdb-sourcepath gud-jdb-classpath))
2020 (not (setq found-file
2022 (concat (car cplist) "/" filename)))))
2023 (setq cplist (cdr cplist)))
2024 (if found-file (concat (car cplist) "/" filename)))))
2026 (defun gud-jdb-find-source (string)
2027 "Alias for function used to locate source files.
2028 Set to `gud-jdb-find-source-using-classpath' or `gud-jdb-find-source-file'
2029 during jdb initialization depending on the value of
2030 `gud-jdb-use-classpath'."
2033 (defun gud-jdb-parse-classpath-string (string)
2034 "Parse the classpath list and convert each item to an absolute pathname."
2035 (mapcar (lambda (s) (if (string-match "[/\\]$" s)
2036 (replace-match "" nil nil s) s))
2037 (mapcar 'file-truename
2040 (concat "[ \t\n\r,\"" path-separator "]+")))))
2042 ;; See comentary for other debugger's marker filters - there you will find
2043 ;; important notes about STRING.
2044 (defun gud-jdb-marker-filter (string)
2046 ;; Build up the accumulator.
2047 (setq gud-marker-acc
2049 (concat gud-marker-acc string)
2052 ;; Look for classpath information until gud-jdb-classpath-string is found
2053 ;; (interactive, multiple settings of classpath from jdb
2054 ;; not supported/followed)
2055 (if (and gud-jdb-use-classpath
2056 (not gud-jdb-classpath-string)
2057 (or (string-match "classpath:[ \t[]+\\([^]]+\\)" gud-marker-acc)
2058 (string-match "-classpath[ \t\"]+\\([^ \"]+\\)" gud-marker-acc)))
2059 (setq gud-jdb-classpath
2060 (gud-jdb-parse-classpath-string
2061 (setq gud-jdb-classpath-string
2062 (match-string 1 gud-marker-acc)))))
2064 ;; We process STRING from left to right. Each time through the
2065 ;; following loop we process at most one marker. After we've found a
2066 ;; marker, delete gud-marker-acc up to and including the match
2068 ;; Process each complete marker in the input.
2071 ;; Do we see a marker?
2073 ;; jdb puts out a string of the following form when it
2074 ;; hits a breakpoint:
2076 ;; <fully-qualified-class><method> (<class>:<line-number>)
2078 ;; <fully-qualified-class>'s are composed of Java ID's
2079 ;; separated by periods. <method> and <class> are
2080 ;; also Java ID's. <method> begins with a period and
2081 ;; may contain less-than and greater-than (constructors,
2082 ;; for instance, are called <init> in the symbol table.)
2083 ;; Java ID's begin with a letter followed by letters
2084 ;; and/or digits. The set of letters includes underscore
2087 ;; The first group matches <fully-qualified-class>,
2088 ;; the second group matches <class> and the third group
2089 ;; matches <line-number>. We don't care about using
2090 ;; <method> so we don't "group" it.
2092 ;; FIXME: Java ID's are UNICODE strings, this matches ASCII
2095 ;; The ".," in the last square-bracket are necessary because
2096 ;; of Sun's total disrespect for backwards compatibility in
2097 ;; reported line numbers from jdb - starting in 1.4.0 they
2098 ;; print line numbers using LOCALE, inserting a comma or a
2099 ;; period at the thousands positions (how ingenious!).
2101 "\\(\[[0-9]+\] \\)*\\([a-zA-Z0-9.$_]+\\)\\.[a-zA-Z0-9$_<>(),]+ \
2102 \\(([a-zA-Z0-9.$_]+:\\|line=\\)\\([0-9.,]+\\)"
2105 ;; A good marker is one that:
2106 ;; 1) does not have a "[n] " prefix (not part of a stack backtrace)
2107 ;; 2) does have an "[n] " prefix and n is the lowest prefix seen
2108 ;; since the last prompt
2109 ;; Figure out the line on which to position the debugging arrow.
2110 ;; Return the info as a cons of the form:
2112 ;; (<file-name> . <line-number>) .
2113 (if (if (match-beginning 1)
2115 (setq n (string-to-number (substring
2117 (1+ (match-beginning 1))
2118 (- (match-end 1) 2))))
2119 (if (< n gud-jdb-lowest-stack-level)
2120 (progn (setq gud-jdb-lowest-stack-level n) t)))
2122 (if (setq file-found
2123 (gud-jdb-find-source (match-string 2 gud-marker-acc)))
2124 (setq gud-last-frame
2128 ((numstr (match-string 4 gud-marker-acc)))
2129 (if (string-match "[.,]" numstr)
2130 (replace-match "" nil nil numstr)
2132 (message "Could not find source file.")))
2134 ;; Set the accumulator to the remaining text.
2135 (setq gud-marker-acc (substring gud-marker-acc (match-end 0))))
2137 (if (string-match comint-prompt-regexp gud-marker-acc)
2138 (setq gud-jdb-lowest-stack-level 999)))
2140 ;; Do not allow gud-marker-acc to grow without bound. If the source
2141 ;; file information is not within the last 3/4
2142 ;; gud-marker-acc-max-length characters, well,...
2143 (if (> (length gud-marker-acc) gud-marker-acc-max-length)
2144 (setq gud-marker-acc
2145 (substring gud-marker-acc
2146 (- (/ (* gud-marker-acc-max-length 3) 4)))))
2148 ;; We don't filter any debugger output so just return what we were given.
2151 (defvar gud-jdb-command-name "jdb" "Command that executes the Java debugger.")
2154 (defun jdb (command-line)
2155 "Run jdb with command line COMMAND-LINE in a buffer.
2156 The buffer is named \"*gud*\" if no initial class is given or
2157 \"*gud-<initial-class-basename>*\" if there is. If the \"-classpath\"
2158 switch is given, omit all whitespace between it and its value.
2160 See `gud-jdb-use-classpath' and `gud-jdb-classpath' documentation for
2161 information on how jdb accesses source files. Alternatively (if
2162 `gud-jdb-use-classpath' is nil), see `gud-jdb-directories' for the
2163 original source file access method.
2165 For general information about commands available to control jdb from
2166 gud, see `gud-mode'."
2168 (list (gud-query-cmdline 'jdb)))
2169 (setq gud-jdb-classpath nil)
2170 (setq gud-jdb-sourcepath nil)
2172 ;; Set gud-jdb-classpath from the CLASSPATH environment variable,
2173 ;; if CLASSPATH is set.
2174 (setq gud-jdb-classpath-string (getenv "CLASSPATH"))
2175 (if gud-jdb-classpath-string
2176 (setq gud-jdb-classpath
2177 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2178 (setq gud-jdb-classpath-string nil) ; prepare for next
2180 (gud-common-init command-line 'gud-jdb-massage-args
2181 'gud-jdb-marker-filter)
2182 (set (make-local-variable 'gud-minor-mode) 'jdb)
2184 ;; If a -classpath option was provided, set gud-jdb-classpath
2185 (if gud-jdb-classpath-string
2186 (setq gud-jdb-classpath
2187 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2188 (setq gud-jdb-classpath-string nil) ; prepare for next
2189 ;; If a -sourcepath option was provided, parse it
2190 (if gud-jdb-sourcepath
2191 (setq gud-jdb-sourcepath
2192 (gud-jdb-parse-classpath-string gud-jdb-sourcepath)))
2194 (gud-def gud-break "stop at %c:%l" "\C-b" "Set breakpoint at current line.")
2195 (gud-def gud-remove "clear %c:%l" "\C-d" "Remove breakpoint at current line")
2196 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2197 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2198 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
2199 (gud-def gud-finish "step up" "\C-f" "Continue until current method returns.")
2200 (gud-def gud-up "up\C-Mwhere" "<" "Up one stack frame.")
2201 (gud-def gud-down "down\C-Mwhere" ">" "Up one stack frame.")
2202 (gud-def gud-run "run" nil "Run the program.") ;if VM start using jdb
2204 (setq comint-prompt-regexp "^> \\|^[^ ]+\\[[0-9]+\\] ")
2205 (setq paragraph-start comint-prompt-regexp)
2206 (run-hooks 'jdb-mode-hook)
2208 (if gud-jdb-use-classpath
2209 ;; Get the classpath information from the debugger
2211 (if (string-match "-attach" command-line)
2212 (gud-call "classpath"))
2213 (fset 'gud-jdb-find-source
2214 'gud-jdb-find-source-using-classpath))
2216 ;; Else create and bind the class/source association list as well
2217 ;; as the source file list.
2218 (setq gud-jdb-class-source-alist
2219 (gud-jdb-build-class-source-alist
2220 (setq gud-jdb-source-files
2221 (gud-jdb-build-source-files-list gud-jdb-directories
2223 (fset 'gud-jdb-find-source 'gud-jdb-find-source-file)))
2226 ;; ======================================================================
2228 ;; BASHDB support. See http://bashdb.sourceforge.net
2230 ;; AUTHOR: Rocky Bernstein <rocky@panix.com>
2232 ;; CREATED: Sun Nov 10 10:46:38 2002 Rocky Bernstein.
2234 ;; INVOCATION NOTES:
2236 ;; You invoke bashdb-mode with:
2238 ;; M-x bashdb <enter>
2240 ;; It responds with:
2242 ;; Run bashdb (like this): bash
2245 ;; History of argument lists passed to bashdb.
2246 (defvar gud-bashdb-history nil)
2248 ;; Convert a command line as would be typed normally to run a script
2249 ;; into one that invokes an Emacs-enabled debugging session.
2250 ;; "--debugger" in inserted as the first switch.
2252 ;; There's no guarantee that Emacs will hand the filter the entire
2253 ;; marker at once; it could be broken up across several strings. We
2254 ;; might even receive a big chunk with several markers in it. If we
2255 ;; receive a chunk of text which looks like it might contain the
2256 ;; beginning of a marker, we save it here between calls to the
2258 (defun gud-bashdb-marker-filter (string)
2259 (setq gud-marker-acc (concat gud-marker-acc string))
2262 ;; Process all the complete markers in this chunk.
2263 ;; Format of line looks like this:
2264 ;; (/etc/init.d/ntp.init:16):
2265 ;; but we also allow DOS drive letters
2266 ;; (d:/etc/init.d/ntp.init:16):
2267 (while (string-match "\\(^\\|\n\\)(\\(\\([a-zA-Z]:\\)?[^:\n]*\\):\\([0-9]*\\)):.*\n"
2271 ;; Extract the frame position from the marker.
2273 (cons (match-string 2 gud-marker-acc)
2274 (string-to-number (match-string 4 gud-marker-acc)))
2276 ;; Append any text before the marker to the output we're going
2277 ;; to return - we don't include the marker in this text.
2278 output (concat output
2279 (substring gud-marker-acc 0 (match-beginning 0)))
2281 ;; Set the accumulator to the remaining text.
2282 gud-marker-acc (substring gud-marker-acc (match-end 0))))
2284 ;; Does the remaining text look like it might end with the
2285 ;; beginning of another marker? If it does, then keep it in
2286 ;; gud-marker-acc until we receive the rest of it. Since we
2287 ;; know the full marker regexp above failed, it's pretty simple to
2288 ;; test for marker starts.
2289 (if (string-match "\032.*\\'" gud-marker-acc)
2291 ;; Everything before the potential marker start can be output.
2292 (setq output (concat output (substring gud-marker-acc
2293 0 (match-beginning 0))))
2295 ;; Everything after, we save, to combine with later input.
2296 (setq gud-marker-acc
2297 (substring gud-marker-acc (match-beginning 0))))
2299 (setq output (concat output gud-marker-acc)
2304 (defcustom gud-bashdb-command-name "bash --debugger"
2305 "File name for executing bash debugger."
2310 (defun bashdb (command-line)
2311 "Run bashdb on program FILE in buffer *gud-FILE*.
2312 The directory containing FILE becomes the initial working directory
2313 and source-file directory for your debugger."
2315 (list (read-from-minibuffer "Run bashdb (like this): "
2316 (if (consp gud-bashdb-history)
2317 (car gud-bashdb-history)
2318 (concat gud-bashdb-command-name
2320 gud-minibuffer-local-map nil
2321 '(gud-bashdb-history . 1))))
2323 (gud-common-init command-line nil 'gud-bashdb-marker-filter)
2325 (set (make-local-variable 'gud-minor-mode) 'bashdb)
2327 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
2328 (gud-def gud-tbreak "tbreak %l" "\C-t" "Set temporary breakpoint at current line.")
2329 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
2330 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2331 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2332 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
2333 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
2334 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
2335 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
2336 (gud-def gud-print "x %e" "\C-p" "Evaluate BASH expression at point.")
2339 (gud-def gud-statement "eval %e" "\C-e" "Execute BASH statement at point.")
2341 (setq comint-prompt-regexp "^bashdb<+(*[0-9]+)*>+ ")
2342 (setq paragraph-start comint-prompt-regexp)
2343 (run-hooks 'bashdb-mode-hook)
2347 ;; End of debugger-specific information
2351 ;; When we send a command to the debugger via gud-call, it's annoying
2352 ;; to see the command and the new prompt inserted into the debugger's
2353 ;; buffer; we have other ways of knowing the command has completed.
2355 ;; If the buffer looks like this:
2356 ;; --------------------
2357 ;; (gdb) set args foo bar
2359 ;; --------------------
2360 ;; (the -!- marks the location of point), and we type `C-x SPC' in a
2361 ;; source file to set a breakpoint, we want the buffer to end up like
2363 ;; --------------------
2364 ;; (gdb) set args foo bar
2365 ;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
2367 ;; --------------------
2368 ;; Essentially, the old prompt is deleted, and the command's output
2369 ;; and the new prompt take its place.
2371 ;; Not echoing the command is easy enough; you send it directly using
2372 ;; process-send-string, and it never enters the buffer. However,
2373 ;; getting rid of the old prompt is trickier; you don't want to do it
2374 ;; when you send the command, since that will result in an annoying
2375 ;; flicker as the prompt is deleted, redisplay occurs while Emacs
2376 ;; waits for a response from the debugger, and the new prompt is
2377 ;; inserted. Instead, we'll wait until we actually get some output
2378 ;; from the subprocess before we delete the prompt. If the command
2379 ;; produced no output other than a new prompt, that prompt will most
2380 ;; likely be in the first chunk of output received, so we will delete
2381 ;; the prompt and then replace it with an identical one. If the
2382 ;; command produces output, the prompt is moving anyway, so the
2383 ;; flicker won't be annoying.
2385 ;; So - when we want to delete the prompt upon receipt of the next
2386 ;; chunk of debugger output, we position gud-delete-prompt-marker at
2387 ;; the start of the prompt; the process filter will notice this, and
2388 ;; delete all text between it and the process output marker. If
2389 ;; gud-delete-prompt-marker points nowhere, we leave the current
2391 (defvar gud-delete-prompt-marker nil)
2394 (put 'gud-mode 'mode-class 'special)
2396 (define-derived-mode gud-mode comint-mode "Debugger"
2397 "Major mode for interacting with an inferior debugger process.
2399 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
2400 M-x perldb, M-x xdb, or M-x jdb. Each entry point finishes by executing a
2401 hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook',
2402 `perldb-mode-hook', `xdb-mode-hook', or `jdb-mode-hook' respectively.
2404 After startup, the following commands are available in both the GUD
2405 interaction buffer and any source buffer GUD visits due to a breakpoint stop
2408 \\[gud-break] sets a breakpoint at the current file and line. In the
2409 GUD buffer, the current file and line are those of the last breakpoint or
2410 step. In a source buffer, they are the buffer's file and current line.
2412 \\[gud-remove] removes breakpoints on the current file and line.
2414 \\[gud-refresh] displays in the source window the last line referred to
2417 \\[gud-step], \\[gud-next], and \\[gud-stepi] do a step-one-line,
2418 step-one-line (not entering function calls), and step-one-instruction
2419 and then update the source window with the current file and position.
2420 \\[gud-cont] continues execution.
2422 \\[gud-print] tries to find the largest C lvalue or function-call expression
2423 around point, and sends it to the debugger for value display.
2425 The above commands are common to all supported debuggers except xdb which
2426 does not support stepping instructions.
2428 Under gdb, sdb and xdb, \\[gud-tbreak] behaves exactly like \\[gud-break],
2429 except that the breakpoint is temporary; that is, it is removed when
2430 execution stops on it.
2432 Under gdb, dbx, and xdb, \\[gud-up] pops up through an enclosing stack
2433 frame. \\[gud-down] drops back down through one.
2435 If you are using gdb or xdb, \\[gud-finish] runs execution to the return from
2436 the current function and stops.
2438 All the keystrokes above are accessible in the GUD buffer
2439 with the prefix C-c, and in all buffers through the prefix C-x C-a.
2441 All pre-defined functions for which the concept make sense repeat
2442 themselves the appropriate number of times if you give a prefix
2445 You may use the `gud-def' macro in the initialization hook to define other
2448 Other commands for interacting with the debugger process are inherited from
2449 comint mode, which see."
2450 (setq mode-line-process '(":%s"))
2451 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
2452 (set (make-local-variable 'gud-last-frame) nil)
2453 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
2454 (make-local-variable 'comint-prompt-regexp)
2455 ;; Don't put repeated commands in command history many times.
2456 (set (make-local-variable 'comint-input-ignoredups) t)
2457 (make-local-variable 'paragraph-start)
2458 (set (make-local-variable 'gud-delete-prompt-marker) (make-marker))
2459 (add-hook 'kill-buffer-hook 'gud-kill-buffer-hook nil t))
2461 ;; Cause our buffers to be displayed, by default,
2462 ;; in the selected window.
2463 ;;;###autoload (add-hook 'same-window-regexps "\\*gud-.*\\*\\(\\|<[0-9]+>\\)")
2465 (defcustom gud-chdir-before-run t
2466 "Non-nil if GUD should `cd' to the debugged executable."
2470 (defvar gud-target-name "--unknown--"
2471 "The apparent name of the program being debugged in a gud buffer.")
2473 ;; Perform initializations common to all debuggers.
2474 ;; The first arg is the specified command line,
2475 ;; which starts with the program to debug.
2476 ;; The other three args specify the values to use
2477 ;; for local variables in the debugger buffer.
2478 (defun gud-common-init (command-line massage-args marker-filter
2479 &optional find-file)
2480 (let* ((words (split-string command-line))
2481 (program (car words))
2482 (dir default-directory)
2483 ;; Extract the file name from WORDS
2484 ;; and put t in its place.
2485 ;; Later on we will put the modified file name arg back there.
2486 (file-word (let ((w (cdr words)))
2487 (while (and w (= ?- (aref (car w) 0)))
2493 (and file-word (substitute-in-file-name file-word)))
2495 ;; If a directory was specified, expand the file name.
2496 ;; Otherwise, don't expand it, so GDB can use the PATH.
2497 ;; A file name without directory is literally valid
2498 ;; only if the file exists in ., and in that case,
2499 ;; omitting the expansion here has no visible effect.
2500 (file (and file-word
2501 (if (file-name-directory file-subst)
2502 (expand-file-name file-subst)
2504 (filepart (and file-word (concat "-" (file-name-nondirectory file))))
2505 (existing-buffer (get-buffer (concat "*gud" filepart "*"))))
2506 (pop-to-buffer (concat "*gud" filepart "*"))
2507 (when (and existing-buffer (get-buffer-process existing-buffer))
2508 (error "This program is already running under gdb"))
2509 ;; Set the dir, in case the buffer already existed with a different dir.
2510 (setq default-directory dir)
2511 ;; Set default-directory to the file's directory.
2513 gud-chdir-before-run
2514 ;; Don't set default-directory if no directory was specified.
2515 ;; In that case, either the file is found in the current directory,
2516 ;; in which case this setq is a no-op,
2517 ;; or it is found by searching PATH,
2518 ;; in which case we don't know what directory it was found in.
2519 (file-name-directory file)
2520 (setq default-directory (file-name-directory file)))
2521 (or (bolp) (newline))
2522 (insert "Current directory is " default-directory "\n")
2523 ;; Put the substituted and expanded file name back in its place.
2525 (while (and w (not (eq (car w) t)))
2529 (apply 'make-comint (concat "gud" filepart) program nil
2530 (if massage-args (funcall massage-args file args) args))
2531 ;; Since comint clobbered the mode, we don't set it until now.
2533 (set (make-local-variable 'gud-target-name)
2534 (and file-word (file-name-nondirectory file))))
2535 (set (make-local-variable 'gud-marker-filter) marker-filter)
2536 (if find-file (set (make-local-variable 'gud-find-file) find-file))
2537 (setq gud-running nil)
2538 (setq gud-last-last-frame nil)
2540 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
2541 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
2544 (defun gud-set-buffer ()
2545 (when (eq major-mode 'gud-mode)
2546 (setq gud-comint-buffer (current-buffer))))
2548 (defvar gud-filter-defer-flag nil
2549 "Non-nil means don't process anything from the debugger right now.
2550 It is saved for when this flag is not set.")
2552 ;; These functions are responsible for inserting output from your debugger
2553 ;; into the buffer. The hard work is done by the method that is
2554 ;; the value of gud-marker-filter.
2556 (defun gud-filter (proc string)
2557 ;; Here's where the actual buffer insertion is done
2558 (let (output process-window)
2559 (if (buffer-name (process-buffer proc))
2560 (if gud-filter-defer-flag
2561 ;; If we can't process any text now,
2562 ;; save it for later.
2563 (setq gud-filter-pending-text
2564 (concat (or gud-filter-pending-text "") string))
2566 ;; If we have to ask a question during the processing,
2567 ;; defer any additional text that comes from the debugger
2568 ;; during that time.
2569 (let ((gud-filter-defer-flag t))
2570 ;; Process now any text we previously saved up.
2571 (if gud-filter-pending-text
2572 (setq string (concat gud-filter-pending-text string)
2573 gud-filter-pending-text nil))
2575 (with-current-buffer (process-buffer proc)
2576 ;; If we have been so requested, delete the debugger prompt.
2579 (if (marker-buffer gud-delete-prompt-marker)
2580 (let ((inhibit-read-only t))
2581 (delete-region (process-mark proc)
2582 gud-delete-prompt-marker)
2583 (comint-update-fence)
2584 (set-marker gud-delete-prompt-marker nil)))
2585 ;; Save the process output, checking for source file markers.
2586 (setq output (gud-marker-filter string))
2587 ;; Check for a filename-and-line number.
2588 ;; Don't display the specified file
2589 ;; unless (1) point is at or after the position where output appears
2590 ;; and (2) this buffer is on the screen.
2591 (setq process-window
2593 (>= (point) (process-mark proc))
2594 (get-buffer-window (current-buffer)))))
2596 ;; Let the comint filter do the actual insertion.
2597 ;; That lets us inherit various comint features.
2598 (comint-output-filter proc output))
2600 ;; Put the arrow on the source line.
2601 ;; This must be outside of the save-excursion
2602 ;; in case the source file is our current buffer.
2604 (with-selected-window process-window
2605 (gud-display-frame))
2606 ;; We have to be in the proper buffer, (process-buffer proc),
2607 ;; but not in a save-excursion, because that would restore point.
2608 (with-current-buffer (process-buffer proc)
2609 (gud-display-frame))))
2611 ;; If we deferred text that arrived during this processing,
2613 (if gud-filter-pending-text
2614 (gud-filter proc ""))))))
2616 (defvar gud-minor-mode-type nil)
2617 (defvar gud-overlay-arrow-position nil)
2618 (add-to-list 'overlay-arrow-variable-list 'gud-overlay-arrow-position)
2620 (defun gud-sentinel (proc msg)
2621 (cond ((null (buffer-name (process-buffer proc)))
2623 ;; Stop displaying an arrow in a source file.
2624 (setq gud-overlay-arrow-position nil)
2625 (set-process-buffer proc nil)
2626 (if (and (boundp 'speedbar-frame)
2627 (string-equal speedbar-initial-expansion-list-name "GUD"))
2628 (speedbar-change-initial-expansion-list
2629 speedbar-previously-used-expansion-list-name))
2630 (if (memq gud-minor-mode-type '(gdbmi gdba))
2633 ((memq (process-status proc) '(signal exit))
2634 ;; Stop displaying an arrow in a source file.
2635 (setq gud-overlay-arrow-position nil)
2636 (with-current-buffer gud-comint-buffer
2637 (if (memq gud-minor-mode-type '(gdbmi gdba))
2640 (let* ((obuf (current-buffer)))
2641 ;; save-excursion isn't the right thing if
2642 ;; process-buffer is current-buffer
2645 ;; Write something in *compilation* and hack its mode line,
2646 (set-buffer (process-buffer proc))
2647 ;; Fix the mode line.
2648 (setq mode-line-process
2650 (symbol-name (process-status proc))))
2651 (force-mode-line-update)
2653 (insert ?\n mode-name " " msg)
2655 (goto-char (point-max))
2656 (insert ?\n mode-name " " msg)))
2657 ;; If buffer and mode line will show that the process
2658 ;; is dead, we can delete it now. Otherwise it
2659 ;; will stay around until M-x list-processes.
2660 (delete-process proc))
2661 ;; Restore old buffer, but don't restore old point
2662 ;; if obuf is the gud buffer.
2663 (set-buffer obuf))))))
2665 (defun gud-kill-buffer-hook ()
2666 (setq gud-minor-mode-type gud-minor-mode)
2668 (kill-process (get-buffer-process (current-buffer)))
2672 (dolist (buffer (buffer-list))
2673 (unless (eq buffer gud-comint-buffer)
2674 (with-current-buffer buffer
2675 (when gud-minor-mode
2676 (setq gud-minor-mode nil)
2677 (kill-local-variable 'tool-bar-map))))))
2679 (defun gud-display-frame ()
2680 "Find and obey the last filename-and-line marker from the debugger.
2681 Obeying it means displaying in another window the specified file and line."
2683 (when gud-last-frame
2685 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
2686 (setq gud-last-last-frame gud-last-frame
2687 gud-last-frame nil)))
2689 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
2690 ;; and that its line LINE is visible.
2691 ;; Put the overlay-arrow on the line LINE in that buffer.
2692 ;; Most of the trickiness in here comes from wanting to preserve the current
2693 ;; region-restriction if that's possible. We use an explicit display-buffer
2694 ;; to get around the fact that this is called inside a save-excursion.
2696 (defun gud-display-line (true-file line)
2697 (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
2699 (with-current-buffer gud-comint-buffer
2700 (gud-find-file true-file)))
2701 (window (and buffer (or (get-buffer-window buffer)
2702 (display-buffer buffer))))
2706 (with-current-buffer buffer
2707 (unless (or (verify-visited-file-modtime buffer) gud-keep-buffer)
2709 (format "File %s changed on disk. Reread from disk? "
2712 (setq gud-keep-buffer t)))
2717 (or gud-overlay-arrow-position
2718 (setq gud-overlay-arrow-position (make-marker)))
2719 (set-marker gud-overlay-arrow-position (point) (current-buffer)))
2720 (cond ((or (< pos (point-min)) (> pos (point-max)))
2723 (if window (set-window-point window gud-overlay-arrow-position))))))
2725 ;; The gud-call function must do the right thing whether its invoking
2726 ;; keystroke is from the GUD buffer itself (via major-mode binding)
2727 ;; or a C buffer. In the former case, we want to supply data from
2728 ;; gud-last-frame. Here's how we do it:
2730 (defun gud-format-command (str arg)
2731 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
2732 (frame (or gud-last-frame gud-last-last-frame))
2734 (while (and str (string-match "\\([^%]*\\)%\\([adeflpc]\\)" str))
2735 (let ((key (string-to-char (match-string 2 str)))
2739 (setq subst (file-name-nondirectory (if insource
2743 (setq subst (file-name-sans-extension
2744 (file-name-nondirectory (if insource
2748 (setq subst (file-name-directory (if insource
2752 (setq subst (int-to-string
2756 (+ (count-lines (point-min) (point))
2760 (setq subst (gud-find-expr)))
2762 (setq subst (gud-read-address)))
2772 (+ (count-lines (point-min) (point))
2776 (setq subst (if arg (int-to-string arg)))))
2777 (setq result (concat result (match-string 1 str) subst)))
2778 (setq str (substring str (match-end 2))))
2779 ;; There might be text left in STR when the loop ends.
2780 (concat result str)))
2782 (defun gud-read-address ()
2783 "Return a string containing the core-address found in the buffer at point."
2786 (let ((pt (point)) found begin)
2787 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
2789 (found (forward-char 2)
2790 (buffer-substring found
2791 (progn (re-search-forward "[^0-9a-f]")
2794 (t (setq begin (progn (re-search-backward "[^0-9]")
2798 (re-search-forward "[^0-9]")
2800 (buffer-substring begin (point))))))))
2802 (defun gud-call (fmt &optional arg)
2803 (let ((msg (gud-format-command fmt arg)))
2804 (message "Command: %s" msg)
2806 (gud-basic-call msg)))
2808 (defun gud-basic-call (command)
2809 "Invoke the debugger COMMAND displaying source in other window."
2812 (let ((proc (get-buffer-process gud-comint-buffer)))
2813 (or proc (error "Current buffer has no process"))
2814 ;; Arrange for the current prompt to get deleted.
2816 (set-buffer gud-comint-buffer)
2819 (goto-char (process-mark proc))
2821 (if (looking-at comint-prompt-regexp)
2822 (set-marker gud-delete-prompt-marker (point)))
2823 (if (memq gud-minor-mode '(gdbmi gdba))
2824 (apply comint-input-sender (list proc command))
2825 (process-send-string proc (concat command "\n")))))))
2827 (defun gud-refresh (&optional arg)
2828 "Fix up a possibly garbled display, and redraw the arrow."
2830 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
2834 ;; Code for parsing expressions out of C or Fortran code. The single entry
2835 ;; point is gud-find-expr, which tries to return an lvalue expression from
2838 (defvar gud-find-expr-function 'gud-find-c-expr)
2840 (defun gud-find-expr (&rest args)
2841 (apply gud-find-expr-function args))
2843 ;; The next eight functions are hacked from gdbsrc.el by
2844 ;; Debby Ayers <ayers@asc.slb.com>,
2845 ;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
2847 (defun gud-find-c-expr ()
2848 "Returns the expr that surrounds point."
2852 (expr (gud-innermost-expr))
2853 (test-expr (gud-prev-expr)))
2854 (while (and test-expr (gud-expr-compound test-expr expr))
2855 (let ((prev-expr expr))
2856 (setq expr (cons (car test-expr) (cdr expr)))
2857 (goto-char (car expr))
2858 (setq test-expr (gud-prev-expr))
2859 ;; If we just pasted on the condition of an if or while,
2860 ;; throw it away again.
2861 (if (member (buffer-substring (car test-expr) (cdr test-expr))
2862 '("if" "while" "for"))
2866 (setq test-expr (gud-next-expr))
2867 (while (gud-expr-compound expr test-expr)
2868 (setq expr (cons (car expr) (cdr test-expr)))
2869 (setq test-expr (gud-next-expr)))
2870 (buffer-substring (car expr) (cdr expr)))))
2872 (defun gud-innermost-expr ()
2873 "Returns the smallest expr that point is in; move point to beginning of it.
2874 The expr is represented as a cons cell, where the car specifies the point in
2875 the current buffer that marks the beginning of the expr and the cdr specifies
2876 the character after the end of the expr."
2877 (let ((p (point)) begin end)
2879 (setq begin (point))
2892 (defun gud-backward-sexp ()
2893 "Version of `backward-sexp' that catches errors."
2898 (defun gud-forward-sexp ()
2899 "Version of `forward-sexp' that catches errors."
2904 (defun gud-prev-expr ()
2905 "Returns the previous expr, point is set to beginning of that expr.
2906 The expr is represented as a cons cell, where the car specifies the point in
2907 the current buffer that marks the beginning of the expr and the cdr specifies
2908 the character after the end of the expr"
2909 (let ((begin) (end))
2911 (setq begin (point))
2917 (defun gud-next-expr ()
2918 "Returns the following expr, point is set to beginning of that expr.
2919 The expr is represented as a cons cell, where the car specifies the point in
2920 the current buffer that marks the beginning of the expr and the cdr specifies
2921 the character after the end of the expr."
2922 (let ((begin) (end))
2927 (setq begin (point))
2930 (defun gud-expr-compound-sep (span-start span-end)
2931 "Scan from SPAN-START to SPAN-END for punctuation characters.
2932 If `->' is found, return `?.'. If `.' is found, return `?.'.
2933 If any other punctuation is found, return `??'.
2934 If no punctuation is found, return `? '."
2937 (while (< span-start span-end)
2938 (setq syntax (char-syntax (char-after span-start)))
2941 ((= syntax ?.) (setq syntax (char-after span-start))
2943 ((= syntax ?.) (setq result ?.))
2944 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
2946 (setq span-start (+ span-start 1)))
2947 (t (setq span-start span-end)
2948 (setq result ??)))))
2949 (setq span-start (+ span-start 1)))
2952 (defun gud-expr-compound (first second)
2953 "Non-nil if concatenating FIRST and SECOND makes a single C expression.
2954 The two exprs are represented as a cons cells, where the car
2955 specifies the point in the current buffer that marks the beginning of the
2956 expr and the cdr specifies the character after the end of the expr.
2957 Link exprs of the form:
2964 (let ((span-start (cdr first))
2965 (span-end (car second))
2967 (setq syntax (gud-expr-compound-sep span-start span-end))
2969 ((= (car first) (car second)) nil)
2970 ((= (cdr first) (cdr second)) nil)
2973 (setq span-start (char-after (- span-start 1)))
2974 (setq span-end (char-after span-end))
2976 ((= span-start ?)) t)
2977 ((= span-start ?]) t)
2983 (defun gud-find-class (f line)
2984 "Find fully qualified class in file F at line LINE.
2985 This function uses the `gud-jdb-classpath' (and optional
2986 `gud-jdb-sourcepath') list(s) to derive a file
2987 pathname relative to its classpath directory. The values in
2988 `gud-jdb-classpath' are assumed to have been converted to absolute
2989 pathname standards using file-truename.
2990 If F is visited by a buffer and its mode is CC-mode(Java),
2991 syntactic information of LINE is used to find the enclosing (nested)
2992 class string which is appended to the top level
2993 class of the file (using s to separate nested class ids)."
2994 ;; Convert f to a standard representation and remove suffix
2995 (if (and gud-jdb-use-classpath (or gud-jdb-classpath gud-jdb-sourcepath))
2997 (let ((cplist (append gud-jdb-sourcepath gud-jdb-classpath))
2998 (fbuffer (get-file-buffer f))
2999 syntax-symbol syntax-point class-found)
3000 (setq f (file-name-sans-extension (file-truename f)))
3001 ;; Syntax-symbol returns the symbol of the *first* element
3002 ;; in the syntactical analysis result list, syntax-point
3003 ;; returns the buffer position of same
3004 (fset 'syntax-symbol (lambda (x) (c-langelem-sym (car x))))
3005 (fset 'syntax-point (lambda (x) (c-langelem-pos (car x))))
3006 ;; Search through classpath list for an entry that is
3008 (while (and cplist (not class-found))
3009 (if (string-match (car cplist) f)
3011 (mapconcat 'identity
3013 (substring f (+ (match-end 0) 1))
3015 (setq cplist (cdr cplist)))
3016 ;; if f is visited by a java(cc-mode) buffer, walk up the
3017 ;; syntactic information chain and collect any 'inclass
3018 ;; symbols until 'topmost-intro is reached to find out if
3019 ;; point is within a nested class
3020 (if (and fbuffer (equal (symbol-file 'java-mode) "cc-mode"))
3022 (set-buffer fbuffer)
3023 (let ((nclass) (syntax))
3024 ;; While the c-syntactic information does not start
3025 ;; with the 'topmost-intro symbol, there may be
3026 ;; nested classes...
3027 (while (not (eq 'topmost-intro
3028 (syntax-symbol (c-guess-basic-syntax))))
3029 ;; Check if the current position c-syntactic
3030 ;; analysis has 'inclass
3031 (setq syntax (c-guess-basic-syntax))
3033 (and (not (eq 'inclass (syntax-symbol syntax)))
3035 (setq syntax (cdr syntax)))
3036 (if (eq 'inclass (syntax-symbol syntax))
3038 (goto-char (syntax-point syntax))
3039 ;; Now we're at the beginning of a class
3040 ;; definition. Find class name
3042 "[A-Za-z0-9 \t\n]*?class[ \t\n]+\\([^ \t\n]+\\)")
3044 (append (list (match-string-no-properties 1))
3046 (setq syntax (c-guess-basic-syntax))
3047 (while (and (not (syntax-point syntax)) (cdr syntax))
3048 (setq syntax (cdr syntax)))
3049 (goto-char (syntax-point syntax))
3051 (string-match (concat (car nclass) "$") class-found)
3053 (replace-match (mapconcat 'identity nclass "$")
3054 t t class-found)))))
3055 (if (not class-found)
3056 (message "gud-find-class: class for file %s not found!" f))
3058 ;; Not using classpath - try class/source association list
3059 (let ((class-found (rassoc f gud-jdb-class-source-alist)))
3062 (message "gud-find-class: class for file %s not found in gud-jdb-class-source-alist!" f)
3066 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3067 ;;; GDB script mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3068 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3070 (defvar gdb-script-mode-syntax-table
3071 (let ((st (make-syntax-table)))
3072 (modify-syntax-entry ?' "\"" st)
3073 (modify-syntax-entry ?# "<" st)
3074 (modify-syntax-entry ?\n ">" st)
3077 (defvar gdb-script-font-lock-keywords
3078 '(("^define\\s-+\\(\\(\\w\\|\\s_\\)+\\)" (1 font-lock-function-name-face))
3079 ("\\$\\(\\w+\\)" (1 font-lock-variable-name-face))
3080 ("^\\s-*\\([a-z]+\\)" (1 font-lock-keyword-face))))
3082 (defvar gdb-script-font-lock-syntactic-keywords
3083 '(("^document\\s-.*\\(\n\\)" (1 "< b"))
3084 ;; It would be best to change the \n in front, but it's more difficult.
3085 ("^en\\(d\\)\\>" (1 "> b"))))
3087 (defun gdb-script-font-lock-syntactic-face (state)
3089 ((nth 3 state) font-lock-string-face)
3090 ((nth 7 state) font-lock-doc-face)
3091 (t font-lock-comment-face)))
3093 (defvar gdb-script-basic-indent 2)
3095 (defun gdb-script-skip-to-head ()
3096 "We're just in front of an `end' and we need to go to its head."
3097 (while (and (re-search-backward "^\\s-*\\(\\(end\\)\\|define\\|document\\|if\\|while\\)\\>" nil 'move)
3099 (gdb-script-skip-to-head)))
3101 (defun gdb-script-calculate-indentation ()
3103 ((looking-at "end\\>")
3104 (gdb-script-skip-to-head)
3105 (current-indentation))
3106 ((looking-at "else\\>")
3107 (while (and (re-search-backward "^\\s-*\\(if\\|\\(end\\)\\)\\>" nil 'move)
3109 (gdb-script-skip-to-head))
3110 (current-indentation))
3112 (forward-comment (- (point-max)))
3114 (skip-chars-forward " \t")
3115 (+ (current-indentation)
3116 (if (looking-at "\\(if\\|while\\|define\\|else\\)\\>")
3117 gdb-script-basic-indent 0)))))
3119 (defun gdb-script-indent-line ()
3120 "Indent current line of GDB script."
3122 (if (and (eq (get-text-property (point) 'face) font-lock-doc-face)
3125 (skip-chars-forward " \t")
3126 (not (looking-at "end\\>"))))
3128 (let* ((savep (point))
3129 (indent (condition-case nil
3132 (skip-chars-forward " \t")
3133 (if (>= (point) savep) (setq savep nil))
3134 (max (gdb-script-calculate-indentation) 0))
3137 (save-excursion (indent-line-to indent))
3138 (indent-line-to indent)))))
3140 ;; Derived from cfengine.el.
3141 (defun gdb-script-beginning-of-defun ()
3142 "`beginning-of-defun' function for Gdb script mode.
3143 Treats actions as defuns."
3144 (unless (<= (current-column) (current-indentation))
3146 (if (re-search-backward "^define \\|^document " nil t)
3148 (goto-char (point-min)))
3151 ;; Derived from cfengine.el.
3152 (defun gdb-script-end-of-defun ()
3153 "`end-of-defun' function for Gdb script mode.
3154 Treats actions as defuns."
3156 (if (re-search-forward "^end" nil t)
3158 (goto-char (point-max)))
3162 (add-to-list 'auto-mode-alist '("/\\.gdbinit" . gdb-script-mode))
3165 (define-derived-mode gdb-script-mode nil "GDB-Script"
3166 "Major mode for editing GDB scripts"
3167 (set (make-local-variable 'comment-start) "#")
3168 (set (make-local-variable 'comment-start-skip) "#+\\s-*")
3169 (set (make-local-variable 'outline-regexp) "[ \t]")
3170 (set (make-local-variable 'imenu-generic-expression)
3171 '((nil "^define[ \t]+\\(\\w+\\)" 1)))
3172 (set (make-local-variable 'indent-line-function) 'gdb-script-indent-line)
3173 (set (make-local-variable 'beginning-of-defun-function)
3174 #'gdb-script-beginning-of-defun)
3175 (set (make-local-variable 'end-of-defun-function)
3176 #'gdb-script-end-of-defun)
3177 (set (make-local-variable 'font-lock-defaults)
3178 '(gdb-script-font-lock-keywords nil nil ((?_ . "w")) nil
3179 (font-lock-syntactic-keywords
3180 . gdb-script-font-lock-syntactic-keywords)
3181 (font-lock-syntactic-face-function
3182 . gdb-script-font-lock-syntactic-face))))
3185 ;;; tooltips for GUD
3187 ;;; Customizable settings
3188 (defcustom gud-tooltip-modes '(gud-mode c-mode c++-mode fortran-mode)
3189 "List of modes for which to enable GUD tips."
3194 (defcustom gud-tooltip-display
3195 '((eq (tooltip-event-buffer gud-tooltip-event)
3196 (marker-buffer gud-overlay-arrow-position)))
3197 "List of forms determining where GUD tooltips are displayed.
3199 Forms in the list are combined with AND. The default is to display
3200 only tooltips in the buffer containing the overlay arrow."
3202 :tag "GUD buffers predicate"
3205 (defcustom gud-tooltip-echo-area nil
3206 "Use the echo area instead of frames for GUD tooltips."
3208 :tag "Use echo area"
3211 (define-obsolete-variable-alias 'tooltip-gud-modes
3212 'gud-tooltip-modes "22.1")
3213 (define-obsolete-variable-alias 'tooltip-gud-display
3214 'gud-tooltip-display "22.1")
3216 ;;; Reacting on mouse movements
3218 (defun gud-tooltip-change-major-mode ()
3219 "Function added to `change-major-mode-hook' when tooltip mode is on."
3220 (add-hook 'post-command-hook 'gud-tooltip-activate-mouse-motions-if-enabled))
3222 (defun gud-tooltip-activate-mouse-motions-if-enabled ()
3223 "Reconsider for all buffers whether mouse motion events are desired."
3224 (remove-hook 'post-command-hook
3225 'gud-tooltip-activate-mouse-motions-if-enabled)
3226 (dolist (buffer (buffer-list))
3229 (if (and gud-tooltip-mode
3230 (memq major-mode gud-tooltip-modes))
3231 (gud-tooltip-activate-mouse-motions t)
3232 (gud-tooltip-activate-mouse-motions nil)))))
3234 (defvar gud-tooltip-mouse-motions-active nil
3235 "Locally t in a buffer if tooltip processing of mouse motion is enabled.")
3237 (defun gud-tooltip-activate-mouse-motions (activatep)
3238 "Activate/deactivate mouse motion events for the current buffer.
3239 ACTIVATEP non-nil means activate mouse motion events."
3242 (make-local-variable 'gud-tooltip-mouse-motions-active)
3243 (setq gud-tooltip-mouse-motions-active t)
3244 (make-local-variable 'track-mouse)
3245 (setq track-mouse t))
3246 (when gud-tooltip-mouse-motions-active
3247 (kill-local-variable 'gud-tooltip-mouse-motions-active)
3248 (kill-local-variable 'track-mouse))))
3250 (defun gud-tooltip-mouse-motion (event)
3251 "Command handler for mouse movement events in `global-map'."
3254 (when (car (mouse-pixel-position))
3255 (setq tooltip-last-mouse-motion-event (copy-sequence event))
3256 (tooltip-start-delayed-tip)))
3260 (defvar gud-tooltip-original-filter nil
3261 "Process filter to restore after GUD output has been received.")
3263 (defvar gud-tooltip-dereference nil
3264 "Non-nil means print expressions with a `*' in front of them.
3265 For C this would dereference a pointer expression.")
3267 (defvar gud-tooltip-event nil
3268 "The mouse movement event that led to a tooltip display.
3269 This event can be examined by forms in GUD-TOOLTIP-DISPLAY.")
3271 (defun toggle-gud-tooltip-dereference ()
3272 "Toggle whether tooltips should show `* expr' or `expr'."
3274 (setq gud-tooltip-dereference (not gud-tooltip-dereference))
3275 (when (interactive-p)
3276 (message "Dereferencing is now %s."
3277 (if gud-tooltip-dereference "on" "off"))))
3279 (define-obsolete-function-alias 'tooltip-gud-toggle-dereference
3280 'toggle-gud-tooltip-dereference "22.1")
3283 (define-minor-mode gud-tooltip-mode
3284 "Toggle the display of GUD tooltips."
3288 (if gud-tooltip-mode
3290 (add-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3291 (add-hook 'pre-command-hook 'tooltip-hide)
3292 (add-hook 'tooltip-hook 'gud-tooltip-tips)
3293 (define-key global-map [mouse-movement] 'gud-tooltip-mouse-motion))
3294 (unless tooltip-mode (remove-hook 'pre-command-hook 'tooltip-hide)
3295 (remove-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3296 (remove-hook 'tooltip-hook 'gud-tooltip-tips)
3297 (define-key global-map [mouse-movement] 'ignore)))
3298 (gud-tooltip-activate-mouse-motions-if-enabled)
3301 (buffer-name gud-comint-buffer); gud-comint-buffer might be kille
3302 (with-current-buffer gud-comint-buffer
3303 (memq gud-minor-mode '(gdbmi gdba))))
3304 (if gud-tooltip-mode
3306 (dolist (buffer (buffer-list))
3307 (unless (eq buffer gud-comint-buffer)
3308 (with-current-buffer buffer
3309 (when (and (memq gud-minor-mode '(gdbmi gdba))
3310 (not (string-match "\\`\\*.+\\*\\'"
3312 (make-local-variable 'gdb-define-alist)
3313 (gdb-create-define-alist)
3314 (add-hook 'after-save-hook
3315 'gdb-create-define-alist nil t))))))
3316 (kill-local-variable 'gdb-define-alist)
3317 (remove-hook 'after-save-hook 'gdb-create-define-alist t))))
3319 ; This will only display data that comes in one chunk.
3320 ; Larger arrays (say 400 elements) are displayed in
3321 ; the tooltip incompletely and spill over into the gud buffer.
3322 ; Switching the process-filter creates timing problems and
3323 ; it may be difficult to do better. Using annotations as in
3324 ; gdb-ui.el gets round this problem.
3325 (defun gud-tooltip-process-output (process output)
3326 "Process debugger output and show it in a tooltip window."
3327 (set-process-filter process gud-tooltip-original-filter)
3328 (tooltip-show (tooltip-strip-prompt process output)
3329 (or gud-tooltip-echo-area tooltip-use-echo-area)))
3331 (defun gud-tooltip-print-command (expr)
3332 "Return a suitable command to print the expression EXPR.
3333 If GUD-TOOLTIP-DEREFERENCE is t, also prepend a `*' to EXPR."
3334 (when gud-tooltip-dereference
3335 (setq expr (concat "*" expr)))
3336 (case gud-minor-mode
3337 (gdba (concat "server print " expr))
3338 ((dbx gdbmi) (concat "print " expr))
3339 (xdb (concat "p " expr))
3340 (sdb (concat expr "/"))
3343 (defun gud-tooltip-tips (event)
3344 "Show tip for identifier or selection under the mouse.
3345 The mouse must either point at an identifier or inside a selected
3346 region for the tip window to be shown. If gud-tooltip-dereference is t,
3347 add a `*' in front of the printed expression. In the case of a C program
3348 controlled by GDB, show the associated #define directives when program is
3351 This function must return nil if it doesn't handle EVENT."
3353 (when (and (eventp event)
3355 (boundp 'gud-comint-buffer)
3357 (buffer-name gud-comint-buffer); gud-comint-buffer might be killed
3358 (setq process (get-buffer-process gud-comint-buffer))
3359 (posn-point (event-end event))
3360 (or (and (eq gud-minor-mode 'gdba) (not gdb-active-process))
3361 (progn (setq gud-tooltip-event event)
3362 (eval (cons 'and gud-tooltip-display)))))
3363 (let ((expr (tooltip-expr-to-print event)))
3365 (if (and (eq gud-minor-mode 'gdba)
3366 (not gdb-active-process))
3368 (with-current-buffer
3369 (window-buffer (let ((mouse (mouse-position)))
3370 (window-at (cadr mouse)
3372 (let ((define-elt (assoc expr gdb-define-alist)))
3373 (unless (null define-elt)
3376 (or gud-tooltip-echo-area tooltip-use-echo-area))
3378 (let ((cmd (gud-tooltip-print-command expr)))
3379 (when (and gud-tooltip-mode (eq gud-minor-mode 'gdb))
3380 (gud-tooltip-mode -1)
3381 (message-box "Using GUD tooltips in this mode is unsafe\n\
3382 so they have been disabled."))
3383 (unless (null cmd) ; CMD can be nil if unknown debugger
3384 (if (memq gud-minor-mode '(gdba gdbmi))
3388 gdb-server-prefix "macro expand " expr "\n")
3389 `(lambda () (gdb-tooltip-print-1 ,expr))))
3391 (list (concat cmd "\n") 'gdb-tooltip-print)))
3392 (setq gud-tooltip-original-filter (process-filter process))
3393 (set-process-filter process 'gud-tooltip-process-output)
3394 (gud-basic-call cmd))
3399 ;;; arch-tag: 6d990948-df65-461a-be39-1c7fb83ac4c4
3400 ;;; gud.el ends here