| blob | 0577e2a2bb763586c43d6108d8b63ab7f9575553 |
1 ;;; gud.el --- Grand Unified Debugger mode for running GDB and other debuggers
3 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
4 ;; Maintainer: FSF
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)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; 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.
27 ;;; Commentary:
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
39 ;; debugger.)
41 ;;; Code:
48 ;; ======================================================================
49 ;; GUD commands must be visible in C buffers visited by GUD
52 "Grand Unified Debugger mode for gdb and other debuggers under Emacs.
53 Supported debuggers include gdb, sdb, dbx, xdb, perldb, pdb (Python), jdb, and bash."
59 "Prefix of all GUD commands valid in C buffers."
80 "Return the symbol used for SYM in MINOR-MODE.
81 MINOR-MODE defaults to `gud-minor-mode.
82 The symbol returned is `gud-<MINOR-MODE>-<SYM>'.
83 If SOFT is non-nil, returns nil if the symbol doesn't already exist."
89 "Return the value of `gud-symbol' SYM. Default to nil."
94 "Non-nil if debuggee is running.
97 ;; Use existing Info buffer, if possible.
99 "Go to relevant Emacs info node."
118 ([tooltips] menu-item "Toggle GUD tooltips" gud-tooltip-mode
119 :enable (and (not emacs-basic-display)
120 (display-graphic-p)
121 (fboundp 'x-show-tip))
122 :button (:toggle . gud-tooltip-mode))
123 ([refresh] "Refresh" . gud-refresh)
124 ([run] menu-item "Run" gud-run
125 :enable (and (not gud-running)
126 (memq gud-minor-mode '(gdbmi gdba gdb dbx jdb))))
127 ([until] menu-item "Continue to selection" gud-until
128 :enable (and (not gud-running)
129 (memq gud-minor-mode '(gdbmi gdba gdb perldb))))
130 ([remove] menu-item "Remove Breakpoint" gud-remove
131 :enable (not gud-running))
132 ([tbreak] menu-item "Temporary Breakpoint" gud-tbreak
133 :enable (memq gud-minor-mode '(gdbmi gdba gdb sdb xdb bashdb)))
134 ([break] menu-item "Set Breakpoint" gud-break
135 :enable (not gud-running))
136 ([up] menu-item "Up Stack" gud-up
137 :enable (and (not gud-running)
138 (memq gud-minor-mode
139 '(gdbmi gdba gdb dbx xdb jdb pdb bashdb))))
140 ([down] menu-item "Down Stack" gud-down
141 :enable (and (not gud-running)
142 (memq gud-minor-mode
143 '(gdbmi gdba gdb dbx xdb jdb pdb bashdb))))
144 ([print*] menu-item "Print Dereference" gud-pstar
145 :enable (and (not gud-running)
146 (memq gud-minor-mode '(gdbmi gdba gdb))))
147 ([print] menu-item "Print Expression" gud-print
148 :enable (not gud-running))
149 ([watch] menu-item "Watch Expression" gud-watch
150 :enable (and (not gud-running)
151 (memq gud-minor-mode '(gdbmi gdba))))
152 ([finish] menu-item "Finish Function" gud-finish
153 :enable (and (not gud-running)
154 (memq gud-minor-mode
155 '(gdbmi gdba gdb xdb jdb pdb bashdb))))
156 ([stepi] menu-item "Step Instruction" gud-stepi
157 :enable (and (not gud-running)
158 (memq gud-minor-mode '(gdbmi gdba gdb dbx))))
159 ([nexti] menu-item "Next Instruction" gud-nexti
160 :enable (and (not gud-running)
161 (memq gud-minor-mode '(gdbmi gdba gdb dbx))))
162 ([step] menu-item "Step Line" gud-step
163 :enable (not gud-running))
164 ([next] menu-item "Next Line" gud-next
165 :enable (not gud-running))
166 ([cont] menu-item "Continue" gud-cont
167 :enable (not gud-running)))
168 "Menu for `gud-mode'."
169 :name "Gud")
171 (easy-mmode-defmap gud-minor-mode-map
172 `(([menu-bar debug] . ("Gud" . ,gud-menu-map)))
173 "Map used in visited files.")
175 (let ((m (assq 'gud-minor-mode minor-mode-map-alist)))
176 (if m (setcdr m gud-minor-mode-map)
177 (push (cons 'gud-minor-mode gud-minor-mode-map) minor-mode-map-alist)))
179 (defvar gud-mode-map
180 ;; Will inherit from comint-mode via define-derived-mode.
181 (make-sparse-keymap)
182 "`gud-mode' keymap.")
184 (defvar gud-tool-bar-map
185 (if (display-graphic-p)
186 (let ((map (make-sparse-keymap)))
187 (dolist (x '((gud-break . "gud-break")
188 (gud-remove . "gud-remove")
189 (gud-print . "gud-print")
190 (gud-pstar . "gud-pstar")
191 (gud-watch . "gud-watch")
192 (gud-cont . "gud-cont")
193 (gud-until . "gud-until")
194 (gud-finish . "gud-finish")
195 (gud-run . "gud-run")
196 ;; gud-s, gud-si etc. instead of gud-step,
197 ;; gud-stepi, to avoid file-name clashes on DOS
198 ;; 8+3 filesystems.
199 (gud-next . "gud-n")
200 (gud-step . "gud-s")
201 (gud-nexti . "gud-ni")
202 (gud-stepi . "gud-si")
203 (gud-up . "gud-up")
204 (gud-down . "gud-down")
205 (gud-goto-info . "info"))
206 map)
207 (tool-bar-local-item-from-menu
208 (car x) (cdr x) map gud-minor-mode-map)))))
210 (defun gud-file-name (f)
211 "Transform a relative file name to an absolute file name.
212 Uses `gud-<MINOR-MODE>-directories' to find the source files."
213 (if (file-exists-p f) (expand-file-name f)
214 (let ((directories (gud-val 'directories))
215 (result nil))
216 (while directories
217 (let ((path (expand-file-name f (car directories))))
218 (if (file-exists-p path)
219 (setq result path
220 directories nil)))
221 (setq directories (cdr directories)))
222 result)))
224 (defun gud-find-file (file)
225 ;; Don't get confused by double slashes in the name that comes from GDB.
226 (while (string-match "//+" file)
227 (setq file (replace-match "/" t t file)))
228 (let ((minor-mode gud-minor-mode)
229 (buf (funcall (or gud-find-file 'gud-file-name) file)))
230 (when (stringp buf)
231 (setq buf (and (file-readable-p buf) (find-file-noselect buf 'nowarn))))
232 (when buf
233 ;; Copy `gud-minor-mode' to the found buffer to turn on the menu.
234 (with-current-buffer buf
235 (set (make-local-variable 'gud-minor-mode) minor-mode)
236 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
237 (when (and gud-tooltip-mode
238 (memq gud-minor-mode '(gdbmi gdba)))
239 (make-local-variable 'gdb-define-alist)
240 (unless gdb-define-alist (gdb-create-define-alist))
241 (add-hook 'after-save-hook 'gdb-create-define-alist nil t))
242 (make-local-variable 'gud-keep-buffer))
243 buf)))
244 \f
245 ;; ======================================================================
246 ;; command definition
248 ;; This macro is used below to define some basic debugger interface commands.
249 ;; Of course you may use `gud-def' with any other debugger command, including
250 ;; user defined ones.
252 ;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
253 ;; which defines FUNC to send the command NAME to the debugger, gives
254 ;; it the docstring DOC, and binds that function to KEY in the GUD
255 ;; major mode. The function is also bound in the global keymap with the
256 ;; GUD prefix.
258 (defmacro gud-def (func cmd key &optional doc)
259 "Define FUNC to be a command sending STR and bound to KEY, with
260 optional doc string DOC. Certain %-escapes in the string arguments
261 are interpreted specially if present. These are:
263 %f name (without directory) of current source file.
264 %F name (without directory or extension) of current source file.
265 %d directory of current source file.
266 %l number of current source line
267 %e text of the C lvalue or function-call expression surrounding point.
268 %a text of the hexadecimal address surrounding point
269 %p prefix argument to the command (if any) as a number
271 The `current' source file is the file of the current buffer (if
272 we're in a C file) or the source file current at the last break or
273 step (if we're in the GUD buffer).
274 The `current' line is that of the current buffer (if we're in a
275 source file) or the source line number at the last break or step (if
276 we're in the GUD buffer)."
277 `(progn
278 (defun ,func (arg)
279 ,@(if doc (list doc))
280 (interactive "p")
281 ,(if (stringp cmd)
282 `(gud-call ,cmd arg)
283 cmd))
284 ,(if key `(local-set-key ,(concat "\C-c" key) ',func))
285 ,(if key `(global-set-key (vconcat gud-key-prefix ,key) ',func))))
287 ;; Where gud-display-frame should put the debugging arrow; a cons of
288 ;; (filename . line-number). This is set by the marker-filter, which scans
289 ;; the debugger's output for indications of the current program counter.
290 (defvar gud-last-frame nil)
292 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
293 ;; the last frame, even if it's been called before and gud-last-frame has
294 ;; been set to nil.
295 (defvar gud-last-last-frame nil)
297 ;; All debugger-specific information is collected here.
298 ;; Here's how it works, in case you ever need to add a debugger to the mode.
299 ;;
300 ;; Each entry must define the following at startup:
301 ;;
302 ;;<name>
303 ;; comint-prompt-regexp
304 ;; gud-<name>-massage-args
305 ;; gud-<name>-marker-filter
306 ;; gud-<name>-find-file
307 ;;
308 ;; The job of the massage-args method is to modify the given list of
309 ;; debugger arguments before running the debugger.
310 ;;
311 ;; The job of the marker-filter method is to detect file/line markers in
312 ;; strings and set the global gud-last-frame to indicate what display
313 ;; action (if any) should be triggered by the marker. Note that only
314 ;; whatever the method *returns* is displayed in the buffer; thus, you
315 ;; can filter the debugger's output, interpreting some and passing on
316 ;; the rest.
317 ;;
318 ;; The job of the find-file method is to visit and return the buffer indicated
319 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
320 ;; something else.
321 \f
322 ;; ======================================================================
323 ;; speedbar support functions and variables.
324 (eval-when-compile (require 'speedbar)) ;For speedbar-with-attached-buffer.
326 (defvar gud-last-speedbar-buffer nil
327 "The last GUD buffer used.")
329 (defvar gud-last-speedbar-stackframe nil
330 "Description of the currently displayed GUD stack.
331 t means that there is no stack, and we are in display-file mode.")
333 (defvar gud-speedbar-key-map nil
334 "Keymap used when in the buffers display mode.")
336 (defun gud-install-speedbar-variables ()
337 "Install those variables used by speedbar to enhance gud/gdb."
338 (if gud-speedbar-key-map
339 nil
340 (setq gud-speedbar-key-map (speedbar-make-specialized-keymap))
342 (define-key gud-speedbar-key-map "j" 'speedbar-edit-line)
343 (define-key gud-speedbar-key-map "e" 'speedbar-edit-line)
344 (define-key gud-speedbar-key-map "\C-m" 'speedbar-edit-line)
345 (define-key gud-speedbar-key-map "D" 'gdb-var-delete)))
348 (defvar gud-speedbar-menu-items
349 ;; Note to self. Add expand, and turn off items when not available.
350 '(["Jump to stack frame" speedbar-edit-line
351 (with-current-buffer gud-comint-buffer
352 (not (memq gud-minor-mode '(gdbmi gdba))))]
353 ["Edit value" speedbar-edit-line
354 (with-current-buffer gud-comint-buffer
355 (memq gud-minor-mode '(gdbmi gdba)))]
356 ["Delete expression" gdb-var-delete
357 (with-current-buffer gud-comint-buffer
358 (memq gud-minor-mode '(gdbmi gdba)))])
359 "Additional menu items to add to the speedbar frame.")
361 ;; Make sure our special speedbar mode is loaded
362 (if (featurep 'speedbar)
363 (gud-install-speedbar-variables)
364 (add-hook 'speedbar-load-hook 'gud-install-speedbar-variables))
366 (defun gud-speedbar-buttons (buffer)
367 "Create a speedbar display based on the current state of GUD.
368 If the GUD BUFFER is not running a supported debugger, then turn
369 off the specialized speedbar mode."
370 (let ((minor-mode (with-current-buffer buffer gud-minor-mode)))
371 (cond
372 ((memq minor-mode '(gdbmi gdba))
373 (when (or gdb-var-changed
374 (not (save-excursion
375 (goto-char (point-min))
376 (let ((case-fold-search t))
377 (looking-at "Watch Expressions:")))))
378 (erase-buffer)
380 (let ((var-list gdb-var-list))
381 (while var-list
382 (let* ((depth 0) (start 0) (char ?+)
383 (var (car var-list)) (varnum (nth 1 var)))
385 (setq depth (1+ depth)
386 start (1+ (match-beginning 0))))
387 (if (equal (nth 2 var) "0")
388 (speedbar-make-tag-line 'bracket ?? nil nil
390 'gdb-edit-value
391 nil
392 (if (and (nth 5 var)
393 gdb-show-changed-values)
394 'font-lock-warning-face
395 nil) depth)
396 (if (and (cadr var-list)
397 (string-match varnum (cadr (cadr var-list))))
398 (setq char ?-))
399 (speedbar-make-tag-line 'bracket char
400 'gdb-speedbar-expand-node varnum
402 nil nil nil depth)))
403 (setq var-list (cdr var-list))))
404 (setq gdb-var-changed nil)))
405 (t (if (and (save-excursion
406 (goto-char (point-min))
407 (looking-at "Current Stack"))
408 (equal gud-last-last-frame gud-last-speedbar-stackframe))
409 nil
410 (setq gud-last-speedbar-buffer buffer)
411 (let ((gud-frame-list
412 (cond ((eq minor-mode 'gdb)
413 (gud-gdb-get-stackframe buffer))
414 ;; Add more debuggers here!
415 (t (speedbar-remove-localized-speedbar-support buffer)
416 nil))))
417 (erase-buffer)
418 (if (not gud-frame-list)
421 (dolist (frame gud-frame-list)
423 (if (= (length frame) 2)
424 (progn
425 ; (speedbar-insert-button "[?]"
426 ; 'speedbar-button-face
427 ; nil nil nil t)
428 (speedbar-insert-button (car frame)
429 'speedbar-directory-face
430 nil nil nil t))
431 ; (speedbar-insert-button "[+]"
432 ; 'speedbar-button-face
433 ; 'speedbar-highlight-face
434 ; 'gud-gdb-get-scope-data
435 ; frame t)
436 (speedbar-insert-button (car frame)
437 'speedbar-file-face
438 'speedbar-highlight-face
439 (cond ((memq minor-mode '(gdbmi gdba gdb))
440 'gud-gdb-goto-stackframe)
441 (t (error "Should never be here")))
442 frame t)))
443 ; (let ((selected-frame
444 ; (cond ((eq ff 'gud-gdb-find-file)
445 ; (gud-gdb-selected-frame-info buffer))
446 ; (t (error "Should never be here"))))))
447 )
448 (setq gud-last-speedbar-stackframe gud-last-last-frame))))))
450 \f
451 ;; ======================================================================
452 ;; gdb functions
454 ;; History of argument lists passed to gdb.
455 (defvar gud-gdb-history nil)
457 (defcustom gud-gdb-command-name "gdb --annotate=3"
458 "Default command to execute an executable under the GDB debugger."
459 :type 'string
460 :group 'gud)
462 (defvar gud-gdb-marker-regexp
463 ;; This used to use path-separator instead of ":";
464 ;; however, we found that on both Windows 32 and MSDOS
465 ;; a colon is correct here.
469 ;; There's no guarantee that Emacs will hand the filter the entire
470 ;; marker at once; it could be broken up across several strings. We
471 ;; might even receive a big chunk with several markers in it. If we
472 ;; receive a chunk of text which looks like it might contain the
473 ;; beginning of a marker, we save it here between calls to the
474 ;; filter.
475 (defvar gud-marker-acc "")
476 (make-variable-buffer-local 'gud-marker-acc)
478 (defun gud-gdb-marker-filter (string)
479 (setq gud-marker-acc (concat gud-marker-acc string))
480 (let ((output ""))
482 ;; Process all the complete markers in this chunk.
483 (while (string-match gud-gdb-marker-regexp gud-marker-acc)
484 (setq
486 ;; Extract the frame position from the marker.
487 gud-last-frame (cons (match-string 1 gud-marker-acc)
488 (string-to-number (match-string 2 gud-marker-acc)))
490 ;; Append any text before the marker to the output we're going
491 ;; to return - we don't include the marker in this text.
492 output (concat output
493 (substring gud-marker-acc 0 (match-beginning 0)))
495 ;; Set the accumulator to the remaining text.
496 gud-marker-acc (substring gud-marker-acc (match-end 0))))
498 ;; Check for annotations and change gud-minor-mode to 'gdba if
499 ;; they are found.
501 (let ((match (match-string 1 gud-marker-acc)))
502 (when (string-equal match "prompt")
503 (require 'gdb-ui)
504 (gdb-prompt nil))
506 (setq
507 ;; Append any text before the marker to the output we're going
508 ;; to return - we don't include the marker in this text.
509 output (concat output
510 (substring gud-marker-acc 0 (match-beginning 0)))
512 ;; Set the accumulator to the remaining text.
514 gud-marker-acc (substring gud-marker-acc (match-end 0)))
515 (if (string-equal match "error-begin")
516 (put-text-property 0 (length gud-marker-acc)
517 'face font-lock-warning-face
518 gud-marker-acc))))
520 ;; Does the remaining text look like it might end with the
521 ;; beginning of another marker? If it does, then keep it in
522 ;; gud-marker-acc until we receive the rest of it. Since we
523 ;; know the full marker regexp above failed, it's pretty simple to
524 ;; test for marker starts.
526 (progn
527 ;; Everything before the potential marker start can be output.
528 (setq output (concat output (substring gud-marker-acc
529 0 (match-beginning 0))))
531 ;; Everything after, we save, to combine with later input.
532 (setq gud-marker-acc
533 (substring gud-marker-acc (match-beginning 0))))
535 (setq output (concat output gud-marker-acc)
536 gud-marker-acc ""))
538 output))
540 (easy-mmode-defmap gud-minibuffer-local-map
541 '(("\C-i" . comint-dynamic-complete-filename))
542 "Keymap for minibuffer prompting of gud startup command."
543 :inherit minibuffer-local-map)
545 (defun gud-query-cmdline (minor-mode &optional init)
546 (let* ((hist-sym (gud-symbol 'history nil minor-mode))
547 (cmd-name (gud-val 'command-name minor-mode)))
548 (unless (boundp hist-sym) (set hist-sym nil))
549 (read-from-minibuffer
550 (format "Run %s (like this): " minor-mode)
551 (or (car-safe (symbol-value hist-sym))
552 (concat (or cmd-name (symbol-name minor-mode))
553 " "
554 (or init
555 (let ((file nil))
556 (dolist (f (directory-files default-directory) file)
557 (if (and (file-executable-p f)
558 (not (file-directory-p f))
559 (or (not file)
560 (file-newer-than-file-p f file)))
561 (setq file f)))))))
562 gud-minibuffer-local-map nil
563 hist-sym)))
565 (defvar gdb-first-prompt t)
567 (defvar gud-filter-pending-text nil
568 "Non-nil means this is text that has been saved for later in `gud-filter'.")
570 ;;;###autoload
571 (defun gdb (command-line)
572 "Run gdb on program FILE in buffer *gud-FILE*.
573 The directory containing FILE becomes the initial working directory
574 and source-file directory for your debugger."
575 (interactive (list (gud-query-cmdline 'gdb)))
577 (gud-common-init command-line nil 'gud-gdb-marker-filter)
578 (set (make-local-variable 'gud-minor-mode) 'gdb)
580 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
581 (gud-def gud-tbreak "tbreak %f:%l" "\C-t" "Set temporary breakpoint at current line.")
582 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
583 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
584 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
585 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
586 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
587 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
588 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
589 (gud-def gud-jump
590 (progn (gud-call "tbreak %f:%l") (gud-call "jump %f:%l"))
591 "\C-j" "Set execution address to current line.")
593 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
594 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
595 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
596 (gud-def gud-pstar "print* %e" nil
597 "Evaluate C dereferenced pointer expression at point.")
598 (gud-def gud-until "until %l" "\C-u" "Continue to current line.")
599 (gud-def gud-run "run" nil "Run the program.")
601 (local-set-key "\C-i" 'gud-gdb-complete-command)
602 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
603 (setq paragraph-start comint-prompt-regexp)
604 (setq gdb-first-prompt t)
605 (setq gud-filter-pending-text nil)
606 (run-hooks 'gdb-mode-hook))
608 ;; One of the nice features of GDB is its impressive support for
609 ;; context-sensitive command completion. We preserve that feature
610 ;; in the GUD buffer by using a GDB command designed just for Emacs.
612 ;; The completion process filter indicates when it is finished.
613 (defvar gud-gdb-fetch-lines-in-progress)
615 ;; Since output may arrive in fragments we accumulate partials strings here.
616 (defvar gud-gdb-fetch-lines-string)
618 ;; We need to know how much of the completion to chop off.
619 (defvar gud-gdb-fetch-lines-break)
621 ;; The completion list is constructed by the process filter.
622 (defvar gud-gdb-fetched-lines)
624 (defvar gud-comint-buffer nil)
626 (defun gud-gdb-complete-command ()
627 "Perform completion on the GDB command preceding point.
628 This is implemented using the GDB `complete' command which isn't
629 available with older versions of GDB."
630 (interactive)
631 (let* ((end (point))
632 (command (buffer-substring (comint-line-beginning-position) end))
633 (command-word
634 ;; Find the word break. This match will always succeed.
636 (substring command (match-beginning 2))))
637 (complete-list
638 (gud-gdb-run-command-fetch-lines (concat "complete " command)
639 (current-buffer)
640 ;; From string-match above.
641 (match-beginning 2))))
642 ;; Protect against old versions of GDB.
643 (and complete-list
645 (error "This version of GDB doesn't support the `complete' command"))
646 ;; Sort the list like readline.
647 (setq complete-list (sort complete-list (function string-lessp)))
648 ;; Remove duplicates.
649 (let ((first complete-list)
650 (second (cdr complete-list)))
651 (while second
652 (if (string-equal (car first) (car second))
653 (setcdr first (setq second (cdr second)))
654 (setq first second
655 second (cdr second)))))
656 ;; Add a trailing single quote if there is a unique completion
657 ;; and it contains an odd number of unquoted single quotes.
658 (and (= (length complete-list) 1)
659 (let ((str (car complete-list))
660 (pos 0)
661 (count 0))
663 (setq count (1+ count)
664 pos (match-end 0)))
665 (and (= (mod count 2) 1)
666 (setq complete-list (list (concat str "'"))))))
667 ;; Let comint handle the rest.
668 (comint-dynamic-simple-complete command-word complete-list)))
670 ;; The completion process filter is installed temporarily to slurp the
671 ;; output of GDB up to the next prompt and build the completion list.
672 (defun gud-gdb-fetch-lines-filter (string filter)
673 "Filter used to read the list of lines output by a command.
674 STRING is the output to filter.
675 It is passed through FILTER before we look at it."
676 (setq string (funcall filter string))
677 (setq string (concat gud-gdb-fetch-lines-string string))
679 (push (substring string gud-gdb-fetch-lines-break (match-beginning 0))
680 gud-gdb-fetched-lines)
681 (setq string (substring string (match-end 0))))
682 (if (string-match comint-prompt-regexp string)
683 (progn
684 (setq gud-gdb-fetch-lines-in-progress nil)
685 string)
686 (progn
687 (setq gud-gdb-fetch-lines-string string)
688 "")))
690 ;; gdb speedbar functions
692 (defun gud-gdb-goto-stackframe (text token indent)
693 "Goto the stackframe described by TEXT, TOKEN, and INDENT."
694 (speedbar-with-attached-buffer
695 (gud-basic-call (concat "server frame " (nth 1 token)))
696 (sit-for 1)))
698 (defvar gud-gdb-fetched-stack-frame nil
699 "Stack frames we are fetching from GDB.")
701 ;(defun gud-gdb-get-scope-data (text token indent)
702 ; ;; checkdoc-params: (indent)
703 ; "Fetch data associated with a stack frame, and expand/contract it.
704 ;Data to do this is retrieved from TEXT and TOKEN."
705 ; (let ((args nil) (scope nil))
706 ; (gud-gdb-run-command-fetch-lines "info args")
707 ;
708 ; (gud-gdb-run-command-fetch-lines "info local")
709 ;
710 ; ))
712 (defun gud-gdb-get-stackframe (buffer)
713 "Extract the current stack frame out of the GUD GDB BUFFER."
714 (let ((newlst nil)
715 (fetched-stack-frame-list
716 (gud-gdb-run-command-fetch-lines "server backtrace" buffer)))
717 (if (and (car fetched-stack-frame-list)
718 (string-match "No stack" (car fetched-stack-frame-list)))
719 ;; Go into some other mode???
720 nil
721 (dolist (e fetched-stack-frame-list)
722 (let ((name nil) (num nil))
723 (if (not (or
726 (if (not (string-match
728 nil
729 (setcar newlst
730 (list (nth 0 (car newlst))
731 (nth 1 (car newlst))
732 (match-string 1 e)
733 (match-string 2 e))))
734 (setq num (match-string 1 e)
735 name (match-string 2 e))
736 (setq newlst
737 (cons
738 (if (string-match
740 (list name num (match-string 1 e)
741 (match-string 2 e))
742 (list name num))
743 newlst)))))
744 (nreverse newlst))))
746 ;(defun gud-gdb-selected-frame-info (buffer)
747 ; "Learn GDB information for the currently selected stack frame in BUFFER."
748 ; )
750 (defun gud-gdb-run-command-fetch-lines (command buffer &optional skip)
751 "Run COMMAND, and return the list of lines it outputs.
752 BUFFER is the GUD buffer in which to run the command.
753 SKIP is the number of chars to skip on each lines, it defaults to 0."
754 (with-current-buffer buffer
755 (if (save-excursion
756 (goto-char (point-max))
757 (forward-line 0)
758 (not (looking-at comint-prompt-regexp)))
759 nil
760 ;; Much of this copied from GDB complete, but I'm grabbing the stack
761 ;; frame instead.
762 (let ((gud-gdb-fetch-lines-in-progress t)
763 (gud-gdb-fetched-lines nil)
764 (gud-gdb-fetch-lines-string nil)
765 (gud-gdb-fetch-lines-break (or skip 0))
766 (gud-marker-filter
767 `(lambda (string) (gud-gdb-fetch-lines-filter string ',gud-marker-filter))))
768 ;; Issue the command to GDB.
769 (gud-basic-call command)
770 ;; Slurp the output.
771 (while gud-gdb-fetch-lines-in-progress
772 (accept-process-output (get-buffer-process buffer)))
773 (nreverse gud-gdb-fetched-lines)))))
775 \f
776 ;; ======================================================================
777 ;; sdb functions
779 ;; History of argument lists passed to sdb.
780 (defvar gud-sdb-history nil)
782 (defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
783 "If nil, we're on a System V Release 4 and don't need the tags hack.")
785 (defvar gud-sdb-lastfile nil)
787 (defun gud-sdb-marker-filter (string)
788 (setq gud-marker-acc
789 (if gud-marker-acc (concat gud-marker-acc string) string))
790 (let (start)
791 ;; Process all complete markers in this chunk
792 (while
793 (cond
794 ;; System V Release 3.2 uses this format
796 gud-marker-acc start)
797 (setq gud-last-frame
798 (cons (match-string 3 gud-marker-acc)
799 (string-to-number (match-string 4 gud-marker-acc)))))
800 ;; System V Release 4.0 quite often clumps two lines together
801 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
802 gud-marker-acc start)
803 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc))
804 (setq gud-last-frame
805 (cons gud-sdb-lastfile
806 (string-to-number (match-string 3 gud-marker-acc)))))
807 ;; System V Release 4.0
809 gud-marker-acc start)
810 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc)))
812 gud-marker-acc start))
813 (setq gud-last-frame
814 (cons gud-sdb-lastfile
815 (string-to-number (match-string 1 gud-marker-acc)))))
816 (t
817 (setq gud-sdb-lastfile nil)))
818 (setq start (match-end 0)))
820 ;; Search for the last incomplete line in this chunk
822 (setq start (match-end 0)))
824 ;; If we have an incomplete line, store it in gud-marker-acc.
825 (setq gud-marker-acc (substring gud-marker-acc (or start 0))))
826 string)
828 (defun gud-sdb-find-file (f)
829 (if gud-sdb-needs-tags (find-tag-noselect f) (find-file-noselect f)))
831 ;;;###autoload
832 (defun sdb (command-line)
833 "Run sdb on program FILE in buffer *gud-FILE*.
834 The directory containing FILE becomes the initial working directory
835 and source-file directory for your debugger."
836 (interactive (list (gud-query-cmdline 'sdb)))
838 (if gud-sdb-needs-tags (require 'etags))
839 (if (and gud-sdb-needs-tags
840 (not (and (boundp 'tags-file-name)
841 (stringp tags-file-name)
842 (file-exists-p tags-file-name))))
843 (error "The sdb support requires a valid tags table to work"))
845 (gud-common-init command-line nil 'gud-sdb-marker-filter 'gud-sdb-find-file)
846 (set (make-local-variable 'gud-minor-mode) 'sdb)
848 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
849 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
850 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
851 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
852 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
853 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
854 (gud-def gud-cont "c" "\C-r" "Continue with display.")
855 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
858 (setq paragraph-start comint-prompt-regexp)
859 (run-hooks 'sdb-mode-hook)
860 )
861 \f
862 ;; ======================================================================
863 ;; dbx functions
865 ;; History of argument lists passed to dbx.
866 (defvar gud-dbx-history nil)
868 (defcustom gud-dbx-directories nil
869 "*A list of directories that dbx should search for source code.
870 If nil, only source files in the program directory
871 will be known to dbx.
873 The file names should be absolute, or relative to the directory
874 containing the executable being debugged."
875 :type '(choice (const :tag "Current Directory" nil)
876 (repeat :value ("")
877 directory))
878 :group 'gud)
880 (defun gud-dbx-massage-args (file args)
881 (nconc (let ((directories gud-dbx-directories)
882 (result nil))
883 (while directories
884 (setq result (cons (car directories) (cons "-I" result)))
885 (setq directories (cdr directories)))
886 (nreverse result))
887 args))
889 (defun gud-dbx-marker-filter (string)
890 (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
892 (let (start)
893 ;; Process all complete markers in this chunk.
894 (while (or (string-match
896 gud-marker-acc start)
897 (string-match
899 gud-marker-acc start))
900 (setq gud-last-frame
901 (cons (match-string 2 gud-marker-acc)
902 (string-to-number (match-string 1 gud-marker-acc)))
903 start (match-end 0)))
905 ;; Search for the last incomplete line in this chunk
907 (setq start (match-end 0)))
909 ;; If the incomplete line APPEARS to begin with another marker, keep it
910 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
911 ;; unnecessary concat during the next call.
912 (setq gud-marker-acc
914 (substring gud-marker-acc (match-beginning 0))
915 nil)))
916 string)
918 ;; Functions for Mips-style dbx. Given the option `-emacs', documented in
919 ;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
920 (defvar gud-mips-p
921 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
922 ;; We haven't tested gud on this system:
923 (string-match "^mips-[^-]*-riscos" system-configuration)
924 ;; It's documented on OSF/1.3
925 (string-match "^mips-[^-]*-osf1" system-configuration)
926 (string-match "^alpha[^-]*-[^-]*-osf" system-configuration))
927 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
929 (defvar gud-dbx-command-name
930 (concat "dbx" (if gud-mips-p " -emacs")))
932 ;; This is just like the gdb one except for the regexps since we need to cope
933 ;; with an optional breakpoint number in [] before the ^Z^Z
934 (defun gud-mipsdbx-marker-filter (string)
935 (setq gud-marker-acc (concat gud-marker-acc string))
936 (let ((output ""))
938 ;; Process all the complete markers in this chunk.
939 (while (string-match
940 ;; This is like th gdb marker but with an optional
941 ;; leading break point number like `[1] '
943 gud-marker-acc)
944 (setq
946 ;; Extract the frame position from the marker.
947 gud-last-frame
948 (cons (match-string 1 gud-marker-acc)
949 (string-to-number (match-string 2 gud-marker-acc)))
951 ;; Append any text before the marker to the output we're going
952 ;; to return - we don't include the marker in this text.
953 output (concat output
954 (substring gud-marker-acc 0 (match-beginning 0)))
956 ;; Set the accumulator to the remaining text.
957 gud-marker-acc (substring gud-marker-acc (match-end 0))))
959 ;; Does the remaining text look like it might end with the
960 ;; beginning of another marker? If it does, then keep it in
961 ;; gud-marker-acc until we receive the rest of it. Since we
962 ;; know the full marker regexp above failed, it's pretty simple to
963 ;; test for marker starts.
965 (progn
966 ;; Everything before the potential marker start can be output.
967 (setq output (concat output (substring gud-marker-acc
968 0 (match-beginning 0))))
970 ;; Everything after, we save, to combine with later input.
971 (setq gud-marker-acc
972 (substring gud-marker-acc (match-beginning 0))))
974 (setq output (concat output gud-marker-acc)
975 gud-marker-acc ""))
977 output))
979 ;; The dbx in IRIX is a pain. It doesn't print the file name when
980 ;; stopping at a breakpoint (but you do get it from the `up' and
981 ;; `down' commands...). The only way to extract the information seems
982 ;; to be with a `file' command, although the current line number is
983 ;; available in $curline. Thus we have to look for output which
984 ;; appears to indicate a breakpoint. Then we prod the dbx sub-process
985 ;; to output the information we want with a combination of the
986 ;; `printf' and `file' commands as a pseudo marker which we can
987 ;; recognise next time through the marker-filter. This would be like
988 ;; the gdb marker but you can't get the file name without a newline...
989 ;; Note that gud-remove won't work since Irix dbx expects a breakpoint
990 ;; number rather than a line number etc. Maybe this could be made to
991 ;; work by listing all the breakpoints and picking the one(s) with the
992 ;; correct line number, but life's too short.
993 ;; d.love@dl.ac.uk (Dave Love) can be blamed for this
995 (defvar gud-irix-p
996 (and (string-match "^mips-[^-]*-irix" system-configuration)
998 "Non-nil to assume the interface appropriate for IRIX dbx.
999 This works in IRIX 4, 5 and 6, but `gud-dbx-use-stopformat-p' provides
1000 a better solution in 6.1 upwards.")
1001 (defvar gud-dbx-use-stopformat-p
1003 "Non-nil to use the dbx feature present at least from Irix 6.1
1004 whereby $stopformat=1 produces an output format compatiable with
1005 `gud-dbx-marker-filter'.")
1006 ;; [Irix dbx seems to be a moving target. The dbx output changed
1007 ;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
1008 ;; the output from `up' is no longer spotted by gud (and it's probably
1009 ;; not distinctive enough to try to match it -- use C-<, C->
1010 ;; exclusively) . For 5.3 and 6.0, the $curline variable changed to
1011 ;; `long long'(why?!), so the printf stuff needed changing. The line
1012 ;; number was cast to `long' as a compromise between the new `long
1013 ;; long' and the original `int'. This is reported not to work in 6.2,
1014 ;; so it's changed back to int -- don't make your sources too long.
1015 ;; From Irix6.1 (but not 6.0?) dbx supports an undocumented feature
1016 ;; whereby `set $stopformat=1' reportedly produces output compatible
1017 ;; with `gud-dbx-marker-filter', which we prefer.
1019 ;; The process filter is also somewhat
1020 ;; unreliable, sometimes not spotting the markers; I don't know
1021 ;; whether there's anything that can be done about that. It would be
1022 ;; much better if SGI could be persuaded to (re?)instate the MIPS
1023 ;; -emacs flag for gdb-like output (which ought to be possible as most
1024 ;; of the communication I've had over it has been from sgi.com).]
1026 ;; this filter is influenced by the xdb one rather than the gdb one
1027 (defun gud-irixdbx-marker-filter (string)
1028 (let (result (case-fold-search nil))
1029 (if (or (string-match comint-prompt-regexp string)
1031 (setq result (concat gud-marker-acc string)
1032 gud-marker-acc "")
1033 (setq gud-marker-acc (concat gud-marker-acc string)))
1034 (if result
1035 (cond
1036 ;; look for breakpoint or signal indication e.g.:
1037 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
1038 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
1039 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
1040 ((string-match
1042 result)
1043 ;; prod dbx into printing out the line number and file
1044 ;; name in a form we can grok as below
1045 (process-send-string (get-buffer-process gud-comint-buffer)
1047 ;; look for result of, say, "up" e.g.:
1048 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
1049 ;; (this will also catch one of the lines printed by "where")
1050 ((string-match
1052 result)
1053 (let ((file (match-string 1 result)))
1054 (if (file-exists-p file)
1055 (setq gud-last-frame
1056 (cons (match-string 1 result)
1057 (string-to-number (match-string 2 result))))))
1058 result)
1059 ((string-match ; kluged-up marker as above
1061 (let ((file (gud-file-name (match-string 2 result))))
1062 (if (and file (file-exists-p file))
1063 (setq gud-last-frame
1064 (cons file
1065 (string-to-number (match-string 1 result))))))
1066 (setq result (substring result 0 (match-beginning 0))))))
1067 (or result "")))
1069 (defvar gud-dgux-p (string-match "-dgux" system-configuration)
1070 "Non-nil means to assume the interface approriate for DG/UX dbx.
1071 This was tested using R4.11.")
1073 ;; There are a couple of differences between DG's dbx output and normal
1074 ;; dbx output which make it nontrivial to integrate this into the
1075 ;; standard dbx-marker-filter (mainly, there are a different number of
1076 ;; backreferences). The markers look like:
1077 ;;
1078 ;; (0) Stopped at line 10, routine main(argc=1, argv=0xeffff0e0), file t.c
1079 ;;
1080 ;; from breakpoints (the `(0)' there isn't constant, it's the breakpoint
1081 ;; number), and
1082 ;;
1083 ;; Stopped at line 13, routine main(argc=1, argv=0xeffff0e0), file t.c
1084 ;;
1085 ;; from signals and
1086 ;;
1087 ;; Frame 21, line 974, routine command_loop(), file keyboard.c
1088 ;;
1089 ;; from up/down/where.
1091 (defun gud-dguxdbx-marker-filter (string)
1092 (setq gud-marker-acc (if gud-marker-acc
1093 (concat gud-marker-acc string)
1094 string))
1097 start)
1098 ;; Process all complete markers in this chunk.
1099 (while (string-match re gud-marker-acc start)
1100 (setq gud-last-frame
1101 (cons (match-string 4 gud-marker-acc)
1102 (string-to-number (match-string 3 gud-marker-acc)))
1103 start (match-end 0)))
1105 ;; Search for the last incomplete line in this chunk
1107 (setq start (match-end 0)))
1109 ;; If the incomplete line APPEARS to begin with another marker, keep it
1110 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1111 ;; unnecessary concat during the next call.
1112 (setq gud-marker-acc
1114 (substring gud-marker-acc (match-beginning 0))
1115 nil)))
1116 string)
1118 ;;;###autoload
1119 (defun dbx (command-line)
1120 "Run dbx on program FILE in buffer *gud-FILE*.
1121 The directory containing FILE becomes the initial working directory
1122 and source-file directory for your debugger."
1123 (interactive (list (gud-query-cmdline 'dbx)))
1125 (cond
1126 (gud-mips-p
1127 (gud-common-init command-line nil 'gud-mipsdbx-marker-filter))
1128 (gud-irix-p
1129 (gud-common-init command-line 'gud-dbx-massage-args
1130 'gud-irixdbx-marker-filter))
1131 (gud-dgux-p
1132 (gud-common-init command-line 'gud-dbx-massage-args
1133 'gud-dguxdbx-marker-filter))
1134 (t
1135 (gud-common-init command-line 'gud-dbx-massage-args
1136 'gud-dbx-marker-filter)))
1138 (set (make-local-variable 'gud-minor-mode) 'dbx)
1140 (cond
1141 (gud-mips-p
1142 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1143 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1145 "\C-b" "Set breakpoint at current line.")
1146 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
1147 (gud-irix-p
1149 "\C-b" "Set breakpoint at current line.")
1150 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1152 "<" "Up (numeric arg) stack frames.")
1154 ">" "Down (numeric arg) stack frames.")
1155 ;; Make dbx give out the source location info that we need.
1156 (process-send-string (get-buffer-process gud-comint-buffer)
1158 (t
1159 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1160 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1162 "\C-b" "Set breakpoint at current line.")
1163 (if gud-dbx-use-stopformat-p
1164 (process-send-string (get-buffer-process gud-comint-buffer)
1167 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
1168 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
1169 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
1170 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
1171 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
1172 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
1173 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
1174 (gud-def gud-run "run" nil "Run the program.")
1177 (setq paragraph-start comint-prompt-regexp)
1178 (run-hooks 'dbx-mode-hook)
1179 )
1180 \f
1181 ;; ======================================================================
1182 ;; xdb (HP PARISC debugger) functions
1184 ;; History of argument lists passed to xdb.
1185 (defvar gud-xdb-history nil)
1187 (defcustom gud-xdb-directories nil
1188 "*A list of directories that xdb should search for source code.
1189 If nil, only source files in the program directory
1190 will be known to xdb.
1192 The file names should be absolute, or relative to the directory
1193 containing the executable being debugged."
1194 :type '(choice (const :tag "Current Directory" nil)
1195 (repeat :value ("")
1196 directory))
1197 :group 'gud)
1199 (defun gud-xdb-massage-args (file args)
1200 (nconc (let ((directories gud-xdb-directories)
1201 (result nil))
1202 (while directories
1203 (setq result (cons (car directories) (cons "-d" result)))
1204 (setq directories (cdr directories)))
1205 (nreverse result))
1206 args))
1208 ;; xdb does not print the lines all at once, so we have to accumulate them
1209 (defun gud-xdb-marker-filter (string)
1210 (let (result)
1211 (if (or (string-match comint-prompt-regexp string)
1213 (setq result (concat gud-marker-acc string)
1214 gud-marker-acc "")
1215 (setq gud-marker-acc (concat gud-marker-acc string)))
1216 (if result
1218 result)
1220 result))
1221 (let ((line (string-to-number (match-string 2 result)))
1222 (file (gud-file-name (match-string 1 result))))
1223 (if file
1224 (setq gud-last-frame (cons file line))))))
1225 (or result "")))
1227 ;;;###autoload
1228 (defun xdb (command-line)
1229 "Run xdb on program FILE in buffer *gud-FILE*.
1230 The directory containing FILE becomes the initial working directory
1231 and source-file directory for your debugger.
1233 You can set the variable `gud-xdb-directories' to a list of program source
1234 directories if your program contains sources from more than one directory."
1235 (interactive (list (gud-query-cmdline 'xdb)))
1237 (gud-common-init command-line 'gud-xdb-massage-args
1238 'gud-xdb-marker-filter)
1239 (set (make-local-variable 'gud-minor-mode) 'xdb)
1241 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
1243 "Set temporary breakpoint at current line.")
1244 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
1245 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
1246 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1247 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1248 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1249 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1251 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
1253 (setq comint-prompt-regexp "^>")
1254 (setq paragraph-start comint-prompt-regexp)
1255 (run-hooks 'xdb-mode-hook))
1256 \f
1257 ;; ======================================================================
1258 ;; perldb functions
1260 ;; History of argument lists passed to perldb.
1261 (defvar gud-perldb-history nil)
1263 (defun gud-perldb-massage-args (file args)
1264 "Convert a command line as would be typed normally to run perldb
1265 into one that invokes an Emacs-enabled debugging session.
1267 ;; FIXME: what if the command is `make perldb' and doesn't accept those extra
1268 ;; arguments ?
1269 (let* ((new-args nil)
1270 (seen-e nil)
1271 (shift (lambda () (push (pop args) new-args))))
1273 ;; Pass all switches and -e scripts through.
1274 (while (and args
1275 (string-match "^-" (car args))
1276 (not (equal "-" (car args)))
1277 (not (equal "--" (car args))))
1278 (when (equal "-e" (car args))
1279 ;; -e goes with the next arg, so shift one extra.
1280 (or (funcall shift)
1281 ;; -e as the last arg is an error in Perl.
1282 (error "No code specified for -e"))
1283 (setq seen-e t))
1284 (funcall shift))
1286 (unless seen-e
1287 (if (or (not args)
1288 (string-match "^-" (car args)))
1289 (error "Can't use stdin as the script to debug"))
1290 ;; This is the program name.
1291 (funcall shift))
1293 ;; If -e specified, make sure there is a -- so -emacs is not taken
1294 ;; as -e macs.
1295 (if (and args (equal "--" (car args)))
1296 (funcall shift)
1297 (and seen-e (push "--" new-args)))
1299 (push "-emacs" new-args)
1300 (while args
1301 (funcall shift))
1303 (nreverse new-args)))
1305 ;; There's no guarantee that Emacs will hand the filter the entire
1306 ;; marker at once; it could be broken up across several strings. We
1307 ;; might even receive a big chunk with several markers in it. If we
1308 ;; receive a chunk of text which looks like it might contain the
1309 ;; beginning of a marker, we save it here between calls to the
1310 ;; filter.
1311 (defun gud-perldb-marker-filter (string)
1312 (setq gud-marker-acc (concat gud-marker-acc string))
1313 (let ((output ""))
1315 ;; Process all the complete markers in this chunk.
1317 gud-marker-acc)
1318 (setq
1320 ;; Extract the frame position from the marker.
1321 gud-last-frame
1322 (cons (match-string 1 gud-marker-acc)
1323 (string-to-number (match-string 3 gud-marker-acc)))
1325 ;; Append any text before the marker to the output we're going
1326 ;; to return - we don't include the marker in this text.
1327 output (concat output
1328 (substring gud-marker-acc 0 (match-beginning 0)))
1330 ;; Set the accumulator to the remaining text.
1331 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1333 ;; Does the remaining text look like it might end with the
1334 ;; beginning of another marker? If it does, then keep it in
1335 ;; gud-marker-acc until we receive the rest of it. Since we
1336 ;; know the full marker regexp above failed, it's pretty simple to
1337 ;; test for marker starts.
1339 (progn
1340 ;; Everything before the potential marker start can be output.
1341 (setq output (concat output (substring gud-marker-acc
1342 0 (match-beginning 0))))
1344 ;; Everything after, we save, to combine with later input.
1345 (setq gud-marker-acc
1346 (substring gud-marker-acc (match-beginning 0))))
1348 (setq output (concat output gud-marker-acc)
1349 gud-marker-acc ""))
1351 output))
1353 (defcustom gud-perldb-command-name "perl -d"
1354 "Default command to execute a Perl script under debugger."
1355 :type 'string
1356 :group 'gud)
1358 ;;;###autoload
1359 (defun perldb (command-line)
1360 "Run perldb on program FILE in buffer *gud-FILE*.
1361 The directory containing FILE becomes the initial working directory
1362 and source-file directory for your debugger."
1363 (interactive
1364 (list (gud-query-cmdline 'perldb
1365 (concat (or (buffer-file-name) "-e 0") " "))))
1367 (gud-common-init command-line 'gud-perldb-massage-args
1368 'gud-perldb-marker-filter)
1369 (set (make-local-variable 'gud-minor-mode) 'perldb)
1371 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
1372 (gud-def gud-remove "B %l" "\C-d" "Remove breakpoint at current line")
1373 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
1374 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
1375 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1376 ; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
1377 ; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
1378 ; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
1379 (gud-def gud-print "p %e" "\C-p" "Evaluate perl expression at point.")
1380 (gud-def gud-until "c %l" "\C-u" "Continue to current line.")
1383 (setq comint-prompt-regexp "^ DB<+[0-9]+>+ ")
1384 (setq paragraph-start comint-prompt-regexp)
1385 (run-hooks 'perldb-mode-hook))
1386 \f
1387 ;; ======================================================================
1388 ;; pdb (Python debugger) functions
1390 ;; History of argument lists passed to pdb.
1391 (defvar gud-pdb-history nil)
1393 ;; Last group is for return value, e.g. "> test.py(2)foo()->None"
1394 ;; Either file or function name may be omitted: "> <string>(0)?()"
1395 (defvar gud-pdb-marker-regexp
1396 "^> \\([-a-zA-Z0-9_/.:\\]*\\|<string>\\)(\\([0-9]+\\))\\([a-zA-Z0-9_]*\\|\\?\\)()\\(->[^\n]*\\)?\n")
1397 (defvar gud-pdb-marker-regexp-file-group 1)
1398 (defvar gud-pdb-marker-regexp-line-group 2)
1399 (defvar gud-pdb-marker-regexp-fnname-group 3)
1401 (defvar gud-pdb-marker-regexp-start "^> ")
1403 ;; There's no guarantee that Emacs will hand the filter the entire
1404 ;; marker at once; it could be broken up across several strings. We
1405 ;; might even receive a big chunk with several markers in it. If we
1406 ;; receive a chunk of text which looks like it might contain the
1407 ;; beginning of a marker, we save it here between calls to the
1408 ;; filter.
1409 (defun gud-pdb-marker-filter (string)
1410 (setq gud-marker-acc (concat gud-marker-acc string))
1411 (let ((output ""))
1413 ;; Process all the complete markers in this chunk.
1414 (while (string-match gud-pdb-marker-regexp gud-marker-acc)
1415 (setq
1417 ;; Extract the frame position from the marker.
1418 gud-last-frame
1419 (let ((file (match-string gud-pdb-marker-regexp-file-group
1420 gud-marker-acc))
1421 (line (string-to-number
1422 (match-string gud-pdb-marker-regexp-line-group
1423 gud-marker-acc))))
1424 (if (string-equal file "<string>")
1425 gud-last-frame
1426 (cons file line)))
1428 ;; Output everything instead of the below
1429 output (concat output (substring gud-marker-acc 0 (match-end 0)))
1430 ;; ;; Append any text before the marker to the output we're going
1431 ;; ;; to return - we don't include the marker in this text.
1432 ;; output (concat output
1433 ;; (substring gud-marker-acc 0 (match-beginning 0)))
1435 ;; Set the accumulator to the remaining text.
1436 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1438 ;; Does the remaining text look like it might end with the
1439 ;; beginning of another marker? If it does, then keep it in
1440 ;; gud-marker-acc until we receive the rest of it. Since we
1441 ;; know the full marker regexp above failed, it's pretty simple to
1442 ;; test for marker starts.
1443 (if (string-match gud-pdb-marker-regexp-start gud-marker-acc)
1444 (progn
1445 ;; Everything before the potential marker start can be output.
1446 (setq output (concat output (substring gud-marker-acc
1447 0 (match-beginning 0))))
1449 ;; Everything after, we save, to combine with later input.
1450 (setq gud-marker-acc
1451 (substring gud-marker-acc (match-beginning 0))))
1453 (setq output (concat output gud-marker-acc)
1454 gud-marker-acc ""))
1456 output))
1458 (defcustom gud-pdb-command-name "pdb"
1459 "File name for executing the Python debugger.
1460 This should be an executable on your path, or an absolute file name."
1461 :type 'string
1462 :group 'gud)
1464 ;;;###autoload
1465 (defun pdb (command-line)
1466 "Run pdb on program FILE in buffer `*gud-FILE*'.
1467 The directory containing FILE becomes the initial working directory
1468 and source-file directory for your debugger."
1469 (interactive
1470 (list (gud-query-cmdline 'pdb)))
1472 (gud-common-init command-line nil 'gud-pdb-marker-filter)
1473 (set (make-local-variable 'gud-minor-mode) 'pdb)
1475 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
1476 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
1477 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
1478 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
1479 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
1480 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1481 (gud-def gud-up "up" "<" "Up one stack frame.")
1482 (gud-def gud-down "down" ">" "Down one stack frame.")
1483 (gud-def gud-print "p %e" "\C-p" "Evaluate Python expression at point.")
1484 ;; Is this right?
1485 (gud-def gud-statement "! %e" "\C-e" "Execute Python statement at point.")
1487 ;; (setq comint-prompt-regexp "^(.*pdb[+]?) *")
1488 (setq comint-prompt-regexp "^(Pdb) *")
1489 (setq paragraph-start comint-prompt-regexp)
1490 (run-hooks 'pdb-mode-hook))
1491 \f
1492 ;; ======================================================================
1493 ;;
1494 ;; JDB support.
1495 ;;
1496 ;; AUTHOR: Derek Davies <ddavies@world.std.com>
1497 ;; Zoltan Kemenczy <zoltan@ieee.org;zkemenczy@rim.net>
1498 ;;
1499 ;; CREATED: Sun Feb 22 10:46:38 1998 Derek Davies.
1500 ;; UPDATED: Nov 11, 2001 Zoltan Kemenczy
1501 ;; Dec 10, 2002 Zoltan Kemenczy - added nested class support
1502 ;;
1503 ;; INVOCATION NOTES:
1504 ;;
1505 ;; You invoke jdb-mode with:
1506 ;;
1507 ;; M-x jdb <enter>
1508 ;;
1509 ;; It responds with:
1510 ;;
1511 ;; Run jdb (like this): jdb
1512 ;;
1513 ;; type any jdb switches followed by the name of the class you'd like to debug.
1514 ;; Supply a fully qualfied classname (these do not have the ".class" extension)
1515 ;; for the name of the class to debug (e.g. "COM.the-kind.ddavies.CoolClass").
1516 ;; See the known problems section below for restrictions when specifying jdb
1517 ;; command line switches (search forward for '-classpath').
1518 ;;
1519 ;; You should see something like the following:
1520 ;;
1521 ;; Current directory is ~/src/java/hello/
1522 ;; Initializing jdb...
1523 ;; 0xed2f6628:class(hello)
1524 ;; >
1525 ;;
1526 ;; To set an initial breakpoint try:
1527 ;;
1528 ;; > stop in hello.main
1529 ;; Breakpoint set in hello.main
1530 ;; >
1531 ;;
1532 ;; To execute the program type:
1533 ;;
1534 ;; > run
1535 ;; run hello
1536 ;;
1537 ;; Breakpoint hit: running ...
1538 ;; hello.main (hello:12)
1539 ;;
1540 ;; Type M-n to step over the current line and M-s to step into it. That,
1541 ;; along with the JDB 'help' command should get you started. The 'quit'
1542 ;; JDB command will get out out of the debugger. There is some truly
1543 ;; pathetic JDB documentation available at:
1544 ;;
1545 ;; http://java.sun.com/products/jdk/1.1/debugging/
1546 ;;
1547 ;; KNOWN PROBLEMS AND FIXME's:
1548 ;;
1549 ;; Not sure what happens with inner classes ... haven't tried them.
1550 ;;
1551 ;; Does not grok UNICODE id's. Only ASCII id's are supported.
1552 ;;
1553 ;; You must not put whitespace between "-classpath" and the path to
1554 ;; search for java classes even though it is required when invoking jdb
1555 ;; from the command line. See gud-jdb-massage-args for details.
1556 ;; The same applies for "-sourcepath".
1557 ;;
1558 ;; Note: The following applies only if `gud-jdb-use-classpath' is nil;
1559 ;; refer to the documentation of `gud-jdb-use-classpath' and
1560 ;; `gud-jdb-classpath',`gud-jdb-sourcepath' variables for information
1561 ;; on using the classpath for locating java source files.
1562 ;;
1563 ;; If any of the source files in the directories listed in
1564 ;; gud-jdb-directories won't parse you'll have problems. Make sure
1565 ;; every file ending in ".java" in these directories parses without error.
1566 ;;
1567 ;; All the .java files in the directories in gud-jdb-directories are
1568 ;; syntactically analyzed each time gud jdb is invoked. It would be
1569 ;; nice to keep as much information as possible between runs. It would
1570 ;; be really nice to analyze the files only as neccessary (when the
1571 ;; source needs to be displayed.) I'm not sure to what extent the former
1572 ;; can be accomplished and I'm not sure the latter can be done at all
1573 ;; since I don't know of any general way to tell which .class files are
1574 ;; defined by which .java file without analyzing all the .java files.
1575 ;; If anyone knows why JavaSoft didn't put the source file names in
1576 ;; debuggable .class files please clue me in so I find something else
1577 ;; to be spiteful and bitter about.
1578 ;;
1579 ;; ======================================================================
1580 ;; gud jdb variables and functions
1582 (defcustom gud-jdb-command-name "jdb"
1583 "Command that executes the Java debugger."
1584 :type 'string
1585 :group 'gud)
1587 (defcustom gud-jdb-use-classpath t
1588 "If non-nil, search for Java source files in classpath directories.
1589 The list of directories to search is the value of `gud-jdb-classpath'.
1590 The file pathname is obtained by converting the fully qualified
1591 class information output by jdb to a relative pathname and appending
1592 it to `gud-jdb-classpath' element by element until a match is found.
1594 This method has a significant jdb startup time reduction advantage
1595 since it does not require the scanning of all `gud-jdb-directories'
1596 and parsing all Java files for class information.
1598 Set to nil to use `gud-jdb-directories' to scan java sources for
1599 class information on jdb startup (original method)."
1600 :type 'boolean
1601 :group 'gud)
1603 (defvar gud-jdb-classpath nil
1604 "Java/jdb classpath directories list.
1605 If `gud-jdb-use-classpath' is non-nil, gud-jdb derives the `gud-jdb-classpath'
1606 list automatically using the following methods in sequence
1607 \(with subsequent successful steps overriding the results of previous
1608 steps):
1610 1) Read the CLASSPATH environment variable,
1612 or detected in jdb output (e.g. if jdb is run by a script
1613 that echoes the actual jdb command before starting jdb)
1616 an already running VM) argument (This case typically does not
1618 to the VM when it is started).
1620 Note that method 3 cannot be used with oldjdb (or Java 1 jdb) since
1621 those debuggers do not support the classpath command. Use 1) or 2).")
1623 (defvar gud-jdb-sourcepath nil
1625 This list is prepended to `gud-jdb-classpath' to form the complete
1626 list of directories searched for source files.")
1628 (defvar gud-marker-acc-max-length 4000
1629 "Maximum number of debugger output characters to keep.
1630 This variable limits the size of `gud-marker-acc' which holds
1631 the most recent debugger output history while searching for
1632 source file information.")
1634 (defvar gud-jdb-history nil
1635 "History of argument lists passed to jdb.")
1638 ;; List of Java source file directories.
1639 (defvar gud-jdb-directories (list ".")
1640 "*A list of directories that gud jdb should search for source code.
1641 The file names should be absolute, or relative to the current
1642 directory.
1644 The set of .java files residing in the directories listed are
1645 syntactically analyzed to determine the classes they define and the
1646 packages in which these classes belong. In this way gud jdb maps the
1647 package-qualified class names output by the jdb debugger to the source
1648 file from which the class originated. This allows gud mode to keep
1649 the source code display in sync with the debugging session.")
1651 (defvar gud-jdb-source-files nil
1652 "List of the java source files for this debugging session.")
1654 ;; Association list of fully qualified class names (package + class name)
1655 ;; and their source files.
1656 (defvar gud-jdb-class-source-alist nil
1657 "Association list of fully qualified class names and source files.")
1659 ;; This is used to hold a source file during analysis.
1660 (defvar gud-jdb-analysis-buffer nil)
1662 (defvar gud-jdb-classpath-string nil
1663 "Holds temporary classpath values.")
1665 (defun gud-jdb-build-source-files-list (path extn)
1666 "Return a list of java source files (absolute paths).
1667 PATH gives the directories in which to search for files with
1668 extension EXTN. Normally EXTN is given as the regular expression
1670 (apply 'nconc (mapcar (lambda (d)
1671 (when (file-directory-p d)
1672 (directory-files d t extn nil)))
1673 path)))
1675 ;; Move point past whitespace.
1676 (defun gud-jdb-skip-whitespace ()
1679 ;; Move point past a "// <eol>" type of comment.
1680 (defun gud-jdb-skip-single-line-comment ()
1681 (end-of-line))
1683 ;; Move point past a "/* */" or "/** */" type of comment.
1684 (defun gud-jdb-skip-traditional-or-documentation-comment ()
1685 (forward-char 2)
1686 (catch 'break
1687 (while (not (eobp))
1688 (if (eq (following-char) ?*)
1689 (progn
1690 (forward-char)
1691 (if (not (eobp))
1692 (if (eq (following-char) ?/)
1693 (progn
1694 (forward-char)
1695 (throw 'break nil)))))
1696 (forward-char)))))
1698 ;; Move point past any number of consecutive whitespace chars and/or comments.
1699 (defun gud-jdb-skip-whitespace-and-comments ()
1700 (gud-jdb-skip-whitespace)
1701 (catch 'done
1702 (while t
1703 (cond
1704 ((looking-at "//")
1705 (gud-jdb-skip-single-line-comment)
1706 (gud-jdb-skip-whitespace))
1708 (gud-jdb-skip-traditional-or-documentation-comment)
1709 (gud-jdb-skip-whitespace))
1710 (t (throw 'done nil))))))
1712 ;; Move point past things that are id-like. The intent is to skip regular
1713 ;; id's, such as class or interface names as well as package and interface
1714 ;; names.
1715 (defun gud-jdb-skip-id-ish-thing ()
1718 ;; Move point past a string literal.
1719 (defun gud-jdb-skip-string-literal ()
1720 (forward-char)
1721 (while (not (cond
1723 (forward-char))
1725 (forward-char))
1726 (forward-char))
1728 ;; Move point past a character literal.
1729 (defun gud-jdb-skip-character-literal ()
1730 (forward-char)
1731 (while
1732 (progn
1734 (forward-char 2))
1736 (forward-char))
1737 (forward-char))
1739 ;; Move point past the following block. There may be (legal) cruft before
1740 ;; the block's opening brace. There must be a block or it's the end of life
1741 ;; in petticoat junction.
1742 (defun gud-jdb-skip-block ()
1744 ;; Find the begining of the block.
1745 (while
1746 (not (eq (following-char) ?{))
1748 ;; Skip any constructs that can harbor literal block delimiter
1749 ;; characters and/or the delimiters for the constructs themselves.
1750 (cond
1751 ((looking-at "//")
1752 (gud-jdb-skip-single-line-comment))
1754 (gud-jdb-skip-traditional-or-documentation-comment))
1756 (gud-jdb-skip-string-literal))
1758 (gud-jdb-skip-character-literal))
1759 (t (forward-char))))
1761 ;; Now at the begining of the block.
1762 (forward-char)
1764 ;; Skip over the body of the block as well as the final brace.
1765 (let ((open-level 1))
1766 (while (not (eq open-level 0))
1767 (cond
1768 ((looking-at "//")
1769 (gud-jdb-skip-single-line-comment))
1771 (gud-jdb-skip-traditional-or-documentation-comment))
1773 (gud-jdb-skip-string-literal))
1775 (gud-jdb-skip-character-literal))
1776 ((eq (following-char) ?{)
1777 (setq open-level (+ open-level 1))
1778 (forward-char))
1779 ((eq (following-char) ?})
1780 (setq open-level (- open-level 1))
1781 (forward-char))
1782 (t (forward-char))))))
1784 ;; Find the package and class definitions in Java source file FILE. Assumes
1785 ;; that FILE contains a legal Java program. BUF is a scratch buffer used
1786 ;; to hold the source during analysis.
1787 (defun gud-jdb-analyze-source (buf file)
1788 (let ((l nil))
1789 (set-buffer buf)
1790 (insert-file-contents file nil nil nil t)
1791 (goto-char 0)
1792 (catch 'abort
1793 (let ((p ""))
1794 (while (progn
1795 (gud-jdb-skip-whitespace)
1796 (not (eobp)))
1797 (cond
1799 ;; Any number of semi's following a block is legal. Move point
1800 ;; past them. Note that comments and whitespace may be
1801 ;; interspersed as well.
1803 (forward-char))
1805 ;; Move point past a single line comment.
1806 ((looking-at "//")
1807 (gud-jdb-skip-single-line-comment))
1809 ;; Move point past a traditional or documentation comment.
1811 (gud-jdb-skip-traditional-or-documentation-comment))
1813 ;; Move point past a package statement, but save the PackageName.
1814 ((looking-at "package")
1815 (forward-char 7)
1816 (gud-jdb-skip-whitespace-and-comments)
1817 (let ((s (point)))
1818 (gud-jdb-skip-id-ish-thing)
1819 (setq p (concat (buffer-substring s (point)) "."))
1820 (gud-jdb-skip-whitespace-and-comments)
1822 (forward-char))))
1824 ;; Move point past an import statement.
1825 ((looking-at "import")
1826 (forward-char 6)
1827 (gud-jdb-skip-whitespace-and-comments)
1828 (gud-jdb-skip-id-ish-thing)
1829 (gud-jdb-skip-whitespace-and-comments)
1831 (forward-char)))
1833 ;; Move point past the various kinds of ClassModifiers.
1834 ((looking-at "public")
1835 (forward-char 6))
1836 ((looking-at "abstract")
1837 (forward-char 8))
1838 ((looking-at "final")
1839 (forward-char 5))
1841 ;; Move point past a ClassDeclaraction, but save the class
1842 ;; Identifier.
1843 ((looking-at "class")
1844 (forward-char 5)
1845 (gud-jdb-skip-whitespace-and-comments)
1846 (let ((s (point)))
1847 (gud-jdb-skip-id-ish-thing)
1848 (setq
1849 l (nconc l (list (concat p (buffer-substring s (point)))))))
1850 (gud-jdb-skip-block))
1852 ;; Move point past an interface statement.
1853 ((looking-at "interface")
1854 (forward-char 9)
1855 (gud-jdb-skip-block))
1857 ;; Anything else means the input is invalid.
1858 (t
1859 (message (format "Error parsing file %s." file))
1860 (throw 'abort nil))))))
1861 l))
1863 (defun gud-jdb-build-class-source-alist-for-file (file)
1864 (mapcar
1865 (lambda (c)
1866 (cons c file))
1867 (gud-jdb-analyze-source gud-jdb-analysis-buffer file)))
1869 ;; Return an alist of fully qualified classes and the source files
1870 ;; holding their definitions. SOURCES holds a list of all the source
1871 ;; files to examine.
1872 (defun gud-jdb-build-class-source-alist (sources)
1873 (setq gud-jdb-analysis-buffer (get-buffer-create " *gud-jdb-scratch*"))
1874 (prog1
1875 (apply
1876 'nconc
1877 (mapcar
1878 'gud-jdb-build-class-source-alist-for-file
1879 sources))
1880 (kill-buffer gud-jdb-analysis-buffer)
1881 (setq gud-jdb-analysis-buffer nil)))
1883 ;; Change what was given in the minibuffer to something that can be used to
1884 ;; invoke the debugger.
1885 (defun gud-jdb-massage-args (file args)
1886 ;; The jdb executable must have whitespace between "-classpath" and
1887 ;; its value while gud-common-init expects all switch values to
1888 ;; follow the switch keyword without intervening whitespace. We
1889 ;; require that when the user enters the "-classpath" switch in the
1890 ;; EMACS minibuffer that they do so without the intervening
1891 ;; whitespace. This function adds it back (it's called after
1892 ;; gud-common-init). There are more switches like this (for
1893 ;; instance "-host" and "-password") but I don't care about them
1894 ;; yet.
1895 (if args
1896 (let (massaged-args user-error)
1898 (while (and args (not user-error))
1899 (cond
1900 ((setq user-error (string-match "-classpath$" (car args))))
1901 ((setq user-error (string-match "-sourcepath$" (car args))))
1903 (setq massaged-args
1904 (append massaged-args
1905 (list "-classpath"
1906 (setq gud-jdb-classpath-string
1907 (match-string 1 (car args)))))))
1909 (setq massaged-args
1910 (append massaged-args
1911 (list "-sourcepath"
1912 (setq gud-jdb-sourcepath
1913 (match-string 1 (car args)))))))
1914 (t (setq massaged-args (append massaged-args (list (car args))))))
1915 (setq args (cdr args)))
1917 ;; By this point the current directory is all screwed up. Maybe we
1918 ;; could fix things and re-invoke gud-common-init, but for now I think
1919 ;; issueing the error is good enough.
1920 (if user-error
1921 (progn
1922 (kill-buffer (current-buffer))
1923 (error "Error: Omit whitespace between '-classpath or -sourcepath' and its value")))
1924 massaged-args)))
1926 ;; Search for an association with P, a fully qualified class name, in
1927 ;; gud-jdb-class-source-alist. The asssociation gives the fully
1928 ;; qualified file name of the source file which produced the class.
1929 (defun gud-jdb-find-source-file (p)
1930 (cdr (assoc p gud-jdb-class-source-alist)))
1932 ;; Note: Reset to this value every time a prompt is seen
1933 (defvar gud-jdb-lowest-stack-level 999)
1935 (defun gud-jdb-find-source-using-classpath (p)
1936 "Find source file corresponding to fully qualified class p.
1937 Convert p from jdb's output, converted to a pathname
1938 relative to a classpath directory."
1939 (save-match-data
1940 (let
1941 (;; Replace dots with slashes and append ".java" to generate file
1942 ;; name relative to classpath
1943 (filename
1944 (concat
1945 (mapconcat 'identity
1946 (split-string
1947 ;; Eliminate any subclass references in the class
1948 ;; name string. These start with a "$"
1949 ((lambda (x)
1950 (if (string-match "$.*" x)
1951 (replace-match "" t t x) p))
1952 p)
1954 ".java"))
1955 (cplist (append gud-jdb-sourcepath gud-jdb-classpath))
1956 found-file)
1957 (while (and cplist
1958 (not (setq found-file
1959 (file-readable-p
1960 (concat (car cplist) "/" filename)))))
1961 (setq cplist (cdr cplist)))
1962 (if found-file (concat (car cplist) "/" filename)))))
1964 (defun gud-jdb-find-source (string)
1965 "Alias for function used to locate source files.
1966 Set to `gud-jdb-find-source-using-classpath' or `gud-jdb-find-source-file'
1967 during jdb initialization depending on the value of
1968 `gud-jdb-use-classpath'."
1969 nil)
1971 (defun gud-jdb-parse-classpath-string (string)
1972 "Parse the classpath list and convert each item to an absolute pathname."
1974 (replace-match "" nil nil s) s))
1975 (mapcar 'file-truename
1976 (split-string
1977 string
1980 ;; See comentary for other debugger's marker filters - there you will find
1981 ;; important notes about STRING.
1982 (defun gud-jdb-marker-filter (string)
1984 ;; Build up the accumulator.
1985 (setq gud-marker-acc
1986 (if gud-marker-acc
1987 (concat gud-marker-acc string)
1988 string))
1990 ;; Look for classpath information until gud-jdb-classpath-string is found
1991 ;; (interactive, multiple settings of classpath from jdb
1992 ;; not supported/followed)
1993 (if (and gud-jdb-use-classpath
1994 (not gud-jdb-classpath-string)
1997 (setq gud-jdb-classpath
1998 (gud-jdb-parse-classpath-string
1999 (setq gud-jdb-classpath-string
2000 (match-string 1 gud-marker-acc)))))
2002 ;; We process STRING from left to right. Each time through the
2003 ;; following loop we process at most one marker. After we've found a
2004 ;; marker, delete gud-marker-acc up to and including the match
2005 (let (file-found)
2006 ;; Process each complete marker in the input.
2007 (while
2009 ;; Do we see a marker?
2010 (string-match
2011 ;; jdb puts out a string of the following form when it
2012 ;; hits a breakpoint:
2013 ;;
2014 ;; <fully-qualified-class><method> (<class>:<line-number>)
2015 ;;
2016 ;; <fully-qualified-class>'s are composed of Java ID's
2017 ;; separated by periods. <method> and <class> are
2018 ;; also Java ID's. <method> begins with a period and
2019 ;; may contain less-than and greater-than (constructors,
2020 ;; for instance, are called <init> in the symbol table.)
2021 ;; Java ID's begin with a letter followed by letters
2022 ;; and/or digits. The set of letters includes underscore
2023 ;; and dollar sign.
2024 ;;
2025 ;; The first group matches <fully-qualified-class>,
2026 ;; the second group matches <class> and the third group
2027 ;; matches <line-number>. We don't care about using
2028 ;; <method> so we don't "group" it.
2029 ;;
2030 ;; FIXME: Java ID's are UNICODE strings, this matches ASCII
2031 ;; ID's only.
2032 ;;
2033 ;; The ".," in the last square-bracket are necessary because
2034 ;; of Sun's total disrespect for backwards compatibility in
2035 ;; reported line numbers from jdb - starting in 1.4.0 they
2036 ;; print line numbers using LOCALE, inserting a comma or a
2037 ;; period at the thousands positions (how ingenious!).
2041 gud-marker-acc)
2043 ;; A good marker is one that:
2044 ;; 1) does not have a "[n] " prefix (not part of a stack backtrace)
2045 ;; 2) does have an "[n] " prefix and n is the lowest prefix seen
2046 ;; since the last prompt
2047 ;; Figure out the line on which to position the debugging arrow.
2048 ;; Return the info as a cons of the form:
2049 ;;
2050 ;; (<file-name> . <line-number>) .
2051 (if (if (match-beginning 1)
2052 (let (n)
2053 (setq n (string-to-number (substring
2054 gud-marker-acc
2055 (1+ (match-beginning 1))
2056 (- (match-end 1) 2))))
2057 (if (< n gud-jdb-lowest-stack-level)
2058 (progn (setq gud-jdb-lowest-stack-level n) t)))
2059 t)
2060 (if (setq file-found
2061 (gud-jdb-find-source (match-string 2 gud-marker-acc)))
2062 (setq gud-last-frame
2063 (cons file-found
2064 (string-to-number
2065 (let
2066 ((numstr (match-string 4 gud-marker-acc)))
2067 (if (string-match "[.,]" numstr)
2068 (replace-match "" nil nil numstr)
2069 numstr)))))
2070 (message "Could not find source file.")))
2072 ;; Set the accumulator to the remaining text.
2073 (setq gud-marker-acc (substring gud-marker-acc (match-end 0))))
2075 (if (string-match comint-prompt-regexp gud-marker-acc)
2076 (setq gud-jdb-lowest-stack-level 999)))
2078 ;; Do not allow gud-marker-acc to grow without bound. If the source
2079 ;; file information is not within the last 3/4
2080 ;; gud-marker-acc-max-length characters, well,...
2081 (if (> (length gud-marker-acc) gud-marker-acc-max-length)
2082 (setq gud-marker-acc
2083 (substring gud-marker-acc
2084 (- (/ (* gud-marker-acc-max-length 3) 4)))))
2086 ;; We don't filter any debugger output so just return what we were given.
2087 string)
2089 (defvar gud-jdb-command-name "jdb" "Command that executes the Java debugger.")
2091 ;;;###autoload
2092 (defun jdb (command-line)
2093 "Run jdb with command line COMMAND-LINE in a buffer.
2096 switch is given, omit all whitespace between it and its value.
2098 See `gud-jdb-use-classpath' and `gud-jdb-classpath' documentation for
2099 information on how jdb accesses source files. Alternatively (if
2100 `gud-jdb-use-classpath' is nil), see `gud-jdb-directories' for the
2101 original source file access method.
2103 For general information about commands available to control jdb from
2104 gud, see `gud-mode'."
2105 (interactive
2106 (list (gud-query-cmdline 'jdb)))
2107 (setq gud-jdb-classpath nil)
2108 (setq gud-jdb-sourcepath nil)
2110 ;; Set gud-jdb-classpath from the CLASSPATH environment variable,
2111 ;; if CLASSPATH is set.
2112 (setq gud-jdb-classpath-string (getenv "CLASSPATH"))
2113 (if gud-jdb-classpath-string
2114 (setq gud-jdb-classpath
2115 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2116 (setq gud-jdb-classpath-string nil) ; prepare for next
2118 (gud-common-init command-line 'gud-jdb-massage-args
2119 'gud-jdb-marker-filter)
2120 (set (make-local-variable 'gud-minor-mode) 'jdb)
2122 ;; If a -classpath option was provided, set gud-jdb-classpath
2123 (if gud-jdb-classpath-string
2124 (setq gud-jdb-classpath
2125 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2126 (setq gud-jdb-classpath-string nil) ; prepare for next
2127 ;; If a -sourcepath option was provided, parse it
2128 (if gud-jdb-sourcepath
2129 (setq gud-jdb-sourcepath
2130 (gud-jdb-parse-classpath-string gud-jdb-sourcepath)))
2132 (gud-def gud-break "stop at %c:%l" "\C-b" "Set breakpoint at current line.")
2133 (gud-def gud-remove "clear %c:%l" "\C-d" "Remove breakpoint at current line")
2134 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2135 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2136 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
2137 (gud-def gud-finish "step up" "\C-f" "Continue until current method returns.")
2138 (gud-def gud-up "up\C-Mwhere" "<" "Up one stack frame.")
2139 (gud-def gud-down "down\C-Mwhere" ">" "Up one stack frame.")
2140 (gud-def gud-run "run" nil "Run the program.") ;if VM start using jdb
2143 (setq paragraph-start comint-prompt-regexp)
2144 (run-hooks 'jdb-mode-hook)
2146 (if gud-jdb-use-classpath
2147 ;; Get the classpath information from the debugger
2148 (progn
2149 (if (string-match "-attach" command-line)
2150 (gud-call "classpath"))
2151 (fset 'gud-jdb-find-source
2152 'gud-jdb-find-source-using-classpath))
2154 ;; Else create and bind the class/source association list as well
2155 ;; as the source file list.
2156 (setq gud-jdb-class-source-alist
2157 (gud-jdb-build-class-source-alist
2158 (setq gud-jdb-source-files
2159 (gud-jdb-build-source-files-list gud-jdb-directories
2161 (fset 'gud-jdb-find-source 'gud-jdb-find-source-file)))
2162 \f
2164 ;; ======================================================================
2165 ;;
2166 ;; BASHDB support. See http://bashdb.sourceforge.net
2167 ;;
2168 ;; AUTHOR: Rocky Bernstein <rocky@panix.com>
2169 ;;
2170 ;; CREATED: Sun Nov 10 10:46:38 2002 Rocky Bernstein.
2171 ;;
2172 ;; INVOCATION NOTES:
2173 ;;
2174 ;; You invoke bashdb-mode with:
2175 ;;
2176 ;; M-x bashdb <enter>
2177 ;;
2178 ;; It responds with:
2179 ;;
2180 ;; Run bashdb (like this): bash
2181 ;;
2183 ;; History of argument lists passed to bashdb.
2184 (defvar gud-bashdb-history nil)
2186 ;; Convert a command line as would be typed normally to run a script
2187 ;; into one that invokes an Emacs-enabled debugging session.
2188 ;; "--debugger" in inserted as the first switch.
2190 ;; There's no guarantee that Emacs will hand the filter the entire
2191 ;; marker at once; it could be broken up across several strings. We
2192 ;; might even receive a big chunk with several markers in it. If we
2193 ;; receive a chunk of text which looks like it might contain the
2194 ;; beginning of a marker, we save it here between calls to the
2195 ;; filter.
2196 (defun gud-bashdb-marker-filter (string)
2197 (setq gud-marker-acc (concat gud-marker-acc string))
2198 (let ((output ""))
2200 ;; Process all the complete markers in this chunk.
2201 ;; Format of line looks like this:
2202 ;; (/etc/init.d/ntp.init:16):
2203 ;; but we also allow DOS drive letters
2204 ;; (d:/etc/init.d/ntp.init:16):
2206 gud-marker-acc)
2207 (setq
2209 ;; Extract the frame position from the marker.
2210 gud-last-frame
2211 (cons (match-string 2 gud-marker-acc)
2212 (string-to-number (match-string 4 gud-marker-acc)))
2214 ;; Append any text before the marker to the output we're going
2215 ;; to return - we don't include the marker in this text.
2216 output (concat output
2217 (substring gud-marker-acc 0 (match-beginning 0)))
2219 ;; Set the accumulator to the remaining text.
2220 gud-marker-acc (substring gud-marker-acc (match-end 0))))
2222 ;; Does the remaining text look like it might end with the
2223 ;; beginning of another marker? If it does, then keep it in
2224 ;; gud-marker-acc until we receive the rest of it. Since we
2225 ;; know the full marker regexp above failed, it's pretty simple to
2226 ;; test for marker starts.
2228 (progn
2229 ;; Everything before the potential marker start can be output.
2230 (setq output (concat output (substring gud-marker-acc
2231 0 (match-beginning 0))))
2233 ;; Everything after, we save, to combine with later input.
2234 (setq gud-marker-acc
2235 (substring gud-marker-acc (match-beginning 0))))
2237 (setq output (concat output gud-marker-acc)
2238 gud-marker-acc ""))
2240 output))
2242 (defcustom gud-bashdb-command-name "bash --debugger"
2243 "File name for executing bash debugger."
2244 :type 'string
2245 :group 'gud)
2247 ;;;###autoload
2248 (defun bashdb (command-line)
2249 "Run bashdb on program FILE in buffer *gud-FILE*.
2250 The directory containing FILE becomes the initial working directory
2251 and source-file directory for your debugger."
2252 (interactive
2253 (list (read-from-minibuffer "Run bashdb (like this): "
2254 (if (consp gud-bashdb-history)
2255 (car gud-bashdb-history)
2256 (concat gud-bashdb-command-name
2257 " "))
2258 gud-minibuffer-local-map nil
2259 '(gud-bashdb-history . 1))))
2261 (gud-common-init command-line nil 'gud-bashdb-marker-filter)
2263 (set (make-local-variable 'gud-minor-mode) 'bashdb)
2265 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
2266 (gud-def gud-tbreak "tbreak %l" "\C-t" "Set temporary breakpoint at current line.")
2267 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
2268 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2269 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2270 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
2271 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
2272 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
2273 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
2274 (gud-def gud-print "x %e" "\C-p" "Evaluate BASH expression at point.")
2276 ;; Is this right?
2277 (gud-def gud-statement "eval %e" "\C-e" "Execute BASH statement at point.")
2279 (setq comint-prompt-regexp "^bashdb<+(*[0-9]+)*>+ ")
2280 (setq paragraph-start comint-prompt-regexp)
2281 (run-hooks 'bashdb-mode-hook)
2282 )
2284 ;;
2285 ;; End of debugger-specific information
2286 ;;
2288 \f
2289 ;; When we send a command to the debugger via gud-call, it's annoying
2290 ;; to see the command and the new prompt inserted into the debugger's
2291 ;; buffer; we have other ways of knowing the command has completed.
2292 ;;
2293 ;; If the buffer looks like this:
2294 ;; --------------------
2295 ;; (gdb) set args foo bar
2296 ;; (gdb) -!-
2297 ;; --------------------
2298 ;; (the -!- marks the location of point), and we type `C-x SPC' in a
2299 ;; source file to set a breakpoint, we want the buffer to end up like
2300 ;; this:
2301 ;; --------------------
2302 ;; (gdb) set args foo bar
2303 ;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
2304 ;; (gdb) -!-
2305 ;; --------------------
2306 ;; Essentially, the old prompt is deleted, and the command's output
2307 ;; and the new prompt take its place.
2308 ;;
2309 ;; Not echoing the command is easy enough; you send it directly using
2310 ;; process-send-string, and it never enters the buffer. However,
2311 ;; getting rid of the old prompt is trickier; you don't want to do it
2312 ;; when you send the command, since that will result in an annoying
2313 ;; flicker as the prompt is deleted, redisplay occurs while Emacs
2314 ;; waits for a response from the debugger, and the new prompt is
2315 ;; inserted. Instead, we'll wait until we actually get some output
2316 ;; from the subprocess before we delete the prompt. If the command
2317 ;; produced no output other than a new prompt, that prompt will most
2318 ;; likely be in the first chunk of output received, so we will delete
2319 ;; the prompt and then replace it with an identical one. If the
2320 ;; command produces output, the prompt is moving anyway, so the
2321 ;; flicker won't be annoying.
2322 ;;
2323 ;; So - when we want to delete the prompt upon receipt of the next
2324 ;; chunk of debugger output, we position gud-delete-prompt-marker at
2325 ;; the start of the prompt; the process filter will notice this, and
2326 ;; delete all text between it and the process output marker. If
2327 ;; gud-delete-prompt-marker points nowhere, we leave the current
2328 ;; prompt alone.
2329 (defvar gud-delete-prompt-marker nil)
2331 \f
2332 (put 'gud-mode 'mode-class 'special)
2334 (define-derived-mode gud-mode comint-mode "Debugger"
2335 "Major mode for interacting with an inferior debugger process.
2337 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
2338 M-x perldb, M-x xdb, or M-x jdb. Each entry point finishes by executing a
2339 hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook',
2340 `perldb-mode-hook', `xdb-mode-hook', or `jdb-mode-hook' respectively.
2342 After startup, the following commands are available in both the GUD
2343 interaction buffer and any source buffer GUD visits due to a breakpoint stop
2344 or step operation:
2347 GUD buffer, the current file and line are those of the last breakpoint or
2348 step. In a source buffer, they are the buffer's file and current line.
2353 in the gud buffer.
2356 step-one-line (not entering function calls), and step-one-instruction
2357 and then update the source window with the current file and position.
2361 around point, and sends it to the debugger for value display.
2363 The above commands are common to all supported debuggers except xdb which
2364 does not support stepping instructions.
2367 except that the breakpoint is temporary; that is, it is removed when
2368 execution stops on it.
2374 the current function and stops.
2376 All the keystrokes above are accessible in the GUD buffer
2377 with the prefix C-c, and in all buffers through the prefix C-x C-a.
2379 All pre-defined functions for which the concept make sense repeat
2380 themselves the appropriate number of times if you give a prefix
2381 argument.
2383 You may use the `gud-def' macro in the initialization hook to define other
2384 commands.
2386 Other commands for interacting with the debugger process are inherited from
2387 comint mode, which see."
2388 (setq mode-line-process '(":%s"))
2389 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
2390 (set (make-local-variable 'gud-last-frame) nil)
2391 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
2392 (make-local-variable 'comint-prompt-regexp)
2393 ;; Don't put repeated commands in command history many times.
2394 (set (make-local-variable 'comint-input-ignoredups) t)
2395 (make-local-variable 'paragraph-start)
2396 (set (make-local-variable 'gud-delete-prompt-marker) (make-marker))
2397 (add-hook 'kill-buffer-hook 'gud-kill-buffer-hook nil t))
2399 ;; Cause our buffers to be displayed, by default,
2400 ;; in the selected window.
2403 (defcustom gud-chdir-before-run t
2404 "Non-nil if GUD should `cd' to the debugged executable."
2405 :group 'gud
2406 :type 'boolean)
2408 (defvar gud-target-name "--unknown--"
2409 "The apparent name of the program being debugged in a gud buffer.")
2411 ;; Perform initializations common to all debuggers.
2412 ;; The first arg is the specified command line,
2413 ;; which starts with the program to debug.
2414 ;; The other three args specify the values to use
2415 ;; for local variables in the debugger buffer.
2416 (defun gud-common-init (command-line massage-args marker-filter
2417 &optional find-file)
2418 (let* ((words (split-string command-line))
2419 (program (car words))
2420 (dir default-directory)
2421 ;; Extract the file name from WORDS
2422 ;; and put t in its place.
2423 ;; Later on we will put the modified file name arg back there.
2424 (file-word (let ((w (cdr words)))
2425 (while (and w (= ?- (aref (car w) 0)))
2426 (setq w (cdr w)))
2427 (and w
2428 (prog1 (car w)
2429 (setcar w t)))))
2430 (file-subst
2431 (and file-word (substitute-in-file-name file-word)))
2432 (args (cdr words))
2433 ;; If a directory was specified, expand the file name.
2434 ;; Otherwise, don't expand it, so GDB can use the PATH.
2435 ;; A file name without directory is literally valid
2436 ;; only if the file exists in ., and in that case,
2437 ;; omitting the expansion here has no visible effect.
2438 (file (and file-word
2439 (if (file-name-directory file-subst)
2440 (expand-file-name file-subst)
2441 file-subst)))
2442 (filepart (and file-word (concat "-" (file-name-nondirectory file))))
2443 (existing-buffer (get-buffer (concat "*gud" filepart "*"))))
2444 (pop-to-buffer (concat "*gud" filepart "*"))
2445 (when (and existing-buffer (get-buffer-process existing-buffer))
2446 (error "This program is already running under gdb"))
2447 ;; Set the dir, in case the buffer already existed with a different dir.
2448 (setq default-directory dir)
2449 ;; Set default-directory to the file's directory.
2450 (and file-word
2451 gud-chdir-before-run
2452 ;; Don't set default-directory if no directory was specified.
2453 ;; In that case, either the file is found in the current directory,
2454 ;; in which case this setq is a no-op,
2455 ;; or it is found by searching PATH,
2456 ;; in which case we don't know what directory it was found in.
2457 (file-name-directory file)
2458 (setq default-directory (file-name-directory file)))
2459 (or (bolp) (newline))
2461 ;; Put the substituted and expanded file name back in its place.
2462 (let ((w args))
2463 (while (and w (not (eq (car w) t)))
2464 (setq w (cdr w)))
2465 (if w
2466 (setcar w file)))
2467 (apply 'make-comint (concat "gud" filepart) program nil
2468 (if massage-args (funcall massage-args file args) args))
2469 ;; Since comint clobbered the mode, we don't set it until now.
2470 (gud-mode)
2471 (set (make-local-variable 'gud-target-name)
2472 (and file-word (file-name-nondirectory file))))
2473 (set (make-local-variable 'gud-marker-filter) marker-filter)
2474 (if find-file (set (make-local-variable 'gud-find-file) find-file))
2475 (setq gud-running nil)
2476 (setq gud-last-last-frame nil)
2478 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
2479 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
2480 (gud-set-buffer))
2482 (defun gud-set-buffer ()
2483 (when (eq major-mode 'gud-mode)
2484 (setq gud-comint-buffer (current-buffer))))
2486 (defvar gud-filter-defer-flag nil
2487 "Non-nil means don't process anything from the debugger right now.
2488 It is saved for when this flag is not set.")
2490 ;; These functions are responsible for inserting output from your debugger
2491 ;; into the buffer. The hard work is done by the method that is
2492 ;; the value of gud-marker-filter.
2494 (defun gud-filter (proc string)
2495 ;; Here's where the actual buffer insertion is done
2496 (let (output process-window)
2497 (if (buffer-name (process-buffer proc))
2498 (if gud-filter-defer-flag
2499 ;; If we can't process any text now,
2500 ;; save it for later.
2501 (setq gud-filter-pending-text
2502 (concat (or gud-filter-pending-text "") string))
2504 ;; If we have to ask a question during the processing,
2505 ;; defer any additional text that comes from the debugger
2506 ;; during that time.
2507 (let ((gud-filter-defer-flag t))
2508 ;; Process now any text we previously saved up.
2509 (if gud-filter-pending-text
2510 (setq string (concat gud-filter-pending-text string)
2511 gud-filter-pending-text nil))
2513 (with-current-buffer (process-buffer proc)
2514 ;; If we have been so requested, delete the debugger prompt.
2515 (save-restriction
2516 (widen)
2517 (if (marker-buffer gud-delete-prompt-marker)
2518 (progn
2519 (delete-region (process-mark proc)
2520 gud-delete-prompt-marker)
2521 (set-marker gud-delete-prompt-marker nil)))
2522 ;; Save the process output, checking for source file markers.
2523 (setq output (gud-marker-filter string))
2524 ;; Check for a filename-and-line number.
2525 ;; Don't display the specified file
2526 ;; unless (1) point is at or after the position where output appears
2527 ;; and (2) this buffer is on the screen.
2528 (setq process-window
2529 (and gud-last-frame
2530 (>= (point) (process-mark proc))
2531 (get-buffer-window (current-buffer)))))
2533 ;; Let the comint filter do the actual insertion.
2534 ;; That lets us inherit various comint features.
2535 (comint-output-filter proc output))
2537 ;; Put the arrow on the source line.
2538 ;; This must be outside of the save-excursion
2539 ;; in case the source file is our current buffer.
2540 (if process-window
2541 (with-selected-window process-window
2542 (gud-display-frame))
2543 ;; We have to be in the proper buffer, (process-buffer proc),
2544 ;; but not in a save-excursion, because that would restore point.
2545 (with-current-buffer (process-buffer proc)
2546 (gud-display-frame))))
2548 ;; If we deferred text that arrived during this processing,
2549 ;; handle it now.
2550 (if gud-filter-pending-text
2551 (gud-filter proc ""))))))
2553 (defvar gud-minor-mode-type nil)
2554 (defvar gud-overlay-arrow-position nil)
2555 (add-to-list 'overlay-arrow-variable-list 'gud-overlay-arrow-position)
2557 (defun gud-sentinel (proc msg)
2558 (cond ((null (buffer-name (process-buffer proc)))
2559 ;; buffer killed
2560 ;; Stop displaying an arrow in a source file.
2561 (setq gud-overlay-arrow-position nil)
2562 (set-process-buffer proc nil)
2563 (if (memq gud-minor-mode-type '(gdbmi gdba))
2564 (gdb-reset)
2565 (gud-reset)))
2566 ((memq (process-status proc) '(signal exit))
2567 ;; Stop displaying an arrow in a source file.
2568 (setq gud-overlay-arrow-position nil)
2569 (with-current-buffer gud-comint-buffer
2570 (if (memq gud-minor-mode-type '(gdbmi gdba))
2571 (gdb-reset)
2572 (gud-reset)))
2573 (let* ((obuf (current-buffer)))
2574 ;; save-excursion isn't the right thing if
2575 ;; process-buffer is current-buffer
2576 (unwind-protect
2577 (progn
2578 ;; Write something in *compilation* and hack its mode line,
2579 (set-buffer (process-buffer proc))
2580 ;; Fix the mode line.
2581 (setq mode-line-process
2582 (concat ":"
2583 (symbol-name (process-status proc))))
2584 (force-mode-line-update)
2585 (if (eobp)
2587 (save-excursion
2588 (goto-char (point-max))
2590 ;; If buffer and mode line will show that the process
2591 ;; is dead, we can delete it now. Otherwise it
2592 ;; will stay around until M-x list-processes.
2593 (delete-process proc))
2594 ;; Restore old buffer, but don't restore old point
2595 ;; if obuf is the gud buffer.
2596 (set-buffer obuf))))))
2598 (defun gud-kill-buffer-hook ()
2599 (setq gud-minor-mode-type gud-minor-mode)
2600 (condition-case nil
2601 (kill-process (get-buffer-process (current-buffer)))
2602 (error nil)))
2604 (defun gud-reset ()
2605 (dolist (buffer (buffer-list))
2606 (unless (eq buffer gud-comint-buffer)
2607 (with-current-buffer buffer
2608 (when gud-minor-mode
2609 (setq gud-minor-mode nil)
2610 (kill-local-variable 'tool-bar-map))))))
2612 (defun gud-display-frame ()
2613 "Find and obey the last filename-and-line marker from the debugger.
2614 Obeying it means displaying in another window the specified file and line."
2615 (interactive)
2616 (when gud-last-frame
2617 (gud-set-buffer)
2618 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
2619 (setq gud-last-last-frame gud-last-frame
2620 gud-last-frame nil)))
2622 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
2623 ;; and that its line LINE is visible.
2624 ;; Put the overlay-arrow on the line LINE in that buffer.
2625 ;; Most of the trickiness in here comes from wanting to preserve the current
2626 ;; region-restriction if that's possible. We use an explicit display-buffer
2627 ;; to get around the fact that this is called inside a save-excursion.
2629 (defun gud-display-line (true-file line)
2630 (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
2631 (buffer
2632 (with-current-buffer gud-comint-buffer
2633 (gud-find-file true-file)))
2634 (window (and buffer (or (get-buffer-window buffer)
2635 (display-buffer buffer))))
2636 (pos))
2637 (if buffer
2638 (progn
2639 (with-current-buffer buffer
2640 (unless (or (verify-visited-file-modtime buffer) gud-keep-buffer)
2641 (if (yes-or-no-p
2642 (format "File %s changed on disk. Reread from disk? "
2643 (buffer-name)))
2644 (revert-buffer t t)
2645 (setq gud-keep-buffer t)))
2646 (save-restriction
2647 (widen)
2648 (goto-line line)
2649 (setq pos (point))
2650 (or gud-overlay-arrow-position
2651 (setq gud-overlay-arrow-position (make-marker)))
2652 (set-marker gud-overlay-arrow-position (point) (current-buffer)))
2653 (cond ((or (< pos (point-min)) (> pos (point-max)))
2654 (widen)
2655 (goto-char pos))))
2656 (if window (set-window-point window gud-overlay-arrow-position))))))
2658 ;; The gud-call function must do the right thing whether its invoking
2659 ;; keystroke is from the GUD buffer itself (via major-mode binding)
2660 ;; or a C buffer. In the former case, we want to supply data from
2661 ;; gud-last-frame. Here's how we do it:
2663 (defun gud-format-command (str arg)
2664 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
2665 (frame (or gud-last-frame gud-last-last-frame))
2666 result)
2668 (let ((key (string-to-char (match-string 2 str)))
2669 subst)
2670 (cond
2671 ((eq key ?f)
2672 (setq subst (file-name-nondirectory (if insource
2673 (buffer-file-name)
2674 (car frame)))))
2675 ((eq key ?F)
2676 (setq subst (file-name-sans-extension
2677 (file-name-nondirectory (if insource
2678 (buffer-file-name)
2679 (car frame))))))
2680 ((eq key ?d)
2681 (setq subst (file-name-directory (if insource
2682 (buffer-file-name)
2683 (car frame)))))
2684 ((eq key ?l)
2685 (setq subst (int-to-string
2686 (if insource
2687 (save-restriction
2688 (widen)
2689 (+ (count-lines (point-min) (point))
2690 (if (bolp) 1 0)))
2691 (cdr frame)))))
2692 ((eq key ?e)
2693 (setq subst (gud-find-expr)))
2694 ((eq key ?a)
2695 (setq subst (gud-read-address)))
2696 ((eq key ?c)
2697 (setq subst
2698 (gud-find-class
2699 (if insource
2700 (buffer-file-name)
2701 (car frame))
2702 (if insource
2703 (save-restriction
2704 (widen)
2705 (+ (count-lines (point-min) (point))
2706 (if (bolp) 1 0)))
2707 (cdr frame)))))
2708 ((eq key ?p)
2709 (setq subst (if arg (int-to-string arg)))))
2710 (setq result (concat result (match-string 1 str) subst)))
2711 (setq str (substring str (match-end 2))))
2712 ;; There might be text left in STR when the loop ends.
2713 (concat result str)))
2715 (defun gud-read-address ()
2716 "Return a string containing the core-address found in the buffer at point."
2717 (save-match-data
2718 (save-excursion
2719 (let ((pt (point)) found begin)
2720 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
2721 (cond
2722 (found (forward-char 2)
2723 (buffer-substring found
2724 (progn (re-search-forward "[^0-9a-f]")
2725 (forward-char -1)
2726 (point))))
2727 (t (setq begin (progn (re-search-backward "[^0-9]")
2728 (forward-char 1)
2729 (point)))
2730 (forward-char 1)
2731 (re-search-forward "[^0-9]")
2732 (forward-char -1)
2733 (buffer-substring begin (point))))))))
2735 (defun gud-call (fmt &optional arg)
2736 (let ((msg (gud-format-command fmt arg)))
2737 (message "Command: %s" msg)
2738 (sit-for 0)
2739 (gud-basic-call msg)))
2741 (defun gud-basic-call (command)
2742 "Invoke the debugger COMMAND displaying source in other window."
2743 (interactive)
2744 (gud-set-buffer)
2745 (let ((proc (get-buffer-process gud-comint-buffer)))
2746 (or proc (error "Current buffer has no process"))
2747 ;; Arrange for the current prompt to get deleted.
2748 (save-excursion
2749 (set-buffer gud-comint-buffer)
2750 (save-restriction
2751 (widen)
2752 (goto-char (process-mark proc))
2753 (forward-line 0)
2754 (if (looking-at comint-prompt-regexp)
2755 (set-marker gud-delete-prompt-marker (point)))
2756 (if (memq gud-minor-mode '(gdbmi gdba))
2757 (apply comint-input-sender (list proc command))
2760 (defun gud-refresh (&optional arg)
2761 "Fix up a possibly garbled display, and redraw the arrow."
2762 (interactive "P")
2763 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
2764 (gud-display-frame)
2765 (recenter arg))
2766 \f
2767 ;; Code for parsing expressions out of C or Fortran code. The single entry
2768 ;; point is gud-find-expr, which tries to return an lvalue expression from
2769 ;; around point.
2771 (defvar gud-find-expr-function 'gud-find-c-expr)
2773 (defun gud-find-expr (&rest args)
2774 (apply gud-find-expr-function args))
2776 ;; The next eight functions are hacked from gdbsrc.el by
2777 ;; Debby Ayers <ayers@asc.slb.com>,
2778 ;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
2780 (defun gud-find-c-expr ()
2781 "Returns the expr that surrounds point."
2782 (interactive)
2783 (save-excursion
2784 (let ((p (point))
2785 (expr (gud-innermost-expr))
2786 (test-expr (gud-prev-expr)))
2787 (while (and test-expr (gud-expr-compound test-expr expr))
2788 (let ((prev-expr expr))
2789 (setq expr (cons (car test-expr) (cdr expr)))
2790 (goto-char (car expr))
2791 (setq test-expr (gud-prev-expr))
2792 ;; If we just pasted on the condition of an if or while,
2793 ;; throw it away again.
2794 (if (member (buffer-substring (car test-expr) (cdr test-expr))
2795 '("if" "while" "for"))
2796 (setq test-expr nil
2797 expr prev-expr))))
2798 (goto-char p)
2799 (setq test-expr (gud-next-expr))
2800 (while (gud-expr-compound expr test-expr)
2801 (setq expr (cons (car expr) (cdr test-expr)))
2802 (setq test-expr (gud-next-expr)))
2803 (buffer-substring (car expr) (cdr expr)))))
2805 (defun gud-innermost-expr ()
2806 "Returns the smallest expr that point is in; move point to beginning of it.
2807 The expr is represented as a cons cell, where the car specifies the point in
2808 the current buffer that marks the beginning of the expr and the cdr specifies
2809 the character after the end of the expr."
2810 (let ((p (point)) begin end)
2811 (gud-backward-sexp)
2812 (setq begin (point))
2813 (gud-forward-sexp)
2814 (setq end (point))
2815 (if (>= p end)
2816 (progn
2817 (setq begin p)
2818 (goto-char p)
2819 (gud-forward-sexp)
2820 (setq end (point)))
2821 )
2822 (goto-char begin)
2823 (cons begin end)))
2825 (defun gud-backward-sexp ()
2826 "Version of `backward-sexp' that catches errors."
2827 (condition-case nil
2828 (backward-sexp)
2829 (error t)))
2831 (defun gud-forward-sexp ()
2832 "Version of `forward-sexp' that catches errors."
2833 (condition-case nil
2834 (forward-sexp)
2835 (error t)))
2837 (defun gud-prev-expr ()
2838 "Returns the previous expr, point is set to beginning of that expr.
2839 The expr is represented as a cons cell, where the car specifies the point in
2840 the current buffer that marks the beginning of the expr and the cdr specifies
2841 the character after the end of the expr"
2842 (let ((begin) (end))
2843 (gud-backward-sexp)
2844 (setq begin (point))
2845 (gud-forward-sexp)
2846 (setq end (point))
2847 (goto-char begin)
2848 (cons begin end)))
2850 (defun gud-next-expr ()
2851 "Returns the following expr, point is set to beginning of that expr.
2852 The expr is represented as a cons cell, where the car specifies the point in
2853 the current buffer that marks the beginning of the expr and the cdr specifies
2854 the character after the end of the expr."
2855 (let ((begin) (end))
2856 (gud-forward-sexp)
2857 (gud-forward-sexp)
2858 (setq end (point))
2859 (gud-backward-sexp)
2860 (setq begin (point))
2861 (cons begin end)))
2863 (defun gud-expr-compound-sep (span-start span-end)
2864 "Scan from SPAN-START to SPAN-END for punctuation characters.
2865 If `->' is found, return `?.'. If `.' is found, return `?.'.
2866 If any other punctuation is found, return `??'.
2867 If no punctuation is found, return `? '."
2868 (let ((result ?\ )
2869 (syntax))
2870 (while (< span-start span-end)
2871 (setq syntax (char-syntax (char-after span-start)))
2872 (cond
2873 ((= syntax ?\ ) t)
2874 ((= syntax ?.) (setq syntax (char-after span-start))
2875 (cond
2876 ((= syntax ?.) (setq result ?.))
2877 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
2878 (setq result ?.)
2879 (setq span-start (+ span-start 1)))
2880 (t (setq span-start span-end)
2881 (setq result ??)))))
2882 (setq span-start (+ span-start 1)))
2883 result))
2885 (defun gud-expr-compound (first second)
2886 "Non-nil if concatenating FIRST and SECOND makes a single C expression.
2887 The two exprs are represented as a cons cells, where the car
2888 specifies the point in the current buffer that marks the beginning of the
2889 expr and the cdr specifies the character after the end of the expr.
2890 Link exprs of the form:
2891 Expr -> Expr
2892 Expr . Expr
2893 Expr (Expr)
2894 Expr [Expr]
2895 (Expr) Expr
2896 [Expr] Expr"
2897 (let ((span-start (cdr first))
2898 (span-end (car second))
2899 (syntax))
2900 (setq syntax (gud-expr-compound-sep span-start span-end))
2901 (cond
2902 ((= (car first) (car second)) nil)
2903 ((= (cdr first) (cdr second)) nil)
2904 ((= syntax ?.) t)
2905 ((= syntax ?\ )
2906 (setq span-start (char-after (- span-start 1)))
2907 (setq span-end (char-after span-end))
2908 (cond
2909 ((= span-start ?)) t)
2910 ((= span-start ?]) t)
2911 ((= span-end ?() t)
2912 ((= span-end ?[) t)
2913 (t nil)))
2914 (t nil))))
2916 (defun gud-find-class (f line)
2917 "Find fully qualified class in file F at line LINE.
2918 This function uses the `gud-jdb-classpath' (and optional
2919 `gud-jdb-sourcepath') list(s) to derive a file
2920 pathname relative to its classpath directory. The values in
2921 `gud-jdb-classpath' are assumed to have been converted to absolute
2922 pathname standards using file-truename.
2923 If F is visited by a buffer and its mode is CC-mode(Java),
2924 syntactic information of LINE is used to find the enclosing (nested)
2925 class string which is appended to the top level
2926 class of the file (using s to separate nested class ids)."
2927 ;; Convert f to a standard representation and remove suffix
2928 (if (and gud-jdb-use-classpath (or gud-jdb-classpath gud-jdb-sourcepath))
2929 (save-match-data
2930 (let ((cplist (append gud-jdb-sourcepath gud-jdb-classpath))
2931 (fbuffer (get-file-buffer f))
2932 syntax-symbol syntax-point class-found)
2933 (setq f (file-name-sans-extension (file-truename f)))
2934 ;; Syntax-symbol returns the symbol of the *first* element
2935 ;; in the syntactical analysis result list, syntax-point
2936 ;; returns the buffer position of same
2937 (fset 'syntax-symbol (lambda (x) (c-langelem-sym (car x))))
2938 (fset 'syntax-point (lambda (x) (c-langelem-pos (car x))))
2939 ;; Search through classpath list for an entry that is
2940 ;; contained in f
2941 (while (and cplist (not class-found))
2942 (if (string-match (car cplist) f)
2943 (setq class-found
2944 (mapconcat 'identity
2945 (split-string
2946 (substring f (+ (match-end 0) 1))
2947 "/") ".")))
2948 (setq cplist (cdr cplist)))
2949 ;; if f is visited by a java(cc-mode) buffer, walk up the
2950 ;; syntactic information chain and collect any 'inclass
2951 ;; symbols until 'topmost-intro is reached to find out if
2952 ;; point is within a nested class
2953 (if (and fbuffer (equal (symbol-file 'java-mode) "cc-mode"))
2954 (save-excursion
2955 (set-buffer fbuffer)
2956 (let ((nclass) (syntax))
2957 ;; While the c-syntactic information does not start
2958 ;; with the 'topmost-intro symbol, there may be
2959 ;; nested classes...
2960 (while (not (eq 'topmost-intro
2961 (syntax-symbol (c-guess-basic-syntax))))
2962 ;; Check if the current position c-syntactic
2963 ;; analysis has 'inclass
2964 (setq syntax (c-guess-basic-syntax))
2965 (while
2966 (and (not (eq 'inclass (syntax-symbol syntax)))
2967 (cdr syntax))
2968 (setq syntax (cdr syntax)))
2969 (if (eq 'inclass (syntax-symbol syntax))
2970 (progn
2971 (goto-char (syntax-point syntax))
2972 ;; Now we're at the beginning of a class
2973 ;; definition. Find class name
2974 (looking-at
2976 (setq nclass
2977 (append (list (match-string-no-properties 1))
2978 nclass)))
2979 (setq syntax (c-guess-basic-syntax))
2980 (while (and (not (syntax-point syntax)) (cdr syntax))
2981 (setq syntax (cdr syntax)))
2982 (goto-char (syntax-point syntax))
2983 ))
2984 (string-match (concat (car nclass) "$") class-found)
2985 (setq class-found
2986 (replace-match (mapconcat 'identity nclass "$")
2987 t t class-found)))))
2988 (if (not class-found)
2989 (message "gud-find-class: class for file %s not found!" f))
2990 class-found))
2991 ;; Not using classpath - try class/source association list
2992 (let ((class-found (rassoc f gud-jdb-class-source-alist)))
2993 (if class-found
2994 (car class-found)
2995 (message "gud-find-class: class for file %s not found in gud-jdb-class-source-alist!" f)
2996 nil))))
2998 \f
2999 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3000 ;;; GDB script mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3001 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3003 (defvar gdb-script-mode-syntax-table
3004 (let ((st (make-syntax-table)))
3006 (modify-syntax-entry ?# "<" st)
3008 st))
3010 (defvar gdb-script-font-lock-keywords
3015 (defvar gdb-script-font-lock-syntactic-keywords
3020 (defun gdb-script-font-lock-syntactic-face (state)
3021 (cond
3022 ((nth 3 state) font-lock-string-face)
3023 ((nth 7 state) font-lock-doc-face)
3024 (t font-lock-comment-face)))
3026 (defvar gdb-script-basic-indent 2)
3028 (defun gdb-script-skip-to-head ()
3029 "We're just in front of an `end' and we need to go to its head."
3030 (while (and (re-search-backward "^\\s-*\\(\\(end\\)\\|define\\|document\\|if\\|while\\)\\>" nil 'move)
3031 (match-end 2))
3032 (gdb-script-skip-to-head)))
3034 (defun gdb-script-calculate-indentation ()
3035 (cond
3037 (gdb-script-skip-to-head)
3038 (current-indentation))
3041 (match-end 2))
3042 (gdb-script-skip-to-head))
3043 (current-indentation))
3044 (t
3045 (forward-comment (- (point-max)))
3046 (forward-line 0)
3048 (+ (current-indentation)
3050 gdb-script-basic-indent 0)))))
3052 (defun gdb-script-indent-line ()
3053 "Indent current line of GDB script."
3054 (interactive)
3055 (if (and (eq (get-text-property (point) 'face) font-lock-doc-face)
3056 (save-excursion
3057 (forward-line 0)
3060 'noindent
3061 (let* ((savep (point))
3062 (indent (condition-case nil
3063 (save-excursion
3064 (forward-line 0)
3066 (if (>= (point) savep) (setq savep nil))
3067 (max (gdb-script-calculate-indentation) 0))
3068 (error 0))))
3069 (if savep
3070 (save-excursion (indent-line-to indent))
3071 (indent-line-to indent)))))
3073 ;; Derived from cfengine.el.
3074 (defun gdb-script-beginning-of-defun ()
3075 "`beginning-of-defun' function for Gdb script mode.
3076 Treats actions as defuns."
3077 (unless (<= (current-column) (current-indentation))
3078 (end-of-line))
3080 (beginning-of-line)
3081 (goto-char (point-min)))
3082 t)
3084 ;; Derived from cfengine.el.
3085 (defun gdb-script-end-of-defun ()
3086 "`end-of-defun' function for Gdb script mode.
3087 Treats actions as defuns."
3088 (end-of-line)
3089 (if (re-search-forward "^end" nil t)
3090 (beginning-of-line)
3091 (goto-char (point-max)))
3092 t)
3094 ;;;###autoload
3097 ;;;###autoload
3098 (define-derived-mode gdb-script-mode nil "GDB-Script"
3099 "Major mode for editing GDB scripts"
3100 (set (make-local-variable 'comment-start) "#")
3103 (set (make-local-variable 'imenu-generic-expression)
3105 (set (make-local-variable 'indent-line-function) 'gdb-script-indent-line)
3106 (set (make-local-variable 'beginning-of-defun-function)
3107 #'gdb-script-beginning-of-defun)
3108 (set (make-local-variable 'end-of-defun-function)
3109 #'gdb-script-end-of-defun)
3110 (set (make-local-variable 'font-lock-defaults)
3111 '(gdb-script-font-lock-keywords nil nil ((?_ . "w")) nil
3112 (font-lock-syntactic-keywords
3113 . gdb-script-font-lock-syntactic-keywords)
3114 (font-lock-syntactic-face-function
3115 . gdb-script-font-lock-syntactic-face))))
3117 \f
3118 ;;; tooltips for GUD
3120 ;;; Customizable settings
3121 (defcustom gud-tooltip-modes '(gud-mode c-mode c++-mode fortran-mode)
3122 "List of modes for which to enable GUD tips."
3123 :type 'sexp
3124 :tag "GUD modes"
3125 :group 'tooltip)
3127 (defcustom gud-tooltip-display
3128 '((eq (tooltip-event-buffer gud-tooltip-event)
3129 (marker-buffer gud-overlay-arrow-position)))
3130 "List of forms determining where GUD tooltips are displayed.
3132 Forms in the list are combined with AND. The default is to display
3133 only tooltips in the buffer containing the overlay arrow."
3134 :type 'sexp
3135 :tag "GUD buffers predicate"
3136 :group 'tooltip)
3138 (defcustom gud-tooltip-echo-area nil
3139 "Use the echo area instead of frames for GUD tooltips."
3140 :type 'boolean
3141 :tag "Use echo area"
3142 :group 'tooltip)
3144 (define-obsolete-variable-alias 'tooltip-gud-modes
3145 'gud-tooltip-modes "22.1")
3146 (define-obsolete-variable-alias 'tooltip-gud-display
3147 'gud-tooltip-display "22.1")
3149 ;;; Reacting on mouse movements
3151 (defun gud-tooltip-change-major-mode ()
3152 "Function added to `change-major-mode-hook' when tooltip mode is on."
3153 (add-hook 'post-command-hook 'gud-tooltip-activate-mouse-motions-if-enabled))
3155 (defun gud-tooltip-activate-mouse-motions-if-enabled ()
3156 "Reconsider for all buffers whether mouse motion events are desired."
3157 (remove-hook 'post-command-hook
3158 'gud-tooltip-activate-mouse-motions-if-enabled)
3159 (dolist (buffer (buffer-list))
3160 (save-excursion
3161 (set-buffer buffer)
3162 (if (and gud-tooltip-mode
3163 (memq major-mode gud-tooltip-modes))
3164 (gud-tooltip-activate-mouse-motions t)
3165 (gud-tooltip-activate-mouse-motions nil)))))
3167 (defvar gud-tooltip-mouse-motions-active nil
3168 "Locally t in a buffer if tooltip processing of mouse motion is enabled.")
3170 (defun gud-tooltip-activate-mouse-motions (activatep)
3171 "Activate/deactivate mouse motion events for the current buffer.
3172 ACTIVATEP non-nil means activate mouse motion events."
3173 (if activatep
3174 (progn
3175 (make-local-variable 'gud-tooltip-mouse-motions-active)
3176 (setq gud-tooltip-mouse-motions-active t)
3177 (make-local-variable 'track-mouse)
3178 (setq track-mouse t))
3179 (when gud-tooltip-mouse-motions-active
3180 (kill-local-variable 'gud-tooltip-mouse-motions-active)
3181 (kill-local-variable 'track-mouse))))
3183 (defun gud-tooltip-mouse-motion (event)
3184 "Command handler for mouse movement events in `global-map'."
3185 (interactive "e")
3186 (tooltip-hide)
3187 (when (car (mouse-pixel-position))
3188 (setq tooltip-last-mouse-motion-event (copy-sequence event))
3189 (tooltip-start-delayed-tip)))
3191 ;;; Tips for `gud'
3193 (defvar gud-tooltip-original-filter nil
3194 "Process filter to restore after GUD output has been received.")
3196 (defvar gud-tooltip-dereference nil
3197 "Non-nil means print expressions with a `*' in front of them.
3198 For C this would dereference a pointer expression.")
3200 (defvar gud-tooltip-event nil
3201 "The mouse movement event that led to a tooltip display.
3202 This event can be examined by forms in GUD-TOOLTIP-DISPLAY.")
3204 (defun toggle-gud-tooltip-dereference ()
3205 "Toggle whether tooltips should show `* expr' or `expr'."
3206 (interactive)
3207 (setq gud-tooltip-dereference (not gud-tooltip-dereference))
3208 (when (interactive-p)
3209 (message "Dereferencing is now %s."
3210 (if gud-tooltip-dereference "on" "off"))))
3212 (define-obsolete-function-alias 'tooltip-gud-toggle-dereference
3213 'toggle-gud-tooltip-dereference "22.1")
3215 ;;;###autoload
3216 (define-minor-mode gud-tooltip-mode
3217 "Toggle the display of GUD tooltips."
3218 :global t
3219 :group 'gud
3220 (require 'tooltip)
3221 (if gud-tooltip-mode
3222 (progn
3223 (add-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3224 (add-hook 'pre-command-hook 'tooltip-hide)
3225 (add-hook 'tooltip-hook 'gud-tooltip-tips)
3226 (define-key global-map [mouse-movement] 'gud-tooltip-mouse-motion))
3227 (unless tooltip-mode (remove-hook 'pre-command-hook 'tooltip-hide)
3228 (remove-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3229 (remove-hook 'tooltip-hook 'gud-tooltip-tips)
3230 (define-key global-map [mouse-movement] 'ignore)))
3231 (gud-tooltip-activate-mouse-motions-if-enabled)
3232 (if (and
3233 gud-comint-buffer
3234 (buffer-name gud-comint-buffer); gud-comint-buffer might be kille
3235 (with-current-buffer gud-comint-buffer
3236 (memq gud-minor-mode '(gdbmi gdba))))
3237 (if gud-tooltip-mode
3238 (progn
3239 (dolist (buffer (buffer-list))
3240 (unless (eq buffer gud-comint-buffer)
3241 (with-current-buffer buffer
3242 (when (and (memq gud-minor-mode '(gdbmi gdba))
3244 (buffer-name))))
3245 (make-local-variable 'gdb-define-alist)
3246 (gdb-create-define-alist)
3247 (add-hook 'after-save-hook
3248 'gdb-create-define-alist nil t))))))
3249 (kill-local-variable 'gdb-define-alist)
3250 (remove-hook 'after-save-hook 'gdb-create-define-alist t))))
3252 ; This will only display data that comes in one chunk.
3253 ; Larger arrays (say 400 elements) are displayed in
3254 ; the tooltip incompletely and spill over into the gud buffer.
3255 ; Switching the process-filter creates timing problems and
3256 ; it may be difficult to do better. Using annotations as in
3257 ; gdb-ui.el gets round this problem.
3258 (defun gud-tooltip-process-output (process output)
3259 "Process debugger output and show it in a tooltip window."
3260 (set-process-filter process gud-tooltip-original-filter)
3261 (tooltip-show (tooltip-strip-prompt process output)
3262 (or gud-tooltip-echo-area tooltip-use-echo-area)))
3264 (defun gud-tooltip-print-command (expr)
3265 "Return a suitable command to print the expression EXPR.
3266 If GUD-TOOLTIP-DEREFERENCE is t, also prepend a `*' to EXPR."
3267 (when gud-tooltip-dereference
3268 (setq expr (concat "*" expr)))
3269 (case gud-minor-mode
3270 (gdba (concat "server print " expr))
3271 ((dbx gdbmi) (concat "print " expr))
3272 (xdb (concat "p " expr))
3273 (sdb (concat expr "/"))
3274 (perldb expr)))
3276 (defun gud-tooltip-tips (event)
3277 "Show tip for identifier or selection under the mouse.
3278 The mouse must either point at an identifier or inside a selected
3279 region for the tip window to be shown. If gud-tooltip-dereference is t,
3280 add a `*' in front of the printed expression. In the case of a C program
3281 controlled by GDB, show the associated #define directives when program is
3282 not executing.
3284 This function must return nil if it doesn't handle EVENT."
3285 (let (process)
3286 (when (and (eventp event)
3287 gud-tooltip-mode
3288 (boundp 'gud-comint-buffer)
3289 gud-comint-buffer
3290 (buffer-name gud-comint-buffer); gud-comint-buffer might be killed
3291 (setq process (get-buffer-process gud-comint-buffer))
3292 (posn-point (event-end event))
3293 (or (and (eq gud-minor-mode 'gdba) (not gdb-active-process))
3294 (progn (setq gud-tooltip-event event)
3295 (eval (cons 'and gud-tooltip-display)))))
3296 (let ((expr (tooltip-expr-to-print event)))
3297 (when expr
3298 (if (and (eq gud-minor-mode 'gdba)
3299 (not gdb-active-process))
3300 (progn
3301 (with-current-buffer
3302 (window-buffer (let ((mouse (mouse-position)))
3303 (window-at (cadr mouse)
3304 (cddr mouse))))
3305 (let ((define-elt (assoc expr gdb-define-alist)))
3306 (unless (null define-elt)
3307 (tooltip-show
3308 (cdr define-elt)
3309 (or gud-tooltip-echo-area tooltip-use-echo-area))
3310 expr))))
3311 (let ((cmd (gud-tooltip-print-command expr)))
3312 (when (and gud-tooltip-mode (eq gud-minor-mode 'gdb))
3313 (gud-tooltip-mode -1)
3315 so they have been disabled."))
3316 (unless (null cmd) ; CMD can be nil if unknown debugger
3317 (if (memq gud-minor-mode '(gdba gdbmi))
3318 (if gdb-macro-info
3319 (gdb-enqueue-input
3320 (list (concat
3322 `(lambda () (gdb-tooltip-print-1 ,expr))))
3323 (gdb-enqueue-input
3325 (setq gud-tooltip-original-filter (process-filter process))
3326 (set-process-filter process 'gud-tooltip-process-output)
3327 (gud-basic-call cmd))
3328 expr))))))))
3330 (provide 'gud)
3332 ;;; arch-tag: 6d990948-df65-461a-be39-1c7fb83ac4c4
3333 ;;; gud.el ends here