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