debug.el 30.7 KB
Newer Older
1
;;; debug.el --- debuggers and related commands for Emacs  -*- lexical-binding: t -*-
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1985-1986, 1994, 2001-2014 Free Software Foundation,
4
;; Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keywords: lisp, tools, maint
Eric S. Raymond's avatar
Eric S. Raymond committed
8

Jim Blandy's avatar
Jim Blandy committed
9 10
;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
15 16 17 18 19 20 21

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Jim Blandy's avatar
Jim Blandy committed
23

24 25
;;; Commentary:

26
;; This is a major mode documented in the Emacs Lisp manual.
27

Eric S. Raymond's avatar
Eric S. Raymond committed
28
;;; Code:
Jim Blandy's avatar
Jim Blandy committed
29

Miles Bader's avatar
Miles Bader committed
30 31
(require 'button)

Stephen Eglen's avatar
Stephen Eglen committed
32 33 34 35
(defgroup debugger nil
  "Debuggers and related commands for Emacs."
  :prefix "debugger-"
  :group 'debug)
36

Stephen Eglen's avatar
Stephen Eglen committed
37
(defcustom debugger-mode-hook nil
38
  "Hooks run when `debugger-mode' is turned on."
Stephen Eglen's avatar
Stephen Eglen committed
39
  :type 'hook
Dan Nicolaescu's avatar
Dan Nicolaescu committed
40 41
  :group 'debugger
  :version "20.3")
42

43
(defcustom debugger-batch-max-lines 40
44
  "Maximum lines to show in debugger buffer in a noninteractive Emacs.
45 46 47 48 49 50
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")
Jim Blandy's avatar
Jim Blandy committed
51

52
(defcustom debugger-bury-or-kill 'bury
Glenn Morris's avatar
Glenn Morris committed
53 54 55
  "What to do with the debugger buffer when exiting `debug'.
The value affects the behavior of operations on any window
previously showing the debugger buffer.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78

`nil' means that if its window is not deleted when exiting the
  debugger, invoking `switch-to-prev-buffer' will usually show
  the debugger buffer again.

`append' means that if the window is not deleted, the debugger
  buffer moves to the end of the window's previous buffers so
  it's less likely that a future invocation of
  `switch-to-prev-buffer' will switch to it.  Also, it moves the
  buffer to the end of the frame's buffer list.

`bury' means that if the window is not deleted, its buffer is
  removed from the window's list of previous buffers.  Also, it
  moves the buffer to the end of the frame's buffer list.  This
  value provides the most reliable remedy to not have
  `switch-to-prev-buffer' switch to the debugger buffer again
  without killing the buffer.

`kill' means to kill the debugger buffer.

The value used here is passed to `quit-restore-window'."
  :type '(choice
	  (const :tag "Keep alive" nil)
79 80 81
	  (const :tag "Append" append)
	  (const :tag "Bury" bury)
	  (const :tag "Kill" kill))
82
  :group 'debugger
83
  :version "24.3")
84

85 86
(defvar debugger-step-after-exit nil
  "Non-nil means \"single-step\" after the debugger exits.")
87 88 89 90 91 92 93

(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.")

94 95 96
(defvar debugger-previous-window nil
  "This is the window last showing the debugger buffer.")

97 98 99
(defvar debugger-previous-window-height nil
  "The last recorded height of `debugger-previous-window'.")

100 101 102 103
(defvar debugger-previous-backtrace nil
  "The contents of the previous backtrace (including text properties).
This is to optimize `debugger-make-xrefs'.")

104
(defvar debugger-outer-match-data)
105 106
(defvar debugger-will-be-back nil
  "Non-nil if we expect to get back in the debugger soon.")
107

108 109 110 111 112
(defvar inhibit-debug-on-entry nil
  "Non-nil means that debug-on-entry is disabled.")

(defvar debugger-jumping-flag nil
  "Non-nil means that debug-on-entry is disabled.
113 114
This variable is used by `debugger-jump', `debugger-step-through',
and `debugger-reenable' to temporarily disable debug-on-entry.")
115

116
(defvar inhibit-trace)                  ;Not yet implemented.
117

118 119 120 121 122 123 124 125 126 127
(defvar debugger-args nil
  "Arguments with which the debugger was called.
It is a list expected to take the form (CAUSE . REST)
where CAUSE can be:
- debug: called for entry to a flagged function.
- t: called because of debug-on-next-call.
- lambda: same thing but via `funcall'.
- exit: called because of exit of a flagged function.
- error: called because of `debug-on-error'.")

Jim Blandy's avatar
Jim Blandy committed
128 129 130
;;;###autoload
(setq debugger 'debug)
;;;###autoload
131
(defun debug (&rest args)
132
  "Enter debugger.  \\<debugger-mode-map>`\\[debugger-continue]' returns from the debugger.
Jim Blandy's avatar
Jim Blandy committed
133 134 135 136 137 138
Arguments are mainly for use when this is called from the internals
of the evaluator.

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."
139
  (interactive)
140 141 142 143 144 145
  (if inhibit-redisplay
      ;; Don't really try to enter debugger within an eval from redisplay.
      debugger-value
    (unless noninteractive
      (message "Entering debugger..."))
    (let (debugger-value
146 147 148 149
	  (debugger-previous-state
           (if (get-buffer "*Backtrace*")
               (with-current-buffer (get-buffer "*Backtrace*")
                 (list major-mode (buffer-string)))))
150
          (debugger-args args)
151
	  (debugger-buffer (get-buffer-create "*Backtrace*"))
152
	  (debugger-old-buffer (current-buffer))
153
	  (debugger-window nil)
154
	  (debugger-step-after-exit nil)
155
          (debugger-will-be-back nil)
156 157 158 159 160
	  ;; Don't keep reading from an executing kbd macro!
	  (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))
161
	  (debugger-with-timeout-suspend (with-timeout-suspend)))
162 163 164 165 166
      ;; 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
167 168
	    (inhibit-trace t)
	    (inhibit-debug-on-entry t)
169
	    unread-command-events
170 171 172 173 174 175 176 177 178 179 180
	    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
181 182
	    (cursor-in-echo-area nil)
	    (window-configuration (current-window-configuration)))
183 184
	(unwind-protect
	    (save-excursion
185 186
	      (when (eq (car debugger-args) 'debug)
		;; Skip the frames for backtrace-debug, byte-code,
187
		;; debug--implement-debug-on-entry and the advice's `apply'.
188 189 190 191 192 193 194 195 196 197 198
		(backtrace-debug 4 t)
		;; Place an extra debug-on-exit for macro's.
		(when (eq 'lambda (car-safe (cadr (backtrace-frame 4))))
		  (backtrace-debug 5 t)))
	      (pop-to-buffer
	       debugger-buffer
	       `((display-buffer-reuse-window
		  display-buffer-in-previous-window)
		  . (,(when debugger-previous-window
			`(previous-window . ,debugger-previous-window)))))
	      (setq debugger-window (selected-window))
199 200 201 202 203 204 205 206
	      (if (eq debugger-previous-window debugger-window)
		  (when debugger-jumping-flag
		    ;; Try to restore previous height of debugger
		    ;; window.
		    (condition-case nil
			(window-resize
			 debugger-window
			 (- debugger-previous-window-height
207
			    (window-total-height debugger-window)))
208 209
		      (error nil)))
		(setq debugger-previous-window debugger-window))
210 211 212 213 214 215 216
	      (debugger-mode)
	      (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)
217
		  (goto-char (point-min))
218 219 220 221 222 223 224 225 226 227 228 229 230
		  (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 "%s" (buffer-string))
		(kill-emacs -1))
	      (message "")
	      (let ((standard-output nil)
		    (buffer-read-only t))
231
		(message "")
232 233 234
		;; Make sure we unbind buffer-read-only in the right buffer.
		(save-excursion
		  (recursive-edit))))
235 236 237 238
	  (when (and (window-live-p debugger-window)
		     (eq (window-buffer debugger-window) debugger-buffer))
	    ;; Record height of debugger window.
	    (setq debugger-previous-window-height
239
		  (window-total-height debugger-window)))
240 241 242 243 244 245 246 247 248 249
	  (if debugger-will-be-back
	      ;; Restore previous window configuration (Bug#12623).
	      (set-window-configuration window-configuration)
	    (when (and (window-live-p debugger-window)
		       (eq (window-buffer debugger-window) debugger-buffer))
	      (progn
		;; Unshow debugger-buffer.
		(quit-restore-window debugger-window debugger-bury-or-kill)
		;; Restore current buffer (Bug#12502).
		(set-buffer debugger-old-buffer))))
250 251 252 253 254 255 256 257 258 259 260
          ;; Restore previous state of debugger-buffer in case we were
          ;; in a recursive invocation of the debugger, otherwise just
          ;; erase the buffer and put it into fundamental mode.
	  (when (buffer-live-p debugger-buffer)
	    (with-current-buffer debugger-buffer
	      (let ((inhibit-read-only t))
		(erase-buffer)
		(if (null debugger-previous-state)
		    (fundamental-mode)
		  (insert (nth 1 debugger-previous-state))
		  (funcall (nth 0 debugger-previous-state))))))
261
	  (with-timeout-unsuspend debugger-with-timeout-suspend)
262 263 264
	  (set-match-data debugger-outer-match-data)))
      (setq debug-on-next-call debugger-step-after-exit)
      debugger-value)))
Jim Blandy's avatar
Jim Blandy committed
265

266
(defun debugger-setup-buffer (args)
267 268 269 270
  "Initialize the `*Backtrace*' buffer for entry to the debugger.
That buffer should be current already."
  (setq buffer-read-only nil)
  (erase-buffer)
271
  (set-buffer-multibyte t)		;Why was it nil ?  -stef
272
  (setq buffer-undo-list t)
273 274 275 276 277 278 279 280 281
  (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(")
282 283 284 285
		   (forward-line (if (eq (car args) 'debug)
                                     ;; Remove debug--implement-debug-on-entry
                                     ;; and the advice's `apply' frame.
				     3
286
				   1))
287 288 289 290
		   (point)))
  (insert "Debugger entered")
  ;; lambda is for debug-on-call when a function call is next.
  ;; debug is for debug-on-entry function called.
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
  (let ((pos (point)))
    (pcase (car args)
      ((or `lambda `debug)
       (insert "--entering a function:\n")
       (setq pos (1- (point))))
      ;; Exiting a function.
      (`exit
       (insert "--returning value: ")
       (setq pos (point))
       (setq debugger-value (nth 1 args))
       (prin1 debugger-value (current-buffer))
       (insert ?\n)
       (delete-char 1)
       (insert ? )
       (beginning-of-line))
      ;; Debugger entered for an error.
      (`error
       (insert "--Lisp error: ")
       (setq pos (point))
       (prin1 (nth 1 args) (current-buffer))
       (insert ?\n))
      ;; debug-on-call, when the next thing is an eval.
      (`t
       (insert "--beginning evaluation of function call form:\n")
       (setq pos (1- (point))))
      ;; User calls debug directly.
      (_
       (insert ": ")
       (setq pos (point))
       (prin1 (if (eq (car args) 'nil)
                  (cdr args) args)
              (current-buffer))
       (insert ?\n)))
    ;; Place point on "stack frame 0" (bug#15101).
    (goto-char pos))
326 327 328
  ;; After any frame that uses eval-buffer,
  ;; insert a line that states the buffer position it's reading at.
  (save-excursion
329 330 331 332 333 334 335 336 337 338 339
    (let ((tem eval-buffer-list))
      (while (and tem
		  (re-search-forward "^  eval-\\(buffer\\|region\\)(" nil t))
	(end-of-line)
	(insert (format "  ; Reading at buffer position %d"
			;; This will get the wrong result
			;; if there are two nested eval-region calls
			;; for the same buffer.  That's not a very useful case.
			(with-current-buffer (car tem)
			  (point))))
	(pop tem))))
340 341 342
  (debugger-make-xrefs))

(defun debugger-make-xrefs (&optional buffer)
343
  "Attach cross-references to function names in the `*Backtrace*' buffer."
344
  (interactive "b")
345
  (with-current-buffer (or buffer (current-buffer))
346 347 348
    (save-excursion
      (setq buffer (current-buffer))
      (let ((inhibit-read-only t)
Glenn Morris's avatar
Glenn Morris committed
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
	    (old-end (point-min)) (new-end (point-min)))
	;; If we saved an old backtrace, find the common part
	;; between the new and the old.
	;; Compare line by line, starting from the end,
	;; because that's the part that is likely to be unchanged.
	(if debugger-previous-backtrace
	    (let (old-start new-start (all-match t))
	      (goto-char (point-max))
	      (with-temp-buffer
		(insert debugger-previous-backtrace)
		(while (and all-match (not (bobp)))
		  (setq old-end (point))
		  (forward-line -1)
		  (setq old-start (point))
		  (with-current-buffer buffer
		    (setq new-end (point))
		    (forward-line -1)
		    (setq new-start (point)))
		  (if (not (zerop
			    (let ((case-fold-search nil))
			      (compare-buffer-substrings
			       (current-buffer) old-start old-end
			       buffer new-start new-end))))
		      (setq all-match nil))))
	      ;; Now new-end is the position of the start of the
	      ;; unchanged part in the current buffer, and old-end is
	      ;; the position of that same text in the saved old
	      ;; backtrace.  But we must subtract (point-min) since strings are
	      ;; indexed in origin 0.
378

Glenn Morris's avatar
Glenn Morris committed
379 380 381 382 383 384 385 386 387 388 389 390
	      ;; Replace the unchanged part of the backtrace
	      ;; with the text from debugger-previous-backtrace,
	      ;; since that already has the proper xrefs.
	      ;; With this optimization, we only need to scan
	      ;; the changed part of the backtrace.
	      (delete-region new-end (point-max))
	      (goto-char (point-max))
	      (insert (substring debugger-previous-backtrace
				 (- old-end (point-min))))
	      ;; Make the unchanged part of the backtrace inaccessible
	      ;; so it won't be scanned.
	      (narrow-to-region (point-min) new-end)))
391

Glenn Morris's avatar
Glenn Morris committed
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
	;; Scan the new part of the backtrace, inserting xrefs.
	(goto-char (point-min))
	(while (progn
		 (goto-char (+ (point) 2))
		 (skip-syntax-forward "^w_")
		 (not (eobp)))
	  (let* ((beg (point))
		 (end (progn (skip-syntax-forward "w_") (point)))
		 (sym (intern-soft (buffer-substring-no-properties
				    beg end)))
		 (file (and sym (symbol-file sym 'defun))))
	    (when file
	      (goto-char beg)
	      ;; help-xref-button needs to operate on something matched
	      ;; by a regexp, so set that up for it.
	      (re-search-forward "\\(\\sw\\|\\s_\\)+")
	      (help-xref-button 0 'help-function-def sym file)))
	  (forward-line 1))
	(widen))
411
      (setq debugger-previous-backtrace (buffer-string)))))
412

Jim Blandy's avatar
Jim Blandy committed
413 414 415 416 417
(defun debugger-step-through ()
  "Proceed, stepping through subexpressions of this expression.
Enter another debugger on next entry to eval, apply or funcall."
  (interactive)
  (setq debugger-step-after-exit t)
418
  (setq debugger-jumping-flag t)
419
  (setq debugger-will-be-back t)
420
  (add-hook 'post-command-hook 'debugger-reenable)
Jim Blandy's avatar
Jim Blandy committed
421 422 423 424 425 426
  (message "Proceeding, will debug on next eval or call.")
  (exit-recursive-edit))

(defun debugger-continue ()
  "Continue, evaluating this expression without stopping."
  (interactive)
427 428
  (unless debugger-may-continue
    (error "Cannot continue"))
Jim Blandy's avatar
Jim Blandy committed
429
  (message "Continuing.")
430 431 432 433 434 435
  (save-excursion
    ;; Check to see if we've flagged some frame for debug-on-exit, in which
    ;; case we'll probably come back to the debugger soon.
    (goto-char (point-min))
    (if (re-search-forward "^\\* " nil t)
        (setq debugger-will-be-back t)))
Jim Blandy's avatar
Jim Blandy committed
436 437 438 439 440 441 442
  (exit-recursive-edit))

(defun debugger-return-value (val)
  "Continue, specifying value to return.
This is only useful when the value returned from the debugger
will be used, such as in a debug on exit from a frame."
  (interactive "XReturn value (evaluated): ")
443 444 445 446
  (when (memq (car debugger-args) '(t lambda error debug))
    (error "Cannot return a value %s"
           (if (eq (car debugger-args) 'error)
               "from an error" "at function entrance")))
Jim Blandy's avatar
Jim Blandy committed
447 448 449
  (setq debugger-value val)
  (princ "Returning " t)
  (prin1 debugger-value)
450 451 452 453 454 455
  (save-excursion
    ;; Check to see if we've flagged some frame for debug-on-exit, in which
    ;; case we'll probably come back to the debugger soon.
    (goto-char (point-min))
    (if (re-search-forward "^\\* " nil t)
        (setq debugger-will-be-back t)))
Jim Blandy's avatar
Jim Blandy committed
456 457 458 459 460
  (exit-recursive-edit))

(defun debugger-jump ()
  "Continue to exit from this frame, with all debug-on-entry suspended."
  (interactive)
461
  (debugger-frame)
462 463
  (setq debugger-jumping-flag t)
  (add-hook 'post-command-hook 'debugger-reenable)
Jim Blandy's avatar
Jim Blandy committed
464
  (message "Continuing through this frame")
465
  (setq debugger-will-be-back t)
Jim Blandy's avatar
Jim Blandy committed
466 467 468
  (exit-recursive-edit))

(defun debugger-reenable ()
469 470 471 472 473
  "Turn all debug-on-entry functions back on.
This function is put on `post-command-hook' by `debugger-jump' and
removes itself from that hook."
  (setq debugger-jumping-flag nil)
  (remove-hook 'post-command-hook 'debugger-reenable))
Jim Blandy's avatar
Jim Blandy committed
474

475
(defun debugger-frame-number (&optional skip-base)
Jim Blandy's avatar
Jim Blandy committed
476 477 478
  "Return number of frames in backtrace before the one point points at."
  (save-excursion
    (beginning-of-line)
479 480
    (if (looking-at " *;;;\\|[a-z]")
	(error "This line is not a function call"))
Jim Blandy's avatar
Jim Blandy committed
481 482
    (let ((opoint (point))
	  (count 0))
483 484 485 486 487 488 489
      (unless skip-base
        (while (not (eq (cadr (backtrace-frame count)) 'debug))
          (setq count (1+ count)))
        ;; Skip debug--implement-debug-on-entry frame.
        (when (eq 'debug--implement-debug-on-entry
                  (cadr (backtrace-frame (1+ count))))
          (setq count (+ 2 count))))
Jim Blandy's avatar
Jim Blandy committed
490
      (goto-char (point-min))
491 492 493
      (when (looking-at "Debugger entered--\\(Lisp error\\|returning value\\):")
	(goto-char (match-end 0))
	(forward-sexp 1))
Jim Blandy's avatar
Jim Blandy committed
494 495 496
      (forward-line 1)
      (while (progn
	       (forward-char 2)
497 498 499 500 501 502 503
	       (cond ((debugger--locals-visible-p)
		      (goto-char (next-single-char-property-change
				  (point) 'locals-visible)))
		     ((= (following-char) ?\()
		      (forward-sexp 1))
		     (t
		      (forward-sexp 2)))
Jim Blandy's avatar
Jim Blandy committed
504 505
	       (forward-line 1)
	       (<= (point) opoint))
506 507
	(if (looking-at " *;;;")
	    (forward-line 1))
Jim Blandy's avatar
Jim Blandy committed
508 509 510 511 512 513 514
	(setq count (1+ count)))
      count)))

(defun debugger-frame ()
  "Request entry to debugger when this frame exits.
Applies to the frame whose line point is on in the backtrace."
  (interactive)
515
  (backtrace-debug (debugger-frame-number) t)
516
  (beginning-of-line)
Jim Blandy's avatar
Jim Blandy committed
517
  (if (= (following-char) ? )
518
      (let ((inhibit-read-only t))
Jim Blandy's avatar
Jim Blandy committed
519 520 521 522 523
	(delete-char 1)
	(insert ?*)))
  (beginning-of-line))

(defun debugger-frame-clear ()
524
  "Do not enter debugger when this frame exits.
Jim Blandy's avatar
Jim Blandy committed
525 526
Applies to the frame whose line point is on in the backtrace."
  (interactive)
527
  (backtrace-debug (debugger-frame-number) nil)
528
  (beginning-of-line)
Jim Blandy's avatar
Jim Blandy committed
529
  (if (= (following-char) ?*)
530
      (let ((inhibit-read-only t))
Jim Blandy's avatar
Jim Blandy committed
531 532 533 534
	(delete-char 1)
	(insert ? )))
  (beginning-of-line))

535 536
(defmacro debugger-env-macro (&rest body)
  "Run BODY in original environment."
Stefan Monnier's avatar
Stefan Monnier committed
537
  (declare (indent 0))
538
  `(save-excursion
539
    (if (null (buffer-live-p debugger-old-buffer))
540 541 542
        ;; old buffer deleted
        (setq debugger-old-buffer (current-buffer)))
    (set-buffer debugger-old-buffer)
543 544 545 546
    (set-match-data debugger-outer-match-data)
    (prog1
        (progn ,@body)
      (setq debugger-outer-match-data (match-data)))))
547

548 549 550 551 552 553 554 555
(defun debugger--backtrace-base ()
  "Return the function name that marks the top of the backtrace.
See `backtrace-frame'."
  (cond ((eq 'debug--implement-debug-on-entry
	     (cadr (backtrace-frame 1 'debug)))
	 'debug--implement-debug-on-entry)
	(t 'debug)))

556
(defun debugger-eval-expression (exp &optional nframe)
557 558
  "Eval an expression, in an environment like that outside the debugger.
The environment used is the one when entering the activation frame at point."
559
  (interactive
560 561 562 563
   (list (read--expression "Eval in stack frame: ")))
  (let ((nframe (or nframe
                    (condition-case nil (1+ (debugger-frame-number 'skip-base))
                      (error 0)))) ;; If on first line.
564
	(base (debugger--backtrace-base)))
565 566 567 568 569 570
    (debugger-env-macro
      (let ((val (backtrace-eval exp nframe base)))
        (prog1
            (prin1 val t)
          (let ((str (eval-expression-print-format val)))
            (if str (princ str t))))))))
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627

(defun debugger--locals-visible-p ()
  "Are the local variables of the current stack frame visible?"
  (save-excursion
    (move-to-column 2)
    (get-text-property (point) 'locals-visible)))

(defun debugger--insert-locals (locals)
  "Insert the local variables LOCALS at point."
  (cond ((null locals)
	 (insert "\n    [no locals]"))
	(t
	 (let ((print-escape-newlines t))
	   (dolist (s+v locals)
	     (let ((symbol (car s+v))
		   (value (cdr s+v)))
	       (insert "\n    ")
	       (prin1 symbol (current-buffer))
	       (insert " = ")
	       (prin1 value (current-buffer))))))))

(defun debugger--show-locals ()
  "For the frame at point, insert locals and add text properties."
  (let* ((nframe (1+ (debugger-frame-number 'skip-base)))
	 (base (debugger--backtrace-base))
	 (locals (backtrace--locals nframe base))
	 (inhibit-read-only t))
    (save-excursion
      (let ((start (progn
		     (move-to-column 2)
		     (point))))
	(end-of-line)
	(debugger--insert-locals locals)
	(add-text-properties start (point) '(locals-visible t))))))

(defun debugger--hide-locals ()
  "Delete local variables and remove the text property."
  (let* ((col (current-column))
	 (end (progn
		(move-to-column 2)
		(next-single-char-property-change (point) 'locals-visible)))
	 (start (previous-single-char-property-change end 'locals-visible))
	 (inhibit-read-only t))
    (remove-text-properties start end '(locals-visible))
    (goto-char start)
    (end-of-line)
    (delete-region (point) end)
    (move-to-column col)))

(defun debugger-toggle-locals ()
  "Show or hide local variables of the current stack frame."
  (interactive)
  (cond ((debugger--locals-visible-p)
	 (debugger--hide-locals))
	(t
	 (debugger--show-locals))))

Jim Blandy's avatar
Jim Blandy committed
628

629
(defvar debugger-mode-map
630 631
  (let ((map (make-keymap))
	(menu-map (make-sparse-keymap)))
632 633 634 635 636 637 638 639 640 641 642 643 644
    (set-keymap-parent map button-buffer-map)
    (suppress-keymap map)
    (define-key map "-" 'negative-argument)
    (define-key map "b" 'debugger-frame)
    (define-key map "c" 'debugger-continue)
    (define-key map "j" 'debugger-jump)
    (define-key map "r" 'debugger-return-value)
    (define-key map "u" 'debugger-frame-clear)
    (define-key map "d" 'debugger-step-through)
    (define-key map "l" 'debugger-list-functions)
    (define-key map "h" 'describe-mode)
    (define-key map "q" 'top-level)
    (define-key map "e" 'debugger-eval-expression)
Paul Eggert's avatar
Paul Eggert committed
645
    (define-key map "v" 'debugger-toggle-locals) ; "v" is for "variables".
646 647
    (define-key map " " 'next-line)
    (define-key map "R" 'debugger-record-expression)
648
    (define-key map "\C-m" 'debug-help-follow)
649
    (define-key map [mouse-2] 'push-button)
650 651 652
    (define-key map [menu-bar debugger] (cons "Debugger" menu-map))
    (define-key menu-map [deb-top]
      '(menu-item "Quit" top-level
Dan Nicolaescu's avatar
Dan Nicolaescu committed
653
		  :help "Quit debugging and return to top level"))
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
    (define-key menu-map [deb-s0] '("--"))
    (define-key menu-map [deb-descr]
      '(menu-item "Describe Debugger Mode" describe-mode
		  :help "Display documentation for debugger-mode"))
    (define-key menu-map [deb-hfol]
      '(menu-item "Help Follow" debug-help-follow
		  :help "Follow cross-reference"))
    (define-key menu-map [deb-nxt]
      '(menu-item "Next Line" next-line
		  :help "Move cursor down"))
    (define-key menu-map [deb-s1] '("--"))
    (define-key menu-map [deb-lfunc]
      '(menu-item "List debug on entry functions" debugger-list-functions
		  :help "Display a list of all the functions now set to debug on entry"))
    (define-key menu-map [deb-fclear]
      '(menu-item "Cancel debug frame" debugger-frame-clear
		  :help "Do not enter debugger when this frame exits"))
    (define-key menu-map [deb-frame]
      '(menu-item "Debug frame" debugger-frame
		  :help "Request entry to debugger when this frame exits"))
    (define-key menu-map [deb-s2] '("--"))
    (define-key menu-map [deb-ret]
      '(menu-item "Return value..." debugger-return-value
		  :help "Continue, specifying value to return."))
    (define-key menu-map [deb-rec]
      '(menu-item "Display and Record Expression" debugger-record-expression
		  :help "Display a variable's value and record it in `*Backtrace-record*' buffer"))
    (define-key menu-map [deb-eval]
      '(menu-item "Eval Expression..." debugger-eval-expression
		  :help "Eval an expression, in an environment like that outside the debugger"))
    (define-key menu-map [deb-jump]
      '(menu-item "Jump" debugger-jump
		  :help "Continue to exit from this frame, with all debug-on-entry suspended"))
    (define-key menu-map [deb-cont]
      '(menu-item "Continue" debugger-continue
689
	:help "Continue, evaluating this expression without stopping"))
690 691
    (define-key menu-map [deb-step]
      '(menu-item "Step through" debugger-step-through
692
	:help "Proceed, stepping through subexpressions of this expression"))
693
    map))
694 695 696

(put 'debugger-mode 'mode-class 'special)

697
(define-derived-mode debugger-mode fundamental-mode "Debugger"
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
  "Mode for backtrace buffers, selected in debugger.
\\<debugger-mode-map>
A line starts with `*' if exiting that frame will call the debugger.
Type \\[debugger-frame] or \\[debugger-frame-clear] to set or remove the `*'.

When in debugger due to frame being exited,
use the \\[debugger-return-value] command to override the value
being returned from that frame.

Use \\[debug-on-entry] and \\[cancel-debug-on-entry] to control
which functions will enter the debugger when called.

Complete list of commands:
\\{debugger-mode-map}"
  (setq truncate-lines t)
  (set-syntax-table emacs-lisp-mode-syntax-table)
714
  (use-local-map debugger-mode-map))
715

Stephen Eglen's avatar
Stephen Eglen committed
716
(defcustom debugger-record-buffer "*Debugger-record*"
717
  "Buffer name for expression values, for \\[debugger-record-expression]."
Stephen Eglen's avatar
Stephen Eglen committed
718
  :type 'string
Dan Nicolaescu's avatar
Dan Nicolaescu committed
719 720
  :group 'debugger
  :version "20.3")
721 722 723 724

(defun debugger-record-expression  (exp)
  "Display a variable's value and record it in `*Backtrace-record*' buffer."
  (interactive
725
   (list (read--expression "Record Eval: ")))
726 727 728 729 730 731 732
  (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)
733
    (message "%s"
734 735
	     (buffer-substring (line-beginning-position 0)
			       (line-end-position 0)))))
Jim Blandy's avatar
Jim Blandy committed
736

Glenn Morris's avatar
Glenn Morris committed
737 738
(declare-function help-xref-interned "help-mode" (symbol))

739 740 741 742 743 744
(defun debug-help-follow (&optional pos)
  "Follow cross-reference at POS, defaulting to point.

For the cross-reference format, see `help-make-xrefs'."
  (interactive "d")
  (require 'help-mode)
745 746 747
  ;; Ideally we'd just do (call-interactively 'help-follow) except that this
  ;; assumes we're already in a *Help* buffer and reuses it, so it ends up
  ;; incorrectly "reusing" the *Backtrace* buffer to show the help info.
748 749 750 751 752 753 754 755 756 757 758 759
  (unless pos
    (setq pos (point)))
  (unless (push-button pos)
    ;; check if the symbol under point is a function or variable
    (let ((sym
	   (intern
	    (save-excursion
	      (goto-char pos) (skip-syntax-backward "w_")
	      (buffer-substring (point)
				(progn (skip-syntax-forward "w_")
				       (point)))))))
      (when (or (boundp sym) (fboundp sym) (facep sym))
760
        (help-xref-interned sym)))))
Jim Blandy's avatar
Jim Blandy committed
761

Lute Kamstra's avatar
Lute Kamstra committed
762 763
;; When you change this, you may also need to change the number of
;; frames that the debugger skips.
764
(defun debug--implement-debug-on-entry (&rest _ignore)
Lute Kamstra's avatar
Lute Kamstra committed
765 766 767 768 769 770 771
  "Conditionally call the debugger.
A call to this function is inserted by `debug-on-entry' to cause
functions to break on entry."
  (if (or inhibit-debug-on-entry debugger-jumping-flag)
      nil
    (funcall debugger 'debug)))

Jim Blandy's avatar
Jim Blandy committed
772 773 774
;;;###autoload
(defun debug-on-entry (function)
  "Request FUNCTION to invoke debugger each time it is called.
775

776
When called interactively, prompt for FUNCTION in the minibuffer.
777 778 779 780 781 782 783 784

This works by modifying the definition of FUNCTION.  If you tell the
debugger to continue, FUNCTION's execution proceeds.  If FUNCTION is a
normal function or a macro written in Lisp, you can also step through
its execution.  FUNCTION can also be a primitive that is not a special
form, in which case stepping is not possible.  Break-on-entry for
primitive functions only works when that function is called from Lisp.

Jim Blandy's avatar
Jim Blandy committed
785
Use \\[cancel-debug-on-entry] to cancel the effect of this command.
786
Redefining FUNCTION also cancels it."
787 788
  (interactive
   (let ((fn (function-called-at-point)) val)
789
     (when (special-form-p fn)
790
       (setq fn nil))
791
     (setq val (completing-read
792 793 794 795 796 797
		(if fn
		    (format "Debug on entry to function (default %s): " fn)
		  "Debug on entry to function: ")
		obarray
		#'(lambda (symbol)
		    (and (fboundp symbol)
798
			 (not (special-form-p symbol))))
799 800
		t nil nil (symbol-name fn)))
     (list (if (equal val "") fn (intern val)))))
801 802
  (advice-add function :before #'debug--implement-debug-on-entry
              '((depth . -100)))
Jim Blandy's avatar
Jim Blandy committed
803 804
  function)

805 806 807 808 809 810 811 812 813
(defun debug--function-list ()
  "List of functions currently set for debug on entry."
  (let ((funs '()))
    (mapatoms
     (lambda (s)
       (when (advice-member-p #'debug--implement-debug-on-entry s)
         (push s funs))))
    funs))

Jim Blandy's avatar
Jim Blandy committed
814 815 816
;;;###autoload
(defun cancel-debug-on-entry (&optional function)
  "Undo effect of \\[debug-on-entry] on FUNCTION.
817
If FUNCTION is nil, cancel debug-on-entry for all functions.
818 819
When called interactively, prompt for FUNCTION in the minibuffer.
To specify a nil argument interactively, exit with an empty minibuffer."
Jim Blandy's avatar
Jim Blandy committed
820 821
  (interactive
   (list (let ((name
822
		(completing-read
823
		 "Cancel debug on entry to function (default all functions): "
824
		 (mapcar #'symbol-name (debug--function-list)) nil t)))
825 826 827
	   (when name
	     (unless (string= name "")
	       (intern name))))))
828
  (if function
Jim Blandy's avatar
Jim Blandy committed
829
      (progn
830
        (advice-remove function #'debug--implement-debug-on-entry)
Jim Blandy's avatar
Jim Blandy committed
831
	function)
Paul Eggert's avatar
Paul Eggert committed
832
    (message "Canceling debug-on-entry for all functions")
833
    (mapcar #'cancel-debug-on-entry (debug--function-list))))
Jim Blandy's avatar
Jim Blandy committed
834 835 836 837

(defun debugger-list-functions ()
  "Display a list of all the functions now set to debug on entry."
  (interactive)
838
  (require 'help-mode)
839 840
  (help-setup-xref '(debugger-list-functions)
		   (called-interactively-p 'interactive))
841 842
  (with-output-to-temp-buffer (help-buffer)
    (with-current-buffer standard-output
843 844 845 846 847 848 849 850 851 852 853 854
      (let ((funs (debug--function-list)))
        (if (null funs)
            (princ "No debug-on-entry functions now\n")
          (princ "Functions set to debug on entry:\n\n")
          (dolist (fun funs)
            (make-text-button (point) (progn (prin1 fun) (point))
                              'type 'help-function
                              'help-args (list fun))
            (terpri))
          (terpri)
          (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."))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
855

Richard M. Stallman's avatar
Richard M. Stallman committed
856 857
(provide 'debug)

Eric S. Raymond's avatar
Eric S. Raymond committed
858
;;; debug.el ends here