(vc-mcvs-mode-line-string): Fix thinko.
[emacs.git] / lisp / gud.el
blob6d192081719d6531bccff41cf27ed559f6adca86
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,93,94,95,96,1998,2000,2002 Free Software Foundation, Inc.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Commentary:
28 ;; The ancestral gdb.el was by W. Schelter <wfs@rascal.ics.utexas.edu>
29 ;; It was later rewritten by rms. Some ideas were due to Masanobu.
30 ;; Grand Unification (sdb/dbx support) by Eric S. Raymond <esr@thyrsus.com>
31 ;; The overloading code was then rewritten by Barry Warsaw <bwarsaw@cen.com>,
32 ;; who also hacked the mode to use comint.el. Shane Hartman <shane@spr.com>
33 ;; added support for xdb (HPUX debugger). Rick Sladkey <jrs@world.std.com>
34 ;; wrote the GDB command completion code. Dave Love <d.love@dl.ac.uk>
35 ;; added the IRIX kluge, re-implemented the Mips-ish variant and added
36 ;; a menu. Brian D. Carlstrom <bdc@ai.mit.edu> combined the IRIX kluge with
37 ;; the gud-xdb-directories hack producing gud-dbx-directories. Derek L. Davies
38 ;; <ddavies@world.std.com> added support for jdb (Java debugger.)
40 ;;; Code:
42 (require 'comint)
43 (require 'etags)
45 ;; ======================================================================
46 ;; GUD commands must be visible in C buffers visited by GUD
48 (defgroup gud nil
49 "Grand Unified Debugger mode for gdb and other debuggers under Emacs.
50 Supported debuggers include gdb, sdb, dbx, xdb, perldb, pdb (Python), jdb, and bash."
51 :group 'unix
52 :group 'tools)
55 (defcustom gud-key-prefix "\C-x\C-a"
56 "Prefix of all GUD commands valid in C buffers."
57 :type 'string
58 :group 'gud)
60 (global-set-key (concat gud-key-prefix "\C-l") 'gud-refresh)
61 (define-key ctl-x-map " " 'gud-break) ;; backward compatibility hack
63 (defvar gud-marker-filter nil)
64 (put 'gud-marker-filter 'permanent-local t)
65 (defvar gud-find-file nil)
66 (put 'gud-find-file 'permanent-local t)
68 (defun gud-marker-filter (&rest args)
69 (apply gud-marker-filter args))
71 (defvar gud-minor-mode nil)
72 (put 'gud-minor-mode 'permanent-local t)
74 (defvar gud-keep-buffer nil)
76 (defun gud-symbol (sym &optional soft minor-mode)
77 "Return the symbol used for SYM in MINOR-MODE.
78 MINOR-MODE defaults to `gud-minor-mode.
79 The symbol returned is `gud-<MINOR-MODE>-<SYM>'.
80 If SOFT is non-nil, returns nil if the symbol doesn't already exist."
81 (unless (or minor-mode gud-minor-mode) (error "Gud internal error"))
82 (funcall (if soft 'intern-soft 'intern)
83 (format "gud-%s-%s" (or minor-mode gud-minor-mode) sym)))
85 (defun gud-val (sym &optional minor-mode)
86 "Return the value of `gud-symbol' SYM. Default to nil."
87 (let ((sym (gud-symbol sym t minor-mode)))
88 (if (boundp sym) (symbol-value sym))))
90 (defvar gud-running nil
91 "Non-nil if debuggee is running.
92 Used to grey out relevant toolbar icons.")
94 (easy-mmode-defmap gud-menu-map
95 '(([refresh] "Refresh" . gud-refresh)
96 ([run] menu-item "Run" gud-run
97 :enable (and (not gud-running)
98 (memq gud-minor-mode '(gdba gdb jdb))))
99 ([goto] menu-item "Continue to selection" gud-until
100 :enable (and (not gud-running)
101 (memq gud-minor-mode '(gdba gdb))))
102 ([remove] menu-item "Remove Breakpoint" gud-remove
103 :enable (not gud-running))
104 ([tbreak] menu-item "Temporary Breakpoint" gud-tbreak
105 :enable (memq gud-minor-mode '(gdba gdb sdb xdb bashdb)))
106 ([break] menu-item "Set Breakpoint" gud-break
107 :enable (not gud-running))
108 ([up] menu-item "Up Stack" gud-up
109 :enable (and (not gud-running)
110 (memq gud-minor-mode
111 '(gdba gdb dbx xdb jdb pdb bashdb))))
112 ([down] menu-item "Down Stack" gud-down
113 :enable (and (not gud-running)
114 (memq gud-minor-mode
115 '(gdba gdb dbx xdb jdb pdb bashdb))))
116 ([print] menu-item "Print Expression" gud-print
117 :enable (not gud-running))
118 ([display] menu-item "Display Expression" gud-display
119 :enable (and (not gud-running)
120 (eq gud-minor-mode 'gdba)))
121 ([finish] menu-item "Finish Function" gud-finish
122 :enable (and (not gud-running)
123 (memq gud-minor-mode
124 '(gdba gdb xdb jdb pdb bashdb))))
125 ([stepi] "Step Instruction" . gud-stepi)
126 ([step] menu-item "Step Line" gud-step
127 :enable (not gud-running))
128 ([next] menu-item "Next Line" gud-next
129 :enable (not gud-running))
130 ([cont] menu-item "Continue" gud-cont
131 :enable (not gud-running)))
132 "Menu for `gud-mode'."
133 :name "Gud")
135 (easy-mmode-defmap gud-minor-mode-map
136 `(([menu-bar debug] . ("Gud" . ,gud-menu-map)))
137 "Map used in visited files.")
139 (let ((m (assq 'gud-minor-mode minor-mode-map-alist)))
140 (if m (setcdr m gud-minor-mode-map)
141 (push (cons 'gud-minor-mode gud-minor-mode-map) minor-mode-map-alist)))
143 (defvar gud-mode-map
144 ;; Will inherit from comint-mode via define-derived-mode.
145 (make-sparse-keymap)
146 "`gud-mode' keymap.")
148 (defvar gud-tool-bar-map
149 (if (display-graphic-p)
150 (let ((map (make-sparse-keymap)))
151 (dolist (x '((gud-break . "gud-break")
152 (gud-remove . "gud-remove")
153 (gud-print . "gud-print")
154 (gud-display . "gud-display")
155 (gud-run . "gud-run")
156 (gud-until . "gud-until")
157 (gud-cont . "gud-cont")
158 (gud-step . "gud-step")
159 (gud-next . "gud-next")
160 (gud-finish . "gud-finish")
161 (gud-up . "gud-up")
162 (gud-down . "gud-down"))
163 map)
164 (tool-bar-local-item-from-menu
165 (car x) (cdr x) map gud-minor-mode-map)))))
167 (defun gud-file-name (f)
168 "Transform a relative file name to an absolute file name.
169 Uses `gud-<MINOR-MODE>-directories' to find the source files."
170 (if (file-exists-p f) (expand-file-name f)
171 (let ((directories (gud-val 'directories))
172 (result nil))
173 (while directories
174 (let ((path (expand-file-name f (car directories))))
175 (if (file-exists-p path)
176 (setq result path
177 directories nil)))
178 (setq directories (cdr directories)))
179 result)))
181 (defun gud-find-file (file)
182 ;; Don't get confused by double slashes in the name that comes from GDB.
183 (while (string-match "//+" file)
184 (setq file (replace-match "/" t t file)))
185 (let ((minor-mode gud-minor-mode)
186 (buf (funcall (or gud-find-file 'gud-file-name) file)))
187 (when (stringp buf)
188 (setq buf (and (file-readable-p buf) (find-file-noselect buf 'nowarn))))
189 (when buf
190 ;; Copy `gud-minor-mode' to the found buffer to turn on the menu.
191 (with-current-buffer buf
192 (set (make-local-variable 'gud-minor-mode) minor-mode)
193 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
194 (make-local-variable 'gud-keep-buffer))
195 buf)))
197 ;; ======================================================================
198 ;; command definition
200 ;; This macro is used below to define some basic debugger interface commands.
201 ;; Of course you may use `gud-def' with any other debugger command, including
202 ;; user defined ones.
204 ;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
205 ;; which defines FUNC to send the command NAME to the debugger, gives
206 ;; it the docstring DOC, and binds that function to KEY in the GUD
207 ;; major mode. The function is also bound in the global keymap with the
208 ;; GUD prefix.
210 (defmacro gud-def (func cmd key &optional doc)
211 "Define FUNC to be a command sending STR and bound to KEY, with
212 optional doc string DOC. Certain %-escapes in the string arguments
213 are interpreted specially if present. These are:
215 %f name (without directory) of current source file.
216 %F name (without directory or extension) of current source file.
217 %d directory of current source file.
218 %l number of current source line
219 %e text of the C lvalue or function-call expression surrounding point.
220 %a text of the hexadecimal address surrounding point
221 %p prefix argument to the command (if any) as a number
223 The `current' source file is the file of the current buffer (if
224 we're in a C file) or the source file current at the last break or
225 step (if we're in the GUD buffer).
226 The `current' line is that of the current buffer (if we're in a
227 source file) or the source line number at the last break or step (if
228 we're in the GUD buffer)."
229 `(progn
230 (defun ,func (arg)
231 ,@(if doc (list doc))
232 (interactive "p")
233 ,(if (stringp cmd)
234 `(gud-call ,cmd arg)
235 cmd))
236 ,(if key `(local-set-key ,(concat "\C-c" key) ',func))
237 ,(if key `(global-set-key (vconcat gud-key-prefix ,key) ',func))))
239 ;; Where gud-display-frame should put the debugging arrow; a cons of
240 ;; (filename . line-number). This is set by the marker-filter, which scans
241 ;; the debugger's output for indications of the current program counter.
242 (defvar gud-last-frame nil)
244 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
245 ;; the last frame, even if it's been called before and gud-last-frame has
246 ;; been set to nil.
247 (defvar gud-last-last-frame nil)
249 ;; All debugger-specific information is collected here.
250 ;; Here's how it works, in case you ever need to add a debugger to the mode.
252 ;; Each entry must define the following at startup:
254 ;;<name>
255 ;; comint-prompt-regexp
256 ;; gud-<name>-massage-args
257 ;; gud-<name>-marker-filter
258 ;; gud-<name>-find-file
260 ;; The job of the massage-args method is to modify the given list of
261 ;; debugger arguments before running the debugger.
263 ;; The job of the marker-filter method is to detect file/line markers in
264 ;; strings and set the global gud-last-frame to indicate what display
265 ;; action (if any) should be triggered by the marker. Note that only
266 ;; whatever the method *returns* is displayed in the buffer; thus, you
267 ;; can filter the debugger's output, interpreting some and passing on
268 ;; the rest.
270 ;; The job of the find-file method is to visit and return the buffer indicated
271 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
272 ;; something else.
274 ;; ======================================================================
275 ;; speedbar support functions and variables.
276 (eval-when-compile (require 'speedbar)) ;For speedbar-with-attached-buffer.
278 (defvar gud-last-speedbar-buffer nil
279 "The last GUD buffer used.")
281 (defvar gud-last-speedbar-stackframe nil
282 "Description of the currently displayed GUD stack.
283 t means that there is no stack, and we are in display-file mode.")
285 (defvar gud-speedbar-key-map nil
286 "Keymap used when in the buffers display mode.")
288 (defun gud-install-speedbar-variables ()
289 "Install those variables used by speedbar to enhance gud/gdb."
290 (if gud-speedbar-key-map
292 (setq gud-speedbar-key-map (speedbar-make-specialized-keymap))
294 (define-key gud-speedbar-key-map "j" 'speedbar-edit-line)
295 (define-key gud-speedbar-key-map "e" 'speedbar-edit-line)
296 (define-key gud-speedbar-key-map "\C-m" 'speedbar-edit-line)))
298 (defvar gud-speedbar-menu-items
299 ;; Note to self. Add expand, and turn off items when not available.
300 '(["Jump to stack frame" speedbar-edit-line t])
301 "Additional menu items to add to the speedbar frame.")
303 ;; Make sure our special speedbar mode is loaded
304 (if (featurep 'speedbar)
305 (gud-install-speedbar-variables)
306 (add-hook 'speedbar-load-hook 'gud-install-speedbar-variables))
308 (defun gud-speedbar-buttons (buffer)
309 "Create a speedbar display based on the current state of GUD.
310 If the GUD BUFFER is not running a supported debugger, then turn
311 off the specialized speedbar mode."
312 (if (and (save-excursion (goto-char (point-min))
313 (looking-at "Current Stack"))
314 (equal gud-last-last-frame gud-last-speedbar-stackframe))
316 (setq gud-last-speedbar-buffer buffer)
317 (let* ((minor-mode (with-current-buffer buffer gud-minor-mode))
318 (frames
319 (cond ((memq minor-mode '(gdba gdb))
320 (gud-gdb-get-stackframe buffer))
321 ;; Add more debuggers here!
323 (speedbar-remove-localized-speedbar-support buffer)
324 nil))))
325 (erase-buffer)
326 (if (not frames)
327 (insert "No Stack frames\n")
328 (insert "Current Stack:\n"))
329 (while frames
330 (insert (nth 1 (car frames)) ":\n")
331 (if (= (length (car frames)) 2)
332 (progn
333 ; (speedbar-insert-button "[?]"
334 ; 'speedbar-button-face
335 ; nil nil nil t)
336 (speedbar-insert-button (car (car frames))
337 'speedbar-directory-face
338 nil nil nil t))
339 ; (speedbar-insert-button "[+]"
340 ; 'speedbar-button-face
341 ; 'speedbar-highlight-face
342 ; 'gud-gdb-get-scope-data
343 ; (car frames) t)
344 (speedbar-insert-button (car (car frames))
345 'speedbar-file-face
346 'speedbar-highlight-face
347 (cond ((memq minor-mode '(gdba gdb))
348 'gud-gdb-goto-stackframe)
349 (t (error "Should never be here")))
350 (car frames) t))
351 (setq frames (cdr frames)))
352 ; (let ((selected-frame
353 ; (cond ((eq ff 'gud-gdb-find-file)
354 ; (gud-gdb-selected-frame-info buffer))
355 ; (t (error "Should never be here"))))))
357 (setq gud-last-speedbar-stackframe gud-last-last-frame)))
360 ;; ======================================================================
361 ;; gdb functions
363 ;; History of argument lists passed to gdb.
364 (defvar gud-gdb-history nil)
366 (defcustom gud-gdb-command-name "gdb --fullname"
367 "Default command to execute an executable under the GDB debugger."
368 :type 'string
369 :group 'gud)
371 (defvar gud-gdb-marker-regexp
372 ;; This used to use path-separator instead of ":";
373 ;; however, we found that on both Windows 32 and MSDOS
374 ;; a colon is correct here.
375 (concat "\032\032\\(.:?[^" ":" "\n]*\\)" ":"
376 "\\([0-9]*\\)" ":" ".*\n"))
378 ;; There's no guarantee that Emacs will hand the filter the entire
379 ;; marker at once; it could be broken up across several strings. We
380 ;; might even receive a big chunk with several markers in it. If we
381 ;; receive a chunk of text which looks like it might contain the
382 ;; beginning of a marker, we save it here between calls to the
383 ;; filter.
384 (defvar gud-marker-acc "")
385 (make-variable-buffer-local 'gud-marker-acc)
387 (defun gud-gdb-marker-filter (string)
388 (setq gud-marker-acc (concat gud-marker-acc string))
389 (let ((output ""))
391 ;; Process all the complete markers in this chunk.
392 (while (string-match gud-gdb-marker-regexp gud-marker-acc)
393 (setq
395 ;; Extract the frame position from the marker.
396 gud-last-frame (cons (match-string 1 gud-marker-acc)
397 (string-to-int (match-string 2 gud-marker-acc)))
399 ;; Append any text before the marker to the output we're going
400 ;; to return - we don't include the marker in this text.
401 output (concat output
402 (substring gud-marker-acc 0 (match-beginning 0)))
404 ;; Set the accumulator to the remaining text.
405 gud-marker-acc (substring gud-marker-acc (match-end 0))))
407 ;; Does the remaining text look like it might end with the
408 ;; beginning of another marker? If it does, then keep it in
409 ;; gud-marker-acc until we receive the rest of it. Since we
410 ;; know the full marker regexp above failed, it's pretty simple to
411 ;; test for marker starts.
412 (if (string-match "\032.*\\'" gud-marker-acc)
413 (progn
414 ;; Everything before the potential marker start can be output.
415 (setq output (concat output (substring gud-marker-acc
416 0 (match-beginning 0))))
418 ;; Everything after, we save, to combine with later input.
419 (setq gud-marker-acc
420 (substring gud-marker-acc (match-beginning 0))))
422 (setq output (concat output gud-marker-acc)
423 gud-marker-acc ""))
425 output))
427 (easy-mmode-defmap gud-minibuffer-local-map
428 '(("\C-i" . comint-dynamic-complete-filename))
429 "Keymap for minibuffer prompting of gud startup command."
430 :inherit minibuffer-local-map)
432 (defun gud-query-cmdline (minor-mode &optional init)
433 (let* ((hist-sym (gud-symbol 'history nil minor-mode))
434 (cmd-name (gud-val 'command-name minor-mode)))
435 (unless (boundp hist-sym) (set hist-sym nil))
436 (read-from-minibuffer
437 (format "Run %s (like this): " minor-mode)
438 (or (car-safe (symbol-value hist-sym))
439 (concat (or cmd-name (symbol-name minor-mode))
441 (or init
442 (let ((file nil))
443 (dolist (f (directory-files default-directory) file)
444 (if (and (file-executable-p f)
445 (not (file-directory-p f))
446 (or (not file)
447 (file-newer-than-file-p f file)))
448 (setq file f)))))))
449 gud-minibuffer-local-map nil
450 hist-sym)))
452 ;;;###autoload
453 (defun gdb (command-line)
454 "Run gdb on program FILE in buffer *gud-FILE*.
455 The directory containing FILE becomes the initial working directory
456 and source-file directory for your debugger."
457 (interactive (list (gud-query-cmdline 'gdb)))
459 (gud-common-init command-line nil 'gud-gdb-marker-filter)
460 (set (make-local-variable 'gud-minor-mode) 'gdb)
462 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
463 (gud-def gud-tbreak "tbreak %f:%l" "\C-t" "Set temporary breakpoint at current line.")
464 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
465 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
466 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
467 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
468 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
469 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
470 (gud-def gud-jump "tbreak %f:%l\njump %f:%l" "\C-j" "Relocate execution address to line at point in source buffer.")
472 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
473 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
474 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
475 (gud-def gud-until "until %l" "\C-u" "Continue up to current line.")
476 (gud-def gud-run "run" nil "Run the program.")
478 (local-set-key "\C-i" 'gud-gdb-complete-command)
479 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
480 (setq paragraph-start comint-prompt-regexp)
481 (run-hooks 'gdb-mode-hook)
484 ;; One of the nice features of GDB is its impressive support for
485 ;; context-sensitive command completion. We preserve that feature
486 ;; in the GUD buffer by using a GDB command designed just for Emacs.
488 ;; The completion process filter indicates when it is finished.
489 (defvar gud-gdb-fetch-lines-in-progress)
491 ;; Since output may arrive in fragments we accumulate partials strings here.
492 (defvar gud-gdb-fetch-lines-string)
494 ;; We need to know how much of the completion to chop off.
495 (defvar gud-gdb-fetch-lines-break)
497 ;; The completion list is constructed by the process filter.
498 (defvar gud-gdb-fetched-lines)
500 (defvar gud-comint-buffer nil)
502 (defun gud-gdb-complete-command ()
503 "Perform completion on the GDB command preceding point.
504 This is implemented using the GDB `complete' command which isn't
505 available with older versions of GDB."
506 (interactive)
507 (let* ((end (point))
508 (command (buffer-substring (comint-line-beginning-position) end))
509 (command-word
510 ;; Find the word break. This match will always succeed.
511 (and (string-match "\\(\\`\\| \\)\\([^ ]*\\)\\'" command)
512 (substring command (match-beginning 2))))
513 (complete-list
514 (gud-gdb-run-command-fetch-lines (concat "complete " command)
515 (current-buffer)
516 ;; From string-match above.
517 (match-beginning 2))))
518 ;; Protect against old versions of GDB.
519 (and complete-list
520 (string-match "^Undefined command: \"complete\"" (car complete-list))
521 (error "This version of GDB doesn't support the `complete' command"))
522 ;; Sort the list like readline.
523 (setq complete-list (sort complete-list (function string-lessp)))
524 ;; Remove duplicates.
525 (let ((first complete-list)
526 (second (cdr complete-list)))
527 (while second
528 (if (string-equal (car first) (car second))
529 (setcdr first (setq second (cdr second)))
530 (setq first second
531 second (cdr second)))))
532 ;; Add a trailing single quote if there is a unique completion
533 ;; and it contains an odd number of unquoted single quotes.
534 (and (= (length complete-list) 1)
535 (let ((str (car complete-list))
536 (pos 0)
537 (count 0))
538 (while (string-match "\\([^'\\]\\|\\\\'\\)*'" str pos)
539 (setq count (1+ count)
540 pos (match-end 0)))
541 (and (= (mod count 2) 1)
542 (setq complete-list (list (concat str "'"))))))
543 ;; Let comint handle the rest.
544 (comint-dynamic-simple-complete command-word complete-list)))
546 ;; The completion process filter is installed temporarily to slurp the
547 ;; output of GDB up to the next prompt and build the completion list.
548 (defun gud-gdb-fetch-lines-filter (string filter)
549 "Filter used to read the list of lines output by a command.
550 STRING is the output to filter.
551 It is passed through FILTER before we look at it."
552 (setq string (funcall filter string))
553 (setq string (concat gud-gdb-fetch-lines-string string))
554 (while (string-match "\n" string)
555 (push (substring string gud-gdb-fetch-lines-break (match-beginning 0))
556 gud-gdb-fetched-lines)
557 (setq string (substring string (match-end 0))))
558 (if (string-match comint-prompt-regexp string)
559 (progn
560 (setq gud-gdb-fetch-lines-in-progress nil)
561 string)
562 (progn
563 (setq gud-gdb-fetch-lines-string string)
564 "")))
566 ;; gdb speedbar functions
568 (defun gud-gdb-goto-stackframe (text token indent)
569 "Goto the stackframe described by TEXT, TOKEN, and INDENT."
570 (speedbar-with-attached-buffer
571 (gud-basic-call (concat "frame " (nth 1 token)))
572 (sit-for 1)))
574 (defvar gud-gdb-fetched-stack-frame nil
575 "Stack frames we are fetching from GDB.")
577 ;(defun gud-gdb-get-scope-data (text token indent)
578 ; ;; checkdoc-params: (indent)
579 ; "Fetch data associated with a stack frame, and expand/contract it.
580 ;Data to do this is retrieved from TEXT and TOKEN."
581 ; (let ((args nil) (scope nil))
582 ; (gud-gdb-run-command-fetch-lines "info args")
584 ; (gud-gdb-run-command-fetch-lines "info local")
586 ; ))
588 (defun gud-gdb-get-stackframe (buffer)
589 "Extract the current stack frame out of the GUD GDB BUFFER."
590 (let ((newlst nil)
591 (fetched-stack-frame-list
592 (gud-gdb-run-command-fetch-lines "backtrace" buffer)))
593 (if (and (car fetched-stack-frame-list)
594 (string-match "No stack" (car fetched-stack-frame-list)))
595 ;; Go into some other mode???
597 (dolist (e fetched-stack-frame-list)
598 (let ((name nil) (num nil))
599 (if (not (or
600 (string-match "^#\\([0-9]+\\) +[0-9a-fx]+ in \\([:0-9a-zA-Z_]+\\) (" e)
601 (string-match "^#\\([0-9]+\\) +\\([:0-9a-zA-Z_]+\\) (" e)))
602 (if (not (string-match
603 "at \\([-0-9a-zA-Z_.]+\\):\\([0-9]+\\)$" e))
605 (setcar newlst
606 (list (nth 0 (car newlst))
607 (nth 1 (car newlst))
608 (match-string 1 e)
609 (match-string 2 e))))
610 (setq num (match-string 1 e)
611 name (match-string 2 e))
612 (setq newlst
613 (cons
614 (if (string-match
615 "at \\([-0-9a-zA-Z_.]+\\):\\([0-9]+\\)$" e)
616 (list name num (match-string 1 e)
617 (match-string 2 e))
618 (list name num))
619 newlst)))))
620 (nreverse newlst))))
622 ;(defun gud-gdb-selected-frame-info (buffer)
623 ; "Learn GDB information for the currently selected stack frame in BUFFER."
626 (defun gud-gdb-run-command-fetch-lines (command buffer &optional skip)
627 "Run COMMAND, and return the list of lines it outputs.
628 BUFFER is the GUD buffer in which to run the command.
629 SKIP is the number of chars to skip on each lines, it defaults to 0."
630 (with-current-buffer buffer
631 (if (save-excursion
632 (goto-char (point-max))
633 (forward-line 0)
634 (not (looking-at comint-prompt-regexp)))
636 ;; Much of this copied from GDB complete, but I'm grabbing the stack
637 ;; frame instead.
638 (let ((gud-gdb-fetch-lines-in-progress t)
639 (gud-gdb-fetched-lines nil)
640 (gud-gdb-fetch-lines-string nil)
641 (gud-gdb-fetch-lines-break (or skip 0))
642 (gud-marker-filter
643 `(lambda (string) (gud-gdb-fetch-lines-filter string ',gud-marker-filter))))
644 ;; Issue the command to GDB.
645 (gud-basic-call command)
646 ;; Slurp the output.
647 (while gud-gdb-fetch-lines-in-progress
648 (accept-process-output (get-buffer-process buffer)))
649 (nreverse gud-gdb-fetched-lines)))))
652 ;; ======================================================================
653 ;; sdb functions
655 ;; History of argument lists passed to sdb.
656 (defvar gud-sdb-history nil)
658 (defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
659 "If nil, we're on a System V Release 4 and don't need the tags hack.")
661 (defvar gud-sdb-lastfile nil)
663 (defun gud-sdb-marker-filter (string)
664 (setq gud-marker-acc
665 (if gud-marker-acc (concat gud-marker-acc string) string))
666 (let (start)
667 ;; Process all complete markers in this chunk
668 (while
669 (cond
670 ;; System V Release 3.2 uses this format
671 ((string-match "\\(^\\|\n\\)\\*?\\(0x\\w* in \\)?\\([^:\n]*\\):\\([0-9]*\\):.*\n"
672 gud-marker-acc start)
673 (setq gud-last-frame
674 (cons (match-string 3 gud-marker-acc)
675 (string-to-int (match-string 4 gud-marker-acc)))))
676 ;; System V Release 4.0 quite often clumps two lines together
677 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
678 gud-marker-acc start)
679 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc))
680 (setq gud-last-frame
681 (cons gud-sdb-lastfile
682 (string-to-int (match-string 3 gud-marker-acc)))))
683 ;; System V Release 4.0
684 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n"
685 gud-marker-acc start)
686 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc)))
687 ((and gud-sdb-lastfile (string-match "^\\([0-9]+\\):"
688 gud-marker-acc start))
689 (setq gud-last-frame
690 (cons gud-sdb-lastfile
691 (string-to-int (match-string 1 gud-marker-acc)))))
693 (setq gud-sdb-lastfile nil)))
694 (setq start (match-end 0)))
696 ;; Search for the last incomplete line in this chunk
697 (while (string-match "\n" gud-marker-acc start)
698 (setq start (match-end 0)))
700 ;; If we have an incomplete line, store it in gud-marker-acc.
701 (setq gud-marker-acc (substring gud-marker-acc (or start 0))))
702 string)
704 (defun gud-sdb-find-file (f)
705 (if gud-sdb-needs-tags (find-tag-noselect f) (find-file-noselect f)))
707 ;;;###autoload
708 (defun sdb (command-line)
709 "Run sdb on program FILE in buffer *gud-FILE*.
710 The directory containing FILE becomes the initial working directory
711 and source-file directory for your debugger."
712 (interactive (list (gud-query-cmdline 'sdb)))
714 (if (and gud-sdb-needs-tags
715 (not (and (boundp 'tags-file-name)
716 (stringp tags-file-name)
717 (file-exists-p tags-file-name))))
718 (error "The sdb support requires a valid tags table to work"))
720 (gud-common-init command-line nil 'gud-sdb-marker-filter 'gud-sdb-find-file)
721 (set (make-local-variable 'gud-minor-mode) 'sdb)
723 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
724 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
725 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
726 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
727 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
728 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
729 (gud-def gud-cont "c" "\C-r" "Continue with display.")
730 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
732 (setq comint-prompt-regexp "\\(^\\|\n\\)\\*")
733 (setq paragraph-start comint-prompt-regexp)
734 (run-hooks 'sdb-mode-hook)
737 ;; ======================================================================
738 ;; dbx functions
740 ;; History of argument lists passed to dbx.
741 (defvar gud-dbx-history nil)
743 (defcustom gud-dbx-directories nil
744 "*A list of directories that dbx should search for source code.
745 If nil, only source files in the program directory
746 will be known to dbx.
748 The file names should be absolute, or relative to the directory
749 containing the executable being debugged."
750 :type '(choice (const :tag "Current Directory" nil)
751 (repeat :value ("")
752 directory))
753 :group 'gud)
755 (defun gud-dbx-massage-args (file args)
756 (nconc (let ((directories gud-dbx-directories)
757 (result nil))
758 (while directories
759 (setq result (cons (car directories) (cons "-I" result)))
760 (setq directories (cdr directories)))
761 (nreverse result))
762 args))
764 (defun gud-dbx-marker-filter (string)
765 (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
767 (let (start)
768 ;; Process all complete markers in this chunk.
769 (while (or (string-match
770 "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
771 gud-marker-acc start)
772 (string-match
773 "signal .* in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
774 gud-marker-acc start))
775 (setq gud-last-frame
776 (cons (match-string 2 gud-marker-acc)
777 (string-to-int (match-string 1 gud-marker-acc)))
778 start (match-end 0)))
780 ;; Search for the last incomplete line in this chunk
781 (while (string-match "\n" gud-marker-acc start)
782 (setq start (match-end 0)))
784 ;; If the incomplete line APPEARS to begin with another marker, keep it
785 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
786 ;; unnecessary concat during the next call.
787 (setq gud-marker-acc
788 (if (string-match "\\(stopped\\|signal\\)" gud-marker-acc start)
789 (substring gud-marker-acc (match-beginning 0))
790 nil)))
791 string)
793 ;; Functions for Mips-style dbx. Given the option `-emacs', documented in
794 ;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
795 (defvar gud-mips-p
796 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
797 ;; We haven't tested gud on this system:
798 (string-match "^mips-[^-]*-riscos" system-configuration)
799 ;; It's documented on OSF/1.3
800 (string-match "^mips-[^-]*-osf1" system-configuration)
801 (string-match "^alpha[^-]*-[^-]*-osf" system-configuration))
802 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
804 (defvar gud-dbx-command-name
805 (concat "dbx" (if gud-mips-p " -emacs")))
807 ;; This is just like the gdb one except for the regexps since we need to cope
808 ;; with an optional breakpoint number in [] before the ^Z^Z
809 (defun gud-mipsdbx-marker-filter (string)
810 (setq gud-marker-acc (concat gud-marker-acc string))
811 (let ((output ""))
813 ;; Process all the complete markers in this chunk.
814 (while (string-match
815 ;; This is like th gdb marker but with an optional
816 ;; leading break point number like `[1] '
817 "[][ 0-9]*\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
818 gud-marker-acc)
819 (setq
821 ;; Extract the frame position from the marker.
822 gud-last-frame
823 (cons (match-string 1 gud-marker-acc)
824 (string-to-int (match-string 2 gud-marker-acc)))
826 ;; Append any text before the marker to the output we're going
827 ;; to return - we don't include the marker in this text.
828 output (concat output
829 (substring gud-marker-acc 0 (match-beginning 0)))
831 ;; Set the accumulator to the remaining text.
832 gud-marker-acc (substring gud-marker-acc (match-end 0))))
834 ;; Does the remaining text look like it might end with the
835 ;; beginning of another marker? If it does, then keep it in
836 ;; gud-marker-acc until we receive the rest of it. Since we
837 ;; know the full marker regexp above failed, it's pretty simple to
838 ;; test for marker starts.
839 (if (string-match "[][ 0-9]*\032.*\\'" gud-marker-acc)
840 (progn
841 ;; Everything before the potential marker start can be output.
842 (setq output (concat output (substring gud-marker-acc
843 0 (match-beginning 0))))
845 ;; Everything after, we save, to combine with later input.
846 (setq gud-marker-acc
847 (substring gud-marker-acc (match-beginning 0))))
849 (setq output (concat output gud-marker-acc)
850 gud-marker-acc ""))
852 output))
854 ;; The dbx in IRIX is a pain. It doesn't print the file name when
855 ;; stopping at a breakpoint (but you do get it from the `up' and
856 ;; `down' commands...). The only way to extract the information seems
857 ;; to be with a `file' command, although the current line number is
858 ;; available in $curline. Thus we have to look for output which
859 ;; appears to indicate a breakpoint. Then we prod the dbx sub-process
860 ;; to output the information we want with a combination of the
861 ;; `printf' and `file' commands as a pseudo marker which we can
862 ;; recognise next time through the marker-filter. This would be like
863 ;; the gdb marker but you can't get the file name without a newline...
864 ;; Note that gud-remove won't work since Irix dbx expects a breakpoint
865 ;; number rather than a line number etc. Maybe this could be made to
866 ;; work by listing all the breakpoints and picking the one(s) with the
867 ;; correct line number, but life's too short.
868 ;; d.love@dl.ac.uk (Dave Love) can be blamed for this
870 (defvar gud-irix-p
871 (and (string-match "^mips-[^-]*-irix" system-configuration)
872 (not (string-match "irix[6-9]\\.[1-9]" system-configuration)))
873 "Non-nil to assume the interface appropriate for IRIX dbx.
874 This works in IRIX 4, 5 and 6, but `gud-dbx-use-stopformat-p' provides
875 a better solution in 6.1 upwards.")
876 (defvar gud-dbx-use-stopformat-p
877 (string-match "irix[6-9]\\.[1-9]" system-configuration)
878 "Non-nil to use the dbx feature present at least from Irix 6.1
879 whereby $stopformat=1 produces an output format compatiable with
880 `gud-dbx-marker-filter'.")
881 ;; [Irix dbx seems to be a moving target. The dbx output changed
882 ;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
883 ;; the output from `up' is no longer spotted by gud (and it's probably
884 ;; not distinctive enough to try to match it -- use C-<, C->
885 ;; exclusively) . For 5.3 and 6.0, the $curline variable changed to
886 ;; `long long'(why?!), so the printf stuff needed changing. The line
887 ;; number was cast to `long' as a compromise between the new `long
888 ;; long' and the original `int'. This is reported not to work in 6.2,
889 ;; so it's changed back to int -- don't make your sources too long.
890 ;; From Irix6.1 (but not 6.0?) dbx supports an undocumented feature
891 ;; whereby `set $stopformat=1' reportedly produces output compatible
892 ;; with `gud-dbx-marker-filter', which we prefer.
894 ;; The process filter is also somewhat
895 ;; unreliable, sometimes not spotting the markers; I don't know
896 ;; whether there's anything that can be done about that. It would be
897 ;; much better if SGI could be persuaded to (re?)instate the MIPS
898 ;; -emacs flag for gdb-like output (which ought to be possible as most
899 ;; of the communication I've had over it has been from sgi.com).]
901 ;; this filter is influenced by the xdb one rather than the gdb one
902 (defun gud-irixdbx-marker-filter (string)
903 (let (result (case-fold-search nil))
904 (if (or (string-match comint-prompt-regexp string)
905 (string-match ".*\012" string))
906 (setq result (concat gud-marker-acc string)
907 gud-marker-acc "")
908 (setq gud-marker-acc (concat gud-marker-acc string)))
909 (if result
910 (cond
911 ;; look for breakpoint or signal indication e.g.:
912 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
913 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
914 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
915 ((string-match
916 "^\\(\\[[0-9]+] \\)?Process +[0-9]+ ([^)]*) [^[]+\\[[^]\n]*]\n"
917 result)
918 ;; prod dbx into printing out the line number and file
919 ;; name in a form we can grok as below
920 (process-send-string (get-buffer-process gud-comint-buffer)
921 "printf \"\032\032%1d:\",(int)$curline;file\n"))
922 ;; look for result of, say, "up" e.g.:
923 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
924 ;; (this will also catch one of the lines printed by "where")
925 ((string-match
926 "^[^ ][^[]*\\[\"\\([^\"]+\\)\":\\([0-9]+\\), [^]]+]\n"
927 result)
928 (let ((file (match-string 1 result)))
929 (if (file-exists-p file)
930 (setq gud-last-frame
931 (cons (match-string 1 result)
932 (string-to-int (match-string 2 result))))))
933 result)
934 ((string-match ; kluged-up marker as above
935 "\032\032\\([0-9]*\\):\\(.*\\)\n" result)
936 (let ((file (gud-file-name (match-string 2 result))))
937 (if (and file (file-exists-p file))
938 (setq gud-last-frame
939 (cons file
940 (string-to-int (match-string 1 result))))))
941 (setq result (substring result 0 (match-beginning 0))))))
942 (or result "")))
944 (defvar gud-dgux-p (string-match "-dgux" system-configuration)
945 "Non-nil means to assume the interface approriate for DG/UX dbx.
946 This was tested using R4.11.")
948 ;; There are a couple of differences between DG's dbx output and normal
949 ;; dbx output which make it nontrivial to integrate this into the
950 ;; standard dbx-marker-filter (mainly, there are a different number of
951 ;; backreferences). The markers look like:
953 ;; (0) Stopped at line 10, routine main(argc=1, argv=0xeffff0e0), file t.c
955 ;; from breakpoints (the `(0)' there isn't constant, it's the breakpoint
956 ;; number), and
958 ;; Stopped at line 13, routine main(argc=1, argv=0xeffff0e0), file t.c
960 ;; from signals and
962 ;; Frame 21, line 974, routine command_loop(), file keyboard.c
964 ;; from up/down/where.
966 (defun gud-dguxdbx-marker-filter (string)
967 (setq gud-marker-acc (if gud-marker-acc
968 (concat gud-marker-acc string)
969 string))
970 (let ((re (concat "^\\(\\(([0-9]+) \\)?Stopped at\\|Frame [0-9]+,\\)"
971 " line \\([0-9]+\\), routine .*, file \\([^ \t\n]+\\)"))
972 start)
973 ;; Process all complete markers in this chunk.
974 (while (string-match re gud-marker-acc start)
975 (setq gud-last-frame
976 (cons (match-string 4 gud-marker-acc)
977 (string-to-int (match-string 3 gud-marker-acc)))
978 start (match-end 0)))
980 ;; Search for the last incomplete line in this chunk
981 (while (string-match "\n" gud-marker-acc start)
982 (setq start (match-end 0)))
984 ;; If the incomplete line APPEARS to begin with another marker, keep it
985 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
986 ;; unnecessary concat during the next call.
987 (setq gud-marker-acc
988 (if (string-match "Stopped\\|Frame" gud-marker-acc start)
989 (substring gud-marker-acc (match-beginning 0))
990 nil)))
991 string)
993 ;;;###autoload
994 (defun dbx (command-line)
995 "Run dbx on program FILE in buffer *gud-FILE*.
996 The directory containing FILE becomes the initial working directory
997 and source-file directory for your debugger."
998 (interactive (list (gud-query-cmdline 'dbx)))
1000 (cond
1001 (gud-mips-p
1002 (gud-common-init command-line nil 'gud-mipsdbx-marker-filter))
1003 (gud-irix-p
1004 (gud-common-init command-line 'gud-dbx-massage-args
1005 'gud-irixdbx-marker-filter))
1006 (gud-dgux-p
1007 (gud-common-init command-line 'gud-dbx-massage-args
1008 'gud-dguxdbx-marker-filter))
1010 (gud-common-init command-line 'gud-dbx-massage-args
1011 'gud-dbx-marker-filter)))
1013 (set (make-local-variable 'gud-minor-mode) 'dbx)
1015 (cond
1016 (gud-mips-p
1017 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1018 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1019 (gud-def gud-break "stop at \"%f\":%l"
1020 "\C-b" "Set breakpoint at current line.")
1021 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
1022 (gud-irix-p
1023 (gud-def gud-break "stop at \"%d%f\":%l"
1024 "\C-b" "Set breakpoint at current line.")
1025 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1026 (gud-def gud-up "up %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1027 "<" "Up (numeric arg) stack frames.")
1028 (gud-def gud-down "down %p; printf \"\032\032%1d:\",(int)$curline;file\n"
1029 ">" "Down (numeric arg) stack frames.")
1030 ;; Make dbx give out the source location info that we need.
1031 (process-send-string (get-buffer-process gud-comint-buffer)
1032 "printf \"\032\032%1d:\",(int)$curline;file\n"))
1034 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1035 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1036 (gud-def gud-break "file \"%d%f\"\nstop at %l"
1037 "\C-b" "Set breakpoint at current line.")
1038 (if gud-dbx-use-stopformat-p
1039 (process-send-string (get-buffer-process gud-comint-buffer)
1040 "set $stopformat=1\n"))))
1042 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
1043 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
1044 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
1045 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
1046 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
1047 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
1049 (setq comint-prompt-regexp "^[^)\n]*dbx) *")
1050 (setq paragraph-start comint-prompt-regexp)
1051 (run-hooks 'dbx-mode-hook)
1054 ;; ======================================================================
1055 ;; xdb (HP PARISC debugger) functions
1057 ;; History of argument lists passed to xdb.
1058 (defvar gud-xdb-history nil)
1060 (defcustom gud-xdb-directories nil
1061 "*A list of directories that xdb should search for source code.
1062 If nil, only source files in the program directory
1063 will be known to xdb.
1065 The file names should be absolute, or relative to the directory
1066 containing the executable being debugged."
1067 :type '(choice (const :tag "Current Directory" nil)
1068 (repeat :value ("")
1069 directory))
1070 :group 'gud)
1072 (defun gud-xdb-massage-args (file args)
1073 (nconc (let ((directories gud-xdb-directories)
1074 (result nil))
1075 (while directories
1076 (setq result (cons (car directories) (cons "-d" result)))
1077 (setq directories (cdr directories)))
1078 (nreverse result))
1079 args))
1081 ;; xdb does not print the lines all at once, so we have to accumulate them
1082 (defun gud-xdb-marker-filter (string)
1083 (let (result)
1084 (if (or (string-match comint-prompt-regexp string)
1085 (string-match ".*\012" string))
1086 (setq result (concat gud-marker-acc string)
1087 gud-marker-acc "")
1088 (setq gud-marker-acc (concat gud-marker-acc string)))
1089 (if result
1090 (if (or (string-match "\\([^\n \t:]+\\): [^:]+: \\([0-9]+\\)[: ]"
1091 result)
1092 (string-match "[^: \t]+:[ \t]+\\([^:]+\\): [^:]+: \\([0-9]+\\):"
1093 result))
1094 (let ((line (string-to-int (match-string 2 result)))
1095 (file (gud-file-name (match-string 1 result))))
1096 (if file
1097 (setq gud-last-frame (cons file line))))))
1098 (or result "")))
1100 ;;;###autoload
1101 (defun xdb (command-line)
1102 "Run xdb on program FILE in buffer *gud-FILE*.
1103 The directory containing FILE becomes the initial working directory
1104 and source-file directory for your debugger.
1106 You can set the variable 'gud-xdb-directories' to a list of program source
1107 directories if your program contains sources from more than one directory."
1108 (interactive (list (gud-query-cmdline 'xdb)))
1110 (gud-common-init command-line 'gud-xdb-massage-args
1111 'gud-xdb-marker-filter)
1112 (set (make-local-variable 'gud-minor-mode) 'xdb)
1114 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
1115 (gud-def gud-tbreak "b %f:%l\\t" "\C-t"
1116 "Set temporary breakpoint at current line.")
1117 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
1118 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
1119 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1120 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1121 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1122 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1123 (gud-def gud-finish "bu\\t" "\C-f" "Finish executing current function.")
1124 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
1126 (setq comint-prompt-regexp "^>")
1127 (setq paragraph-start comint-prompt-regexp)
1128 (run-hooks 'xdb-mode-hook))
1130 ;; ======================================================================
1131 ;; perldb functions
1133 ;; History of argument lists passed to perldb.
1134 (defvar gud-perldb-history nil)
1136 (defun gud-perldb-massage-args (file args)
1137 "Convert a command line as would be typed normally to run perldb
1138 into one that invokes an Emacs-enabled debugging session.
1139 \"-emacs\" is inserted where it will be $ARGV[0] (see perl5db.pl)."
1140 ;; FIXME: what if the command is `make perldb' and doesn't accept those extra
1141 ;; arguments ?
1142 (let* ((new-args nil)
1143 (seen-e nil)
1144 (shift (lambda () (push (pop args) new-args))))
1146 ;; Pass all switches and -e scripts through.
1147 (while (and args
1148 (string-match "^-" (car args))
1149 (not (equal "-" (car args)))
1150 (not (equal "--" (car args))))
1151 (when (equal "-e" (car args))
1152 ;; -e goes with the next arg, so shift one extra.
1153 (or (funcall shift)
1154 ;; -e as the last arg is an error in Perl.
1155 (error "No code specified for -e"))
1156 (setq seen-e t))
1157 (funcall shift))
1159 (unless seen-e
1160 (if (or (not args)
1161 (string-match "^-" (car args)))
1162 (error "Can't use stdin as the script to debug"))
1163 ;; This is the program name.
1164 (funcall shift))
1166 ;; If -e specified, make sure there is a -- so -emacs is not taken
1167 ;; as -e macs.
1168 (if (and args (equal "--" (car args)))
1169 (funcall shift)
1170 (and seen-e (push "--" new-args)))
1172 (push "-emacs" new-args)
1173 (while args
1174 (funcall shift))
1176 (nreverse new-args)))
1178 ;; There's no guarantee that Emacs will hand the filter the entire
1179 ;; marker at once; it could be broken up across several strings. We
1180 ;; might even receive a big chunk with several markers in it. If we
1181 ;; receive a chunk of text which looks like it might contain the
1182 ;; beginning of a marker, we save it here between calls to the
1183 ;; filter.
1184 (defun gud-perldb-marker-filter (string)
1185 (setq gud-marker-acc (concat gud-marker-acc string))
1186 (let ((output ""))
1188 ;; Process all the complete markers in this chunk.
1189 (while (string-match "\032\032\\(\\([a-zA-Z]:\\)?[^:\n]*\\):\\([0-9]*\\):.*\n"
1190 gud-marker-acc)
1191 (setq
1193 ;; Extract the frame position from the marker.
1194 gud-last-frame
1195 (cons (match-string 1 gud-marker-acc)
1196 (string-to-int (match-string 3 gud-marker-acc)))
1198 ;; Append any text before the marker to the output we're going
1199 ;; to return - we don't include the marker in this text.
1200 output (concat output
1201 (substring gud-marker-acc 0 (match-beginning 0)))
1203 ;; Set the accumulator to the remaining text.
1204 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1206 ;; Does the remaining text look like it might end with the
1207 ;; beginning of another marker? If it does, then keep it in
1208 ;; gud-marker-acc until we receive the rest of it. Since we
1209 ;; know the full marker regexp above failed, it's pretty simple to
1210 ;; test for marker starts.
1211 (if (string-match "\032.*\\'" gud-marker-acc)
1212 (progn
1213 ;; Everything before the potential marker start can be output.
1214 (setq output (concat output (substring gud-marker-acc
1215 0 (match-beginning 0))))
1217 ;; Everything after, we save, to combine with later input.
1218 (setq gud-marker-acc
1219 (substring gud-marker-acc (match-beginning 0))))
1221 (setq output (concat output gud-marker-acc)
1222 gud-marker-acc ""))
1224 output))
1226 (defcustom gud-perldb-command-name "perl -d"
1227 "Default command to execute a Perl script under debugger."
1228 :type 'string
1229 :group 'gud)
1231 ;;;###autoload
1232 (defun perldb (command-line)
1233 "Run perldb on program FILE in buffer *gud-FILE*.
1234 The directory containing FILE becomes the initial working directory
1235 and source-file directory for your debugger."
1236 (interactive
1237 (list (gud-query-cmdline 'perldb
1238 (concat (or (buffer-file-name) "-e 0") " "))))
1240 (gud-common-init command-line 'gud-perldb-massage-args
1241 'gud-perldb-marker-filter)
1242 (set (make-local-variable 'gud-minor-mode) 'perldb)
1244 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
1245 (gud-def gud-remove "d %l" "\C-d" "Remove breakpoint at current line")
1246 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
1247 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
1248 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1249 ; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
1250 ; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
1251 ; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
1252 (gud-def gud-print "%e" "\C-p" "Evaluate perl expression at point.")
1254 (setq comint-prompt-regexp "^ DB<+[0-9]+>+ ")
1255 (setq paragraph-start comint-prompt-regexp)
1256 (run-hooks 'perldb-mode-hook))
1258 ;; ======================================================================
1259 ;; pdb (Python debugger) functions
1261 ;; History of argument lists passed to pdb.
1262 (defvar gud-pdb-history nil)
1264 ;; Last group is for return value, e.g. "> test.py(2)foo()->None"
1265 ;; Either file or function name may be omitted: "> <string>(0)?()"
1266 (defvar gud-pdb-marker-regexp
1267 "^> \\([-a-zA-Z0-9_/.:\\]*\\|<string>\\)(\\([0-9]+\\))\\([a-zA-Z0-9_]*\\|\\?\\)()\\(->[^\n]*\\)?\n")
1268 (defvar gud-pdb-marker-regexp-file-group 1)
1269 (defvar gud-pdb-marker-regexp-line-group 2)
1270 (defvar gud-pdb-marker-regexp-fnname-group 3)
1272 (defvar gud-pdb-marker-regexp-start "^> ")
1274 ;; There's no guarantee that Emacs will hand the filter the entire
1275 ;; marker at once; it could be broken up across several strings. We
1276 ;; might even receive a big chunk with several markers in it. If we
1277 ;; receive a chunk of text which looks like it might contain the
1278 ;; beginning of a marker, we save it here between calls to the
1279 ;; filter.
1280 (defun gud-pdb-marker-filter (string)
1281 (setq gud-marker-acc (concat gud-marker-acc string))
1282 (let ((output ""))
1284 ;; Process all the complete markers in this chunk.
1285 (while (string-match gud-pdb-marker-regexp gud-marker-acc)
1286 (setq
1288 ;; Extract the frame position from the marker.
1289 gud-last-frame
1290 (let ((file (match-string gud-pdb-marker-regexp-file-group
1291 gud-marker-acc))
1292 (line (string-to-int
1293 (match-string gud-pdb-marker-regexp-line-group
1294 gud-marker-acc))))
1295 (if (string-equal file "<string>")
1296 gud-last-frame
1297 (cons file line)))
1299 ;; Output everything instead of the below
1300 output (concat output (substring gud-marker-acc 0 (match-end 0)))
1301 ;; ;; Append any text before the marker to the output we're going
1302 ;; ;; to return - we don't include the marker in this text.
1303 ;; output (concat output
1304 ;; (substring gud-marker-acc 0 (match-beginning 0)))
1306 ;; Set the accumulator to the remaining text.
1307 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1309 ;; Does the remaining text look like it might end with the
1310 ;; beginning of another marker? If it does, then keep it in
1311 ;; gud-marker-acc until we receive the rest of it. Since we
1312 ;; know the full marker regexp above failed, it's pretty simple to
1313 ;; test for marker starts.
1314 (if (string-match gud-pdb-marker-regexp-start gud-marker-acc)
1315 (progn
1316 ;; Everything before the potential marker start can be output.
1317 (setq output (concat output (substring gud-marker-acc
1318 0 (match-beginning 0))))
1320 ;; Everything after, we save, to combine with later input.
1321 (setq gud-marker-acc
1322 (substring gud-marker-acc (match-beginning 0))))
1324 (setq output (concat output gud-marker-acc)
1325 gud-marker-acc ""))
1327 output))
1329 (defcustom gud-pdb-command-name "pdb"
1330 "File name for executing the Python debugger.
1331 This should be an executable on your path, or an absolute file name."
1332 :type 'string
1333 :group 'gud)
1335 ;;;###autoload
1336 (defun pdb (command-line)
1337 "Run pdb on program FILE in buffer `*gud-FILE*'.
1338 The directory containing FILE becomes the initial working directory
1339 and source-file directory for your debugger."
1340 (interactive
1341 (list (gud-query-cmdline 'pdb)))
1343 (gud-common-init command-line nil 'gud-pdb-marker-filter)
1344 (set (make-local-variable 'gud-minor-mode) 'pdb)
1346 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
1347 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
1348 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
1349 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
1350 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
1351 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1352 (gud-def gud-up "up" "<" "Up one stack frame.")
1353 (gud-def gud-down "down" ">" "Down one stack frame.")
1354 (gud-def gud-print "p %e" "\C-p" "Evaluate Python expression at point.")
1355 ;; Is this right?
1356 (gud-def gud-statement "! %e" "\C-e" "Execute Python statement at point.")
1358 ;; (setq comint-prompt-regexp "^(.*pdb[+]?) *")
1359 (setq comint-prompt-regexp "^(Pdb) *")
1360 (setq paragraph-start comint-prompt-regexp)
1361 (run-hooks 'pdb-mode-hook))
1363 ;; ======================================================================
1365 ;; JDB support.
1367 ;; AUTHOR: Derek Davies <ddavies@world.std.com>
1368 ;; Zoltan Kemenczy <zoltan@ieee.org;zkemenczy@rim.net>
1370 ;; CREATED: Sun Feb 22 10:46:38 1998 Derek Davies.
1371 ;; UPDATED: Nov 11, 2001 Zoltan Kemenczy
1372 ;; Dec 10, 2002 Zoltan Kemenczy - added nested class support
1374 ;; INVOCATION NOTES:
1376 ;; You invoke jdb-mode with:
1378 ;; M-x jdb <enter>
1380 ;; It responds with:
1382 ;; Run jdb (like this): jdb
1384 ;; type any jdb switches followed by the name of the class you'd like to debug.
1385 ;; Supply a fully qualfied classname (these do not have the ".class" extension)
1386 ;; for the name of the class to debug (e.g. "COM.the-kind.ddavies.CoolClass").
1387 ;; See the known problems section below for restrictions when specifying jdb
1388 ;; command line switches (search forward for '-classpath').
1390 ;; You should see something like the following:
1392 ;; Current directory is ~/src/java/hello/
1393 ;; Initializing jdb...
1394 ;; 0xed2f6628:class(hello)
1395 ;; >
1397 ;; To set an initial breakpoint try:
1399 ;; > stop in hello.main
1400 ;; Breakpoint set in hello.main
1401 ;; >
1403 ;; To execute the program type:
1405 ;; > run
1406 ;; run hello
1408 ;; Breakpoint hit: running ...
1409 ;; hello.main (hello:12)
1411 ;; Type M-n to step over the current line and M-s to step into it. That,
1412 ;; along with the JDB 'help' command should get you started. The 'quit'
1413 ;; JDB command will get out out of the debugger. There is some truly
1414 ;; pathetic JDB documentation available at:
1416 ;; http://java.sun.com/products/jdk/1.1/debugging/
1418 ;; KNOWN PROBLEMS AND FIXME's:
1420 ;; Not sure what happens with inner classes ... haven't tried them.
1422 ;; Does not grok UNICODE id's. Only ASCII id's are supported.
1424 ;; You must not put whitespace between "-classpath" and the path to
1425 ;; search for java classes even though it is required when invoking jdb
1426 ;; from the command line. See gud-jdb-massage-args for details.
1427 ;; The same applies for "-sourcepath".
1429 ;; Note: The following applies only if `gud-jdb-use-classpath' is nil;
1430 ;; refer to the documentation of `gud-jdb-use-classpath' and
1431 ;; `gud-jdb-classpath',`gud-jdb-sourcepath' variables for information
1432 ;; on using the classpath for locating java source files.
1434 ;; If any of the source files in the directories listed in
1435 ;; gud-jdb-directories won't parse you'll have problems. Make sure
1436 ;; every file ending in ".java" in these directories parses without error.
1438 ;; All the .java files in the directories in gud-jdb-directories are
1439 ;; syntactically analyzed each time gud jdb is invoked. It would be
1440 ;; nice to keep as much information as possible between runs. It would
1441 ;; be really nice to analyze the files only as neccessary (when the
1442 ;; source needs to be displayed.) I'm not sure to what extent the former
1443 ;; can be accomplished and I'm not sure the latter can be done at all
1444 ;; since I don't know of any general way to tell which .class files are
1445 ;; defined by which .java file without analyzing all the .java files.
1446 ;; If anyone knows why JavaSoft didn't put the source file names in
1447 ;; debuggable .class files please clue me in so I find something else
1448 ;; to be spiteful and bitter about.
1450 ;; ======================================================================
1451 ;; gud jdb variables and functions
1453 (defcustom gud-jdb-command-name "jdb"
1454 "Command that executes the Java debugger."
1455 :type 'string
1456 :group 'gud)
1458 (defcustom gud-jdb-use-classpath t
1459 "If non-nil, search for Java source files in classpath directories.
1460 The list of directories to search is the value of `gud-jdb-classpath'.
1461 The file pathname is obtained by converting the fully qualified
1462 class information output by jdb to a relative pathname and appending
1463 it to `gud-jdb-classpath' element by element until a match is found.
1465 This method has a significant jdb startup time reduction advantage
1466 since it does not require the scanning of all `gud-jdb-directories'
1467 and parsing all Java files for class information.
1469 Set to nil to use `gud-jdb-directories' to scan java sources for
1470 class information on jdb startup (original method)."
1471 :type 'boolean
1472 :group 'gud)
1474 (defvar gud-jdb-classpath nil
1475 "Java/jdb classpath directories list.
1476 If `gud-jdb-use-classpath' is non-nil, gud-jdb derives the `gud-jdb-classpath'
1477 list automatically using the following methods in sequence
1478 \(with subsequent successful steps overriding the results of previous
1479 steps):
1481 1) Read the CLASSPATH environment variable,
1482 2) Read any \"-classpath\" argument used to run jdb,
1483 or detected in jdb output (e.g. if jdb is run by a script
1484 that echoes the actual jdb command before starting jdb)
1485 3) Send a \"classpath\" command to jdb and scan jdb output for
1486 classpath information if jdb is invoked with an \"-attach\" (to
1487 an already running VM) argument (This case typically does not
1488 have a \"-classpath\" command line argument - that is provided
1489 to the VM when it is started).
1491 Note that method 3 cannot be used with oldjdb (or Java 1 jdb) since
1492 those debuggers do not support the classpath command. Use 1) or 2).")
1494 (defvar gud-jdb-sourcepath nil
1495 "Directory list provided by an (optional) \"-sourcepath\" option to jdb.
1496 This list is prepended to `gud-jdb-classpath' to form the complete
1497 list of directories searched for source files.")
1499 (defvar gud-marker-acc-max-length 4000
1500 "Maximum number of debugger output characters to keep.
1501 This variable limits the size of `gud-marker-acc' which holds
1502 the most recent debugger output history while searching for
1503 source file information.")
1505 (defvar gud-jdb-history nil
1506 "History of argument lists passed to jdb.")
1509 ;; List of Java source file directories.
1510 (defvar gud-jdb-directories (list ".")
1511 "*A list of directories that gud jdb should search for source code.
1512 The file names should be absolute, or relative to the current
1513 directory.
1515 The set of .java files residing in the directories listed are
1516 syntactically analyzed to determine the classes they define and the
1517 packages in which these classes belong. In this way gud jdb maps the
1518 package-qualified class names output by the jdb debugger to the source
1519 file from which the class originated. This allows gud mode to keep
1520 the source code display in sync with the debugging session.")
1522 (defvar gud-jdb-source-files nil
1523 "List of the java source files for this debugging session.")
1525 ;; Association list of fully qualified class names (package + class name)
1526 ;; and their source files.
1527 (defvar gud-jdb-class-source-alist nil
1528 "Association list of fully qualified class names and source files.")
1530 ;; This is used to hold a source file during analysis.
1531 (defvar gud-jdb-analysis-buffer nil)
1533 (defvar gud-jdb-classpath-string nil
1534 "Holds temporary classpath values.")
1536 (defun gud-jdb-build-source-files-list (path extn)
1537 "Return a list of java source files (absolute paths).
1538 PATH gives the directories in which to search for files with
1539 extension EXTN. Normally EXTN is given as the regular expression
1540 \"\\.java$\" ."
1541 (apply 'nconc (mapcar (lambda (d)
1542 (when (file-directory-p d)
1543 (directory-files d t extn nil)))
1544 path)))
1546 ;; Move point past whitespace.
1547 (defun gud-jdb-skip-whitespace ()
1548 (skip-chars-forward " \n\r\t\014"))
1550 ;; Move point past a "// <eol>" type of comment.
1551 (defun gud-jdb-skip-single-line-comment ()
1552 (end-of-line))
1554 ;; Move point past a "/* */" or "/** */" type of comment.
1555 (defun gud-jdb-skip-traditional-or-documentation-comment ()
1556 (forward-char 2)
1557 (catch 'break
1558 (while (not (eobp))
1559 (if (eq (following-char) ?*)
1560 (progn
1561 (forward-char)
1562 (if (not (eobp))
1563 (if (eq (following-char) ?/)
1564 (progn
1565 (forward-char)
1566 (throw 'break nil)))))
1567 (forward-char)))))
1569 ;; Move point past any number of consecutive whitespace chars and/or comments.
1570 (defun gud-jdb-skip-whitespace-and-comments ()
1571 (gud-jdb-skip-whitespace)
1572 (catch 'done
1573 (while t
1574 (cond
1575 ((looking-at "//")
1576 (gud-jdb-skip-single-line-comment)
1577 (gud-jdb-skip-whitespace))
1578 ((looking-at "/\\*")
1579 (gud-jdb-skip-traditional-or-documentation-comment)
1580 (gud-jdb-skip-whitespace))
1581 (t (throw 'done nil))))))
1583 ;; Move point past things that are id-like. The intent is to skip regular
1584 ;; id's, such as class or interface names as well as package and interface
1585 ;; names.
1586 (defun gud-jdb-skip-id-ish-thing ()
1587 (skip-chars-forward "^ /\n\r\t\014,;{"))
1589 ;; Move point past a string literal.
1590 (defun gud-jdb-skip-string-literal ()
1591 (forward-char)
1592 (while (not (cond
1593 ((eq (following-char) ?\\)
1594 (forward-char))
1595 ((eq (following-char) ?\042))))
1596 (forward-char))
1597 (forward-char))
1599 ;; Move point past a character literal.
1600 (defun gud-jdb-skip-character-literal ()
1601 (forward-char)
1602 (while
1603 (progn
1604 (if (eq (following-char) ?\\)
1605 (forward-char 2))
1606 (not (eq (following-char) ?\')))
1607 (forward-char))
1608 (forward-char))
1610 ;; Move point past the following block. There may be (legal) cruft before
1611 ;; the block's opening brace. There must be a block or it's the end of life
1612 ;; in petticoat junction.
1613 (defun gud-jdb-skip-block ()
1615 ;; Find the begining of the block.
1616 (while
1617 (not (eq (following-char) ?{))
1619 ;; Skip any constructs that can harbor literal block delimiter
1620 ;; characters and/or the delimiters for the constructs themselves.
1621 (cond
1622 ((looking-at "//")
1623 (gud-jdb-skip-single-line-comment))
1624 ((looking-at "/\\*")
1625 (gud-jdb-skip-traditional-or-documentation-comment))
1626 ((eq (following-char) ?\042)
1627 (gud-jdb-skip-string-literal))
1628 ((eq (following-char) ?\')
1629 (gud-jdb-skip-character-literal))
1630 (t (forward-char))))
1632 ;; Now at the begining of the block.
1633 (forward-char)
1635 ;; Skip over the body of the block as well as the final brace.
1636 (let ((open-level 1))
1637 (while (not (eq open-level 0))
1638 (cond
1639 ((looking-at "//")
1640 (gud-jdb-skip-single-line-comment))
1641 ((looking-at "/\\*")
1642 (gud-jdb-skip-traditional-or-documentation-comment))
1643 ((eq (following-char) ?\042)
1644 (gud-jdb-skip-string-literal))
1645 ((eq (following-char) ?\')
1646 (gud-jdb-skip-character-literal))
1647 ((eq (following-char) ?{)
1648 (setq open-level (+ open-level 1))
1649 (forward-char))
1650 ((eq (following-char) ?})
1651 (setq open-level (- open-level 1))
1652 (forward-char))
1653 (t (forward-char))))))
1655 ;; Find the package and class definitions in Java source file FILE. Assumes
1656 ;; that FILE contains a legal Java program. BUF is a scratch buffer used
1657 ;; to hold the source during analysis.
1658 (defun gud-jdb-analyze-source (buf file)
1659 (let ((l nil))
1660 (set-buffer buf)
1661 (insert-file-contents file nil nil nil t)
1662 (goto-char 0)
1663 (catch 'abort
1664 (let ((p ""))
1665 (while (progn
1666 (gud-jdb-skip-whitespace)
1667 (not (eobp)))
1668 (cond
1670 ;; Any number of semi's following a block is legal. Move point
1671 ;; past them. Note that comments and whitespace may be
1672 ;; interspersed as well.
1673 ((eq (following-char) ?\073)
1674 (forward-char))
1676 ;; Move point past a single line comment.
1677 ((looking-at "//")
1678 (gud-jdb-skip-single-line-comment))
1680 ;; Move point past a traditional or documentation comment.
1681 ((looking-at "/\\*")
1682 (gud-jdb-skip-traditional-or-documentation-comment))
1684 ;; Move point past a package statement, but save the PackageName.
1685 ((looking-at "package")
1686 (forward-char 7)
1687 (gud-jdb-skip-whitespace-and-comments)
1688 (let ((s (point)))
1689 (gud-jdb-skip-id-ish-thing)
1690 (setq p (concat (buffer-substring s (point)) "."))
1691 (gud-jdb-skip-whitespace-and-comments)
1692 (if (eq (following-char) ?\073)
1693 (forward-char))))
1695 ;; Move point past an import statement.
1696 ((looking-at "import")
1697 (forward-char 6)
1698 (gud-jdb-skip-whitespace-and-comments)
1699 (gud-jdb-skip-id-ish-thing)
1700 (gud-jdb-skip-whitespace-and-comments)
1701 (if (eq (following-char) ?\073)
1702 (forward-char)))
1704 ;; Move point past the various kinds of ClassModifiers.
1705 ((looking-at "public")
1706 (forward-char 6))
1707 ((looking-at "abstract")
1708 (forward-char 8))
1709 ((looking-at "final")
1710 (forward-char 5))
1712 ;; Move point past a ClassDeclaraction, but save the class
1713 ;; Identifier.
1714 ((looking-at "class")
1715 (forward-char 5)
1716 (gud-jdb-skip-whitespace-and-comments)
1717 (let ((s (point)))
1718 (gud-jdb-skip-id-ish-thing)
1719 (setq
1720 l (nconc l (list (concat p (buffer-substring s (point)))))))
1721 (gud-jdb-skip-block))
1723 ;; Move point past an interface statement.
1724 ((looking-at "interface")
1725 (forward-char 9)
1726 (gud-jdb-skip-block))
1728 ;; Anything else means the input is invalid.
1730 (message (format "Error parsing file %s." file))
1731 (throw 'abort nil))))))
1734 (defun gud-jdb-build-class-source-alist-for-file (file)
1735 (mapcar
1736 (lambda (c)
1737 (cons c file))
1738 (gud-jdb-analyze-source gud-jdb-analysis-buffer file)))
1740 ;; Return an alist of fully qualified classes and the source files
1741 ;; holding their definitions. SOURCES holds a list of all the source
1742 ;; files to examine.
1743 (defun gud-jdb-build-class-source-alist (sources)
1744 (setq gud-jdb-analysis-buffer (get-buffer-create " *gud-jdb-scratch*"))
1745 (prog1
1746 (apply
1747 'nconc
1748 (mapcar
1749 'gud-jdb-build-class-source-alist-for-file
1750 sources))
1751 (kill-buffer gud-jdb-analysis-buffer)
1752 (setq gud-jdb-analysis-buffer nil)))
1754 ;; Change what was given in the minibuffer to something that can be used to
1755 ;; invoke the debugger.
1756 (defun gud-jdb-massage-args (file args)
1757 ;; The jdb executable must have whitespace between "-classpath" and
1758 ;; its value while gud-common-init expects all switch values to
1759 ;; follow the switch keyword without intervening whitespace. We
1760 ;; require that when the user enters the "-classpath" switch in the
1761 ;; EMACS minibuffer that they do so without the intervening
1762 ;; whitespace. This function adds it back (it's called after
1763 ;; gud-common-init). There are more switches like this (for
1764 ;; instance "-host" and "-password") but I don't care about them
1765 ;; yet.
1766 (if args
1767 (let (massaged-args user-error)
1769 (while (and args (not user-error))
1770 (cond
1771 ((setq user-error (string-match "-classpath$" (car args))))
1772 ((setq user-error (string-match "-sourcepath$" (car args))))
1773 ((string-match "-classpath\\(.+\\)" (car args))
1774 (setq massaged-args
1775 (append massaged-args
1776 (list "-classpath"
1777 (setq gud-jdb-classpath-string
1778 (match-string 1 (car args)))))))
1779 ((string-match "-sourcepath\\(.+\\)" (car args))
1780 (setq massaged-args
1781 (append massaged-args
1782 (list "-sourcepath"
1783 (setq gud-jdb-sourcepath
1784 (match-string 1 (car args)))))))
1785 (t (setq massaged-args (append massaged-args (list (car args))))))
1786 (setq args (cdr args)))
1788 ;; By this point the current directory is all screwed up. Maybe we
1789 ;; could fix things and re-invoke gud-common-init, but for now I think
1790 ;; issueing the error is good enough.
1791 (if user-error
1792 (progn
1793 (kill-buffer (current-buffer))
1794 (error "Error: Omit whitespace between '-classpath or -sourcepath' and its value")))
1795 massaged-args)))
1797 ;; Search for an association with P, a fully qualified class name, in
1798 ;; gud-jdb-class-source-alist. The asssociation gives the fully
1799 ;; qualified file name of the source file which produced the class.
1800 (defun gud-jdb-find-source-file (p)
1801 (cdr (assoc p gud-jdb-class-source-alist)))
1803 ;; Note: Reset to this value every time a prompt is seen
1804 (defvar gud-jdb-lowest-stack-level 999)
1806 (defun gud-jdb-find-source-using-classpath (p)
1807 "Find source file corresponding to fully qualified class p.
1808 Convert p from jdb's output, converted to a pathname
1809 relative to a classpath directory."
1810 (save-match-data
1811 (let
1812 (;; Replace dots with slashes and append ".java" to generate file
1813 ;; name relative to classpath
1814 (filename
1815 (concat
1816 (mapconcat 'identity
1817 (split-string
1818 ;; Eliminate any subclass references in the class
1819 ;; name string. These start with a "$"
1820 ((lambda (x)
1821 (if (string-match "$.*" x)
1822 (replace-match "" t t x) p))
1824 "\\.") "/")
1825 ".java"))
1826 (cplist (append gud-jdb-sourcepath gud-jdb-classpath))
1827 found-file)
1828 (while (and cplist
1829 (not (setq found-file
1830 (file-readable-p
1831 (concat (car cplist) "/" filename)))))
1832 (setq cplist (cdr cplist)))
1833 (if found-file (concat (car cplist) "/" filename)))))
1835 (defun gud-jdb-find-source (string)
1836 "Alias for function used to locate source files.
1837 Set to `gud-jdb-find-source-using-classpath' or `gud-jdb-find-source-file'
1838 during jdb initialization depending on the value of
1839 `gud-jdb-use-classpath'."
1840 nil)
1842 (defun gud-jdb-parse-classpath-string (string)
1843 "Parse the classpath list and convert each item to an absolute pathname."
1844 (mapcar (lambda (s) (if (string-match "[/\\]$" s)
1845 (replace-match "" nil nil s) s))
1846 (mapcar 'file-truename
1847 (split-string
1848 string
1849 (concat "[ \t\n\r,\"" path-separator "]+")))))
1851 ;; See comentary for other debugger's marker filters - there you will find
1852 ;; important notes about STRING.
1853 (defun gud-jdb-marker-filter (string)
1855 ;; Build up the accumulator.
1856 (setq gud-marker-acc
1857 (if gud-marker-acc
1858 (concat gud-marker-acc string)
1859 string))
1861 ;; Look for classpath information until gud-jdb-classpath-string is found
1862 ;; (interactive, multiple settings of classpath from jdb
1863 ;; not supported/followed)
1864 (if (and gud-jdb-use-classpath
1865 (not gud-jdb-classpath-string)
1866 (or (string-match "classpath:[ \t[]+\\([^]]+\\)" gud-marker-acc)
1867 (string-match "-classpath[ \t\"]+\\([^ \"]+\\)" gud-marker-acc)))
1868 (setq gud-jdb-classpath
1869 (gud-jdb-parse-classpath-string
1870 (setq gud-jdb-classpath-string
1871 (match-string 1 gud-marker-acc)))))
1873 ;; We process STRING from left to right. Each time through the
1874 ;; following loop we process at most one marker. After we've found a
1875 ;; marker, delete gud-marker-acc up to and including the match
1876 (let (file-found)
1877 ;; Process each complete marker in the input.
1878 (while
1880 ;; Do we see a marker?
1881 (string-match
1882 ;; jdb puts out a string of the following form when it
1883 ;; hits a breakpoint:
1885 ;; <fully-qualified-class><method> (<class>:<line-number>)
1887 ;; <fully-qualified-class>'s are composed of Java ID's
1888 ;; separated by periods. <method> and <class> are
1889 ;; also Java ID's. <method> begins with a period and
1890 ;; may contain less-than and greater-than (constructors,
1891 ;; for instance, are called <init> in the symbol table.)
1892 ;; Java ID's begin with a letter followed by letters
1893 ;; and/or digits. The set of letters includes underscore
1894 ;; and dollar sign.
1896 ;; The first group matches <fully-qualified-class>,
1897 ;; the second group matches <class> and the third group
1898 ;; matches <line-number>. We don't care about using
1899 ;; <method> so we don't "group" it.
1901 ;; FIXME: Java ID's are UNICODE strings, this matches ASCII
1902 ;; ID's only.
1904 ;; The "," in the last square-bracket is necessary because of
1905 ;; Sun's total disrespect for backwards compatibility in
1906 ;; reported line numbers from jdb - starting in 1.4.0 they
1907 ;; introduced a comma at the thousands position (how
1908 ;; ingenious!)
1910 "\\(\[[0-9]+\] \\)*\\([a-zA-Z0-9.$_]+\\)\\.[a-zA-Z0-9$_<>(),]+ \
1911 \\(([a-zA-Z0-9.$_]+:\\|line=\\)\\([0-9,]+\\)"
1912 gud-marker-acc)
1914 ;; A good marker is one that:
1915 ;; 1) does not have a "[n] " prefix (not part of a stack backtrace)
1916 ;; 2) does have an "[n] " prefix and n is the lowest prefix seen
1917 ;; since the last prompt
1918 ;; Figure out the line on which to position the debugging arrow.
1919 ;; Return the info as a cons of the form:
1921 ;; (<file-name> . <line-number>) .
1922 (if (if (match-beginning 1)
1923 (let (n)
1924 (setq n (string-to-int (substring
1925 gud-marker-acc
1926 (1+ (match-beginning 1))
1927 (- (match-end 1) 2))))
1928 (if (< n gud-jdb-lowest-stack-level)
1929 (progn (setq gud-jdb-lowest-stack-level n) t)))
1931 (if (setq file-found
1932 (gud-jdb-find-source (match-string 2 gud-marker-acc)))
1933 (setq gud-last-frame
1934 (cons file-found
1935 (string-to-int
1936 (let
1937 ((numstr (match-string 4 gud-marker-acc)))
1938 (if (string-match "," numstr)
1939 (replace-match "" nil nil numstr)
1940 numstr)))))
1941 (message "Could not find source file.")))
1943 ;; Set the accumulator to the remaining text.
1944 (setq gud-marker-acc (substring gud-marker-acc (match-end 0))))
1946 (if (string-match comint-prompt-regexp gud-marker-acc)
1947 (setq gud-jdb-lowest-stack-level 999)))
1949 ;; Do not allow gud-marker-acc to grow without bound. If the source
1950 ;; file information is not within the last 3/4
1951 ;; gud-marker-acc-max-length characters, well,...
1952 (if (> (length gud-marker-acc) gud-marker-acc-max-length)
1953 (setq gud-marker-acc
1954 (substring gud-marker-acc
1955 (- (/ (* gud-marker-acc-max-length 3) 4)))))
1957 ;; We don't filter any debugger output so just return what we were given.
1958 string)
1960 (defvar gud-jdb-command-name "jdb" "Command that executes the Java debugger.")
1962 ;;;###autoload
1963 (defun jdb (command-line)
1964 "Run jdb with command line COMMAND-LINE in a buffer.
1965 The buffer is named \"*gud*\" if no initial class is given or
1966 \"*gud-<initial-class-basename>*\" if there is. If the \"-classpath\"
1967 switch is given, omit all whitespace between it and its value.
1969 See `gud-jdb-use-classpath' and `gud-jdb-classpath' documentation for
1970 information on how jdb accesses source files. Alternatively (if
1971 `gud-jdb-use-classpath' is nil), see `gud-jdb-directories' for the
1972 original source file access method.
1974 For general information about commands available to control jdb from
1975 gud, see `gud-mode'."
1976 (interactive
1977 (list (gud-query-cmdline 'jdb)))
1978 (setq gud-jdb-classpath nil)
1979 (setq gud-jdb-sourcepath nil)
1981 ;; Set gud-jdb-classpath from the CLASSPATH environment variable,
1982 ;; if CLASSPATH is set.
1983 (setq gud-jdb-classpath-string (getenv "CLASSPATH"))
1984 (if gud-jdb-classpath-string
1985 (setq gud-jdb-classpath
1986 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
1987 (setq gud-jdb-classpath-string nil) ; prepare for next
1989 (gud-common-init command-line 'gud-jdb-massage-args
1990 'gud-jdb-marker-filter)
1991 (set (make-local-variable 'gud-minor-mode) 'jdb)
1993 ;; If a -classpath option was provided, set gud-jdb-classpath
1994 (if gud-jdb-classpath-string
1995 (setq gud-jdb-classpath
1996 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
1997 (setq gud-jdb-classpath-string nil) ; prepare for next
1998 ;; If a -sourcepath option was provided, parse it
1999 (if gud-jdb-sourcepath
2000 (setq gud-jdb-sourcepath
2001 (gud-jdb-parse-classpath-string gud-jdb-sourcepath)))
2003 (gud-def gud-break "stop at %c:%l" "\C-b" "Set breakpoint at current line.")
2004 (gud-def gud-remove "clear %c:%l" "\C-d" "Remove breakpoint at current line")
2005 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2006 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2007 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
2008 (gud-def gud-finish "step up" "\C-f" "Continue until current method returns.")
2009 (gud-def gud-up "up\C-Mwhere" "<" "Up one stack frame.")
2010 (gud-def gud-down "down\C-Mwhere" ">" "Up one stack frame.")
2011 (gud-def gud-run "run" nil "Run the program.") ;if VM start using jdb
2013 (setq comint-prompt-regexp "^> \\|^[^ ]+\\[[0-9]+\\] ")
2014 (setq paragraph-start comint-prompt-regexp)
2015 (run-hooks 'jdb-mode-hook)
2017 (if gud-jdb-use-classpath
2018 ;; Get the classpath information from the debugger
2019 (progn
2020 (if (string-match "-attach" command-line)
2021 (gud-call "classpath"))
2022 (fset 'gud-jdb-find-source
2023 'gud-jdb-find-source-using-classpath))
2025 ;; Else create and bind the class/source association list as well
2026 ;; as the source file list.
2027 (setq gud-jdb-class-source-alist
2028 (gud-jdb-build-class-source-alist
2029 (setq gud-jdb-source-files
2030 (gud-jdb-build-source-files-list gud-jdb-directories
2031 "\\.java$"))))
2032 (fset 'gud-jdb-find-source 'gud-jdb-find-source-file)))
2035 ;; ======================================================================
2037 ;; BASHDB support. See http://bashdb.sourceforge.net
2039 ;; AUTHOR: Rocky Bernstein <rocky@panix.com>
2041 ;; CREATED: Sun Nov 10 10:46:38 2002 Rocky Bernstein.
2043 ;; INVOCATION NOTES:
2045 ;; You invoke bashdb-mode with:
2047 ;; M-x bashdb <enter>
2049 ;; It responds with:
2051 ;; Run bashdb (like this): bash
2054 ;; History of argument lists passed to bashdb.
2055 (defvar gud-bashdb-history nil)
2057 ;; Convert a command line as would be typed normally to run a script
2058 ;; into one that invokes an Emacs-enabled debugging session.
2059 ;; "--debugger" in inserted as the first switch.
2061 ;; There's no guarantee that Emacs will hand the filter the entire
2062 ;; marker at once; it could be broken up across several strings. We
2063 ;; might even receive a big chunk with several markers in it. If we
2064 ;; receive a chunk of text which looks like it might contain the
2065 ;; beginning of a marker, we save it here between calls to the
2066 ;; filter.
2067 (defun gud-bashdb-marker-filter (string)
2068 (setq gud-marker-acc (concat gud-marker-acc string))
2069 (let ((output ""))
2071 ;; Process all the complete markers in this chunk.
2072 ;; Format of line looks like this:
2073 ;; (/etc/init.d/ntp.init:16):
2074 ;; but we also allow DOS drive letters
2075 ;; (d:/etc/init.d/ntp.init:16):
2076 (while (string-match "\\(^\\|\n\\)(\\(\\([a-zA-Z]:\\)?[^:\n]*\\):\\([0-9]*\\)):.*\n"
2077 gud-marker-acc)
2078 (setq
2080 ;; Extract the frame position from the marker.
2081 gud-last-frame
2082 (cons (match-string 2 gud-marker-acc)
2083 (string-to-int (match-string 4 gud-marker-acc)))
2085 ;; Append any text before the marker to the output we're going
2086 ;; to return - we don't include the marker in this text.
2087 output (concat output
2088 (substring gud-marker-acc 0 (match-beginning 0)))
2090 ;; Set the accumulator to the remaining text.
2091 gud-marker-acc (substring gud-marker-acc (match-end 0))))
2093 ;; Does the remaining text look like it might end with the
2094 ;; beginning of another marker? If it does, then keep it in
2095 ;; gud-marker-acc until we receive the rest of it. Since we
2096 ;; know the full marker regexp above failed, it's pretty simple to
2097 ;; test for marker starts.
2098 (if (string-match "\032.*\\'" gud-marker-acc)
2099 (progn
2100 ;; Everything before the potential marker start can be output.
2101 (setq output (concat output (substring gud-marker-acc
2102 0 (match-beginning 0))))
2104 ;; Everything after, we save, to combine with later input.
2105 (setq gud-marker-acc
2106 (substring gud-marker-acc (match-beginning 0))))
2108 (setq output (concat output gud-marker-acc)
2109 gud-marker-acc ""))
2111 output))
2113 (defcustom gud-bashdb-command-name "bash --debugger"
2114 "File name for executing bash debugger."
2115 :type 'string
2116 :group 'gud)
2118 ;;;###autoload
2119 (defun bashdb (command-line)
2120 "Run bashdb on program FILE in buffer *gud-FILE*.
2121 The directory containing FILE becomes the initial working directory
2122 and source-file directory for your debugger."
2123 (interactive
2124 (list (read-from-minibuffer "Run bashdb (like this): "
2125 (if (consp gud-bashdb-history)
2126 (car gud-bashdb-history)
2127 (concat gud-bashdb-command-name
2128 " "))
2129 gud-minibuffer-local-map nil
2130 '(gud-bashdb-history . 1))))
2132 (gud-common-init command-line nil 'gud-bashdb-marker-filter)
2134 (set (make-local-variable 'gud-minor-mode) 'bashdb)
2136 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
2137 (gud-def gud-tbreak "tbreak %l" "\C-t" "Set temporary breakpoint at current line.")
2138 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
2139 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2140 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2141 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
2142 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
2143 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
2144 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
2145 (gud-def gud-print "x %e" "\C-p" "Evaluate BASH expression at point.")
2147 ;; Is this right?
2148 (gud-def gud-statement "eval %e" "\C-e" "Execute BASH statement at point.")
2150 (setq comint-prompt-regexp "^bashdb<+(*[0-9]+)*>+ ")
2151 (setq paragraph-start comint-prompt-regexp)
2152 (run-hooks 'bashdb-mode-hook)
2156 ;; End of debugger-specific information
2160 ;; When we send a command to the debugger via gud-call, it's annoying
2161 ;; to see the command and the new prompt inserted into the debugger's
2162 ;; buffer; we have other ways of knowing the command has completed.
2164 ;; If the buffer looks like this:
2165 ;; --------------------
2166 ;; (gdb) set args foo bar
2167 ;; (gdb) -!-
2168 ;; --------------------
2169 ;; (the -!- marks the location of point), and we type `C-x SPC' in a
2170 ;; source file to set a breakpoint, we want the buffer to end up like
2171 ;; this:
2172 ;; --------------------
2173 ;; (gdb) set args foo bar
2174 ;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
2175 ;; (gdb) -!-
2176 ;; --------------------
2177 ;; Essentially, the old prompt is deleted, and the command's output
2178 ;; and the new prompt take its place.
2180 ;; Not echoing the command is easy enough; you send it directly using
2181 ;; process-send-string, and it never enters the buffer. However,
2182 ;; getting rid of the old prompt is trickier; you don't want to do it
2183 ;; when you send the command, since that will result in an annoying
2184 ;; flicker as the prompt is deleted, redisplay occurs while Emacs
2185 ;; waits for a response from the debugger, and the new prompt is
2186 ;; inserted. Instead, we'll wait until we actually get some output
2187 ;; from the subprocess before we delete the prompt. If the command
2188 ;; produced no output other than a new prompt, that prompt will most
2189 ;; likely be in the first chunk of output received, so we will delete
2190 ;; the prompt and then replace it with an identical one. If the
2191 ;; command produces output, the prompt is moving anyway, so the
2192 ;; flicker won't be annoying.
2194 ;; So - when we want to delete the prompt upon receipt of the next
2195 ;; chunk of debugger output, we position gud-delete-prompt-marker at
2196 ;; the start of the prompt; the process filter will notice this, and
2197 ;; delete all text between it and the process output marker. If
2198 ;; gud-delete-prompt-marker points nowhere, we leave the current
2199 ;; prompt alone.
2200 (defvar gud-delete-prompt-marker nil)
2203 (put 'gud-mode 'mode-class 'special)
2205 (define-derived-mode gud-mode comint-mode "Debugger"
2206 "Major mode for interacting with an inferior debugger process.
2208 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
2209 M-x perldb, M-x xdb, or M-x jdb. Each entry point finishes by executing a
2210 hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook',
2211 `perldb-mode-hook', `xdb-mode-hook', or `jdb-mode-hook' respectively.
2213 After startup, the following commands are available in both the GUD
2214 interaction buffer and any source buffer GUD visits due to a breakpoint stop
2215 or step operation:
2217 \\[gud-break] sets a breakpoint at the current file and line. In the
2218 GUD buffer, the current file and line are those of the last breakpoint or
2219 step. In a source buffer, they are the buffer's file and current line.
2221 \\[gud-remove] removes breakpoints on the current file and line.
2223 \\[gud-refresh] displays in the source window the last line referred to
2224 in the gud buffer.
2226 \\[gud-step], \\[gud-next], and \\[gud-stepi] do a step-one-line,
2227 step-one-line (not entering function calls), and step-one-instruction
2228 and then update the source window with the current file and position.
2229 \\[gud-cont] continues execution.
2231 \\[gud-print] tries to find the largest C lvalue or function-call expression
2232 around point, and sends it to the debugger for value display.
2234 The above commands are common to all supported debuggers except xdb which
2235 does not support stepping instructions.
2237 Under gdb, sdb and xdb, \\[gud-tbreak] behaves exactly like \\[gud-break],
2238 except that the breakpoint is temporary; that is, it is removed when
2239 execution stops on it.
2241 Under gdb, dbx, and xdb, \\[gud-up] pops up through an enclosing stack
2242 frame. \\[gud-down] drops back down through one.
2244 If you are using gdb or xdb, \\[gud-finish] runs execution to the return from
2245 the current function and stops.
2247 All the keystrokes above are accessible in the GUD buffer
2248 with the prefix C-c, and in all buffers through the prefix C-x C-a.
2250 All pre-defined functions for which the concept make sense repeat
2251 themselves the appropriate number of times if you give a prefix
2252 argument.
2254 You may use the `gud-def' macro in the initialization hook to define other
2255 commands.
2257 Other commands for interacting with the debugger process are inherited from
2258 comint mode, which see."
2259 (setq mode-line-process '(":%s"))
2260 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
2261 (set (make-local-variable 'gud-last-frame) nil)
2262 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
2263 (make-local-variable 'comint-prompt-regexp)
2264 ;; Don't put repeated commands in command history many times.
2265 (set (make-local-variable 'comint-input-ignoredups) t)
2266 (make-local-variable 'paragraph-start)
2267 (set (make-local-variable 'gud-delete-prompt-marker) (make-marker)))
2269 ;; Cause our buffers to be displayed, by default,
2270 ;; in the selected window.
2271 ;;;###autoload (add-hook 'same-window-regexps "\\*gud-.*\\*\\(\\|<[0-9]+>\\)")
2273 (defcustom gud-chdir-before-run t
2274 "Non-nil if GUD should `cd' to the debugged executable."
2275 :group 'gud
2276 :type 'boolean)
2278 (defvar gud-target-name "--unknown--"
2279 "The apparent name of the program being debugged in a gud buffer.")
2281 ;; Perform initializations common to all debuggers.
2282 ;; The first arg is the specified command line,
2283 ;; which starts with the program to debug.
2284 ;; The other three args specify the values to use
2285 ;; for local variables in the debugger buffer.
2286 (defun gud-common-init (command-line massage-args marker-filter
2287 &optional find-file)
2288 (let* ((words (split-string command-line))
2289 (program (car words))
2290 (dir default-directory)
2291 ;; Extract the file name from WORDS
2292 ;; and put t in its place.
2293 ;; Later on we will put the modified file name arg back there.
2294 (file-word (let ((w (cdr words)))
2295 (while (and w (= ?- (aref (car w) 0)))
2296 (setq w (cdr w)))
2297 (and w
2298 (prog1 (car w)
2299 (setcar w t)))))
2300 (file-subst
2301 (and file-word (substitute-in-file-name file-word)))
2302 (args (cdr words))
2303 ;; If a directory was specified, expand the file name.
2304 ;; Otherwise, don't expand it, so GDB can use the PATH.
2305 ;; A file name without directory is literally valid
2306 ;; only if the file exists in ., and in that case,
2307 ;; omitting the expansion here has no visible effect.
2308 (file (and file-word
2309 (if (file-name-directory file-subst)
2310 (expand-file-name file-subst)
2311 file-subst)))
2312 (filepart (and file-word (concat "-" (file-name-nondirectory file)))))
2313 (pop-to-buffer (concat "*gud" filepart "*"))
2314 ;; Set the dir, in case the buffer already existed with a different dir.
2315 (setq default-directory dir)
2316 ;; Set default-directory to the file's directory.
2317 (and file-word
2318 gud-chdir-before-run
2319 ;; Don't set default-directory if no directory was specified.
2320 ;; In that case, either the file is found in the current directory,
2321 ;; in which case this setq is a no-op,
2322 ;; or it is found by searching PATH,
2323 ;; in which case we don't know what directory it was found in.
2324 (file-name-directory file)
2325 (setq default-directory (file-name-directory file)))
2326 (or (bolp) (newline))
2327 (insert "Current directory is " default-directory "\n")
2328 ;; Put the substituted and expanded file name back in its place.
2329 (let ((w args))
2330 (while (and w (not (eq (car w) t)))
2331 (setq w (cdr w)))
2332 (if w
2333 (setcar w file)))
2334 (apply 'make-comint (concat "gud" filepart) program nil
2335 (if massage-args (funcall massage-args file args) args))
2336 ;; Since comint clobbered the mode, we don't set it until now.
2337 (gud-mode)
2338 (set (make-local-variable 'gud-target-name)
2339 (and file-word (file-name-nondirectory file))))
2340 (set (make-local-variable 'gud-marker-filter) marker-filter)
2341 (if find-file (set (make-local-variable 'gud-find-file) find-file))
2342 (setq gud-running nil)
2343 (setq gud-last-last-frame nil)
2345 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
2346 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
2347 (gud-set-buffer))
2349 (defun gud-set-buffer ()
2350 (when (eq major-mode 'gud-mode)
2351 (setq gud-comint-buffer (current-buffer))))
2353 (defvar gud-filter-defer-flag nil
2354 "Non-nil means don't process anything from the debugger right now.
2355 It is saved for when this flag is not set.")
2357 (defvar gud-filter-pending-text nil
2358 "Non-nil means this is text that has been saved for later in `gud-filter'.")
2360 ;; These functions are responsible for inserting output from your debugger
2361 ;; into the buffer. The hard work is done by the method that is
2362 ;; the value of gud-marker-filter.
2364 (defun gud-filter (proc string)
2365 ;; Here's where the actual buffer insertion is done
2366 (let (output process-window)
2367 (if (buffer-name (process-buffer proc))
2368 (if gud-filter-defer-flag
2369 ;; If we can't process any text now,
2370 ;; save it for later.
2371 (setq gud-filter-pending-text
2372 (concat (or gud-filter-pending-text "") string))
2374 ;; If we have to ask a question during the processing,
2375 ;; defer any additional text that comes from the debugger
2376 ;; during that time.
2377 (let ((gud-filter-defer-flag t))
2378 ;; Process now any text we previously saved up.
2379 (if gud-filter-pending-text
2380 (setq string (concat gud-filter-pending-text string)
2381 gud-filter-pending-text nil))
2383 (with-current-buffer (process-buffer proc)
2384 ;; If we have been so requested, delete the debugger prompt.
2385 (save-restriction
2386 (widen)
2387 (if (marker-buffer gud-delete-prompt-marker)
2388 (progn
2389 (delete-region (process-mark proc)
2390 gud-delete-prompt-marker)
2391 (set-marker gud-delete-prompt-marker nil)))
2392 ;; Save the process output, checking for source file markers.
2393 (setq output (gud-marker-filter string))
2394 ;; Check for a filename-and-line number.
2395 ;; Don't display the specified file
2396 ;; unless (1) point is at or after the position where output appears
2397 ;; and (2) this buffer is on the screen.
2398 (setq process-window
2399 (and gud-last-frame
2400 (>= (point) (process-mark proc))
2401 (get-buffer-window (current-buffer)))))
2403 ;; Let the comint filter do the actual insertion.
2404 ;; That lets us inherit various comint features.
2405 (comint-output-filter proc output))
2407 ;; Put the arrow on the source line.
2408 ;; This must be outside of the save-excursion
2409 ;; in case the source file is our current buffer.
2410 (if process-window
2411 (save-selected-window
2412 (select-window process-window)
2413 (gud-display-frame))
2414 ;; We have to be in the proper buffer, (process-buffer proc),
2415 ;; but not in a save-excursion, because that would restore point.
2416 (let ((old-buf (current-buffer)))
2417 (set-buffer (process-buffer proc))
2418 (unwind-protect
2419 (gud-display-frame)
2420 (set-buffer old-buf)))))
2422 ;; If we deferred text that arrived during this processing,
2423 ;; handle it now.
2424 (if gud-filter-pending-text
2425 (gud-filter proc ""))))))
2427 (defun gud-sentinel (proc msg)
2428 (cond ((null (buffer-name (process-buffer proc)))
2429 ;; buffer killed
2430 ;; Stop displaying an arrow in a source file.
2431 (setq overlay-arrow-position nil)
2432 (set-process-buffer proc nil)
2433 (if (eq gud-minor-mode-type 'gdba)
2434 (gdb-reset)
2435 (gud-reset)))
2436 ((memq (process-status proc) '(signal exit))
2437 ;; Stop displaying an arrow in a source file.
2438 (setq overlay-arrow-position nil)
2439 (with-current-buffer gud-comint-buffer
2440 (if (eq gud-minor-mode 'gdba)
2441 (gdb-reset)
2442 (gud-reset)))
2443 (let* ((obuf (current-buffer)))
2444 ;; save-excursion isn't the right thing if
2445 ;; process-buffer is current-buffer
2446 (unwind-protect
2447 (progn
2448 ;; Write something in *compilation* and hack its mode line,
2449 (set-buffer (process-buffer proc))
2450 ;; Fix the mode line.
2451 (setq mode-line-process
2452 (concat ":"
2453 (symbol-name (process-status proc))))
2454 (force-mode-line-update)
2455 (if (eobp)
2456 (insert ?\n mode-name " " msg)
2457 (save-excursion
2458 (goto-char (point-max))
2459 (insert ?\n mode-name " " msg)))
2460 ;; If buffer and mode line will show that the process
2461 ;; is dead, we can delete it now. Otherwise it
2462 ;; will stay around until M-x list-processes.
2463 (delete-process proc))
2464 ;; Restore old buffer, but don't restore old point
2465 ;; if obuf is the gud buffer.
2466 (set-buffer obuf))))))
2468 (defvar gud-minor-mode-type nil)
2470 (defun gud-kill-buffer-hook ()
2471 (if gud-minor-mode
2472 (setq gud-minor-mode-type gud-minor-mode)))
2474 (add-hook 'kill-buffer-hook 'gud-kill-buffer-hook)
2476 (defun gud-reset ()
2477 (dolist (buffer (buffer-list))
2478 (if (not (eq buffer gud-comint-buffer))
2479 (save-excursion
2480 (set-buffer buffer)
2481 (when gud-minor-mode
2482 (setq gud-minor-mode nil)
2483 (kill-local-variable 'tool-bar-map))))))
2485 (defun gud-display-frame ()
2486 "Find and obey the last filename-and-line marker from the debugger.
2487 Obeying it means displaying in another window the specified file and line."
2488 (interactive)
2489 (when gud-last-frame
2490 (gud-set-buffer)
2491 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
2492 (setq gud-last-last-frame gud-last-frame
2493 gud-last-frame nil)))
2495 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
2496 ;; and that its line LINE is visible.
2497 ;; Put the overlay-arrow on the line LINE in that buffer.
2498 ;; Most of the trickiness in here comes from wanting to preserve the current
2499 ;; region-restriction if that's possible. We use an explicit display-buffer
2500 ;; to get around the fact that this is called inside a save-excursion.
2502 (defun gud-display-line (true-file line)
2503 (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
2504 (buffer
2505 (with-current-buffer gud-comint-buffer
2506 (gud-find-file true-file)))
2507 (window (and buffer (or (get-buffer-window buffer)
2508 (if (eq gud-minor-mode 'gdba)
2509 (gdb-display-source-buffer buffer)
2510 (display-buffer buffer)))))
2511 (pos))
2512 (if buffer
2513 (progn
2514 (with-current-buffer buffer
2515 (if (not (or (verify-visited-file-modtime buffer) gud-keep-buffer))
2516 (progn
2518 (yes-or-no-p
2519 (format "File %s changed on disk. Reread from disk? "
2520 (buffer-name)))
2521 (revert-buffer t t)
2522 (setq gud-keep-buffer t))))
2523 (save-restriction
2524 (widen)
2525 (goto-line line)
2526 (setq pos (point))
2527 (setq overlay-arrow-string "=>")
2528 (or overlay-arrow-position
2529 (setq overlay-arrow-position (make-marker)))
2530 (set-marker overlay-arrow-position (point) (current-buffer)))
2531 (cond ((or (< pos (point-min)) (> pos (point-max)))
2532 (widen)
2533 (goto-char pos))))
2534 (set-window-point window overlay-arrow-position)))))
2536 ;; The gud-call function must do the right thing whether its invoking
2537 ;; keystroke is from the GUD buffer itself (via major-mode binding)
2538 ;; or a C buffer. In the former case, we want to supply data from
2539 ;; gud-last-frame. Here's how we do it:
2541 (defun gud-format-command (str arg)
2542 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
2543 (frame (or gud-last-frame gud-last-last-frame))
2544 result)
2545 (while (and str (string-match "\\([^%]*\\)%\\([adeflpc]\\)" str))
2546 (let ((key (string-to-char (match-string 2 str)))
2547 subst)
2548 (cond
2549 ((eq key ?f)
2550 (setq subst (file-name-nondirectory (if insource
2551 (buffer-file-name)
2552 (car frame)))))
2553 ((eq key ?F)
2554 (setq subst (file-name-sans-extension
2555 (file-name-nondirectory (if insource
2556 (buffer-file-name)
2557 (car frame))))))
2558 ((eq key ?d)
2559 (setq subst (file-name-directory (if insource
2560 (buffer-file-name)
2561 (car frame)))))
2562 ((eq key ?l)
2563 (setq subst (int-to-string
2564 (if insource
2565 (save-restriction
2566 (widen)
2567 (+ (count-lines (point-min) (point))
2568 (if (bolp) 1 0)))
2569 (cdr frame)))))
2570 ((eq key ?e)
2571 (setq subst (gud-find-c-expr)))
2572 ((eq key ?a)
2573 (setq subst (gud-read-address)))
2574 ((eq key ?c)
2575 (setq subst
2576 (gud-find-class
2577 (if insource
2578 (buffer-file-name)
2579 (car frame))
2580 (if insource
2581 (save-restriction
2582 (widen)
2583 (+ (count-lines (point-min) (point))
2584 (if (bolp) 1 0)))
2585 (cdr frame)))))
2586 ((eq key ?p)
2587 (setq subst (if arg (int-to-string arg)))))
2588 (setq result (concat result (match-string 1 str) subst)))
2589 (setq str (substring str (match-end 2))))
2590 ;; There might be text left in STR when the loop ends.
2591 (concat result str)))
2593 (defun gud-read-address ()
2594 "Return a string containing the core-address found in the buffer at point."
2595 (save-match-data
2596 (save-excursion
2597 (let ((pt (point)) found begin)
2598 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
2599 (cond
2600 (found (forward-char 2)
2601 (buffer-substring found
2602 (progn (re-search-forward "[^0-9a-f]")
2603 (forward-char -1)
2604 (point))))
2605 (t (setq begin (progn (re-search-backward "[^0-9]")
2606 (forward-char 1)
2607 (point)))
2608 (forward-char 1)
2609 (re-search-forward "[^0-9]")
2610 (forward-char -1)
2611 (buffer-substring begin (point))))))))
2613 (defun gud-call (fmt &optional arg)
2614 (let ((msg (gud-format-command fmt arg)))
2615 (message "Command: %s" msg)
2616 (sit-for 0)
2617 (gud-basic-call msg)))
2619 (defun gud-basic-call (command)
2620 "Invoke the debugger COMMAND displaying source in other window."
2621 (interactive)
2622 (gud-set-buffer)
2623 (let ((proc (get-buffer-process gud-comint-buffer)))
2624 (or proc (error "Current buffer has no process"))
2625 ;; Arrange for the current prompt to get deleted.
2626 (save-excursion
2627 (set-buffer gud-comint-buffer)
2628 (save-restriction
2629 (widen)
2630 (goto-char (process-mark proc))
2631 (forward-line 0)
2632 (if (looking-at comint-prompt-regexp)
2633 (set-marker gud-delete-prompt-marker (point)))
2634 (if (eq gud-minor-mode 'gdba)
2635 (apply comint-input-sender (list proc command))
2636 (process-send-string proc (concat command "\n")))))))
2638 (defun gud-refresh (&optional arg)
2639 "Fix up a possibly garbled display, and redraw the arrow."
2640 (interactive "P")
2641 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
2642 (gud-display-frame)
2643 (recenter arg))
2645 ;; Code for parsing expressions out of C code. The single entry point is
2646 ;; find-c-expr, which tries to return an lvalue expression from around point.
2648 ;; The rest of this file is a hacked version of gdbsrc.el by
2649 ;; Debby Ayers <ayers@asc.slb.com>,
2650 ;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
2652 (defun gud-find-c-expr ()
2653 "Returns the C expr that surrounds point."
2654 (interactive)
2655 (save-excursion
2656 (let (p expr test-expr)
2657 (setq p (point))
2658 (setq expr (gud-innermost-expr))
2659 (setq test-expr (gud-prev-expr))
2660 (while (and test-expr (gud-expr-compound test-expr expr))
2661 (let ((prev-expr expr))
2662 (setq expr (cons (car test-expr) (cdr expr)))
2663 (goto-char (car expr))
2664 (setq test-expr (gud-prev-expr))
2665 ;; If we just pasted on the condition of an if or while,
2666 ;; throw it away again.
2667 (if (member (buffer-substring (car test-expr) (cdr test-expr))
2668 '("if" "while" "for"))
2669 (setq test-expr nil
2670 expr prev-expr))))
2671 (goto-char p)
2672 (setq test-expr (gud-next-expr))
2673 (while (gud-expr-compound expr test-expr)
2674 (setq expr (cons (car expr) (cdr test-expr)))
2675 (setq test-expr (gud-next-expr)))
2676 (buffer-substring (car expr) (cdr expr)))))
2678 (defun gud-innermost-expr ()
2679 "Returns the smallest expr that point is in; move point to beginning of it.
2680 The expr is represented as a cons cell, where the car specifies the point in
2681 the current buffer that marks the beginning of the expr and the cdr specifies
2682 the character after the end of the expr."
2683 (let ((p (point)) begin end)
2684 (gud-backward-sexp)
2685 (setq begin (point))
2686 (gud-forward-sexp)
2687 (setq end (point))
2688 (if (>= p end)
2689 (progn
2690 (setq begin p)
2691 (goto-char p)
2692 (gud-forward-sexp)
2693 (setq end (point)))
2695 (goto-char begin)
2696 (cons begin end)))
2698 (defun gud-backward-sexp ()
2699 "Version of `backward-sexp' that catches errors."
2700 (condition-case nil
2701 (backward-sexp)
2702 (error t)))
2704 (defun gud-forward-sexp ()
2705 "Version of `forward-sexp' that catches errors."
2706 (condition-case nil
2707 (forward-sexp)
2708 (error t)))
2710 (defun gud-prev-expr ()
2711 "Returns the previous expr, point is set to beginning of that expr.
2712 The expr is represented as a cons cell, where the car specifies the point in
2713 the current buffer that marks the beginning of the expr and the cdr specifies
2714 the character after the end of the expr"
2715 (let ((begin) (end))
2716 (gud-backward-sexp)
2717 (setq begin (point))
2718 (gud-forward-sexp)
2719 (setq end (point))
2720 (goto-char begin)
2721 (cons begin end)))
2723 (defun gud-next-expr ()
2724 "Returns the following expr, point is set to beginning of that expr.
2725 The expr is represented as a cons cell, where the car specifies the point in
2726 the current buffer that marks the beginning of the expr and the cdr specifies
2727 the character after the end of the expr."
2728 (let ((begin) (end))
2729 (gud-forward-sexp)
2730 (gud-forward-sexp)
2731 (setq end (point))
2732 (gud-backward-sexp)
2733 (setq begin (point))
2734 (cons begin end)))
2736 (defun gud-expr-compound-sep (span-start span-end)
2737 "Scan from SPAN-START to SPAN-END for punctuation characters.
2738 If `->' is found, return `?.'. If `.' is found, return `?.'.
2739 If any other punctuation is found, return `??'.
2740 If no punctuation is found, return `? '."
2741 (let ((result ?\ )
2742 (syntax))
2743 (while (< span-start span-end)
2744 (setq syntax (char-syntax (char-after span-start)))
2745 (cond
2746 ((= syntax ?\ ) t)
2747 ((= syntax ?.) (setq syntax (char-after span-start))
2748 (cond
2749 ((= syntax ?.) (setq result ?.))
2750 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
2751 (setq result ?.)
2752 (setq span-start (+ span-start 1)))
2753 (t (setq span-start span-end)
2754 (setq result ??)))))
2755 (setq span-start (+ span-start 1)))
2756 result))
2758 (defun gud-expr-compound (first second)
2759 "Non-nil if concatenating FIRST and SECOND makes a single C expression.
2760 The two exprs are represented as a cons cells, where the car
2761 specifies the point in the current buffer that marks the beginning of the
2762 expr and the cdr specifies the character after the end of the expr.
2763 Link exprs of the form:
2764 Expr -> Expr
2765 Expr . Expr
2766 Expr (Expr)
2767 Expr [Expr]
2768 (Expr) Expr
2769 [Expr] Expr"
2770 (let ((span-start (cdr first))
2771 (span-end (car second))
2772 (syntax))
2773 (setq syntax (gud-expr-compound-sep span-start span-end))
2774 (cond
2775 ((= (car first) (car second)) nil)
2776 ((= (cdr first) (cdr second)) nil)
2777 ((= syntax ?.) t)
2778 ((= syntax ?\ )
2779 (setq span-start (char-after (- span-start 1)))
2780 (setq span-end (char-after span-end))
2781 (cond
2782 ((= span-start ?)) t)
2783 ((= span-start ?]) t)
2784 ((= span-end ?() t)
2785 ((= span-end ?[) t)
2786 (t nil)))
2787 (t nil))))
2789 (defun gud-find-class (f line)
2790 "Find fully qualified class in file F at line LINE.
2791 This function uses the `gud-jdb-classpath' (and optional
2792 `gud-jdb-sourcepath') list(s) to derive a file
2793 pathname relative to its classpath directory. The values in
2794 `gud-jdb-classpath' are assumed to have been converted to absolute
2795 pathname standards using file-truename.
2796 If F is visited by a buffer and its mode is CC-mode(Java),
2797 syntactic information of LINE is used to find the enclosing (nested)
2798 class string which is appended to the top level
2799 class of the file (using s to separate nested class ids)."
2800 ;; Convert f to a standard representation and remove suffix
2801 (if (and gud-jdb-use-classpath (or gud-jdb-classpath gud-jdb-sourcepath))
2802 (save-match-data
2803 (let ((cplist (append gud-jdb-sourcepath gud-jdb-classpath))
2804 (fbuffer (get-file-buffer f))
2805 class-found)
2806 (setq f (file-name-sans-extension (file-truename f)))
2807 ;; Search through classpath list for an entry that is
2808 ;; contained in f
2809 (while (and cplist (not class-found))
2810 (if (string-match (car cplist) f)
2811 (setq class-found
2812 (mapconcat 'identity
2813 (split-string
2814 (substring f (+ (match-end 0) 1))
2815 "/") ".")))
2816 (setq cplist (cdr cplist)))
2817 ;; if f is visited by a java(cc-mode) buffer, walk up the
2818 ;; syntactic information chain and collect any 'inclass
2819 ;; symbols until 'topmost-intro is reached to find out if
2820 ;; point is within a nested class
2821 (if (and fbuffer (equal (symbol-file 'java-mode) "cc-mode"))
2822 (save-excursion
2823 (set-buffer fbuffer)
2824 (let ((nclass) (syntax)
2825 (pos (point)))
2826 ;; While the c-syntactic information does not start
2827 ;; with the 'topmost-intro symbol, there may be
2828 ;; nested classes...
2829 (while (not (eq 'topmost-intro
2830 (car (car (c-guess-basic-syntax)))))
2831 ;; Check if the current position c-syntactic
2832 ;; analysis has 'inclass
2833 (setq syntax (c-guess-basic-syntax))
2834 (while
2835 (and (not (eq 'inclass (car (car syntax))))
2836 (cdr syntax))
2837 (setq syntax (cdr syntax)))
2838 (if (eq 'inclass (car (car syntax)))
2839 (progn
2840 (goto-char (cdr (car syntax)))
2841 ;; Now we're at the beginning of a class
2842 ;; definition. Find class name
2843 (looking-at
2844 "[A-Za-z0-9 \t\n]*?class[ \t\n]+\\([^ \t\n]+\\)")
2845 (setq nclass
2846 (append (list (match-string-no-properties 1))
2847 nclass)))
2848 (setq syntax (c-guess-basic-syntax))
2849 (while (and (not (cdr (car syntax))) (cdr syntax))
2850 (setq syntax (cdr syntax)))
2851 (goto-char (cdr (car syntax)))
2853 (string-match (concat (car nclass) "$") class-found)
2854 (setq class-found
2855 (replace-match (mapconcat 'identity nclass "$")
2856 t t class-found)))))
2857 (if (not class-found)
2858 (message "gud-find-class: class for file %s not found!" f))
2859 class-found))
2860 ;; Not using classpath - try class/source association list
2861 (let ((class-found (rassoc f gud-jdb-class-source-alist)))
2862 (if class-found
2863 (car class-found)
2864 (message "gud-find-class: class for file %s not found in gud-jdb-class-source-alist!" f)
2865 nil))))
2867 (provide 'gud)
2869 ;;; gud.el ends here