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