Commit | Line | Data |
---|---|---|
c0274f38 ER |
1 | ;;; debug.el --- debuggers and related commands for Emacs |
2 | ||
3731a850 TTN |
3 | ;; Copyright (C) 1985, 1986, 1994, 2001, 2002, 2003, 2004, |
4 | ;; 2005 Free Software Foundation, Inc. | |
9750e079 | 5 | |
e5167999 | 6 | ;; Maintainer: FSF |
e9571d2a | 7 | ;; Keywords: lisp, tools, maint |
e5167999 | 8 | |
0231f2dc JB |
9 | ;; This file is part of GNU Emacs. |
10 | ||
11 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 | ;; it under the terms of the GNU General Public License as published by | |
e5167999 | 13 | ;; the Free Software Foundation; either version 2, or (at your option) |
0231f2dc JB |
14 | ;; any later version. |
15 | ||
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
b578f267 | 22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
3a35cf56 LK |
23 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 | ;; Boston, MA 02110-1301, USA. | |
0231f2dc | 25 | |
e41b2db1 ER |
26 | ;;; Commentary: |
27 | ||
07f3fdb1 | 28 | ;; This is a major mode documented in the Emacs Lisp manual. |
e41b2db1 | 29 | |
e5167999 | 30 | ;;; Code: |
0231f2dc | 31 | |
bb9a622e MB |
32 | (require 'button) |
33 | ||
666b9413 SE |
34 | (defgroup debugger nil |
35 | "Debuggers and related commands for Emacs." | |
36 | :prefix "debugger-" | |
37 | :group 'debug) | |
8c1cd093 | 38 | |
666b9413 SE |
39 | (defcustom debugger-mode-hook nil |
40 | "*Hooks run when `debugger-mode' is turned on." | |
41 | :type 'hook | |
cd32a7ba DN |
42 | :group 'debugger |
43 | :version "20.3") | |
8c1cd093 | 44 | |
63ca439e GM |
45 | (defcustom debugger-batch-max-lines 40 |
46 | "*Maximum lines to show in debugger buffer in a noninteractive Emacs. | |
47 | When the debugger is entered and Emacs is running in batch mode, | |
48 | if the backtrace text has more than this many lines, | |
49 | the middle is discarded, and just the beginning and end are displayed." | |
50 | :type 'integer | |
51 | :group 'debugger | |
52 | :version "21.1") | |
0231f2dc | 53 | |
15cf150d LK |
54 | (defvar debug-function-list nil |
55 | "List of functions currently set for debug on entry.") | |
56 | ||
57 | (defvar debugger-step-after-exit nil | |
58 | "Non-nil means \"single-step\" after the debugger exits.") | |
2eeeb0d2 RS |
59 | |
60 | (defvar debugger-value nil | |
61 | "This is the value for the debugger to return, when it returns.") | |
62 | ||
63 | (defvar debugger-old-buffer nil | |
64 | "This is the buffer that was current when the debugger was entered.") | |
65 | ||
25c58854 RS |
66 | (defvar debugger-previous-backtrace nil |
67 | "The contents of the previous backtrace (including text properties). | |
68 | This is to optimize `debugger-make-xrefs'.") | |
69 | ||
cf1c8cd9 | 70 | (defvar debugger-outer-match-data) |
80ddb8ed RS |
71 | (defvar debugger-outer-load-read-function) |
72 | (defvar debugger-outer-overriding-local-map) | |
29e2b496 | 73 | (defvar debugger-outer-overriding-terminal-local-map) |
35cf010d RS |
74 | (defvar debugger-outer-track-mouse) |
75 | (defvar debugger-outer-last-command) | |
76 | (defvar debugger-outer-this-command) | |
c82fbd0c RS |
77 | ;; unread-command-char is obsolete, |
78 | ;; but we still save and restore it | |
79 | ;; in case some user program still tries to set it. | |
35cf010d RS |
80 | (defvar debugger-outer-unread-command-char) |
81 | (defvar debugger-outer-unread-command-events) | |
0359db82 | 82 | (defvar debugger-outer-unread-post-input-method-events) |
35cf010d RS |
83 | (defvar debugger-outer-last-input-event) |
84 | (defvar debugger-outer-last-command-event) | |
85 | (defvar debugger-outer-last-nonmenu-event) | |
86 | (defvar debugger-outer-last-event-frame) | |
87 | (defvar debugger-outer-standard-input) | |
88 | (defvar debugger-outer-standard-output) | |
bf90c2c0 | 89 | (defvar debugger-outer-inhibit-redisplay) |
35cf010d | 90 | (defvar debugger-outer-cursor-in-echo-area) |
9b530428 SM |
91 | (defvar debugger-will-be-back nil |
92 | "Non-nil if we expect to get back in the debugger soon.") | |
35cf010d | 93 | |
b6b77a90 LK |
94 | (defvar inhibit-debug-on-entry nil |
95 | "Non-nil means that debug-on-entry is disabled.") | |
96 | ||
97 | (defvar debugger-jumping-flag nil | |
98 | "Non-nil means that debug-on-entry is disabled. | |
9b54d453 LK |
99 | This variable is used by `debugger-jump', `debugger-step-through', |
100 | and `debugger-reenable' to temporarily disable debug-on-entry.") | |
cf9a1b69 | 101 | |
d48f0f00 | 102 | (defvar inhibit-trace) ;Not yet implemented. |
77932668 | 103 | |
0231f2dc JB |
104 | ;;;###autoload |
105 | (setq debugger 'debug) | |
106 | ;;;###autoload | |
107 | (defun debug (&rest debugger-args) | |
2512acba | 108 | "Enter debugger. To return, type \\<debugger-mode-map>`\\[debugger-continue]'. |
0231f2dc JB |
109 | Arguments are mainly for use when this is called from the internals |
110 | of the evaluator. | |
111 | ||
112 | You may call with no args, or you may pass nil as the first arg and | |
113 | any other args you like. In that case, the list of args after the | |
114 | first will be printed into the backtrace buffer." | |
73e78cf1 | 115 | (interactive) |
e734f584 RS |
116 | (if inhibit-redisplay |
117 | ;; Don't really try to enter debugger within an eval from redisplay. | |
118 | debugger-value | |
119 | (unless noninteractive | |
120 | (message "Entering debugger...")) | |
121 | (let (debugger-value | |
122 | (debug-on-error nil) | |
123 | (debug-on-quit nil) | |
124 | (debugger-buffer (let ((default-major-mode 'fundamental-mode)) | |
125 | (get-buffer-create "*Backtrace*"))) | |
126 | (debugger-old-buffer (current-buffer)) | |
127 | (debugger-step-after-exit nil) | |
9b530428 | 128 | (debugger-will-be-back nil) |
e734f584 RS |
129 | ;; Don't keep reading from an executing kbd macro! |
130 | (executing-kbd-macro nil) | |
131 | ;; Save the outer values of these vars for the `e' command | |
132 | ;; before we replace the values. | |
133 | (debugger-outer-match-data (match-data)) | |
134 | (debugger-outer-load-read-function load-read-function) | |
135 | (debugger-outer-overriding-local-map overriding-local-map) | |
136 | (debugger-outer-overriding-terminal-local-map | |
137 | overriding-terminal-local-map) | |
138 | (debugger-outer-track-mouse track-mouse) | |
139 | (debugger-outer-last-command last-command) | |
140 | (debugger-outer-this-command this-command) | |
12cf32ce RS |
141 | (debugger-outer-unread-command-char |
142 | (with-no-warnings unread-command-char)) | |
e734f584 RS |
143 | (debugger-outer-unread-command-events unread-command-events) |
144 | (debugger-outer-unread-post-input-method-events | |
145 | unread-post-input-method-events) | |
146 | (debugger-outer-last-input-event last-input-event) | |
147 | (debugger-outer-last-command-event last-command-event) | |
148 | (debugger-outer-last-nonmenu-event last-nonmenu-event) | |
149 | (debugger-outer-last-event-frame last-event-frame) | |
150 | (debugger-outer-standard-input standard-input) | |
151 | (debugger-outer-standard-output standard-output) | |
152 | (debugger-outer-inhibit-redisplay inhibit-redisplay) | |
385480e5 RS |
153 | (debugger-outer-cursor-in-echo-area cursor-in-echo-area) |
154 | (debugger-with-timeout-suspend (with-timeout-suspend))) | |
e734f584 RS |
155 | ;; Set this instead of binding it, so that `q' |
156 | ;; will not restore it. | |
157 | (setq overriding-terminal-local-map nil) | |
158 | ;; Don't let these magic variables affect the debugger itself. | |
159 | (let ((last-command nil) this-command track-mouse | |
cf9a1b69 SM |
160 | (inhibit-trace t) |
161 | (inhibit-debug-on-entry t) | |
12cf32ce | 162 | unread-command-events |
e734f584 RS |
163 | unread-post-input-method-events |
164 | last-input-event last-command-event last-nonmenu-event | |
165 | last-event-frame | |
166 | overriding-local-map | |
167 | load-read-function | |
168 | ;; If we are inside a minibuffer, allow nesting | |
169 | ;; so that we don't get an error from the `e' command. | |
170 | (enable-recursive-minibuffers | |
171 | (or enable-recursive-minibuffers (> (minibuffer-depth) 0))) | |
172 | (standard-input t) (standard-output t) | |
173 | inhibit-redisplay | |
174 | (cursor-in-echo-area nil)) | |
175 | (unwind-protect | |
176 | (save-excursion | |
177 | (save-window-excursion | |
12cf32ce | 178 | (with-no-warnings |
c4fbcb01 LK |
179 | (setq unread-command-char -1)) |
180 | (when (eq (car debugger-args) 'debug) | |
181 | ;; Skip the frames for backtrace-debug, byte-code, | |
182 | ;; and implement-debug-on-entry. | |
183 | (backtrace-debug 4 t) | |
184 | ;; Place an extra debug-on-exit for macro's. | |
185 | (when (eq 'lambda (car-safe (cadr (backtrace-frame 4)))) | |
186 | (backtrace-debug 5 t))) | |
d48f0f00 | 187 | (pop-to-buffer debugger-buffer) |
e734f584 RS |
188 | (debugger-mode) |
189 | (debugger-setup-buffer debugger-args) | |
190 | (when noninteractive | |
191 | ;; If the backtrace is long, save the beginning | |
192 | ;; and the end, but discard the middle. | |
193 | (when (> (count-lines (point-min) (point-max)) | |
194 | debugger-batch-max-lines) | |
195 | (goto-char (point-min)) | |
196 | (forward-line (/ 2 debugger-batch-max-lines)) | |
197 | (let ((middlestart (point))) | |
198 | (goto-char (point-max)) | |
199 | (forward-line (- (/ 2 debugger-batch-max-lines) | |
200 | debugger-batch-max-lines)) | |
201 | (delete-region middlestart (point))) | |
202 | (insert "...\n")) | |
63ca439e | 203 | (goto-char (point-min)) |
2f74c84b | 204 | (message "%s" (buffer-string)) |
e734f584 | 205 | (kill-emacs)) |
35cf010d | 206 | (message "") |
cf9a1b69 | 207 | (let ((standard-output nil) |
e734f584 RS |
208 | (buffer-read-only t)) |
209 | (message "") | |
210 | ;; Make sure we unbind buffer-read-only in the right buffer. | |
211 | (save-excursion | |
212 | (recursive-edit))))) | |
213 | ;; Kill or at least neuter the backtrace buffer, so that users | |
214 | ;; don't try to execute debugger commands in an invalid context. | |
78d54dee | 215 | (if (get-buffer-window debugger-buffer 0) |
e734f584 RS |
216 | ;; Still visible despite the save-window-excursion? Maybe it |
217 | ;; it's in a pop-up frame. It would be annoying to delete and | |
218 | ;; recreate it every time the debugger stops, so instead we'll | |
532c188a | 219 | ;; erase it (and maybe hide it) but keep it alive. |
78d54dee | 220 | (with-current-buffer debugger-buffer |
e734f584 | 221 | (erase-buffer) |
78d54dee SM |
222 | (fundamental-mode) |
223 | (with-selected-window (get-buffer-window debugger-buffer 0) | |
d48f0f00 | 224 | (when (and (window-dedicated-p (selected-window)) |
9b530428 | 225 | (not debugger-will-be-back)) |
532c188a SM |
226 | ;; If the window is not dedicated, burying the buffer |
227 | ;; will mean that the frame created for it is left | |
d48f0f00 | 228 | ;; around showing some random buffer, and next time we |
532c188a SM |
229 | ;; pop to the debugger buffer we'll create yet |
230 | ;; another frame. | |
9b530428 | 231 | ;; If debugger-will-be-back is non-nil, the frame |
d48f0f00 SM |
232 | ;; would need to be de-iconified anyway immediately |
233 | ;; after when we re-enter the debugger, so iconifying it | |
234 | ;; here would cause flashing. | |
01bf52cb SM |
235 | ;; Use quit-window rather than bury-buffer to quieten |
236 | ;; Drew Adams. --Stef | |
237 | (quit-window)))) | |
e734f584 | 238 | (kill-buffer debugger-buffer)) |
385480e5 | 239 | (with-timeout-unsuspend debugger-with-timeout-suspend) |
e734f584 RS |
240 | (set-match-data debugger-outer-match-data))) |
241 | ;; Put into effect the modified values of these variables | |
242 | ;; in case the user set them with the `e' command. | |
243 | (setq load-read-function debugger-outer-load-read-function) | |
244 | (setq overriding-local-map debugger-outer-overriding-local-map) | |
245 | (setq overriding-terminal-local-map | |
246 | debugger-outer-overriding-terminal-local-map) | |
247 | (setq track-mouse debugger-outer-track-mouse) | |
248 | (setq last-command debugger-outer-last-command) | |
249 | (setq this-command debugger-outer-this-command) | |
12cf32ce | 250 | (with-no-warnings |
c4fbcb01 | 251 | (setq unread-command-char debugger-outer-unread-command-char)) |
e734f584 RS |
252 | (setq unread-command-events debugger-outer-unread-command-events) |
253 | (setq unread-post-input-method-events | |
254 | debugger-outer-unread-post-input-method-events) | |
255 | (setq last-input-event debugger-outer-last-input-event) | |
256 | (setq last-command-event debugger-outer-last-command-event) | |
257 | (setq last-nonmenu-event debugger-outer-last-nonmenu-event) | |
258 | (setq last-event-frame debugger-outer-last-event-frame) | |
259 | (setq standard-input debugger-outer-standard-input) | |
260 | (setq standard-output debugger-outer-standard-output) | |
261 | (setq inhibit-redisplay debugger-outer-inhibit-redisplay) | |
262 | (setq cursor-in-echo-area debugger-outer-cursor-in-echo-area) | |
263 | (setq debug-on-next-call debugger-step-after-exit) | |
264 | debugger-value))) | |
0231f2dc | 265 | \f |
63ca439e GM |
266 | (defun debugger-setup-buffer (debugger-args) |
267 | "Initialize the `*Backtrace*' buffer for entry to the debugger. | |
268 | That buffer should be current already." | |
269 | (setq buffer-read-only nil) | |
270 | (erase-buffer) | |
271 | (set-buffer-multibyte nil) | |
272 | (let ((standard-output (current-buffer)) | |
273 | (print-escape-newlines t) | |
274 | (print-level 8) | |
275 | (print-length 50)) | |
276 | (backtrace)) | |
277 | (goto-char (point-min)) | |
278 | (delete-region (point) | |
279 | (progn | |
280 | (search-forward "\n debug(") | |
439368ed | 281 | (forward-line (if (eq (car debugger-args) 'debug) |
449808f7 | 282 | 2 ; Remove implement-debug-on-entry frame. |
439368ed | 283 | 1)) |
63ca439e GM |
284 | (point))) |
285 | (insert "Debugger entered") | |
286 | ;; lambda is for debug-on-call when a function call is next. | |
287 | ;; debug is for debug-on-entry function called. | |
288 | (cond ((memq (car debugger-args) '(lambda debug)) | |
c4fbcb01 | 289 | (insert "--entering a function:\n")) |
63ca439e GM |
290 | ;; Exiting a function. |
291 | ((eq (car debugger-args) 'exit) | |
292 | (insert "--returning value: ") | |
293 | (setq debugger-value (nth 1 debugger-args)) | |
294 | (prin1 debugger-value (current-buffer)) | |
295 | (insert ?\n) | |
296 | (delete-char 1) | |
297 | (insert ? ) | |
298 | (beginning-of-line)) | |
299 | ;; Debugger entered for an error. | |
300 | ((eq (car debugger-args) 'error) | |
301 | (insert "--Lisp error: ") | |
302 | (prin1 (nth 1 debugger-args) (current-buffer)) | |
303 | (insert ?\n)) | |
304 | ;; debug-on-call, when the next thing is an eval. | |
305 | ((eq (car debugger-args) t) | |
306 | (insert "--beginning evaluation of function call form:\n")) | |
307 | ;; User calls debug directly. | |
308 | (t | |
309 | (insert ": ") | |
310 | (prin1 (if (eq (car debugger-args) 'nil) | |
311 | (cdr debugger-args) debugger-args) | |
312 | (current-buffer)) | |
cc1bde62 | 313 | (insert ?\n))) |
27bde5f0 RS |
314 | ;; After any frame that uses eval-buffer, |
315 | ;; insert a line that states the buffer position it's reading at. | |
316 | (save-excursion | |
245f0222 RS |
317 | (let ((tem eval-buffer-list)) |
318 | (while (and tem | |
319 | (re-search-forward "^ eval-\\(buffer\\|region\\)(" nil t)) | |
320 | (end-of-line) | |
321 | (insert (format " ; Reading at buffer position %d" | |
322 | ;; This will get the wrong result | |
323 | ;; if there are two nested eval-region calls | |
324 | ;; for the same buffer. That's not a very useful case. | |
325 | (with-current-buffer (car tem) | |
326 | (point)))) | |
327 | (pop tem)))) | |
cc1bde62 SS |
328 | (debugger-make-xrefs)) |
329 | ||
330 | (defun debugger-make-xrefs (&optional buffer) | |
dc64809a | 331 | "Attach cross-references to function names in the `*Backtrace*' buffer." |
cc1bde62 SS |
332 | (interactive "b") |
333 | (save-excursion | |
334 | (set-buffer (or buffer (current-buffer))) | |
25c58854 | 335 | (setq buffer (current-buffer)) |
9b530428 | 336 | (let ((inhibit-read-only t) |
6836bb69 | 337 | (old-end (point-min)) (new-end (point-min))) |
25c58854 RS |
338 | ;; If we saved an old backtrace, find the common part |
339 | ;; between the new and the old. | |
340 | ;; Compare line by line, starting from the end, | |
341 | ;; because that's the part that is likely to be unchanged. | |
342 | (if debugger-previous-backtrace | |
343 | (let (old-start new-start (all-match t)) | |
344 | (goto-char (point-max)) | |
345 | (with-temp-buffer | |
346 | (insert debugger-previous-backtrace) | |
347 | (while (and all-match (not (bobp))) | |
348 | (setq old-end (point)) | |
349 | (forward-line -1) | |
350 | (setq old-start (point)) | |
351 | (with-current-buffer buffer | |
352 | (setq new-end (point)) | |
353 | (forward-line -1) | |
354 | (setq new-start (point))) | |
355 | (if (not (zerop | |
356 | (compare-buffer-substrings | |
357 | (current-buffer) old-start old-end | |
358 | buffer new-start new-end))) | |
359 | (setq all-match nil)))) | |
360 | ;; Now new-end is the position of the start of the | |
361 | ;; unchanged part in the current buffer, and old-end is | |
362 | ;; the position of that same text in the saved old | |
6836bb69 | 363 | ;; backtrace. But we must subtract (point-min) since strings are |
25c58854 RS |
364 | ;; indexed in origin 0. |
365 | ||
366 | ;; Replace the unchanged part of the backtrace | |
367 | ;; with the text from debugger-previous-backtrace, | |
368 | ;; since that already has the proper xrefs. | |
369 | ;; With this optimization, we only need to scan | |
370 | ;; the changed part of the backtrace. | |
371 | (delete-region new-end (point-max)) | |
372 | (goto-char (point-max)) | |
6836bb69 SM |
373 | (insert (substring debugger-previous-backtrace |
374 | (- old-end (point-min)))) | |
25c58854 RS |
375 | ;; Make the unchanged part of the backtrace inaccessible |
376 | ;; so it won't be scanned. | |
377 | (narrow-to-region (point-min) new-end))) | |
a1506d29 | 378 | |
25c58854 RS |
379 | ;; Scan the new part of the backtrace, inserting xrefs. |
380 | (goto-char (point-min)) | |
381 | (while (progn | |
dc64809a | 382 | (goto-char (+ (point) 2)) |
25c58854 RS |
383 | (skip-syntax-forward "^w_") |
384 | (not (eobp))) | |
385 | (let* ((beg (point)) | |
386 | (end (progn (skip-syntax-forward "w_") (point))) | |
387 | (sym (intern-soft (buffer-substring-no-properties | |
388 | beg end))) | |
654359e2 | 389 | (file (and sym (symbol-file sym 'defun)))) |
25c58854 RS |
390 | (when file |
391 | (goto-char beg) | |
392 | ;; help-xref-button needs to operate on something matched | |
393 | ;; by a regexp, so set that up for it. | |
dc64809a LK |
394 | (re-search-forward "\\(\\sw\\|\\s_\\)+") |
395 | (help-xref-button 0 'help-function-def sym file))) | |
f27b0335 | 396 | (forward-line 1)) |
25c58854 RS |
397 | (widen)) |
398 | (setq debugger-previous-backtrace (buffer-string)))) | |
63ca439e | 399 | \f |
0231f2dc JB |
400 | (defun debugger-step-through () |
401 | "Proceed, stepping through subexpressions of this expression. | |
402 | Enter another debugger on next entry to eval, apply or funcall." | |
403 | (interactive) | |
404 | (setq debugger-step-after-exit t) | |
9b54d453 | 405 | (setq debugger-jumping-flag t) |
9b530428 | 406 | (setq debugger-will-be-back t) |
9b54d453 | 407 | (add-hook 'post-command-hook 'debugger-reenable) |
0231f2dc JB |
408 | (message "Proceeding, will debug on next eval or call.") |
409 | (exit-recursive-edit)) | |
410 | ||
411 | (defun debugger-continue () | |
412 | "Continue, evaluating this expression without stopping." | |
413 | (interactive) | |
094e0928 GM |
414 | (unless debugger-may-continue |
415 | (error "Cannot continue")) | |
0231f2dc | 416 | (message "Continuing.") |
9b530428 SM |
417 | (save-excursion |
418 | ;; Check to see if we've flagged some frame for debug-on-exit, in which | |
419 | ;; case we'll probably come back to the debugger soon. | |
420 | (goto-char (point-min)) | |
421 | (if (re-search-forward "^\\* " nil t) | |
422 | (setq debugger-will-be-back t))) | |
0231f2dc JB |
423 | (exit-recursive-edit)) |
424 | ||
425 | (defun debugger-return-value (val) | |
426 | "Continue, specifying value to return. | |
427 | This is only useful when the value returned from the debugger | |
428 | will be used, such as in a debug on exit from a frame." | |
429 | (interactive "XReturn value (evaluated): ") | |
430 | (setq debugger-value val) | |
431 | (princ "Returning " t) | |
432 | (prin1 debugger-value) | |
9b530428 SM |
433 | (save-excursion |
434 | ;; Check to see if we've flagged some frame for debug-on-exit, in which | |
435 | ;; case we'll probably come back to the debugger soon. | |
436 | (goto-char (point-min)) | |
437 | (if (re-search-forward "^\\* " nil t) | |
438 | (setq debugger-will-be-back t))) | |
0231f2dc JB |
439 | (exit-recursive-edit)) |
440 | ||
441 | (defun debugger-jump () | |
442 | "Continue to exit from this frame, with all debug-on-entry suspended." | |
443 | (interactive) | |
27bde5f0 | 444 | (debugger-frame) |
b6b77a90 LK |
445 | (setq debugger-jumping-flag t) |
446 | (add-hook 'post-command-hook 'debugger-reenable) | |
0231f2dc | 447 | (message "Continuing through this frame") |
9b530428 | 448 | (setq debugger-will-be-back t) |
0231f2dc JB |
449 | (exit-recursive-edit)) |
450 | ||
451 | (defun debugger-reenable () | |
b6b77a90 LK |
452 | "Turn all debug-on-entry functions back on. |
453 | This function is put on `post-command-hook' by `debugger-jump' and | |
454 | removes itself from that hook." | |
455 | (setq debugger-jumping-flag nil) | |
456 | (remove-hook 'post-command-hook 'debugger-reenable)) | |
0231f2dc JB |
457 | |
458 | (defun debugger-frame-number () | |
459 | "Return number of frames in backtrace before the one point points at." | |
460 | (save-excursion | |
461 | (beginning-of-line) | |
462 | (let ((opoint (point)) | |
463 | (count 0)) | |
27bde5f0 RS |
464 | (while (not (eq (cadr (backtrace-frame count)) 'debug)) |
465 | (setq count (1+ count))) | |
449808f7 LK |
466 | ;; Skip implement-debug-on-entry frame. |
467 | (when (eq 'implement-debug-on-entry (cadr (backtrace-frame (1+ count)))) | |
439368ed | 468 | (setq count (1+ count))) |
0231f2dc | 469 | (goto-char (point-min)) |
439368ed LK |
470 | (when (looking-at "Debugger entered--\\(Lisp error\\|returning value\\):") |
471 | (goto-char (match-end 0)) | |
472 | (forward-sexp 1)) | |
0231f2dc JB |
473 | (forward-line 1) |
474 | (while (progn | |
475 | (forward-char 2) | |
476 | (if (= (following-char) ?\() | |
477 | (forward-sexp 1) | |
478 | (forward-sexp 2)) | |
479 | (forward-line 1) | |
480 | (<= (point) opoint)) | |
65fe45f2 RS |
481 | (if (looking-at " *;;;") |
482 | (forward-line 1)) | |
0231f2dc JB |
483 | (setq count (1+ count))) |
484 | count))) | |
485 | ||
0231f2dc JB |
486 | (defun debugger-frame () |
487 | "Request entry to debugger when this frame exits. | |
488 | Applies to the frame whose line point is on in the backtrace." | |
489 | (interactive) | |
fa5b1b57 RS |
490 | (save-excursion |
491 | (beginning-of-line) | |
492 | (if (looking-at " *;;;\\|[a-z]") | |
493 | (error "This line is not a function call"))) | |
0231f2dc | 494 | (beginning-of-line) |
27bde5f0 | 495 | (backtrace-debug (debugger-frame-number) t) |
0231f2dc | 496 | (if (= (following-char) ? ) |
9b530428 | 497 | (let ((inhibit-read-only t)) |
0231f2dc JB |
498 | (delete-char 1) |
499 | (insert ?*))) | |
500 | (beginning-of-line)) | |
501 | ||
502 | (defun debugger-frame-clear () | |
c519f68f | 503 | "Do not enter debugger when this frame exits. |
0231f2dc JB |
504 | Applies to the frame whose line point is on in the backtrace." |
505 | (interactive) | |
fa5b1b57 RS |
506 | (save-excursion |
507 | (beginning-of-line) | |
508 | (if (looking-at " *;;;\\|[a-z]") | |
509 | (error "This line is not a function call"))) | |
0231f2dc | 510 | (beginning-of-line) |
27bde5f0 | 511 | (backtrace-debug (debugger-frame-number) nil) |
0231f2dc | 512 | (if (= (following-char) ?*) |
9b530428 | 513 | (let ((inhibit-read-only t)) |
0231f2dc JB |
514 | (delete-char 1) |
515 | (insert ? ))) | |
516 | (beginning-of-line)) | |
517 | ||
8c1cd093 KH |
518 | (put 'debugger-env-macro 'lisp-indent-function 0) |
519 | (defmacro debugger-env-macro (&rest body) | |
520 | "Run BODY in original environment." | |
6c2599ed SS |
521 | `(save-excursion |
522 | (if (null (buffer-name debugger-old-buffer)) | |
523 | ;; old buffer deleted | |
524 | (setq debugger-old-buffer (current-buffer))) | |
525 | (set-buffer debugger-old-buffer) | |
526 | (let ((load-read-function debugger-outer-load-read-function) | |
527 | (overriding-terminal-local-map | |
528 | debugger-outer-overriding-terminal-local-map) | |
529 | (overriding-local-map debugger-outer-overriding-local-map) | |
530 | (track-mouse debugger-outer-track-mouse) | |
531 | (last-command debugger-outer-last-command) | |
532 | (this-command debugger-outer-this-command) | |
6c2599ed SS |
533 | (unread-command-events debugger-outer-unread-command-events) |
534 | (unread-post-input-method-events | |
535 | debugger-outer-unread-post-input-method-events) | |
536 | (last-input-event debugger-outer-last-input-event) | |
537 | (last-command-event debugger-outer-last-command-event) | |
538 | (last-nonmenu-event debugger-outer-last-nonmenu-event) | |
539 | (last-event-frame debugger-outer-last-event-frame) | |
540 | (standard-input debugger-outer-standard-input) | |
541 | (standard-output debugger-outer-standard-output) | |
542 | (inhibit-redisplay debugger-outer-inhibit-redisplay) | |
543 | (cursor-in-echo-area debugger-outer-cursor-in-echo-area)) | |
544 | (set-match-data debugger-outer-match-data) | |
12cf32ce RS |
545 | (prog1 |
546 | (let ((save-ucc (with-no-warnings unread-command-char))) | |
547 | (unwind-protect | |
548 | (progn | |
549 | (with-no-warnings | |
c4fbcb01 | 550 | (setq unread-command-char debugger-outer-unread-command-char)) |
12cf32ce RS |
551 | (prog1 (progn ,@body) |
552 | (with-no-warnings | |
c4fbcb01 | 553 | (setq debugger-outer-unread-command-char unread-command-char)))) |
12cf32ce | 554 | (with-no-warnings |
c4fbcb01 | 555 | (setq unread-command-char save-ucc)))) |
6c2599ed SS |
556 | (setq debugger-outer-match-data (match-data)) |
557 | (setq debugger-outer-load-read-function load-read-function) | |
558 | (setq debugger-outer-overriding-terminal-local-map | |
559 | overriding-terminal-local-map) | |
560 | (setq debugger-outer-overriding-local-map overriding-local-map) | |
561 | (setq debugger-outer-track-mouse track-mouse) | |
562 | (setq debugger-outer-last-command last-command) | |
563 | (setq debugger-outer-this-command this-command) | |
6c2599ed SS |
564 | (setq debugger-outer-unread-command-events unread-command-events) |
565 | (setq debugger-outer-unread-post-input-method-events | |
566 | unread-post-input-method-events) | |
567 | (setq debugger-outer-last-input-event last-input-event) | |
568 | (setq debugger-outer-last-command-event last-command-event) | |
569 | (setq debugger-outer-last-nonmenu-event last-nonmenu-event) | |
570 | (setq debugger-outer-last-event-frame last-event-frame) | |
571 | (setq debugger-outer-standard-input standard-input) | |
572 | (setq debugger-outer-standard-output standard-output) | |
573 | (setq debugger-outer-inhibit-redisplay inhibit-redisplay) | |
574 | (setq debugger-outer-cursor-in-echo-area cursor-in-echo-area) | |
575 | )))) | |
8c1cd093 | 576 | |
0231f2dc | 577 | (defun debugger-eval-expression (exp) |
8782c06b RS |
578 | "Eval an expression, in an environment like that outside the debugger." |
579 | (interactive | |
580 | (list (read-from-minibuffer "Eval: " | |
581 | nil read-expression-map t | |
582 | 'read-expression-history))) | |
8c1cd093 | 583 | (debugger-env-macro (eval-expression exp))) |
0231f2dc | 584 | \f |
78d54dee SM |
585 | (defvar debugger-mode-map |
586 | (let ((map (make-keymap))) | |
587 | (set-keymap-parent map button-buffer-map) | |
588 | (suppress-keymap map) | |
589 | (define-key map "-" 'negative-argument) | |
590 | (define-key map "b" 'debugger-frame) | |
591 | (define-key map "c" 'debugger-continue) | |
592 | (define-key map "j" 'debugger-jump) | |
593 | (define-key map "r" 'debugger-return-value) | |
594 | (define-key map "u" 'debugger-frame-clear) | |
595 | (define-key map "d" 'debugger-step-through) | |
596 | (define-key map "l" 'debugger-list-functions) | |
597 | (define-key map "h" 'describe-mode) | |
598 | (define-key map "q" 'top-level) | |
599 | (define-key map "e" 'debugger-eval-expression) | |
600 | (define-key map " " 'next-line) | |
601 | (define-key map "R" 'debugger-record-expression) | |
245f0222 | 602 | (define-key map "\C-m" 'debug-help-follow) |
78d54dee SM |
603 | (define-key map [mouse-2] 'push-button) |
604 | map)) | |
028d38a2 RS |
605 | |
606 | (put 'debugger-mode 'mode-class 'special) | |
607 | ||
608 | (defun debugger-mode () | |
609 | "Mode for backtrace buffers, selected in debugger. | |
610 | \\<debugger-mode-map> | |
611 | A line starts with `*' if exiting that frame will call the debugger. | |
612 | Type \\[debugger-frame] or \\[debugger-frame-clear] to set or remove the `*'. | |
613 | ||
614 | When in debugger due to frame being exited, | |
615 | use the \\[debugger-return-value] command to override the value | |
616 | being returned from that frame. | |
617 | ||
618 | Use \\[debug-on-entry] and \\[cancel-debug-on-entry] to control | |
619 | which functions will enter the debugger when called. | |
620 | ||
621 | Complete list of commands: | |
622 | \\{debugger-mode-map}" | |
623 | (kill-all-local-variables) | |
624 | (setq major-mode 'debugger-mode) | |
625 | (setq mode-name "Debugger") | |
626 | (setq truncate-lines t) | |
627 | (set-syntax-table emacs-lisp-mode-syntax-table) | |
628 | (use-local-map debugger-mode-map) | |
629 | (run-mode-hooks 'debugger-mode-hook)) | |
245f0222 | 630 | \f |
666b9413 SE |
631 | (defcustom debugger-record-buffer "*Debugger-record*" |
632 | "*Buffer name for expression values, for \\[debugger-record-expression]." | |
633 | :type 'string | |
cd32a7ba DN |
634 | :group 'debugger |
635 | :version "20.3") | |
8c1cd093 KH |
636 | |
637 | (defun debugger-record-expression (exp) | |
638 | "Display a variable's value and record it in `*Backtrace-record*' buffer." | |
639 | (interactive | |
640 | (list (read-from-minibuffer | |
641 | "Record Eval: " | |
642 | nil | |
643 | read-expression-map t | |
644 | 'read-expression-history))) | |
645 | (let* ((buffer (get-buffer-create debugger-record-buffer)) | |
646 | (standard-output buffer)) | |
647 | (princ (format "Debugger Eval (%s): " exp)) | |
648 | (princ (debugger-eval-expression exp)) | |
649 | (terpri)) | |
650 | ||
651 | (with-current-buffer (get-buffer debugger-record-buffer) | |
8e71c318 | 652 | (message "%s" |
be940bc5 SM |
653 | (buffer-substring (line-beginning-position 0) |
654 | (line-end-position 0))))) | |
0231f2dc | 655 | |
245f0222 RS |
656 | (defun debug-help-follow (&optional pos) |
657 | "Follow cross-reference at POS, defaulting to point. | |
658 | ||
659 | For the cross-reference format, see `help-make-xrefs'." | |
660 | (interactive "d") | |
661 | (require 'help-mode) | |
662 | (unless pos | |
663 | (setq pos (point))) | |
664 | (unless (push-button pos) | |
665 | ;; check if the symbol under point is a function or variable | |
666 | (let ((sym | |
667 | (intern | |
668 | (save-excursion | |
669 | (goto-char pos) (skip-syntax-backward "w_") | |
670 | (buffer-substring (point) | |
671 | (progn (skip-syntax-forward "w_") | |
672 | (point))))))) | |
673 | (when (or (boundp sym) (fboundp sym) (facep sym)) | |
674 | (switch-to-buffer-other-window (generate-new-buffer "*Help*")) | |
675 | (help-do-xref pos #'help-xref-interned (list sym)))))) | |
0231f2dc | 676 | \f |
449808f7 LK |
677 | ;; When you change this, you may also need to change the number of |
678 | ;; frames that the debugger skips. | |
679 | (defun implement-debug-on-entry () | |
680 | "Conditionally call the debugger. | |
681 | A call to this function is inserted by `debug-on-entry' to cause | |
682 | functions to break on entry." | |
683 | (if (or inhibit-debug-on-entry debugger-jumping-flag) | |
684 | nil | |
685 | (funcall debugger 'debug))) | |
686 | ||
ce5ce46d LK |
687 | (defun debugger-special-form-p (symbol) |
688 | "Return whether SYMBOL is a special form." | |
689 | (and (fboundp symbol) | |
690 | (subrp (symbol-function symbol)) | |
691 | (eq (cdr (subr-arity (symbol-function symbol))) 'unevalled))) | |
692 | ||
0231f2dc JB |
693 | ;;;###autoload |
694 | (defun debug-on-entry (function) | |
695 | "Request FUNCTION to invoke debugger each time it is called. | |
8ac3941d | 696 | |
8e71c318 | 697 | When called interactively, prompt for FUNCTION in the minibuffer. |
8ac3941d LK |
698 | |
699 | This works by modifying the definition of FUNCTION. If you tell the | |
700 | debugger to continue, FUNCTION's execution proceeds. If FUNCTION is a | |
701 | normal function or a macro written in Lisp, you can also step through | |
702 | its execution. FUNCTION can also be a primitive that is not a special | |
703 | form, in which case stepping is not possible. Break-on-entry for | |
704 | primitive functions only works when that function is called from Lisp. | |
705 | ||
0231f2dc | 706 | Use \\[cancel-debug-on-entry] to cancel the effect of this command. |
2512acba | 707 | Redefining FUNCTION also cancels it." |
ce5ce46d LK |
708 | (interactive |
709 | (let ((fn (function-called-at-point)) val) | |
710 | (when (debugger-special-form-p fn) | |
711 | (setq fn nil)) | |
3731a850 | 712 | (setq val (completing-read |
ce5ce46d LK |
713 | (if fn |
714 | (format "Debug on entry to function (default %s): " fn) | |
715 | "Debug on entry to function: ") | |
716 | obarray | |
717 | #'(lambda (symbol) | |
718 | (and (fboundp symbol) | |
719 | (not (debugger-special-form-p symbol)))) | |
720 | t nil nil (symbol-name fn))) | |
721 | (list (if (equal val "") fn (intern val))))) | |
722 | (when (debugger-special-form-p function) | |
d7029908 | 723 | (error "Function %s is a special form" function)) |
8e71c318 | 724 | (if (or (symbolp (symbol-function function)) |
7473b6ad | 725 | (subrp (symbol-function function))) |
d7029908 LK |
726 | ;; The function is built-in or aliased to another function. |
727 | ;; Create a wrapper in which we can add the debug call. | |
f9e899b6 | 728 | (fset function `(lambda (&rest debug-on-entry-args) |
7473b6ad | 729 | ,(interactive-form (symbol-function function)) |
8e71c318 | 730 | (apply ',(symbol-function function) |
d7029908 LK |
731 | debug-on-entry-args))) |
732 | (when (eq (car-safe (symbol-function function)) 'autoload) | |
733 | ;; The function is autoloaded. Load its real definition. | |
734 | (load (cadr (symbol-function function)) nil noninteractive nil t)) | |
735 | (when (or (not (consp (symbol-function function))) | |
736 | (and (eq (car (symbol-function function)) 'macro) | |
737 | (not (consp (cdr (symbol-function function)))))) | |
738 | ;; The function is byte-compiled. Create a wrapper in which | |
739 | ;; we can add the debug call. | |
740 | (debug-convert-byte-code function))) | |
741 | (unless (consp (symbol-function function)) | |
742 | (error "Definition of %s is not a list" function)) | |
449808f7 | 743 | (fset function (debug-on-entry-1 function t)) |
d7029908 LK |
744 | (unless (memq function debug-function-list) |
745 | (push function debug-function-list)) | |
0231f2dc JB |
746 | function) |
747 | ||
748 | ;;;###autoload | |
749 | (defun cancel-debug-on-entry (&optional function) | |
750 | "Undo effect of \\[debug-on-entry] on FUNCTION. | |
dd72a03a | 751 | If FUNCTION is nil, cancel debug-on-entry for all functions. |
8e71c318 LT |
752 | When called interactively, prompt for FUNCTION in the minibuffer. |
753 | To specify a nil argument interactively, exit with an empty minibuffer." | |
10a4c11f JB |
754 | (interactive |
755 | (list (let ((name | |
922a9de3 | 756 | (completing-read |
5b76833f | 757 | "Cancel debug on entry to function (default all functions): " |
922a9de3 | 758 | (mapcar 'symbol-name debug-function-list) nil t))) |
dd72a03a LK |
759 | (when name |
760 | (unless (string= name "") | |
761 | (intern name)))))) | |
762 | (if (and function | |
763 | (not (string= function ""))) ; Pre 22.1 compatibility test. | |
0231f2dc | 764 | (progn |
d7029908 | 765 | (let ((defn (debug-on-entry-1 function nil))) |
7473b6ad | 766 | (condition-case nil |
d7029908 LK |
767 | (when (and (equal (nth 1 defn) '(&rest debug-on-entry-args)) |
768 | (eq (car (nth 3 defn)) 'apply)) | |
769 | ;; `defn' is a wrapper introduced in debug-on-entry. | |
770 | ;; Get rid of it since we don't need it any more. | |
771 | (setq defn (nth 1 (nth 1 (nth 3 defn))))) | |
7473b6ad | 772 | (error nil)) |
d7029908 | 773 | (fset function defn)) |
0231f2dc JB |
774 | (setq debug-function-list (delq function debug-function-list)) |
775 | function) | |
776 | (message "Cancelling debug-on-entry for all functions") | |
777 | (mapcar 'cancel-debug-on-entry debug-function-list))) | |
778 | ||
779 | (defun debug-convert-byte-code (function) | |
d7029908 LK |
780 | (let* ((defn (symbol-function function)) |
781 | (macro (eq (car-safe defn) 'macro))) | |
782 | (when macro (setq defn (cdr defn))) | |
783 | (unless (consp defn) | |
784 | ;; Assume a compiled code object. | |
785 | (let* ((contents (append defn nil)) | |
786 | (body | |
787 | (list (list 'byte-code (nth 1 contents) | |
788 | (nth 2 contents) (nth 3 contents))))) | |
789 | (if (nthcdr 5 contents) | |
790 | (setq body (cons (list 'interactive (nth 5 contents)) body))) | |
791 | (if (nth 4 contents) | |
792 | ;; Use `documentation' here, to get the actual string, | |
793 | ;; in case the compiled function has a reference | |
794 | ;; to the .elc file. | |
795 | (setq body (cons (documentation function) body))) | |
796 | (setq defn (cons 'lambda (cons (car contents) body)))) | |
797 | (when macro (setq defn (cons 'macro defn))) | |
798 | (fset function defn)))) | |
0231f2dc | 799 | |
449808f7 LK |
800 | (defun debug-on-entry-1 (function flag) |
801 | (let* ((defn (symbol-function function)) | |
802 | (tail defn)) | |
8e71c318 | 803 | (when (eq (car-safe tail) 'macro) |
d7029908 LK |
804 | (setq tail (cdr tail))) |
805 | (if (not (eq (car-safe tail) 'lambda)) | |
806 | ;; Only signal an error when we try to set debug-on-entry. | |
807 | ;; When we try to clear debug-on-entry, we are now done. | |
808 | (when flag | |
809 | (error "%s is not a user-defined Lisp function" function)) | |
810 | (setq tail (cdr tail)) | |
a29cf450 SM |
811 | ;; Skip the docstring. |
812 | (when (and (stringp (cadr tail)) (cddr tail)) | |
813 | (setq tail (cdr tail))) | |
814 | ;; Skip the interactive form. | |
815 | (when (eq 'interactive (car-safe (cadr tail))) | |
816 | (setq tail (cdr tail))) | |
449808f7 | 817 | (unless (eq flag (equal (cadr tail) '(implement-debug-on-entry))) |
a29cf450 SM |
818 | ;; Add/remove debug statement as needed. |
819 | (if flag | |
449808f7 | 820 | (setcdr tail (cons '(implement-debug-on-entry) (cdr tail))) |
d7029908 LK |
821 | (setcdr tail (cddr tail))))) |
822 | defn)) | |
0231f2dc JB |
823 | |
824 | (defun debugger-list-functions () | |
825 | "Display a list of all the functions now set to debug on entry." | |
826 | (interactive) | |
78d54dee SM |
827 | (require 'help-mode) |
828 | (help-setup-xref '(debugger-list-functions) (interactive-p)) | |
829 | (with-output-to-temp-buffer (help-buffer) | |
830 | (with-current-buffer standard-output | |
831 | (if (null debug-function-list) | |
832 | (princ "No debug-on-entry functions now\n") | |
833 | (princ "Functions set to debug on entry:\n\n") | |
834 | (dolist (fun debug-function-list) | |
835 | (make-text-button (point) (progn (prin1 fun) (point)) | |
836 | 'type 'help-function | |
837 | 'help-args (list fun)) | |
838 | (terpri)) | |
839 | (terpri) | |
840 | (princ "Note: if you have redefined a function, then it may no longer\n") | |
841 | (princ "be set to debug on entry, even if it is in the list."))))) | |
c0274f38 | 842 | |
896546cd RS |
843 | (provide 'debug) |
844 | ||
78d54dee | 845 | ;; arch-tag: b6ec7047-f801-4103-9c63-d69322db9d3b |
c0274f38 | 846 | ;;; debug.el ends here |