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