| blob | f6ef6f1e810dae320ec03660ff803f5c8cef46ca |
1 ;;; gud.el --- Grand Unified Debugger mode for running GDB and other debuggers
3 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
4 ;; Maintainer: FSF
5 ;; Keywords: unix, tools
7 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 2000, 2001, 2002, 2003,
8 ;; 2004, 2005 Free Software Foundation, Inc.
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
29 ;; The ancestral gdb.el was by W. Schelter <wfs@rascal.ics.utexas.edu> It was
30 ;; later rewritten by rms. Some ideas were due to Masanobu. Grand
31 ;; Unification (sdb/dbx support) by Eric S. Raymond <esr@thyrsus.com> Barry
32 ;; Warsaw <bwarsaw@cen.com> hacked the mode to use comint.el. Shane Hartman
33 ;; <shane@spr.com> added support for xdb (HPUX debugger). Rick Sladkey
34 ;; <jrs@world.std.com> wrote the GDB command completion code. Dave Love
35 ;; <d.love@dl.ac.uk> added the IRIX kluge, re-implemented the Mips-ish variant
36 ;; and added a menu. Brian D. Carlstrom <bdc@ai.mit.edu> combined the IRIX
37 ;; kluge with the gud-xdb-directories hack producing gud-dbx-directories.
38 ;; Derek L. Davies <ddavies@world.std.com> added support for jdb (Java
39 ;; debugger.)
41 ;;; Code:
58 ;; ======================================================================
59 ;; GUD commands must be visible in C buffers visited by GUD
62 "Grand Unified Debugger mode for gdb and other debuggers under Emacs.
63 Supported debuggers include gdb, sdb, dbx, xdb, perldb, pdb (Python), jdb, and bash."
69 "Prefix of all GUD commands valid in C buffers."
90 "Return the symbol used for SYM in MINOR-MODE.
91 MINOR-MODE defaults to `gud-minor-mode.
92 The symbol returned is `gud-<MINOR-MODE>-<SYM>'.
93 If SOFT is non-nil, returns nil if the symbol doesn't already exist."
99 "Return the value of `gud-symbol' SYM. Default to nil."
104 "Non-nil if debuggee is running.
107 ;; Use existing Info buffer, if possible.
109 "Go to relevant Emacs info node."
140 ([tooltips] menu-item "Toggle GUD tooltips" gud-tooltip-mode
141 :enable (and (not emacs-basic-display)
142 (display-graphic-p)
143 (fboundp 'x-show-tip))
144 :button (:toggle . gud-tooltip-mode))
145 ([refresh] "Refresh" . gud-refresh)
146 ([run] menu-item "Run" gud-run
147 :enable (and (not gud-running)
148 (memq gud-minor-mode '(gdbmi gdb dbx jdb)))
149 :visible (not (eq gud-minor-mode 'gdba)))
150 ([go] menu-item "Run/Continue" gud-go
151 :visible (and (not gud-running)
152 (eq gud-minor-mode 'gdba)))
153 ([stop] menu-item "Stop" gud-stop-subjob
154 :visible (or (not (eq gud-minor-mode 'gdba))
155 (and gud-running
156 (eq gud-minor-mode 'gdba))))
157 ([until] menu-item "Continue to selection" gud-until
158 :enable (and (not gud-running)
159 (memq gud-minor-mode '(gdbmi gdba gdb perldb)))
160 :visible (gud-tool-bar-item-visible-no-fringe))
161 ([remove] menu-item "Remove Breakpoint" gud-remove
162 :enable (not gud-running)
163 :visible (gud-tool-bar-item-visible-no-fringe))
164 ([tbreak] menu-item "Temporary Breakpoint" gud-tbreak
165 :enable (memq gud-minor-mode
166 '(gdbmi gdba gdb sdb xdb bashdb)))
167 ([break] menu-item "Set Breakpoint" gud-break
168 :enable (not gud-running)
169 :visible (gud-tool-bar-item-visible-no-fringe))
170 ([up] menu-item "Up Stack" gud-up
171 :enable (and (not gud-running)
172 (memq gud-minor-mode
173 '(gdbmi gdba gdb dbx xdb jdb pdb bashdb))))
174 ([down] menu-item "Down Stack" gud-down
175 :enable (and (not gud-running)
176 (memq gud-minor-mode
177 '(gdbmi gdba gdb dbx xdb jdb pdb bashdb))))
178 ([pp] menu-item "Print the emacs s-expression" gud-pp
179 :enable (and (not gud-running)
180 gdb-active-process)
181 :visible (and (string-equal
182 (buffer-local-value
183 'gud-target-name gud-comint-buffer) "emacs")
184 (eq gud-minor-mode 'gdba)))
185 ([print*] menu-item "Print Dereference" gud-pstar
186 :enable (and (not gud-running)
187 (memq gud-minor-mode '(gdbmi gdba gdb))))
188 ([print] menu-item "Print Expression" gud-print
189 :enable (not gud-running))
190 ([watch] menu-item "Watch Expression" gud-watch
191 :enable (and (not gud-running)
192 (memq gud-minor-mode '(gdbmi gdba))))
193 ([finish] menu-item "Finish Function" gud-finish
194 :enable (and (not gud-running)
195 (memq gud-minor-mode
196 '(gdbmi gdba gdb xdb jdb pdb bashdb))))
197 ([stepi] menu-item "Step Instruction" gud-stepi
198 :enable (and (not gud-running)
199 (memq gud-minor-mode '(gdbmi gdba gdb dbx))))
200 ([nexti] menu-item "Next Instruction" gud-nexti
201 :enable (and (not gud-running)
202 (memq gud-minor-mode '(gdbmi gdba gdb dbx))))
203 ([step] menu-item "Step Line" gud-step
204 :enable (not gud-running))
205 ([next] menu-item "Next Line" gud-next
206 :enable (not gud-running))
207 ([cont] menu-item "Continue" gud-cont
208 :enable (not gud-running)
209 :visible (not (eq gud-minor-mode 'gdba))))
210 "Menu for `gud-mode'."
211 :name "Gud")
213 (easy-mmode-defmap gud-minor-mode-map
214 `(([menu-bar debug] . ("Gud" . ,gud-menu-map)))
215 "Map used in visited files.")
217 (let ((m (assq 'gud-minor-mode minor-mode-map-alist)))
218 (if m (setcdr m gud-minor-mode-map)
219 (push (cons 'gud-minor-mode gud-minor-mode-map) minor-mode-map-alist)))
221 (defvar gud-mode-map
222 ;; Will inherit from comint-mode via define-derived-mode.
223 (make-sparse-keymap)
224 "`gud-mode' keymap.")
226 (defvar gud-tool-bar-map
227 (if (display-graphic-p)
228 (let ((map (make-sparse-keymap)))
229 (dolist (x '((gud-break . "gud/break")
230 (gud-remove . "gud/remove")
231 (gud-print . "gud/print")
232 (gud-pstar . "gud/pstar")
233 (gud-pp . "gud/pp")
234 (gud-watch . "gud/watch")
235 (gud-run . "gud/run")
236 (gud-go . "gud/go")
237 (gud-stop-subjob . "gud/stop")
238 ;; gud-s, gud-si etc. instead of gud-step,
239 ;; gud-stepi, to avoid file-name clashes on DOS
240 ;; 8+3 filesystems.
241 (gud-cont . "gud/cont")
242 (gud-until . "gud/until")
243 (gud-next . "gud/next")
244 (gud-step . "gud/step")
245 (gud-finish . "gud/finish")
246 (gud-nexti . "gud/nexti")
247 (gud-stepi . "gud/stepi")
248 (gud-up . "gud/up")
249 (gud-down . "gud/down")
250 (gud-goto-info . "info"))
251 map)
252 (tool-bar-local-item-from-menu
253 (car x) (cdr x) map gud-minor-mode-map)))))
255 (defun gud-file-name (f)
256 "Transform a relative file name to an absolute file name.
257 Uses `gud-<MINOR-MODE>-directories' to find the source files."
258 (if (file-exists-p f) (expand-file-name f)
259 (let ((directories (gud-val 'directories))
260 (result nil))
261 (while directories
262 (let ((path (expand-file-name f (car directories))))
263 (if (file-exists-p path)
264 (setq result path
265 directories nil)))
266 (setq directories (cdr directories)))
267 result)))
269 (defun gud-find-file (file)
270 ;; Don't get confused by double slashes in the name that comes from GDB.
271 (while (string-match "//+" file)
272 (setq file (replace-match "/" t t file)))
273 (let ((minor-mode gud-minor-mode)
274 (buf (funcall (or gud-find-file 'gud-file-name) file)))
275 (when (stringp buf)
276 (setq buf (and (file-readable-p buf) (find-file-noselect buf 'nowarn))))
277 (when buf
278 ;; Copy `gud-minor-mode' to the found buffer to turn on the menu.
279 (with-current-buffer buf
280 (set (make-local-variable 'gud-minor-mode) minor-mode)
281 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
282 (when (and gud-tooltip-mode
283 (memq gud-minor-mode '(gdbmi gdba)))
284 (make-local-variable 'gdb-define-alist)
285 (unless gdb-define-alist (gdb-create-define-alist))
286 (add-hook 'after-save-hook 'gdb-create-define-alist nil t))
287 (make-local-variable 'gud-keep-buffer))
288 buf)))
289 \f
290 ;; ======================================================================
291 ;; command definition
293 ;; This macro is used below to define some basic debugger interface commands.
294 ;; Of course you may use `gud-def' with any other debugger command, including
295 ;; user defined ones.
297 ;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
298 ;; which defines FUNC to send the command NAME to the debugger, gives
299 ;; it the docstring DOC, and binds that function to KEY in the GUD
300 ;; major mode. The function is also bound in the global keymap with the
301 ;; GUD prefix.
303 (defmacro gud-def (func cmd key &optional doc)
304 "Define FUNC to be a command sending STR and bound to KEY, with
305 optional doc string DOC. Certain %-escapes in the string arguments
306 are interpreted specially if present. These are:
308 %f name (without directory) of current source file.
309 %F name (without directory or extension) of current source file.
310 %d directory of current source file.
311 %l number of current source line
312 %e text of the C lvalue or function-call expression surrounding point.
313 %a text of the hexadecimal address surrounding point
314 %p prefix argument to the command (if any) as a number
316 The `current' source file is the file of the current buffer (if
317 we're in a C file) or the source file current at the last break or
318 step (if we're in the GUD buffer).
319 The `current' line is that of the current buffer (if we're in a
320 source file) or the source line number at the last break or step (if
321 we're in the GUD buffer)."
322 `(progn
323 (defun ,func (arg)
324 ,@(if doc (list doc))
325 (interactive "p")
326 ,(if (stringp cmd)
327 `(gud-call ,cmd arg)
328 cmd))
329 ,(if key `(local-set-key ,(concat "\C-c" key) ',func))
330 ,(if key `(global-set-key (vconcat gud-key-prefix ,key) ',func))))
332 ;; Where gud-display-frame should put the debugging arrow; a cons of
333 ;; (filename . line-number). This is set by the marker-filter, which scans
334 ;; the debugger's output for indications of the current program counter.
335 (defvar gud-last-frame nil)
337 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
338 ;; the last frame, even if it's been called before and gud-last-frame has
339 ;; been set to nil.
340 (defvar gud-last-last-frame nil)
342 ;; All debugger-specific information is collected here.
343 ;; Here's how it works, in case you ever need to add a debugger to the mode.
344 ;;
345 ;; Each entry must define the following at startup:
346 ;;
347 ;;<name>
348 ;; comint-prompt-regexp
349 ;; gud-<name>-massage-args
350 ;; gud-<name>-marker-filter
351 ;; gud-<name>-find-file
352 ;;
353 ;; The job of the massage-args method is to modify the given list of
354 ;; debugger arguments before running the debugger.
355 ;;
356 ;; The job of the marker-filter method is to detect file/line markers in
357 ;; strings and set the global gud-last-frame to indicate what display
358 ;; action (if any) should be triggered by the marker. Note that only
359 ;; whatever the method *returns* is displayed in the buffer; thus, you
360 ;; can filter the debugger's output, interpreting some and passing on
361 ;; the rest.
362 ;;
363 ;; The job of the find-file method is to visit and return the buffer indicated
364 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
365 ;; something else.
366 \f
367 ;; ======================================================================
368 ;; speedbar support functions and variables.
369 (eval-when-compile (require 'speedbar)) ;For speedbar-with-attached-buffer.
371 (defvar gud-last-speedbar-stackframe nil
372 "Description of the currently displayed GUD stack.
373 t means that there is no stack, and we are in display-file mode.")
375 (defvar gud-speedbar-key-map nil
376 "Keymap used when in the buffers display mode.")
378 (defun gud-speedbar-item-info ()
379 "Display the data type of the watch expression element."
380 (let ((var (nth (- (line-number-at-pos (point)) 2) gdb-var-list)))
381 (if (nth 4 var)
382 (speedbar-message "%s" (nth 3 var)))))
384 (defun gud-install-speedbar-variables ()
385 "Install those variables used by speedbar to enhance gud/gdb."
386 (if gud-speedbar-key-map
387 nil
388 (setq gud-speedbar-key-map (speedbar-make-specialized-keymap))
390 (define-key gud-speedbar-key-map "j" 'speedbar-edit-line)
391 (define-key gud-speedbar-key-map "e" 'speedbar-edit-line)
392 (define-key gud-speedbar-key-map "\C-m" 'speedbar-edit-line)
393 (define-key gud-speedbar-key-map " " 'speedbar-toggle-line-expansion)
394 (define-key gud-speedbar-key-map "[" 'speedbar-expand-line-descendants)
395 (define-key gud-speedbar-key-map "]" 'speedbar-contract-line-descendants)
396 (define-key gud-speedbar-key-map "D" 'gdb-var-delete)
397 (define-key gud-speedbar-key-map "p" 'gud-pp))
399 (speedbar-add-expansion-list '("GUD" gud-speedbar-menu-items
400 gud-speedbar-key-map
401 gud-expansion-speedbar-buttons))
403 (add-to-list
404 'speedbar-mode-functions-list
405 '("GUD" (speedbar-item-info . gud-speedbar-item-info)
406 (speedbar-line-directory . ignore))))
408 (defvar gud-speedbar-menu-items
409 '(["Jump to stack frame" speedbar-edit-line
410 :visible (with-current-buffer gud-comint-buffer
411 (not (memq gud-minor-mode '(gdbmi gdba))))]
412 ["Edit value" speedbar-edit-line
413 :visible (with-current-buffer gud-comint-buffer
414 (memq gud-minor-mode '(gdbmi gdba)))]
415 ["Delete expression" gdb-var-delete
416 (with-current-buffer gud-comint-buffer
417 (memq gud-minor-mode '(gdbmi gdba)))]
418 ["Auto raise frame" gdb-speedbar-auto-raise
419 :style toggle :selected gdb-speedbar-auto-raise
420 :visible (with-current-buffer gud-comint-buffer
421 (memq gud-minor-mode '(gdbmi gdba)))])
422 "Additional menu items to add to the speedbar frame.")
424 ;; Make sure our special speedbar mode is loaded
425 (if (featurep 'speedbar)
426 (gud-install-speedbar-variables)
427 (add-hook 'speedbar-load-hook 'gud-install-speedbar-variables))
429 (defun gud-expansion-speedbar-buttons (directory zero)
430 "Wrapper for call to speedbar-add-expansion-list. DIRECTORY and
431 ZERO are not used, but are required by the caller."
432 (gud-speedbar-buttons gud-comint-buffer))
434 (defun gud-speedbar-buttons (buffer)
435 "Create a speedbar display based on the current state of GUD.
436 If the GUD BUFFER is not running a supported debugger, then turn
437 off the specialized speedbar mode. BUFFER is not used, but are
438 required by the caller."
439 (when (and (boundp 'gud-comint-buffer)
440 gud-comint-buffer
441 ;; gud-comint-buffer might be killed
442 (buffer-name gud-comint-buffer))
443 (let* ((minor-mode (with-current-buffer buffer gud-minor-mode))
444 (window (get-buffer-window (current-buffer) 0))
445 (p (window-point window)))
446 (cond
447 ((memq minor-mode '(gdbmi gdba))
448 (when (or gdb-var-changed
449 (not (save-excursion
450 (goto-char (point-min))
451 (let ((case-fold-search t))
452 (looking-at "Watch Expressions:")))))
453 (erase-buffer)
455 (if gdb-speedbar-auto-raise
456 (raise-frame speedbar-frame))
457 (let ((var-list gdb-var-list))
458 (while var-list
459 (let* (char (depth 0) (start 0)
460 (var (car var-list)) (varnum (nth 1 var)))
462 (setq depth (1+ depth)
463 start (1+ (match-beginning 0))))
464 (if (or (equal (nth 2 var) "0")
465 (and (equal (nth 2 var) "1")
467 (speedbar-make-tag-line 'bracket ?? nil nil
469 'gdb-edit-value
470 nil
471 (if (and (nth 5 var)
472 gdb-show-changed-values)
473 'font-lock-warning-face
474 nil) depth)
475 (if (and (cadr var-list)
477 (cadr (cadr var-list))))
478 (setq char ?-)
479 (setq char ?+))
481 (speedbar-make-tag-line 'bracket char
482 'gdb-speedbar-expand-node varnum
485 (nth 4 var))
486 'gdb-edit-value nil
487 (if (and (nth 5 var)
488 gdb-show-changed-values)
489 'font-lock-warning-face
490 nil) depth)
491 (speedbar-make-tag-line 'bracket char
492 'gdb-speedbar-expand-node varnum
494 nil nil nil depth))))
495 (setq var-list (cdr var-list))))
496 (setq gdb-var-changed nil)))
497 (t (if (and (save-excursion
498 (goto-char (point-min))
499 (looking-at "Current Stack:"))
500 (equal gud-last-last-frame gud-last-speedbar-stackframe))
501 nil
502 (let ((gud-frame-list
503 (cond ((eq minor-mode 'gdb)
504 (gud-gdb-get-stackframe buffer))
505 ;; Add more debuggers here!
506 (t (speedbar-remove-localized-speedbar-support buffer)
507 nil))))
508 (erase-buffer)
509 (if (not gud-frame-list)
512 (dolist (frame gud-frame-list)
514 (if (= (length frame) 2)
515 (progn
516 (speedbar-insert-button (car frame)
517 'speedbar-directory-face
518 nil nil nil t))
519 (speedbar-insert-button
520 (car frame)
521 'speedbar-file-face
522 'speedbar-highlight-face
523 (cond ((memq minor-mode '(gdbmi gdba gdb))
524 'gud-gdb-goto-stackframe)
525 (t (error "Should never be here")))
526 frame t))))
527 (setq gud-last-speedbar-stackframe gud-last-last-frame))))
528 (set-window-point window p))))
530 \f
531 ;; ======================================================================
532 ;; gdb functions
534 ;; History of argument lists passed to gdb.
535 (defvar gud-gdb-history nil)
537 (defcustom gud-gdb-command-name "gdb --annotate=3"
538 "Default command to execute an executable under the GDB debugger."
539 :type 'string
540 :group 'gud)
542 (defvar gud-gdb-marker-regexp
543 ;; This used to use path-separator instead of ":";
544 ;; however, we found that on both Windows 32 and MSDOS
545 ;; a colon is correct here.
549 ;; There's no guarantee that Emacs will hand the filter the entire
550 ;; marker at once; it could be broken up across several strings. We
551 ;; might even receive a big chunk with several markers in it. If we
552 ;; receive a chunk of text which looks like it might contain the
553 ;; beginning of a marker, we save it here between calls to the
554 ;; filter.
555 (defvar gud-marker-acc "")
556 (make-variable-buffer-local 'gud-marker-acc)
558 (defun gud-gdb-marker-filter (string)
559 (setq gud-marker-acc (concat gud-marker-acc string))
560 (let ((output ""))
562 ;; Process all the complete markers in this chunk.
563 (while (string-match gud-gdb-marker-regexp gud-marker-acc)
564 (setq
566 ;; Extract the frame position from the marker.
567 gud-last-frame (cons (match-string 1 gud-marker-acc)
568 (string-to-number (match-string 2 gud-marker-acc)))
570 ;; Append any text before the marker to the output we're going
571 ;; to return - we don't include the marker in this text.
572 output (concat output
573 (substring gud-marker-acc 0 (match-beginning 0)))
575 ;; Set the accumulator to the remaining text.
576 gud-marker-acc (substring gud-marker-acc (match-end 0))))
578 ;; Check for annotations and change gud-minor-mode to 'gdba if
579 ;; they are found.
581 (let ((match (match-string 1 gud-marker-acc)))
583 ;; Pick up stopped annotation if attaching to process.
584 (if (string-equal match "stopped") (setq gdb-active-process t))
586 ;; Using annotations, switch to gud-gdba-marker-filter.
587 (when (string-equal match "prompt")
588 (require 'gdb-ui)
589 (gdb-prompt nil))
591 (setq
592 ;; Append any text before the marker to the output we're going
593 ;; to return - we don't include the marker in this text.
594 output (concat output
595 (substring gud-marker-acc 0 (match-beginning 0)))
597 ;; Set the accumulator to the remaining text.
599 gud-marker-acc (substring gud-marker-acc (match-end 0)))
601 ;; Pick up any errors that occur before first prompt annotation.
602 (if (string-equal match "error-begin")
603 (put-text-property 0 (length gud-marker-acc)
604 'face font-lock-warning-face
605 gud-marker-acc))))
607 ;; Does the remaining text look like it might end with the
608 ;; beginning of another marker? If it does, then keep it in
609 ;; gud-marker-acc until we receive the rest of it. Since we
610 ;; know the full marker regexp above failed, it's pretty simple to
611 ;; test for marker starts.
613 (progn
614 ;; Everything before the potential marker start can be output.
615 (setq output (concat output (substring gud-marker-acc
616 0 (match-beginning 0))))
618 ;; Everything after, we save, to combine with later input.
619 (setq gud-marker-acc
620 (substring gud-marker-acc (match-beginning 0))))
622 (setq output (concat output gud-marker-acc)
623 gud-marker-acc ""))
625 output))
627 (easy-mmode-defmap gud-minibuffer-local-map
628 '(("\C-i" . comint-dynamic-complete-filename))
629 "Keymap for minibuffer prompting of gud startup command."
630 :inherit minibuffer-local-map)
632 (defun gud-query-cmdline (minor-mode &optional init)
633 (let* ((hist-sym (gud-symbol 'history nil minor-mode))
634 (cmd-name (gud-val 'command-name minor-mode)))
635 (unless (boundp hist-sym) (set hist-sym nil))
636 (read-from-minibuffer
637 (format "Run %s (like this): " minor-mode)
638 (or (car-safe (symbol-value hist-sym))
639 (concat (or cmd-name (symbol-name minor-mode))
640 " "
641 (or init
642 (let ((file nil))
643 (dolist (f (directory-files default-directory) file)
644 (if (and (file-executable-p f)
645 (not (file-directory-p f))
646 (or (not file)
647 (file-newer-than-file-p f file)))
648 (setq file f)))))))
649 gud-minibuffer-local-map nil
650 hist-sym)))
652 (defvar gdb-first-prompt t)
654 (defvar gud-filter-pending-text nil
655 "Non-nil means this is text that has been saved for later in `gud-filter'.")
657 ;;;###autoload
658 (defun gdb (command-line)
659 "Run gdb on program FILE in buffer *gud-FILE*.
660 The directory containing FILE becomes the initial working directory
661 and source-file directory for your debugger."
662 (interactive (list (gud-query-cmdline 'gdb)))
664 (gud-common-init command-line nil 'gud-gdb-marker-filter)
665 (set (make-local-variable 'gud-minor-mode) 'gdb)
667 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
668 (gud-def gud-tbreak "tbreak %f:%l" "\C-t"
669 "Set temporary breakpoint at current line.")
670 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
671 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
672 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
673 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
674 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
675 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
676 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
677 (gud-def gud-jump
678 (progn (gud-call "tbreak %f:%l") (gud-call "jump %f:%l"))
679 "\C-j" "Set execution address to current line.")
681 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
682 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
683 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
684 (gud-def gud-pstar "print* %e" nil
685 "Evaluate C dereferenced pointer expression at point.")
687 ;; For debugging Emacs only.
688 (gud-def gud-pv "pv1 %e" "\C-v" "Print the value of the lisp variable.")
690 (gud-def gud-until "until %l" "\C-u" "Continue to current line.")
691 (gud-def gud-run "run" nil "Run the program.")
693 (local-set-key "\C-i" 'gud-gdb-complete-command)
694 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
695 (setq paragraph-start comint-prompt-regexp)
696 (setq gdb-first-prompt t)
697 (setq gud-filter-pending-text nil)
698 (run-hooks 'gdb-mode-hook))
700 ;; One of the nice features of GDB is its impressive support for
701 ;; context-sensitive command completion. We preserve that feature
702 ;; in the GUD buffer by using a GDB command designed just for Emacs.
704 ;; The completion process filter indicates when it is finished.
705 (defvar gud-gdb-fetch-lines-in-progress)
707 ;; Since output may arrive in fragments we accumulate partials strings here.
708 (defvar gud-gdb-fetch-lines-string)
710 ;; We need to know how much of the completion to chop off.
711 (defvar gud-gdb-fetch-lines-break)
713 ;; The completion list is constructed by the process filter.
714 (defvar gud-gdb-fetched-lines)
716 (defvar gud-comint-buffer nil)
718 (defun gud-gdb-complete-command ()
719 "Perform completion on the GDB command preceding point.
720 This is implemented using the GDB `complete' command which isn't
721 available with older versions of GDB."
722 (interactive)
723 (let* ((end (point))
724 (command (buffer-substring (comint-line-beginning-position) end))
725 (command-word
726 ;; Find the word break. This match will always succeed.
728 (substring command (match-beginning 2))))
729 (complete-list
730 (gud-gdb-run-command-fetch-lines (concat "complete " command)
731 (current-buffer)
732 ;; From string-match above.
733 (match-beginning 2))))
734 ;; Protect against old versions of GDB.
735 (and complete-list
737 (error "This version of GDB doesn't support the `complete' command"))
738 ;; Sort the list like readline.
739 (setq complete-list (sort complete-list (function string-lessp)))
740 ;; Remove duplicates.
741 (let ((first complete-list)
742 (second (cdr complete-list)))
743 (while second
744 (if (string-equal (car first) (car second))
745 (setcdr first (setq second (cdr second)))
746 (setq first second
747 second (cdr second)))))
748 ;; Add a trailing single quote if there is a unique completion
749 ;; and it contains an odd number of unquoted single quotes.
750 (and (= (length complete-list) 1)
751 (let ((str (car complete-list))
752 (pos 0)
753 (count 0))
755 (setq count (1+ count)
756 pos (match-end 0)))
757 (and (= (mod count 2) 1)
758 (setq complete-list (list (concat str "'"))))))
759 ;; Let comint handle the rest.
760 (comint-dynamic-simple-complete command-word complete-list)))
762 ;; The completion process filter is installed temporarily to slurp the
763 ;; output of GDB up to the next prompt and build the completion list.
764 (defun gud-gdb-fetch-lines-filter (string filter)
765 "Filter used to read the list of lines output by a command.
766 STRING is the output to filter.
767 It is passed through FILTER before we look at it."
768 (setq string (funcall filter string))
769 (setq string (concat gud-gdb-fetch-lines-string string))
771 (push (substring string gud-gdb-fetch-lines-break (match-beginning 0))
772 gud-gdb-fetched-lines)
773 (setq string (substring string (match-end 0))))
774 (if (string-match comint-prompt-regexp string)
775 (progn
776 (setq gud-gdb-fetch-lines-in-progress nil)
777 string)
778 (progn
779 (setq gud-gdb-fetch-lines-string string)
780 "")))
782 ;; gdb speedbar functions
784 (defun gud-gdb-goto-stackframe (text token indent)
785 "Goto the stackframe described by TEXT, TOKEN, and INDENT."
786 (speedbar-with-attached-buffer
787 (gud-basic-call (concat "server frame " (nth 1 token)))
788 (sit-for 1)))
790 (defvar gud-gdb-fetched-stack-frame nil
791 "Stack frames we are fetching from GDB.")
793 ;(defun gud-gdb-get-scope-data (text token indent)
794 ; ;; checkdoc-params: (indent)
795 ; "Fetch data associated with a stack frame, and expand/contract it.
796 ;Data to do this is retrieved from TEXT and TOKEN."
797 ; (let ((args nil) (scope nil))
798 ; (gud-gdb-run-command-fetch-lines "info args")
799 ;
800 ; (gud-gdb-run-command-fetch-lines "info local")
801 ;
802 ; ))
804 (defun gud-gdb-get-stackframe (buffer)
805 "Extract the current stack frame out of the GUD GDB BUFFER."
806 (let ((newlst nil)
807 (fetched-stack-frame-list
808 (gud-gdb-run-command-fetch-lines "server backtrace" buffer)))
809 (if (and (car fetched-stack-frame-list)
810 (string-match "No stack" (car fetched-stack-frame-list)))
811 ;; Go into some other mode???
812 nil
813 (dolist (e fetched-stack-frame-list)
814 (let ((name nil) (num nil))
815 (if (not (or
818 (if (not (string-match
820 nil
821 (setcar newlst
822 (list (nth 0 (car newlst))
823 (nth 1 (car newlst))
824 (match-string 1 e)
825 (match-string 2 e))))
826 (setq num (match-string 1 e)
827 name (match-string 2 e))
828 (setq newlst
829 (cons
830 (if (string-match
832 (list name num (match-string 1 e)
833 (match-string 2 e))
834 (list name num))
835 newlst)))))
836 (nreverse newlst))))
838 ;(defun gud-gdb-selected-frame-info (buffer)
839 ; "Learn GDB information for the currently selected stack frame in BUFFER."
840 ; )
842 (defun gud-gdb-run-command-fetch-lines (command buffer &optional skip)
843 "Run COMMAND, and return the list of lines it outputs.
844 BUFFER is the GUD buffer in which to run the command.
845 SKIP is the number of chars to skip on each lines, it defaults to 0."
846 (with-current-buffer buffer
847 (if (save-excursion
848 (goto-char (point-max))
849 (forward-line 0)
850 (not (looking-at comint-prompt-regexp)))
851 nil
852 ;; Much of this copied from GDB complete, but I'm grabbing the stack
853 ;; frame instead.
854 (let ((gud-gdb-fetch-lines-in-progress t)
855 (gud-gdb-fetched-lines nil)
856 (gud-gdb-fetch-lines-string nil)
857 (gud-gdb-fetch-lines-break (or skip 0))
858 (gud-marker-filter
859 `(lambda (string) (gud-gdb-fetch-lines-filter string ',gud-marker-filter))))
860 ;; Issue the command to GDB.
861 (gud-basic-call command)
862 ;; Slurp the output.
863 (while gud-gdb-fetch-lines-in-progress
864 (accept-process-output (get-buffer-process buffer)))
865 (nreverse gud-gdb-fetched-lines)))))
867 \f
868 ;; ======================================================================
869 ;; sdb functions
871 ;; History of argument lists passed to sdb.
872 (defvar gud-sdb-history nil)
874 (defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
875 "If nil, we're on a System V Release 4 and don't need the tags hack.")
877 (defvar gud-sdb-lastfile nil)
879 (defun gud-sdb-marker-filter (string)
880 (setq gud-marker-acc
881 (if gud-marker-acc (concat gud-marker-acc string) string))
882 (let (start)
883 ;; Process all complete markers in this chunk
884 (while
885 (cond
886 ;; System V Release 3.2 uses this format
888 gud-marker-acc start)
889 (setq gud-last-frame
890 (cons (match-string 3 gud-marker-acc)
891 (string-to-number (match-string 4 gud-marker-acc)))))
892 ;; System V Release 4.0 quite often clumps two lines together
893 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
894 gud-marker-acc start)
895 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc))
896 (setq gud-last-frame
897 (cons gud-sdb-lastfile
898 (string-to-number (match-string 3 gud-marker-acc)))))
899 ;; System V Release 4.0
901 gud-marker-acc start)
902 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc)))
904 gud-marker-acc start))
905 (setq gud-last-frame
906 (cons gud-sdb-lastfile
907 (string-to-number (match-string 1 gud-marker-acc)))))
908 (t
909 (setq gud-sdb-lastfile nil)))
910 (setq start (match-end 0)))
912 ;; Search for the last incomplete line in this chunk
914 (setq start (match-end 0)))
916 ;; If we have an incomplete line, store it in gud-marker-acc.
917 (setq gud-marker-acc (substring gud-marker-acc (or start 0))))
918 string)
920 (defun gud-sdb-find-file (f)
921 (if gud-sdb-needs-tags (find-tag-noselect f) (find-file-noselect f)))
923 ;;;###autoload
924 (defun sdb (command-line)
925 "Run sdb on program FILE in buffer *gud-FILE*.
926 The directory containing FILE becomes the initial working directory
927 and source-file directory for your debugger."
928 (interactive (list (gud-query-cmdline 'sdb)))
930 (if gud-sdb-needs-tags (require 'etags))
931 (if (and gud-sdb-needs-tags
932 (not (and (boundp 'tags-file-name)
933 (stringp tags-file-name)
934 (file-exists-p tags-file-name))))
935 (error "The sdb support requires a valid tags table to work"))
937 (gud-common-init command-line nil 'gud-sdb-marker-filter 'gud-sdb-find-file)
938 (set (make-local-variable 'gud-minor-mode) 'sdb)
940 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
941 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
942 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
943 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
944 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
945 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
946 (gud-def gud-cont "c" "\C-r" "Continue with display.")
947 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
950 (setq paragraph-start comint-prompt-regexp)
951 (run-hooks 'sdb-mode-hook)
952 )
953 \f
954 ;; ======================================================================
955 ;; dbx functions
957 ;; History of argument lists passed to dbx.
958 (defvar gud-dbx-history nil)
960 (defcustom gud-dbx-directories nil
961 "*A list of directories that dbx should search for source code.
962 If nil, only source files in the program directory
963 will be known to dbx.
965 The file names should be absolute, or relative to the directory
966 containing the executable being debugged."
967 :type '(choice (const :tag "Current Directory" nil)
968 (repeat :value ("")
969 directory))
970 :group 'gud)
972 (defun gud-dbx-massage-args (file args)
973 (nconc (let ((directories gud-dbx-directories)
974 (result nil))
975 (while directories
976 (setq result (cons (car directories) (cons "-I" result)))
977 (setq directories (cdr directories)))
978 (nreverse result))
979 args))
981 (defun gud-dbx-marker-filter (string)
982 (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
984 (let (start)
985 ;; Process all complete markers in this chunk.
986 (while (or (string-match
988 gud-marker-acc start)
989 (string-match
991 gud-marker-acc start))
992 (setq gud-last-frame
993 (cons (match-string 2 gud-marker-acc)
994 (string-to-number (match-string 1 gud-marker-acc)))
995 start (match-end 0)))
997 ;; Search for the last incomplete line in this chunk
999 (setq start (match-end 0)))
1001 ;; If the incomplete line APPEARS to begin with another marker, keep it
1002 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1003 ;; unnecessary concat during the next call.
1004 (setq gud-marker-acc
1006 (substring gud-marker-acc (match-beginning 0))
1007 nil)))
1008 string)
1010 ;; Functions for Mips-style dbx. Given the option `-emacs', documented in
1011 ;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
1012 (defvar gud-mips-p
1013 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
1014 ;; We haven't tested gud on this system:
1015 (string-match "^mips-[^-]*-riscos" system-configuration)
1016 ;; It's documented on OSF/1.3
1017 (string-match "^mips-[^-]*-osf1" system-configuration)
1018 (string-match "^alpha[^-]*-[^-]*-osf" system-configuration))
1019 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
1021 (defvar gud-dbx-command-name
1022 (concat "dbx" (if gud-mips-p " -emacs")))
1024 ;; This is just like the gdb one except for the regexps since we need to cope
1025 ;; with an optional breakpoint number in [] before the ^Z^Z
1026 (defun gud-mipsdbx-marker-filter (string)
1027 (setq gud-marker-acc (concat gud-marker-acc string))
1028 (let ((output ""))
1030 ;; Process all the complete markers in this chunk.
1031 (while (string-match
1032 ;; This is like th gdb marker but with an optional
1033 ;; leading break point number like `[1] '
1035 gud-marker-acc)
1036 (setq
1038 ;; Extract the frame position from the marker.
1039 gud-last-frame
1040 (cons (match-string 1 gud-marker-acc)
1041 (string-to-number (match-string 2 gud-marker-acc)))
1043 ;; Append any text before the marker to the output we're going
1044 ;; to return - we don't include the marker in this text.
1045 output (concat output
1046 (substring gud-marker-acc 0 (match-beginning 0)))
1048 ;; Set the accumulator to the remaining text.
1049 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1051 ;; Does the remaining text look like it might end with the
1052 ;; beginning of another marker? If it does, then keep it in
1053 ;; gud-marker-acc until we receive the rest of it. Since we
1054 ;; know the full marker regexp above failed, it's pretty simple to
1055 ;; test for marker starts.
1057 (progn
1058 ;; Everything before the potential marker start can be output.
1059 (setq output (concat output (substring gud-marker-acc
1060 0 (match-beginning 0))))
1062 ;; Everything after, we save, to combine with later input.
1063 (setq gud-marker-acc
1064 (substring gud-marker-acc (match-beginning 0))))
1066 (setq output (concat output gud-marker-acc)
1067 gud-marker-acc ""))
1069 output))
1071 ;; The dbx in IRIX is a pain. It doesn't print the file name when
1072 ;; stopping at a breakpoint (but you do get it from the `up' and
1073 ;; `down' commands...). The only way to extract the information seems
1074 ;; to be with a `file' command, although the current line number is
1075 ;; available in $curline. Thus we have to look for output which
1076 ;; appears to indicate a breakpoint. Then we prod the dbx sub-process
1077 ;; to output the information we want with a combination of the
1078 ;; `printf' and `file' commands as a pseudo marker which we can
1079 ;; recognise next time through the marker-filter. This would be like
1080 ;; the gdb marker but you can't get the file name without a newline...
1081 ;; Note that gud-remove won't work since Irix dbx expects a breakpoint
1082 ;; number rather than a line number etc. Maybe this could be made to
1083 ;; work by listing all the breakpoints and picking the one(s) with the
1084 ;; correct line number, but life's too short.
1085 ;; d.love@dl.ac.uk (Dave Love) can be blamed for this
1087 (defvar gud-irix-p
1088 (and (string-match "^mips-[^-]*-irix" system-configuration)
1090 "Non-nil to assume the interface appropriate for IRIX dbx.
1091 This works in IRIX 4, 5 and 6, but `gud-dbx-use-stopformat-p' provides
1092 a better solution in 6.1 upwards.")
1093 (defvar gud-dbx-use-stopformat-p
1095 "Non-nil to use the dbx feature present at least from Irix 6.1
1096 whereby $stopformat=1 produces an output format compatiable with
1097 `gud-dbx-marker-filter'.")
1098 ;; [Irix dbx seems to be a moving target. The dbx output changed
1099 ;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
1100 ;; the output from `up' is no longer spotted by gud (and it's probably
1101 ;; not distinctive enough to try to match it -- use C-<, C->
1102 ;; exclusively) . For 5.3 and 6.0, the $curline variable changed to
1103 ;; `long long'(why?!), so the printf stuff needed changing. The line
1104 ;; number was cast to `long' as a compromise between the new `long
1105 ;; long' and the original `int'. This is reported not to work in 6.2,
1106 ;; so it's changed back to int -- don't make your sources too long.
1107 ;; From Irix6.1 (but not 6.0?) dbx supports an undocumented feature
1108 ;; whereby `set $stopformat=1' reportedly produces output compatible
1109 ;; with `gud-dbx-marker-filter', which we prefer.
1111 ;; The process filter is also somewhat
1112 ;; unreliable, sometimes not spotting the markers; I don't know
1113 ;; whether there's anything that can be done about that. It would be
1114 ;; much better if SGI could be persuaded to (re?)instate the MIPS
1115 ;; -emacs flag for gdb-like output (which ought to be possible as most
1116 ;; of the communication I've had over it has been from sgi.com).]
1118 ;; this filter is influenced by the xdb one rather than the gdb one
1119 (defun gud-irixdbx-marker-filter (string)
1120 (let (result (case-fold-search nil))
1121 (if (or (string-match comint-prompt-regexp string)
1123 (setq result (concat gud-marker-acc string)
1124 gud-marker-acc "")
1125 (setq gud-marker-acc (concat gud-marker-acc string)))
1126 (if result
1127 (cond
1128 ;; look for breakpoint or signal indication e.g.:
1129 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
1130 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
1131 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
1132 ((string-match
1134 result)
1135 ;; prod dbx into printing out the line number and file
1136 ;; name in a form we can grok as below
1137 (process-send-string (get-buffer-process gud-comint-buffer)
1139 ;; look for result of, say, "up" e.g.:
1140 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
1141 ;; (this will also catch one of the lines printed by "where")
1142 ((string-match
1144 result)
1145 (let ((file (match-string 1 result)))
1146 (if (file-exists-p file)
1147 (setq gud-last-frame
1148 (cons (match-string 1 result)
1149 (string-to-number (match-string 2 result))))))
1150 result)
1151 ((string-match ; kluged-up marker as above
1153 (let ((file (gud-file-name (match-string 2 result))))
1154 (if (and file (file-exists-p file))
1155 (setq gud-last-frame
1156 (cons file
1157 (string-to-number (match-string 1 result))))))
1158 (setq result (substring result 0 (match-beginning 0))))))
1159 (or result "")))
1161 (defvar gud-dgux-p (string-match "-dgux" system-configuration)
1162 "Non-nil means to assume the interface approriate for DG/UX dbx.
1163 This was tested using R4.11.")
1165 ;; There are a couple of differences between DG's dbx output and normal
1166 ;; dbx output which make it nontrivial to integrate this into the
1167 ;; standard dbx-marker-filter (mainly, there are a different number of
1168 ;; backreferences). The markers look like:
1169 ;;
1170 ;; (0) Stopped at line 10, routine main(argc=1, argv=0xeffff0e0), file t.c
1171 ;;
1172 ;; from breakpoints (the `(0)' there isn't constant, it's the breakpoint
1173 ;; number), and
1174 ;;
1175 ;; Stopped at line 13, routine main(argc=1, argv=0xeffff0e0), file t.c
1176 ;;
1177 ;; from signals and
1178 ;;
1179 ;; Frame 21, line 974, routine command_loop(), file keyboard.c
1180 ;;
1181 ;; from up/down/where.
1183 (defun gud-dguxdbx-marker-filter (string)
1184 (setq gud-marker-acc (if gud-marker-acc
1185 (concat gud-marker-acc string)
1186 string))
1189 start)
1190 ;; Process all complete markers in this chunk.
1191 (while (string-match re gud-marker-acc start)
1192 (setq gud-last-frame
1193 (cons (match-string 4 gud-marker-acc)
1194 (string-to-number (match-string 3 gud-marker-acc)))
1195 start (match-end 0)))
1197 ;; Search for the last incomplete line in this chunk
1199 (setq start (match-end 0)))
1201 ;; If the incomplete line APPEARS to begin with another marker, keep it
1202 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1203 ;; unnecessary concat during the next call.
1204 (setq gud-marker-acc
1206 (substring gud-marker-acc (match-beginning 0))
1207 nil)))
1208 string)
1210 ;;;###autoload
1211 (defun dbx (command-line)
1212 "Run dbx on program FILE in buffer *gud-FILE*.
1213 The directory containing FILE becomes the initial working directory
1214 and source-file directory for your debugger."
1215 (interactive (list (gud-query-cmdline 'dbx)))
1217 (cond
1218 (gud-mips-p
1219 (gud-common-init command-line nil 'gud-mipsdbx-marker-filter))
1220 (gud-irix-p
1221 (gud-common-init command-line 'gud-dbx-massage-args
1222 'gud-irixdbx-marker-filter))
1223 (gud-dgux-p
1224 (gud-common-init command-line 'gud-dbx-massage-args
1225 'gud-dguxdbx-marker-filter))
1226 (t
1227 (gud-common-init command-line 'gud-dbx-massage-args
1228 'gud-dbx-marker-filter)))
1230 (set (make-local-variable 'gud-minor-mode) 'dbx)
1232 (cond
1233 (gud-mips-p
1234 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1235 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1237 "\C-b" "Set breakpoint at current line.")
1238 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
1239 (gud-irix-p
1241 "\C-b" "Set breakpoint at current line.")
1242 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1244 "<" "Up (numeric arg) stack frames.")
1246 ">" "Down (numeric arg) stack frames.")
1247 ;; Make dbx give out the source location info that we need.
1248 (process-send-string (get-buffer-process gud-comint-buffer)
1250 (t
1251 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1252 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1254 "\C-b" "Set breakpoint at current line.")
1255 (if gud-dbx-use-stopformat-p
1256 (process-send-string (get-buffer-process gud-comint-buffer)
1259 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
1260 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
1261 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
1262 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
1263 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
1264 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
1265 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
1266 (gud-def gud-run "run" nil "Run the program.")
1269 (setq paragraph-start comint-prompt-regexp)
1270 (run-hooks 'dbx-mode-hook)
1271 )
1272 \f
1273 ;; ======================================================================
1274 ;; xdb (HP PARISC debugger) functions
1276 ;; History of argument lists passed to xdb.
1277 (defvar gud-xdb-history nil)
1279 (defcustom gud-xdb-directories nil
1280 "*A list of directories that xdb should search for source code.
1281 If nil, only source files in the program directory
1282 will be known to xdb.
1284 The file names should be absolute, or relative to the directory
1285 containing the executable being debugged."
1286 :type '(choice (const :tag "Current Directory" nil)
1287 (repeat :value ("")
1288 directory))
1289 :group 'gud)
1291 (defun gud-xdb-massage-args (file args)
1292 (nconc (let ((directories gud-xdb-directories)
1293 (result nil))
1294 (while directories
1295 (setq result (cons (car directories) (cons "-d" result)))
1296 (setq directories (cdr directories)))
1297 (nreverse result))
1298 args))
1300 ;; xdb does not print the lines all at once, so we have to accumulate them
1301 (defun gud-xdb-marker-filter (string)
1302 (let (result)
1303 (if (or (string-match comint-prompt-regexp string)
1305 (setq result (concat gud-marker-acc string)
1306 gud-marker-acc "")
1307 (setq gud-marker-acc (concat gud-marker-acc string)))
1308 (if result
1310 result)
1312 result))
1313 (let ((line (string-to-number (match-string 2 result)))
1314 (file (gud-file-name (match-string 1 result))))
1315 (if file
1316 (setq gud-last-frame (cons file line))))))
1317 (or result "")))
1319 ;;;###autoload
1320 (defun xdb (command-line)
1321 "Run xdb on program FILE in buffer *gud-FILE*.
1322 The directory containing FILE becomes the initial working directory
1323 and source-file directory for your debugger.
1325 You can set the variable `gud-xdb-directories' to a list of program source
1326 directories if your program contains sources from more than one directory."
1327 (interactive (list (gud-query-cmdline 'xdb)))
1329 (gud-common-init command-line 'gud-xdb-massage-args
1330 'gud-xdb-marker-filter)
1331 (set (make-local-variable 'gud-minor-mode) 'xdb)
1333 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
1335 "Set temporary breakpoint at current line.")
1336 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
1337 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
1338 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1339 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1340 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1341 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1343 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
1345 (setq comint-prompt-regexp "^>")
1346 (setq paragraph-start comint-prompt-regexp)
1347 (run-hooks 'xdb-mode-hook))
1348 \f
1349 ;; ======================================================================
1350 ;; perldb functions
1352 ;; History of argument lists passed to perldb.
1353 (defvar gud-perldb-history nil)
1355 (defun gud-perldb-massage-args (file args)
1356 "Convert a command line as would be typed normally to run perldb
1357 into one that invokes an Emacs-enabled debugging session.
1359 ;; FIXME: what if the command is `make perldb' and doesn't accept those extra
1360 ;; arguments ?
1361 (let* ((new-args nil)
1362 (seen-e nil)
1363 (shift (lambda () (push (pop args) new-args))))
1365 ;; Pass all switches and -e scripts through.
1366 (while (and args
1367 (string-match "^-" (car args))
1368 (not (equal "-" (car args)))
1369 (not (equal "--" (car args))))
1370 (when (equal "-e" (car args))
1371 ;; -e goes with the next arg, so shift one extra.
1372 (or (funcall shift)
1373 ;; -e as the last arg is an error in Perl.
1374 (error "No code specified for -e"))
1375 (setq seen-e t))
1376 (funcall shift))
1378 (unless seen-e
1379 (if (or (not args)
1380 (string-match "^-" (car args)))
1381 (error "Can't use stdin as the script to debug"))
1382 ;; This is the program name.
1383 (funcall shift))
1385 ;; If -e specified, make sure there is a -- so -emacs is not taken
1386 ;; as -e macs.
1387 (if (and args (equal "--" (car args)))
1388 (funcall shift)
1389 (and seen-e (push "--" new-args)))
1391 (push "-emacs" new-args)
1392 (while args
1393 (funcall shift))
1395 (nreverse new-args)))
1397 ;; There's no guarantee that Emacs will hand the filter the entire
1398 ;; marker at once; it could be broken up across several strings. We
1399 ;; might even receive a big chunk with several markers in it. If we
1400 ;; receive a chunk of text which looks like it might contain the
1401 ;; beginning of a marker, we save it here between calls to the
1402 ;; filter.
1403 (defun gud-perldb-marker-filter (string)
1404 (setq gud-marker-acc (concat gud-marker-acc string))
1405 (let ((output ""))
1407 ;; Process all the complete markers in this chunk.
1409 gud-marker-acc)
1410 (setq
1412 ;; Extract the frame position from the marker.
1413 gud-last-frame
1414 (cons (match-string 1 gud-marker-acc)
1415 (string-to-number (match-string 3 gud-marker-acc)))
1417 ;; Append any text before the marker to the output we're going
1418 ;; to return - we don't include the marker in this text.
1419 output (concat output
1420 (substring gud-marker-acc 0 (match-beginning 0)))
1422 ;; Set the accumulator to the remaining text.
1423 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1425 ;; Does the remaining text look like it might end with the
1426 ;; beginning of another marker? If it does, then keep it in
1427 ;; gud-marker-acc until we receive the rest of it. Since we
1428 ;; know the full marker regexp above failed, it's pretty simple to
1429 ;; test for marker starts.
1431 (progn
1432 ;; Everything before the potential marker start can be output.
1433 (setq output (concat output (substring gud-marker-acc
1434 0 (match-beginning 0))))
1436 ;; Everything after, we save, to combine with later input.
1437 (setq gud-marker-acc
1438 (substring gud-marker-acc (match-beginning 0))))
1440 (setq output (concat output gud-marker-acc)
1441 gud-marker-acc ""))
1443 output))
1445 (defcustom gud-perldb-command-name "perl -d"
1446 "Default command to execute a Perl script under debugger."
1447 :type 'string
1448 :group 'gud)
1450 ;;;###autoload
1451 (defun perldb (command-line)
1452 "Run perldb on program FILE in buffer *gud-FILE*.
1453 The directory containing FILE becomes the initial working directory
1454 and source-file directory for your debugger."
1455 (interactive
1456 (list (gud-query-cmdline 'perldb
1457 (concat (or (buffer-file-name) "-e 0") " "))))
1459 (gud-common-init command-line 'gud-perldb-massage-args
1460 'gud-perldb-marker-filter)
1461 (set (make-local-variable 'gud-minor-mode) 'perldb)
1463 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
1464 (gud-def gud-remove "B %l" "\C-d" "Remove breakpoint at current line")
1465 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
1466 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
1467 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1468 ; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
1469 ; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
1470 ; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
1471 (gud-def gud-print "p %e" "\C-p" "Evaluate perl expression at point.")
1472 (gud-def gud-until "c %l" "\C-u" "Continue to current line.")
1475 (setq comint-prompt-regexp "^ DB<+[0-9]+>+ ")
1476 (setq paragraph-start comint-prompt-regexp)
1477 (run-hooks 'perldb-mode-hook))
1478 \f
1479 ;; ======================================================================
1480 ;; pdb (Python debugger) functions
1482 ;; History of argument lists passed to pdb.
1483 (defvar gud-pdb-history nil)
1485 ;; Last group is for return value, e.g. "> test.py(2)foo()->None"
1486 ;; Either file or function name may be omitted: "> <string>(0)?()"
1487 (defvar gud-pdb-marker-regexp
1488 "^> \\([-a-zA-Z0-9_/.:\\]*\\|<string>\\)(\\([0-9]+\\))\\([a-zA-Z0-9_]*\\|\\?\\)()\\(->[^\n]*\\)?\n")
1489 (defvar gud-pdb-marker-regexp-file-group 1)
1490 (defvar gud-pdb-marker-regexp-line-group 2)
1491 (defvar gud-pdb-marker-regexp-fnname-group 3)
1493 (defvar gud-pdb-marker-regexp-start "^> ")
1495 ;; There's no guarantee that Emacs will hand the filter the entire
1496 ;; marker at once; it could be broken up across several strings. We
1497 ;; might even receive a big chunk with several markers in it. If we
1498 ;; receive a chunk of text which looks like it might contain the
1499 ;; beginning of a marker, we save it here between calls to the
1500 ;; filter.
1501 (defun gud-pdb-marker-filter (string)
1502 (setq gud-marker-acc (concat gud-marker-acc string))
1503 (let ((output ""))
1505 ;; Process all the complete markers in this chunk.
1506 (while (string-match gud-pdb-marker-regexp gud-marker-acc)
1507 (setq
1509 ;; Extract the frame position from the marker.
1510 gud-last-frame
1511 (let ((file (match-string gud-pdb-marker-regexp-file-group
1512 gud-marker-acc))
1513 (line (string-to-number
1514 (match-string gud-pdb-marker-regexp-line-group
1515 gud-marker-acc))))
1516 (if (string-equal file "<string>")
1517 gud-last-frame
1518 (cons file line)))
1520 ;; Output everything instead of the below
1521 output (concat output (substring gud-marker-acc 0 (match-end 0)))
1522 ;; ;; Append any text before the marker to the output we're going
1523 ;; ;; to return - we don't include the marker in this text.
1524 ;; output (concat output
1525 ;; (substring gud-marker-acc 0 (match-beginning 0)))
1527 ;; Set the accumulator to the remaining text.
1528 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1530 ;; Does the remaining text look like it might end with the
1531 ;; beginning of another marker? If it does, then keep it in
1532 ;; gud-marker-acc until we receive the rest of it. Since we
1533 ;; know the full marker regexp above failed, it's pretty simple to
1534 ;; test for marker starts.
1535 (if (string-match gud-pdb-marker-regexp-start gud-marker-acc)
1536 (progn
1537 ;; Everything before the potential marker start can be output.
1538 (setq output (concat output (substring gud-marker-acc
1539 0 (match-beginning 0))))
1541 ;; Everything after, we save, to combine with later input.
1542 (setq gud-marker-acc
1543 (substring gud-marker-acc (match-beginning 0))))
1545 (setq output (concat output gud-marker-acc)
1546 gud-marker-acc ""))
1548 output))
1550 (defcustom gud-pdb-command-name "pdb"
1551 "File name for executing the Python debugger.
1552 This should be an executable on your path, or an absolute file name."
1553 :type 'string
1554 :group 'gud)
1556 ;;;###autoload
1557 (defun pdb (command-line)
1558 "Run pdb on program FILE in buffer `*gud-FILE*'.
1559 The directory containing FILE becomes the initial working directory
1560 and source-file directory for your debugger."
1561 (interactive
1562 (list (gud-query-cmdline 'pdb)))
1564 (gud-common-init command-line nil 'gud-pdb-marker-filter)
1565 (set (make-local-variable 'gud-minor-mode) 'pdb)
1567 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
1568 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
1569 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
1570 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
1571 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
1572 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1573 (gud-def gud-up "up" "<" "Up one stack frame.")
1574 (gud-def gud-down "down" ">" "Down one stack frame.")
1575 (gud-def gud-print "p %e" "\C-p" "Evaluate Python expression at point.")
1576 ;; Is this right?
1577 (gud-def gud-statement "! %e" "\C-e" "Execute Python statement at point.")
1579 ;; (setq comint-prompt-regexp "^(.*pdb[+]?) *")
1580 (setq comint-prompt-regexp "^(Pdb) *")
1581 (setq paragraph-start comint-prompt-regexp)
1582 (run-hooks 'pdb-mode-hook))
1583 \f
1584 ;; ======================================================================
1585 ;;
1586 ;; JDB support.
1587 ;;
1588 ;; AUTHOR: Derek Davies <ddavies@world.std.com>
1589 ;; Zoltan Kemenczy <zoltan@ieee.org;zkemenczy@rim.net>
1590 ;;
1591 ;; CREATED: Sun Feb 22 10:46:38 1998 Derek Davies.
1592 ;; UPDATED: Nov 11, 2001 Zoltan Kemenczy
1593 ;; Dec 10, 2002 Zoltan Kemenczy - added nested class support
1594 ;;
1595 ;; INVOCATION NOTES:
1596 ;;
1597 ;; You invoke jdb-mode with:
1598 ;;
1599 ;; M-x jdb <enter>
1600 ;;
1601 ;; It responds with:
1602 ;;
1603 ;; Run jdb (like this): jdb
1604 ;;
1605 ;; type any jdb switches followed by the name of the class you'd like to debug.
1606 ;; Supply a fully qualfied classname (these do not have the ".class" extension)
1607 ;; for the name of the class to debug (e.g. "COM.the-kind.ddavies.CoolClass").
1608 ;; See the known problems section below for restrictions when specifying jdb
1609 ;; command line switches (search forward for '-classpath').
1610 ;;
1611 ;; You should see something like the following:
1612 ;;
1613 ;; Current directory is ~/src/java/hello/
1614 ;; Initializing jdb...
1615 ;; 0xed2f6628:class(hello)
1616 ;; >
1617 ;;
1618 ;; To set an initial breakpoint try:
1619 ;;
1620 ;; > stop in hello.main
1621 ;; Breakpoint set in hello.main
1622 ;; >
1623 ;;
1624 ;; To execute the program type:
1625 ;;
1626 ;; > run
1627 ;; run hello
1628 ;;
1629 ;; Breakpoint hit: running ...
1630 ;; hello.main (hello:12)
1631 ;;
1632 ;; Type M-n to step over the current line and M-s to step into it. That,
1633 ;; along with the JDB 'help' command should get you started. The 'quit'
1634 ;; JDB command will get out out of the debugger. There is some truly
1635 ;; pathetic JDB documentation available at:
1636 ;;
1637 ;; http://java.sun.com/products/jdk/1.1/debugging/
1638 ;;
1639 ;; KNOWN PROBLEMS AND FIXME's:
1640 ;;
1641 ;; Not sure what happens with inner classes ... haven't tried them.
1642 ;;
1643 ;; Does not grok UNICODE id's. Only ASCII id's are supported.
1644 ;;
1645 ;; You must not put whitespace between "-classpath" and the path to
1646 ;; search for java classes even though it is required when invoking jdb
1647 ;; from the command line. See gud-jdb-massage-args for details.
1648 ;; The same applies for "-sourcepath".
1649 ;;
1650 ;; Note: The following applies only if `gud-jdb-use-classpath' is nil;
1651 ;; refer to the documentation of `gud-jdb-use-classpath' and
1652 ;; `gud-jdb-classpath',`gud-jdb-sourcepath' variables for information
1653 ;; on using the classpath for locating java source files.
1654 ;;
1655 ;; If any of the source files in the directories listed in
1656 ;; gud-jdb-directories won't parse you'll have problems. Make sure
1657 ;; every file ending in ".java" in these directories parses without error.
1658 ;;
1659 ;; All the .java files in the directories in gud-jdb-directories are
1660 ;; syntactically analyzed each time gud jdb is invoked. It would be
1661 ;; nice to keep as much information as possible between runs. It would
1662 ;; be really nice to analyze the files only as neccessary (when the
1663 ;; source needs to be displayed.) I'm not sure to what extent the former
1664 ;; can be accomplished and I'm not sure the latter can be done at all
1665 ;; since I don't know of any general way to tell which .class files are
1666 ;; defined by which .java file without analyzing all the .java files.
1667 ;; If anyone knows why JavaSoft didn't put the source file names in
1668 ;; debuggable .class files please clue me in so I find something else
1669 ;; to be spiteful and bitter about.
1670 ;;
1671 ;; ======================================================================
1672 ;; gud jdb variables and functions
1674 (defcustom gud-jdb-command-name "jdb"
1675 "Command that executes the Java debugger."
1676 :type 'string
1677 :group 'gud)
1679 (defcustom gud-jdb-use-classpath t
1680 "If non-nil, search for Java source files in classpath directories.
1681 The list of directories to search is the value of `gud-jdb-classpath'.
1682 The file pathname is obtained by converting the fully qualified
1683 class information output by jdb to a relative pathname and appending
1684 it to `gud-jdb-classpath' element by element until a match is found.
1686 This method has a significant jdb startup time reduction advantage
1687 since it does not require the scanning of all `gud-jdb-directories'
1688 and parsing all Java files for class information.
1690 Set to nil to use `gud-jdb-directories' to scan java sources for
1691 class information on jdb startup (original method)."
1692 :type 'boolean
1693 :group 'gud)
1695 (defvar gud-jdb-classpath nil
1696 "Java/jdb classpath directories list.
1697 If `gud-jdb-use-classpath' is non-nil, gud-jdb derives the `gud-jdb-classpath'
1698 list automatically using the following methods in sequence
1699 \(with subsequent successful steps overriding the results of previous
1700 steps):
1702 1) Read the CLASSPATH environment variable,
1704 or detected in jdb output (e.g. if jdb is run by a script
1705 that echoes the actual jdb command before starting jdb)
1708 an already running VM) argument (This case typically does not
1710 to the VM when it is started).
1712 Note that method 3 cannot be used with oldjdb (or Java 1 jdb) since
1713 those debuggers do not support the classpath command. Use 1) or 2).")
1715 (defvar gud-jdb-sourcepath nil
1717 This list is prepended to `gud-jdb-classpath' to form the complete
1718 list of directories searched for source files.")
1720 (defvar gud-marker-acc-max-length 4000
1721 "Maximum number of debugger output characters to keep.
1722 This variable limits the size of `gud-marker-acc' which holds
1723 the most recent debugger output history while searching for
1724 source file information.")
1726 (defvar gud-jdb-history nil
1727 "History of argument lists passed to jdb.")
1730 ;; List of Java source file directories.
1731 (defvar gud-jdb-directories (list ".")
1732 "*A list of directories that gud jdb should search for source code.
1733 The file names should be absolute, or relative to the current
1734 directory.
1736 The set of .java files residing in the directories listed are
1737 syntactically analyzed to determine the classes they define and the
1738 packages in which these classes belong. In this way gud jdb maps the
1739 package-qualified class names output by the jdb debugger to the source
1740 file from which the class originated. This allows gud mode to keep
1741 the source code display in sync with the debugging session.")
1743 (defvar gud-jdb-source-files nil
1744 "List of the java source files for this debugging session.")
1746 ;; Association list of fully qualified class names (package + class name)
1747 ;; and their source files.
1748 (defvar gud-jdb-class-source-alist nil
1749 "Association list of fully qualified class names and source files.")
1751 ;; This is used to hold a source file during analysis.
1752 (defvar gud-jdb-analysis-buffer nil)
1754 (defvar gud-jdb-classpath-string nil
1755 "Holds temporary classpath values.")
1757 (defun gud-jdb-build-source-files-list (path extn)
1758 "Return a list of java source files (absolute paths).
1759 PATH gives the directories in which to search for files with
1760 extension EXTN. Normally EXTN is given as the regular expression
1762 (apply 'nconc (mapcar (lambda (d)
1763 (when (file-directory-p d)
1764 (directory-files d t extn nil)))
1765 path)))
1767 ;; Move point past whitespace.
1768 (defun gud-jdb-skip-whitespace ()
1771 ;; Move point past a "// <eol>" type of comment.
1772 (defun gud-jdb-skip-single-line-comment ()
1773 (end-of-line))
1775 ;; Move point past a "/* */" or "/** */" type of comment.
1776 (defun gud-jdb-skip-traditional-or-documentation-comment ()
1777 (forward-char 2)
1778 (catch 'break
1779 (while (not (eobp))
1780 (if (eq (following-char) ?*)
1781 (progn
1782 (forward-char)
1783 (if (not (eobp))
1784 (if (eq (following-char) ?/)
1785 (progn
1786 (forward-char)
1787 (throw 'break nil)))))
1788 (forward-char)))))
1790 ;; Move point past any number of consecutive whitespace chars and/or comments.
1791 (defun gud-jdb-skip-whitespace-and-comments ()
1792 (gud-jdb-skip-whitespace)
1793 (catch 'done
1794 (while t
1795 (cond
1796 ((looking-at "//")
1797 (gud-jdb-skip-single-line-comment)
1798 (gud-jdb-skip-whitespace))
1800 (gud-jdb-skip-traditional-or-documentation-comment)
1801 (gud-jdb-skip-whitespace))
1802 (t (throw 'done nil))))))
1804 ;; Move point past things that are id-like. The intent is to skip regular
1805 ;; id's, such as class or interface names as well as package and interface
1806 ;; names.
1807 (defun gud-jdb-skip-id-ish-thing ()
1810 ;; Move point past a string literal.
1811 (defun gud-jdb-skip-string-literal ()
1812 (forward-char)
1813 (while (not (cond
1815 (forward-char))
1817 (forward-char))
1818 (forward-char))
1820 ;; Move point past a character literal.
1821 (defun gud-jdb-skip-character-literal ()
1822 (forward-char)
1823 (while
1824 (progn
1826 (forward-char 2))
1828 (forward-char))
1829 (forward-char))
1831 ;; Move point past the following block. There may be (legal) cruft before
1832 ;; the block's opening brace. There must be a block or it's the end of life
1833 ;; in petticoat junction.
1834 (defun gud-jdb-skip-block ()
1836 ;; Find the begining of the block.
1837 (while
1838 (not (eq (following-char) ?{))
1840 ;; Skip any constructs that can harbor literal block delimiter
1841 ;; characters and/or the delimiters for the constructs themselves.
1842 (cond
1843 ((looking-at "//")
1844 (gud-jdb-skip-single-line-comment))
1846 (gud-jdb-skip-traditional-or-documentation-comment))
1848 (gud-jdb-skip-string-literal))
1850 (gud-jdb-skip-character-literal))
1851 (t (forward-char))))
1853 ;; Now at the begining of the block.
1854 (forward-char)
1856 ;; Skip over the body of the block as well as the final brace.
1857 (let ((open-level 1))
1858 (while (not (eq open-level 0))
1859 (cond
1860 ((looking-at "//")
1861 (gud-jdb-skip-single-line-comment))
1863 (gud-jdb-skip-traditional-or-documentation-comment))
1865 (gud-jdb-skip-string-literal))
1867 (gud-jdb-skip-character-literal))
1868 ((eq (following-char) ?{)
1869 (setq open-level (+ open-level 1))
1870 (forward-char))
1871 ((eq (following-char) ?})
1872 (setq open-level (- open-level 1))
1873 (forward-char))
1874 (t (forward-char))))))
1876 ;; Find the package and class definitions in Java source file FILE. Assumes
1877 ;; that FILE contains a legal Java program. BUF is a scratch buffer used
1878 ;; to hold the source during analysis.
1879 (defun gud-jdb-analyze-source (buf file)
1880 (let ((l nil))
1881 (set-buffer buf)
1882 (insert-file-contents file nil nil nil t)
1883 (goto-char 0)
1884 (catch 'abort
1885 (let ((p ""))
1886 (while (progn
1887 (gud-jdb-skip-whitespace)
1888 (not (eobp)))
1889 (cond
1891 ;; Any number of semi's following a block is legal. Move point
1892 ;; past them. Note that comments and whitespace may be
1893 ;; interspersed as well.
1895 (forward-char))
1897 ;; Move point past a single line comment.
1898 ((looking-at "//")
1899 (gud-jdb-skip-single-line-comment))
1901 ;; Move point past a traditional or documentation comment.
1903 (gud-jdb-skip-traditional-or-documentation-comment))
1905 ;; Move point past a package statement, but save the PackageName.
1906 ((looking-at "package")
1907 (forward-char 7)
1908 (gud-jdb-skip-whitespace-and-comments)
1909 (let ((s (point)))
1910 (gud-jdb-skip-id-ish-thing)
1911 (setq p (concat (buffer-substring s (point)) "."))
1912 (gud-jdb-skip-whitespace-and-comments)
1914 (forward-char))))
1916 ;; Move point past an import statement.
1917 ((looking-at "import")
1918 (forward-char 6)
1919 (gud-jdb-skip-whitespace-and-comments)
1920 (gud-jdb-skip-id-ish-thing)
1921 (gud-jdb-skip-whitespace-and-comments)
1923 (forward-char)))
1925 ;; Move point past the various kinds of ClassModifiers.
1926 ((looking-at "public")
1927 (forward-char 6))
1928 ((looking-at "abstract")
1929 (forward-char 8))
1930 ((looking-at "final")
1931 (forward-char 5))
1933 ;; Move point past a ClassDeclaraction, but save the class
1934 ;; Identifier.
1935 ((looking-at "class")
1936 (forward-char 5)
1937 (gud-jdb-skip-whitespace-and-comments)
1938 (let ((s (point)))
1939 (gud-jdb-skip-id-ish-thing)
1940 (setq
1941 l (nconc l (list (concat p (buffer-substring s (point)))))))
1942 (gud-jdb-skip-block))
1944 ;; Move point past an interface statement.
1945 ((looking-at "interface")
1946 (forward-char 9)
1947 (gud-jdb-skip-block))
1949 ;; Anything else means the input is invalid.
1950 (t
1951 (message "Error parsing file %s." file)
1952 (throw 'abort nil))))))
1953 l))
1955 (defun gud-jdb-build-class-source-alist-for-file (file)
1956 (mapcar
1957 (lambda (c)
1958 (cons c file))
1959 (gud-jdb-analyze-source gud-jdb-analysis-buffer file)))
1961 ;; Return an alist of fully qualified classes and the source files
1962 ;; holding their definitions. SOURCES holds a list of all the source
1963 ;; files to examine.
1964 (defun gud-jdb-build-class-source-alist (sources)
1965 (setq gud-jdb-analysis-buffer (get-buffer-create " *gud-jdb-scratch*"))
1966 (prog1
1967 (apply
1968 'nconc
1969 (mapcar
1970 'gud-jdb-build-class-source-alist-for-file
1971 sources))
1972 (kill-buffer gud-jdb-analysis-buffer)
1973 (setq gud-jdb-analysis-buffer nil)))
1975 ;; Change what was given in the minibuffer to something that can be used to
1976 ;; invoke the debugger.
1977 (defun gud-jdb-massage-args (file args)
1978 ;; The jdb executable must have whitespace between "-classpath" and
1979 ;; its value while gud-common-init expects all switch values to
1980 ;; follow the switch keyword without intervening whitespace. We
1981 ;; require that when the user enters the "-classpath" switch in the
1982 ;; EMACS minibuffer that they do so without the intervening
1983 ;; whitespace. This function adds it back (it's called after
1984 ;; gud-common-init). There are more switches like this (for
1985 ;; instance "-host" and "-password") but I don't care about them
1986 ;; yet.
1987 (if args
1988 (let (massaged-args user-error)
1990 (while (and args (not user-error))
1991 (cond
1992 ((setq user-error (string-match "-classpath$" (car args))))
1993 ((setq user-error (string-match "-sourcepath$" (car args))))
1995 (setq massaged-args
1996 (append massaged-args
1997 (list "-classpath"
1998 (setq gud-jdb-classpath-string
1999 (match-string 1 (car args)))))))
2001 (setq massaged-args
2002 (append massaged-args
2003 (list "-sourcepath"
2004 (setq gud-jdb-sourcepath
2005 (match-string 1 (car args)))))))
2006 (t (setq massaged-args (append massaged-args (list (car args))))))
2007 (setq args (cdr args)))
2009 ;; By this point the current directory is all screwed up. Maybe we
2010 ;; could fix things and re-invoke gud-common-init, but for now I think
2011 ;; issueing the error is good enough.
2012 (if user-error
2013 (progn
2014 (kill-buffer (current-buffer))
2015 (error "Error: Omit whitespace between '-classpath or -sourcepath' and its value")))
2016 massaged-args)))
2018 ;; Search for an association with P, a fully qualified class name, in
2019 ;; gud-jdb-class-source-alist. The asssociation gives the fully
2020 ;; qualified file name of the source file which produced the class.
2021 (defun gud-jdb-find-source-file (p)
2022 (cdr (assoc p gud-jdb-class-source-alist)))
2024 ;; Note: Reset to this value every time a prompt is seen
2025 (defvar gud-jdb-lowest-stack-level 999)
2027 (defun gud-jdb-find-source-using-classpath (p)
2028 "Find source file corresponding to fully qualified class p.
2029 Convert p from jdb's output, converted to a pathname
2030 relative to a classpath directory."
2031 (save-match-data
2032 (let
2033 (;; Replace dots with slashes and append ".java" to generate file
2034 ;; name relative to classpath
2035 (filename
2036 (concat
2037 (mapconcat 'identity
2038 (split-string
2039 ;; Eliminate any subclass references in the class
2040 ;; name string. These start with a "$"
2041 ((lambda (x)
2042 (if (string-match "$.*" x)
2043 (replace-match "" t t x) p))
2044 p)
2046 ".java"))
2047 (cplist (append gud-jdb-sourcepath gud-jdb-classpath))
2048 found-file)
2049 (while (and cplist
2050 (not (setq found-file
2051 (file-readable-p
2052 (concat (car cplist) "/" filename)))))
2053 (setq cplist (cdr cplist)))
2054 (if found-file (concat (car cplist) "/" filename)))))
2056 (defun gud-jdb-find-source (string)
2057 "Alias for function used to locate source files.
2058 Set to `gud-jdb-find-source-using-classpath' or `gud-jdb-find-source-file'
2059 during jdb initialization depending on the value of
2060 `gud-jdb-use-classpath'."
2061 nil)
2063 (defun gud-jdb-parse-classpath-string (string)
2064 "Parse the classpath list and convert each item to an absolute pathname."
2066 (replace-match "" nil nil s) s))
2067 (mapcar 'file-truename
2068 (split-string
2069 string
2072 ;; See comentary for other debugger's marker filters - there you will find
2073 ;; important notes about STRING.
2074 (defun gud-jdb-marker-filter (string)
2076 ;; Build up the accumulator.
2077 (setq gud-marker-acc
2078 (if gud-marker-acc
2079 (concat gud-marker-acc string)
2080 string))
2082 ;; Look for classpath information until gud-jdb-classpath-string is found
2083 ;; (interactive, multiple settings of classpath from jdb
2084 ;; not supported/followed)
2085 (if (and gud-jdb-use-classpath
2086 (not gud-jdb-classpath-string)
2089 (setq gud-jdb-classpath
2090 (gud-jdb-parse-classpath-string
2091 (setq gud-jdb-classpath-string
2092 (match-string 1 gud-marker-acc)))))
2094 ;; We process STRING from left to right. Each time through the
2095 ;; following loop we process at most one marker. After we've found a
2096 ;; marker, delete gud-marker-acc up to and including the match
2097 (let (file-found)
2098 ;; Process each complete marker in the input.
2099 (while
2101 ;; Do we see a marker?
2102 (string-match
2103 ;; jdb puts out a string of the following form when it
2104 ;; hits a breakpoint:
2105 ;;
2106 ;; <fully-qualified-class><method> (<class>:<line-number>)
2107 ;;
2108 ;; <fully-qualified-class>'s are composed of Java ID's
2109 ;; separated by periods. <method> and <class> are
2110 ;; also Java ID's. <method> begins with a period and
2111 ;; may contain less-than and greater-than (constructors,
2112 ;; for instance, are called <init> in the symbol table.)
2113 ;; Java ID's begin with a letter followed by letters
2114 ;; and/or digits. The set of letters includes underscore
2115 ;; and dollar sign.
2116 ;;
2117 ;; The first group matches <fully-qualified-class>,
2118 ;; the second group matches <class> and the third group
2119 ;; matches <line-number>. We don't care about using
2120 ;; <method> so we don't "group" it.
2121 ;;
2122 ;; FIXME: Java ID's are UNICODE strings, this matches ASCII
2123 ;; ID's only.
2124 ;;
2125 ;; The ".," in the last square-bracket are necessary because
2126 ;; of Sun's total disrespect for backwards compatibility in
2127 ;; reported line numbers from jdb - starting in 1.4.0 they
2128 ;; print line numbers using LOCALE, inserting a comma or a
2129 ;; period at the thousands positions (how ingenious!).
2133 gud-marker-acc)
2135 ;; A good marker is one that:
2136 ;; 1) does not have a "[n] " prefix (not part of a stack backtrace)
2137 ;; 2) does have an "[n] " prefix and n is the lowest prefix seen
2138 ;; since the last prompt
2139 ;; Figure out the line on which to position the debugging arrow.
2140 ;; Return the info as a cons of the form:
2141 ;;
2142 ;; (<file-name> . <line-number>) .
2143 (if (if (match-beginning 1)
2144 (let (n)
2145 (setq n (string-to-number (substring
2146 gud-marker-acc
2147 (1+ (match-beginning 1))
2148 (- (match-end 1) 2))))
2149 (if (< n gud-jdb-lowest-stack-level)
2150 (progn (setq gud-jdb-lowest-stack-level n) t)))
2151 t)
2152 (if (setq file-found
2153 (gud-jdb-find-source (match-string 2 gud-marker-acc)))
2154 (setq gud-last-frame
2155 (cons file-found
2156 (string-to-number
2157 (let
2158 ((numstr (match-string 4 gud-marker-acc)))
2159 (if (string-match "[.,]" numstr)
2160 (replace-match "" nil nil numstr)
2161 numstr)))))
2162 (message "Could not find source file.")))
2164 ;; Set the accumulator to the remaining text.
2165 (setq gud-marker-acc (substring gud-marker-acc (match-end 0))))
2167 (if (string-match comint-prompt-regexp gud-marker-acc)
2168 (setq gud-jdb-lowest-stack-level 999)))
2170 ;; Do not allow gud-marker-acc to grow without bound. If the source
2171 ;; file information is not within the last 3/4
2172 ;; gud-marker-acc-max-length characters, well,...
2173 (if (> (length gud-marker-acc) gud-marker-acc-max-length)
2174 (setq gud-marker-acc
2175 (substring gud-marker-acc
2176 (- (/ (* gud-marker-acc-max-length 3) 4)))))
2178 ;; We don't filter any debugger output so just return what we were given.
2179 string)
2181 (defvar gud-jdb-command-name "jdb" "Command that executes the Java debugger.")
2183 ;;;###autoload
2184 (defun jdb (command-line)
2185 "Run jdb with command line COMMAND-LINE in a buffer.
2188 switch is given, omit all whitespace between it and its value.
2190 See `gud-jdb-use-classpath' and `gud-jdb-classpath' documentation for
2191 information on how jdb accesses source files. Alternatively (if
2192 `gud-jdb-use-classpath' is nil), see `gud-jdb-directories' for the
2193 original source file access method.
2195 For general information about commands available to control jdb from
2196 gud, see `gud-mode'."
2197 (interactive
2198 (list (gud-query-cmdline 'jdb)))
2199 (setq gud-jdb-classpath nil)
2200 (setq gud-jdb-sourcepath nil)
2202 ;; Set gud-jdb-classpath from the CLASSPATH environment variable,
2203 ;; if CLASSPATH is set.
2204 (setq gud-jdb-classpath-string (getenv "CLASSPATH"))
2205 (if gud-jdb-classpath-string
2206 (setq gud-jdb-classpath
2207 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2208 (setq gud-jdb-classpath-string nil) ; prepare for next
2210 (gud-common-init command-line 'gud-jdb-massage-args
2211 'gud-jdb-marker-filter)
2212 (set (make-local-variable 'gud-minor-mode) 'jdb)
2214 ;; If a -classpath option was provided, set gud-jdb-classpath
2215 (if gud-jdb-classpath-string
2216 (setq gud-jdb-classpath
2217 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2218 (setq gud-jdb-classpath-string nil) ; prepare for next
2219 ;; If a -sourcepath option was provided, parse it
2220 (if gud-jdb-sourcepath
2221 (setq gud-jdb-sourcepath
2222 (gud-jdb-parse-classpath-string gud-jdb-sourcepath)))
2224 (gud-def gud-break "stop at %c:%l" "\C-b" "Set breakpoint at current line.")
2225 (gud-def gud-remove "clear %c:%l" "\C-d" "Remove breakpoint at current line")
2226 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2227 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2228 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
2229 (gud-def gud-finish "step up" "\C-f" "Continue until current method returns.")
2230 (gud-def gud-up "up\C-Mwhere" "<" "Up one stack frame.")
2231 (gud-def gud-down "down\C-Mwhere" ">" "Up one stack frame.")
2232 (gud-def gud-run "run" nil "Run the program.") ;if VM start using jdb
2235 (setq paragraph-start comint-prompt-regexp)
2236 (run-hooks 'jdb-mode-hook)
2238 (if gud-jdb-use-classpath
2239 ;; Get the classpath information from the debugger
2240 (progn
2241 (if (string-match "-attach" command-line)
2242 (gud-call "classpath"))
2243 (fset 'gud-jdb-find-source
2244 'gud-jdb-find-source-using-classpath))
2246 ;; Else create and bind the class/source association list as well
2247 ;; as the source file list.
2248 (setq gud-jdb-class-source-alist
2249 (gud-jdb-build-class-source-alist
2250 (setq gud-jdb-source-files
2251 (gud-jdb-build-source-files-list gud-jdb-directories
2253 (fset 'gud-jdb-find-source 'gud-jdb-find-source-file)))
2254 \f
2256 ;; ======================================================================
2257 ;;
2258 ;; BASHDB support. See http://bashdb.sourceforge.net
2259 ;;
2260 ;; AUTHOR: Rocky Bernstein <rocky@panix.com>
2261 ;;
2262 ;; CREATED: Sun Nov 10 10:46:38 2002 Rocky Bernstein.
2263 ;;
2264 ;; INVOCATION NOTES:
2265 ;;
2266 ;; You invoke bashdb-mode with:
2267 ;;
2268 ;; M-x bashdb <enter>
2269 ;;
2270 ;; It responds with:
2271 ;;
2272 ;; Run bashdb (like this): bash
2273 ;;
2275 ;; History of argument lists passed to bashdb.
2276 (defvar gud-bashdb-history nil)
2278 ;; Convert a command line as would be typed normally to run a script
2279 ;; into one that invokes an Emacs-enabled debugging session.
2280 ;; "--debugger" in inserted as the first switch.
2282 ;; There's no guarantee that Emacs will hand the filter the entire
2283 ;; marker at once; it could be broken up across several strings. We
2284 ;; might even receive a big chunk with several markers in it. If we
2285 ;; receive a chunk of text which looks like it might contain the
2286 ;; beginning of a marker, we save it here between calls to the
2287 ;; filter.
2288 (defun gud-bashdb-marker-filter (string)
2289 (setq gud-marker-acc (concat gud-marker-acc string))
2290 (let ((output ""))
2292 ;; Process all the complete markers in this chunk.
2293 ;; Format of line looks like this:
2294 ;; (/etc/init.d/ntp.init:16):
2295 ;; but we also allow DOS drive letters
2296 ;; (d:/etc/init.d/ntp.init:16):
2298 gud-marker-acc)
2299 (setq
2301 ;; Extract the frame position from the marker.
2302 gud-last-frame
2303 (cons (match-string 2 gud-marker-acc)
2304 (string-to-number (match-string 4 gud-marker-acc)))
2306 ;; Append any text before the marker to the output we're going
2307 ;; to return - we don't include the marker in this text.
2308 output (concat output
2309 (substring gud-marker-acc 0 (match-beginning 0)))
2311 ;; Set the accumulator to the remaining text.
2312 gud-marker-acc (substring gud-marker-acc (match-end 0))))
2314 ;; Does the remaining text look like it might end with the
2315 ;; beginning of another marker? If it does, then keep it in
2316 ;; gud-marker-acc until we receive the rest of it. Since we
2317 ;; know the full marker regexp above failed, it's pretty simple to
2318 ;; test for marker starts.
2320 (progn
2321 ;; Everything before the potential marker start can be output.
2322 (setq output (concat output (substring gud-marker-acc
2323 0 (match-beginning 0))))
2325 ;; Everything after, we save, to combine with later input.
2326 (setq gud-marker-acc
2327 (substring gud-marker-acc (match-beginning 0))))
2329 (setq output (concat output gud-marker-acc)
2330 gud-marker-acc ""))
2332 output))
2334 (defcustom gud-bashdb-command-name "bash --debugger"
2335 "File name for executing bash debugger."
2336 :type 'string
2337 :group 'gud)
2339 ;;;###autoload
2340 (defun bashdb (command-line)
2341 "Run bashdb on program FILE in buffer *gud-FILE*.
2342 The directory containing FILE becomes the initial working directory
2343 and source-file directory for your debugger."
2344 (interactive
2345 (list (read-from-minibuffer "Run bashdb (like this): "
2346 (if (consp gud-bashdb-history)
2347 (car gud-bashdb-history)
2348 (concat gud-bashdb-command-name
2349 " "))
2350 gud-minibuffer-local-map nil
2351 '(gud-bashdb-history . 1))))
2353 (gud-common-init command-line nil 'gud-bashdb-marker-filter)
2355 (set (make-local-variable 'gud-minor-mode) 'bashdb)
2357 (gud-def gud-break "break %l" "\C-b" "Set breakpoint at current line.")
2358 (gud-def gud-tbreak "tbreak %l" "\C-t" "Set temporary breakpoint at current line.")
2359 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
2360 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2361 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2362 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
2363 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
2364 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
2365 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
2366 (gud-def gud-print "x %e" "\C-p" "Evaluate BASH expression at point.")
2368 ;; Is this right?
2369 (gud-def gud-statement "eval %e" "\C-e" "Execute BASH statement at point.")
2371 (setq comint-prompt-regexp "^bashdb<+(*[0-9]+)*>+ ")
2372 (setq paragraph-start comint-prompt-regexp)
2373 (run-hooks 'bashdb-mode-hook)
2374 )
2376 ;;
2377 ;; End of debugger-specific information
2378 ;;
2380 \f
2381 ;; When we send a command to the debugger via gud-call, it's annoying
2382 ;; to see the command and the new prompt inserted into the debugger's
2383 ;; buffer; we have other ways of knowing the command has completed.
2384 ;;
2385 ;; If the buffer looks like this:
2386 ;; --------------------
2387 ;; (gdb) set args foo bar
2388 ;; (gdb) -!-
2389 ;; --------------------
2390 ;; (the -!- marks the location of point), and we type `C-x SPC' in a
2391 ;; source file to set a breakpoint, we want the buffer to end up like
2392 ;; this:
2393 ;; --------------------
2394 ;; (gdb) set args foo bar
2395 ;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
2396 ;; (gdb) -!-
2397 ;; --------------------
2398 ;; Essentially, the old prompt is deleted, and the command's output
2399 ;; and the new prompt take its place.
2400 ;;
2401 ;; Not echoing the command is easy enough; you send it directly using
2402 ;; process-send-string, and it never enters the buffer. However,
2403 ;; getting rid of the old prompt is trickier; you don't want to do it
2404 ;; when you send the command, since that will result in an annoying
2405 ;; flicker as the prompt is deleted, redisplay occurs while Emacs
2406 ;; waits for a response from the debugger, and the new prompt is
2407 ;; inserted. Instead, we'll wait until we actually get some output
2408 ;; from the subprocess before we delete the prompt. If the command
2409 ;; produced no output other than a new prompt, that prompt will most
2410 ;; likely be in the first chunk of output received, so we will delete
2411 ;; the prompt and then replace it with an identical one. If the
2412 ;; command produces output, the prompt is moving anyway, so the
2413 ;; flicker won't be annoying.
2414 ;;
2415 ;; So - when we want to delete the prompt upon receipt of the next
2416 ;; chunk of debugger output, we position gud-delete-prompt-marker at
2417 ;; the start of the prompt; the process filter will notice this, and
2418 ;; delete all text between it and the process output marker. If
2419 ;; gud-delete-prompt-marker points nowhere, we leave the current
2420 ;; prompt alone.
2421 (defvar gud-delete-prompt-marker nil)
2423 \f
2424 (put 'gud-mode 'mode-class 'special)
2426 (define-derived-mode gud-mode comint-mode "Debugger"
2427 "Major mode for interacting with an inferior debugger process.
2429 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
2430 M-x perldb, M-x xdb, or M-x jdb. Each entry point finishes by executing a
2431 hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook',
2432 `perldb-mode-hook', `xdb-mode-hook', or `jdb-mode-hook' respectively.
2434 After startup, the following commands are available in both the GUD
2435 interaction buffer and any source buffer GUD visits due to a breakpoint stop
2436 or step operation:
2439 GUD buffer, the current file and line are those of the last breakpoint or
2440 step. In a source buffer, they are the buffer's file and current line.
2445 in the gud buffer.
2448 step-one-line (not entering function calls), and step-one-instruction
2449 and then update the source window with the current file and position.
2453 around point, and sends it to the debugger for value display.
2455 The above commands are common to all supported debuggers except xdb which
2456 does not support stepping instructions.
2459 except that the breakpoint is temporary; that is, it is removed when
2460 execution stops on it.
2466 the current function and stops.
2468 All the keystrokes above are accessible in the GUD buffer
2469 with the prefix C-c, and in all buffers through the prefix C-x C-a.
2471 All pre-defined functions for which the concept make sense repeat
2472 themselves the appropriate number of times if you give a prefix
2473 argument.
2475 You may use the `gud-def' macro in the initialization hook to define other
2476 commands.
2478 Other commands for interacting with the debugger process are inherited from
2479 comint mode, which see."
2480 (setq mode-line-process '(":%s"))
2481 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
2482 (set (make-local-variable 'gud-last-frame) nil)
2483 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
2484 (make-local-variable 'comint-prompt-regexp)
2485 ;; Don't put repeated commands in command history many times.
2486 (set (make-local-variable 'comint-input-ignoredups) t)
2487 (make-local-variable 'paragraph-start)
2488 (set (make-local-variable 'gud-delete-prompt-marker) (make-marker))
2489 (add-hook 'kill-buffer-hook 'gud-kill-buffer-hook nil t))
2491 ;; Cause our buffers to be displayed, by default,
2492 ;; in the selected window.
2495 (defcustom gud-chdir-before-run t
2496 "Non-nil if GUD should `cd' to the debugged executable."
2497 :group 'gud
2498 :type 'boolean)
2500 (defvar gud-target-name "--unknown--"
2501 "The apparent name of the program being debugged in a gud buffer.")
2503 ;; Perform initializations common to all debuggers.
2504 ;; The first arg is the specified command line,
2505 ;; which starts with the program to debug.
2506 ;; The other three args specify the values to use
2507 ;; for local variables in the debugger buffer.
2508 (defun gud-common-init (command-line massage-args marker-filter
2509 &optional find-file)
2510 (let* ((words (split-string command-line))
2511 (program (car words))
2512 (dir default-directory)
2513 ;; Extract the file name from WORDS
2514 ;; and put t in its place.
2515 ;; Later on we will put the modified file name arg back there.
2516 (file-word (let ((w (cdr words)))
2517 (while (and w (= ?- (aref (car w) 0)))
2518 (setq w (cdr w)))
2519 (and w
2520 (prog1 (car w)
2521 (setcar w t)))))
2522 (file-subst
2523 (and file-word (substitute-in-file-name file-word)))
2524 (args (cdr words))
2525 ;; If a directory was specified, expand the file name.
2526 ;; Otherwise, don't expand it, so GDB can use the PATH.
2527 ;; A file name without directory is literally valid
2528 ;; only if the file exists in ., and in that case,
2529 ;; omitting the expansion here has no visible effect.
2530 (file (and file-word
2531 (if (file-name-directory file-subst)
2532 (expand-file-name file-subst)
2533 file-subst)))
2534 (filepart (and file-word (concat "-" (file-name-nondirectory file))))
2535 (existing-buffer (get-buffer (concat "*gud" filepart "*"))))
2536 (pop-to-buffer (concat "*gud" filepart "*"))
2537 (when (and existing-buffer (get-buffer-process existing-buffer))
2538 (error "This program is already running under gdb"))
2539 ;; Set the dir, in case the buffer already existed with a different dir.
2540 (setq default-directory dir)
2541 ;; Set default-directory to the file's directory.
2542 (and file-word
2543 gud-chdir-before-run
2544 ;; Don't set default-directory if no directory was specified.
2545 ;; In that case, either the file is found in the current directory,
2546 ;; in which case this setq is a no-op,
2547 ;; or it is found by searching PATH,
2548 ;; in which case we don't know what directory it was found in.
2549 (file-name-directory file)
2550 (setq default-directory (file-name-directory file)))
2551 (or (bolp) (newline))
2553 ;; Put the substituted and expanded file name back in its place.
2554 (let ((w args))
2555 (while (and w (not (eq (car w) t)))
2556 (setq w (cdr w)))
2557 (if w
2558 (setcar w file)))
2559 (apply 'make-comint (concat "gud" filepart) program nil
2560 (if massage-args (funcall massage-args file args) args))
2561 ;; Since comint clobbered the mode, we don't set it until now.
2562 (gud-mode)
2563 (set (make-local-variable 'gud-target-name)
2564 (and file-word (file-name-nondirectory file))))
2565 (set (make-local-variable 'gud-marker-filter) marker-filter)
2566 (if find-file (set (make-local-variable 'gud-find-file) find-file))
2567 (setq gud-running nil)
2568 (setq gud-last-last-frame nil)
2570 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
2571 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
2572 (gud-set-buffer))
2574 (defun gud-set-buffer ()
2575 (when (eq major-mode 'gud-mode)
2576 (setq gud-comint-buffer (current-buffer))))
2578 (defvar gud-filter-defer-flag nil
2579 "Non-nil means don't process anything from the debugger right now.
2580 It is saved for when this flag is not set.")
2582 ;; These functions are responsible for inserting output from your debugger
2583 ;; into the buffer. The hard work is done by the method that is
2584 ;; the value of gud-marker-filter.
2586 (defun gud-filter (proc string)
2587 ;; Here's where the actual buffer insertion is done
2588 (let (output process-window)
2589 (if (buffer-name (process-buffer proc))
2590 (if gud-filter-defer-flag
2591 ;; If we can't process any text now,
2592 ;; save it for later.
2593 (setq gud-filter-pending-text
2594 (concat (or gud-filter-pending-text "") string))
2596 ;; If we have to ask a question during the processing,
2597 ;; defer any additional text that comes from the debugger
2598 ;; during that time.
2599 (let ((gud-filter-defer-flag t))
2600 ;; Process now any text we previously saved up.
2601 (if gud-filter-pending-text
2602 (setq string (concat gud-filter-pending-text string)
2603 gud-filter-pending-text nil))
2605 (with-current-buffer (process-buffer proc)
2606 ;; If we have been so requested, delete the debugger prompt.
2607 (save-restriction
2608 (widen)
2609 (if (marker-buffer gud-delete-prompt-marker)
2610 (let ((inhibit-read-only t))
2611 (delete-region (process-mark proc)
2612 gud-delete-prompt-marker)
2613 (comint-update-fence)
2614 (set-marker gud-delete-prompt-marker nil)))
2615 ;; Save the process output, checking for source file markers.
2616 (setq output (gud-marker-filter string))
2617 ;; Check for a filename-and-line number.
2618 ;; Don't display the specified file
2619 ;; unless (1) point is at or after the position where output appears
2620 ;; and (2) this buffer is on the screen.
2621 (setq process-window
2622 (and gud-last-frame
2623 (>= (point) (process-mark proc))
2624 (get-buffer-window (current-buffer)))))
2626 ;; Let the comint filter do the actual insertion.
2627 ;; That lets us inherit various comint features.
2628 (comint-output-filter proc output))
2630 ;; Put the arrow on the source line.
2631 ;; This must be outside of the save-excursion
2632 ;; in case the source file is our current buffer.
2633 (if process-window
2634 (with-selected-window process-window
2635 (gud-display-frame))
2636 ;; We have to be in the proper buffer, (process-buffer proc),
2637 ;; but not in a save-excursion, because that would restore point.
2638 (with-current-buffer (process-buffer proc)
2639 (gud-display-frame))))
2641 ;; If we deferred text that arrived during this processing,
2642 ;; handle it now.
2643 (if gud-filter-pending-text
2644 (gud-filter proc ""))))))
2646 (defvar gud-minor-mode-type nil)
2647 (defvar gud-overlay-arrow-position nil)
2648 (add-to-list 'overlay-arrow-variable-list 'gud-overlay-arrow-position)
2650 (defun gud-sentinel (proc msg)
2651 (cond ((null (buffer-name (process-buffer proc)))
2652 ;; buffer killed
2653 ;; Stop displaying an arrow in a source file.
2654 (setq gud-overlay-arrow-position nil)
2655 (set-process-buffer proc nil)
2656 (if (and (boundp 'speedbar-frame)
2657 (string-equal speedbar-initial-expansion-list-name "GUD"))
2658 (speedbar-change-initial-expansion-list
2659 speedbar-previously-used-expansion-list-name))
2660 (if (memq gud-minor-mode-type '(gdbmi gdba))
2661 (gdb-reset)
2662 (gud-reset)))
2663 ((memq (process-status proc) '(signal exit))
2664 ;; Stop displaying an arrow in a source file.
2665 (setq gud-overlay-arrow-position nil)
2666 (with-current-buffer gud-comint-buffer
2667 (if (memq gud-minor-mode-type '(gdbmi gdba))
2668 (gdb-reset)
2669 (gud-reset)))
2670 (let* ((obuf (current-buffer)))
2671 ;; save-excursion isn't the right thing if
2672 ;; process-buffer is current-buffer
2673 (unwind-protect
2674 (progn
2675 ;; Write something in *compilation* and hack its mode line,
2676 (set-buffer (process-buffer proc))
2677 ;; Fix the mode line.
2678 (setq mode-line-process
2679 (concat ":"
2680 (symbol-name (process-status proc))))
2681 (force-mode-line-update)
2682 (if (eobp)
2684 (save-excursion
2685 (goto-char (point-max))
2687 ;; If buffer and mode line will show that the process
2688 ;; is dead, we can delete it now. Otherwise it
2689 ;; will stay around until M-x list-processes.
2690 (delete-process proc))
2691 ;; Restore old buffer, but don't restore old point
2692 ;; if obuf is the gud buffer.
2693 (set-buffer obuf))))))
2695 (defun gud-kill-buffer-hook ()
2696 (setq gud-minor-mode-type gud-minor-mode)
2697 (condition-case nil
2698 (kill-process (get-buffer-process (current-buffer)))
2699 (error nil)))
2701 (defun gud-reset ()
2702 (dolist (buffer (buffer-list))
2703 (unless (eq buffer gud-comint-buffer)
2704 (with-current-buffer buffer
2705 (when gud-minor-mode
2706 (setq gud-minor-mode nil)
2707 (kill-local-variable 'tool-bar-map))))))
2709 (defun gud-display-frame ()
2710 "Find and obey the last filename-and-line marker from the debugger.
2711 Obeying it means displaying in another window the specified file and line."
2712 (interactive)
2713 (when gud-last-frame
2714 (gud-set-buffer)
2715 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
2716 (setq gud-last-last-frame gud-last-frame
2717 gud-last-frame nil)))
2719 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
2720 ;; and that its line LINE is visible.
2721 ;; Put the overlay-arrow on the line LINE in that buffer.
2722 ;; Most of the trickiness in here comes from wanting to preserve the current
2723 ;; region-restriction if that's possible. We use an explicit display-buffer
2724 ;; to get around the fact that this is called inside a save-excursion.
2726 (defun gud-display-line (true-file line)
2727 (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
2728 (buffer
2729 (with-current-buffer gud-comint-buffer
2730 (gud-find-file true-file)))
2731 (window (and buffer (or (get-buffer-window buffer)
2732 (display-buffer buffer))))
2733 (pos))
2734 (if buffer
2735 (progn
2736 (with-current-buffer buffer
2737 (unless (or (verify-visited-file-modtime buffer) gud-keep-buffer)
2738 (if (yes-or-no-p
2739 (format "File %s changed on disk. Reread from disk? "
2740 (buffer-name)))
2741 (revert-buffer t t)
2742 (setq gud-keep-buffer t)))
2743 (save-restriction
2744 (widen)
2745 (goto-line line)
2746 (setq pos (point))
2747 (or gud-overlay-arrow-position
2748 (setq gud-overlay-arrow-position (make-marker)))
2749 (set-marker gud-overlay-arrow-position (point) (current-buffer)))
2750 (cond ((or (< pos (point-min)) (> pos (point-max)))
2751 (widen)
2752 (goto-char pos))))
2753 (if window (set-window-point window gud-overlay-arrow-position))))))
2755 ;; The gud-call function must do the right thing whether its invoking
2756 ;; keystroke is from the GUD buffer itself (via major-mode binding)
2757 ;; or a C buffer. In the former case, we want to supply data from
2758 ;; gud-last-frame. Here's how we do it:
2760 (defun gud-format-command (str arg)
2761 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
2762 (frame (or gud-last-frame gud-last-last-frame))
2763 result)
2765 (let ((key (string-to-char (match-string 2 str)))
2766 subst)
2767 (cond
2768 ((eq key ?f)
2769 (setq subst (file-name-nondirectory (if insource
2770 (buffer-file-name)
2771 (car frame)))))
2772 ((eq key ?F)
2773 (setq subst (file-name-sans-extension
2774 (file-name-nondirectory (if insource
2775 (buffer-file-name)
2776 (car frame))))))
2777 ((eq key ?d)
2778 (setq subst (file-name-directory (if insource
2779 (buffer-file-name)
2780 (car frame)))))
2781 ((eq key ?l)
2782 (setq subst (int-to-string
2783 (if insource
2784 (save-restriction
2785 (widen)
2786 (+ (count-lines (point-min) (point))
2787 (if (bolp) 1 0)))
2788 (cdr frame)))))
2789 ((eq key ?e)
2790 (setq subst (gud-find-expr)))
2791 ((eq key ?a)
2792 (setq subst (gud-read-address)))
2793 ((eq key ?c)
2794 (setq subst
2795 (gud-find-class
2796 (if insource
2797 (buffer-file-name)
2798 (car frame))
2799 (if insource
2800 (save-restriction
2801 (widen)
2802 (+ (count-lines (point-min) (point))
2803 (if (bolp) 1 0)))
2804 (cdr frame)))))
2805 ((eq key ?p)
2806 (setq subst (if arg (int-to-string arg)))))
2807 (setq result (concat result (match-string 1 str) subst)))
2808 (setq str (substring str (match-end 2))))
2809 ;; There might be text left in STR when the loop ends.
2810 (concat result str)))
2812 (defun gud-read-address ()
2813 "Return a string containing the core-address found in the buffer at point."
2814 (save-match-data
2815 (save-excursion
2816 (let ((pt (point)) found begin)
2817 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
2818 (cond
2819 (found (forward-char 2)
2820 (buffer-substring found
2821 (progn (re-search-forward "[^0-9a-f]")
2822 (forward-char -1)
2823 (point))))
2824 (t (setq begin (progn (re-search-backward "[^0-9]")
2825 (forward-char 1)
2826 (point)))
2827 (forward-char 1)
2828 (re-search-forward "[^0-9]")
2829 (forward-char -1)
2830 (buffer-substring begin (point))))))))
2832 (defun gud-call (fmt &optional arg)
2833 (let ((msg (gud-format-command fmt arg)))
2834 (message "Command: %s" msg)
2835 (sit-for 0)
2836 (gud-basic-call msg)))
2838 (defun gud-basic-call (command)
2839 "Invoke the debugger COMMAND displaying source in other window."
2840 (interactive)
2841 (gud-set-buffer)
2842 (let ((proc (get-buffer-process gud-comint-buffer)))
2843 (or proc (error "Current buffer has no process"))
2844 ;; Arrange for the current prompt to get deleted.
2845 (save-excursion
2846 (set-buffer gud-comint-buffer)
2847 (save-restriction
2848 (widen)
2849 (goto-char (process-mark proc))
2850 (forward-line 0)
2851 (if (looking-at comint-prompt-regexp)
2852 (set-marker gud-delete-prompt-marker (point)))
2853 (if (memq gud-minor-mode '(gdbmi gdba))
2854 (apply comint-input-sender (list proc command))
2857 (defun gud-refresh (&optional arg)
2858 "Fix up a possibly garbled display, and redraw the arrow."
2859 (interactive "P")
2860 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
2861 (gud-display-frame)
2862 (recenter arg))
2863 \f
2864 ;; Code for parsing expressions out of C or Fortran code. The single entry
2865 ;; point is gud-find-expr, which tries to return an lvalue expression from
2866 ;; around point.
2868 (defvar gud-find-expr-function 'gud-find-c-expr)
2870 (defun gud-find-expr (&rest args)
2871 (apply gud-find-expr-function args))
2873 ;; The next eight functions are hacked from gdbsrc.el by
2874 ;; Debby Ayers <ayers@asc.slb.com>,
2875 ;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
2877 (defun gud-find-c-expr ()
2878 "Returns the expr that surrounds point."
2879 (interactive)
2880 (save-excursion
2881 (let ((p (point))
2882 (expr (gud-innermost-expr))
2883 (test-expr (gud-prev-expr)))
2884 (while (and test-expr (gud-expr-compound test-expr expr))
2885 (let ((prev-expr expr))
2886 (setq expr (cons (car test-expr) (cdr expr)))
2887 (goto-char (car expr))
2888 (setq test-expr (gud-prev-expr))
2889 ;; If we just pasted on the condition of an if or while,
2890 ;; throw it away again.
2891 (if (member (buffer-substring (car test-expr) (cdr test-expr))
2892 '("if" "while" "for"))
2893 (setq test-expr nil
2894 expr prev-expr))))
2895 (goto-char p)
2896 (setq test-expr (gud-next-expr))
2897 (while (gud-expr-compound expr test-expr)
2898 (setq expr (cons (car expr) (cdr test-expr)))
2899 (setq test-expr (gud-next-expr)))
2900 (buffer-substring (car expr) (cdr expr)))))
2902 (defun gud-innermost-expr ()
2903 "Returns the smallest expr that point is in; move point to beginning of it.
2904 The expr is represented as a cons cell, where the car specifies the point in
2905 the current buffer that marks the beginning of the expr and the cdr specifies
2906 the character after the end of the expr."
2907 (let ((p (point)) begin end)
2908 (gud-backward-sexp)
2909 (setq begin (point))
2910 (gud-forward-sexp)
2911 (setq end (point))
2912 (if (>= p end)
2913 (progn
2914 (setq begin p)
2915 (goto-char p)
2916 (gud-forward-sexp)
2917 (setq end (point)))
2918 )
2919 (goto-char begin)
2920 (cons begin end)))
2922 (defun gud-backward-sexp ()
2923 "Version of `backward-sexp' that catches errors."
2924 (condition-case nil
2925 (backward-sexp)
2926 (error t)))
2928 (defun gud-forward-sexp ()
2929 "Version of `forward-sexp' that catches errors."
2930 (condition-case nil
2931 (forward-sexp)
2932 (error t)))
2934 (defun gud-prev-expr ()
2935 "Returns the previous expr, point is set to beginning of that expr.
2936 The expr is represented as a cons cell, where the car specifies the point in
2937 the current buffer that marks the beginning of the expr and the cdr specifies
2938 the character after the end of the expr"
2939 (let ((begin) (end))
2940 (gud-backward-sexp)
2941 (setq begin (point))
2942 (gud-forward-sexp)
2943 (setq end (point))
2944 (goto-char begin)
2945 (cons begin end)))
2947 (defun gud-next-expr ()
2948 "Returns the following expr, point is set to beginning of that expr.
2949 The expr is represented as a cons cell, where the car specifies the point in
2950 the current buffer that marks the beginning of the expr and the cdr specifies
2951 the character after the end of the expr."
2952 (let ((begin) (end))
2953 (gud-forward-sexp)
2954 (gud-forward-sexp)
2955 (setq end (point))
2956 (gud-backward-sexp)
2957 (setq begin (point))
2958 (cons begin end)))
2960 (defun gud-expr-compound-sep (span-start span-end)
2961 "Scan from SPAN-START to SPAN-END for punctuation characters.
2962 If `->' is found, return `?.'. If `.' is found, return `?.'.
2963 If any other punctuation is found, return `??'.
2964 If no punctuation is found, return `? '."
2965 (let ((result ?\s)
2966 (syntax))
2967 (while (< span-start span-end)
2968 (setq syntax (char-syntax (char-after span-start)))
2969 (cond
2970 ((= syntax ?\s) t)
2971 ((= syntax ?.) (setq syntax (char-after span-start))
2972 (cond
2973 ((= syntax ?.) (setq result ?.))
2974 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
2975 (setq result ?.)
2976 (setq span-start (+ span-start 1)))
2977 (t (setq span-start span-end)
2978 (setq result ??)))))
2979 (setq span-start (+ span-start 1)))
2980 result))
2982 (defun gud-expr-compound (first second)
2983 "Non-nil if concatenating FIRST and SECOND makes a single C expression.
2984 The two exprs are represented as a cons cells, where the car
2985 specifies the point in the current buffer that marks the beginning of the
2986 expr and the cdr specifies the character after the end of the expr.
2987 Link exprs of the form:
2988 Expr -> Expr
2989 Expr . Expr
2990 Expr (Expr)
2991 Expr [Expr]
2992 (Expr) Expr
2993 [Expr] Expr"
2994 (let ((span-start (cdr first))
2995 (span-end (car second))
2996 (syntax))
2997 (setq syntax (gud-expr-compound-sep span-start span-end))
2998 (cond
2999 ((= (car first) (car second)) nil)
3000 ((= (cdr first) (cdr second)) nil)
3001 ((= syntax ?.) t)
3002 ((= syntax ?\s)
3003 (setq span-start (char-after (- span-start 1)))
3004 (setq span-end (char-after span-end))
3005 (cond
3006 ((= span-start ?)) t)
3007 ((= span-start ?]) t)
3008 ((= span-end ?() t)
3009 ((= span-end ?[) t)
3010 (t nil)))
3011 (t nil))))
3013 (defun gud-find-class (f line)
3014 "Find fully qualified class in file F at line LINE.
3015 This function uses the `gud-jdb-classpath' (and optional
3016 `gud-jdb-sourcepath') list(s) to derive a file
3017 pathname relative to its classpath directory. The values in
3018 `gud-jdb-classpath' are assumed to have been converted to absolute
3019 pathname standards using file-truename.
3020 If F is visited by a buffer and its mode is CC-mode(Java),
3021 syntactic information of LINE is used to find the enclosing (nested)
3022 class string which is appended to the top level
3023 class of the file (using s to separate nested class ids)."
3024 ;; Convert f to a standard representation and remove suffix
3025 (if (and gud-jdb-use-classpath (or gud-jdb-classpath gud-jdb-sourcepath))
3026 (save-match-data
3027 (let ((cplist (append gud-jdb-sourcepath gud-jdb-classpath))
3028 (fbuffer (get-file-buffer f))
3029 syntax-symbol syntax-point class-found)
3030 (setq f (file-name-sans-extension (file-truename f)))
3031 ;; Syntax-symbol returns the symbol of the *first* element
3032 ;; in the syntactical analysis result list, syntax-point
3033 ;; returns the buffer position of same
3034 (fset 'syntax-symbol (lambda (x) (c-langelem-sym (car x))))
3035 (fset 'syntax-point (lambda (x) (c-langelem-pos (car x))))
3036 ;; Search through classpath list for an entry that is
3037 ;; contained in f
3038 (while (and cplist (not class-found))
3039 (if (string-match (car cplist) f)
3040 (setq class-found
3041 (mapconcat 'identity
3042 (split-string
3043 (substring f (+ (match-end 0) 1))
3044 "/") ".")))
3045 (setq cplist (cdr cplist)))
3046 ;; if f is visited by a java(cc-mode) buffer, walk up the
3047 ;; syntactic information chain and collect any 'inclass
3048 ;; symbols until 'topmost-intro is reached to find out if
3049 ;; point is within a nested class
3050 (if (and fbuffer (equal (symbol-file 'java-mode) "cc-mode"))
3051 (save-excursion
3052 (set-buffer fbuffer)
3053 (let ((nclass) (syntax))
3054 ;; While the c-syntactic information does not start
3055 ;; with the 'topmost-intro symbol, there may be
3056 ;; nested classes...
3057 (while (not (eq 'topmost-intro
3058 (syntax-symbol (c-guess-basic-syntax))))
3059 ;; Check if the current position c-syntactic
3060 ;; analysis has 'inclass
3061 (setq syntax (c-guess-basic-syntax))
3062 (while
3063 (and (not (eq 'inclass (syntax-symbol syntax)))
3064 (cdr syntax))
3065 (setq syntax (cdr syntax)))
3066 (if (eq 'inclass (syntax-symbol syntax))
3067 (progn
3068 (goto-char (syntax-point syntax))
3069 ;; Now we're at the beginning of a class
3070 ;; definition. Find class name
3071 (looking-at
3073 (setq nclass
3074 (append (list (match-string-no-properties 1))
3075 nclass)))
3076 (setq syntax (c-guess-basic-syntax))
3077 (while (and (not (syntax-point syntax)) (cdr syntax))
3078 (setq syntax (cdr syntax)))
3079 (goto-char (syntax-point syntax))
3080 ))
3081 (string-match (concat (car nclass) "$") class-found)
3082 (setq class-found
3083 (replace-match (mapconcat 'identity nclass "$")
3084 t t class-found)))))
3085 (if (not class-found)
3086 (message "gud-find-class: class for file %s not found!" f))
3087 class-found))
3088 ;; Not using classpath - try class/source association list
3089 (let ((class-found (rassoc f gud-jdb-class-source-alist)))
3090 (if class-found
3091 (car class-found)
3092 (message "gud-find-class: class for file %s not found in gud-jdb-class-source-alist!" f)
3093 nil))))
3095 \f
3096 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3097 ;;; GDB script mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3098 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3100 (defvar gdb-script-mode-syntax-table
3101 (let ((st (make-syntax-table)))
3103 (modify-syntax-entry ?# "<" st)
3105 st))
3107 (defvar gdb-script-font-lock-keywords
3112 ;; FIXME: The keyword "end" associated with "document"
3113 ;; should have font-lock-keyword-face (currently font-lock-doc-face).
3114 (defvar gdb-script-font-lock-syntactic-keywords
3119 (defun gdb-script-font-lock-syntactic-face (state)
3120 (cond
3121 ((nth 3 state) font-lock-string-face)
3122 ((nth 7 state) font-lock-doc-face)
3123 (t font-lock-comment-face)))
3125 (defvar gdb-script-basic-indent 2)
3127 (defun gdb-script-skip-to-head ()
3128 "We're just in front of an `end' and we need to go to its head."
3129 (while (and (re-search-backward "^\\s-*\\(\\(end\\)\\|define\\|document\\|if\\|while\\)\\>" nil 'move)
3130 (match-end 2))
3131 (gdb-script-skip-to-head)))
3133 (defun gdb-script-calculate-indentation ()
3134 (cond
3136 (gdb-script-skip-to-head)
3137 (current-indentation))
3140 (match-end 2))
3141 (gdb-script-skip-to-head))
3142 (current-indentation))
3143 (t
3144 (forward-comment (- (point-max)))
3145 (forward-line 0)
3147 (+ (current-indentation)
3149 gdb-script-basic-indent 0)))))
3151 (defun gdb-script-indent-line ()
3152 "Indent current line of GDB script."
3153 (interactive)
3154 (if (and (eq (get-text-property (point) 'face) font-lock-doc-face)
3155 (save-excursion
3156 (forward-line 0)
3159 'noindent
3160 (let* ((savep (point))
3161 (indent (condition-case nil
3162 (save-excursion
3163 (forward-line 0)
3165 (if (>= (point) savep) (setq savep nil))
3166 (max (gdb-script-calculate-indentation) 0))
3167 (error 0))))
3168 (if savep
3169 (save-excursion (indent-line-to indent))
3170 (indent-line-to indent)))))
3172 ;; Derived from cfengine.el.
3173 (defun gdb-script-beginning-of-defun ()
3174 "`beginning-of-defun' function for Gdb script mode.
3175 Treats actions as defuns."
3176 (unless (<= (current-column) (current-indentation))
3177 (end-of-line))
3179 (beginning-of-line)
3180 (goto-char (point-min)))
3181 t)
3183 ;; Derived from cfengine.el.
3184 (defun gdb-script-end-of-defun ()
3185 "`end-of-defun' function for Gdb script mode.
3186 Treats actions as defuns."
3187 (end-of-line)
3188 (if (re-search-forward "^end" nil t)
3189 (beginning-of-line)
3190 (goto-char (point-max)))
3191 t)
3193 ;;;###autoload
3196 ;;;###autoload
3197 (define-derived-mode gdb-script-mode nil "GDB-Script"
3198 "Major mode for editing GDB scripts"
3199 (set (make-local-variable 'comment-start) "#")
3202 (set (make-local-variable 'imenu-generic-expression)
3204 (set (make-local-variable 'indent-line-function) 'gdb-script-indent-line)
3205 (set (make-local-variable 'beginning-of-defun-function)
3206 #'gdb-script-beginning-of-defun)
3207 (set (make-local-variable 'end-of-defun-function)
3208 #'gdb-script-end-of-defun)
3209 (set (make-local-variable 'font-lock-defaults)
3210 '(gdb-script-font-lock-keywords nil nil ((?_ . "w")) nil
3211 (font-lock-syntactic-keywords
3212 . gdb-script-font-lock-syntactic-keywords)
3213 (font-lock-syntactic-face-function
3214 . gdb-script-font-lock-syntactic-face))))
3216 \f
3217 ;;; tooltips for GUD
3219 ;;; Customizable settings
3220 (defcustom gud-tooltip-modes '(gud-mode c-mode c++-mode fortran-mode)
3221 "List of modes for which to enable GUD tips."
3222 :type 'sexp
3223 :tag "GUD modes"
3224 :group 'tooltip)
3226 (defcustom gud-tooltip-display
3227 '((eq (tooltip-event-buffer gud-tooltip-event)
3228 (marker-buffer gud-overlay-arrow-position)))
3229 "List of forms determining where GUD tooltips are displayed.
3231 Forms in the list are combined with AND. The default is to display
3232 only tooltips in the buffer containing the overlay arrow."
3233 :type 'sexp
3234 :tag "GUD buffers predicate"
3235 :group 'tooltip)
3237 (defcustom gud-tooltip-echo-area nil
3238 "Use the echo area instead of frames for GUD tooltips."
3239 :type 'boolean
3240 :tag "Use echo area"
3241 :group 'tooltip)
3243 (define-obsolete-variable-alias 'tooltip-gud-modes
3244 'gud-tooltip-modes "22.1")
3245 (define-obsolete-variable-alias 'tooltip-gud-display
3246 'gud-tooltip-display "22.1")
3248 ;;; Reacting on mouse movements
3250 (defun gud-tooltip-change-major-mode ()
3251 "Function added to `change-major-mode-hook' when tooltip mode is on."
3252 (add-hook 'post-command-hook 'gud-tooltip-activate-mouse-motions-if-enabled))
3254 (defun gud-tooltip-activate-mouse-motions-if-enabled ()
3255 "Reconsider for all buffers whether mouse motion events are desired."
3256 (remove-hook 'post-command-hook
3257 'gud-tooltip-activate-mouse-motions-if-enabled)
3258 (dolist (buffer (buffer-list))
3259 (save-excursion
3260 (set-buffer buffer)
3261 (if (and gud-tooltip-mode
3262 (memq major-mode gud-tooltip-modes))
3263 (gud-tooltip-activate-mouse-motions t)
3264 (gud-tooltip-activate-mouse-motions nil)))))
3266 (defvar gud-tooltip-mouse-motions-active nil
3267 "Locally t in a buffer if tooltip processing of mouse motion is enabled.")
3269 (defun gud-tooltip-activate-mouse-motions (activatep)
3270 "Activate/deactivate mouse motion events for the current buffer.
3271 ACTIVATEP non-nil means activate mouse motion events."
3272 (if activatep
3273 (progn
3274 (make-local-variable 'gud-tooltip-mouse-motions-active)
3275 (setq gud-tooltip-mouse-motions-active t)
3276 (make-local-variable 'track-mouse)
3277 (setq track-mouse t))
3278 (when gud-tooltip-mouse-motions-active
3279 (kill-local-variable 'gud-tooltip-mouse-motions-active)
3280 (kill-local-variable 'track-mouse))))
3282 (defun gud-tooltip-mouse-motion (event)
3283 "Command handler for mouse movement events in `global-map'."
3284 (interactive "e")
3285 (tooltip-hide)
3286 (when (car (mouse-pixel-position))
3287 (setq tooltip-last-mouse-motion-event (copy-sequence event))
3288 (tooltip-start-delayed-tip)))
3290 ;;; Tips for `gud'
3292 (defvar gud-tooltip-original-filter nil
3293 "Process filter to restore after GUD output has been received.")
3295 (defvar gud-tooltip-dereference nil
3296 "Non-nil means print expressions with a `*' in front of them.
3297 For C this would dereference a pointer expression.")
3299 (defvar gud-tooltip-event nil
3300 "The mouse movement event that led to a tooltip display.
3301 This event can be examined by forms in GUD-TOOLTIP-DISPLAY.")
3303 (defun toggle-gud-tooltip-dereference ()
3304 "Toggle whether tooltips should show `* expr' or `expr'."
3305 (interactive)
3306 (setq gud-tooltip-dereference (not gud-tooltip-dereference))
3307 (when (interactive-p)
3308 (message "Dereferencing is now %s."
3309 (if gud-tooltip-dereference "on" "off"))))
3311 (define-obsolete-function-alias 'tooltip-gud-toggle-dereference
3312 'toggle-gud-tooltip-dereference "22.1")
3314 ;;;###autoload
3315 (define-minor-mode gud-tooltip-mode
3316 "Toggle the display of GUD tooltips."
3317 :global t
3318 :group 'gud
3319 (require 'tooltip)
3320 (if gud-tooltip-mode
3321 (progn
3322 (add-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3323 (add-hook 'pre-command-hook 'tooltip-hide)
3324 (add-hook 'tooltip-hook 'gud-tooltip-tips)
3325 (define-key global-map [mouse-movement] 'gud-tooltip-mouse-motion))
3326 (unless tooltip-mode (remove-hook 'pre-command-hook 'tooltip-hide)
3327 (remove-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3328 (remove-hook 'tooltip-hook 'gud-tooltip-tips)
3329 (define-key global-map [mouse-movement] 'ignore)))
3330 (gud-tooltip-activate-mouse-motions-if-enabled)
3331 (if (and
3332 gud-comint-buffer
3333 (buffer-name gud-comint-buffer); gud-comint-buffer might be kille
3334 (with-current-buffer gud-comint-buffer
3335 (memq gud-minor-mode '(gdbmi gdba))))
3336 (if gud-tooltip-mode
3337 (progn
3338 (dolist (buffer (buffer-list))
3339 (unless (eq buffer gud-comint-buffer)
3340 (with-current-buffer buffer
3341 (when (and (memq gud-minor-mode '(gdbmi gdba))
3343 (buffer-name))))
3344 (make-local-variable 'gdb-define-alist)
3345 (gdb-create-define-alist)
3346 (add-hook 'after-save-hook
3347 'gdb-create-define-alist nil t))))))
3348 (kill-local-variable 'gdb-define-alist)
3349 (remove-hook 'after-save-hook 'gdb-create-define-alist t))))
3351 ; This will only display data that comes in one chunk.
3352 ; Larger arrays (say 400 elements) are displayed in
3353 ; the tooltip incompletely and spill over into the gud buffer.
3354 ; Switching the process-filter creates timing problems and
3355 ; it may be difficult to do better. Using annotations as in
3356 ; gdb-ui.el gets round this problem.
3357 (defun gud-tooltip-process-output (process output)
3358 "Process debugger output and show it in a tooltip window."
3359 (set-process-filter process gud-tooltip-original-filter)
3360 (tooltip-show (tooltip-strip-prompt process output)
3361 (or gud-tooltip-echo-area tooltip-use-echo-area)))
3363 (defun gud-tooltip-print-command (expr)
3364 "Return a suitable command to print the expression EXPR.
3365 If GUD-TOOLTIP-DEREFERENCE is t, also prepend a `*' to EXPR."
3366 (when gud-tooltip-dereference
3367 (setq expr (concat "*" expr)))
3368 (case gud-minor-mode
3369 (gdba (concat "server print " expr))
3370 ((dbx gdbmi) (concat "print " expr))
3371 (xdb (concat "p " expr))
3372 (sdb (concat expr "/"))
3373 (perldb expr)))
3375 (defun gud-tooltip-tips (event)
3376 "Show tip for identifier or selection under the mouse.
3377 The mouse must either point at an identifier or inside a selected
3378 region for the tip window to be shown. If gud-tooltip-dereference is t,
3379 add a `*' in front of the printed expression. In the case of a C program
3380 controlled by GDB, show the associated #define directives when program is
3381 not executing.
3383 This function must return nil if it doesn't handle EVENT."
3384 (let (process)
3385 (when (and (eventp event)
3386 gud-tooltip-mode
3387 (boundp 'gud-comint-buffer)
3388 gud-comint-buffer
3389 (buffer-name gud-comint-buffer); gud-comint-buffer might be killed
3390 (setq process (get-buffer-process gud-comint-buffer))
3391 (posn-point (event-end event))
3392 (or (and (eq gud-minor-mode 'gdba) (not gdb-active-process))
3393 (progn (setq gud-tooltip-event event)
3394 (eval (cons 'and gud-tooltip-display)))))
3395 (let ((expr (tooltip-expr-to-print event)))
3396 (when expr
3397 (if (and (eq gud-minor-mode 'gdba)
3398 (not gdb-active-process))
3399 (progn
3400 (with-current-buffer
3401 (window-buffer (let ((mouse (mouse-position)))
3402 (window-at (cadr mouse)
3403 (cddr mouse))))
3404 (let ((define-elt (assoc expr gdb-define-alist)))
3405 (unless (null define-elt)
3406 (tooltip-show
3407 (cdr define-elt)
3408 (or gud-tooltip-echo-area tooltip-use-echo-area))
3409 expr))))
3410 (let ((cmd (gud-tooltip-print-command expr)))
3411 (when (and gud-tooltip-mode (eq gud-minor-mode 'gdb))
3412 (gud-tooltip-mode -1)
3414 so they have been disabled."))
3415 (unless (null cmd) ; CMD can be nil if unknown debugger
3416 (if (memq gud-minor-mode '(gdba gdbmi))
3417 (if gdb-macro-info
3418 (gdb-enqueue-input
3419 (list (concat
3421 `(lambda () (gdb-tooltip-print-1 ,expr))))
3422 (gdb-enqueue-input
3424 (setq gud-tooltip-original-filter (process-filter process))
3425 (set-process-filter process 'gud-tooltip-process-output)
3426 (gud-basic-call cmd))
3427 expr))))))))
3429 (provide 'gud)
3431 ;;; arch-tag: 6d990948-df65-461a-be39-1c7fb83ac4c4
3432 ;;; gud.el ends here