;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING. If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
;;; Commentary:
;;; Code:
-(defvar debug-function-list nil
- "List of functions currently set for debug on entry.")
+(defgroup debugger nil
+ "Debuggers and related commands for Emacs."
+ :prefix "debugger-"
+ :group 'debug)
+
+(defcustom debugger-mode-hook nil
+ "*Hooks run when `debugger-mode' is turned on."
+ :type 'hook
+ :group 'debugger
+ :version "20.3")
+
+(defcustom debugger-batch-max-lines 40
+ "*Maximum lines to show in debugger buffer in a noninteractive Emacs.
+When the debugger is entered and Emacs is running in batch mode,
+if the backtrace text has more than this many lines,
+the middle is discarded, and just the beginning and end are displayed."
+ :type 'integer
+ :group 'debugger
+ :version "21.1")
+
+(defcustom debug-function-list nil
+ "List of functions currently set for debug on entry."
+ :type '(repeat function)
+ :group 'debugger)
+
+(defcustom debugger-step-after-exit nil
+ "Non-nil means \"single-step\" after the debugger exits."
+ :type 'boolean
+ :group 'debugger)
+
+(defvar debugger-value nil
+ "This is the value for the debugger to return, when it returns.")
+
+(defvar debugger-old-buffer nil
+ "This is the buffer that was current when the debugger was entered.")
(defvar debugger-outer-match-data)
+(defvar debugger-outer-load-read-function)
+(defvar debugger-outer-overriding-local-map)
+(defvar debugger-outer-overriding-terminal-local-map)
(defvar debugger-outer-track-mouse)
(defvar debugger-outer-last-command)
(defvar debugger-outer-this-command)
(defvar debugger-outer-unread-command-char)
(defvar debugger-outer-unread-command-events)
+(defvar debugger-outer-unread-post-input-method-events)
(defvar debugger-outer-last-input-event)
(defvar debugger-outer-last-command-event)
(defvar debugger-outer-last-nonmenu-event)
(defvar debugger-outer-last-event-frame)
(defvar debugger-outer-standard-input)
(defvar debugger-outer-standard-output)
+(defvar debugger-outer-inhibit-redisplay)
(defvar debugger-outer-cursor-in-echo-area)
;;;###autoload
You may call with no args, or you may pass nil as the first arg and
any other args you like. In that case, the list of args after the
first will be printed into the backtrace buffer."
- (message "Entering debugger...")
+ (interactive)
+ (unless noninteractive
+ (message "Entering debugger..."))
(let (debugger-value
(debug-on-error nil)
(debug-on-quit nil)
(debugger-old-buffer (current-buffer))
(debugger-step-after-exit nil)
;; Don't keep reading from an executing kbd macro!
- (executing-macro nil)
+ (executing-kbd-macro nil)
;; Save the outer values of these vars for the `e' command
;; before we replace the values.
(debugger-outer-match-data (match-data))
+ (debugger-outer-load-read-function load-read-function)
+ (debugger-outer-overriding-local-map overriding-local-map)
+ (debugger-outer-overriding-terminal-local-map
+ overriding-terminal-local-map)
(debugger-outer-track-mouse track-mouse)
(debugger-outer-last-command last-command)
(debugger-outer-this-command this-command)
(debugger-outer-unread-command-char unread-command-char)
(debugger-outer-unread-command-events unread-command-events)
+ (debugger-outer-unread-post-input-method-events
+ unread-post-input-method-events)
(debugger-outer-last-input-event last-input-event)
(debugger-outer-last-command-event last-command-event)
(debugger-outer-last-nonmenu-event last-nonmenu-event)
(debugger-outer-last-event-frame last-event-frame)
(debugger-outer-standard-input standard-input)
(debugger-outer-standard-output standard-output)
+ (debugger-outer-inhibit-redisplay inhibit-redisplay)
(debugger-outer-cursor-in-echo-area cursor-in-echo-area))
+ ;; Set this instead of binding it, so that `q'
+ ;; will not restore it.
+ (setq overriding-terminal-local-map nil)
;; Don't let these magic variables affect the debugger itself.
(let ((last-command nil) this-command track-mouse
(unread-command-char -1) unread-command-events
+ unread-post-input-method-events
last-input-event last-command-event last-nonmenu-event
last-event-frame
+ overriding-local-map
+ load-read-function
+ ;; If we are inside a minibuffer, allow nesting
+ ;; so that we don't get an error from the `e' command.
+ (enable-recursive-minibuffers
+ (or enable-recursive-minibuffers (> (minibuffer-depth) 0)))
(standard-input t) (standard-output t)
+ inhibit-redisplay
(cursor-in-echo-area nil))
(unwind-protect
(save-excursion
(save-window-excursion
(pop-to-buffer debugger-buffer)
- (erase-buffer)
- (let ((standard-output (current-buffer))
- (print-escape-newlines t)
- (print-length 50))
- (backtrace))
- (goto-char (point-min))
(debugger-mode)
- (delete-region (point)
- (progn
- (search-forward "\n debug(")
- (forward-line 1)
- (point)))
+ (debugger-setup-buffer debugger-args)
+ (when noninteractive
+ ;; If the backtrace is long, save the beginning
+ ;; and the end, but discard the middle.
+ (when (> (count-lines (point-min) (point-max))
+ debugger-batch-max-lines)
+ (goto-char (point-min))
+ (forward-line (/ 2 debugger-batch-max-lines))
+ (let ((middlestart (point)))
+ (goto-char (point-max))
+ (forward-line (- (/ 2 debugger-batch-max-lines)
+ debugger-batch-max-lines))
+ (delete-region middlestart (point)))
+ (insert "...\n"))
+ (goto-char (point-min))
+ (message (buffer-string))
+ (kill-emacs))
+ (if (eq (car debugger-args) 'debug)
+ ;; Skip the frames for backtrace-debug, byte-code, and debug.
+ (backtrace-debug 3 t))
(debugger-reenable)
- (cond ((memq (car debugger-args) '(lambda debug))
- (insert "Entering:\n")
- (if (eq (car debugger-args) 'debug)
- (progn
- (backtrace-debug 4 t)
- (delete-char 1)
- (insert ?*)
- (beginning-of-line))))
- ((eq (car debugger-args) 'exit)
- (insert "Return value: ")
- (setq debugger-value (nth 1 debugger-args))
- (prin1 debugger-value (current-buffer))
- (insert ?\n)
- (delete-char 1)
- (insert ? )
- (beginning-of-line))
- ((eq (car debugger-args) 'error)
- (insert "Signalling: ")
- (prin1 (nth 1 debugger-args) (current-buffer))
- (insert ?\n))
- ((eq (car debugger-args) t)
- (insert "Beginning evaluation of function call form:\n"))
- (t
- (prin1 (if (eq (car debugger-args) 'nil)
- (cdr debugger-args) debugger-args)
- (current-buffer))
- (insert ?\n)))
(message "")
(let ((inhibit-trace t)
(standard-output nil)
(buffer-read-only t))
(message "")
- (recursive-edit))))
+ ;; Make sure we unbind buffer-read-only in the right buffer.
+ (save-excursion
+ (recursive-edit)))))
;; Kill or at least neuter the backtrace buffer, so that users
;; don't try to execute debugger commands in an invalid context.
(if (get-buffer-window debugger-buffer 'visible)
(erase-buffer)
(fundamental-mode))
(kill-buffer debugger-buffer))
- (store-match-data debugger-outer-match-data)))
+ (set-match-data debugger-outer-match-data)))
;; Put into effect the modified values of these variables
;; in case the user set them with the `e' command.
+ (setq load-read-function debugger-outer-load-read-function)
+ (setq overriding-local-map debugger-outer-overriding-local-map)
+ (setq overriding-terminal-local-map
+ debugger-outer-overriding-terminal-local-map)
(setq track-mouse debugger-outer-track-mouse)
(setq last-command debugger-outer-last-command)
(setq this-command debugger-outer-this-command)
(setq unread-command-char debugger-outer-unread-command-char)
(setq unread-command-events debugger-outer-unread-command-events)
+ (setq unread-post-input-method-events
+ debugger-outer-unread-post-input-method-events)
(setq last-input-event debugger-outer-last-input-event)
(setq last-command-event debugger-outer-last-command-event)
(setq last-nonmenu-event debugger-outer-last-nonmenu-event)
(setq last-event-frame debugger-outer-last-event-frame)
(setq standard-input debugger-outer-standard-input)
(setq standard-output debugger-outer-standard-output)
+ (setq inhibit-redisplay debugger-outer-inhibit-redisplay)
(setq cursor-in-echo-area debugger-outer-cursor-in-echo-area)
(setq debug-on-next-call debugger-step-after-exit)
debugger-value))
\f
+(defun debugger-setup-buffer (debugger-args)
+ "Initialize the `*Backtrace*' buffer for entry to the debugger.
+That buffer should be current already."
+ (setq buffer-read-only nil)
+ (erase-buffer)
+ (set-buffer-multibyte nil)
+ (let ((standard-output (current-buffer))
+ (print-escape-newlines t)
+ (print-level 8)
+ (print-length 50))
+ (backtrace))
+ (goto-char (point-min))
+ (delete-region (point)
+ (progn
+ (search-forward "\n debug(")
+ (forward-line 1)
+ (point)))
+ (insert "Debugger entered")
+ ;; lambda is for debug-on-call when a function call is next.
+ ;; debug is for debug-on-entry function called.
+ (cond ((memq (car debugger-args) '(lambda debug))
+ (insert "--entering a function:\n")
+ (if (eq (car debugger-args) 'debug)
+ (progn
+ (delete-char 1)
+ (insert ?*)
+ (beginning-of-line))))
+ ;; Exiting a function.
+ ((eq (car debugger-args) 'exit)
+ (insert "--returning value: ")
+ (setq debugger-value (nth 1 debugger-args))
+ (prin1 debugger-value (current-buffer))
+ (insert ?\n)
+ (delete-char 1)
+ (insert ? )
+ (beginning-of-line))
+ ;; Debugger entered for an error.
+ ((eq (car debugger-args) 'error)
+ (insert "--Lisp error: ")
+ (prin1 (nth 1 debugger-args) (current-buffer))
+ (insert ?\n))
+ ;; debug-on-call, when the next thing is an eval.
+ ((eq (car debugger-args) t)
+ (insert "--beginning evaluation of function call form:\n"))
+ ;; User calls debug directly.
+ (t
+ (insert ": ")
+ (prin1 (if (eq (car debugger-args) 'nil)
+ (cdr debugger-args) debugger-args)
+ (current-buffer))
+ (insert ?\n))))
+\f
(defun debugger-step-through ()
"Proceed, stepping through subexpressions of this expression.
Enter another debugger on next entry to eval, apply or funcall."
(prin1 debugger-value)
(exit-recursive-edit))
+;; Chosen empirically to account for all the frames
+;; that will exist when debugger-frame is called
+;; within the first one that appears in the backtrace buffer.
+;; Assumes debugger-frame is called from a key;
+;; will be wrong if it is called with Meta-x.
+(defconst debugger-frame-offset 8 "")
+
(defun debugger-jump ()
"Continue to exit from this frame, with all debug-on-entry suspended."
(interactive)
(setq count (1+ count)))
count)))
-;; Chosen empirically to account for all the frames
-;; that will exist when debugger-frame is called
-;; within the first one that appears in the backtrace buffer.
-;; Assumes debugger-frame is called from a key;
-;; will be wrong if it is called with Meta-x.
-(defconst debugger-frame-offset 8 "")
-
(defun debugger-frame ()
"Request entry to debugger when this frame exits.
Applies to the frame whose line point is on in the backtrace."
(beginning-of-line))
(defun debugger-frame-clear ()
- "Do not enter to debugger when this frame exits.
+ "Do not enter debugger when this frame exits.
Applies to the frame whose line point is on in the backtrace."
(interactive)
(beginning-of-line)
(insert ? )))
(beginning-of-line))
+
+
+(put 'debugger-env-macro 'lisp-indent-function 0)
+(defmacro debugger-env-macro (&rest body)
+ "Run BODY in original environment."
+ `(save-excursion
+ (if (null (buffer-name debugger-old-buffer))
+ ;; old buffer deleted
+ (setq debugger-old-buffer (current-buffer)))
+ (set-buffer debugger-old-buffer)
+ (let ((load-read-function debugger-outer-load-read-function)
+ (overriding-terminal-local-map
+ debugger-outer-overriding-terminal-local-map)
+ (overriding-local-map debugger-outer-overriding-local-map)
+ (track-mouse debugger-outer-track-mouse)
+ (last-command debugger-outer-last-command)
+ (this-command debugger-outer-this-command)
+ (unread-command-char debugger-outer-unread-command-char)
+ (unread-command-events debugger-outer-unread-command-events)
+ (unread-post-input-method-events
+ debugger-outer-unread-post-input-method-events)
+ (last-input-event debugger-outer-last-input-event)
+ (last-command-event debugger-outer-last-command-event)
+ (last-nonmenu-event debugger-outer-last-nonmenu-event)
+ (last-event-frame debugger-outer-last-event-frame)
+ (standard-input debugger-outer-standard-input)
+ (standard-output debugger-outer-standard-output)
+ (inhibit-redisplay debugger-outer-inhibit-redisplay)
+ (cursor-in-echo-area debugger-outer-cursor-in-echo-area))
+ (set-match-data debugger-outer-match-data)
+ (prog1 (progn ,@body)
+ (setq debugger-outer-match-data (match-data))
+ (setq debugger-outer-load-read-function load-read-function)
+ (setq debugger-outer-overriding-terminal-local-map
+ overriding-terminal-local-map)
+ (setq debugger-outer-overriding-local-map overriding-local-map)
+ (setq debugger-outer-track-mouse track-mouse)
+ (setq debugger-outer-last-command last-command)
+ (setq debugger-outer-this-command this-command)
+ (setq debugger-outer-unread-command-char unread-command-char)
+ (setq debugger-outer-unread-command-events unread-command-events)
+ (setq debugger-outer-unread-post-input-method-events
+ unread-post-input-method-events)
+ (setq debugger-outer-last-input-event last-input-event)
+ (setq debugger-outer-last-command-event last-command-event)
+ (setq debugger-outer-last-nonmenu-event last-nonmenu-event)
+ (setq debugger-outer-last-event-frame last-event-frame)
+ (setq debugger-outer-standard-input standard-input)
+ (setq debugger-outer-standard-output standard-output)
+ (setq debugger-outer-inhibit-redisplay inhibit-redisplay)
+ (setq debugger-outer-cursor-in-echo-area cursor-in-echo-area)
+ ))))
+
(defun debugger-eval-expression (exp)
"Eval an expression, in an environment like that outside the debugger."
(interactive
(list (read-from-minibuffer "Eval: "
nil read-expression-map t
'read-expression-history)))
- (save-excursion
- (if (null (buffer-name debugger-old-buffer))
- ;; old buffer deleted
- (setq debugger-old-buffer (current-buffer)))
- (set-buffer debugger-old-buffer)
- (let ((track-mouse debugger-outer-track-mouse)
- (last-command debugger-outer-last-command)
- (this-command debugger-outer-this-command)
- (unread-command-char debugger-outer-unread-command-char)
- (unread-command-events debugger-outer-unread-command-events)
- (last-input-event debugger-outer-last-input-event)
- (last-command-event debugger-outer-last-command-event)
- (last-nonmenu-event debugger-outer-last-nonmenu-event)
- (last-event-frame debugger-outer-last-event-frame)
- (standard-input debugger-outer-standard-input)
- (standard-output debugger-outer-standard-output)
- (cursor-in-echo-area debugger-outer-cursor-in-echo-area))
- (store-match-data debugger-outer-match-data)
- (prog1 (eval-expression exp)
- (setq debugger-outer-match-data (match-data))
- (setq debugger-outer-track-mouse track-mouse)
- (setq debugger-outer-last-command last-command)
- (setq debugger-outer-this-command this-command)
- (setq debugger-outer-unread-command-char unread-command-char)
- (setq debugger-outer-unread-command-events unread-command-events)
- (setq debugger-outer-last-input-event last-input-event)
- (setq debugger-outer-last-command-event last-command-event)
- (setq debugger-outer-last-nonmenu-event last-nonmenu-event)
- (setq debugger-outer-last-event-frame last-event-frame)
- (setq debugger-outer-standard-input standard-input)
- (setq debugger-outer-standard-output standard-output)
- (setq debugger-outer-cursor-in-echo-area cursor-in-echo-area)))))
+ (debugger-env-macro (eval-expression exp)))
\f
(defvar debugger-mode-map nil)
(if debugger-mode-map
(define-key debugger-mode-map "h" 'describe-mode)
(define-key debugger-mode-map "q" 'top-level)
(define-key debugger-mode-map "e" 'debugger-eval-expression)
- (define-key debugger-mode-map " " 'next-line)))
+ (define-key debugger-mode-map " " 'next-line)
+ (define-key debugger-mode-map "R" 'debugger-record-expression)
+ ))
+
+
+(defcustom debugger-record-buffer "*Debugger-record*"
+ "*Buffer name for expression values, for \\[debugger-record-expression]."
+ :type 'string
+ :group 'debugger
+ :version "20.3")
+
+(defun debugger-record-expression (exp)
+ "Display a variable's value and record it in `*Backtrace-record*' buffer."
+ (interactive
+ (list (read-from-minibuffer
+ "Record Eval: "
+ nil
+ read-expression-map t
+ 'read-expression-history)))
+ (let* ((buffer (get-buffer-create debugger-record-buffer))
+ (standard-output buffer))
+ (princ (format "Debugger Eval (%s): " exp))
+ (princ (debugger-eval-expression exp))
+ (terpri))
+
+ (with-current-buffer (get-buffer debugger-record-buffer)
+ (save-excursion
+ (forward-line -1)
+ (message
+ (buffer-substring (point) (progn (end-of-line) (point)))))))
(put 'debugger-mode 'mode-class 'special)
Complete list of commands:
\\{debugger-mode-map}"
- (kill-all-local-variables)
+ (kill-all-local-variables)
(setq major-mode 'debugger-mode)
(setq mode-name "Debugger")
(setq truncate-lines t)
(set-syntax-table emacs-lisp-mode-syntax-table)
- (use-local-map debugger-mode-map))
+ (use-local-map debugger-mode-map)
+ (run-hooks 'debugger-mode-hook))
\f
;;;###autoload
(defun debug-on-entry (function)
Redefining FUNCTION also cancels it."
(interactive "aDebug on entry (to function): ")
(debugger-reenable)
+ ;; Handle a function that has been aliased to some other function.
+ (if (symbolp (symbol-function function))
+ (fset function `(lambda (&rest debug-on-entry-args)
+ (apply ',(symbol-function function)
+ debug-on-entry-args))))
(if (subrp (symbol-function function))
(error "Function %s is a primitive" function))
(or (consp (symbol-function function))
(if (nthcdr 5 contents)
(setq body (cons (list 'interactive (nth 5 contents)) body)))
(if (nth 4 contents)
- (setq body (cons (nth 4 contents) body)))
+ ;; Use `documentation' here, to get the actual string,
+ ;; in case the compiled function has a reference
+ ;; to the .elc file.
+ (setq body (cons (documentation function) body)))
(fset function (cons 'lambda (cons (car contents) body)))))))
(defun debug-on-entry-1 (function defn flag)
(terpri)
(setq list (cdr list))))
(princ "Note: if you have redefined a function, then it may no longer\n")
- (princ "be set to debug on entry, even if it is in the list."))))
+ (princ "be set to debug on entry, even if it is in the list."))
+ (save-excursion
+ (set-buffer standard-output)
+ (help-mode))))
+
+(provide 'debug)
;;; debug.el ends here