-;;; 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>
+;; Version: 1.3
;; Keywords: unix, tools
-;; %W%
-
-;; Copyright (C) 1992 Free Software Foundation, Inc.
+;; Copyright (C) 1992, 1993 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).
;;; Code:
(require 'comint)
-(require 'tags)
+(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)
+(global-set-key "\C-x " '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)
+(defun gud-massage-args (file args)
(error "GUD not properly entered."))
-(defun gud-marker-filter (proc s)
+(defun gud-marker-filter (str)
(error "GUD not properly entered."))
-(defun gud-visit-file (f)
+(defun gud-find-file (f)
(error "GUD not properly entered."))
-(defun gud-set-break (proc f n)
- (error "GUD not properly entered."))
+;; ======================================================================
+;; 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
-;; user defined ones.
-
-(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))
- (list 'define-key 'gud-mode-map key (list 'quote func)))))
-
-;; All debugger-specific information is collected here
-;; Here's how it works, in case you ever need to add a debugger to the table.
+;; user defined ones.
+
+;; 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 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 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 program counter.
+(defvar gud-last-frame nil)
+
+;; 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)
+
+;; 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.
-;;
-;; Debugger-specific information begins here:
;; ======================================================================
;; gdb functions
-(defun gud-gdb-debugger-startup (f d)
- (make-comint (concat "gud-" f) "gdb" nil "-fullname" "-cd" d f))
+;;; History of argument lists passed to gdb.
+(defvar gud-gdb-history nil)
-(defun gud-gdb-marker-filter (proc s)
- (if (string-match "\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n" s)
+(defun gud-gdb-massage-args (file args)
+ (cons "-fullname" (cons file args)))
+
+(defun gud-gdb-marker-filter (string)
+ (if (string-match "\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n" string)
(progn
(setq gud-last-frame
(cons
))
string))
-(defun gud-gdb-visit-file (f)
+(defun gud-gdb-find-file (f)
(find-file-noselect f))
-(defun gud-gdb-set-break (proc f n)
- (gud-call "break %s:%d" f n))
-
;;;###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)))
-
- (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-c" "Continue with display")
-
- (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)")
-
- (gud-common-init path)
+ (interactive
+ (list (read-from-minibuffer "Run gdb (like this): "
+ (if (consp gud-gdb-history)
+ (car gud-gdb-history)
+ "gdb ")
+ nil 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.")
(setq comint-prompt-regexp "^(.*gdb[+]?) *")
(run-hooks 'gdb-mode-hook)
;; ======================================================================
;; sdb functions
-(defun gud-sdb-debugger-startup (f d)
- (make-comint (concat "gud-" f) "sdb" nil f "-" d))
-
-(defun gud-sdb-marker-filter (proc str)
- (if (string-match "\\(^0x\\w* in \\|^\\|\n\\)\\([^:\n]*\\):\\([0-9]*\\):.*\n"
- str)
- (setq gud-last-frame
- (cons
- (substring string (match-beginning 2) (match-end 2))
- (string-to-int
- (substring string (match-beginning 3) (match-end 3))))))
+;;; 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-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))))))
+ ;; 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))
-
-(defun gud-sdb-set-break (proc f n)
- (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."
- (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) (file-exists-p tags-file-name))))
(error "The sdb support requires a valid tags table to work."))
- (interactive "fRun sdb on file: ")
- (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-c" "Continue with display")
-
- (gud-common-init path)
-
- (setq comint-prompt-pattern "\\(^\\|\n\\)\\*")
+ (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\\)\\*")
(run-hooks 'sdb-mode-hook)
)
;; ======================================================================
;; dbx functions
-(defun gud-dbx-debugger-startup (f d)
- (make-comint (concat "gud-" file) "dbx" nil f))
+;;; History of argument lists passed to dbx.
+(defvar gud-dbx-history nil)
+
+(defun gud-dbx-massage-args (file args)
+ (cons file args))
-(defun gud-dbx-marker-filter (proc str)
+(defun gud-dbx-marker-filter (string)
(if (string-match
- "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\"" str)
+ "stopped 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)
+(defun gud-dbx-find-file (f)
(find-file-noselect f))
-(defun gud-dbx-set-break (proc f n)
- (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)))
+ (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 '((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)
+
+ (gud-def gud-break "file \"%f\"\nstop at %l"
+ "\C-b" "Set breakpoint at current line.")
+;; (gud-def gud-break "stop at \"%f\":%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.")
- (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-c" "Continue with display")
-
- (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)")
-
- (gud-common-init path)
(setq comint-prompt-regexp "^[^)]*dbx) *")
-
(run-hooks 'dbx-mode-hook)
)
+;; ======================================================================
+;; 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
+(defvar gud-xdb-accumulation "")
+
+(defun gud-xdb-marker-filter (string)
+ (let (result)
+ (if (or (string-match comint-prompt-regexp string)
+ (string-match ".*\012" string))
+ (setq result (concat gud-xdb-accumulation string)
+ gud-xdb-accumulation "")
+ (setq gud-xdb-accumulation (concat gud-xdb-accumulation 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))))
+
+;;;###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 "^>")
+ (make-local-variable 'gud-xdb-accumulation)
+ (setq gud-xdb-accumulation "")
+ (run-hooks 'xdb-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)
-
-(if gud-mode-map
- nil
- (setq gud-mode-map (copy-keymap comint-mode-map))
- (define-key gud-mode-map "\C-cl" '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)
+;;; 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.
+;;;
+;;; If the buffer looks like this:
+;;; --------------------
+;;; (gdb) set args foo bar
+;;; (gdb) -!-
+;;; --------------------
+;;; (the -!- marks the location of point), and we type `C-x SPC' in a
+;;; source file to set a breakpoint, we want the buffer to end up like
+;;; this:
+;;; --------------------
+;;; (gdb) set args foo bar
+;;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
+;;; (gdb) -!-
+;;; --------------------
+;;; Essentially, the old prompt is deleted, and the command's output
+;;; and the new prompt take its place.
+;;;
+;;; Not echoing the command is easy enough; you send it directly using
+;;; process-send-string, and it never enters the buffer. However,
+;;; getting rid of the old prompt is trickier; you don't want to do it
+;;; when you send the command, since that will result in an annoying
+;;; flicker as the prompt is deleted, redisplay occurs while Emacs
+;;; waits for a response from the debugger, and the new prompt is
+;;; inserted. Instead, we'll wait until we actually get some output
+;;; from the subprocess before we delete the prompt. If the command
+;;; produced no output other than a new prompt, that prompt will most
+;;; likely be in the first chunk of output received, so we will delete
+;;; the prompt and then replace it with an identical one. If the
+;;; command produces output, the prompt is moving anyway, so the
+;;; flicker won't be annoying.
+;;;
+;;; So - when we want to delete the prompt upon receipt of the next
+;;; chunk of debugger output, we position gud-delete-prompt-marker at
+;;; the start of the prompt; the process filter will notice this, and
+;;; delete all text between it and the process output marker. If
+;;; gud-delete-prompt-marker points nowhere, we leave the current
+;;; prompt alone.
+(defvar gud-delete-prompt-marker nil)
\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.
-These functions repeat themselves the appropriate number of times if you give a
-prefix argument.
+Under gdb, dbx, and xdb, \\[gud-up] pops up through an enclosing stack
+frame. \\[gud-down] drops back down through one.
-If you are in a source file, you may do the following:
+If you are using gdb or xdb, \\[gud-finish] runs execution to the return from
+the current function and stops.
-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 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.
-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.
+All pre-defined functions for which the concept make sense repeat
+themselves the appropriate number of times if you give a prefix
+argument.
+
+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)
+ (use-local-map (copy-keymap comint-mode-map))
(make-local-variable 'gud-last-frame)
(setq gud-last-frame nil)
(make-local-variable 'comint-prompt-regexp)
+ (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))
+(defvar gud-comint-buffer nil)
+
+;; 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 (expand-file-name file-word))
+ (filepart (file-name-nondirectory file)))
+ (switch-to-buffer (concat "*gud-" filepart "*"))
+ (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
+ (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)))))
+
+;; 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-insert (proc string)
+(defun gud-filter (proc string)
;; Here's where the actual buffer insertion is done
- (let ((moving (= (point) (process-mark proc)))
- (output-after-point (< (point) (process-mark proc)))
- (old-buffer (current-buffer))
- start)
- (set-buffer (process-buffer proc))
- (unwind-protect
+ (let ((inhibit-quit t))
+ (save-excursion
+ (set-buffer (process-buffer proc))
+ (let (moving output-after-point)
(save-excursion
- ;; Insert the text, moving the process-marker.
(goto-char (process-mark proc))
- (setq start (point))
- (insert-before-markers string)
- (set-marker (process-mark proc) (point))
+ ;; 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 (gud-marker-filter string))
+ (setq moving (= (point) (process-mark proc)))
+ (setq output-after-point (< (point) (process-mark proc)))
;; 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))
- )
- (set-buffer old-buffer))
- (if moving (goto-char (process-mark proc)))))
+ (if (and gud-last-frame
+ (not output-after-point)
+ (get-buffer-window (current-buffer)))
+ (gud-display-frame)))
+ (if moving (goto-char (process-mark proc)))))))
(defun gud-sentinel (proc msg)
(cond ((null (buffer-name (process-buffer proc)))
;; 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* ((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)
+
+;;; 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))))
+ (if (string-match "\\(.*\\)%f\\(.*\\)" str)
+ (progn
+ (setq str (concat
+ (substring str (match-beginning 1) (match-end 1))
+ (file-name-nondirectory (if insource
+ (buffer-file-name)
+ (car gud-last-frame)))
+ (substring str (match-beginning 2) (match-end 2))))))
+ (if (string-match "\\(.*\\)%l\\(.*\\)" str)
+ (progn
+ (setq str (concat
+ (substring str (match-beginning 1) (match-end 1))
+ (if insource
+ (save-excursion
+ (beginning-of-line)
+ (save-restriction (widen)
+ (1+ (count-lines 1 (point)))))
+ (cdr gud-last-frame))
+ (substring str (match-beginning 2) (match-end 2))))))
+ (if (string-match "\\(.*\\)%e\\(.*\\)" str)
+ (progn
+ (setq str (concat
+ (substring str (match-beginning 1) (match-end 1))
+ (find-c-expr)
+ (substring str (match-beginning 2) (match-end 2))))))
+ (if (string-match "\\(.*\\)%a\\(.*\\)" str)
+ (progn
+ (setq str (concat
+ (substring str (match-beginning 1) (match-end 1))
+ (gud-read-address)
+ (substring str (match-beginning 2) (match-end 2))))))
+ (if (string-match "\\(.*\\)%p\\(.*\\)" str)
+ (progn
+ (setq str (concat
+ (substring str (match-beginning 1) (match-end 1))
+ (if arg (int-to-string arg) "")
+ (substring str (match-beginning 2) (match-end 2))))))
+ )
+ 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)))
+ (cond
+ (found (forward-char 2)
+ (buffer-substring found
+ (progn (re-search-forward "[^0-9a-f]")
+ (forward-char -1)
+ (point))))
+ (t (setq begin (progn (re-search-backward "[^0-9]")
+ (forward-char 1)
+ (point)))
+ (forward-char 1)
+ (re-search-forward "[^0-9]")
+ (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)
- (goto-char (point-max))
- (let ((command (concat (apply 'format command args) "\n"))
- (proc (get-buffer-process current-gud-buffer)))
- (gud-filter-insert proc command)
- (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)
- ;; Apply a method from the gud buffer environment, passing it file and line.
- ;; 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))))))
+ (let ((command (concat command "\n"))
+ (proc (get-buffer-process gud-comint-buffer)))
+
+ ;; Arrange for the current prompt to get deleted.
(save-excursion
- (gud-set-buffer)
- (funcall func
- (get-buffer-process current-gud-buffer)
- file
- line)
- )))
-
-(defun gud-break ()
- "Set breakpoint at this source line."
- (interactive)
- (gud-apply-from-source 'gud-set-break))
+ (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 gud-read-address()
- "Return a string containing the core-address found in the buffer at point."
- (save-excursion
- (let ((pt (dot)) found begin)
- (setq found (if (search-backward "0x" (- pt 7) t)(dot)))
- (cond (found (forward-char 2)
- (setq result
- (buffer-substring found
- (progn (re-search-forward "[^0-9a-f]")
- (forward-char -1)
- (dot)))))
- (t (setq begin (progn (re-search-backward "[^0-9]") (forward-char 1)
- (dot)))
- (forward-char 1)
- (re-search-forward "[^0-9]")
- (forward-char -1)
- (buffer-substring begin (dot)))))))
-
-
-(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 (dot-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