| blob | 714e06c3a18d4c24ca200561b3aae5d4d22b1730 |
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, 2006, 2007, 2008 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 3, 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:
56 ;; ======================================================================
57 ;; GUD commands must be visible in C buffers visited by GUD
60 "Grand Unified Debugger mode for gdb and other debuggers under Emacs.
61 Supported debuggers include gdb, sdb, dbx, xdb, perldb, pdb (Python), jdb."
67 "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 debugged program is running.
109 ;; Use existing Info buffer, if possible.
111 "Go to relevant Emacs info node."
142 ([tooltips] menu-item "Toggle GUD tooltips" gud-tooltip-mode
143 :enable (and (not emacs-basic-display)
144 (display-graphic-p)
145 (fboundp 'x-show-tip))
146 :visible (memq gud-minor-mode
147 '(gdbmi gdba dbx sdb xdb pdb))
148 :button (:toggle . gud-tooltip-mode))
149 ([refresh] "Refresh" . gud-refresh)
150 ([run] menu-item "Run" gud-run
151 :enable (not gud-running)
152 :visible (memq gud-minor-mode '(gdbmi gdb dbx jdb)))
153 ([go] menu-item (if gdb-active-process "Continue" "Run") gud-go
154 :visible (and (not gud-running)
155 (eq gud-minor-mode 'gdba)))
156 ([stop] menu-item "Stop" gud-stop-subjob
157 :visible (or (not (memq gud-minor-mode '(gdba pdb)))
158 (and gud-running
159 (eq gud-minor-mode 'gdba))))
160 ([until] menu-item "Continue to selection" gud-until
161 :enable (not gud-running)
162 :visible (and (memq gud-minor-mode '(gdbmi gdba gdb perldb))
163 (gud-tool-bar-item-visible-no-fringe)))
164 ([remove] menu-item "Remove Breakpoint" gud-remove
165 :enable (not gud-running)
166 :visible (gud-tool-bar-item-visible-no-fringe))
167 ([tbreak] menu-item "Temporary Breakpoint" gud-tbreak
168 :enable (not gud-running)
169 :visible (memq gud-minor-mode
170 '(gdbmi gdba gdb sdb xdb)))
171 ([break] menu-item "Set Breakpoint" gud-break
172 :enable (not gud-running)
173 :visible (gud-tool-bar-item-visible-no-fringe))
174 ([up] menu-item "Up Stack" gud-up
175 :enable (not gud-running)
176 :visible (memq gud-minor-mode
177 '(gdbmi gdba gdb dbx xdb jdb pdb)))
178 ([down] menu-item "Down Stack" gud-down
179 :enable (not gud-running)
180 :visible (memq gud-minor-mode
181 '(gdbmi gdba gdb dbx xdb jdb pdb)))
182 ([pp] menu-item "Print S-expression" gud-pp
183 :enable (and (not gud-running)
184 gdb-active-process)
185 :visible (and (string-equal
186 (buffer-local-value
187 'gud-target-name gud-comint-buffer) "emacs")
188 (eq gud-minor-mode 'gdba)))
189 ([print*] menu-item "Print Dereference" gud-pstar
190 :enable (not gud-running)
191 :visible (memq gud-minor-mode '(gdbmi gdba gdb)))
192 ([print] menu-item "Print Expression" gud-print
193 :enable (not gud-running))
194 ([watch] menu-item "Watch Expression" gud-watch
195 :enable (not gud-running)
196 :visible (memq gud-minor-mode '(gdbmi gdba)))
197 ([finish] menu-item "Finish Function" gud-finish
198 :enable (not gud-running)
199 :visible (memq gud-minor-mode
200 '(gdbmi gdba gdb xdb jdb pdb)))
201 ([stepi] menu-item "Step Instruction" gud-stepi
202 :enable (not gud-running)
203 :visible (memq gud-minor-mode '(gdbmi gdba gdb dbx)))
204 ([nexti] menu-item "Next Instruction" gud-nexti
205 :enable (not gud-running)
206 :visible (memq gud-minor-mode '(gdbmi gdba gdb dbx)))
207 ([step] menu-item "Step Line" gud-step
208 :enable (not gud-running))
209 ([next] menu-item "Next Line" gud-next
210 :enable (not gud-running))
211 ([cont] menu-item "Continue" gud-cont
212 :enable (not gud-running)
213 :visible (not (eq gud-minor-mode 'gdba))))
214 "Menu for `gud-mode'."
215 :name "Gud")
217 (easy-mmode-defmap gud-minor-mode-map
218 (append
219 `(([menu-bar debug] . ("Gud" . ,gud-menu-map)))
220 ;; Get tool bar like functionality from the menu bar on a text only
221 ;; terminal.
222 (unless window-system
223 `(([menu-bar down]
224 . (,(propertize "down" 'face 'font-lock-doc-face) . gud-down))
225 ([menu-bar up]
226 . (,(propertize "up" 'face 'font-lock-doc-face) . gud-up))
227 ([menu-bar finish]
228 . (,(propertize "finish" 'face 'font-lock-doc-face) . gud-finish))
229 ([menu-bar step]
230 . (,(propertize "step" 'face 'font-lock-doc-face) . gud-step))
231 ([menu-bar next]
232 . (,(propertize "next" 'face 'font-lock-doc-face) . gud-next))
233 ([menu-bar until] menu-item
234 ,(propertize "until" 'face 'font-lock-doc-face) gud-until
235 :visible (memq gud-minor-mode '(gdbmi gdba gdb perldb)))
236 ([menu-bar cont] menu-item
237 ,(propertize "cont" 'face 'font-lock-doc-face) gud-cont
238 :visible (not (eq gud-minor-mode 'gdba)))
239 ([menu-bar run] menu-item
240 ,(propertize "run" 'face 'font-lock-doc-face) gud-run
241 :visible (memq gud-minor-mode '(gdbmi gdb dbx jdb)))
242 ([menu-bar go] menu-item
243 ,(propertize " go " 'face 'font-lock-doc-face) gud-go
244 :visible (and (not gud-running)
245 (eq gud-minor-mode 'gdba)))
246 ([menu-bar stop] menu-item
247 ,(propertize "stop" 'face 'font-lock-doc-face) gud-stop-subjob
248 :visible (or gud-running
249 (not (eq gud-minor-mode 'gdba))))
250 ([menu-bar print]
251 . (,(propertize "print" 'face 'font-lock-doc-face) . gud-print))
252 ([menu-bar tools] . undefined)
253 ([menu-bar buffer] . undefined)
254 ([menu-bar options] . undefined)
255 ([menu-bar edit] . undefined)
256 ([menu-bar file] . undefined))))
257 "Map used in visited files.")
259 (let ((m (assq 'gud-minor-mode minor-mode-map-alist)))
260 (if m (setcdr m gud-minor-mode-map)
261 (push (cons 'gud-minor-mode gud-minor-mode-map) minor-mode-map-alist)))
263 (defvar gud-mode-map
264 ;; Will inherit from comint-mode via define-derived-mode.
265 (make-sparse-keymap)
266 "`gud-mode' keymap.")
268 (defvar gud-tool-bar-map
269 (if (display-graphic-p)
270 (let ((map (make-sparse-keymap)))
271 (dolist (x '((gud-break . "gud/break")
272 (gud-remove . "gud/remove")
273 (gud-print . "gud/print")
274 (gud-pstar . "gud/pstar")
275 (gud-pp . "gud/pp")
276 (gud-watch . "gud/watch")
277 (gud-run . "gud/run")
278 (gud-go . "gud/go")
279 (gud-stop-subjob . "gud/stop")
280 (gud-cont . "gud/cont")
281 (gud-until . "gud/until")
282 (gud-next . "gud/next")
283 (gud-step . "gud/step")
284 (gud-finish . "gud/finish")
285 (gud-nexti . "gud/nexti")
286 (gud-stepi . "gud/stepi")
287 (gud-up . "gud/up")
288 (gud-down . "gud/down")
289 (gud-goto-info . "info"))
290 map)
291 (tool-bar-local-item-from-menu
292 (car x) (cdr x) map gud-minor-mode-map)))))
294 (defun gud-file-name (f)
295 "Transform a relative file name to an absolute file name.
296 Uses `gud-<MINOR-MODE>-directories' to find the source files."
297 (if (file-exists-p f) (expand-file-name f)
298 (let ((directories (gud-val 'directories))
299 (result nil))
300 (while directories
301 (let ((path (expand-file-name f (car directories))))
302 (if (file-exists-p path)
303 (setq result path
304 directories nil)))
305 (setq directories (cdr directories)))
306 result)))
308 (defun gud-find-file (file)
309 ;; Don't get confused by double slashes in the name that comes from GDB.
310 (while (string-match "//+" file)
311 (setq file (replace-match "/" t t file)))
312 (let ((minor-mode gud-minor-mode)
313 (buf (funcall (or gud-find-file 'gud-file-name) file)))
314 (when (stringp buf)
315 (setq buf (and (file-readable-p buf) (find-file-noselect buf 'nowarn))))
316 (when buf
317 ;; Copy `gud-minor-mode' to the found buffer to turn on the menu.
318 (with-current-buffer buf
319 (set (make-local-variable 'gud-minor-mode) minor-mode)
320 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
321 (when (and gud-tooltip-mode
322 (memq gud-minor-mode '(gdbmi gdba)))
323 (make-local-variable 'gdb-define-alist)
324 (unless gdb-define-alist (gdb-create-define-alist))
325 (add-hook 'after-save-hook 'gdb-create-define-alist nil t))
326 (make-local-variable 'gud-keep-buffer))
327 buf)))
328 \f
329 ;; ======================================================================
330 ;; command definition
332 ;; This macro is used below to define some basic debugger interface commands.
333 ;; Of course you may use `gud-def' with any other debugger command, including
334 ;; user defined ones.
336 ;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
337 ;; which defines FUNC to send the command NAME to the debugger, gives
338 ;; it the docstring DOC, and binds that function to KEY in the GUD
339 ;; major mode. The function is also bound in the global keymap with the
340 ;; GUD prefix.
342 (defmacro gud-def (func cmd key &optional doc)
343 "Define FUNC to be a command sending STR and bound to KEY, with
344 optional doc string DOC. Certain %-escapes in the string arguments
345 are interpreted specially if present. These are:
347 %f -- Name (without directory) of current source file.
348 %F -- Name (without directory or extension) of current source file.
349 %d -- Directory of current source file.
350 %l -- Number of current source line.
351 %e -- Text of the C lvalue or function-call expression surrounding point.
352 %a -- Text of the hexadecimal address surrounding point.
353 %p -- Prefix argument to the command (if any) as a number.
354 %c -- Fully qualified class name derived from the expression
355 surrounding point (jdb only).
357 The `current' source file is the file of the current buffer (if
358 we're in a C file) or the source file current at the last break or
359 step (if we're in the GUD buffer).
360 The `current' line is that of the current buffer (if we're in a
361 source file) or the source line number at the last break or step (if
362 we're in the GUD buffer)."
363 `(progn
364 (defun ,func (arg)
365 ,@(if doc (list doc))
366 (interactive "p")
367 (if (not gud-running)
368 ,(if (stringp cmd)
369 `(gud-call ,cmd arg)
370 cmd)))
371 ,(if key `(local-set-key ,(concat "\C-c" key) ',func))
372 ,(if key `(global-set-key (vconcat gud-key-prefix ,key) ',func))))
374 ;; Where gud-display-frame should put the debugging arrow; a cons of
375 ;; (filename . line-number). This is set by the marker-filter, which scans
376 ;; the debugger's output for indications of the current program counter.
377 (defvar gud-last-frame nil)
379 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
380 ;; the last frame, even if it's been called before and gud-last-frame has
381 ;; been set to nil.
382 (defvar gud-last-last-frame nil)
384 ;; All debugger-specific information is collected here.
385 ;; Here's how it works, in case you ever need to add a debugger to the mode.
386 ;;
387 ;; Each entry must define the following at startup:
388 ;;
389 ;;<name>
390 ;; comint-prompt-regexp
391 ;; gud-<name>-massage-args
392 ;; gud-<name>-marker-filter
393 ;; gud-<name>-find-file
394 ;;
395 ;; The job of the massage-args method is to modify the given list of
396 ;; debugger arguments before running the debugger.
397 ;;
398 ;; The job of the marker-filter method is to detect file/line markers in
399 ;; strings and set the global gud-last-frame to indicate what display
400 ;; action (if any) should be triggered by the marker. Note that only
401 ;; whatever the method *returns* is displayed in the buffer; thus, you
402 ;; can filter the debugger's output, interpreting some and passing on
403 ;; the rest.
404 ;;
405 ;; The job of the find-file method is to visit and return the buffer indicated
406 ;; by the car of gud-tag-frame. This may be a file name, a tag name, or
407 ;; something else.
408 \f
409 ;; ======================================================================
410 ;; speedbar support functions and variables.
411 (eval-when-compile (require 'speedbar)) ;For speedbar-with-attached-buffer.
413 (defvar gud-last-speedbar-stackframe nil
414 "Description of the currently displayed GUD stack.
415 t means that there is no stack, and we are in display-file mode.")
417 (defvar gud-speedbar-key-map nil
418 "Keymap used when in the buffers display mode.")
420 (defun gud-speedbar-item-info ()
421 "Display the data type of the watch expression element."
422 (let ((var (nth (- (line-number-at-pos (point)) 2) gdb-var-list)))
423 (if (nth 6 var)
424 (speedbar-message "%s: %s" (nth 6 var) (nth 3 var))
425 (speedbar-message "%s" (nth 3 var)))))
427 (defun gud-install-speedbar-variables ()
428 "Install those variables used by speedbar to enhance gud/gdb."
429 (if gud-speedbar-key-map
430 nil
431 (setq gud-speedbar-key-map (speedbar-make-specialized-keymap))
433 (define-key gud-speedbar-key-map "j" 'speedbar-edit-line)
434 (define-key gud-speedbar-key-map "e" 'speedbar-edit-line)
435 (define-key gud-speedbar-key-map "\C-m" 'speedbar-edit-line)
436 (define-key gud-speedbar-key-map " " 'speedbar-toggle-line-expansion)
437 (define-key gud-speedbar-key-map "D" 'gdb-var-delete)
438 (define-key gud-speedbar-key-map "p" 'gud-pp))
440 (speedbar-add-expansion-list '("GUD" gud-speedbar-menu-items
441 gud-speedbar-key-map
442 gud-expansion-speedbar-buttons))
444 (add-to-list
445 'speedbar-mode-functions-list
446 '("GUD" (speedbar-item-info . gud-speedbar-item-info)
447 (speedbar-line-directory . ignore))))
449 (defvar gud-speedbar-menu-items
450 '(["Jump to stack frame" speedbar-edit-line
451 :visible (not (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
452 '(gdbmi gdba)))]
453 ["Edit value" speedbar-edit-line
454 :visible (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
455 '(gdbmi gdba))]
456 ["Delete expression" gdb-var-delete
457 :visible (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
458 '(gdbmi gdba))]
459 ["Auto raise frame" gdb-speedbar-auto-raise
460 :style toggle :selected gdb-speedbar-auto-raise
461 :visible (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
462 '(gdbmi gdba))]
463 ("Output Format"
464 :visible (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
465 '(gdbmi gdba))
466 ["Binary" (gdb-var-set-format "binary") t]
467 ["Natural" (gdb-var-set-format "natural") t]
468 ["Hexadecimal" (gdb-var-set-format "hexadecimal") t]))
469 "Additional menu items to add to the speedbar frame.")
471 ;; Make sure our special speedbar mode is loaded
472 (if (featurep 'speedbar)
473 (gud-install-speedbar-variables)
474 (add-hook 'speedbar-load-hook 'gud-install-speedbar-variables))
476 (defun gud-expansion-speedbar-buttons (directory zero)
477 "Wrapper for call to speedbar-add-expansion-list. DIRECTORY and
478 ZERO are not used, but are required by the caller."
479 (gud-speedbar-buttons gud-comint-buffer))
481 (defun gud-speedbar-buttons (buffer)
482 "Create a speedbar display based on the current state of GUD.
483 If the GUD BUFFER is not running a supported debugger, then turn
484 off the specialized speedbar mode. BUFFER is not used, but are
485 required by the caller."
486 (when (and gud-comint-buffer
487 ;; gud-comint-buffer might be killed
488 (buffer-name gud-comint-buffer))
489 (let* ((minor-mode (with-current-buffer buffer gud-minor-mode))
490 (window (get-buffer-window (current-buffer) 0))
491 (start (window-start window))
492 (p (window-point window)))
493 (cond
494 ((memq minor-mode '(gdbmi gdba))
495 (erase-buffer)
497 (if gdb-speedbar-auto-raise
498 (raise-frame speedbar-frame))
499 (let ((var-list gdb-var-list) parent)
500 (while var-list
501 (let* (char (depth 0) (start 0) (var (car var-list))
502 (varnum (car var)) (expr (nth 1 var))
503 (type (if (nth 3 var) (nth 3 var) " "))
504 (value (nth 4 var)) (status (nth 5 var)))
505 (put-text-property
506 0 (length expr) 'face font-lock-variable-name-face expr)
507 (put-text-property
508 0 (length type) 'face font-lock-type-face type)
510 (setq depth (1+ depth)
511 start (1+ (match-beginning 0))))
512 (if (eq depth 0) (setq parent nil))
513 (if (or (equal (nth 2 var) "0")
514 (and (equal (nth 2 var) "1")
516 (speedbar-make-tag-line
517 'bracket ?? nil nil
519 (if (or parent (eq status 'out-of-scope))
520 nil 'gdb-edit-value)
521 nil
522 (if gdb-show-changed-values
523 (or parent (case status
524 (changed 'font-lock-warning-face)
525 (out-of-scope 'shadow)
526 (t t)))
527 t)
528 depth)
529 (if (eq status 'out-of-scope) (setq parent 'shadow))
530 (if (and (nth 1 var-list)
532 (car (nth 1 var-list))))
533 (setq char ?-)
534 (setq char ?+))
536 (speedbar-make-tag-line
537 'bracket char
538 'gdb-speedbar-expand-node varnum
540 (if (or parent (eq status 'out-of-scope))
541 nil 'gdb-edit-value)
542 nil
543 (if gdb-show-changed-values
544 (or parent (case status
545 (changed 'font-lock-warning-face)
546 (out-of-scope 'shadow)
547 (t t)))
548 t)
549 depth)
550 (speedbar-make-tag-line
551 'bracket char
552 'gdb-speedbar-expand-node varnum
554 nil nil
555 (if (and (or parent status) gdb-show-changed-values)
556 'shadow t)
557 depth))))
558 (setq var-list (cdr var-list)))))
559 (t (unless (and (save-excursion
560 (goto-char (point-min))
561 (looking-at "Current Stack:"))
562 (equal gud-last-last-frame gud-last-speedbar-stackframe))
563 (let ((gud-frame-list
564 (cond ((eq minor-mode 'gdb)
565 (gud-gdb-get-stackframe buffer))
566 ;; Add more debuggers here!
567 (t (speedbar-remove-localized-speedbar-support buffer)
568 nil))))
569 (erase-buffer)
570 (if (not gud-frame-list)
573 (dolist (frame gud-frame-list)
575 (if (= (length frame) 2)
576 (progn
577 (speedbar-insert-button (car frame)
578 'speedbar-directory-face
579 nil nil nil t))
580 (speedbar-insert-button
581 (car frame)
582 'speedbar-file-face
583 'speedbar-highlight-face
584 (cond ((memq minor-mode '(gdbmi gdba gdb))
585 'gud-gdb-goto-stackframe)
586 (t (error "Should never be here")))
587 frame t))))
588 (setq gud-last-speedbar-stackframe gud-last-last-frame))))
589 (set-window-start window start)
590 (set-window-point window p))))
592 \f
593 ;; ======================================================================
594 ;; gdb functions
596 ;; History of argument lists passed to gdb.
597 (defvar gud-gdb-history nil)
599 (defcustom gud-gud-gdb-command-name "gdb --fullname"
600 "Default command to run an executable under GDB in text command mode.
602 :type 'string
603 :group 'gud)
605 (defvar gud-gdb-marker-regexp
606 ;; This used to use path-separator instead of ":";
607 ;; however, we found that on both Windows 32 and MSDOS
608 ;; a colon is correct here.
612 ;; There's no guarantee that Emacs will hand the filter the entire
613 ;; marker at once; it could be broken up across several strings. We
614 ;; might even receive a big chunk with several markers in it. If we
615 ;; receive a chunk of text which looks like it might contain the
616 ;; beginning of a marker, we save it here between calls to the
617 ;; filter.
618 (defvar gud-marker-acc "")
619 (make-variable-buffer-local 'gud-marker-acc)
621 (defun gud-gdb-marker-filter (string)
622 (setq gud-marker-acc (concat gud-marker-acc string))
623 (let ((output ""))
625 ;; Process all the complete markers in this chunk.
626 (while (string-match gud-gdb-marker-regexp gud-marker-acc)
627 (setq
629 ;; Extract the frame position from the marker.
630 gud-last-frame (cons (match-string 1 gud-marker-acc)
631 (string-to-number (match-string 2 gud-marker-acc)))
633 ;; Append any text before the marker to the output we're going
634 ;; to return - we don't include the marker in this text.
635 output (concat output
636 (substring gud-marker-acc 0 (match-beginning 0)))
638 ;; Set the accumulator to the remaining text.
639 gud-marker-acc (substring gud-marker-acc (match-end 0))))
641 ;; Check for annotations and change gud-minor-mode to 'gdba if
642 ;; they are found.
644 (let ((match (match-string 1 gud-marker-acc)))
646 (setq
647 ;; Append any text before the marker to the output we're going
648 ;; to return - we don't include the marker in this text.
649 output (concat output
650 (substring gud-marker-acc 0 (match-beginning 0)))
652 ;; Set the accumulator to the remaining text.
654 gud-marker-acc (substring gud-marker-acc (match-end 0)))))
656 ;; Does the remaining text look like it might end with the
657 ;; beginning of another marker? If it does, then keep it in
658 ;; gud-marker-acc until we receive the rest of it. Since we
659 ;; know the full marker regexp above failed, it's pretty simple to
660 ;; test for marker starts.
662 (progn
663 ;; Everything before the potential marker start can be output.
664 (setq output (concat output (substring gud-marker-acc
665 0 (match-beginning 0))))
667 ;; Everything after, we save, to combine with later input.
668 (setq gud-marker-acc
669 (substring gud-marker-acc (match-beginning 0))))
671 (setq output (concat output gud-marker-acc)
672 gud-marker-acc ""))
674 output))
676 (easy-mmode-defmap gud-minibuffer-local-map
677 '(("\C-i" . comint-dynamic-complete-filename))
678 "Keymap for minibuffer prompting of gud startup command."
679 :inherit minibuffer-local-map)
681 (defun gud-query-cmdline (minor-mode &optional init)
682 (let* ((hist-sym (gud-symbol 'history nil minor-mode))
683 (cmd-name (gud-val 'command-name minor-mode)))
684 (unless (boundp hist-sym) (set hist-sym nil))
685 (read-from-minibuffer
686 (format "Run %s (like this): " minor-mode)
687 (or (car-safe (symbol-value hist-sym))
688 (concat (or cmd-name (symbol-name minor-mode))
689 " "
690 (or init
691 (let ((file nil))
692 (dolist (f (directory-files default-directory) file)
693 (if (and (file-executable-p f)
694 (not (file-directory-p f))
695 (or (not file)
696 (file-newer-than-file-p f file)))
697 (setq file f)))))))
698 gud-minibuffer-local-map nil
699 hist-sym)))
701 (defvar gdb-first-prompt t)
703 (defvar gud-filter-pending-text nil
704 "Non-nil means this is text that has been saved for later in `gud-filter'.")
706 ;; The old gdb command (text command mode). The new one is in gdb-ui.el.
707 ;;;###autoload
708 (defun gud-gdb (command-line)
709 "Run gdb on program FILE in buffer *gud-FILE*.
710 The directory containing FILE becomes the initial working
711 directory and source-file directory for your debugger."
712 (interactive (list (gud-query-cmdline 'gud-gdb)))
714 (when (and gud-comint-buffer
715 (buffer-name gud-comint-buffer)
716 (get-buffer-process gud-comint-buffer)
717 (with-current-buffer gud-comint-buffer (eq gud-minor-mode 'gdba)))
718 (gdb-restore-windows)
719 (error
720 "Multiple debugging requires restarting in text command mode"))
722 (gud-common-init command-line nil 'gud-gdb-marker-filter)
723 (set (make-local-variable 'gud-minor-mode) 'gdb)
725 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
726 (gud-def gud-tbreak "tbreak %f:%l" "\C-t"
727 "Set temporary breakpoint at current line.")
728 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
729 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
730 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
731 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
732 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
733 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
734 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
735 (gud-def gud-jump
736 (progn (gud-call "tbreak %f:%l") (gud-call "jump %f:%l"))
737 "\C-j" "Set execution address to current line.")
739 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
740 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
741 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
742 (gud-def gud-pstar "print* %e" nil
743 "Evaluate C dereferenced pointer expression at point.")
745 ;; For debugging Emacs only.
746 (gud-def gud-pv "pv1 %e" "\C-v" "Print the value of the lisp variable.")
748 (gud-def gud-until "until %l" "\C-u" "Continue to current line.")
749 (gud-def gud-run "run" nil "Run the program.")
751 (local-set-key "\C-i" 'gud-gdb-complete-command)
752 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
753 (setq paragraph-start comint-prompt-regexp)
754 (setq gdb-first-prompt t)
755 (setq gud-running nil)
756 (setq gdb-ready nil)
757 (setq gud-filter-pending-text nil)
758 (run-hooks 'gud-gdb-mode-hook))
760 ;; One of the nice features of GDB is its impressive support for
761 ;; context-sensitive command completion. We preserve that feature
762 ;; in the GUD buffer by using a GDB command designed just for Emacs.
764 ;; The completion process filter indicates when it is finished.
765 (defvar gud-gdb-fetch-lines-in-progress)
767 ;; Since output may arrive in fragments we accumulate partials strings here.
768 (defvar gud-gdb-fetch-lines-string)
770 ;; We need to know how much of the completion to chop off.
771 (defvar gud-gdb-fetch-lines-break)
773 ;; The completion list is constructed by the process filter.
774 (defvar gud-gdb-fetched-lines)
776 (defun gud-gdb-complete-command (&optional command a b)
777 "Perform completion on the GDB command preceding point.
778 This is implemented using the GDB `complete' command which isn't
779 available with older versions of GDB."
780 (interactive)
781 (if command
782 ;; Used by gud-watch in mini-buffer.
783 (setq command (concat "p " command))
784 ;; Used in GUD buffer.
785 (let ((end (point)))
786 (setq command (buffer-substring (comint-line-beginning-position) end))))
787 (let* ((command-word
788 ;; Find the word break. This match will always succeed.
790 (substring command (match-beginning 2))))
791 (complete-list
792 (gud-gdb-run-command-fetch-lines (concat "complete " command)
793 (current-buffer)
794 ;; From string-match above.
795 (match-beginning 2))))
796 ;; Protect against old versions of GDB.
797 (and complete-list
799 (error "This version of GDB doesn't support the `complete' command"))
800 ;; Sort the list like readline.
801 (setq complete-list (sort complete-list (function string-lessp)))
802 ;; Remove duplicates.
803 (let ((first complete-list)
804 (second (cdr complete-list)))
805 (while second
806 (if (string-equal (car first) (car second))
807 (setcdr first (setq second (cdr second)))
808 (setq first second
809 second (cdr second)))))
810 ;; Add a trailing single quote if there is a unique completion
811 ;; and it contains an odd number of unquoted single quotes.
812 (and (= (length complete-list) 1)
813 (let ((str (car complete-list))
814 (pos 0)
815 (count 0))
817 (setq count (1+ count)
818 pos (match-end 0)))
819 (and (= (mod count 2) 1)
820 (setq complete-list (list (concat str "'"))))))
821 ;; Let comint handle the rest.
822 (comint-dynamic-simple-complete command-word complete-list)))
824 ;; The completion process filter is installed temporarily to slurp the
825 ;; output of GDB up to the next prompt and build the completion list.
826 (defun gud-gdb-fetch-lines-filter (string filter)
827 "Filter used to read the list of lines output by a command.
828 STRING is the output to filter.
829 It is passed through FILTER before we look at it."
830 (setq string (funcall filter string))
831 (setq string (concat gud-gdb-fetch-lines-string string))
833 (push (substring string gud-gdb-fetch-lines-break (match-beginning 0))
834 gud-gdb-fetched-lines)
835 (setq string (substring string (match-end 0))))
836 (if (string-match comint-prompt-regexp string)
837 (progn
838 (setq gud-gdb-fetch-lines-in-progress nil)
839 string)
840 (progn
841 (setq gud-gdb-fetch-lines-string string)
842 "")))
844 ;; gdb speedbar functions
846 (defun gud-gdb-goto-stackframe (text token indent)
847 "Goto the stackframe described by TEXT, TOKEN, and INDENT."
848 (speedbar-with-attached-buffer
849 (gud-basic-call (concat "server frame " (nth 1 token)))
850 (sit-for 1)))
852 (defvar gud-gdb-fetched-stack-frame nil
853 "Stack frames we are fetching from GDB.")
855 ;(defun gud-gdb-get-scope-data (text token indent)
856 ; ;; checkdoc-params: (indent)
857 ; "Fetch data associated with a stack frame, and expand/contract it.
858 ;Data to do this is retrieved from TEXT and TOKEN."
859 ; (let ((args nil) (scope nil))
860 ; (gud-gdb-run-command-fetch-lines "info args")
861 ;
862 ; (gud-gdb-run-command-fetch-lines "info local")
863 ;
864 ; ))
866 (defun gud-gdb-get-stackframe (buffer)
867 "Extract the current stack frame out of the GUD GDB BUFFER."
868 (let ((newlst nil)
869 (fetched-stack-frame-list
870 (gud-gdb-run-command-fetch-lines "server backtrace" buffer)))
871 (if (and (car fetched-stack-frame-list)
872 (string-match "No stack" (car fetched-stack-frame-list)))
873 ;; Go into some other mode???
874 nil
875 (dolist (e fetched-stack-frame-list)
876 (let ((name nil) (num nil))
877 (if (not (or
880 (if (not (string-match
882 nil
883 (setcar newlst
884 (list (nth 0 (car newlst))
885 (nth 1 (car newlst))
886 (match-string 1 e)
887 (match-string 2 e))))
888 (setq num (match-string 1 e)
889 name (match-string 2 e))
890 (setq newlst
891 (cons
892 (if (string-match
894 (list name num (match-string 1 e)
895 (match-string 2 e))
896 (list name num))
897 newlst)))))
898 (nreverse newlst))))
900 ;(defun gud-gdb-selected-frame-info (buffer)
901 ; "Learn GDB information for the currently selected stack frame in BUFFER."
902 ; )
904 (defun gud-gdb-run-command-fetch-lines (command buffer &optional skip)
905 "Run COMMAND, and return the list of lines it outputs.
906 BUFFER is the current buffer which may be the GUD buffer in which to run.
907 SKIP is the number of chars to skip on each lines, it defaults to 0."
908 (with-current-buffer gud-comint-buffer
909 (if (and (eq gud-comint-buffer buffer)
910 (save-excursion
911 (goto-char (point-max))
912 (forward-line 0)
913 (not (looking-at comint-prompt-regexp))))
914 nil
915 ;; Much of this copied from GDB complete, but I'm grabbing the stack
916 ;; frame instead.
917 (let ((gud-gdb-fetch-lines-in-progress t)
918 (gud-gdb-fetched-lines nil)
919 (gud-gdb-fetch-lines-string nil)
920 (gud-gdb-fetch-lines-break (or skip 0))
921 (gud-marker-filter
922 `(lambda (string)
923 (gud-gdb-fetch-lines-filter string ',gud-marker-filter))))
924 ;; Issue the command to GDB.
925 (gud-basic-call command)
926 ;; Slurp the output.
927 (while gud-gdb-fetch-lines-in-progress
928 (accept-process-output (get-buffer-process gud-comint-buffer)))
929 (nreverse gud-gdb-fetched-lines)))))
931 \f
932 ;; ======================================================================
933 ;; sdb functions
935 ;; History of argument lists passed to sdb.
936 (defvar gud-sdb-history nil)
938 (defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
939 "If nil, we're on a System V Release 4 and don't need the tags hack.")
941 (defvar gud-sdb-lastfile nil)
943 (defun gud-sdb-marker-filter (string)
944 (setq gud-marker-acc
945 (if gud-marker-acc (concat gud-marker-acc string) string))
946 (let (start)
947 ;; Process all complete markers in this chunk
948 (while
949 (cond
950 ;; System V Release 3.2 uses this format
952 gud-marker-acc start)
953 (setq gud-last-frame
954 (cons (match-string 3 gud-marker-acc)
955 (string-to-number (match-string 4 gud-marker-acc)))))
956 ;; System V Release 4.0 quite often clumps two lines together
957 ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
958 gud-marker-acc start)
959 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc))
960 (setq gud-last-frame
961 (cons gud-sdb-lastfile
962 (string-to-number (match-string 3 gud-marker-acc)))))
963 ;; System V Release 4.0
965 gud-marker-acc start)
966 (setq gud-sdb-lastfile (match-string 2 gud-marker-acc)))
968 gud-marker-acc start))
969 (setq gud-last-frame
970 (cons gud-sdb-lastfile
971 (string-to-number (match-string 1 gud-marker-acc)))))
972 (t
973 (setq gud-sdb-lastfile nil)))
974 (setq start (match-end 0)))
976 ;; Search for the last incomplete line in this chunk
978 (setq start (match-end 0)))
980 ;; If we have an incomplete line, store it in gud-marker-acc.
981 (setq gud-marker-acc (substring gud-marker-acc (or start 0))))
982 string)
984 (defun gud-sdb-find-file (f)
985 (if gud-sdb-needs-tags (find-tag-noselect f) (find-file-noselect f)))
987 ;;;###autoload
988 (defun sdb (command-line)
989 "Run sdb on program FILE in buffer *gud-FILE*.
990 The directory containing FILE becomes the initial working directory
991 and source-file directory for your debugger."
992 (interactive (list (gud-query-cmdline 'sdb)))
994 (if gud-sdb-needs-tags (require 'etags))
995 (if (and gud-sdb-needs-tags
996 (not (and (boundp 'tags-file-name)
997 (stringp tags-file-name)
998 (file-exists-p tags-file-name))))
999 (error "The sdb support requires a valid tags table to work"))
1001 (gud-common-init command-line nil 'gud-sdb-marker-filter 'gud-sdb-find-file)
1002 (set (make-local-variable 'gud-minor-mode) 'sdb)
1004 (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
1005 (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
1006 (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
1007 (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
1008 (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
1009 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1010 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1011 (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
1014 (setq paragraph-start comint-prompt-regexp)
1015 (run-hooks 'sdb-mode-hook)
1016 )
1017 \f
1018 ;; ======================================================================
1019 ;; dbx functions
1021 ;; History of argument lists passed to dbx.
1022 (defvar gud-dbx-history nil)
1024 (defcustom gud-dbx-directories nil
1025 "*A list of directories that dbx should search for source code.
1026 If nil, only source files in the program directory
1027 will be known to dbx.
1029 The file names should be absolute, or relative to the directory
1030 containing the executable being debugged."
1031 :type '(choice (const :tag "Current Directory" nil)
1032 (repeat :value ("")
1033 directory))
1034 :group 'gud)
1036 (defun gud-dbx-massage-args (file args)
1037 (nconc (let ((directories gud-dbx-directories)
1038 (result nil))
1039 (while directories
1040 (setq result (cons (car directories) (cons "-I" result)))
1041 (setq directories (cdr directories)))
1042 (nreverse result))
1043 args))
1045 (defun gud-dbx-marker-filter (string)
1046 (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
1048 (let (start)
1049 ;; Process all complete markers in this chunk.
1050 (while (or (string-match
1052 gud-marker-acc start)
1053 (string-match
1055 gud-marker-acc start))
1056 (setq gud-last-frame
1057 (cons (match-string 2 gud-marker-acc)
1058 (string-to-number (match-string 1 gud-marker-acc)))
1059 start (match-end 0)))
1061 ;; Search for the last incomplete line in this chunk
1063 (setq start (match-end 0)))
1065 ;; If the incomplete line APPEARS to begin with another marker, keep it
1066 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1067 ;; unnecessary concat during the next call.
1068 (setq gud-marker-acc
1070 (substring gud-marker-acc (match-beginning 0))
1071 nil)))
1072 string)
1074 ;; Functions for Mips-style dbx. Given the option `-emacs', documented in
1075 ;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
1076 (defvar gud-mips-p
1077 (or (string-match "^mips-[^-]*-ultrix" system-configuration)
1078 ;; We haven't tested gud on this system:
1079 (string-match "^mips-[^-]*-riscos" system-configuration)
1080 ;; It's documented on OSF/1.3
1081 (string-match "^mips-[^-]*-osf1" system-configuration)
1082 (string-match "^alpha[^-]*-[^-]*-osf" system-configuration))
1083 "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
1085 (defvar gud-dbx-command-name
1086 (concat "dbx" (if gud-mips-p " -emacs")))
1088 ;; This is just like the gdb one except for the regexps since we need to cope
1089 ;; with an optional breakpoint number in [] before the ^Z^Z
1090 (defun gud-mipsdbx-marker-filter (string)
1091 (setq gud-marker-acc (concat gud-marker-acc string))
1092 (let ((output ""))
1094 ;; Process all the complete markers in this chunk.
1095 (while (string-match
1096 ;; This is like th gdb marker but with an optional
1097 ;; leading break point number like `[1] '
1099 gud-marker-acc)
1100 (setq
1102 ;; Extract the frame position from the marker.
1103 gud-last-frame
1104 (cons (match-string 1 gud-marker-acc)
1105 (string-to-number (match-string 2 gud-marker-acc)))
1107 ;; Append any text before the marker to the output we're going
1108 ;; to return - we don't include the marker in this text.
1109 output (concat output
1110 (substring gud-marker-acc 0 (match-beginning 0)))
1112 ;; Set the accumulator to the remaining text.
1113 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1115 ;; Does the remaining text look like it might end with the
1116 ;; beginning of another marker? If it does, then keep it in
1117 ;; gud-marker-acc until we receive the rest of it. Since we
1118 ;; know the full marker regexp above failed, it's pretty simple to
1119 ;; test for marker starts.
1121 (progn
1122 ;; Everything before the potential marker start can be output.
1123 (setq output (concat output (substring gud-marker-acc
1124 0 (match-beginning 0))))
1126 ;; Everything after, we save, to combine with later input.
1127 (setq gud-marker-acc
1128 (substring gud-marker-acc (match-beginning 0))))
1130 (setq output (concat output gud-marker-acc)
1131 gud-marker-acc ""))
1133 output))
1135 ;; The dbx in IRIX is a pain. It doesn't print the file name when
1136 ;; stopping at a breakpoint (but you do get it from the `up' and
1137 ;; `down' commands...). The only way to extract the information seems
1138 ;; to be with a `file' command, although the current line number is
1139 ;; available in $curline. Thus we have to look for output which
1140 ;; appears to indicate a breakpoint. Then we prod the dbx sub-process
1141 ;; to output the information we want with a combination of the
1142 ;; `printf' and `file' commands as a pseudo marker which we can
1143 ;; recognise next time through the marker-filter. This would be like
1144 ;; the gdb marker but you can't get the file name without a newline...
1145 ;; Note that gud-remove won't work since Irix dbx expects a breakpoint
1146 ;; number rather than a line number etc. Maybe this could be made to
1147 ;; work by listing all the breakpoints and picking the one(s) with the
1148 ;; correct line number, but life's too short.
1149 ;; d.love@dl.ac.uk (Dave Love) can be blamed for this
1151 (defvar gud-irix-p
1152 (and (string-match "^mips-[^-]*-irix" system-configuration)
1154 "Non-nil to assume the interface appropriate for IRIX dbx.
1155 This works in IRIX 4, 5 and 6, but `gud-dbx-use-stopformat-p' provides
1156 a better solution in 6.1 upwards.")
1157 (defvar gud-dbx-use-stopformat-p
1159 "Non-nil to use the dbx feature present at least from Irix 6.1
1160 whereby $stopformat=1 produces an output format compatiable with
1161 `gud-dbx-marker-filter'.")
1162 ;; [Irix dbx seems to be a moving target. The dbx output changed
1163 ;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
1164 ;; the output from `up' is no longer spotted by gud (and it's probably
1165 ;; not distinctive enough to try to match it -- use C-<, C->
1166 ;; exclusively) . For 5.3 and 6.0, the $curline variable changed to
1167 ;; `long long'(why?!), so the printf stuff needed changing. The line
1168 ;; number was cast to `long' as a compromise between the new `long
1169 ;; long' and the original `int'. This is reported not to work in 6.2,
1170 ;; so it's changed back to int -- don't make your sources too long.
1171 ;; From Irix6.1 (but not 6.0?) dbx supports an undocumented feature
1172 ;; whereby `set $stopformat=1' reportedly produces output compatible
1173 ;; with `gud-dbx-marker-filter', which we prefer.
1175 ;; The process filter is also somewhat
1176 ;; unreliable, sometimes not spotting the markers; I don't know
1177 ;; whether there's anything that can be done about that. It would be
1178 ;; much better if SGI could be persuaded to (re?)instate the MIPS
1179 ;; -emacs flag for gdb-like output (which ought to be possible as most
1180 ;; of the communication I've had over it has been from sgi.com).]
1182 ;; this filter is influenced by the xdb one rather than the gdb one
1183 (defun gud-irixdbx-marker-filter (string)
1184 (let (result (case-fold-search nil))
1185 (if (or (string-match comint-prompt-regexp string)
1187 (setq result (concat gud-marker-acc string)
1188 gud-marker-acc "")
1189 (setq gud-marker-acc (concat gud-marker-acc string)))
1190 (if result
1191 (cond
1192 ;; look for breakpoint or signal indication e.g.:
1193 ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
1194 ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
1195 ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
1196 ((string-match
1198 result)
1199 ;; prod dbx into printing out the line number and file
1200 ;; name in a form we can grok as below
1201 (process-send-string (get-buffer-process gud-comint-buffer)
1203 ;; look for result of, say, "up" e.g.:
1204 ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
1205 ;; (this will also catch one of the lines printed by "where")
1206 ((string-match
1208 result)
1209 (let ((file (match-string 1 result)))
1210 (if (file-exists-p file)
1211 (setq gud-last-frame
1212 (cons (match-string 1 result)
1213 (string-to-number (match-string 2 result))))))
1214 result)
1215 ((string-match ; kluged-up marker as above
1217 (let ((file (gud-file-name (match-string 2 result))))
1218 (if (and file (file-exists-p file))
1219 (setq gud-last-frame
1220 (cons file
1221 (string-to-number (match-string 1 result))))))
1222 (setq result (substring result 0 (match-beginning 0))))))
1223 (or result "")))
1225 (defvar gud-dgux-p (string-match "-dgux" system-configuration)
1226 "Non-nil means to assume the interface approriate for DG/UX dbx.
1227 This was tested using R4.11.")
1229 ;; There are a couple of differences between DG's dbx output and normal
1230 ;; dbx output which make it nontrivial to integrate this into the
1231 ;; standard dbx-marker-filter (mainly, there are a different number of
1232 ;; backreferences). The markers look like:
1233 ;;
1234 ;; (0) Stopped at line 10, routine main(argc=1, argv=0xeffff0e0), file t.c
1235 ;;
1236 ;; from breakpoints (the `(0)' there isn't constant, it's the breakpoint
1237 ;; number), and
1238 ;;
1239 ;; Stopped at line 13, routine main(argc=1, argv=0xeffff0e0), file t.c
1240 ;;
1241 ;; from signals and
1242 ;;
1243 ;; Frame 21, line 974, routine command_loop(), file keyboard.c
1244 ;;
1245 ;; from up/down/where.
1247 (defun gud-dguxdbx-marker-filter (string)
1248 (setq gud-marker-acc (if gud-marker-acc
1249 (concat gud-marker-acc string)
1250 string))
1253 start)
1254 ;; Process all complete markers in this chunk.
1255 (while (string-match re gud-marker-acc start)
1256 (setq gud-last-frame
1257 (cons (match-string 4 gud-marker-acc)
1258 (string-to-number (match-string 3 gud-marker-acc)))
1259 start (match-end 0)))
1261 ;; Search for the last incomplete line in this chunk
1263 (setq start (match-end 0)))
1265 ;; If the incomplete line APPEARS to begin with another marker, keep it
1266 ;; in the accumulator. Otherwise, clear the accumulator to avoid an
1267 ;; unnecessary concat during the next call.
1268 (setq gud-marker-acc
1270 (substring gud-marker-acc (match-beginning 0))
1271 nil)))
1272 string)
1274 ;;;###autoload
1275 (defun dbx (command-line)
1276 "Run dbx on program FILE in buffer *gud-FILE*.
1277 The directory containing FILE becomes the initial working directory
1278 and source-file directory for your debugger."
1279 (interactive (list (gud-query-cmdline 'dbx)))
1281 (cond
1282 (gud-mips-p
1283 (gud-common-init command-line nil 'gud-mipsdbx-marker-filter))
1284 (gud-irix-p
1285 (gud-common-init command-line 'gud-dbx-massage-args
1286 'gud-irixdbx-marker-filter))
1287 (gud-dgux-p
1288 (gud-common-init command-line 'gud-dbx-massage-args
1289 'gud-dguxdbx-marker-filter))
1290 (t
1291 (gud-common-init command-line 'gud-dbx-massage-args
1292 'gud-dbx-marker-filter)))
1294 (set (make-local-variable 'gud-minor-mode) 'dbx)
1296 (cond
1297 (gud-mips-p
1298 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1299 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1301 "\C-b" "Set breakpoint at current line.")
1302 (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
1303 (gud-irix-p
1305 "\C-b" "Set breakpoint at current line.")
1306 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1308 "<" "Up (numeric arg) stack frames.")
1310 ">" "Down (numeric arg) stack frames.")
1311 ;; Make dbx give out the source location info that we need.
1312 (process-send-string (get-buffer-process gud-comint-buffer)
1314 (t
1315 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1316 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1318 "\C-b" "Set breakpoint at current line.")
1319 (if gud-dbx-use-stopformat-p
1320 (process-send-string (get-buffer-process gud-comint-buffer)
1323 (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
1324 (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
1325 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
1326 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
1327 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
1328 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
1329 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
1330 (gud-def gud-run "run" nil "Run the program.")
1333 (setq paragraph-start comint-prompt-regexp)
1334 (run-hooks 'dbx-mode-hook)
1335 )
1336 \f
1337 ;; ======================================================================
1338 ;; xdb (HP PARISC debugger) functions
1340 ;; History of argument lists passed to xdb.
1341 (defvar gud-xdb-history nil)
1343 (defcustom gud-xdb-directories nil
1344 "*A list of directories that xdb should search for source code.
1345 If nil, only source files in the program directory
1346 will be known to xdb.
1348 The file names should be absolute, or relative to the directory
1349 containing the executable being debugged."
1350 :type '(choice (const :tag "Current Directory" nil)
1351 (repeat :value ("")
1352 directory))
1353 :group 'gud)
1355 (defun gud-xdb-massage-args (file args)
1356 (nconc (let ((directories gud-xdb-directories)
1357 (result nil))
1358 (while directories
1359 (setq result (cons (car directories) (cons "-d" result)))
1360 (setq directories (cdr directories)))
1361 (nreverse result))
1362 args))
1364 ;; xdb does not print the lines all at once, so we have to accumulate them
1365 (defun gud-xdb-marker-filter (string)
1366 (let (result)
1367 (if (or (string-match comint-prompt-regexp string)
1369 (setq result (concat gud-marker-acc string)
1370 gud-marker-acc "")
1371 (setq gud-marker-acc (concat gud-marker-acc string)))
1372 (if result
1374 result)
1376 result))
1377 (let ((line (string-to-number (match-string 2 result)))
1378 (file (gud-file-name (match-string 1 result))))
1379 (if file
1380 (setq gud-last-frame (cons file line))))))
1381 (or result "")))
1383 ;;;###autoload
1384 (defun xdb (command-line)
1385 "Run xdb on program FILE in buffer *gud-FILE*.
1386 The directory containing FILE becomes the initial working directory
1387 and source-file directory for your debugger.
1389 You can set the variable `gud-xdb-directories' to a list of program source
1390 directories if your program contains sources from more than one directory."
1391 (interactive (list (gud-query-cmdline 'xdb)))
1393 (gud-common-init command-line 'gud-xdb-massage-args
1394 'gud-xdb-marker-filter)
1395 (set (make-local-variable 'gud-minor-mode) 'xdb)
1397 (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
1399 "Set temporary breakpoint at current line.")
1400 (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
1401 (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
1402 (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
1403 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1404 (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
1405 (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
1407 (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
1409 (setq comint-prompt-regexp "^>")
1410 (setq paragraph-start comint-prompt-regexp)
1411 (run-hooks 'xdb-mode-hook))
1412 \f
1413 ;; ======================================================================
1414 ;; perldb functions
1416 ;; History of argument lists passed to perldb.
1417 (defvar gud-perldb-history nil)
1419 (defun gud-perldb-massage-args (file args)
1420 "Convert a command line as would be typed normally to run perldb
1421 into one that invokes an Emacs-enabled debugging session.
1423 ;; FIXME: what if the command is `make perldb' and doesn't accept those extra
1424 ;; arguments ?
1425 (let* ((new-args nil)
1426 (seen-e nil)
1427 (shift (lambda () (push (pop args) new-args))))
1429 ;; Pass all switches and -e scripts through.
1430 (while (and args
1431 (string-match "^-" (car args))
1432 (not (equal "-" (car args)))
1433 (not (equal "--" (car args))))
1434 (when (equal "-e" (car args))
1435 ;; -e goes with the next arg, so shift one extra.
1436 (or (funcall shift)
1437 ;; -e as the last arg is an error in Perl.
1438 (error "No code specified for -e"))
1439 (setq seen-e t))
1440 (funcall shift))
1442 (unless seen-e
1443 (if (or (not args)
1444 (string-match "^-" (car args)))
1445 (error "Can't use stdin as the script to debug"))
1446 ;; This is the program name.
1447 (funcall shift))
1449 ;; If -e specified, make sure there is a -- so -emacs is not taken
1450 ;; as -e macs.
1451 (if (and args (equal "--" (car args)))
1452 (funcall shift)
1453 (and seen-e (push "--" new-args)))
1455 (push "-emacs" new-args)
1456 (while args
1457 (funcall shift))
1459 (nreverse new-args)))
1461 ;; There's no guarantee that Emacs will hand the filter the entire
1462 ;; marker at once; it could be broken up across several strings. We
1463 ;; might even receive a big chunk with several markers in it. If we
1464 ;; receive a chunk of text which looks like it might contain the
1465 ;; beginning of a marker, we save it here between calls to the
1466 ;; filter.
1467 (defun gud-perldb-marker-filter (string)
1468 (setq gud-marker-acc (concat gud-marker-acc string))
1469 (let ((output ""))
1471 ;; Process all the complete markers in this chunk.
1473 gud-marker-acc)
1474 (setq
1476 ;; Extract the frame position from the marker.
1477 gud-last-frame
1478 (cons (match-string 1 gud-marker-acc)
1479 (string-to-number (match-string 3 gud-marker-acc)))
1481 ;; Append any text before the marker to the output we're going
1482 ;; to return - we don't include the marker in this text.
1483 output (concat output
1484 (substring gud-marker-acc 0 (match-beginning 0)))
1486 ;; Set the accumulator to the remaining text.
1487 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1489 ;; Does the remaining text look like it might end with the
1490 ;; beginning of another marker? If it does, then keep it in
1491 ;; gud-marker-acc until we receive the rest of it. Since we
1492 ;; know the full marker regexp above failed, it's pretty simple to
1493 ;; test for marker starts.
1495 (progn
1496 ;; Everything before the potential marker start can be output.
1497 (setq output (concat output (substring gud-marker-acc
1498 0 (match-beginning 0))))
1500 ;; Everything after, we save, to combine with later input.
1501 (setq gud-marker-acc
1502 (substring gud-marker-acc (match-beginning 0))))
1504 (setq output (concat output gud-marker-acc)
1505 gud-marker-acc ""))
1507 output))
1509 (defcustom gud-perldb-command-name "perl -d"
1510 "Default command to execute a Perl script under debugger."
1511 :type 'string
1512 :group 'gud)
1514 ;;;###autoload
1515 (defun perldb (command-line)
1516 "Run perldb on program FILE in buffer *gud-FILE*.
1517 The directory containing FILE becomes the initial working directory
1518 and source-file directory for your debugger."
1519 (interactive
1520 (list (gud-query-cmdline 'perldb
1521 (concat (or (buffer-file-name) "-e 0") " "))))
1523 (gud-common-init command-line 'gud-perldb-massage-args
1524 'gud-perldb-marker-filter)
1525 (set (make-local-variable 'gud-minor-mode) 'perldb)
1527 (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
1528 (gud-def gud-remove "B %l" "\C-d" "Remove breakpoint at current line")
1529 (gud-def gud-step "s" "\C-s" "Step one source line with display.")
1530 (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
1531 (gud-def gud-cont "c" "\C-r" "Continue with display.")
1532 ; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
1533 ; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
1534 ; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
1535 (gud-def gud-print "p %e" "\C-p" "Evaluate perl expression at point.")
1536 (gud-def gud-until "c %l" "\C-u" "Continue to current line.")
1539 (setq comint-prompt-regexp "^ DB<+[0-9]+>+ ")
1540 (setq paragraph-start comint-prompt-regexp)
1541 (run-hooks 'perldb-mode-hook))
1542 \f
1543 ;; ======================================================================
1544 ;; pdb (Python debugger) functions
1546 ;; History of argument lists passed to pdb.
1547 (defvar gud-pdb-history nil)
1549 ;; Last group is for return value, e.g. "> test.py(2)foo()->None"
1550 ;; Either file or function name may be omitted: "> <string>(0)?()"
1551 (defvar gud-pdb-marker-regexp
1552 "^> \\([-a-zA-Z0-9_/.:\\]*\\|<string>\\)(\\([0-9]+\\))\\([a-zA-Z0-9_]*\\|\\?\\|<module>\\)()\\(->[^\n]*\\)?\n")
1553 (defvar gud-pdb-marker-regexp-file-group 1)
1554 (defvar gud-pdb-marker-regexp-line-group 2)
1555 (defvar gud-pdb-marker-regexp-fnname-group 3)
1557 (defvar gud-pdb-marker-regexp-start "^> ")
1559 ;; There's no guarantee that Emacs will hand the filter the entire
1560 ;; marker at once; it could be broken up across several strings. We
1561 ;; might even receive a big chunk with several markers in it. If we
1562 ;; receive a chunk of text which looks like it might contain the
1563 ;; beginning of a marker, we save it here between calls to the
1564 ;; filter.
1565 (defun gud-pdb-marker-filter (string)
1566 (setq gud-marker-acc (concat gud-marker-acc string))
1567 (let ((output ""))
1569 ;; Process all the complete markers in this chunk.
1570 (while (string-match gud-pdb-marker-regexp gud-marker-acc)
1571 (setq
1573 ;; Extract the frame position from the marker.
1574 gud-last-frame
1575 (let ((file (match-string gud-pdb-marker-regexp-file-group
1576 gud-marker-acc))
1577 (line (string-to-number
1578 (match-string gud-pdb-marker-regexp-line-group
1579 gud-marker-acc))))
1580 (if (string-equal file "<string>")
1581 gud-last-frame
1582 (cons file line)))
1584 ;; Output everything instead of the below
1585 output (concat output (substring gud-marker-acc 0 (match-end 0)))
1586 ;; ;; Append any text before the marker to the output we're going
1587 ;; ;; to return - we don't include the marker in this text.
1588 ;; output (concat output
1589 ;; (substring gud-marker-acc 0 (match-beginning 0)))
1591 ;; Set the accumulator to the remaining text.
1592 gud-marker-acc (substring gud-marker-acc (match-end 0))))
1594 ;; Does the remaining text look like it might end with the
1595 ;; beginning of another marker? If it does, then keep it in
1596 ;; gud-marker-acc until we receive the rest of it. Since we
1597 ;; know the full marker regexp above failed, it's pretty simple to
1598 ;; test for marker starts.
1599 (if (string-match gud-pdb-marker-regexp-start gud-marker-acc)
1600 (progn
1601 ;; Everything before the potential marker start can be output.
1602 (setq output (concat output (substring gud-marker-acc
1603 0 (match-beginning 0))))
1605 ;; Everything after, we save, to combine with later input.
1606 (setq gud-marker-acc
1607 (substring gud-marker-acc (match-beginning 0))))
1609 (setq output (concat output gud-marker-acc)
1610 gud-marker-acc ""))
1612 output))
1614 (defcustom gud-pdb-command-name "pdb"
1615 "File name for executing the Python debugger.
1616 This should be an executable on your path, or an absolute file name."
1617 :type 'string
1618 :group 'gud)
1620 ;;;###autoload
1621 (defun pdb (command-line)
1622 "Run pdb on program FILE in buffer `*gud-FILE*'.
1623 The directory containing FILE becomes the initial working directory
1624 and source-file directory for your debugger."
1625 (interactive
1626 (list (gud-query-cmdline 'pdb)))
1628 (gud-common-init command-line nil 'gud-pdb-marker-filter)
1629 (set (make-local-variable 'gud-minor-mode) 'pdb)
1631 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
1632 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line")
1633 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
1634 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
1635 (gud-def gud-cont "continue" "\C-r" "Continue with display.")
1636 (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
1637 (gud-def gud-up "up" "<" "Up one stack frame.")
1638 (gud-def gud-down "down" ">" "Down one stack frame.")
1639 (gud-def gud-print "p %e" "\C-p" "Evaluate Python expression at point.")
1640 ;; Is this right?
1641 (gud-def gud-statement "! %e" "\C-e" "Execute Python statement at point.")
1643 ;; (setq comint-prompt-regexp "^(.*pdb[+]?) *")
1644 (setq comint-prompt-regexp "^(Pdb) *")
1645 (setq paragraph-start comint-prompt-regexp)
1646 (run-hooks 'pdb-mode-hook))
1647 \f
1648 ;; ======================================================================
1649 ;;
1650 ;; JDB support.
1651 ;;
1652 ;; AUTHOR: Derek Davies <ddavies@world.std.com>
1653 ;; Zoltan Kemenczy <zoltan@ieee.org;zkemenczy@rim.net>
1654 ;;
1655 ;; CREATED: Sun Feb 22 10:46:38 1998 Derek Davies.
1656 ;; UPDATED: Nov 11, 2001 Zoltan Kemenczy
1657 ;; Dec 10, 2002 Zoltan Kemenczy - added nested class support
1658 ;;
1659 ;; INVOCATION NOTES:
1660 ;;
1661 ;; You invoke jdb-mode with:
1662 ;;
1663 ;; M-x jdb <enter>
1664 ;;
1665 ;; It responds with:
1666 ;;
1667 ;; Run jdb (like this): jdb
1668 ;;
1669 ;; type any jdb switches followed by the name of the class you'd like to debug.
1670 ;; Supply a fully qualfied classname (these do not have the ".class" extension)
1671 ;; for the name of the class to debug (e.g. "COM.the-kind.ddavies.CoolClass").
1672 ;; See the known problems section below for restrictions when specifying jdb
1673 ;; command line switches (search forward for '-classpath').
1674 ;;
1675 ;; You should see something like the following:
1676 ;;
1677 ;; Current directory is ~/src/java/hello/
1678 ;; Initializing jdb...
1679 ;; 0xed2f6628:class(hello)
1680 ;; >
1681 ;;
1682 ;; To set an initial breakpoint try:
1683 ;;
1684 ;; > stop in hello.main
1685 ;; Breakpoint set in hello.main
1686 ;; >
1687 ;;
1688 ;; To execute the program type:
1689 ;;
1690 ;; > run
1691 ;; run hello
1692 ;;
1693 ;; Breakpoint hit: running ...
1694 ;; hello.main (hello:12)
1695 ;;
1696 ;; Type M-n to step over the current line and M-s to step into it. That,
1697 ;; along with the JDB 'help' command should get you started. The 'quit'
1698 ;; JDB command will get out out of the debugger. There is some truly
1699 ;; pathetic JDB documentation available at:
1700 ;;
1701 ;; http://java.sun.com/products/jdk/1.1/debugging/
1702 ;;
1703 ;; KNOWN PROBLEMS AND FIXME's:
1704 ;;
1705 ;; Not sure what happens with inner classes ... haven't tried them.
1706 ;;
1707 ;; Does not grok UNICODE id's. Only ASCII id's are supported.
1708 ;;
1709 ;; You must not put whitespace between "-classpath" and the path to
1710 ;; search for java classes even though it is required when invoking jdb
1711 ;; from the command line. See gud-jdb-massage-args for details.
1712 ;; The same applies for "-sourcepath".
1713 ;;
1714 ;; Note: The following applies only if `gud-jdb-use-classpath' is nil;
1715 ;; refer to the documentation of `gud-jdb-use-classpath' and
1716 ;; `gud-jdb-classpath',`gud-jdb-sourcepath' variables for information
1717 ;; on using the classpath for locating java source files.
1718 ;;
1719 ;; If any of the source files in the directories listed in
1720 ;; gud-jdb-directories won't parse you'll have problems. Make sure
1721 ;; every file ending in ".java" in these directories parses without error.
1722 ;;
1723 ;; All the .java files in the directories in gud-jdb-directories are
1724 ;; syntactically analyzed each time gud jdb is invoked. It would be
1725 ;; nice to keep as much information as possible between runs. It would
1726 ;; be really nice to analyze the files only as neccessary (when the
1727 ;; source needs to be displayed.) I'm not sure to what extent the former
1728 ;; can be accomplished and I'm not sure the latter can be done at all
1729 ;; since I don't know of any general way to tell which .class files are
1730 ;; defined by which .java file without analyzing all the .java files.
1731 ;; If anyone knows why JavaSoft didn't put the source file names in
1732 ;; debuggable .class files please clue me in so I find something else
1733 ;; to be spiteful and bitter about.
1734 ;;
1735 ;; ======================================================================
1736 ;; gud jdb variables and functions
1738 (defcustom gud-jdb-command-name "jdb"
1739 "Command that executes the Java debugger."
1740 :type 'string
1741 :group 'gud)
1743 (defcustom gud-jdb-use-classpath t
1744 "If non-nil, search for Java source files in classpath directories.
1745 The list of directories to search is the value of `gud-jdb-classpath'.
1746 The file pathname is obtained by converting the fully qualified
1747 class information output by jdb to a relative pathname and appending
1748 it to `gud-jdb-classpath' element by element until a match is found.
1750 This method has a significant jdb startup time reduction advantage
1751 since it does not require the scanning of all `gud-jdb-directories'
1752 and parsing all Java files for class information.
1754 Set to nil to use `gud-jdb-directories' to scan java sources for
1755 class information on jdb startup (original method)."
1756 :type 'boolean
1757 :group 'gud)
1759 (defvar gud-jdb-classpath nil
1760 "Java/jdb classpath directories list.
1761 If `gud-jdb-use-classpath' is non-nil, gud-jdb derives the `gud-jdb-classpath'
1762 list automatically using the following methods in sequence
1763 \(with subsequent successful steps overriding the results of previous
1764 steps):
1766 1) Read the CLASSPATH environment variable,
1768 or detected in jdb output (e.g. if jdb is run by a script
1769 that echoes the actual jdb command before starting jdb)
1772 an already running VM) argument (This case typically does not
1774 to the VM when it is started).
1776 Note that method 3 cannot be used with oldjdb (or Java 1 jdb) since
1777 those debuggers do not support the classpath command. Use 1) or 2).")
1779 (defvar gud-jdb-sourcepath nil
1781 This list is prepended to `gud-jdb-classpath' to form the complete
1782 list of directories searched for source files.")
1784 (defvar gud-marker-acc-max-length 4000
1785 "Maximum number of debugger output characters to keep.
1786 This variable limits the size of `gud-marker-acc' which holds
1787 the most recent debugger output history while searching for
1788 source file information.")
1790 (defvar gud-jdb-history nil
1791 "History of argument lists passed to jdb.")
1794 ;; List of Java source file directories.
1795 (defvar gud-jdb-directories (list ".")
1796 "*A list of directories that gud jdb should search for source code.
1797 The file names should be absolute, or relative to the current
1798 directory.
1800 The set of .java files residing in the directories listed are
1801 syntactically analyzed to determine the classes they define and the
1802 packages in which these classes belong. In this way gud jdb maps the
1803 package-qualified class names output by the jdb debugger to the source
1804 file from which the class originated. This allows gud mode to keep
1805 the source code display in sync with the debugging session.")
1807 (defvar gud-jdb-source-files nil
1808 "List of the java source files for this debugging session.")
1810 ;; Association list of fully qualified class names (package + class name)
1811 ;; and their source files.
1812 (defvar gud-jdb-class-source-alist nil
1813 "Association list of fully qualified class names and source files.")
1815 ;; This is used to hold a source file during analysis.
1816 (defvar gud-jdb-analysis-buffer nil)
1818 (defvar gud-jdb-classpath-string nil
1819 "Holds temporary classpath values.")
1821 (defun gud-jdb-build-source-files-list (path extn)
1822 "Return a list of java source files (absolute paths).
1823 PATH gives the directories in which to search for files with
1824 extension EXTN. Normally EXTN is given as the regular expression
1826 (apply 'nconc (mapcar (lambda (d)
1827 (when (file-directory-p d)
1828 (directory-files d t extn nil)))
1829 path)))
1831 ;; Move point past whitespace.
1832 (defun gud-jdb-skip-whitespace ()
1835 ;; Move point past a "// <eol>" type of comment.
1836 (defun gud-jdb-skip-single-line-comment ()
1837 (end-of-line))
1839 ;; Move point past a "/* */" or "/** */" type of comment.
1840 (defun gud-jdb-skip-traditional-or-documentation-comment ()
1841 (forward-char 2)
1842 (catch 'break
1843 (while (not (eobp))
1844 (if (eq (following-char) ?*)
1845 (progn
1846 (forward-char)
1847 (if (not (eobp))
1848 (if (eq (following-char) ?/)
1849 (progn
1850 (forward-char)
1851 (throw 'break nil)))))
1852 (forward-char)))))
1854 ;; Move point past any number of consecutive whitespace chars and/or comments.
1855 (defun gud-jdb-skip-whitespace-and-comments ()
1856 (gud-jdb-skip-whitespace)
1857 (catch 'done
1858 (while t
1859 (cond
1860 ((looking-at "//")
1861 (gud-jdb-skip-single-line-comment)
1862 (gud-jdb-skip-whitespace))
1864 (gud-jdb-skip-traditional-or-documentation-comment)
1865 (gud-jdb-skip-whitespace))
1866 (t (throw 'done nil))))))
1868 ;; Move point past things that are id-like. The intent is to skip regular
1869 ;; id's, such as class or interface names as well as package and interface
1870 ;; names.
1871 (defun gud-jdb-skip-id-ish-thing ()
1874 ;; Move point past a string literal.
1875 (defun gud-jdb-skip-string-literal ()
1876 (forward-char)
1877 (while (not (cond
1879 (forward-char))
1881 (forward-char))
1882 (forward-char))
1884 ;; Move point past a character literal.
1885 (defun gud-jdb-skip-character-literal ()
1886 (forward-char)
1887 (while
1888 (progn
1890 (forward-char 2))
1892 (forward-char))
1893 (forward-char))
1895 ;; Move point past the following block. There may be (legal) cruft before
1896 ;; the block's opening brace. There must be a block or it's the end of life
1897 ;; in petticoat junction.
1898 (defun gud-jdb-skip-block ()
1900 ;; Find the begining of the block.
1901 (while
1902 (not (eq (following-char) ?{))
1904 ;; Skip any constructs that can harbor literal block delimiter
1905 ;; characters and/or the delimiters for the constructs themselves.
1906 (cond
1907 ((looking-at "//")
1908 (gud-jdb-skip-single-line-comment))
1910 (gud-jdb-skip-traditional-or-documentation-comment))
1912 (gud-jdb-skip-string-literal))
1914 (gud-jdb-skip-character-literal))
1915 (t (forward-char))))
1917 ;; Now at the begining of the block.
1918 (forward-char)
1920 ;; Skip over the body of the block as well as the final brace.
1921 (let ((open-level 1))
1922 (while (not (eq open-level 0))
1923 (cond
1924 ((looking-at "//")
1925 (gud-jdb-skip-single-line-comment))
1927 (gud-jdb-skip-traditional-or-documentation-comment))
1929 (gud-jdb-skip-string-literal))
1931 (gud-jdb-skip-character-literal))
1932 ((eq (following-char) ?{)
1933 (setq open-level (+ open-level 1))
1934 (forward-char))
1935 ((eq (following-char) ?})
1936 (setq open-level (- open-level 1))
1937 (forward-char))
1938 (t (forward-char))))))
1940 ;; Find the package and class definitions in Java source file FILE. Assumes
1941 ;; that FILE contains a legal Java program. BUF is a scratch buffer used
1942 ;; to hold the source during analysis.
1943 (defun gud-jdb-analyze-source (buf file)
1944 (let ((l nil))
1945 (set-buffer buf)
1946 (insert-file-contents file nil nil nil t)
1947 (goto-char 0)
1948 (catch 'abort
1949 (let ((p ""))
1950 (while (progn
1951 (gud-jdb-skip-whitespace)
1952 (not (eobp)))
1953 (cond
1955 ;; Any number of semi's following a block is legal. Move point
1956 ;; past them. Note that comments and whitespace may be
1957 ;; interspersed as well.
1959 (forward-char))
1961 ;; Move point past a single line comment.
1962 ((looking-at "//")
1963 (gud-jdb-skip-single-line-comment))
1965 ;; Move point past a traditional or documentation comment.
1967 (gud-jdb-skip-traditional-or-documentation-comment))
1969 ;; Move point past a package statement, but save the PackageName.
1970 ((looking-at "package")
1971 (forward-char 7)
1972 (gud-jdb-skip-whitespace-and-comments)
1973 (let ((s (point)))
1974 (gud-jdb-skip-id-ish-thing)
1975 (setq p (concat (buffer-substring s (point)) "."))
1976 (gud-jdb-skip-whitespace-and-comments)
1978 (forward-char))))
1980 ;; Move point past an import statement.
1981 ((looking-at "import")
1982 (forward-char 6)
1983 (gud-jdb-skip-whitespace-and-comments)
1984 (gud-jdb-skip-id-ish-thing)
1985 (gud-jdb-skip-whitespace-and-comments)
1987 (forward-char)))
1989 ;; Move point past the various kinds of ClassModifiers.
1990 ((looking-at "public")
1991 (forward-char 6))
1992 ((looking-at "abstract")
1993 (forward-char 8))
1994 ((looking-at "final")
1995 (forward-char 5))
1997 ;; Move point past a ClassDeclaraction, but save the class
1998 ;; Identifier.
1999 ((looking-at "class")
2000 (forward-char 5)
2001 (gud-jdb-skip-whitespace-and-comments)
2002 (let ((s (point)))
2003 (gud-jdb-skip-id-ish-thing)
2004 (setq
2005 l (nconc l (list (concat p (buffer-substring s (point)))))))
2006 (gud-jdb-skip-block))
2008 ;; Move point past an interface statement.
2009 ((looking-at "interface")
2010 (forward-char 9)
2011 (gud-jdb-skip-block))
2013 ;; Anything else means the input is invalid.
2014 (t
2015 (message "Error parsing file %s." file)
2016 (throw 'abort nil))))))
2017 l))
2019 (defun gud-jdb-build-class-source-alist-for-file (file)
2020 (mapcar
2021 (lambda (c)
2022 (cons c file))
2023 (gud-jdb-analyze-source gud-jdb-analysis-buffer file)))
2025 ;; Return an alist of fully qualified classes and the source files
2026 ;; holding their definitions. SOURCES holds a list of all the source
2027 ;; files to examine.
2028 (defun gud-jdb-build-class-source-alist (sources)
2029 (setq gud-jdb-analysis-buffer (get-buffer-create " *gud-jdb-scratch*"))
2030 (prog1
2031 (apply
2032 'nconc
2033 (mapcar
2034 'gud-jdb-build-class-source-alist-for-file
2035 sources))
2036 (kill-buffer gud-jdb-analysis-buffer)
2037 (setq gud-jdb-analysis-buffer nil)))
2039 ;; Change what was given in the minibuffer to something that can be used to
2040 ;; invoke the debugger.
2041 (defun gud-jdb-massage-args (file args)
2042 ;; The jdb executable must have whitespace between "-classpath" and
2043 ;; its value while gud-common-init expects all switch values to
2044 ;; follow the switch keyword without intervening whitespace. We
2045 ;; require that when the user enters the "-classpath" switch in the
2046 ;; EMACS minibuffer that they do so without the intervening
2047 ;; whitespace. This function adds it back (it's called after
2048 ;; gud-common-init). There are more switches like this (for
2049 ;; instance "-host" and "-password") but I don't care about them
2050 ;; yet.
2051 (if args
2052 (let (massaged-args user-error)
2054 (while (and args (not user-error))
2055 (cond
2056 ((setq user-error (string-match "-classpath$" (car args))))
2057 ((setq user-error (string-match "-sourcepath$" (car args))))
2059 (setq massaged-args
2060 (append massaged-args
2061 (list "-classpath"
2062 (setq gud-jdb-classpath-string
2063 (match-string 1 (car args)))))))
2065 (setq massaged-args
2066 (append massaged-args
2067 (list "-sourcepath"
2068 (setq gud-jdb-sourcepath
2069 (match-string 1 (car args)))))))
2070 (t (setq massaged-args (append massaged-args (list (car args))))))
2071 (setq args (cdr args)))
2073 ;; By this point the current directory is all screwed up. Maybe we
2074 ;; could fix things and re-invoke gud-common-init, but for now I think
2075 ;; issueing the error is good enough.
2076 (if user-error
2077 (progn
2078 (kill-buffer (current-buffer))
2079 (error "Error: Omit whitespace between '-classpath or -sourcepath' and its value")))
2080 massaged-args)))
2082 ;; Search for an association with P, a fully qualified class name, in
2083 ;; gud-jdb-class-source-alist. The asssociation gives the fully
2084 ;; qualified file name of the source file which produced the class.
2085 (defun gud-jdb-find-source-file (p)
2086 (cdr (assoc p gud-jdb-class-source-alist)))
2088 ;; Note: Reset to this value every time a prompt is seen
2089 (defvar gud-jdb-lowest-stack-level 999)
2091 (defun gud-jdb-find-source-using-classpath (p)
2092 "Find source file corresponding to fully qualified class p.
2093 Convert p from jdb's output, converted to a pathname
2094 relative to a classpath directory."
2095 (save-match-data
2096 (let
2097 (;; Replace dots with slashes and append ".java" to generate file
2098 ;; name relative to classpath
2099 (filename
2100 (concat
2101 (mapconcat 'identity
2102 (split-string
2103 ;; Eliminate any subclass references in the class
2104 ;; name string. These start with a "$"
2105 ((lambda (x)
2106 (if (string-match "$.*" x)
2107 (replace-match "" t t x) p))
2108 p)
2110 ".java"))
2111 (cplist (append gud-jdb-sourcepath gud-jdb-classpath))
2112 found-file)
2113 (while (and cplist
2114 (not (setq found-file
2115 (file-readable-p
2116 (concat (car cplist) "/" filename)))))
2117 (setq cplist (cdr cplist)))
2118 (if found-file (concat (car cplist) "/" filename)))))
2120 (defun gud-jdb-find-source (string)
2121 "Alias for function used to locate source files.
2122 Set to `gud-jdb-find-source-using-classpath' or `gud-jdb-find-source-file'
2123 during jdb initialization depending on the value of
2124 `gud-jdb-use-classpath'."
2125 nil)
2127 (defun gud-jdb-parse-classpath-string (string)
2128 "Parse the classpath list and convert each item to an absolute pathname."
2130 (replace-match "" nil nil s) s))
2131 (mapcar 'file-truename
2132 (split-string
2133 string
2136 ;; See comentary for other debugger's marker filters - there you will find
2137 ;; important notes about STRING.
2138 (defun gud-jdb-marker-filter (string)
2140 ;; Build up the accumulator.
2141 (setq gud-marker-acc
2142 (if gud-marker-acc
2143 (concat gud-marker-acc string)
2144 string))
2146 ;; Look for classpath information until gud-jdb-classpath-string is found
2147 ;; (interactive, multiple settings of classpath from jdb
2148 ;; not supported/followed)
2149 (if (and gud-jdb-use-classpath
2150 (not gud-jdb-classpath-string)
2153 (setq gud-jdb-classpath
2154 (gud-jdb-parse-classpath-string
2155 (setq gud-jdb-classpath-string
2156 (match-string 1 gud-marker-acc)))))
2158 ;; We process STRING from left to right. Each time through the
2159 ;; following loop we process at most one marker. After we've found a
2160 ;; marker, delete gud-marker-acc up to and including the match
2161 (let (file-found)
2162 ;; Process each complete marker in the input.
2163 (while
2165 ;; Do we see a marker?
2166 (string-match
2167 ;; jdb puts out a string of the following form when it
2168 ;; hits a breakpoint:
2169 ;;
2170 ;; <fully-qualified-class><method> (<class>:<line-number>)
2171 ;;
2172 ;; <fully-qualified-class>'s are composed of Java ID's
2173 ;; separated by periods. <method> and <class> are
2174 ;; also Java ID's. <method> begins with a period and
2175 ;; may contain less-than and greater-than (constructors,
2176 ;; for instance, are called <init> in the symbol table.)
2177 ;; Java ID's begin with a letter followed by letters
2178 ;; and/or digits. The set of letters includes underscore
2179 ;; and dollar sign.
2180 ;;
2181 ;; The first group matches <fully-qualified-class>,
2182 ;; the second group matches <class> and the third group
2183 ;; matches <line-number>. We don't care about using
2184 ;; <method> so we don't "group" it.
2185 ;;
2186 ;; FIXME: Java ID's are UNICODE strings, this matches ASCII
2187 ;; ID's only.
2188 ;;
2189 ;; The ".," in the last square-bracket are necessary because
2190 ;; of Sun's total disrespect for backwards compatibility in
2191 ;; reported line numbers from jdb - starting in 1.4.0 they
2192 ;; print line numbers using LOCALE, inserting a comma or a
2193 ;; period at the thousands positions (how ingenious!).
2197 gud-marker-acc)
2199 ;; A good marker is one that:
2200 ;; 1) does not have a "[n] " prefix (not part of a stack backtrace)
2201 ;; 2) does have an "[n] " prefix and n is the lowest prefix seen
2202 ;; since the last prompt
2203 ;; Figure out the line on which to position the debugging arrow.
2204 ;; Return the info as a cons of the form:
2205 ;;
2206 ;; (<file-name> . <line-number>) .
2207 (if (if (match-beginning 1)
2208 (let (n)
2209 (setq n (string-to-number (substring
2210 gud-marker-acc
2211 (1+ (match-beginning 1))
2212 (- (match-end 1) 2))))
2213 (if (< n gud-jdb-lowest-stack-level)
2214 (progn (setq gud-jdb-lowest-stack-level n) t)))
2215 t)
2216 (if (setq file-found
2217 (gud-jdb-find-source (match-string 2 gud-marker-acc)))
2218 (setq gud-last-frame
2219 (cons file-found
2220 (string-to-number
2221 (let
2222 ((numstr (match-string 4 gud-marker-acc)))
2223 (if (string-match "[.,]" numstr)
2224 (replace-match "" nil nil numstr)
2225 numstr)))))
2226 (message "Could not find source file.")))
2228 ;; Set the accumulator to the remaining text.
2229 (setq gud-marker-acc (substring gud-marker-acc (match-end 0))))
2231 (if (string-match comint-prompt-regexp gud-marker-acc)
2232 (setq gud-jdb-lowest-stack-level 999)))
2234 ;; Do not allow gud-marker-acc to grow without bound. If the source
2235 ;; file information is not within the last 3/4
2236 ;; gud-marker-acc-max-length characters, well,...
2237 (if (> (length gud-marker-acc) gud-marker-acc-max-length)
2238 (setq gud-marker-acc
2239 (substring gud-marker-acc
2240 (- (/ (* gud-marker-acc-max-length 3) 4)))))
2242 ;; We don't filter any debugger output so just return what we were given.
2243 string)
2245 (defvar gud-jdb-command-name "jdb" "Command that executes the Java debugger.")
2247 ;;;###autoload
2248 (defun jdb (command-line)
2249 "Run jdb with command line COMMAND-LINE in a buffer.
2252 switch is given, omit all whitespace between it and its value.
2254 See `gud-jdb-use-classpath' and `gud-jdb-classpath' documentation for
2255 information on how jdb accesses source files. Alternatively (if
2256 `gud-jdb-use-classpath' is nil), see `gud-jdb-directories' for the
2257 original source file access method.
2259 For general information about commands available to control jdb from
2260 gud, see `gud-mode'."
2261 (interactive
2262 (list (gud-query-cmdline 'jdb)))
2263 (setq gud-jdb-classpath nil)
2264 (setq gud-jdb-sourcepath nil)
2266 ;; Set gud-jdb-classpath from the CLASSPATH environment variable,
2267 ;; if CLASSPATH is set.
2268 (setq gud-jdb-classpath-string (getenv "CLASSPATH"))
2269 (if gud-jdb-classpath-string
2270 (setq gud-jdb-classpath
2271 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2272 (setq gud-jdb-classpath-string nil) ; prepare for next
2274 (gud-common-init command-line 'gud-jdb-massage-args
2275 'gud-jdb-marker-filter)
2276 (set (make-local-variable 'gud-minor-mode) 'jdb)
2278 ;; If a -classpath option was provided, set gud-jdb-classpath
2279 (if gud-jdb-classpath-string
2280 (setq gud-jdb-classpath
2281 (gud-jdb-parse-classpath-string gud-jdb-classpath-string)))
2282 (setq gud-jdb-classpath-string nil) ; prepare for next
2283 ;; If a -sourcepath option was provided, parse it
2284 (if gud-jdb-sourcepath
2285 (setq gud-jdb-sourcepath
2286 (gud-jdb-parse-classpath-string gud-jdb-sourcepath)))
2288 (gud-def gud-break "stop at %c:%l" "\C-b" "Set breakpoint at current line.")
2289 (gud-def gud-remove "clear %c:%l" "\C-d" "Remove breakpoint at current line")
2290 (gud-def gud-step "step" "\C-s" "Step one source line with display.")
2291 (gud-def gud-next "next" "\C-n" "Step one line (skip functions).")
2292 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
2293 (gud-def gud-finish "step up" "\C-f" "Continue until current method returns.")
2294 (gud-def gud-up "up\C-Mwhere" "<" "Up one stack frame.")
2295 (gud-def gud-down "down\C-Mwhere" ">" "Up one stack frame.")
2296 (gud-def gud-run "run" nil "Run the program.") ;if VM start using jdb
2297 (gud-def gud-print "print %e" "\C-p" "Evaluate Java expression at point.")
2301 (setq paragraph-start comint-prompt-regexp)
2302 (run-hooks 'jdb-mode-hook)
2304 (if gud-jdb-use-classpath
2305 ;; Get the classpath information from the debugger
2306 (progn
2307 (if (string-match "-attach" command-line)
2308 (gud-call "classpath"))
2309 (fset 'gud-jdb-find-source
2310 'gud-jdb-find-source-using-classpath))
2312 ;; Else create and bind the class/source association list as well
2313 ;; as the source file list.
2314 (setq gud-jdb-class-source-alist
2315 (gud-jdb-build-class-source-alist
2316 (setq gud-jdb-source-files
2317 (gud-jdb-build-source-files-list gud-jdb-directories
2319 (fset 'gud-jdb-find-source 'gud-jdb-find-source-file)))
2321 ;;
2322 ;; End of debugger-specific information
2323 ;;
2325 \f
2326 ;; When we send a command to the debugger via gud-call, it's annoying
2327 ;; to see the command and the new prompt inserted into the debugger's
2328 ;; buffer; we have other ways of knowing the command has completed.
2329 ;;
2330 ;; If the buffer looks like this:
2331 ;; --------------------
2332 ;; (gdb) set args foo bar
2333 ;; (gdb) -!-
2334 ;; --------------------
2335 ;; (the -!- marks the location of point), and we type `C-x SPC' in a
2336 ;; source file to set a breakpoint, we want the buffer to end up like
2337 ;; this:
2338 ;; --------------------
2339 ;; (gdb) set args foo bar
2340 ;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
2341 ;; (gdb) -!-
2342 ;; --------------------
2343 ;; Essentially, the old prompt is deleted, and the command's output
2344 ;; and the new prompt take its place.
2345 ;;
2346 ;; Not echoing the command is easy enough; you send it directly using
2347 ;; process-send-string, and it never enters the buffer. However,
2348 ;; getting rid of the old prompt is trickier; you don't want to do it
2349 ;; when you send the command, since that will result in an annoying
2350 ;; flicker as the prompt is deleted, redisplay occurs while Emacs
2351 ;; waits for a response from the debugger, and the new prompt is
2352 ;; inserted. Instead, we'll wait until we actually get some output
2353 ;; from the subprocess before we delete the prompt. If the command
2354 ;; produced no output other than a new prompt, that prompt will most
2355 ;; likely be in the first chunk of output received, so we will delete
2356 ;; the prompt and then replace it with an identical one. If the
2357 ;; command produces output, the prompt is moving anyway, so the
2358 ;; flicker won't be annoying.
2359 ;;
2360 ;; So - when we want to delete the prompt upon receipt of the next
2361 ;; chunk of debugger output, we position gud-delete-prompt-marker at
2362 ;; the start of the prompt; the process filter will notice this, and
2363 ;; delete all text between it and the process output marker. If
2364 ;; gud-delete-prompt-marker points nowhere, we leave the current
2365 ;; prompt alone.
2366 (defvar gud-delete-prompt-marker nil)
2368 \f
2369 (put 'gud-mode 'mode-class 'special)
2371 (define-derived-mode gud-mode comint-mode "Debugger"
2372 "Major mode for interacting with an inferior debugger process.
2374 You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
2375 M-x perldb, M-x xdb, or M-x jdb. Each entry point finishes by executing a
2376 hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook',
2377 `perldb-mode-hook', `xdb-mode-hook', or `jdb-mode-hook' respectively.
2379 After startup, the following commands are available in both the GUD
2380 interaction buffer and any source buffer GUD visits due to a breakpoint stop
2381 or step operation:
2384 GUD buffer, the current file and line are those of the last breakpoint or
2385 step. In a source buffer, they are the buffer's file and current line.
2390 in the gud buffer.
2393 step-one-line (not entering function calls), and step-one-instruction
2394 and then update the source window with the current file and position.
2398 around point, and sends it to the debugger for value display.
2400 The above commands are common to all supported debuggers except xdb which
2401 does not support stepping instructions.
2404 except that the breakpoint is temporary; that is, it is removed when
2405 execution stops on it.
2411 the current function and stops.
2413 All the keystrokes above are accessible in the GUD buffer
2414 with the prefix C-c, and in all buffers through the prefix C-x C-a.
2416 All pre-defined functions for which the concept make sense repeat
2417 themselves the appropriate number of times if you give a prefix
2418 argument.
2420 You may use the `gud-def' macro in the initialization hook to define other
2421 commands.
2423 Other commands for interacting with the debugger process are inherited from
2424 comint mode, which see."
2425 (setq mode-line-process '(":%s"))
2426 (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
2427 (set (make-local-variable 'gud-last-frame) nil)
2428 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
2429 (make-local-variable 'comint-prompt-regexp)
2430 ;; Don't put repeated commands in command history many times.
2431 (set (make-local-variable 'comint-input-ignoredups) t)
2432 (make-local-variable 'paragraph-start)
2433 (set (make-local-variable 'gud-delete-prompt-marker) (make-marker))
2434 (add-hook 'kill-buffer-hook 'gud-kill-buffer-hook nil t))
2436 ;; Cause our buffers to be displayed, by default,
2437 ;; in the selected window.
2440 (defcustom gud-chdir-before-run t
2441 "Non-nil if GUD should `cd' to the debugged executable."
2442 :group 'gud
2443 :type 'boolean)
2445 (defvar gud-target-name "--unknown--"
2446 "The apparent name of the program being debugged in a gud buffer.")
2448 ;; Perform initializations common to all debuggers.
2449 ;; The first arg is the specified command line,
2450 ;; which starts with the program to debug.
2451 ;; The other three args specify the values to use
2452 ;; for local variables in the debugger buffer.
2453 (defun gud-common-init (command-line massage-args marker-filter
2454 &optional find-file)
2455 (let* ((words (split-string-and-unquote command-line))
2456 (program (car words))
2457 (dir default-directory)
2458 ;; Extract the file name from WORDS
2459 ;; and put t in its place.
2460 ;; Later on we will put the modified file name arg back there.
2461 (file-word (let ((w (cdr words)))
2462 (while (and w (= ?- (aref (car w) 0)))
2463 (setq w (cdr w)))
2464 (and w
2465 (prog1 (car w)
2466 (setcar w t)))))
2467 (file-subst
2468 (and file-word (substitute-in-file-name file-word)))
2469 (args (cdr words))
2470 ;; If a directory was specified, expand the file name.
2471 ;; Otherwise, don't expand it, so GDB can use the PATH.
2472 ;; A file name without directory is literally valid
2473 ;; only if the file exists in ., and in that case,
2474 ;; omitting the expansion here has no visible effect.
2475 (file (and file-word
2476 (if (file-name-directory file-subst)
2477 (expand-file-name file-subst)
2478 file-subst)))
2479 (filepart (and file-word (concat "-" (file-name-nondirectory file))))
2480 (existing-buffer (get-buffer (concat "*gud" filepart "*"))))
2481 (pop-to-buffer (concat "*gud" filepart "*"))
2482 (when (and existing-buffer (get-buffer-process existing-buffer))
2483 (error "This program is already being debugged"))
2484 ;; Set the dir, in case the buffer already existed with a different dir.
2485 (setq default-directory dir)
2486 ;; Set default-directory to the file's directory.
2487 (and file-word
2488 gud-chdir-before-run
2489 ;; Don't set default-directory if no directory was specified.
2490 ;; In that case, either the file is found in the current directory,
2491 ;; in which case this setq is a no-op,
2492 ;; or it is found by searching PATH,
2493 ;; in which case we don't know what directory it was found in.
2494 (file-name-directory file)
2495 (setq default-directory (file-name-directory file)))
2496 (or (bolp) (newline))
2498 ;; Put the substituted and expanded file name back in its place.
2499 (let ((w args))
2500 (while (and w (not (eq (car w) t)))
2501 (setq w (cdr w)))
2502 (if w
2503 (setcar w file)))
2504 (apply 'make-comint (concat "gud" filepart) program nil
2505 (if massage-args (funcall massage-args file args) args))
2506 ;; Since comint clobbered the mode, we don't set it until now.
2507 (gud-mode)
2508 (set (make-local-variable 'gud-target-name)
2509 (and file-word (file-name-nondirectory file))))
2510 (set (make-local-variable 'gud-marker-filter) marker-filter)
2511 (if find-file (set (make-local-variable 'gud-find-file) find-file))
2512 (setq gud-last-last-frame nil)
2514 (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
2515 (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
2516 (gud-set-buffer))
2518 (defun gud-set-buffer ()
2519 (when (eq major-mode 'gud-mode)
2520 (setq gud-comint-buffer (current-buffer))))
2522 (defvar gud-filter-defer-flag nil
2523 "Non-nil means don't process anything from the debugger right now.
2524 It is saved for when this flag is not set.")
2526 ;; These functions are responsible for inserting output from your debugger
2527 ;; into the buffer. The hard work is done by the method that is
2528 ;; the value of gud-marker-filter.
2530 (defun gud-filter (proc string)
2531 ;; Here's where the actual buffer insertion is done
2532 (let (output process-window)
2533 (if (buffer-name (process-buffer proc))
2534 (if gud-filter-defer-flag
2535 ;; If we can't process any text now,
2536 ;; save it for later.
2537 (setq gud-filter-pending-text
2538 (concat (or gud-filter-pending-text "") string))
2540 ;; If we have to ask a question during the processing,
2541 ;; defer any additional text that comes from the debugger
2542 ;; during that time.
2543 (let ((gud-filter-defer-flag t))
2544 ;; Process now any text we previously saved up.
2545 (if gud-filter-pending-text
2546 (setq string (concat gud-filter-pending-text string)
2547 gud-filter-pending-text nil))
2549 (with-current-buffer (process-buffer proc)
2550 ;; If we have been so requested, delete the debugger prompt.
2551 (save-restriction
2552 (widen)
2553 (if (marker-buffer gud-delete-prompt-marker)
2554 (let ((inhibit-read-only t))
2555 (delete-region (process-mark proc)
2556 gud-delete-prompt-marker)
2557 (comint-update-fence)
2558 (set-marker gud-delete-prompt-marker nil)))
2559 ;; Save the process output, checking for source file markers.
2560 (setq output (gud-marker-filter string))
2561 ;; Check for a filename-and-line number.
2562 ;; Don't display the specified file
2563 ;; unless (1) point is at or after the position where output appears
2564 ;; and (2) this buffer is on the screen.
2565 (setq process-window
2566 (and gud-last-frame
2567 (>= (point) (process-mark proc))
2568 (get-buffer-window (current-buffer)))))
2570 ;; Let the comint filter do the actual insertion.
2571 ;; That lets us inherit various comint features.
2572 (comint-output-filter proc output))
2574 ;; Put the arrow on the source line.
2575 ;; This must be outside of the save-excursion
2576 ;; in case the source file is our current buffer.
2577 (if process-window
2578 (with-selected-window process-window
2579 (gud-display-frame))
2580 ;; We have to be in the proper buffer, (process-buffer proc),
2581 ;; but not in a save-excursion, because that would restore point.
2582 (with-current-buffer (process-buffer proc)
2583 (gud-display-frame))))
2585 ;; If we deferred text that arrived during this processing,
2586 ;; handle it now.
2587 (if gud-filter-pending-text
2588 (gud-filter proc ""))))))
2590 (defvar gud-minor-mode-type nil)
2591 (defvar gud-overlay-arrow-position nil)
2592 (add-to-list 'overlay-arrow-variable-list 'gud-overlay-arrow-position)
2594 (defun gud-sentinel (proc msg)
2595 (cond ((null (buffer-name (process-buffer proc)))
2596 ;; buffer killed
2597 ;; Stop displaying an arrow in a source file.
2598 (setq gud-overlay-arrow-position nil)
2599 (set-process-buffer proc nil)
2600 (if (and (boundp 'speedbar-frame)
2601 (string-equal speedbar-initial-expansion-list-name "GUD"))
2602 (speedbar-change-initial-expansion-list
2603 speedbar-previously-used-expansion-list-name))
2604 (if (memq gud-minor-mode-type '(gdbmi gdba))
2605 (gdb-reset)
2606 (gud-reset)))
2607 ((memq (process-status proc) '(signal exit))
2608 ;; Stop displaying an arrow in a source file.
2609 (setq gud-overlay-arrow-position nil)
2610 (if (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
2611 '(gdba gdbmi))
2612 (gdb-reset)
2613 (gud-reset))
2614 (let* ((obuf (current-buffer)))
2615 ;; save-excursion isn't the right thing if
2616 ;; process-buffer is current-buffer
2617 (unwind-protect
2618 (progn
2619 ;; Write something in the GUD buffer and hack its mode line,
2620 (set-buffer (process-buffer proc))
2621 ;; Fix the mode line.
2622 (setq mode-line-process
2623 (concat ":"
2624 (symbol-name (process-status proc))))
2625 (force-mode-line-update)
2626 (if (eobp)
2628 (save-excursion
2629 (goto-char (point-max))
2631 ;; If buffer and mode line will show that the process
2632 ;; is dead, we can delete it now. Otherwise it
2633 ;; will stay around until M-x list-processes.
2634 (delete-process proc))
2635 ;; Restore old buffer, but don't restore old point
2636 ;; if obuf is the gud buffer.
2637 (set-buffer obuf))))))
2639 (defun gud-kill-buffer-hook ()
2640 (setq gud-minor-mode-type gud-minor-mode)
2641 (condition-case nil
2642 (kill-process (get-buffer-process (current-buffer)))
2643 (error nil)))
2645 (defun gud-reset ()
2646 (dolist (buffer (buffer-list))
2647 (unless (eq buffer gud-comint-buffer)
2648 (with-current-buffer buffer
2649 (when gud-minor-mode
2650 (setq gud-minor-mode nil)
2651 (kill-local-variable 'tool-bar-map))))))
2653 (defun gud-display-frame ()
2654 "Find and obey the last filename-and-line marker from the debugger.
2655 Obeying it means displaying in another window the specified file and line."
2656 (interactive)
2657 (when gud-last-frame
2658 (gud-set-buffer)
2659 (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
2660 (setq gud-last-last-frame gud-last-frame
2661 gud-last-frame nil)))
2663 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
2664 ;; and that its line LINE is visible.
2665 ;; Put the overlay-arrow on the line LINE in that buffer.
2666 ;; Most of the trickiness in here comes from wanting to preserve the current
2667 ;; region-restriction if that's possible. We use an explicit display-buffer
2668 ;; to get around the fact that this is called inside a save-excursion.
2670 (defun gud-display-line (true-file line)
2671 (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
2672 (buffer
2673 (with-current-buffer gud-comint-buffer
2674 (gud-find-file true-file)))
2675 (window (and buffer
2676 (or (get-buffer-window buffer)
2677 (if (memq gud-minor-mode '(gdbmi gdba))
2678 (or (if (get-buffer-window buffer 0)
2679 (display-buffer buffer nil 0))
2680 (unless (gdb-display-source-buffer buffer)
2681 (gdb-display-buffer buffer nil))))
2682 (display-buffer buffer))))
2683 (pos))
2684 (if buffer
2685 (progn
2686 (with-current-buffer buffer
2687 (unless (or (verify-visited-file-modtime buffer) gud-keep-buffer)
2688 (if (yes-or-no-p
2689 (format "File %s changed on disk. Reread from disk? "
2690 (buffer-name)))
2691 (revert-buffer t t)
2692 (setq gud-keep-buffer t)))
2693 (save-restriction
2694 (widen)
2695 (goto-line line)
2696 (setq pos (point))
2697 (or gud-overlay-arrow-position
2698 (setq gud-overlay-arrow-position (make-marker)))
2699 (set-marker gud-overlay-arrow-position (point) (current-buffer))
2700 ;; If they turned on hl-line, move the hl-line highlight to
2701 ;; the arrow's line.
2702 (when (featurep 'hl-line)
2703 (cond
2704 (global-hl-line-mode
2705 (global-hl-line-highlight))
2706 ((and hl-line-mode hl-line-sticky-flag)
2707 (hl-line-highlight)))))
2708 (cond ((or (< pos (point-min)) (> pos (point-max)))
2709 (widen)
2710 (goto-char pos))))
2711 (when window
2712 (set-window-point window gud-overlay-arrow-position)
2713 (if (memq gud-minor-mode '(gdbmi gdba))
2714 (setq gdb-source-window window)))))))
2716 ;; The gud-call function must do the right thing whether its invoking
2717 ;; keystroke is from the GUD buffer itself (via major-mode binding)
2718 ;; or a C buffer. In the former case, we want to supply data from
2719 ;; gud-last-frame. Here's how we do it:
2721 (defun gud-format-command (str arg)
2722 (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
2723 (frame (or gud-last-frame gud-last-last-frame))
2724 result)
2725 (while (and str
2726 (let ((case-fold-search nil))
2728 (let ((key (string-to-char (match-string 2 str)))
2729 subst)
2730 (cond
2731 ((eq key ?f)
2732 (setq subst (file-name-nondirectory (if insource
2733 (buffer-file-name)
2734 (car frame)))))
2735 ((eq key ?F)
2736 (setq subst (file-name-sans-extension
2737 (file-name-nondirectory (if insource
2738 (buffer-file-name)
2739 (car frame))))))
2740 ((eq key ?d)
2741 (setq subst (file-name-directory (if insource
2742 (buffer-file-name)
2743 (car frame)))))
2744 ((eq key ?l)
2745 (setq subst (int-to-string
2746 (if insource
2747 (save-restriction
2748 (widen)
2749 (+ (count-lines (point-min) (point))
2750 (if (bolp) 1 0)))
2751 (cdr frame)))))
2752 ((eq key ?e)
2753 (setq subst (gud-find-expr)))
2754 ((eq key ?a)
2755 (setq subst (gud-read-address)))
2756 ((eq key ?c)
2757 (setq subst
2758 (gud-find-class
2759 (if insource
2760 (buffer-file-name)
2761 (car frame))
2762 (if insource
2763 (save-restriction
2764 (widen)
2765 (+ (count-lines (point-min) (point))
2766 (if (bolp) 1 0)))
2767 (cdr frame)))))
2768 ((eq key ?p)
2769 (setq subst (if arg (int-to-string arg)))))
2770 (setq result (concat result (match-string 1 str) subst)))
2771 (setq str (substring str (match-end 2))))
2772 ;; There might be text left in STR when the loop ends.
2773 (concat result str)))
2775 (defun gud-read-address ()
2776 "Return a string containing the core-address found in the buffer at point."
2777 (save-match-data
2778 (save-excursion
2779 (let ((pt (point)) found begin)
2780 (setq found (if (search-backward "0x" (- pt 7) t) (point)))
2781 (cond
2782 (found (forward-char 2)
2783 (buffer-substring found
2784 (progn (re-search-forward "[^0-9a-f]")
2785 (forward-char -1)
2786 (point))))
2787 (t (setq begin (progn (re-search-backward "[^0-9]")
2788 (forward-char 1)
2789 (point)))
2790 (forward-char 1)
2791 (re-search-forward "[^0-9]")
2792 (forward-char -1)
2793 (buffer-substring begin (point))))))))
2795 (defun gud-call (fmt &optional arg)
2796 (let ((msg (gud-format-command fmt arg)))
2797 (message "Command: %s" msg)
2798 (sit-for 0)
2799 (gud-basic-call msg)))
2801 (defun gud-basic-call (command)
2802 "Invoke the debugger COMMAND displaying source in other window."
2803 (interactive)
2804 (gud-set-buffer)
2805 (let ((proc (get-buffer-process gud-comint-buffer)))
2806 (or proc (error "Current buffer has no process"))
2807 ;; Arrange for the current prompt to get deleted.
2808 (save-excursion
2809 (set-buffer gud-comint-buffer)
2810 (save-restriction
2811 (widen)
2812 (if (marker-position gud-delete-prompt-marker)
2813 ;; We get here when printing an expression.
2814 (goto-char gud-delete-prompt-marker)
2815 (goto-char (process-mark proc))
2816 (forward-line 0))
2817 (if (looking-at comint-prompt-regexp)
2818 (set-marker gud-delete-prompt-marker (point)))
2819 (if (memq gud-minor-mode '(gdbmi gdba))
2820 (apply comint-input-sender (list proc command))
2823 (defun gud-refresh (&optional arg)
2824 "Fix up a possibly garbled display, and redraw the arrow."
2825 (interactive "P")
2826 (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
2827 (gud-display-frame)
2828 (recenter arg))
2829 \f
2830 ;; Code for parsing expressions out of C or Fortran code. The single entry
2831 ;; point is gud-find-expr, which tries to return an lvalue expression from
2832 ;; around point.
2834 (defvar gud-find-expr-function 'gud-find-c-expr)
2836 (defun gud-find-expr (&rest args)
2837 (let ((expr (if (and transient-mark-mode mark-active)
2838 (buffer-substring (region-beginning) (region-end))
2839 (apply gud-find-expr-function args))))
2840 (save-match-data
2842 (error "Expression must not include a newline"))
2843 (with-current-buffer gud-comint-buffer
2844 (save-excursion
2845 (goto-char (process-mark (get-buffer-process gud-comint-buffer)))
2846 (forward-line 0)
2847 (when (looking-at comint-prompt-regexp)
2848 (set-marker gud-delete-prompt-marker (point))
2849 (set-marker-insertion-type gud-delete-prompt-marker t))
2850 (unless (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
2851 'jdb)
2852 (insert (concat expr " = "))))))
2853 expr))
2855 ;; The next eight functions are hacked from gdbsrc.el by
2856 ;; Debby Ayers <ayers@asc.slb.com>,
2857 ;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
2859 (defun gud-find-c-expr ()
2860 "Returns the expr that surrounds point."
2861 (interactive)
2862 (save-excursion
2863 (let ((p (point))
2864 (expr (gud-innermost-expr))
2865 (test-expr (gud-prev-expr)))
2866 (while (and test-expr (gud-expr-compound test-expr expr))
2867 (let ((prev-expr expr))
2868 (setq expr (cons (car test-expr) (cdr expr)))
2869 (goto-char (car expr))
2870 (setq test-expr (gud-prev-expr))
2871 ;; If we just pasted on the condition of an if or while,
2872 ;; throw it away again.
2873 (if (member (buffer-substring (car test-expr) (cdr test-expr))
2874 '("if" "while" "for"))
2875 (setq test-expr nil
2876 expr prev-expr))))
2877 (goto-char p)
2878 (setq test-expr (gud-next-expr))
2879 (while (gud-expr-compound expr test-expr)
2880 (setq expr (cons (car expr) (cdr test-expr)))
2881 (setq test-expr (gud-next-expr)))
2882 (buffer-substring (car expr) (cdr expr)))))
2884 (defun gud-innermost-expr ()
2885 "Returns the smallest expr that point is in; move point to beginning of it.
2886 The expr is represented as a cons cell, where the car specifies the point in
2887 the current buffer that marks the beginning of the expr and the cdr specifies
2888 the character after the end of the expr."
2889 (let ((p (point)) begin end)
2890 (gud-backward-sexp)
2891 (setq begin (point))
2892 (gud-forward-sexp)
2893 (setq end (point))
2894 (if (>= p end)
2895 (progn
2896 (setq begin p)
2897 (goto-char p)
2898 (gud-forward-sexp)
2899 (setq end (point)))
2900 )
2901 (goto-char begin)
2902 (cons begin end)))
2904 (defun gud-backward-sexp ()
2905 "Version of `backward-sexp' that catches errors."
2906 (condition-case nil
2907 (backward-sexp)
2908 (error t)))
2910 (defun gud-forward-sexp ()
2911 "Version of `forward-sexp' that catches errors."
2912 (condition-case nil
2913 (forward-sexp)
2914 (error t)))
2916 (defun gud-prev-expr ()
2917 "Returns the previous expr, point is set to beginning of that expr.
2918 The expr is represented as a cons cell, where the car specifies the point in
2919 the current buffer that marks the beginning of the expr and the cdr specifies
2920 the character after the end of the expr"
2921 (let ((begin) (end))
2922 (gud-backward-sexp)
2923 (setq begin (point))
2924 (gud-forward-sexp)
2925 (setq end (point))
2926 (goto-char begin)
2927 (cons begin end)))
2929 (defun gud-next-expr ()
2930 "Returns the following expr, point is set to beginning of that expr.
2931 The expr is represented as a cons cell, where the car specifies the point in
2932 the current buffer that marks the beginning of the expr and the cdr specifies
2933 the character after the end of the expr."
2934 (let ((begin) (end))
2935 (gud-forward-sexp)
2936 (gud-forward-sexp)
2937 (setq end (point))
2938 (gud-backward-sexp)
2939 (setq begin (point))
2940 (cons begin end)))
2942 (defun gud-expr-compound-sep (span-start span-end)
2943 "Scan from SPAN-START to SPAN-END for punctuation characters.
2944 If `->' is found, return `?.'. If `.' is found, return `?.'.
2945 If any other punctuation is found, return `??'.
2946 If no punctuation is found, return `? '."
2947 (let ((result ?\s)
2948 (syntax))
2949 (while (< span-start span-end)
2950 (setq syntax (char-syntax (char-after span-start)))
2951 (cond
2952 ((= syntax ?\s) t)
2953 ((= syntax ?.) (setq syntax (char-after span-start))
2954 (cond
2955 ((= syntax ?.) (setq result ?.))
2956 ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
2957 (setq result ?.)
2958 (setq span-start (+ span-start 1)))
2959 (t (setq span-start span-end)
2960 (setq result ??)))))
2961 (setq span-start (+ span-start 1)))
2962 result))
2964 (defun gud-expr-compound (first second)
2965 "Non-nil if concatenating FIRST and SECOND makes a single C expression.
2966 The two exprs are represented as a cons cells, where the car
2967 specifies the point in the current buffer that marks the beginning of the
2968 expr and the cdr specifies the character after the end of the expr.
2969 Link exprs of the form:
2970 Expr -> Expr
2971 Expr . Expr
2972 Expr (Expr)
2973 Expr [Expr]
2974 (Expr) Expr
2975 [Expr] Expr"
2976 (let ((span-start (cdr first))
2977 (span-end (car second))
2978 (syntax))
2979 (setq syntax (gud-expr-compound-sep span-start span-end))
2980 (cond
2981 ((= (car first) (car second)) nil)
2982 ((= (cdr first) (cdr second)) nil)
2983 ((= syntax ?.) t)
2984 ((= syntax ?\s)
2985 (setq span-start (char-after (- span-start 1)))
2986 (setq span-end (char-after span-end))
2987 (cond
2988 ((= span-start ?)) t)
2989 ((= span-start ?]) t)
2990 ((= span-end ?() t)
2991 ((= span-end ?[) t)
2992 (t nil)))
2993 (t nil))))
2995 (defun gud-find-class (f line)
2996 "Find fully qualified class in file F at line LINE.
2997 This function uses the `gud-jdb-classpath' (and optional
2998 `gud-jdb-sourcepath') list(s) to derive a file
2999 pathname relative to its classpath directory. The values in
3000 `gud-jdb-classpath' are assumed to have been converted to absolute
3001 pathname standards using file-truename.
3002 If F is visited by a buffer and its mode is CC-mode(Java),
3003 syntactic information of LINE is used to find the enclosing (nested)
3004 class string which is appended to the top level
3005 class of the file (using s to separate nested class ids)."
3006 ;; Convert f to a standard representation and remove suffix
3007 (if (and gud-jdb-use-classpath (or gud-jdb-classpath gud-jdb-sourcepath))
3008 (save-match-data
3009 (let ((cplist (append gud-jdb-sourcepath gud-jdb-classpath))
3010 (fbuffer (get-file-buffer f))
3011 syntax-symbol syntax-point class-found)
3012 (setq f (file-name-sans-extension (file-truename f)))
3013 ;; Syntax-symbol returns the symbol of the *first* element
3014 ;; in the syntactical analysis result list, syntax-point
3015 ;; returns the buffer position of same
3016 (fset 'syntax-symbol (lambda (x) (c-langelem-sym (car x))))
3017 (fset 'syntax-point (lambda (x) (c-langelem-pos (car x))))
3018 ;; Search through classpath list for an entry that is
3019 ;; contained in f
3020 (while (and cplist (not class-found))
3021 (if (string-match (car cplist) f)
3022 (setq class-found
3023 (mapconcat 'identity
3024 (split-string
3025 (substring f (+ (match-end 0) 1))
3026 "/") ".")))
3027 (setq cplist (cdr cplist)))
3028 ;; if f is visited by a java(cc-mode) buffer, walk up the
3029 ;; syntactic information chain and collect any 'inclass
3030 ;; symbols until 'topmost-intro is reached to find out if
3031 ;; point is within a nested class
3032 (if (and fbuffer (equal (symbol-file 'java-mode) "cc-mode"))
3033 (save-excursion
3034 (set-buffer fbuffer)
3035 (let ((nclass) (syntax))
3036 ;; While the c-syntactic information does not start
3037 ;; with the 'topmost-intro symbol, there may be
3038 ;; nested classes...
3039 (while (not (eq 'topmost-intro
3040 (syntax-symbol (c-guess-basic-syntax))))
3041 ;; Check if the current position c-syntactic
3042 ;; analysis has 'inclass
3043 (setq syntax (c-guess-basic-syntax))
3044 (while
3045 (and (not (eq 'inclass (syntax-symbol syntax)))
3046 (cdr syntax))
3047 (setq syntax (cdr syntax)))
3048 (if (eq 'inclass (syntax-symbol syntax))
3049 (progn
3050 (goto-char (syntax-point syntax))
3051 ;; Now we're at the beginning of a class
3052 ;; definition. Find class name
3053 (looking-at
3055 (setq nclass
3056 (append (list (match-string-no-properties 1))
3057 nclass)))
3058 (setq syntax (c-guess-basic-syntax))
3059 (while (and (not (syntax-point syntax)) (cdr syntax))
3060 (setq syntax (cdr syntax)))
3061 (goto-char (syntax-point syntax))
3062 ))
3063 (string-match (concat (car nclass) "$") class-found)
3064 (setq class-found
3065 (replace-match (mapconcat 'identity nclass "$")
3066 t t class-found)))))
3067 (if (not class-found)
3068 (message "gud-find-class: class for file %s not found!" f))
3069 class-found))
3070 ;; Not using classpath - try class/source association list
3071 (let ((class-found (rassoc f gud-jdb-class-source-alist)))
3072 (if class-found
3073 (car class-found)
3074 (message "gud-find-class: class for file %s not found in gud-jdb-class-source-alist!" f)
3075 nil))))
3077 \f
3078 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3079 ;;; GDB script mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3080 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3082 (defvar gdb-script-mode-syntax-table
3083 (let ((st (make-syntax-table)))
3085 (modify-syntax-entry ?# "<" st)
3087 st))
3089 (defvar gdb-script-font-lock-keywords
3094 (defvar gdb-script-font-lock-syntactic-keywords
3097 (0 (unless (eq (match-beginning 0) (point-min))
3100 ;; both the beginning and the end of the docstring, which can't be
3101 ;; expressed in syntax-tables. Instead, we place the "> b" after
3102 ;; placing the "< b", so the start marker is overwritten by the
3103 ;; termination marker and in the end Emacs simply considers that
3104 ;; there's no docstring at all, which is fine.
3105 (put-text-property (1- (match-beginning 0)) (match-beginning 0)
3106 'syntax-table (eval-when-compile
3107 (string-to-syntax "> b")))
3108 ;; Make sure that rehighlighting the previous line won't erase our
3109 ;; syntax-table property.
3110 (put-text-property (1- (match-beginning 0)) (match-end 0)
3111 'font-lock-multiline t)
3112 nil)))))
3114 (defun gdb-script-font-lock-syntactic-face (state)
3115 (cond
3116 ((nth 3 state) font-lock-string-face)
3117 ((nth 7 state) font-lock-doc-face)
3118 (t font-lock-comment-face)))
3120 (defvar gdb-script-basic-indent 2)
3122 (defun gdb-script-skip-to-head ()
3123 "We're just in front of an `end' and we need to go to its head."
3124 (while (and (re-search-backward "^\\s-*\\(\\(end\\)\\|define\\|document\\|if\\|while\\|commands\\)\\>" nil 'move)
3125 (match-end 2))
3126 (gdb-script-skip-to-head)))
3128 (defun gdb-script-calculate-indentation ()
3129 (cond
3131 (gdb-script-skip-to-head)
3132 (current-indentation))
3135 (match-end 2))
3136 (gdb-script-skip-to-head))
3137 (current-indentation))
3138 (t
3139 (forward-comment (- (point-max)))
3140 (forward-line 0)
3142 (+ (current-indentation)
3144 gdb-script-basic-indent 0)))))
3146 (defun gdb-script-indent-line ()
3147 "Indent current line of GDB script."
3148 (interactive)
3149 (if (and (eq (get-text-property (point) 'face) font-lock-doc-face)
3150 (save-excursion
3151 (forward-line 0)
3154 'noindent
3155 (let* ((savep (point))
3156 (indent (condition-case nil
3157 (save-excursion
3158 (forward-line 0)
3160 (if (>= (point) savep) (setq savep nil))
3161 (max (gdb-script-calculate-indentation) 0))
3162 (error 0))))
3163 (if savep
3164 (save-excursion (indent-line-to indent))
3165 (indent-line-to indent)))))
3167 ;; Derived from cfengine.el.
3168 (defun gdb-script-beginning-of-defun ()
3169 "`beginning-of-defun' function for Gdb script mode.
3170 Treats actions as defuns."
3171 (unless (<= (current-column) (current-indentation))
3172 (end-of-line))
3174 (beginning-of-line)
3175 (goto-char (point-min)))
3176 t)
3178 ;; Derived from cfengine.el.
3179 (defun gdb-script-end-of-defun ()
3180 "`end-of-defun' function for Gdb script mode.
3181 Treats actions as defuns."
3182 (end-of-line)
3183 (if (re-search-forward "^end" nil t)
3184 (beginning-of-line)
3185 (goto-char (point-max)))
3186 t)
3188 ;; Besides .gdbinit, gdb documents other names to be usable for init
3189 ;; files, cross-debuggers can use something like
3190 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
3191 ;; don't interfere with each other.
3192 ;;;###autoload
3195 ;;;###autoload
3196 (define-derived-mode gdb-script-mode nil "GDB-Script"
3197 "Major mode for editing GDB scripts"
3198 (set (make-local-variable 'comment-start) "#")
3201 (set (make-local-variable 'imenu-generic-expression)
3203 (set (make-local-variable 'indent-line-function) 'gdb-script-indent-line)
3204 (set (make-local-variable 'beginning-of-defun-function)
3205 #'gdb-script-beginning-of-defun)
3206 (set (make-local-variable 'end-of-defun-function)
3207 #'gdb-script-end-of-defun)
3208 (set (make-local-variable 'font-lock-defaults)
3209 '(gdb-script-font-lock-keywords nil nil ((?_ . "w")) nil
3210 (font-lock-syntactic-keywords
3211 . gdb-script-font-lock-syntactic-keywords)
3212 (font-lock-syntactic-face-function
3213 . gdb-script-font-lock-syntactic-face))))
3215 \f
3216 ;;; tooltips for GUD
3218 ;;; Customizable settings
3220 (define-minor-mode gud-tooltip-mode
3221 "Toggle the display of GUD tooltips."
3222 :global t
3223 :group 'gud
3224 :group 'tooltip
3225 (require 'tooltip)
3226 (if gud-tooltip-mode
3227 (progn
3228 (add-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3229 (add-hook 'pre-command-hook 'tooltip-hide)
3230 (add-hook 'tooltip-hook 'gud-tooltip-tips)
3231 (define-key global-map [mouse-movement] 'gud-tooltip-mouse-motion))
3232 (unless tooltip-mode (remove-hook 'pre-command-hook 'tooltip-hide)
3233 (remove-hook 'change-major-mode-hook 'gud-tooltip-change-major-mode)
3234 (remove-hook 'tooltip-hook 'gud-tooltip-tips)
3235 (define-key global-map [mouse-movement] 'ignore)))
3236 (gud-tooltip-activate-mouse-motions-if-enabled)
3237 (if (and gud-comint-buffer
3238 (buffer-name gud-comint-buffer); gud-comint-buffer might be killed
3239 (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
3240 '(gdbmi gdba)))
3241 (if gud-tooltip-mode
3242 (progn
3243 (dolist (buffer (buffer-list))
3244 (unless (eq buffer gud-comint-buffer)
3245 (with-current-buffer buffer
3246 (when (and (memq gud-minor-mode '(gdbmi gdba))
3248 (buffer-name))))
3249 (make-local-variable 'gdb-define-alist)
3250 (gdb-create-define-alist)
3251 (add-hook 'after-save-hook
3252 'gdb-create-define-alist nil t))))))
3253 (kill-local-variable 'gdb-define-alist)
3254 (remove-hook 'after-save-hook 'gdb-create-define-alist t))))
3256 (defcustom gud-tooltip-modes '(gud-mode c-mode c++-mode fortran-mode
3257 python-mode)
3258 "List of modes for which to enable GUD tooltips."
3259 :type 'sexp
3260 :group 'gud
3261 :group 'tooltip)
3263 (defcustom gud-tooltip-display
3264 '((eq (tooltip-event-buffer gud-tooltip-event)
3265 (marker-buffer gud-overlay-arrow-position)))
3266 "List of forms determining where GUD tooltips are displayed.
3268 Forms in the list are combined with AND. The default is to display
3269 only tooltips in the buffer containing the overlay arrow."
3270 :type 'sexp
3271 :group 'gud
3272 :group 'tooltip)
3274 (defcustom gud-tooltip-echo-area nil
3275 "Use the echo area instead of frames for GUD tooltips."
3276 :type 'boolean
3277 :group 'gud
3278 :group 'tooltip)
3280 (define-obsolete-variable-alias 'tooltip-gud-modes
3281 'gud-tooltip-modes "22.1")
3282 (define-obsolete-variable-alias 'tooltip-gud-display
3283 'gud-tooltip-display "22.1")
3285 ;;; Reacting on mouse movements
3287 (defun gud-tooltip-change-major-mode ()
3288 "Function added to `change-major-mode-hook' when tooltip mode is on."
3289 (add-hook 'post-command-hook 'gud-tooltip-activate-mouse-motions-if-enabled))
3291 (defun gud-tooltip-activate-mouse-motions-if-enabled ()
3292 "Reconsider for all buffers whether mouse motion events are desired."
3293 (remove-hook 'post-command-hook
3294 'gud-tooltip-activate-mouse-motions-if-enabled)
3295 (dolist (buffer (buffer-list))
3296 (save-excursion
3297 (set-buffer buffer)
3298 (if (and gud-tooltip-mode
3299 (memq major-mode gud-tooltip-modes))
3300 (gud-tooltip-activate-mouse-motions t)
3301 (gud-tooltip-activate-mouse-motions nil)))))
3303 (defvar gud-tooltip-mouse-motions-active nil
3304 "Locally t in a buffer if tooltip processing of mouse motion is enabled.")
3306 ;; We don't set track-mouse globally because this is a big redisplay
3307 ;; problem in buffers having a pre-command-hook or such installed,
3308 ;; which does a set-buffer, like the summary buffer of Gnus. Calling
3309 ;; set-buffer prevents redisplay optimizations, so every mouse motion
3310 ;; would be accompanied by a full redisplay.
3312 (defun gud-tooltip-activate-mouse-motions (activatep)
3313 "Activate/deactivate mouse motion events for the current buffer.
3314 ACTIVATEP non-nil means activate mouse motion events."
3315 (if activatep
3316 (progn
3317 (make-local-variable 'gud-tooltip-mouse-motions-active)
3318 (setq gud-tooltip-mouse-motions-active t)
3319 (make-local-variable 'track-mouse)
3320 (setq track-mouse t))
3321 (when gud-tooltip-mouse-motions-active
3322 (kill-local-variable 'gud-tooltip-mouse-motions-active)
3323 (kill-local-variable 'track-mouse))))
3325 (defun gud-tooltip-mouse-motion (event)
3326 "Command handler for mouse movement events in `global-map'."
3327 (interactive "e")
3328 (tooltip-hide)
3329 (when (car (mouse-pixel-position))
3330 (setq tooltip-last-mouse-motion-event (copy-sequence event))
3331 (tooltip-start-delayed-tip)))
3333 ;;; Tips for `gud'
3335 (defvar gud-tooltip-original-filter nil
3336 "Process filter to restore after GUD output has been received.")
3338 (defvar gud-tooltip-dereference nil
3339 "Non-nil means print expressions with a `*' in front of them.
3340 For C this would dereference a pointer expression.")
3342 (defvar gud-tooltip-event nil
3343 "The mouse movement event that led to a tooltip display.
3344 This event can be examined by forms in GUD-TOOLTIP-DISPLAY.")
3346 (defun gud-tooltip-dereference (&optional arg)
3347 "Toggle whether tooltips should show `* expr' or `expr'.
3348 With arg, dereference expr if ARG is positive, otherwise do not derereference."
3349 (interactive "P")
3350 (setq gud-tooltip-dereference
3351 (if (null arg)
3352 (not gud-tooltip-dereference)
3353 (> (prefix-numeric-value arg) 0)))
3354 (message "Dereferencing is now %s."
3355 (if gud-tooltip-dereference "on" "off")))
3357 (define-obsolete-function-alias 'tooltip-gud-toggle-dereference
3358 'gud-tooltip-dereference "22.1")
3360 ; This will only display data that comes in one chunk.
3361 ; Larger arrays (say 400 elements) are displayed in
3362 ; the tooltip incompletely and spill over into the gud buffer.
3363 ; Switching the process-filter creates timing problems and
3364 ; it may be difficult to do better. Using annotations as in
3365 ; gdb-ui.el gets round this problem.
3366 (defun gud-tooltip-process-output (process output)
3367 "Process debugger output and show it in a tooltip window."
3368 (set-process-filter process gud-tooltip-original-filter)
3369 (tooltip-show (tooltip-strip-prompt process output)
3370 (or gud-tooltip-echo-area tooltip-use-echo-area)))
3372 (defun gud-tooltip-print-command (expr)
3373 "Return a suitable command to print the expression EXPR."
3374 (case gud-minor-mode
3375 (gdba (concat "server print " expr))
3376 ((dbx gdbmi) (concat "print " expr))
3377 ((xdb pdb) (concat "p " expr))
3378 (sdb (concat expr "/"))))
3380 (defun gud-tooltip-tips (event)
3381 "Show tip for identifier or selection under the mouse.
3382 The mouse must either point at an identifier or inside a selected
3383 region for the tip window to be shown. If gud-tooltip-dereference is t,
3384 add a `*' in front of the printed expression. In the case of a C program
3385 controlled by GDB, show the associated #define directives when program is
3386 not executing.
3388 This function must return nil if it doesn't handle EVENT."
3389 (let (process)
3390 (when (and (eventp event)
3391 gud-tooltip-mode
3392 gud-comint-buffer
3393 (buffer-name gud-comint-buffer); might be killed
3394 (setq process (get-buffer-process gud-comint-buffer))
3395 (posn-point (event-end event))
3396 (or (and (eq gud-minor-mode 'gdba) (not gdb-active-process))
3397 (progn (setq gud-tooltip-event event)
3398 (eval (cons 'and gud-tooltip-display)))))
3399 (let ((expr (tooltip-expr-to-print event)))
3400 (when expr
3401 (if (and (eq gud-minor-mode 'gdba)
3402 (not gdb-active-process))
3403 (progn
3404 (with-current-buffer
3405 (window-buffer (let ((mouse (mouse-position)))
3406 (window-at (cadr mouse)
3407 (cddr mouse))))
3408 (let ((define-elt (assoc expr gdb-define-alist)))
3409 (unless (null define-elt)
3410 (tooltip-show
3411 (cdr define-elt)
3412 (or gud-tooltip-echo-area tooltip-use-echo-area))
3413 expr))))
3414 (when gud-tooltip-dereference
3415 (setq expr (concat "*" expr)))
3416 (let ((cmd (gud-tooltip-print-command expr)))
3417 (when (and gud-tooltip-mode (eq gud-minor-mode 'gdb))
3418 (gud-tooltip-mode -1)
3420 so they have been disabled."))
3421 (unless (null cmd) ; CMD can be nil if unknown debugger
3422 (if (memq gud-minor-mode '(gdba gdbmi))
3423 (if gdb-macro-info
3424 (gdb-enqueue-input
3425 (list (concat
3427 `(lambda () (gdb-tooltip-print-1 ,expr))))
3428 (gdb-enqueue-input
3430 `(lambda () (gdb-tooltip-print ,expr)))))
3431 (setq gud-tooltip-original-filter (process-filter process))
3432 (set-process-filter process 'gud-tooltip-process-output)
3433 (gud-basic-call cmd))
3434 expr))))))))
3436 (provide 'gud)
3438 ;;; arch-tag: 6d990948-df65-461a-be39-1c7fb83ac4c4
3439 ;;; gud.el ends here