-;;; gud.el --- Grand Unified Debugger mode for gdb, sdb, or dbx under Emacs
+;;; gud.el --- Grand Unified Debugger mode for gdb, sdb, dbx, or xdb
+;;; under Emacs
-;; Author: Eric S. Raymond <eric@snark.thyrsus.com>
+;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
+;; Maintainer: FSF
+;; Version: 1.3
;; Keywords: unix, tools
-;; %W%
-
-;; Copyright (C) 1992 Free Software Foundation, Inc.
+;; Copyright (C) 1992, 1993, 1994 Free Software Foundation, Inc.
;; This file is part of GNU Emacs.
;; It was later rewritten by rms. Some ideas were due to Masanobu.
;; Grand Unification (sdb/dbx support) by Eric S. Raymond <esr@thyrsus.com>
;; The overloading code was then rewritten by Barry Warsaw <bwarsaw@cen.com>,
-;; who also hacked the mode to use comint.el.
-
-;; Note: use of this package with sdb requires that your tags.el support
-;; the find-tag-noselect entry point. Stock distributions up to 18.57 do
-;; *not* include this feature; if it's not included with this file, email
-;; esr@snark.thyrsus.com for it or get 18.58.
-
-;; Further note: due to lossage in the Emacs-18 byte compiler, compiled
-;; versions of this code will fail with a complaint about gud-step if
-;; you invoke the gdb or sdb initializers. This should be fixed in 19.
+;; who also hacked the mode to use comint.el. Shane Hartman <shane@spr.com>
+;; added support for xdb (HPUX debugger). Rick Sladkey <jrs@world.std.com>
+;; wrote the GDB command completion code. Dave Love <d.love@dl.ac.uk>
+;; added the IRIX kluge and re-implemented the Mips-ish variant.
;;; Code:
(require 'comint)
(require 'etags)
+;; ======================================================================
+;; GUD commands must be visible in C buffers visited by GUD
+
+(defvar gud-key-prefix "\C-x\C-a"
+ "Prefix of all GUD commands valid in C buffers.")
+
+(global-set-key (concat gud-key-prefix "\C-l") 'gud-refresh)
+(define-key ctl-x-map " " 'gud-break) ;; backward compatibility hack
+
;; ======================================================================
;; the overloading mechanism
(function (lambda (p) (fset (car p) (symbol-function (cdr p)))))
gud-overload-alist))
-(defun gud-debugger-startup (f d)
- (error "GUD not properly entered."))
-
-(defun gud-marker-filter (proc s)
- (error "GUD not properly entered."))
+(defun gud-massage-args (file args)
+ (error "GUD not properly entered"))
-(defun gud-visit-file (f)
- (error "GUD not properly entered."))
+(defun gud-marker-filter (str)
+ (error "GUD not properly entered"))
-(defun gud-set-break (proc f n rest)
- (error "GUD not properly entered."))
+(defun gud-find-file (f)
+ (error "GUD not properly entered"))
+\f
+;; ======================================================================
+;; command definition
;; This macro is used below to define some basic debugger interface commands.
;; Of course you may use `gud-def' with any other debugger command, including
;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
;; which defines FUNC to send the command NAME to the debugger, gives
-;; it the docstring DOC, and binds that function to KEY. NAME should
-;; be a string. If a numeric prefix argument is given to FUNC, it
-;; gets sent after NAME.
-
-(defmacro gud-def (func name key &optional doc)
- (let* ((cstr (list 'if '(not (= 1 arg))
- (list 'format "%s %s" name 'arg)
- name)))
- (list 'progn
- (list 'defun func '(arg)
- (or doc "")
- '(interactive "p")
- (list 'gud-call cstr))
- (if key
- (list 'define-key 'gud-mode-map key (list 'quote func))))))
+;; it the docstring DOC, and binds that function to KEY in the GUD
+;; major mode. The function is also bound in the global keymap with the
+;; GUD prefix.
+
+(defmacro gud-def (func cmd key &optional doc)
+ "Define FUNC to be a command sending STR and bound to KEY, with
+optional doc string DOC. Certain %-escapes in the string arguments
+are interpreted specially if present. These are:
+
+ %f name (without directory) of current source file.
+ %d directory of current source file.
+ %l number of current source line
+ %e text of the C lvalue or function-call expression surrounding point.
+ %a text of the hexadecimal address surrounding point
+ %p prefix argument to the command (if any) as a number
+
+ The `current' source file is the file of the current buffer (if
+we're in a C file) or the source file current at the last break or
+step (if we're in the GUD buffer).
+ The `current' line is that of the current buffer (if we're in a
+source file) or the source line number at the last break or step (if
+we're in the GUD buffer)."
+ (list 'progn
+ (list 'defun func '(arg)
+ (or doc "")
+ '(interactive "p")
+ (list 'gud-call cmd 'arg))
+ (if key
+ (list 'define-key
+ '(current-local-map)
+ (concat "\C-c" key)
+ (list 'quote func)))
+ (if key
+ (list 'global-set-key
+ (list 'concat 'gud-key-prefix key)
+ (list 'quote func)))))
;; Where gud-display-frame should put the debugging arrow. This is
;; set by the marker-filter, which scans the debugger's output for
-;; indications of the current pc.
+;; indications of the current program counter.
(defvar gud-last-frame nil)
-;; All debugger-specific information is collected here
-;; Here's how it works, in case you ever need to add a debugger to the table.
+;; Used by gud-refresh, which should cause gud-display-frame to redisplay
+;; the last frame, even if it's been called before and gud-last-frame has
+;; been set to nil.
+(defvar gud-last-last-frame nil)
+
+;; All debugger-specific information is collected here.
+;; Here's how it works, in case you ever need to add a debugger to the mode.
;;
;; Each entry must define the following at startup:
;;
;;<name>
;; comint-prompt-regexp
-;; gud-<name>-debugger-startup
+;; gud-<name>-massage-args
;; gud-<name>-marker-filter
-;; gud-<name>-visit-file
-;; gud-<name>-set-break
+;; gud-<name>-find-file
;;
-;; The job of the startup-command method is to fire up a copy of the debugger,
-;; given an object file and source directory.
+;; The job of the massage-args method is to modify the given list of
+;; debugger arguments before running the debugger.
;;
;; The job of the marker-filter method is to detect file/line markers in
;; strings and set the global gud-last-frame to indicate what display
;; action (if any) should be triggered by the marker. Note that only
-;; whetever the method *returns* is displayed in the buffer; thus, you
+;; whatever the method *returns* is displayed in the buffer; thus, you
;; can filter the debugger's output, interpreting some and passing on
;; the rest.
;;
-;; The job of the visit-file method is to visit and return the buffer indicated
+;; The job of the find-file method is to visit and return the buffer indicated
;; by the car of gud-tag-frame. This may be a file name, a tag name, or
;; something else.
-;;
-;; The job of the gud-set-break method is to send the commands
-;; necessary to set a breakpoint at a given line in a given source
-;; file. If its third argument TEMP is non-nil, the breakpoint set
-;; should be temporary - it should be deleted when it is reached. If
-;; the debugger doesn't support such breakpoints, it should set an
-;; ordinary breakpoint.
-;;
-;; Debugger-specific information begins here:
-
+\f
;; ======================================================================
;; gdb functions
-(defun gud-gdb-debugger-startup (f d)
- (make-comint (concat "gud-" f) "gdb" nil "-fullname" "-cd" d f))
-
-(defun gud-gdb-marker-filter (proc string)
- (if (string-match "\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n" string)
- (progn
- (setq gud-last-frame
- (cons
- (substring string (match-beginning 1) (match-end 1))
- (string-to-int
- (substring string (match-beginning 2) (match-end 2)))))
- ;; this computation means the ^Z^Z-initiated marker in the
- ;; input string is never emitted.
- (concat
- (substring string 0 (match-beginning 0))
- (substring string (match-end 0))
- ))
- string))
-
-(defun gud-gdb-visit-file (f)
+;;; History of argument lists passed to gdb.
+(defvar gud-gdb-history nil)
+
+(defun gud-gdb-massage-args (file args)
+ (cons "-fullname" (cons file args)))
+
+;; There's no guarantee that Emacs will hand the filter the entire
+;; marker at once; it could be broken up across several strings. We
+;; might even receive a big chunk with several markers in it. If we
+;; receive a chunk of text which looks like it might contain the
+;; beginning of a marker, we save it here between calls to the
+;; filter.
+(defvar gud-marker-acc "")
+(make-variable-buffer-local 'gud-marker-acc)
+
+(defun gud-gdb-marker-filter (string)
+ (save-match-data
+ (setq gud-marker-acc (concat gud-marker-acc string))
+ (let ((output ""))
+
+ ;; Process all the complete markers in this chunk.
+ (while (string-match "\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
+ gud-marker-acc)
+ (setq
+
+ ;; Extract the frame position from the marker.
+ gud-last-frame
+ (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
+ (string-to-int (substring gud-marker-acc
+ (match-beginning 2)
+ (match-end 2))))
+
+ ;; Append any text before the marker to the output we're going
+ ;; to return - we don't include the marker in this text.
+ output (concat output
+ (substring gud-marker-acc 0 (match-beginning 0)))
+
+ ;; Set the accumulator to the remaining text.
+ gud-marker-acc (substring gud-marker-acc (match-end 0))))
+
+ ;; Does the remaining text look like it might end with the
+ ;; beginning of another marker? If it does, then keep it in
+ ;; gud-marker-acc until we receive the rest of it. Since we
+ ;; know the full marker regexp above failed, it's pretty simple to
+ ;; test for marker starts.
+ (if (string-match "\032.*\\'" gud-marker-acc)
+ (progn
+ ;; Everything before the potential marker start can be output.
+ (setq output (concat output (substring gud-marker-acc
+ 0 (match-beginning 0))))
+
+ ;; Everything after, we save, to combine with later input.
+ (setq gud-marker-acc
+ (substring gud-marker-acc (match-beginning 0))))
+
+ (setq output (concat output gud-marker-acc)
+ gud-marker-acc ""))
+
+ output)))
+
+(defun gud-gdb-find-file (f)
(find-file-noselect f))
-(defun gud-gdb-set-break (proc f n temp)
- (gud-call "%s %s:%d" (if temp "tbreak" "break") f n))
+(defvar gdb-minibuffer-local-map nil
+ "Keymap for minibuffer prompting of gdb startup command.")
+(if gdb-minibuffer-local-map
+ ()
+ (setq gdb-minibuffer-local-map (copy-keymap minibuffer-local-map))
+ (define-key
+ gdb-minibuffer-local-map "\C-i" 'comint-dynamic-complete-filename))
;;;###autoload
-(defun gdb (path)
+(defun gdb (command-line)
"Run gdb on program FILE in buffer *gud-FILE*.
The directory containing FILE becomes the initial working directory
and source-file directory for your debugger."
- (interactive "fRun gdb on file: ")
- (gud-overload-functions '((gud-debugger-startup . gud-gdb-debugger-startup)
- (gud-marker-filter . gud-gdb-marker-filter)
- (gud-visit-file . gud-gdb-visit-file)
- (gud-set-break . gud-gdb-set-break)))
+ (interactive
+ (list (read-from-minibuffer "Run gdb (like this): "
+ (if (consp gud-gdb-history)
+ (car gud-gdb-history)
+ "gdb ")
+ gdb-minibuffer-local-map nil
+ '(gud-gdb-history . 1))))
+ (gud-overload-functions '((gud-massage-args . gud-gdb-massage-args)
+ (gud-marker-filter . gud-gdb-marker-filter)
+ (gud-find-file . gud-gdb-find-file)
+ ))
+
+ (gud-common-init command-line)
+
+ (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
+ (gud-def gud-tbreak "tbreak %f:%l" "\C-t" "Set breakpoint at current line.")
+ (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
+ (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
+ (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
+ (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
+ (gud-def gud-cont "cont" "\C-r" "Continue with display.")
+ (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
+ (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
+ (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
+ (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
+
+ (local-set-key "\C-i" 'gud-gdb-complete-command)
+ (setq comint-prompt-regexp "^(.*gdb[+]?) *")
+ (setq paragraph-start comint-prompt-regexp)
+ (run-hooks 'gdb-mode-hook)
+ )
- (gud-def gud-step "step" "\C-c\C-s" "Step one source line with display")
- (gud-def gud-stepi "stepi" "\C-c\C-i" "Step one instruction with display")
- (gud-def gud-next "next" "\C-c\C-n" "Step one line (skip functions)")
- (gud-def gud-cont "cont" "\C-c\C-r" "Continue with display")
+;; One of the nice features of GDB is its impressive support for
+;; context-sensitive command completion. We preserve that feature
+;; in the GUD buffer by using a GDB command designed just for Emacs.
- (gud-def gud-finish "finish" "\C-c\C-f" "Finish executing current function")
- (gud-def gud-up "up" "\C-c<" "Up N stack frames (numeric arg)")
- (gud-def gud-down "down" "\C-c>" "Down N stack frames (numeric arg)")
+;; The completion process filter indicates when it is finished.
+(defvar gud-gdb-complete-in-progress)
- (gud-common-init path)
+;; Since output may arrive in fragments we accumulate partials strings here.
+(defvar gud-gdb-complete-string)
- (setq comint-prompt-regexp "^(.*gdb[+]?) *")
- (run-hooks 'gdb-mode-hook)
- )
+;; We need to know how much of the completion to chop off.
+(defvar gud-gdb-complete-break)
+
+;; The completion list is constructed by the process filter.
+(defvar gud-gdb-complete-list)
+(defvar gud-comint-buffer nil)
+(defun gud-gdb-complete-command ()
+ "Perform completion on the GDB command preceding point.
+This is implemented using the GDB `complete' command which isn't
+available with older versions of GDB."
+ (interactive)
+ (let* ((end (point))
+ (command (save-excursion
+ (beginning-of-line)
+ (and (looking-at comint-prompt-regexp)
+ (goto-char (match-end 0)))
+ (buffer-substring (point) end)))
+ command-word)
+ ;; Find the word break. This match will always succeed.
+ (string-match "\\(\\`\\| \\)\\([^ ]*\\)\\'" command)
+ (setq gud-gdb-complete-break (match-beginning 2)
+ command-word (substring command gud-gdb-complete-break))
+ (unwind-protect
+ (progn
+ ;; Temporarily install our filter function.
+ (gud-overload-functions
+ '((gud-marker-filter . gud-gdb-complete-filter)))
+ ;; Issue the command to GDB.
+ (gud-basic-call (concat "complete " command))
+ (setq gud-gdb-complete-in-progress t
+ gud-gdb-complete-string nil
+ gud-gdb-complete-list nil)
+ ;; Slurp the output.
+ (while gud-gdb-complete-in-progress
+ (accept-process-output (get-buffer-process gud-comint-buffer))))
+ ;; Restore the old filter function.
+ (gud-overload-functions '((gud-marker-filter . gud-gdb-marker-filter))))
+ ;; Protect against old versions of GDB.
+ (and gud-gdb-complete-list
+ (string-match "^Undefined command: \"complete\""
+ (car gud-gdb-complete-list))
+ (error "This version of GDB doesn't support the `complete' command."))
+ ;; Sort the list like readline.
+ (setq gud-gdb-complete-list
+ (sort gud-gdb-complete-list (function string-lessp)))
+ ;; Remove duplicates.
+ (let ((first gud-gdb-complete-list)
+ (second (cdr gud-gdb-complete-list)))
+ (while second
+ (if (string-equal (car first) (car second))
+ (setcdr first (setq second (cdr second)))
+ (setq first second
+ second (cdr second)))))
+ ;; Let comint handle the rest.
+ (comint-dynamic-simple-complete command-word gud-gdb-complete-list)))
+
+;; The completion process filter is installed temporarily to slurp the
+;; output of GDB up to the next prompt and build the completion list.
+(defun gud-gdb-complete-filter (string)
+ (setq string (concat gud-gdb-complete-string string))
+ (while (string-match "\n" string)
+ (setq gud-gdb-complete-list
+ (cons (substring string gud-gdb-complete-break (match-beginning 0))
+ gud-gdb-complete-list))
+ (setq string (substring string (match-end 0))))
+ (if (string-match comint-prompt-regexp string)
+ (progn
+ (setq gud-gdb-complete-in-progress nil)
+ string)
+ (progn
+ (setq gud-gdb-complete-string string)
+ "")))
+
+\f
;; ======================================================================
;; sdb functions
-(defun gud-sdb-debugger-startup (f d)
- (make-comint (concat "gud-" f) "sdb" nil f "-" d))
+;;; History of argument lists passed to sdb.
+(defvar gud-sdb-history nil)
+
+(defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
+ "If nil, we're on a System V Release 4 and don't need the tags hack.")
+
+(defvar gud-sdb-lastfile nil)
-(defun gud-sdb-marker-filter (proc string)
- (if (string-match "\\(^0x\\w* in \\|^\\|\n\\)\\([^:\n]*\\):\\([0-9]*\\):.*\n"
+(defun gud-sdb-massage-args (file args)
+ (cons file args))
+
+(defun gud-sdb-marker-filter (string)
+ (cond
+ ;; System V Release 3.2 uses this format
+ ((string-match "\\(^0x\\w* in \\|^\\|\n\\)\\([^:\n]*\\):\\([0-9]*\\):.*\n"
string)
- (setq gud-last-frame
- (cons
- (substring string (match-beginning 2) (match-end 2))
- (string-to-int
- (substring string (match-beginning 3) (match-end 3))))))
+ (setq gud-last-frame
+ (cons
+ (substring string (match-beginning 2) (match-end 2))
+ (string-to-int
+ (substring string (match-beginning 3) (match-end 3))))))
+ ;; System V Release 4.0
+ ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n"
+ string)
+ (setq gud-sdb-lastfile
+ (substring string (match-beginning 2) (match-end 2))))
+ ((and gud-sdb-lastfile (string-match "^\\([0-9]+\\):" string))
+ (setq gud-last-frame
+ (cons
+ gud-sdb-lastfile
+ (string-to-int
+ (substring string (match-beginning 1) (match-end 1))))))
+ (t
+ (setq gud-sdb-lastfile nil)))
string)
-(defun gud-sdb-visit-file (f)
- (find-tag-noselect f))
-
-;;; We'll just ignore the TEMP argument for now; I don't know how to
-;;; set temporary breakpoints in sdb. (See the description of the
-;;; gud-set-break method for details.)
-(defun gud-sdb-set-break (proc f n temp)
- (gud-queue-send (format "e %s" f) (format "%d b" n)))
+(defun gud-sdb-find-file (f)
+ (if gud-sdb-needs-tags
+ (find-tag-noselect f)
+ (find-file-noselect f)))
;;;###autoload
-(defun sdb (path)
+(defun sdb (command-line)
"Run sdb on program FILE in buffer *gud-FILE*.
The directory containing FILE becomes the initial working directory
and source-file directory for your debugger."
- (interactive "fRun sdb on file: ")
- (if (not (and (boundp 'tags-file-name) (file-exists-p tags-file-name)))
+ (interactive
+ (list (read-from-minibuffer "Run sdb (like this): "
+ (if (consp gud-sdb-history)
+ (car gud-sdb-history)
+ "sdb ")
+ nil nil
+ '(gud-sdb-history . 1))))
+ (if (and gud-sdb-needs-tags
+ (not (and (boundp 'tags-file-name)
+ (stringp tags-file-name)
+ (file-exists-p tags-file-name))))
(error "The sdb support requires a valid tags table to work."))
- (gud-overload-functions '((gud-debugger-startup . gud-sdb-debugger-startup)
- (gud-marker-filter . gud-sdb-marker-filter)
- (gud-visit-file . gud-sdb-visit-file)
- (gud-set-break . gud-sdb-set-break)))
-
- (gud-def gud-step "s" "\C-c\C-s" "Step one source line with display")
- (gud-def gud-stepi "i" "\C-c\C-i" "Step one instruction with display")
- (gud-def gud-next "S" "\C-c\C-n" "Step one source line (skip functions)")
- (gud-def gud-cont "c" "\C-c\C-r" "Continue with display (`resume')")
-
- (gud-common-init path)
+ (gud-overload-functions '((gud-massage-args . gud-sdb-massage-args)
+ (gud-marker-filter . gud-sdb-marker-filter)
+ (gud-find-file . gud-sdb-find-file)
+ ))
+
+ (gud-common-init command-line)
+
+ (gud-def gud-break "%l b" "\C-b" "Set breakpoint at current line.")
+ (gud-def gud-tbreak "%l c" "\C-t" "Set temporary breakpoint at current line.")
+ (gud-def gud-remove "%l d" "\C-d" "Remove breakpoint at current line")
+ (gud-def gud-step "s %p" "\C-s" "Step one source line with display.")
+ (gud-def gud-stepi "i %p" "\C-i" "Step one instruction with display.")
+ (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
+ (gud-def gud-cont "c" "\C-r" "Continue with display.")
+ (gud-def gud-print "%e/" "\C-p" "Evaluate C expression at point.")
(setq comint-prompt-regexp "\\(^\\|\n\\)\\*")
+ (setq paragraph-start comint-prompt-regexp)
(run-hooks 'sdb-mode-hook)
)
-
+\f
;; ======================================================================
;; dbx functions
-(defun gud-dbx-debugger-startup (f d)
- (make-comint (concat "gud-" f) "dbx" nil f))
+;;; History of argument lists passed to dbx.
+(defvar gud-dbx-history nil)
-(defun gud-dbx-marker-filter (proc string)
- (if (string-match
- "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\"" string)
+(defun gud-dbx-massage-args (file args)
+ (cons file args))
+
+(defun gud-dbx-marker-filter (string)
+ (if (or (string-match
+ "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
+ string)
+ (string-match
+ "signal .* in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
+ string))
(setq gud-last-frame
(cons
(substring string (match-beginning 2) (match-end 2))
(substring string (match-beginning 1) (match-end 1))))))
string)
-(defun gud-dbx-visit-file (f)
+;; Functions for Mips-style dbx. Given the option `-emacs', documented in
+;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
+(defvar gud-mips-p
+ (or (string-match "^mips-[^-]*-ultrix" system-configuration)
+ ;; We haven't tested gud on this system:
+ (string-match "^mips-[^-]*-riscos" system-configuration)
+ ;; It's documented on OSF/1.3
+ (string-match "^mips-[^-]*-osf1" system-configuration)
+ (string-match "^alpha-[^-]*-osf" system-configuration))
+ "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
+
+(defun gud-mipsdbx-massage-args (file args)
+ (cons "-emacs" (cons file args)))
+
+;; This is just like the gdb one except for the regexps since we need to cope
+;; with an optional breakpoint number in [] before the ^Z^Z
+(defun gud-mipsdbx-marker-filter (string)
+ (save-match-data
+ (setq gud-marker-acc (concat gud-marker-acc string))
+ (let ((output ""))
+
+ ;; Process all the complete markers in this chunk.
+ (while (string-match
+ ;; This is like th gdb marker but with an optional
+ ;; leading break point number like `[1] '
+ "[][ 0-9]*\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
+ gud-marker-acc)
+ (setq
+
+ ;; Extract the frame position from the marker.
+ gud-last-frame
+ (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
+ (string-to-int (substring gud-marker-acc
+ (match-beginning 2)
+ (match-end 2))))
+
+ ;; Append any text before the marker to the output we're going
+ ;; to return - we don't include the marker in this text.
+ output (concat output
+ (substring gud-marker-acc 0 (match-beginning 0)))
+
+ ;; Set the accumulator to the remaining text.
+ gud-marker-acc (substring gud-marker-acc (match-end 0))))
+
+ ;; Does the remaining text look like it might end with the
+ ;; beginning of another marker? If it does, then keep it in
+ ;; gud-marker-acc until we receive the rest of it. Since we
+ ;; know the full marker regexp above failed, it's pretty simple to
+ ;; test for marker starts.
+ (if (string-match "[][ 0-9]*\032.*\\'" gud-marker-acc)
+ (progn
+ ;; Everything before the potential marker start can be output.
+ (setq output (concat output (substring gud-marker-acc
+ 0 (match-beginning 0))))
+
+ ;; Everything after, we save, to combine with later input.
+ (setq gud-marker-acc
+ (substring gud-marker-acc (match-beginning 0))))
+
+ (setq output (concat output gud-marker-acc)
+ gud-marker-acc ""))
+
+ output)))
+
+;; The dbx in IRIX is a pain. It doesn't print the file name when
+;; stopping at a breakpoint (but you do get it from the `up' and
+;; `down' commands...). The only way to extract the information seems
+;; to be with a `file' command, although the current line number is
+;; available in $curline. Thus we have to look for output which
+;; appears to indicate a breakpoint. Then we prod the dbx sub-process
+;; to output the information we want with a combination of the
+;; `printf' and `file' commands as a pseudo marker which we can
+;; recognise next time through the marker-filter. This would be like
+;; the gdb marker but you can't get the file name without a newline...
+;; Note that gud-remove won't work since Irix dbx expects a breakpoint
+;; number rather than a line number etc. Maybe this could be made to
+;; work by listing all the breakpoints and picking the one(s) with the
+;; correct line number, but life's too short.
+;; d.love@dl.ac.uk (Dave Love) can be blamed for this
+
+(defvar gud-irix-p (string-match "^mips-[^-]*-irix" system-configuration)
+ "Non-nil to assume the interface appropriate for IRIX dbx.
+This works in IRIX 4 and probably IRIX 5.")
+;; (It's been tested in IRIX 4 and the output from dbx on IRIX 5 looks
+;; the same.)
+
+;; this filter is influenced by the xdb one rather than the gdb one
+(defun gud-irixdbx-marker-filter (string)
+ (save-match-data
+ (let (result (case-fold-search nil))
+ (if (or (string-match comint-prompt-regexp string)
+ (string-match ".*\012" string))
+ (setq result (concat gud-marker-acc string)
+ gud-marker-acc "")
+ (setq gud-marker-acc (concat gud-marker-acc string)))
+ (if result
+ (cond
+ ;; look for breakpoint or signal indication e.g.:
+ ;; [2] Process 1267 (pplot) stopped at [params:338 ,0x400ec0]
+ ;; Process 1281 (pplot) stopped at [params:339 ,0x400ec8]
+ ;; Process 1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
+ ((string-match
+ "^\\(\\[[0-9]+] \\)?Process +[0-9]+ ([^)]*) [^[]+\\[[^]\n]*]\n"
+ result)
+ ;; prod dbx into printing out the line number and file
+ ;; name in a form we can grok as below
+ (process-send-string (get-buffer-process gud-comint-buffer)
+ "printf \"\032\032%1d:\",$curline;file\n"))
+ ;; look for result of, say, "up" e.g.:
+ ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
+ ;; (this will also catch one of the lines printed by "where")
+ ((string-match
+ "^[^ ][^[]*\\[\"\\([^\"]+\\)\":\\([0-9]+\\), [^]]+]\n"
+ result)
+ (let ((file (substring result (match-beginning 1)
+ (match-end 1))))
+ (if (file-exists-p file)
+ (setq gud-last-frame
+ (cons
+ (substring
+ result (match-beginning 1) (match-end 1))
+ (string-to-int
+ (substring
+ result (match-beginning 2) (match-end 2)))))))
+ result)
+ ((string-match ; kluged-up marker as above
+ "\032\032\\([0-9]*\\):\\(.*\\)\n" result)
+ (let ((file (substring result (match-beginning 2) (match-end 2))))
+ (if (file-exists-p file)
+ (setq gud-last-frame
+ (cons
+ file
+ (string-to-int
+ (substring
+ result (match-beginning 1) (match-end 1)))))))
+ (setq result (substring result 0 (match-beginning 0))))))
+ (or result ""))))
+
+(defun gud-dbx-find-file (f)
(find-file-noselect f))
-;;; We'll just ignore the TEMP argument for now; I don't know how to
-;;; set temporary breakpoints in dbx. (See the description of the
-;;; gud-set-break method for details.)
-(defun gud-dbx-set-break (proc f n temp)
- (gud-call "stop at \"%s\":%d" f n))
-
;;;###autoload
-(defun dbx (path)
+(defun dbx (command-line)
"Run dbx on program FILE in buffer *gud-FILE*.
The directory containing FILE becomes the initial working directory
and source-file directory for your debugger."
- (interactive "fRun dbx on file: ")
- (gud-overload-functions '((gud-debugger-startup . gud-dbx-debugger-startup)
- (gud-marker-filter . gud-dbx-marker-filter)
- (gud-visit-file . gud-dbx-visit-file)
- (gud-set-break . gud-dbx-set-break)))
-
- (gud-def gud-step "step" "\C-c\C-s" "Step one source line with display")
- (gud-def gud-stepi "stepi" "\C-c\C-i" "Step one instruction with display")
- (gud-def gud-next "next" "\C-c\C-n" "Step one line (skip functions)")
- (gud-def gud-cont "cont" "\C-c\C-r" "Continue with display (`resume')")
-
- (gud-def gud-up "up" "\C-c<" "Up N stack frames (numeric arg)")
- (gud-def gud-down "down" "\C-c>" "Down N stack frames (numeric arg)")
+ (interactive
+ (list (read-from-minibuffer "Run dbx (like this): "
+ (if (consp gud-dbx-history)
+ (car gud-dbx-history)
+ "dbx ")
+ nil nil
+ '(gud-dbx-history . 1))))
+
+ (gud-overload-functions
+ (cond
+ (gud-mips-p
+ '((gud-massage-args . gud-mipsdbx-massage-args)
+ (gud-marker-filter . gud-mipsdbx-marker-filter)
+ (gud-find-file . gud-dbx-find-file)))
+ (gud-irix-p
+ '((gud-massage-args . gud-dbx-massage-args)
+ (gud-marker-filter . gud-irixdbx-marker-filter)
+ (gud-find-file . gud-dbx-find-file)))
+ (t
+ '((gud-massage-args . gud-dbx-massage-args)
+ (gud-marker-filter . gud-dbx-marker-filter)
+ (gud-find-file . gud-dbx-find-file)))))
+
+ (gud-common-init command-line)
+
+ (cond
+ (gud-mips-p
+ (gud-def gud-break "stop at \"%f\":%l"
+ "\C-b" "Set breakpoint at current line.")
+ (gud-def gud-finish "return" "\C-f" "Finish executing current function."))
+ (gud-irix-p
+ (gud-def gud-break "stop at \"%d%f\":%l"
+ "\C-b" "Set breakpoint at current line.")
+ (gud-def gud-finish "return" "\C-f" "Finish executing current function.")
+ ;; Make dbx give out the source location info that we need.
+ (process-send-string (get-buffer-process gud-comint-buffer)
+ "printf \"\032\032%1d:\",$curline;file\n"))
+ ((or (string-match "-sunos" system-configuration)
+ (string-match "-solaris" system-configuration))
+ ;; The following works for both the UCB and SunPro 2.0.1 versions
+ ;; of dbx. The `stop' is lost using the `\n' separator as in the
+ ;; default case. Is there a dbx where the newline is actually
+ ;; necessary? (d.love@dl.ac.uk)
+ (gud-def gud-break "file \"%d%f\";stop at %l"
+ "\C-b" "Set breakpoint at current line."))
+ (t
+ (gud-def gud-break "file \"%d%f\"\nstop at %l"
+ "\C-b" "Set breakpoint at current line.")))
+
+ (gud-def gud-remove "clear %l" "\C-d" "Remove breakpoint at current line")
+ (gud-def gud-step "step %p" "\C-s" "Step one line with display.")
+ (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
+ (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
+ (gud-def gud-cont "cont" "\C-r" "Continue with display.")
+ (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
+ (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
+ (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
+
+ (setq comint-prompt-regexp "^[^)\n]*dbx) *")
+ (setq paragraph-start comint-prompt-regexp)
+ (run-hooks 'dbx-mode-hook)
+ )
+\f
+;; ======================================================================
+;; xdb (HP PARISC debugger) functions
+
+;;; History of argument lists passed to xdb.
+(defvar gud-xdb-history nil)
+
+(defvar gud-xdb-directories nil
+ "*A list of directories that xdb should search for source code.
+If nil, only source files in the program directory
+will be known to xdb.
+
+The file names should be absolute, or relative to the directory
+containing the executable being debugged.")
+
+(defun gud-xdb-massage-args (file args)
+ (nconc (let ((directories gud-xdb-directories)
+ (result nil))
+ (while directories
+ (setq result (cons (car directories) (cons "-d" result)))
+ (setq directories (cdr directories)))
+ (nreverse (cons file result)))
+ args))
+
+(defun gud-xdb-file-name (f)
+ "Transform a relative pathname to a full pathname in xdb mode"
+ (let ((result nil))
+ (if (file-exists-p f)
+ (setq result (expand-file-name f))
+ (let ((directories gud-xdb-directories))
+ (while directories
+ (let ((path (concat (car directories) "/" f)))
+ (if (file-exists-p path)
+ (setq result (expand-file-name path)
+ directories nil)))
+ (setq directories (cdr directories)))))
+ result))
+
+;; xdb does not print the lines all at once, so we have to accumulate them
+(defun gud-xdb-marker-filter (string)
+ (let (result)
+ (if (or (string-match comint-prompt-regexp string)
+ (string-match ".*\012" string))
+ (setq result (concat gud-marker-acc string)
+ gud-marker-acc "")
+ (setq gud-marker-acc (concat gud-marker-acc string)))
+ (if result
+ (if (or (string-match "\\([^\n \t:]+\\): [^:]+: \\([0-9]+\\):" result)
+ (string-match "[^: \t]+:[ \t]+\\([^:]+\\): [^:]+: \\([0-9]+\\):"
+ result))
+ (let ((line (string-to-int
+ (substring result (match-beginning 2) (match-end 2))))
+ (file (gud-xdb-file-name
+ (substring result (match-beginning 1) (match-end 1)))))
+ (if file
+ (setq gud-last-frame (cons file line))))))
+ (or result "")))
+
+(defun gud-xdb-find-file (f)
+ (let ((realf (gud-xdb-file-name f)))
+ (if realf (find-file-noselect realf))))
- (gud-common-init path)
- (setq comint-prompt-regexp "^[^)]*dbx) *")
+;;;###autoload
+(defun xdb (command-line)
+ "Run xdb on program FILE in buffer *gud-FILE*.
+The directory containing FILE becomes the initial working directory
+and source-file directory for your debugger.
+
+You can set the variable 'gud-xdb-directories' to a list of program source
+directories if your program contains sources from more than one directory."
+ (interactive
+ (list (read-from-minibuffer "Run xdb (like this): "
+ (if (consp gud-xdb-history)
+ (car gud-xdb-history)
+ "xdb ")
+ nil nil
+ '(gud-xdb-history . 1))))
+ (gud-overload-functions '((gud-massage-args . gud-xdb-massage-args)
+ (gud-marker-filter . gud-xdb-marker-filter)
+ (gud-find-file . gud-xdb-find-file)))
+
+ (gud-common-init command-line)
+
+ (gud-def gud-break "b %f:%l" "\C-b" "Set breakpoint at current line.")
+ (gud-def gud-tbreak "b %f:%l\\t" "\C-t"
+ "Set temporary breakpoint at current line.")
+ (gud-def gud-remove "db" "\C-d" "Remove breakpoint at current line")
+ (gud-def gud-step "s %p" "\C-s" "Step one line with display.")
+ (gud-def gud-next "S %p" "\C-n" "Step one line (skip functions).")
+ (gud-def gud-cont "c" "\C-r" "Continue with display.")
+ (gud-def gud-up "up %p" "<" "Up (numeric arg) stack frames.")
+ (gud-def gud-down "down %p" ">" "Down (numeric arg) stack frames.")
+ (gud-def gud-finish "bu\\t" "\C-f" "Finish executing current function.")
+ (gud-def gud-print "p %e" "\C-p" "Evaluate C expression at point.")
+
+ (setq comint-prompt-regexp "^>")
+ (setq paragraph-start comint-prompt-regexp)
+ (run-hooks 'xdb-mode-hook))
+\f
+;; ======================================================================
+;; perldb functions
+
+;;; History of argument lists passed to perldb.
+(defvar gud-perldb-history nil)
+
+(defun gud-perldb-massage-args (file args)
+ (cons "-d" (cons file (cons "-emacs" args))))
+
+;; There's no guarantee that Emacs will hand the filter the entire
+;; marker at once; it could be broken up across several strings. We
+;; might even receive a big chunk with several markers in it. If we
+;; receive a chunk of text which looks like it might contain the
+;; beginning of a marker, we save it here between calls to the
+;; filter.
+(defvar gud-perldb-marker-acc "")
+
+(defun gud-perldb-marker-filter (string)
+ (save-match-data
+ (setq gud-marker-acc (concat gud-marker-acc string))
+ (let ((output ""))
+
+ ;; Process all the complete markers in this chunk.
+ (while (string-match "\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
+ gud-marker-acc)
+ (setq
+
+ ;; Extract the frame position from the marker.
+ gud-last-frame
+ (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
+ (string-to-int (substring gud-marker-acc
+ (match-beginning 2)
+ (match-end 2))))
+
+ ;; Append any text before the marker to the output we're going
+ ;; to return - we don't include the marker in this text.
+ output (concat output
+ (substring gud-marker-acc 0 (match-beginning 0)))
+
+ ;; Set the accumulator to the remaining text.
+ gud-marker-acc (substring gud-marker-acc (match-end 0))))
+
+ ;; Does the remaining text look like it might end with the
+ ;; beginning of another marker? If it does, then keep it in
+ ;; gud-marker-acc until we receive the rest of it. Since we
+ ;; know the full marker regexp above failed, it's pretty simple to
+ ;; test for marker starts.
+ (if (string-match "\032.*\\'" gud-marker-acc)
+ (progn
+ ;; Everything before the potential marker start can be output.
+ (setq output (concat output (substring gud-marker-acc
+ 0 (match-beginning 0))))
+
+ ;; Everything after, we save, to combine with later input.
+ (setq gud-marker-acc
+ (substring gud-marker-acc (match-beginning 0))))
+
+ (setq output (concat output gud-marker-acc)
+ gud-marker-acc ""))
+
+ output)))
+
+(defun gud-perldb-find-file (f)
+ (find-file-noselect f))
- (run-hooks 'dbx-mode-hook)
+;;;###autoload
+(defun perldb (command-line)
+ "Run perldb on program FILE in buffer *gud-FILE*.
+The directory containing FILE becomes the initial working directory
+and source-file directory for your debugger."
+ (interactive
+ (list (read-from-minibuffer "Run perldb (like this): "
+ (if (consp gud-perldb-history)
+ (car gud-perldb-history)
+ "perl ")
+ nil nil
+ '(gud-perldb-history . 1))))
+ (gud-overload-functions '((gud-massage-args . gud-perldb-massage-args)
+ (gud-marker-filter . gud-perldb-marker-filter)
+ (gud-find-file . gud-perldb-find-file)
+ ))
+
+ (gud-common-init command-line)
+
+ (gud-def gud-break "b %l" "\C-b" "Set breakpoint at current line.")
+ (gud-def gud-remove "d %l" "\C-d" "Remove breakpoint at current line")
+ (gud-def gud-step "s" "\C-s" "Step one source line with display.")
+ (gud-def gud-next "n" "\C-n" "Step one line (skip functions).")
+ (gud-def gud-cont "c" "\C-r" "Continue with display.")
+; (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
+; (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
+; (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
+ (gud-def gud-print "%e" "\C-p" "Evaluate perl expression at point.")
+
+ (setq comint-prompt-regexp "^ DB<[0-9]+> ")
+ (setq paragraph-start comint-prompt-regexp)
+ (run-hooks 'perldb-mode-hook)
)
;;
;; End of debugger-specific information
;;
-(defvar gud-mode-map nil
- "Keymap for gud-mode.")
-
-(defvar gud-commands nil
- "List of strings or functions used by send-gud-command.
-It is for customization by you.")
-
-(defvar gud-command-queue nil)
-
+\f
;;; When we send a command to the debugger via gud-call, it's annoying
;;; to see the command and the new prompt inserted into the debugger's
;;; buffer; we have other ways of knowing the command has completed.
;;; prompt alone.
(defvar gud-delete-prompt-marker nil)
-(if gud-mode-map
- nil
- (setq gud-mode-map (copy-keymap comint-mode-map))
- (define-key gud-mode-map "\C-c\C-l" 'gud-refresh))
-
-;; Global mappings --- we'll invoke these from a source buffer.
-(define-key ctl-x-map " " 'gud-break)
-(define-key ctl-x-map "&" 'send-gud-command)
-
\f
(defun gud-mode ()
"Major mode for interacting with an inferior debugger process.
- You start it up with one of the commands M-x gdb, M-x sdb, or
-M-x dbx. Each entry point finishes by executing a hook; gdb-mode-hook,
-sdb-mode-hook or dbx-mode-hook respectively.
+ You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
+or M-x xdb. Each entry point finishes by executing a hook; `gdb-mode-hook',
+`sdb-mode-hook', `dbx-mode-hook' or `xdb-mode-hook' respectively.
+
+After startup, the following commands are available in both the GUD
+interaction buffer and any source buffer GUD visits due to a breakpoint stop
+or step operation:
-After startup, the following commands are available:
+\\[gud-break] sets a breakpoint at the current file and line. In the
+GUD buffer, the current file and line are those of the last breakpoint or
+step. In a source buffer, they are the buffer's file and current line.
-\\{gud-mode-map}
+\\[gud-remove] removes breakpoints on the current file and line.
-\\[gud-refresh] displays in the other window the last line referred to
+\\[gud-refresh] displays in the source window the last line referred to
in the gud buffer.
-\\[gud-step], \\[gud-next], and \\[gud-stepi] in the gud window,
-do a step-one-line, step-one-line (not entering function calls), and
-step-one-instruction and then update the other window
-with the current file and position. \\[gud-cont] continues
-execution.
+\\[gud-step], \\[gud-next], and \\[gud-stepi] do a step-one-line,
+step-one-line (not entering function calls), and step-one-instruction
+and then update the source window with the current file and position.
+\\[gud-cont] continues execution.
-The above commands are common to all supported debuggers. If you are
-using gdb or dbx, the following additional commands will be available:
+\\[gud-print] tries to find the largest C lvalue or function-call expression
+around point, and sends it to the debugger for value display.
-\\[gud-up] pops up through an enclosing stack frame. \\[gud-down] drops
-back down through one.
+The above commands are common to all supported debuggers except xdb which
+does not support stepping instructions.
-If you are using gdb, \\[gdb-finish] runs execution to the return from
-the current function and stops.
+Under gdb, sdb and xdb, \\[gud-tbreak] behaves exactly like \\[gud-break],
+except that the breakpoint is temporary; that is, it is removed when
+execution stops on it.
+
+Under gdb, dbx, and xdb, \\[gud-up] pops up through an enclosing stack
+frame. \\[gud-down] drops back down through one.
-These functions repeat themselves the appropriate number of times if you give a
-prefix argument.
+If you are using gdb or xdb, \\[gud-finish] runs execution to the return from
+the current function and stops.
-If you are in a source file, you may do the following:
+All the keystrokes above are accessible in the GUD buffer
+with the prefix C-c, and in all buffers through the prefix C-x C-a.
-Set a breakpoint at the current line by doing \\[gud-break]. This causes
-an appropriate set-break to be send to the debugger; of course, if the file
-you're visiting doesn't correspond to any code in the executable this will
-have no effect or raise an error.
+All pre-defined functions for which the concept make sense repeat
+themselves the appropriate number of times if you give a prefix
+argument.
-Execute a user-defined command at point with \\[send-gud-command]; the
-prefix argument is taken as an index into the list of strings gud-commands.
-A %s in a gud-commands string is substituted with a number or address picked
-up from point.
+You may use the `gud-def' macro in the initialization hook to define other
+commands.
Other commands for interacting with the debugger process are inherited from
comint mode, which see."
(interactive)
(comint-mode)
-; (kill-all-local-variables)
(setq major-mode 'gud-mode)
(setq mode-name "Debugger")
- (setq mode-line-process '(": %s"))
- (use-local-map gud-mode-map)
+ (setq mode-line-process '(":%s"))
+ (use-local-map (copy-keymap comint-mode-map))
+ (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
(make-local-variable 'gud-last-frame)
(setq gud-last-frame nil)
(make-local-variable 'comint-prompt-regexp)
+ (make-local-variable 'paragraph-start)
(make-local-variable 'gud-delete-prompt-marker)
(setq gud-delete-prompt-marker (make-marker))
(run-hooks 'gud-mode-hook)
)
-(defvar current-gud-buffer nil)
-
-(defun gud-common-init (path)
- ;; perform initializations common to all debuggers
- (setq path (expand-file-name path))
- (let ((file (file-name-nondirectory path)))
- (switch-to-buffer (concat "*gud-" file "*"))
- (setq default-directory (file-name-directory path))
- (or (bolp) (newline))
- (insert "Current directory is " default-directory "\n")
- (gud-debugger-startup file default-directory))
+;; Chop STRING into words separated by SPC or TAB and return a list of them.
+(defun gud-chop-words (string)
+ (let ((i 0) (beg 0)
+ (len (length string))
+ (words nil))
+ (while (< i len)
+ (if (memq (aref string i) '(?\t ? ))
+ (progn
+ (setq words (cons (substring string beg i) words)
+ beg (1+ i))
+ (while (and (< beg len) (memq (aref string beg) '(?\t ? )))
+ (setq beg (1+ beg)))
+ (setq i (1+ beg)))
+ (setq i (1+ i))))
+ (if (< beg len)
+ (setq words (cons (substring string beg) words)))
+ (nreverse words)))
+
+;; Perform initializations common to all debuggers.
+(defun gud-common-init (command-line)
+ (let* ((words (gud-chop-words command-line))
+ (program (car words))
+ (file-word (let ((w (cdr words)))
+ (while (and w (= ?- (aref (car w) 0)))
+ (setq w (cdr w)))
+ (car w)))
+ (args (delq file-word (cdr words)))
+ (file (and file-word
+ (expand-file-name (substitute-in-file-name file-word))))
+ (filepart (and file-word (file-name-nondirectory file))))
+ (switch-to-buffer (concat "*gud-" filepart "*"))
+ (and file-word (setq default-directory (file-name-directory file)))
+ (or (bolp) (newline))
+ (insert "Current directory is " default-directory "\n")
+ (apply 'make-comint (concat "gud-" filepart) program nil
+ (if file-word (gud-massage-args file args))))
(gud-mode)
(set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
(set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
- (setq gud-command-queue nil)
(gud-set-buffer)
)
(defun gud-set-buffer ()
(cond ((eq major-mode 'gud-mode)
- (setq current-gud-buffer (current-buffer)))))
-\f
-(defun gud-filter (proc string)
- ;; This function is responsible for inserting output from your debugger
- ;; into the buffer. The hard work is done by the method that is
- ;; the value of gud-marker-filter.
- (let ((inhibit-quit t))
- (gud-filter-insert proc (gud-marker-filter proc string))
- ;; If we've got queued commands and we see a prompt, pop one and send it.
- ;; In theory we should check that a prompt has been issued before sending
- ;; queued commands. In practice, command responses from the first through
- ;; penultimate elements of a command sequence are short enough that we
- ;; don't really have to bother.
- (if gud-command-queue
- (progn
- (gud-call (car gud-command-queue))
- (setq gud-command-queue (cdr gud-command-queue))
- )
- )))
+ (setq gud-comint-buffer (current-buffer)))))
-(defun gud-filter-insert (proc string)
+;; These functions are responsible for inserting output from your debugger
+;; into the buffer. The hard work is done by the method that is
+;; the value of gud-marker-filter.
+
+(defun gud-filter (proc string)
;; Here's where the actual buffer insertion is done
- (save-excursion
- (set-buffer (process-buffer proc))
- (let ((moving (= (point) (process-mark proc)))
- (output-after-point (< (point) (process-mark proc))))
- (save-excursion
- (goto-char (process-mark proc))
- ;; If we have been so requested, delete the debugger prompt.
- (if (marker-buffer gud-delete-prompt-marker)
- (progn
- (delete-region (point) gud-delete-prompt-marker)
- (set-marker gud-delete-prompt-marker nil)))
- (insert-before-markers string)
- ;; Check for a filename-and-line number.
- ;; Don't display the specified file
- ;; unless (1) point is at or after the position where output appears
- ;; and (2) this buffer is on the screen.
- (if (and gud-last-frame
- (not output-after-point)
- (get-buffer-window (current-buffer)))
- (gud-display-frame)))
- (if moving (goto-char (process-mark proc))))))
+ (let ((inhibit-quit t)
+ output)
+ (save-excursion
+ (set-buffer (process-buffer proc))
+ ;; If we have been so requested, delete the debugger prompt.
+ (if (marker-buffer gud-delete-prompt-marker)
+ (progn
+ (delete-region (process-mark proc) gud-delete-prompt-marker)
+ (set-marker gud-delete-prompt-marker nil)))
+ ;; Save the process output, checking for source file markers.
+ (setq output (gud-marker-filter string))
+ ;; Check for a filename-and-line number.
+ ;; Don't display the specified file
+ ;; unless (1) point is at or after the position where output appears
+ ;; and (2) this buffer is on the screen.
+ (if (and gud-last-frame
+ (>= (point) (process-mark proc))
+ (get-buffer-window (current-buffer)))
+ (gud-display-frame))
+ ;; Let the comint filter do the actual insertion.
+ ;; That lets us inherit various comint features.
+ (comint-output-filter proc output))))
(defun gud-sentinel (proc msg)
(cond ((null (buffer-name (process-buffer proc)))
(setq overlay-arrow-position nil)
;; Fix the mode line.
(setq mode-line-process
- (concat ": "
+ (concat ":"
(symbol-name (process-status proc))))
(let* ((obuf (current-buffer)))
;; save-excursion isn't the right thing if
;; if obuf is the gud buffer.
(set-buffer obuf))))))
-
-(defun gud-refresh (&optional arg)
- "Fix up a possibly garbled display, and redraw the arrow."
- (interactive "P")
- (recenter arg)
- (gud-display-frame))
-
(defun gud-display-frame ()
"Find and obey the last filename-and-line marker from the debugger.
Obeying it means displaying in another window the specified file and line."
(interactive)
(if gud-last-frame
- (progn
+ (progn
(gud-set-buffer)
(gud-display-line (car gud-last-frame) (cdr gud-last-frame))
- (setq gud-last-frame nil))))
+ (setq gud-last-last-frame gud-last-frame
+ gud-last-frame nil))))
;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
;; and that its line LINE is visible.
;; Put the overlay-arrow on the line LINE in that buffer.
+;; Most of the trickiness in here comes from wanting to preserve the current
+;; region-restriction if that's possible. We use an explicit display-buffer
+;; to get around the fact that this is called inside a save-excursion.
(defun gud-display-line (true-file line)
- (let* ((buffer (gud-visit-file true-file))
- (window (display-buffer buffer t))
+ (let* ((last-nonmenu-event t) ; Prevent use of dialog box for questions.
+ (buffer (gud-find-file true-file))
+ (window (display-buffer buffer))
(pos))
+;;; (if (equal buffer (current-buffer))
+;;; nil
+;;; (setq buffer-read-only nil))
(save-excursion
+;;; (setq buffer-read-only t)
(set-buffer buffer)
(save-restriction
(widen)
(widen)
(goto-char pos))))
(set-window-point window overlay-arrow-position)))
-\f
-(defun gud-call (command &rest args)
- "Invoke the debugger COMMAND displaying source in other window."
- (interactive)
- (gud-set-buffer)
- (let ((command (concat (apply 'format command args) "\n"))
- (proc (get-buffer-process current-gud-buffer)))
-
- ;; Arrange for the current prompt to get deleted.
- (save-excursion
- (set-buffer current-gud-buffer)
- (goto-char (process-mark proc))
- (beginning-of-line)
- (if (looking-at comint-prompt-regexp)
- (set-marker gud-delete-prompt-marker (point))))
-
- (goto-char (point-max))
- (process-send-string proc command)))
-(defun gud-queue-send (&rest cmdlist)
- ;; Send the first command, queue the rest for send after successive
- ;; send on subsequent prompts
- (interactive)
- (gud-call (car cmdlist))
- (setq gud-command-queue (append gud-command-queue (cdr cmdlist))))
-
-(defun gud-apply-from-source (func &rest args)
- ;; Apply a method from the gud buffer environment, passing it file
- ;; and line, then ARGS. This is intended to be used for gud
- ;; commands called from a source file.
- (if (not buffer-file-name)
- (error "There is no file associated with this buffer"))
- (let ((file (file-name-nondirectory buffer-file-name))
- (line (save-restriction (widen) (1+ (count-lines 1 (point))))))
- (save-excursion
- (gud-set-buffer)
- (apply func
- (get-buffer-process current-gud-buffer)
- file
- line
- args)
- )))
-
-(defun gud-break (arg)
- "Set breakpoint at this source line.
-With prefix argument, set a temporary breakpoint, if the debugger in
-use supports such things. (A temporary breakpoint is one which will
-be deleted when it is reached.)"
- (interactive "P")
- (gud-apply-from-source 'gud-set-break arg))
+;;; The gud-call function must do the right thing whether its invoking
+;;; keystroke is from the GUD buffer itself (via major-mode binding)
+;;; or a C buffer. In the former case, we want to supply data from
+;;; gud-last-frame. Here's how we do it:
+
+(defun gud-format-command (str arg)
+ (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
+ (frame (or gud-last-frame gud-last-last-frame))
+ result)
+ (while (and str (string-match "\\([^%]*\\)%\\([adeflp]\\)" str))
+ (let ((key (string-to-char (substring str (match-beginning 2))))
+ subst)
+ (cond
+ ((eq key ?f)
+ (setq subst (file-name-nondirectory (if insource
+ (buffer-file-name)
+ (car frame)))))
+ ((eq key ?d)
+ (setq subst (file-name-directory (if insource
+ (buffer-file-name)
+ (car frame)))))
+ ((eq key ?l)
+ (setq subst (if insource
+ (save-excursion
+ (beginning-of-line)
+ (save-restriction (widen)
+ (1+ (count-lines 1 (point)))))
+ (cdr frame))))
+ ((eq key ?e)
+ (setq subst (find-c-expr)))
+ ((eq key ?a)
+ (setq subst (gud-read-address)))
+ ((eq key ?p)
+ (setq subst (if arg (int-to-string arg) ""))))
+ (setq result (concat result
+ (substring str (match-beginning 1) (match-end 1))
+ subst)))
+ (setq str (substring str (match-end 2))))
+ ;; There might be text left in STR when the loop ends.
+ (concat result str)))
(defun gud-read-address ()
"Return a string containing the core-address found in the buffer at point."
(save-excursion
(let ((pt (point)) found begin)
- (setq found (if (search-backward "0x" (- pt 7) t)(point)))
+ (setq found (if (search-backward "0x" (- pt 7) t) (point)))
(cond
(found (forward-char 2)
(buffer-substring found
(forward-char -1)
(buffer-substring begin (point)))))))
+(defun gud-call (fmt &optional arg)
+ (let ((msg (gud-format-command fmt arg)))
+ (message "Command: %s" msg)
+ (sit-for 0)
+ (gud-basic-call msg)))
+
+(defun gud-basic-call (command)
+ "Invoke the debugger COMMAND displaying source in other window."
+ (interactive)
+ (gud-set-buffer)
+ (let ((command (concat command "\n"))
+ (proc (get-buffer-process gud-comint-buffer)))
+
+ ;; Arrange for the current prompt to get deleted.
+ (save-excursion
+ (set-buffer gud-comint-buffer)
+ (goto-char (process-mark proc))
+ (beginning-of-line)
+ (if (looking-at comint-prompt-regexp)
+ (set-marker gud-delete-prompt-marker (point))))
+ (process-send-string proc command)))
-(defun send-gud-command (arg)
- "This command reads the number where the cursor is positioned. A numeric arg
-selects the ARG'th member COMMAND of the list gud-commands. If COMMAND is a
-string, (format COMMAND ADDR) is inserted at the end of the debugger buffer,
-otherwise (funcall COMMAND ADDR) is inserted.
- For example, \"p (rtx)%s->fld[0].rtint\" is a possible string to be a
-member of gud-commands."
+(defun gud-refresh (&optional arg)
+ "Fix up a possibly garbled display, and redraw the arrow."
(interactive "P")
- (let (comm addr)
- (if arg (setq comm (nth arg gud-commands)))
- (setq addr (gud-read-address))
- (if (eq (current-buffer) current-gud-buffer)
- (set-mark (point)))
- (cond (comm
- (setq comm
- (if (stringp comm) (format comm addr) (funcall comm addr))))
- (t (setq comm addr)))
- (switch-to-buffer current-gud-buffer)
- (goto-char (point-max))
- (insert-string comm)))
+ (recenter arg)
+ (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
+ (gud-display-frame))
+\f
+;;; Code for parsing expressions out of C code. The single entry point is
+;;; find-c-expr, which tries to return an lvalue expression from around point.
+;;;
+;;; The rest of this file is a hacked version of gdbsrc.el by
+;;; Debby Ayers <ayers@asc.slb.com>,
+;;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
+
+(defun find-c-expr ()
+ "Returns the C expr that surrounds point."
+ (interactive)
+ (save-excursion
+ (let ((p) (expr) (test-expr))
+ (setq p (point))
+ (setq expr (expr-cur))
+ (setq test-expr (expr-prev))
+ (while (expr-compound test-expr expr)
+ (setq expr (cons (car test-expr) (cdr expr)))
+ (goto-char (car expr))
+ (setq test-expr (expr-prev)))
+ (goto-char p)
+ (setq test-expr (expr-next))
+ (while (expr-compound expr test-expr)
+ (setq expr (cons (car expr) (cdr test-expr)))
+ (setq test-expr (expr-next))
+ )
+ (buffer-substring (car expr) (cdr expr)))))
+
+(defun expr-cur ()
+ "Returns the expr that point is in; point is set to beginning of expr.
+The expr is represented as a cons cell, where the car specifies the point in
+the current buffer that marks the beginning of the expr and the cdr specifies
+the character after the end of the expr."
+ (let ((p (point)) (begin) (end))
+ (expr-backward-sexp)
+ (setq begin (point))
+ (expr-forward-sexp)
+ (setq end (point))
+ (if (>= p end)
+ (progn
+ (setq begin p)
+ (goto-char p)
+ (expr-forward-sexp)
+ (setq end (point))
+ )
+ )
+ (goto-char begin)
+ (cons begin end)))
+
+(defun expr-backward-sexp ()
+ "Version of `backward-sexp' that catches errors."
+ (condition-case nil
+ (backward-sexp)
+ (error t)))
+
+(defun expr-forward-sexp ()
+ "Version of `forward-sexp' that catches errors."
+ (condition-case nil
+ (forward-sexp)
+ (error t)))
+
+(defun expr-prev ()
+ "Returns the previous expr, point is set to beginning of that expr.
+The expr is represented as a cons cell, where the car specifies the point in
+the current buffer that marks the beginning of the expr and the cdr specifies
+the character after the end of the expr"
+ (let ((begin) (end))
+ (expr-backward-sexp)
+ (setq begin (point))
+ (expr-forward-sexp)
+ (setq end (point))
+ (goto-char begin)
+ (cons begin end)))
+
+(defun expr-next ()
+ "Returns the following expr, point is set to beginning of that expr.
+The expr is represented as a cons cell, where the car specifies the point in
+the current buffer that marks the beginning of the expr and the cdr specifies
+the character after the end of the expr."
+ (let ((begin) (end))
+ (expr-forward-sexp)
+ (expr-forward-sexp)
+ (setq end (point))
+ (expr-backward-sexp)
+ (setq begin (point))
+ (cons begin end)))
+
+(defun expr-compound-sep (span-start span-end)
+ "Returns '.' for '->' & '.', returns ' ' for white space,
+returns '?' for other punctuation."
+ (let ((result ? )
+ (syntax))
+ (while (< span-start span-end)
+ (setq syntax (char-syntax (char-after span-start)))
+ (cond
+ ((= syntax ? ) t)
+ ((= syntax ?.) (setq syntax (char-after span-start))
+ (cond
+ ((= syntax ?.) (setq result ?.))
+ ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
+ (setq result ?.)
+ (setq span-start (+ span-start 1)))
+ (t (setq span-start span-end)
+ (setq result ??)))))
+ (setq span-start (+ span-start 1)))
+ result))
+
+(defun expr-compound (first second)
+ "Non-nil if concatenating FIRST and SECOND makes a single C token.
+The two exprs are represented as a cons cells, where the car
+specifies the point in the current buffer that marks the beginning of the
+expr and the cdr specifies the character after the end of the expr.
+Link exprs of the form:
+ Expr -> Expr
+ Expr . Expr
+ Expr (Expr)
+ Expr [Expr]
+ (Expr) Expr
+ [Expr] Expr"
+ (let ((span-start (cdr first))
+ (span-end (car second))
+ (syntax))
+ (setq syntax (expr-compound-sep span-start span-end))
+ (cond
+ ((= (car first) (car second)) nil)
+ ((= (cdr first) (cdr second)) nil)
+ ((= syntax ?.) t)
+ ((= syntax ? )
+ (setq span-start (char-after (- span-start 1)))
+ (setq span-end (char-after span-end))
+ (cond
+ ((= span-start ?) ) t )
+ ((= span-start ?] ) t )
+ ((= span-end ?( ) t )
+ ((= span-end ?[ ) t )
+ (t nil))
+ )
+ (t nil))))
+
+(provide 'gud)
;;; gud.el ends here