Commit | Line | Data |
---|---|---|
f7359658 | 1 | ;;; edebug.el --- a source-level debugger for Emacs Lisp |
84fc2cfa | 2 | |
6b61353c | 3 | ;; Copyright (C) 1988,89,90,91,92,93,94,95,97,1999,2000,01,03,2004 |
c86b5c78 | 4 | ;; Free Software Foundation, Inc. |
84fc2cfa | 5 | |
f367dfc1 | 6 | ;; Author: Daniel LaLiberte <liberte@holonexus.org> |
c86b5c78 | 7 | ;; Maintainer: FSF |
e9571d2a | 8 | ;; Keywords: lisp, tools, maint |
3a801d0c | 9 | |
84fc2cfa ER |
10 | ;; This file is part of GNU Emacs. |
11 | ||
1fe3d507 DL |
12 | ;; GNU Emacs is free software; you can redistribute it and/or modify |
13 | ;; it under the terms of the GNU General Public License as published by | |
14 | ;; the Free Software Foundation; either version 2, or (at your option) | |
15 | ;; any later version. | |
16 | ||
84fc2cfa | 17 | ;; GNU Emacs is distributed in the hope that it will be useful, |
1fe3d507 DL |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
f7359658 RS |
23 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
24 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
25 | ;; Boston, MA 02111-1307, USA. | |
26 | ||
27 | ;;; Commentary: | |
28 | ||
29 | ;; This minor mode allows programmers to step through Emacs Lisp | |
30 | ;; source code while executing functions. You can also set | |
31 | ;; breakpoints, trace (stopping at each expression), evaluate | |
32 | ;; expressions as if outside Edebug, reevaluate and display a list of | |
33 | ;; expressions, trap errors normally caught by debug, and display a | |
34 | ;; debug style backtrace. | |
35 | ||
f7359658 RS |
36 | ;;; Minimal Instructions |
37 | ;; ===================== | |
38 | ||
6392137f | 39 | ;; First evaluate a defun with C-M-x, then run the function. Step |
f7359658 RS |
40 | ;; through the code with SPC, mark breakpoints with b, go until a |
41 | ;; breakpoint is reached with g, and quit execution with q. Use the | |
a1506d29 | 42 | ;; "?" command in edebug to describe other commands. |
c86b5c78 | 43 | ;; See the Emacs Lisp Reference Manual for more details. |
6392137f KH |
44 | |
45 | ;; If you wish to change the default edebug global command prefix, change: | |
46 | ;; (setq edebug-global-prefix "\C-xX") | |
f7359658 | 47 | |
c86b5c78 RS |
48 | ;; Edebug was written by |
49 | ;; Daniel LaLiberte | |
6392137f KH |
50 | ;; GTE Labs |
51 | ;; 40 Sylvan Rd | |
52 | ;; Waltham, MA 02254 | |
f367dfc1 | 53 | ;; liberte@holonexus.org |
f7359658 RS |
54 | |
55 | ;;; Code: | |
1fe3d507 | 56 | |
f7359658 | 57 | ;;; Bug reporting |
84fc2cfa | 58 | |
6db746da | 59 | (defalias 'edebug-submit-bug-report 'report-emacs-bug) |
1fe3d507 | 60 | |
f7359658 | 61 | ;;; Options |
1fe3d507 | 62 | |
c5292bc8 RS |
63 | (defgroup edebug nil |
64 | "A source-level debugger for Emacs Lisp" | |
65 | :group 'lisp) | |
66 | ||
67 | ||
68 | (defcustom edebug-setup-hook nil | |
1fe3d507 | 69 | "*Functions to call before edebug is used. |
a50d4326 DL |
70 | Each time it is set to a new value, Edebug will call those functions |
71 | once and then `edebug-setup-hook' is reset to nil. You could use this | |
72 | to load up Edebug specifications associated with a package you are | |
c5292bc8 RS |
73 | using but only when you also use Edebug." |
74 | :type 'hook | |
75 | :group 'edebug) | |
1fe3d507 | 76 | |
36f8d564 RS |
77 | ;; edebug-all-defs and edebug-all-forms need to be autoloaded |
78 | ;; because the byte compiler binds them; as a result, if edebug | |
79 | ;; is first loaded for a require in a compilation, they will be left unbound. | |
80 | ||
81 | ;;;###autoload | |
c5292bc8 | 82 | (defcustom edebug-all-defs nil |
a50d4326 DL |
83 | "*If non-nil, evaluation of any defining forms will instrument for Edebug. |
84 | This applies to `eval-defun', `eval-region', `eval-buffer', and | |
85 | `eval-current-buffer'. `eval-region' is also called by | |
1fe3d507 DL |
86 | `eval-last-sexp', and `eval-print-last-sexp'. |
87 | ||
88 | You can use the command `edebug-all-defs' to toggle the value of this | |
a50d4326 | 89 | variable. You may wish to make it local to each buffer with |
f7359658 | 90 | \(make-local-variable 'edebug-all-defs) in your |
c5292bc8 RS |
91 | `emacs-lisp-mode-hook'." |
92 | :type 'boolean | |
93 | :group 'edebug) | |
1fe3d507 | 94 | |
36f8d564 RS |
95 | ;; edebug-all-defs and edebug-all-forms need to be autoloaded |
96 | ;; because the byte compiler binds them; as a result, if edebug | |
97 | ;; is first loaded for a require in a compilation, they will be left unbound. | |
98 | ||
99 | ;;;###autoload | |
c5292bc8 | 100 | (defcustom edebug-all-forms nil |
a50d4326 | 101 | "*Non-nil evaluation of all forms will instrument for Edebug. |
1fe3d507 | 102 | This doesn't apply to loading or evaluations in the minibuffer. |
c5292bc8 RS |
103 | Use the command `edebug-all-forms' to toggle the value of this option." |
104 | :type 'boolean | |
105 | :group 'edebug) | |
84fc2cfa | 106 | |
c5292bc8 | 107 | (defcustom edebug-eval-macro-args nil |
a1506d29 | 108 | "*Non-nil means all macro call arguments may be evaluated. |
f7359658 | 109 | If this variable is nil, the default, Edebug will *not* wrap |
a1506d29 | 110 | macro call arguments as if they will be evaluated. |
f7359658 | 111 | For each macro, a `edebug-form-spec' overrides this option. |
1fe3d507 | 112 | So to specify exceptions for macros that have some arguments evaluated |
c86b5c78 | 113 | and some not, you should specify an `edebug-form-spec'." |
c5292bc8 RS |
114 | :type 'boolean |
115 | :group 'edebug) | |
84fc2cfa | 116 | |
c5292bc8 | 117 | (defcustom edebug-save-windows t |
a50d4326 DL |
118 | "*If non-nil, Edebug saves and restores the window configuration. |
119 | That takes some time, so if your program does not care what happens to | |
120 | the window configurations, it is better to set this variable to nil. | |
1fe3d507 DL |
121 | |
122 | If the value is a list, only the listed windows are saved and | |
a1506d29 | 123 | restored. |
84fc2cfa | 124 | |
c5292bc8 RS |
125 | `edebug-toggle-save-windows' may be used to change this variable." |
126 | :type '(choice boolean (repeat string)) | |
127 | :group 'edebug) | |
84fc2cfa | 128 | |
c5292bc8 | 129 | (defcustom edebug-save-displayed-buffer-points nil |
a50d4326 | 130 | "*If non-nil, save and restore point in all displayed buffers. |
84fc2cfa | 131 | |
a50d4326 DL |
132 | Saving and restoring point in other buffers is necessary if you are |
133 | debugging code that changes the point of a buffer which is displayed | |
134 | in a non-selected window. If Edebug or the user then selects the | |
84fc2cfa ER |
135 | window, the buffer's point will be changed to the window's point. |
136 | ||
a50d4326 DL |
137 | Saving and restoring point in all buffers is expensive, since it |
138 | requires selecting each window twice, so enable this only if you need | |
c5292bc8 RS |
139 | it." |
140 | :type 'boolean | |
141 | :group 'edebug) | |
84fc2cfa | 142 | |
c5292bc8 | 143 | (defcustom edebug-initial-mode 'step |
a50d4326 DL |
144 | "*Initial execution mode for Edebug, if non-nil. If this variable |
145 | is non-@code{nil}, it specifies the initial execution mode for Edebug | |
146 | when it is first activated. Possible values are step, next, go, | |
c5292bc8 RS |
147 | Go-nonstop, trace, Trace-fast, continue, and Continue-fast." |
148 | :type '(choice (const step) (const next) (const go) | |
149 | (const Go-nonstop) (const trace) | |
150 | (const Trace-fast) (const continue) | |
7ff1b00e | 151 | (const Continue-fast)) |
c5292bc8 RS |
152 | :group 'edebug) |
153 | ||
154 | (defcustom edebug-trace nil | |
a50d4326 DL |
155 | "*Non-nil means display a trace of function entry and exit. |
156 | Tracing output is displayed in a buffer named `*edebug-trace*', one | |
a1506d29 | 157 | function entry or exit per line, indented by the recursion level. |
a50d4326 DL |
158 | |
159 | You can customize by replacing functions `edebug-print-trace-before' | |
c5292bc8 RS |
160 | and `edebug-print-trace-after'." |
161 | :type 'boolean | |
162 | :group 'edebug) | |
84fc2cfa | 163 | |
c5292bc8 | 164 | (defcustom edebug-test-coverage nil |
1fe3d507 DL |
165 | "*If non-nil, Edebug tests coverage of all expressions debugged. |
166 | This is done by comparing the result of each expression | |
167 | with the previous result. Coverage is considered OK if two different | |
a50d4326 | 168 | results are found. |
84fc2cfa | 169 | |
1fe3d507 | 170 | Use `edebug-display-freq-count' to display the frequency count and |
c5292bc8 RS |
171 | coverage information for a definition." |
172 | :type 'boolean | |
173 | :group 'edebug) | |
1fe3d507 | 174 | |
c5292bc8 | 175 | (defcustom edebug-continue-kbd-macro nil |
a50d4326 | 176 | "*If non-nil, continue defining or executing any keyboard macro. |
c5292bc8 RS |
177 | Use this with caution since it is not debugged." |
178 | :type 'boolean | |
179 | :group 'edebug) | |
180 | ||
181 | ||
182 | (defcustom edebug-print-length 50 | |
183 | "*Default value of `print-length' to use while printing results in Edebug." | |
184 | :type 'integer | |
185 | :group 'edebug) | |
186 | (defcustom edebug-print-level 50 | |
187 | "*Default value of `print-level' to use while printing results in Edebug." | |
188 | :type 'integer | |
189 | :group 'edebug) | |
190 | (defcustom edebug-print-circle t | |
191 | "*Default value of `print-circle' to use while printing results in Edebug." | |
192 | :type 'boolean | |
193 | :group 'edebug) | |
194 | ||
195 | (defcustom edebug-unwrap-results nil | |
1fe3d507 DL |
196 | "*Non-nil if Edebug should unwrap results of expressions. |
197 | This is useful when debugging macros where the results of expressions | |
198 | are instrumented expressions. But don't do this when results might be | |
c5292bc8 RS |
199 | circular or an infinite loop will result." |
200 | :type 'boolean | |
201 | :group 'edebug) | |
1fe3d507 | 202 | |
c5292bc8 | 203 | (defcustom edebug-on-error t |
1fe3d507 DL |
204 | "*Value bound to `debug-on-error' while Edebug is active. |
205 | ||
206 | If `debug-on-error' is non-nil, that value is still used. | |
207 | ||
208 | If the value is a list of signal names, Edebug will stop when any of | |
209 | these errors are signaled from Lisp code whether or not the signal is | |
210 | handled by a `condition-case'. This option is useful for debugging | |
211 | signals that *are* handled since they would otherwise be missed. | |
c5292bc8 | 212 | After execution is resumed, the error is signaled again." |
7ff1b00e AS |
213 | :type '(choice (const :tag "off") |
214 | (repeat :menu-tag "When" | |
215 | :value (nil) | |
216 | (symbol :format "%v")) | |
217 | (const :tag "always" t)) | |
c5292bc8 | 218 | :group 'edebug) |
1fe3d507 | 219 | |
c5292bc8 RS |
220 | (defcustom edebug-on-quit t |
221 | "*Value bound to `debug-on-quit' while Edebug is active." | |
222 | :type 'boolean | |
223 | :group 'edebug) | |
1fe3d507 | 224 | |
c5292bc8 | 225 | (defcustom edebug-global-break-condition nil |
a50d4326 | 226 | "*If non-nil, an expression to test for at every stop point. |
c5292bc8 RS |
227 | If the result is non-nil, then break. Errors are ignored." |
228 | :type 'sexp | |
229 | :group 'edebug) | |
a50d4326 | 230 | |
5492ef3c RS |
231 | (defcustom edebug-sit-for-seconds 1 |
232 | "*Number of seconds to pause when execution mode is `trace'." | |
233 | :type 'number | |
234 | :group 'edebug) | |
235 | ||
f7359658 | 236 | ;;; Form spec utilities. |
1fe3d507 DL |
237 | |
238 | ;;;###autoload | |
239 | (defmacro def-edebug-spec (symbol spec) | |
210bd5c9 | 240 | "Set the `edebug-form-spec' property of SYMBOL according to SPEC. |
1fe3d507 | 241 | Both SYMBOL and SPEC are unevaluated. The SPEC can be 0, t, a symbol |
f7359658 | 242 | \(naming a function), or a list." |
d8f1319a | 243 | `(put (quote ,symbol) 'edebug-form-spec (quote ,spec))) |
1fe3d507 DL |
244 | |
245 | (defmacro def-edebug-form-spec (symbol spec-form) | |
f7359658 | 246 | "For compatibility with old version. Use `def-edebug-spec' instead." |
1fe3d507 DL |
247 | (message "Obsolete: use def-edebug-spec instead.") |
248 | (def-edebug-spec symbol (eval spec-form))) | |
249 | ||
250 | (defun get-edebug-spec (symbol) | |
251 | ;; Get the spec of symbol resolving all indirection. | |
252 | (let ((edebug-form-spec (get symbol 'edebug-form-spec)) | |
253 | indirect) | |
254 | (while (and (symbolp edebug-form-spec) | |
255 | (setq indirect (get edebug-form-spec 'edebug-form-spec))) | |
256 | ;; (edebug-trace "indirection: %s" edebug-form-spec) | |
257 | (setq edebug-form-spec indirect)) | |
258 | edebug-form-spec | |
259 | )) | |
260 | ||
f7359658 | 261 | ;;; Utilities |
1fe3d507 | 262 | |
f7359658 RS |
263 | ;; Define edebug-gensym - from old cl.el |
264 | (defvar edebug-gensym-index 0 | |
265 | "Integer used by `edebug-gensym' to produce new names.") | |
1fe3d507 | 266 | |
f7359658 | 267 | (defun edebug-gensym (&optional prefix) |
1fe3d507 DL |
268 | "Generate a fresh uninterned symbol. |
269 | There is an optional argument, PREFIX. PREFIX is the | |
270 | string that begins the new name. Most people take just the default, | |
271 | except when debugging needs suggest otherwise." | |
272 | (if (null prefix) | |
273 | (setq prefix "G")) | |
274 | (let ((newsymbol nil) | |
275 | (newname "")) | |
276 | (while (not newsymbol) | |
f7359658 RS |
277 | (setq newname (concat prefix (int-to-string edebug-gensym-index))) |
278 | (setq edebug-gensym-index (+ edebug-gensym-index 1)) | |
1fe3d507 DL |
279 | (if (not (intern-soft newname)) |
280 | (setq newsymbol (make-symbol newname)))) | |
281 | newsymbol)) | |
1fe3d507 | 282 | |
f7359658 | 283 | (defun edebug-lambda-list-keywordp (object) |
1fe3d507 | 284 | "Return t if OBJECT is a lambda list keyword. |
f7359658 | 285 | A lambda list keyword is a symbol that starts with `&'." |
1fe3d507 DL |
286 | (and (symbolp object) |
287 | (= ?& (aref (symbol-name object) 0)))) | |
84fc2cfa | 288 | |
84fc2cfa ER |
289 | |
290 | (defun edebug-last-sexp () | |
1fe3d507 | 291 | ;; Return the last sexp before point in current buffer. |
f7359658 | 292 | ;; Assumes Emacs Lisp syntax is active. |
84fc2cfa ER |
293 | (car |
294 | (read-from-string | |
295 | (buffer-substring | |
296 | (save-excursion | |
297 | (forward-sexp -1) | |
298 | (point)) | |
299 | (point))))) | |
300 | ||
301 | (defun edebug-window-list () | |
f7359658 RS |
302 | "Return a list of windows, in order of `next-window'." |
303 | ;; This doesn't work for epoch. | |
e940c6da | 304 | (let (window-list) |
d778509c | 305 | (walk-windows (lambda (w) (push w window-list))) |
84fc2cfa ER |
306 | (nreverse window-list))) |
307 | ||
1fe3d507 DL |
308 | ;; Not used. |
309 | '(defun edebug-two-window-p () | |
84fc2cfa ER |
310 | "Return t if there are two windows." |
311 | (and (not (one-window-p)) | |
312 | (eq (selected-window) | |
313 | (next-window (next-window (selected-window)))))) | |
314 | ||
1fe3d507 | 315 | (defsubst edebug-lookup-function (object) |
84fc2cfa ER |
316 | (while (and (symbolp object) (fboundp object)) |
317 | (setq object (symbol-function object))) | |
1fe3d507 | 318 | object) |
a1506d29 | 319 | |
1fe3d507 DL |
320 | (defun edebug-macrop (object) |
321 | "Return the macro named by OBJECT, or nil if it is not a macro." | |
322 | (setq object (edebug-lookup-function object)) | |
84fc2cfa ER |
323 | (if (and (listp object) |
324 | (eq 'macro (car object)) | |
d778509c | 325 | (functionp (cdr object))) |
84fc2cfa ER |
326 | object)) |
327 | ||
328 | (defun edebug-sort-alist (alist function) | |
1fe3d507 DL |
329 | ;; Return the ALIST sorted with comparison function FUNCTION. |
330 | ;; This uses 'sort so the sorting is destructive. | |
84fc2cfa ER |
331 | (sort alist (function |
332 | (lambda (e1 e2) | |
333 | (funcall function (car e1) (car e2)))))) | |
334 | ||
1fe3d507 | 335 | ;;(def-edebug-spec edebug-save-restriction t) |
84fc2cfa | 336 | |
1fe3d507 DL |
337 | ;; Not used. If it is used, def-edebug-spec must be defined before use. |
338 | '(defmacro edebug-save-restriction (&rest body) | |
84fc2cfa ER |
339 | "Evaluate BODY while saving the current buffers restriction. |
340 | BODY may change buffer outside of current restriction, unlike | |
341 | save-restriction. BODY may change the current buffer, | |
342 | and the restriction will be restored to the original buffer, | |
343 | and the current buffer remains current. | |
344 | Return the result of the last expression in BODY." | |
d8f1319a GM |
345 | `(let ((edebug:s-r-beg (point-min-marker)) |
346 | (edebug:s-r-end (point-max-marker))) | |
347 | (unwind-protect | |
348 | (progn ,@body) | |
349 | (save-excursion | |
350 | (set-buffer (marker-buffer edebug:s-r-beg)) | |
351 | (narrow-to-region edebug:s-r-beg edebug:s-r-end))))) | |
84fc2cfa | 352 | |
f7359658 | 353 | ;;; Display |
1fe3d507 DL |
354 | |
355 | (defconst edebug-trace-buffer "*edebug-trace*" | |
356 | "Name of the buffer to put trace info in.") | |
357 | ||
358 | (defun edebug-pop-to-buffer (buffer &optional window) | |
359 | ;; Like pop-to-buffer, but select window where BUFFER was last shown. | |
a1506d29 | 360 | ;; Select WINDOW if it provided and it still exists. Otherwise, |
1fe3d507 DL |
361 | ;; if buffer is currently shown in several windows, choose one. |
362 | ;; Otherwise, find a new window, possibly splitting one. | |
363 | (setq window (if (and (windowp window) (edebug-window-live-p window) | |
364 | (eq (window-buffer window) buffer)) | |
365 | window | |
366 | (if (eq (window-buffer (selected-window)) buffer) | |
367 | (selected-window) | |
368 | (edebug-get-buffer-window buffer)))) | |
369 | (if window | |
370 | (select-window window) | |
371 | (if (one-window-p) | |
372 | (split-window)) | |
373 | ;; (message "next window: %s" (next-window)) (sit-for 1) | |
374 | (if (eq (get-buffer-window edebug-trace-buffer) (next-window)) | |
f7359658 | 375 | ;; Don't select trace window |
1fe3d507 DL |
376 | nil |
377 | (select-window (next-window)))) | |
378 | (set-window-buffer (selected-window) buffer) | |
379 | (set-window-hscroll (selected-window) 0);; should this be?? | |
380 | ;; Selecting the window does not set the buffer until command loop. | |
381 | ;;(set-buffer buffer) | |
382 | ) | |
84fc2cfa | 383 | |
1fe3d507 DL |
384 | |
385 | (defun edebug-get-displayed-buffer-points () | |
386 | ;; Return a list of buffer point pairs, for all displayed buffers. | |
e940c6da GM |
387 | (let (list) |
388 | (walk-windows (lambda (w) | |
389 | (unless (eq w (selected-window)) | |
d778509c SM |
390 | (push (cons (window-buffer w) |
391 | (window-point w)) | |
392 | list)))) | |
e940c6da | 393 | list)) |
1fe3d507 DL |
394 | |
395 | ||
396 | (defun edebug-set-buffer-points (buffer-points) | |
397 | ;; Restore the buffer-points created by edebug-get-displayed-buffer-points. | |
d778509c SM |
398 | (save-current-buffer |
399 | (mapcar (lambda (buf-point) | |
400 | (when (buffer-live-p (car buf-point)) | |
401 | (set-buffer (car buf-point)) | |
402 | (goto-char (cdr buf-point)))) | |
403 | buffer-points))) | |
1fe3d507 DL |
404 | |
405 | (defun edebug-current-windows (which-windows) | |
406 | ;; Get either a full window configuration or some window information. | |
407 | (if (listp which-windows) | |
408 | (mapcar (function (lambda (window) | |
409 | (if (edebug-window-live-p window) | |
410 | (list window | |
411 | (window-buffer window) | |
412 | (window-point window) | |
413 | (window-start window) | |
414 | (window-hscroll window))))) | |
415 | which-windows) | |
416 | (current-window-configuration))) | |
417 | ||
418 | (defun edebug-set-windows (window-info) | |
419 | ;; Set either a full window configuration or some window information. | |
420 | (if (listp window-info) | |
a1506d29 | 421 | (mapcar (function |
1fe3d507 DL |
422 | (lambda (one-window-info) |
423 | (if one-window-info | |
a1506d29 | 424 | (apply (function |
1fe3d507 DL |
425 | (lambda (window buffer point start hscroll) |
426 | (if (edebug-window-live-p window) | |
427 | (progn | |
428 | (set-window-buffer window buffer) | |
429 | (set-window-point window point) | |
430 | (set-window-start window start) | |
431 | (set-window-hscroll window hscroll))))) | |
432 | one-window-info)))) | |
433 | window-info) | |
434 | (set-window-configuration window-info))) | |
435 | ||
436 | (defalias 'edebug-get-buffer-window 'get-buffer-window) | |
437 | (defalias 'edebug-sit-for 'sit-for) | |
438 | (defalias 'edebug-input-pending-p 'input-pending-p) | |
439 | ||
440 | ||
f7359658 RS |
441 | ;;; Redefine read and eval functions |
442 | ;; read is redefined to maybe instrument forms. | |
443 | ;; eval-defun is redefined to check edebug-all-forms and edebug-all-defs. | |
1fe3d507 | 444 | |
1fe3d507 DL |
445 | ;; Save the original read function |
446 | (or (fboundp 'edebug-original-read) | |
447 | (defalias 'edebug-original-read (symbol-function 'read))) | |
448 | ||
88668147 DL |
449 | (defun edebug-read (&optional stream) |
450 | "Read one Lisp expression as text from STREAM, return as Lisp object. | |
451 | If STREAM is nil, use the value of `standard-input' (which see). | |
452 | STREAM or the value of `standard-input' may be: | |
453 | a buffer (read from point and advance it) | |
454 | a marker (read from where it points and advance it) | |
455 | a function (call it with no arguments for each character, | |
456 | call it with a char as argument to push a char back) | |
457 | a string (takes text from string, starting at the beginning) | |
458 | t (read text line using minibuffer and use it). | |
459 | ||
460 | This version, from Edebug, maybe instruments the expression. But the | |
f7359658 | 461 | STREAM must be the current buffer to do so. Whether it instruments is |
88668147 | 462 | also dependent on the values of `edebug-all-defs' and |
1fe3d507 | 463 | `edebug-all-forms'." |
88668147 DL |
464 | (or stream (setq stream standard-input)) |
465 | (if (eq stream (current-buffer)) | |
1fe3d507 DL |
466 | (edebug-read-and-maybe-wrap-form) |
467 | (edebug-original-read stream))) | |
468 | ||
1fe3d507 DL |
469 | (or (fboundp 'edebug-original-eval-defun) |
470 | (defalias 'edebug-original-eval-defun (symbol-function 'eval-defun))) | |
471 | ||
f7359658 RS |
472 | ;; We should somehow arrange to be able to do this |
473 | ;; without actually replacing the eval-defun command. | |
1fe3d507 DL |
474 | (defun edebug-eval-defun (edebug-it) |
475 | "Evaluate the top-level form containing point, or after point. | |
476 | ||
44b6285e GM |
477 | If the current defun is actually a call to `defvar', then reset the |
478 | variable using its initial value expression even if the variable | |
479 | already has some other value. (Normally `defvar' does not change the | |
480 | variable's value if it already has a value.) | |
481 | ||
482 | With a prefix argument, instrument the code for Edebug. | |
483 | ||
484 | Setting `edebug-all-defs' to a non-nil value reverses the meaning of | |
485 | the prefix argument. Code is then instrumented when this function is | |
486 | invoked without a prefix argument | |
487 | ||
488 | If acting on a `defun' for FUNCTION, and the function was | |
489 | instrumented, `Edebug: FUNCTION' is printed in the minibuffer. If not | |
490 | instrumented, just FUNCTION is printed. | |
491 | ||
492 | If not acting on a `defun', the result of evaluation is displayed in | |
493 | the minibuffer." | |
1fe3d507 | 494 | (interactive "P") |
f7359658 RS |
495 | (let* ((edebugging (not (eq (not edebug-it) (not edebug-all-defs)))) |
496 | (edebug-result) | |
497 | (form | |
498 | (let ((edebug-all-forms edebugging) | |
499 | (edebug-all-defs (eq edebug-all-defs (not edebug-it)))) | |
500 | (edebug-read-top-level-form)))) | |
e75667a0 | 501 | ;; This should be consistent with `eval-defun-1', but not the |
0c4a4faa | 502 | ;; same, since that gets a macroexpanded form. |
6b339332 DL |
503 | (cond ((and (eq (car form) 'defvar) |
504 | (cdr-safe (cdr-safe form))) | |
505 | ;; Force variable to be bound. | |
0c4a4faa | 506 | (makunbound (nth 1 form))) |
6b339332 DL |
507 | ((and (eq (car form) 'defcustom) |
508 | (default-boundp (nth 1 form))) | |
509 | ;; Force variable to be bound. | |
510 | (set-default (nth 1 form) (eval (nth 2 form))))) | |
f7359658 | 511 | (setq edebug-result (eval form)) |
1fe3d507 DL |
512 | (if (not edebugging) |
513 | (princ edebug-result) | |
514 | edebug-result))) | |
515 | ||
516 | ||
517 | ;;;###autoload | |
518 | (defalias 'edebug-defun 'edebug-eval-top-level-form) | |
519 | ||
520 | ;;;###autoload | |
521 | (defun edebug-eval-top-level-form () | |
1f1b7f93 RS |
522 | "Evaluate the top level form point is in, stepping through with Edebug. |
523 | This is like `eval-defun' except that it steps the code for Edebug | |
524 | before evaluating it. It displays the value in the echo area | |
525 | using `eval-expression' (which see). | |
526 | ||
527 | If you do this on a function definition | |
528 | such as a defun or defmacro, it defines the function and instruments | |
529 | its definition for Edebug, so it will do Edebug stepping when called | |
530 | later. It displays `Edebug: FUNCTION' in the echo area to indicate | |
531 | that FUNCTION is now instrumented for Edebug. | |
532 | ||
533 | If the current defun is actually a call to `defvar' or `defcustom', | |
534 | evaluating it this way resets the variable using its initial value | |
535 | expression even if the variable already has some other value. | |
536 | \(Normally `defvar' and `defcustom' do not alter the value if there | |
537 | already is one.)" | |
84fc2cfa | 538 | (interactive) |
1f1b7f93 | 539 | (eval-expression |
f7359658 | 540 | ;; Bind edebug-all-forms only while reading, not while evalling |
1fe3d507 | 541 | ;; but this causes problems while edebugging edebug. |
88668147 DL |
542 | (let ((edebug-all-forms t) |
543 | (edebug-all-defs t)) | |
1fe3d507 | 544 | (edebug-read-top-level-form)))) |
84fc2cfa ER |
545 | |
546 | ||
1fe3d507 DL |
547 | (defun edebug-read-top-level-form () |
548 | (let ((starting-point (point))) | |
549 | (end-of-defun) | |
550 | (beginning-of-defun) | |
551 | (prog1 | |
552 | (edebug-read-and-maybe-wrap-form) | |
553 | ;; Recover point, but only if no error occurred. | |
554 | (goto-char starting-point)))) | |
84fc2cfa | 555 | |
84fc2cfa | 556 | |
1fe3d507 DL |
557 | ;; Compatibility with old versions. |
558 | (defalias 'edebug-all-defuns 'edebug-all-defs) | |
84fc2cfa | 559 | |
1fe3d507 DL |
560 | (defun edebug-all-defs () |
561 | "Toggle edebugging of all definitions." | |
562 | (interactive) | |
563 | (setq edebug-all-defs (not edebug-all-defs)) | |
a1506d29 | 564 | (message "Edebugging all definitions is %s." |
1fe3d507 | 565 | (if edebug-all-defs "on" "off"))) |
84fc2cfa | 566 | |
84fc2cfa | 567 | |
1fe3d507 DL |
568 | (defun edebug-all-forms () |
569 | "Toggle edebugging of all forms." | |
570 | (interactive) | |
571 | (setq edebug-all-forms (not edebug-all-forms)) | |
a1506d29 | 572 | (message "Edebugging all forms is %s." |
1fe3d507 | 573 | (if edebug-all-forms "on" "off"))) |
84fc2cfa ER |
574 | |
575 | ||
1fe3d507 | 576 | (defun edebug-install-read-eval-functions () |
1c222bca | 577 | (interactive) |
88668147 | 578 | ;; Don't install if already installed. |
faa5fa58 DL |
579 | (unless load-read-function |
580 | (setq load-read-function 'edebug-read) | |
88668147 | 581 | (defalias 'eval-defun 'edebug-eval-defun))) |
daa37602 | 582 | |
1fe3d507 DL |
583 | (defun edebug-uninstall-read-eval-functions () |
584 | (interactive) | |
faa5fa58 | 585 | (setq load-read-function nil) |
88668147 | 586 | (defalias 'eval-defun (symbol-function 'edebug-original-eval-defun))) |
1fe3d507 DL |
587 | |
588 | ||
f7359658 | 589 | ;;; Edebug internal data |
1fe3d507 | 590 | |
f7359658 | 591 | ;; The internal data that is needed for edebugging is kept in the |
a1506d29 | 592 | ;; buffer-local variable `edebug-form-data'. |
1fe3d507 DL |
593 | |
594 | (make-variable-buffer-local 'edebug-form-data) | |
595 | ||
0b936a1e | 596 | (defvar edebug-form-data nil) |
1fe3d507 DL |
597 | ;; A list of entries associating symbols with buffer regions. |
598 | ;; This is an automatic buffer local variable. Each entry looks like: | |
599 | ;; @code{(@var{symbol} @var{begin-marker} @var{end-marker}). The markers | |
600 | ;; are at the beginning and end of an entry level form and @var{symbol} is | |
601 | ;; a symbol that holds all edebug related information for the form on its | |
602 | ;; property list. | |
603 | ||
604 | ;; In the future, the symbol will be irrelevant and edebug data will | |
605 | ;; be stored in the definitions themselves rather than in the property | |
606 | ;; list of a symbol. | |
607 | ||
608 | (defun edebug-make-form-data-entry (symbol begin end) | |
609 | (list symbol begin end)) | |
610 | ||
611 | (defsubst edebug-form-data-name (entry) | |
612 | (car entry)) | |
613 | ||
614 | (defsubst edebug-form-data-begin (entry) | |
615 | (nth 1 entry)) | |
616 | ||
617 | (defsubst edebug-form-data-end (entry) | |
618 | (nth 2 entry)) | |
619 | ||
620 | (defsubst edebug-set-form-data-entry (entry name begin end) | |
621 | (setcar entry name);; in case name is changed | |
622 | (set-marker (nth 1 entry) begin) | |
623 | (set-marker (nth 2 entry) end)) | |
624 | ||
625 | (defun edebug-get-form-data-entry (pnt &optional end-point) | |
626 | ;; Find the edebug form data entry which is closest to PNT. | |
627 | ;; If END-POINT is supplied, match must be exact. | |
628 | ;; Return `nil' if none found. | |
629 | (let ((rest edebug-form-data) | |
630 | closest-entry | |
631 | (closest-dist 999999)) ;; need maxint here | |
632 | (while (and rest (< 0 closest-dist)) | |
633 | (let* ((entry (car rest)) | |
634 | (begin (edebug-form-data-begin entry)) | |
635 | (dist (- pnt begin))) | |
636 | (setq rest (cdr rest)) | |
637 | (if (and (<= 0 dist) | |
638 | (< dist closest-dist) | |
639 | (or (not end-point) | |
640 | (= end-point (edebug-form-data-end entry))) | |
641 | (<= pnt (edebug-form-data-end entry))) | |
642 | (setq closest-dist dist | |
643 | closest-entry entry)))) | |
644 | closest-entry)) | |
645 | ||
646 | ;; Also need to find all contained entries, | |
647 | ;; and find an entry given a symbol, which should be just assq. | |
648 | ||
649 | (defun edebug-form-data-symbol () | |
650 | ;; Return the edebug data symbol of the form where point is in. | |
651 | ;; If point is not inside a edebuggable form, cause error. | |
652 | (or (edebug-form-data-name (edebug-get-form-data-entry (point))) | |
653 | (error "Not inside instrumented form"))) | |
654 | ||
655 | (defun edebug-make-top-form-data-entry (new-entry) | |
656 | ;; Make NEW-ENTRY the first element in the `edebug-form-data' list. | |
657 | (edebug-clear-form-data-entry new-entry) | |
658 | (setq edebug-form-data (cons new-entry edebug-form-data))) | |
659 | ||
660 | (defun edebug-clear-form-data-entry (entry) | |
a1506d29 | 661 | ;; If non-nil, clear ENTRY out of the form data. |
1fe3d507 DL |
662 | ;; Maybe clear the markers and delete the symbol's edebug property? |
663 | (if entry | |
664 | (progn | |
a1506d29 JB |
665 | ;; Instead of this, we could just find all contained forms. |
666 | ;; (put (car entry) 'edebug nil) ; | |
1fe3d507 DL |
667 | ;; (mapcar 'edebug-clear-form-data-entry ; dangerous |
668 | ;; (get (car entry) 'edebug-dependents)) | |
669 | ;; (set-marker (nth 1 entry) nil) | |
670 | ;; (set-marker (nth 2 entry) nil) | |
671 | (setq edebug-form-data (delq entry edebug-form-data))))) | |
daa37602 | 672 | |
f7359658 | 673 | ;;; Parser utilities |
1fe3d507 DL |
674 | |
675 | (defun edebug-syntax-error (&rest args) | |
676 | ;; Signal an invalid-read-syntax with ARGS. | |
677 | (signal 'invalid-read-syntax args)) | |
678 | ||
84fc2cfa | 679 | |
1fe3d507 DL |
680 | (defconst edebug-read-syntax-table |
681 | ;; Lookup table for significant characters indicating the class of the | |
682 | ;; token that follows. This is not a \"real\" syntax table. | |
0b936a1e | 683 | (let ((table (make-char-table 'syntax-table 'symbol)) |
1fe3d507 DL |
684 | (i 0)) |
685 | (while (< i ?!) | |
686 | (aset table i 'space) | |
687 | (setq i (1+ i))) | |
688 | (aset table ?\( 'lparen) | |
689 | (aset table ?\) 'rparen) | |
690 | (aset table ?\' 'quote) | |
f7359658 RS |
691 | (aset table ?\` 'backquote) |
692 | (aset table ?\, 'comma) | |
1fe3d507 DL |
693 | (aset table ?\" 'string) |
694 | (aset table ?\? 'char) | |
695 | (aset table ?\[ 'lbracket) | |
696 | (aset table ?\] 'rbracket) | |
697 | (aset table ?\. 'dot) | |
698 | (aset table ?\# 'hash) | |
699 | ;; We treat numbers as symbols, because of confusion with -, -1, and 1-. | |
f7359658 | 700 | ;; We don't care about any other chars since they won't be seen. |
1fe3d507 | 701 | table)) |
84fc2cfa | 702 | |
1fe3d507 DL |
703 | (defun edebug-next-token-class () |
704 | ;; Move to the next token and return its class. We only care about | |
f7359658 RS |
705 | ;; lparen, rparen, dot, quote, backquote, comma, string, char, vector, |
706 | ;; or symbol. | |
1fe3d507 | 707 | (edebug-skip-whitespace) |
e4773f39 KH |
708 | (if (and (eq (following-char) ?.) |
709 | (save-excursion | |
710 | (forward-char 1) | |
711 | (and (>= (following-char) ?0) | |
712 | (<= (following-char) ?9)))) | |
713 | 'symbol | |
714 | (aref edebug-read-syntax-table (following-char)))) | |
84fc2cfa | 715 | |
84fc2cfa | 716 | |
1fe3d507 DL |
717 | (defun edebug-skip-whitespace () |
718 | ;; Leave point before the next token, skipping white space and comments. | |
719 | (skip-chars-forward " \t\r\n\f") | |
720 | (while (= (following-char) ?\;) | |
721 | ;; \r is counted as a comment terminator to support selective display. | |
722 | (skip-chars-forward "^\n\r") ; skip the comment | |
723 | (skip-chars-forward " \t\r\n\f"))) | |
84fc2cfa | 724 | |
84fc2cfa | 725 | |
1fe3d507 | 726 | ;; Mostly obsolete reader; still used in one case. |
84fc2cfa | 727 | |
1fe3d507 DL |
728 | (defun edebug-read-sexp () |
729 | ;; Read one sexp from the current buffer starting at point. | |
730 | ;; Leave point immediately after it. A sexp can be a list or atom. | |
731 | ;; An atom is a symbol (or number), character, string, or vector. | |
732 | ;; This works for reading anything legitimate, but it | |
733 | ;; is gummed up by parser inconsistencies (bugs?) | |
734 | (let ((class (edebug-next-token-class))) | |
735 | (cond | |
736 | ;; read goes one too far if a (possibly quoted) string or symbol | |
737 | ;; is immediately followed by non-whitespace. | |
f4897e40 RS |
738 | ((eq class 'symbol) (edebug-original-read (current-buffer))) |
739 | ((eq class 'string) (edebug-original-read (current-buffer))) | |
1fe3d507 DL |
740 | ((eq class 'quote) (forward-char 1) |
741 | (list 'quote (edebug-read-sexp))) | |
f7359658 RS |
742 | ((eq class 'backquote) |
743 | (list '\` (edebug-read-sexp))) | |
744 | ((eq class 'comma) | |
745 | (list '\, (edebug-read-sexp))) | |
1fe3d507 DL |
746 | (t ; anything else, just read it. |
747 | (edebug-original-read (current-buffer)))))) | |
748 | ||
f7359658 | 749 | ;;; Offsets for reader |
1fe3d507 DL |
750 | |
751 | ;; Define a structure to represent offset positions of expressions. | |
752 | ;; Each offset structure looks like: (before . after) for constituents, | |
753 | ;; or for structures that have elements: (before <subexpressions> . after) | |
754 | ;; where the <subexpressions> are the offset structures for subexpressions | |
755 | ;; including the head of a list. | |
0b936a1e | 756 | (defvar edebug-offsets nil) |
1fe3d507 DL |
757 | |
758 | ;; Stack of offset structures in reverse order of the nesting. | |
759 | ;; This is used to get back to previous levels. | |
0b936a1e SM |
760 | (defvar edebug-offsets-stack nil) |
761 | (defvar edebug-current-offset nil) ; Top of the stack, for convenience. | |
1fe3d507 DL |
762 | |
763 | ;; We must store whether we just read a list with a dotted form that | |
764 | ;; is itself a list. This structure will be condensed, so the offsets | |
765 | ;; must also be condensed. | |
0b936a1e | 766 | (defvar edebug-read-dotted-list nil) |
1fe3d507 DL |
767 | |
768 | (defsubst edebug-initialize-offsets () | |
769 | ;; Reinitialize offset recording. | |
770 | (setq edebug-current-offset nil)) | |
771 | ||
772 | (defun edebug-store-before-offset (point) | |
773 | ;; Add a new offset pair with POINT as the before offset. | |
774 | (let ((new-offset (list point))) | |
775 | (if edebug-current-offset | |
776 | (setcdr edebug-current-offset | |
777 | (cons new-offset (cdr edebug-current-offset))) | |
778 | ;; Otherwise, we are at the top level, so initialize. | |
779 | (setq edebug-offsets new-offset | |
780 | edebug-offsets-stack nil | |
781 | edebug-read-dotted-list nil)) | |
782 | ;; Cons the new offset to the front of the stack. | |
783 | (setq edebug-offsets-stack (cons new-offset edebug-offsets-stack) | |
784 | edebug-current-offset new-offset) | |
84fc2cfa ER |
785 | )) |
786 | ||
1fe3d507 DL |
787 | (defun edebug-store-after-offset (point) |
788 | ;; Finalize the current offset struct by reversing it and | |
789 | ;; store POINT as the after offset. | |
790 | (if (not edebug-read-dotted-list) | |
791 | ;; Just reverse the offsets of all subexpressions. | |
792 | (setcdr edebug-current-offset (nreverse (cdr edebug-current-offset))) | |
793 | ||
794 | ;; We just read a list after a dot, which will be abbreviated out. | |
795 | (setq edebug-read-dotted-list nil) | |
796 | ;; Drop the corresponding offset pair. | |
a1506d29 | 797 | ;; That is, nconc the reverse of the rest of the offsets |
1fe3d507 DL |
798 | ;; with the cdr of last offset. |
799 | (setcdr edebug-current-offset | |
800 | (nconc (nreverse (cdr (cdr edebug-current-offset))) | |
801 | (cdr (car (cdr edebug-current-offset)))))) | |
802 | ||
803 | ;; Now append the point using nconc. | |
804 | (setq edebug-current-offset (nconc edebug-current-offset point)) | |
805 | ;; Pop the stack. | |
806 | (setq edebug-offsets-stack (cdr edebug-offsets-stack) | |
807 | edebug-current-offset (car edebug-offsets-stack))) | |
808 | ||
809 | (defun edebug-ignore-offset () | |
810 | ;; Ignore the last created offset pair. | |
811 | (setcdr edebug-current-offset (cdr (cdr edebug-current-offset)))) | |
812 | ||
1fe3d507 | 813 | (defmacro edebug-storing-offsets (point &rest body) |
5121ef4c | 814 | (declare (debug (form body)) (indent 1)) |
d8f1319a | 815 | `(unwind-protect |
a1506d29 | 816 | (progn |
d8f1319a | 817 | (edebug-store-before-offset ,point) |
a1506d29 | 818 | ,@body) |
d8f1319a | 819 | (edebug-store-after-offset (point)))) |
1fe3d507 DL |
820 | |
821 | ||
f7359658 RS |
822 | ;;; Reader for Emacs Lisp. |
823 | ||
1fe3d507 DL |
824 | ;; Uses edebug-next-token-class (and edebug-skip-whitespace) above. |
825 | ||
826 | (defconst edebug-read-alist | |
827 | '((symbol . edebug-read-symbol) | |
828 | (lparen . edebug-read-list) | |
829 | (string . edebug-read-string) | |
830 | (quote . edebug-read-quote) | |
f7359658 RS |
831 | (backquote . edebug-read-backquote) |
832 | (comma . edebug-read-comma) | |
1fe3d507 DL |
833 | (lbracket . edebug-read-vector) |
834 | (hash . edebug-read-function) | |
835 | )) | |
84fc2cfa | 836 | |
1fe3d507 | 837 | (defun edebug-read-storing-offsets (stream) |
5121ef4c | 838 | (let (edebug-read-dotted-list) ; see edebug-store-after-offset |
1fe3d507 | 839 | (edebug-storing-offsets (point) |
5121ef4c SM |
840 | (funcall |
841 | (or (cdr (assq (edebug-next-token-class) edebug-read-alist)) | |
842 | ;; anything else, just read it. | |
843 | 'edebug-original-read) | |
844 | stream)))) | |
84fc2cfa | 845 | |
1fe3d507 | 846 | (defun edebug-read-symbol (stream) |
f4897e40 | 847 | (edebug-original-read stream)) |
84fc2cfa | 848 | |
1fe3d507 | 849 | (defun edebug-read-string (stream) |
f4897e40 | 850 | (edebug-original-read stream)) |
84fc2cfa | 851 | |
1fe3d507 DL |
852 | (defun edebug-read-quote (stream) |
853 | ;; Turn 'thing into (quote thing) | |
854 | (forward-char 1) | |
855 | (list | |
5121ef4c | 856 | (edebug-storing-offsets (1- (point)) 'quote) |
1fe3d507 DL |
857 | (edebug-read-storing-offsets stream))) |
858 | ||
5121ef4c SM |
859 | (defvar edebug-read-backquote-level 0 |
860 | "If non-zero, we're in a new-style backquote. | |
861 | It should never be negative. This controls how we read comma constructs.") | |
862 | ||
f7359658 RS |
863 | (defun edebug-read-backquote (stream) |
864 | ;; Turn `thing into (\` thing) | |
5121ef4c SM |
865 | (forward-char 1) |
866 | (list | |
867 | (edebug-storing-offsets (1- (point)) '\`) | |
868 | (let ((edebug-read-backquote-level (1+ edebug-read-backquote-level))) | |
869 | (edebug-read-storing-offsets stream)))) | |
f7359658 RS |
870 | |
871 | (defun edebug-read-comma (stream) | |
872 | ;; Turn ,thing into (\, thing). Handle ,@ and ,. also. | |
873 | (let ((opoint (point))) | |
874 | (forward-char 1) | |
875 | (let ((symbol '\,)) | |
876 | (cond ((eq (following-char) ?\.) | |
877 | (setq symbol '\,\.) | |
878 | (forward-char 1)) | |
879 | ((eq (following-char) ?\@) | |
880 | (setq symbol '\,@) | |
881 | (forward-char 1))) | |
882 | ;; Generate the same structure of offsets we would have | |
883 | ;; if the resulting list appeared verbatim in the input text. | |
5121ef4c SM |
884 | (if (zerop edebug-read-backquote-level) |
885 | (edebug-storing-offsets opoint symbol) | |
886 | (list | |
887 | (edebug-storing-offsets opoint symbol) | |
888 | (let ((edebug-read-backquote-level (1- edebug-read-backquote-level))) | |
889 | (edebug-read-storing-offsets stream))))))) | |
f7359658 | 890 | |
1fe3d507 DL |
891 | (defun edebug-read-function (stream) |
892 | ;; Turn #'thing into (function thing) | |
893 | (forward-char 1) | |
6db746da DL |
894 | (cond ((eq ?\' (following-char)) |
895 | (forward-char 1) | |
a1506d29 | 896 | (list |
5121ef4c | 897 | (edebug-storing-offsets (- (point) 2) |
6db746da DL |
898 | (if (featurep 'cl) 'function* 'function)) |
899 | (edebug-read-storing-offsets stream))) | |
057b57f6 | 900 | ((memq (following-char) '(?: ?B ?O ?X ?b ?o ?x ?1 ?2 ?3 ?4 ?5 ?6 |
5121ef4c | 901 | ?7 ?8 ?9 ?0)) |
057b57f6 | 902 | (backward-char 1) |
6db746da DL |
903 | (edebug-original-read stream)) |
904 | (t (edebug-syntax-error "Bad char after #")))) | |
1fe3d507 DL |
905 | |
906 | (defun edebug-read-list (stream) | |
907 | (forward-char 1) ; skip \( | |
a1506d29 | 908 | (prog1 |
1fe3d507 DL |
909 | (let ((elements)) |
910 | (while (not (memq (edebug-next-token-class) '(rparen dot))) | |
5121ef4c SM |
911 | (if (and (eq (edebug-next-token-class) 'backquote) |
912 | (null elements) | |
913 | (zerop edebug-read-backquote-level)) | |
914 | (progn | |
915 | ;; Old style backquote. | |
916 | (forward-char 1) ; Skip backquote. | |
917 | ;; Call edebug-storing-offsets here so that we | |
918 | ;; produce the same offsets we would have had | |
919 | ;; if the backquote were an ordinary symbol. | |
920 | (push (edebug-storing-offsets (1- (point)) '\`) elements)) | |
921 | (push (edebug-read-storing-offsets stream) elements))) | |
1fe3d507 DL |
922 | (setq elements (nreverse elements)) |
923 | (if (eq 'dot (edebug-next-token-class)) | |
924 | (let (dotted-form) | |
925 | (forward-char 1) ; skip \. | |
926 | (setq dotted-form (edebug-read-storing-offsets stream)) | |
927 | elements (nconc elements dotted-form) | |
928 | (if (not (eq (edebug-next-token-class) 'rparen)) | |
929 | (edebug-syntax-error "Expected `)'")) | |
930 | (setq edebug-read-dotted-list (listp dotted-form)) | |
931 | )) | |
932 | elements) | |
933 | (forward-char 1) ; skip \) | |
934 | )) | |
84fc2cfa | 935 | |
1fe3d507 DL |
936 | (defun edebug-read-vector (stream) |
937 | (forward-char 1) ; skip \[ | |
a1506d29 | 938 | (prog1 |
1fe3d507 DL |
939 | (let ((elements)) |
940 | (while (not (eq 'rbracket (edebug-next-token-class))) | |
5121ef4c | 941 | (push (edebug-read-storing-offsets stream) elements)) |
1fe3d507 DL |
942 | (apply 'vector (nreverse elements))) |
943 | (forward-char 1) ; skip \] | |
84fc2cfa ER |
944 | )) |
945 | ||
f7359658 | 946 | ;;; Cursors for traversal of list and vector elements with offsets. |
1fe3d507 DL |
947 | |
948 | (defvar edebug-dotted-spec nil) | |
949 | ||
950 | (defun edebug-new-cursor (expressions offsets) | |
951 | ;; Return a new cursor for EXPRESSIONS with OFFSETS. | |
a1506d29 | 952 | (if (vectorp expressions) |
1fe3d507 DL |
953 | (setq expressions (append expressions nil))) |
954 | (cons expressions offsets)) | |
955 | ||
956 | (defsubst edebug-set-cursor (cursor expressions offsets) | |
957 | ;; Set the CURSOR's EXPRESSIONS and OFFSETS to the given. | |
958 | ;; Return the cursor. | |
959 | (setcar cursor expressions) | |
960 | (setcdr cursor offsets) | |
961 | cursor) | |
962 | ||
552754fe | 963 | (defun edebug-copy-cursor (cursor) |
1fe3d507 DL |
964 | ;; Copy the cursor using the same object and offsets. |
965 | (cons (car cursor) (cdr cursor))) | |
966 | ||
967 | (defsubst edebug-cursor-expressions (cursor) | |
968 | (car cursor)) | |
969 | (defsubst edebug-cursor-offsets (cursor) | |
970 | (cdr cursor)) | |
971 | ||
972 | (defsubst edebug-empty-cursor (cursor) | |
973 | ;; Return non-nil if CURSOR is empty - meaning no more elements. | |
974 | (null (car cursor))) | |
975 | ||
976 | (defsubst edebug-top-element (cursor) | |
977 | ;; Return the top element at the cursor. | |
978 | ;; Assumes not empty. | |
979 | (car (car cursor))) | |
980 | ||
981 | (defun edebug-top-element-required (cursor &rest error) | |
982 | ;; Check if a dotted form is required. | |
983 | (if edebug-dotted-spec (edebug-no-match cursor "Dot expected.")) | |
984 | ;; Check if there is at least one more argument. | |
985 | (if (edebug-empty-cursor cursor) (apply 'edebug-no-match cursor error)) | |
986 | ;; Return that top element. | |
987 | (edebug-top-element cursor)) | |
988 | ||
989 | (defsubst edebug-top-offset (cursor) | |
990 | ;; Return the top offset pair corresponding to the top element. | |
991 | (car (cdr cursor))) | |
992 | ||
993 | (defun edebug-move-cursor (cursor) | |
994 | ;; Advance and return the cursor to the next element and offset. | |
995 | ;; throw no-match if empty before moving. | |
996 | ;; This is a violation of the cursor encapsulation, but | |
997 | ;; there is plenty of that going on while matching. | |
998 | ;; The following test should always fail. | |
a1506d29 | 999 | (if (edebug-empty-cursor cursor) |
1fe3d507 DL |
1000 | (edebug-no-match cursor "Not enough arguments.")) |
1001 | (setcar cursor (cdr (car cursor))) | |
1002 | (setcdr cursor (cdr (cdr cursor))) | |
1003 | cursor) | |
1004 | ||
1005 | ||
1006 | (defun edebug-before-offset (cursor) | |
1007 | ;; Return the before offset of the cursor. | |
1008 | ;; If there is nothing left in the offsets, | |
a1506d29 | 1009 | ;; return one less than the offset itself, |
1fe3d507 DL |
1010 | ;; which is the after offset for a list. |
1011 | (let ((offset (edebug-cursor-offsets cursor))) | |
1012 | (if (consp offset) | |
1013 | (car (car offset)) | |
1014 | (1- offset)))) | |
1015 | ||
1016 | (defun edebug-after-offset (cursor) | |
1017 | ;; Return the after offset of the cursor object. | |
1018 | (let ((offset (edebug-top-offset cursor))) | |
1019 | (while (consp offset) | |
1020 | (setq offset (cdr offset))) | |
1021 | offset)) | |
1022 | ||
f7359658 | 1023 | ;;; The Parser |
1fe3d507 | 1024 | |
f7359658 RS |
1025 | ;; The top level function for parsing forms is |
1026 | ;; edebug-read-and-maybe-wrap-form; it calls all the rest. It checks the | |
1027 | ;; syntax a bit and leaves point at any error it finds, but otherwise | |
1028 | ;; should appear to work like eval-defun. | |
1fe3d507 | 1029 | |
f7359658 RS |
1030 | ;; The basic plan is to surround each expression with a call to |
1031 | ;; the edebug debugger together with indexes into a table of positions of | |
1032 | ;; all expressions. Thus an expression "exp" becomes: | |
1fe3d507 | 1033 | |
f7359658 | 1034 | ;; (edebug-after (edebug-before 1) 2 exp) |
1fe3d507 | 1035 | |
f7359658 RS |
1036 | ;; When this is evaluated, first point is moved to the beginning of |
1037 | ;; exp at offset 1 of the current function. The expression is | |
1038 | ;; evaluated, which may cause more edebug calls, and then point is | |
1039 | ;; moved to offset 2 after the end of exp. | |
1fe3d507 | 1040 | |
f7359658 RS |
1041 | ;; The highest level expressions of the function are wrapped in a call to |
1042 | ;; edebug-enter, which supplies the function name and the actual | |
1043 | ;; arguments to the function. See functions edebug-enter, edebug-before, | |
1044 | ;; and edebug-after for more details. | |
1fe3d507 DL |
1045 | |
1046 | ;; Dynamically bound vars, left unbound, but globally declared. | |
1047 | ;; This is to quiet the byte compiler. | |
1048 | ||
1049 | ;; Window data of the highest definition being wrapped. | |
1050 | ;; This data is shared by all embedded definitions. | |
1051 | (defvar edebug-top-window-data) | |
1052 | ||
1053 | (defvar edebug-&optional) | |
1054 | (defvar edebug-&rest) | |
1055 | (defvar edebug-gate nil) ;; whether no-match forces an error. | |
1056 | ||
0b936a1e SM |
1057 | (defvar edebug-def-name nil) ; name of definition, used by interactive-form |
1058 | (defvar edebug-old-def-name nil) ; previous name of containing definition. | |
1fe3d507 | 1059 | |
0b936a1e SM |
1060 | (defvar edebug-error-point nil) |
1061 | (defvar edebug-best-error nil) | |
1fe3d507 DL |
1062 | |
1063 | ||
1064 | (defun edebug-read-and-maybe-wrap-form () | |
1065 | ;; Read a form and wrap it with edebug calls, if the conditions are right. | |
1066 | ;; Here we just catch any no-match not caught below and signal an error. | |
1067 | ||
1068 | ;; Run the setup hook. | |
88b52bf5 RS |
1069 | ;; If it gets an error, make it nil. |
1070 | (let ((temp-hook edebug-setup-hook)) | |
1071 | (setq edebug-setup-hook nil) | |
1072 | (run-hooks 'temp-hook)) | |
1fe3d507 DL |
1073 | |
1074 | (let (result | |
1075 | edebug-top-window-data | |
1076 | edebug-def-name;; make sure it is locally nil | |
f7359658 | 1077 | ;; I don't like these here!! |
1fe3d507 DL |
1078 | edebug-&optional |
1079 | edebug-&rest | |
1080 | edebug-gate | |
1081 | edebug-best-error | |
1082 | edebug-error-point | |
1083 | no-match | |
1084 | ;; Do this once here instead of several times. | |
1085 | (max-lisp-eval-depth (+ 800 max-lisp-eval-depth)) | |
f7359658 | 1086 | (max-specpdl-size (+ 2000 max-specpdl-size))) |
1fe3d507 DL |
1087 | (setq no-match |
1088 | (catch 'no-match | |
1089 | (setq result (edebug-read-and-maybe-wrap-form1)) | |
1090 | nil)) | |
1091 | (if no-match | |
1092 | (apply 'edebug-syntax-error no-match)) | |
1093 | result)) | |
1094 | ||
1095 | ||
1096 | (defun edebug-read-and-maybe-wrap-form1 () | |
1097 | (let (spec | |
1098 | def-kind | |
1099 | defining-form-p | |
1100 | def-name | |
f7359658 | 1101 | ;; These offset things don't belong here, but to support recursive |
1fe3d507 DL |
1102 | ;; calls to edebug-read, they need to be here. |
1103 | edebug-offsets | |
1104 | edebug-offsets-stack | |
1105 | edebug-current-offset ; reset to nil | |
1106 | ) | |
1107 | (save-excursion | |
1108 | (if (and (eq 'lparen (edebug-next-token-class)) | |
1109 | (eq 'symbol (progn (forward-char 1) (edebug-next-token-class)))) | |
1110 | ;; Find out if this is a defining form from first symbol | |
88668147 | 1111 | (setq def-kind (edebug-original-read (current-buffer)) |
1fe3d507 DL |
1112 | spec (and (symbolp def-kind) (get-edebug-spec def-kind)) |
1113 | defining-form-p (and (listp spec) | |
1114 | (eq '&define (car spec))) | |
1115 | ;; This is incorrect in general!! But OK most of the time. | |
a1506d29 | 1116 | def-name (if (and defining-form-p |
1fe3d507 DL |
1117 | (eq 'name (car (cdr spec))) |
1118 | (eq 'symbol (edebug-next-token-class))) | |
88668147 DL |
1119 | (edebug-original-read (current-buffer)))))) |
1120 | ;;;(message "all defs: %s all forms: %s" edebug-all-defs edebug-all-forms) | |
84fc2cfa | 1121 | (cond |
1fe3d507 DL |
1122 | (defining-form-p |
1123 | (if (or edebug-all-defs edebug-all-forms) | |
1124 | ;; If it is a defining form and we are edebugging defs, | |
1125 | ;; then let edebug-list-form start it. | |
a1506d29 | 1126 | (let ((cursor (edebug-new-cursor |
1fe3d507 DL |
1127 | (list (edebug-read-storing-offsets (current-buffer))) |
1128 | (list edebug-offsets)))) | |
1129 | (car | |
1130 | (edebug-make-form-wrapper | |
1131 | cursor | |
a1506d29 | 1132 | (edebug-before-offset cursor) |
1fe3d507 DL |
1133 | (1- (edebug-after-offset cursor)) |
1134 | (list (cons (symbol-name def-kind) (cdr spec)))))) | |
1135 | ||
1136 | ;; Not edebugging this form, so reset the symbol's edebug | |
1137 | ;; property to be just a marker at the definition's source code. | |
1138 | ;; This only works for defs with simple names. | |
1139 | (put def-name 'edebug (point-marker)) | |
1140 | ;; Also nil out dependent defs. | |
a1506d29 | 1141 | '(mapcar (function |
1fe3d507 DL |
1142 | (lambda (def) |
1143 | (put def-name 'edebug nil))) | |
1144 | (get def-name 'edebug-dependents)) | |
1145 | (edebug-read-sexp))) | |
1146 | ||
1147 | ;; If all forms are being edebugged, explicitly wrap it. | |
1148 | (edebug-all-forms | |
a1506d29 | 1149 | (let ((cursor (edebug-new-cursor |
1fe3d507 DL |
1150 | (list (edebug-read-storing-offsets (current-buffer))) |
1151 | (list edebug-offsets)))) | |
a1506d29 | 1152 | (edebug-make-form-wrapper |
1fe3d507 | 1153 | cursor |
a1506d29 JB |
1154 | (edebug-before-offset cursor) |
1155 | (edebug-after-offset cursor) | |
1fe3d507 DL |
1156 | nil))) |
1157 | ||
1158 | ;; Not a defining form, and not edebugging. | |
1159 | (t (edebug-read-sexp))) | |
1160 | )) | |
1161 | ||
1162 | ||
1163 | (defvar edebug-def-args) ; args of defining form. | |
1164 | (defvar edebug-def-interactive) ; is it an emacs interactive function? | |
1165 | (defvar edebug-inside-func) ;; whether code is inside function context. | |
1166 | ;; Currently def-form sets this to nil; def-body sets it to t. | |
1167 | ||
1168 | (defun edebug-interactive-p-name () | |
1169 | ;; Return a unique symbol for the variable used to store the | |
1170 | ;; status of interactive-p for this function. | |
1171 | (intern (format "edebug-%s-interactive-p" edebug-def-name))) | |
1172 | ||
1173 | ||
1174 | (defun edebug-wrap-def-body (forms) | |
1175 | "Wrap the FORMS of a definition body." | |
1176 | (if edebug-def-interactive | |
d8f1319a GM |
1177 | `(let ((,(edebug-interactive-p-name) |
1178 | (interactive-p))) | |
1179 | ,(edebug-make-enter-wrapper forms)) | |
1fe3d507 DL |
1180 | (edebug-make-enter-wrapper forms))) |
1181 | ||
1182 | ||
1183 | (defun edebug-make-enter-wrapper (forms) | |
1184 | ;; Generate the enter wrapper for some forms of a definition. | |
1185 | ;; This is not to be used for the body of other forms, e.g. `while', | |
1186 | ;; since it wraps the list of forms with a call to `edebug-enter'. | |
1187 | ;; Uses the dynamically bound vars edebug-def-name and edebug-def-args. | |
1188 | ;; Do this after parsing since that may find a name. | |
a1506d29 | 1189 | (setq edebug-def-name |
f7359658 | 1190 | (or edebug-def-name edebug-old-def-name (edebug-gensym "edebug-anon"))) |
d8f1319a GM |
1191 | `(edebug-enter |
1192 | (quote ,edebug-def-name) | |
a1506d29 | 1193 | ,(if edebug-inside-func |
ebb4159c GM |
1194 | `(list |
1195 | ;; Doesn't work with more than one def-body!! | |
1196 | ;; But the list will just be reversed. | |
1197 | ,@(nreverse edebug-def-args)) | |
d8f1319a GM |
1198 | 'nil) |
1199 | (function (lambda () ,@forms)) | |
1200 | )) | |
1fe3d507 DL |
1201 | |
1202 | ||
1203 | (defvar edebug-form-begin-marker) ; the mark for def being instrumented | |
a1506d29 | 1204 | |
1fe3d507 DL |
1205 | (defvar edebug-offset-index) ; the next available offset index. |
1206 | (defvar edebug-offset-list) ; the list of offset positions. | |
1207 | ||
1208 | (defun edebug-inc-offset (offset) | |
1209 | ;; modifies edebug-offset-index and edebug-offset-list | |
1210 | ;; accesses edebug-func-marc and buffer point | |
1211 | (prog1 | |
1212 | edebug-offset-index | |
1213 | (setq edebug-offset-list (cons (- offset edebug-form-begin-marker) | |
1214 | edebug-offset-list) | |
1215 | edebug-offset-index (1+ edebug-offset-index)))) | |
1216 | ||
1217 | ||
1218 | (defun edebug-make-before-and-after-form (before-index form after-index) | |
1219 | ;; Return the edebug form for the current function at offset BEFORE-INDEX | |
a1506d29 | 1220 | ;; given FORM. Looks like: |
1fe3d507 DL |
1221 | ;; (edebug-after (edebug-before BEFORE-INDEX) AFTER-INDEX FORM) |
1222 | ;; Also increment the offset index for subsequent use. | |
a1506d29 | 1223 | (list 'edebug-after |
1fe3d507 DL |
1224 | (list 'edebug-before before-index) |
1225 | after-index form)) | |
1226 | ||
1227 | (defun edebug-make-after-form (form after-index) | |
1228 | ;; Like edebug-make-before-and-after-form, but only after. | |
1229 | (list 'edebug-after 0 after-index form)) | |
1230 | ||
1231 | ||
1232 | (defun edebug-unwrap (sexp) | |
1233 | "Return the unwrapped SEXP or return it as is if it is not wrapped. | |
a1506d29 | 1234 | The SEXP might be the result of wrapping a body, which is a list of |
1fe3d507 DL |
1235 | expressions; a `progn' form will be returned enclosing these forms." |
1236 | (if (consp sexp) | |
a1506d29 | 1237 | (cond |
1fe3d507 DL |
1238 | ((eq 'edebug-after (car sexp)) |
1239 | (nth 3 sexp)) | |
1240 | ((eq 'edebug-enter (car sexp)) | |
1241 | (let ((forms (nthcdr 2 (nth 1 (nth 3 sexp))))) | |
1242 | (if (> (length forms) 1) | |
1243 | (cons 'progn forms) ;; could return (values forms) instead. | |
1244 | (car forms)))) | |
1245 | (t sexp);; otherwise it is not wrapped, so just return it. | |
1246 | ) | |
1247 | sexp)) | |
1248 | ||
1249 | (defun edebug-unwrap* (sexp) | |
1250 | "Return the sexp recursively unwrapped." | |
1251 | (let ((new-sexp (edebug-unwrap sexp))) | |
1252 | (while (not (eq sexp new-sexp)) | |
1253 | (setq sexp new-sexp | |
1254 | new-sexp (edebug-unwrap sexp))) | |
1255 | (if (consp new-sexp) | |
1256 | (mapcar 'edebug-unwrap* new-sexp) | |
1257 | new-sexp))) | |
1258 | ||
1259 | ||
1260 | (defun edebug-defining-form (cursor form-begin form-end speclist) | |
1261 | ;; Process the defining form, starting outside the form. | |
1262 | ;; The speclist is a generated list spec that looks like: | |
1263 | ;; (("def-symbol" defining-form-spec-sans-&define)) | |
1264 | ;; Skip the first offset. | |
1265 | (edebug-set-cursor cursor (edebug-cursor-expressions cursor) | |
1266 | (cdr (edebug-cursor-offsets cursor))) | |
a1506d29 JB |
1267 | (edebug-make-form-wrapper |
1268 | cursor | |
1fe3d507 DL |
1269 | form-begin (1- form-end) |
1270 | speclist)) | |
1271 | ||
1272 | (defun edebug-make-form-wrapper (cursor form-begin form-end | |
1273 | &optional speclist) | |
1274 | ;; Wrap a form, usually a defining form, but any evaluated one. | |
1275 | ;; If speclist is non-nil, this is being called by edebug-defining-form. | |
1276 | ;; Otherwise it is being called from edebug-read-and-maybe-wrap-form1. | |
1277 | ;; This is a hack, but I havent figured out a simpler way yet. | |
1278 | (let* ((form-data-entry (edebug-get-form-data-entry form-begin form-end)) | |
1279 | ;; Set this marker before parsing. | |
a1506d29 JB |
1280 | (edebug-form-begin-marker |
1281 | (if form-data-entry | |
1fe3d507 DL |
1282 | (edebug-form-data-begin form-data-entry) |
1283 | ;; Buffer must be current-buffer for this to work: | |
1284 | (set-marker (make-marker) form-begin)))) | |
1285 | ||
1286 | (let (edebug-offset-list | |
1287 | (edebug-offset-index 0) | |
1288 | result | |
1289 | ;; For definitions. | |
1290 | ;; (edebug-containing-def-name edebug-def-name) | |
1291 | ;; Get name from form-data, if any. | |
1292 | (edebug-old-def-name (edebug-form-data-name form-data-entry)) | |
1293 | edebug-def-name | |
1294 | edebug-def-args | |
1295 | edebug-def-interactive | |
1296 | edebug-inside-func;; whether wrapped code executes inside a function. | |
1297 | ) | |
a1506d29 | 1298 | |
1fe3d507 DL |
1299 | (setq result |
1300 | (if speclist | |
1301 | (edebug-match cursor speclist) | |
1302 | ||
1303 | ;; else wrap as an enter-form. | |
1304 | (edebug-make-enter-wrapper (list (edebug-form cursor))))) | |
a1506d29 | 1305 | |
1fe3d507 | 1306 | ;; Set the name here if it was not set by edebug-make-enter-wrapper. |
a1506d29 | 1307 | (setq edebug-def-name |
f7359658 | 1308 | (or edebug-def-name edebug-old-def-name (edebug-gensym "edebug-anon"))) |
1fe3d507 DL |
1309 | |
1310 | ;; Add this def as a dependent of containing def. Buggy. | |
1311 | '(if (and edebug-containing-def-name | |
1312 | (not (get edebug-containing-def-name 'edebug-dependents))) | |
1313 | (put edebug-containing-def-name 'edebug-dependents | |
a1506d29 JB |
1314 | (cons edebug-def-name |
1315 | (get edebug-containing-def-name | |
1fe3d507 DL |
1316 | 'edebug-dependents)))) |
1317 | ||
1318 | ;; Create a form-data-entry or modify existing entry's markers. | |
1319 | ;; In the latter case, pointers to the entry remain eq. | |
1320 | (if (not form-data-entry) | |
a1506d29 | 1321 | (setq form-data-entry |
1fe3d507 | 1322 | (edebug-make-form-data-entry |
a1506d29 | 1323 | edebug-def-name |
1fe3d507 DL |
1324 | edebug-form-begin-marker |
1325 | ;; Buffer must be current-buffer. | |
1326 | (set-marker (make-marker) form-end) | |
1327 | )) | |
a1506d29 | 1328 | (edebug-set-form-data-entry |
1fe3d507 DL |
1329 | form-data-entry edebug-def-name ;; in case name is changed |
1330 | form-begin form-end)) | |
1331 | ||
1332 | ;; (message "defining: %s" edebug-def-name) (sit-for 2) | |
1333 | (edebug-make-top-form-data-entry form-data-entry) | |
1334 | (message "Edebug: %s" edebug-def-name) | |
1335 | ;;(debug edebug-def-name) | |
1336 | ||
1337 | ;; Destructively reverse edebug-offset-list and make vector from it. | |
1338 | (setq edebug-offset-list (vconcat (nreverse edebug-offset-list))) | |
1339 | ||
1340 | ;; Side effects on the property list of edebug-def-name. | |
1341 | (edebug-clear-frequency-count edebug-def-name) | |
1342 | (edebug-clear-coverage edebug-def-name) | |
1343 | ||
1344 | ;; Set up the initial window data. | |
1345 | (if (not edebug-top-window-data) ;; if not already set, do it now. | |
1346 | (let ((window ;; Find the best window for this buffer. | |
1347 | (or (get-buffer-window (current-buffer)) | |
1348 | (selected-window)))) | |
a1506d29 | 1349 | (setq edebug-top-window-data |
1fe3d507 DL |
1350 | (cons window (window-start window))))) |
1351 | ||
1352 | ;; Store the edebug data in symbol's property list. | |
1353 | (put edebug-def-name 'edebug | |
1354 | ;; A struct or vector would be better here!! | |
1355 | (list edebug-form-begin-marker | |
1356 | nil ; clear breakpoints | |
1357 | edebug-offset-list | |
1358 | edebug-top-window-data | |
1359 | )) | |
1360 | result | |
84fc2cfa ER |
1361 | ))) |
1362 | ||
1363 | ||
1fe3d507 DL |
1364 | (defun edebug-clear-frequency-count (name) |
1365 | ;; Create initial frequency count vector. | |
1366 | ;; For each stop point, the counter is incremented each time it is visited. | |
1367 | (put name 'edebug-freq-count | |
1368 | (make-vector (length edebug-offset-list) 0))) | |
1369 | ||
1370 | ||
1371 | (defun edebug-clear-coverage (name) | |
a1506d29 | 1372 | ;; Create initial coverage vector. |
1fe3d507 | 1373 | ;; Only need one per expression, but it is simpler to use stop points. |
a1506d29 | 1374 | (put name 'edebug-coverage |
1fe3d507 | 1375 | (make-vector (length edebug-offset-list) 'unknown))) |
84fc2cfa | 1376 | |
84fc2cfa | 1377 | |
1fe3d507 | 1378 | (defun edebug-form (cursor) |
a1506d29 | 1379 | ;; Return the instrumented form for the following form. |
1fe3d507 DL |
1380 | ;; Add the point offsets to the edebug-offset-list for the form. |
1381 | (let* ((form (edebug-top-element-required cursor "Expected form")) | |
1382 | (offset (edebug-top-offset cursor))) | |
1383 | (prog1 | |
84fc2cfa | 1384 | (cond |
1fe3d507 DL |
1385 | ((consp form) |
1386 | ;; The first offset for a list form is for the list form itself. | |
1387 | (if (eq 'quote (car form)) | |
1388 | form | |
1389 | (let* ((head (car form)) | |
1390 | (spec (and (symbolp head) (get-edebug-spec head))) | |
1391 | (new-cursor (edebug-new-cursor form offset))) | |
1392 | ;; Find out if this is a defining form from first symbol. | |
1393 | ;; An indirect spec would not work here, yet. | |
1394 | (if (and (consp spec) (eq '&define (car spec))) | |
a1506d29 JB |
1395 | (edebug-defining-form |
1396 | new-cursor | |
1fe3d507 | 1397 | (car offset);; before the form |
a1506d29 | 1398 | (edebug-after-offset cursor) |
1fe3d507 DL |
1399 | (cons (symbol-name head) (cdr spec))) |
1400 | ;; Wrap a regular form. | |
a1506d29 | 1401 | (edebug-make-before-and-after-form |
1fe3d507 DL |
1402 | (edebug-inc-offset (car offset)) |
1403 | (edebug-list-form new-cursor) | |
1404 | ;; After processing the list form, the new-cursor is left | |
1405 | ;; with the offset after the form. | |
1406 | (edebug-inc-offset (edebug-cursor-offsets new-cursor)))) | |
1407 | ))) | |
1408 | ||
1409 | ((symbolp form) | |
1410 | (cond | |
f7359658 | 1411 | ;; Check for constant symbols that don't get wrapped. |
1fe3d507 | 1412 | ((or (memq form '(t nil)) |
be0dd657 | 1413 | (keywordp form)) |
1fe3d507 DL |
1414 | form) |
1415 | ||
1fe3d507 DL |
1416 | (t ;; just a variable |
1417 | (edebug-make-after-form form (edebug-inc-offset (cdr offset)))))) | |
1418 | ||
1419 | ;; Anything else is self-evaluating. | |
1420 | (t form)) | |
1421 | (edebug-move-cursor cursor)))) | |
1422 | ||
1423 | ||
1424 | (defsubst edebug-forms (cursor) (edebug-match cursor '(&rest form))) | |
1425 | (defsubst edebug-sexps (cursor) (edebug-match cursor '(&rest sexp))) | |
1426 | ||
1427 | (defsubst edebug-list-form-args (head cursor) | |
1428 | ;; Process the arguments of a list form given that head of form is a symbol. | |
1429 | ;; Helper for edebug-list-form | |
1430 | (let ((spec (get-edebug-spec head))) | |
1431 | (cond | |
1432 | (spec | |
1433 | (cond | |
1434 | ((consp spec) | |
1435 | ;; It is a speclist. | |
1436 | (let (edebug-best-error | |
1437 | edebug-error-point);; This may not be needed. | |
1438 | (edebug-match-sublist cursor spec))) | |
1439 | ((eq t spec) (edebug-forms cursor)) | |
1440 | ((eq 0 spec) (edebug-sexps cursor)) | |
1441 | ((symbolp spec) (funcall spec cursor));; Not used by edebug, | |
1442 | ; but leave it in for compatibility. | |
1443 | )) | |
1444 | ;; No edebug-form-spec provided. | |
1445 | ((edebug-macrop head) | |
1446 | (if edebug-eval-macro-args | |
1447 | (edebug-forms cursor) | |
1448 | (edebug-sexps cursor))) | |
1449 | (t ;; Otherwise it is a function call. | |
1450 | (edebug-forms cursor))))) | |
1451 | ||
1452 | ||
1453 | (defun edebug-list-form (cursor) | |
1454 | ;; Return an instrumented form built from the list form. | |
1455 | ;; The after offset will be left in the cursor after processing the form. | |
1456 | (let ((head (edebug-top-element-required cursor "Expected elements")) | |
1457 | ;; Prevent backtracking whenever instrumenting. | |
1458 | (edebug-gate t) | |
1459 | ;; A list form is never optional because it matches anything. | |
1460 | (edebug-&optional nil) | |
1461 | (edebug-&rest nil)) | |
1462 | ;; Skip the first offset. | |
1463 | (edebug-set-cursor cursor (edebug-cursor-expressions cursor) | |
1464 | (cdr (edebug-cursor-offsets cursor))) | |
1465 | (cond | |
1fe3d507 DL |
1466 | ((symbolp head) |
1467 | (cond | |
d778509c | 1468 | ((null head) nil) ; () is legal. |
1fe3d507 DL |
1469 | ((eq head 'interactive-p) |
1470 | ;; Special case: replace (interactive-p) with variable | |
1471 | (setq edebug-def-interactive 'check-it) | |
1472 | (edebug-move-cursor cursor) | |
1473 | (edebug-interactive-p-name)) | |
1474 | (t | |
a1506d29 | 1475 | (cons head (edebug-list-form-args |
1fe3d507 DL |
1476 | head (edebug-move-cursor cursor)))))) |
1477 | ||
1478 | ((consp head) | |
d778509c SM |
1479 | (if (eq (car head) ',) |
1480 | ;; The head of a form should normally be a symbol or a lambda | |
1481 | ;; expression but it can also be an unquote form to be filled | |
1482 | ;; before evaluation. We evaluate the arguments anyway, on the | |
1483 | ;; assumption that the unquote form will place a proper function | |
1484 | ;; name (rather than a macro name). | |
1fe3d507 DL |
1485 | (edebug-match cursor '(("," def-form) body)) |
1486 | ;; Process anonymous function and args. | |
1487 | ;; This assumes no anonymous macros. | |
1488 | (edebug-match-specs cursor '(lambda-expr body) 'edebug-match-specs))) | |
1489 | ||
1490 | (t (edebug-syntax-error | |
d778509c | 1491 | "Head of list form must be a symbol or lambda expression"))) |
1fe3d507 DL |
1492 | )) |
1493 | ||
f7359658 | 1494 | ;;; Matching of specs. |
1fe3d507 DL |
1495 | |
1496 | (defvar edebug-after-dotted-spec nil) | |
1497 | ||
1498 | (defvar edebug-matching-depth 0) ;; initial value | |
1499 | (defconst edebug-max-depth 150) ;; maximum number of matching recursions. | |
1500 | ||
1501 | ||
a1506d29 | 1502 | ;;; Failure to match |
f7359658 | 1503 | |
1fe3d507 DL |
1504 | ;; This throws to no-match, if there are higher alternatives. |
1505 | ;; Otherwise it signals an error. The place of the error is found | |
1506 | ;; with the two before- and after-offset functions. | |
1507 | ||
1508 | (defun edebug-no-match (cursor &rest edebug-args) | |
1509 | ;; Throw a no-match, or signal an error immediately if gate is active. | |
1510 | ;; Remember this point in case we need to report this error. | |
1511 | (setq edebug-error-point (or edebug-error-point | |
1512 | (edebug-before-offset cursor)) | |
1513 | edebug-best-error (or edebug-best-error edebug-args)) | |
1514 | (if (and edebug-gate (not edebug-&optional)) | |
1515 | (progn | |
1516 | (if edebug-error-point | |
1517 | (goto-char edebug-error-point)) | |
1518 | (apply 'edebug-syntax-error edebug-args)) | |
1519 | (funcall 'throw 'no-match edebug-args))) | |
1520 | ||
1521 | ||
1522 | (defun edebug-match (cursor specs) | |
1523 | ;; Top level spec matching function. | |
1524 | ;; Used also at each lower level of specs. | |
1525 | (let (edebug-&optional | |
1526 | edebug-&rest | |
1527 | edebug-best-error | |
1528 | edebug-error-point | |
1529 | (edebug-gate edebug-gate) ;; locally bound to limit effect | |
1530 | ) | |
1531 | (edebug-match-specs cursor specs 'edebug-match-specs))) | |
1532 | ||
1533 | ||
1534 | (defun edebug-match-one-spec (cursor spec) | |
1535 | ;; Match one spec, which is not a keyword &-spec. | |
1536 | (cond | |
1537 | ((symbolp spec) (edebug-match-symbol cursor spec)) | |
1538 | ((vectorp spec) (edebug-match cursor (append spec nil))) | |
1539 | ((stringp spec) (edebug-match-string cursor spec)) | |
1540 | ((listp spec) (edebug-match-list cursor spec)) | |
1541 | )) | |
1542 | ||
1543 | ||
1544 | (defun edebug-match-specs (cursor specs remainder-handler) | |
1545 | ;; Append results of matching the list of specs. | |
1546 | ;; The first spec is handled and the remainder-handler handles the rest. | |
a1506d29 | 1547 | (let ((edebug-matching-depth |
1fe3d507 DL |
1548 | (if (> edebug-matching-depth edebug-max-depth) |
1549 | (error "too deep - perhaps infinite loop in spec?") | |
1550 | (1+ edebug-matching-depth)))) | |
1551 | (cond | |
1552 | ((null specs) nil) | |
a1506d29 | 1553 | |
1fe3d507 | 1554 | ;; Is the spec dotted? |
a1506d29 | 1555 | ((atom specs) |
1fe3d507 DL |
1556 | (let ((edebug-dotted-spec t));; Containing spec list was dotted. |
1557 | (edebug-match-specs cursor (list specs) remainder-handler))) | |
1558 | ||
1559 | ;; Is the form dotted? | |
1560 | ((not (listp (edebug-cursor-expressions cursor)));; allow nil | |
1561 | (if (not edebug-dotted-spec) | |
1562 | (edebug-no-match cursor "Dotted spec required.")) | |
1563 | ;; Cancel dotted spec and dotted form. | |
1564 | (let ((edebug-dotted-spec) | |
1565 | (this-form (edebug-cursor-expressions cursor)) | |
1566 | (this-offset (edebug-cursor-offsets cursor))) | |
1567 | ;; Wrap the form in a list, (by changing the cursor??)... | |
1568 | (edebug-set-cursor cursor (list this-form) this-offset) | |
1569 | ;; and process normally, then unwrap the result. | |
1570 | (car (edebug-match-specs cursor specs remainder-handler)))) | |
1571 | ||
1572 | (t;; Process normally. | |
1573 | (let* ((spec (car specs)) | |
a1506d29 | 1574 | (rest) |
1fe3d507 DL |
1575 | (first-char (and (symbolp spec) (aref (symbol-name spec) 0)))) |
1576 | ;;(message "spec = %s first char = %s" spec first-char) (sit-for 1) | |
1577 | (nconc | |
1578 | (cond | |
1579 | ((eq ?& first-char);; "&" symbols take all following specs. | |
1580 | (funcall (get-edebug-spec spec) cursor (cdr specs))) | |
1581 | ((eq ?: first-char);; ":" symbols take one following spec. | |
1582 | (setq rest (cdr (cdr specs))) | |
1583 | (funcall (get-edebug-spec spec) cursor (car (cdr specs)))) | |
1584 | (t;; Any other normal spec. | |
1585 | (setq rest (cdr specs)) | |
1586 | (edebug-match-one-spec cursor spec))) | |
1587 | (funcall remainder-handler cursor rest remainder-handler))))))) | |
1588 | ||
1589 | ||
1590 | ;; Define specs for all the symbol specs with functions used to process them. | |
f7359658 | 1591 | ;; Perhaps we shouldn't be doing this with edebug-form-specs since the |
1fe3d507 DL |
1592 | ;; user may want to define macros or functions with the same names. |
1593 | ;; We could use an internal obarray for these primitive specs. | |
1594 | ||
f71974e1 SM |
1595 | (dolist (pair '((&optional . edebug-match-&optional) |
1596 | (&rest . edebug-match-&rest) | |
1597 | (&or . edebug-match-&or) | |
1598 | (form . edebug-match-form) | |
1599 | (sexp . edebug-match-sexp) | |
1600 | (body . edebug-match-body) | |
1601 | (&define . edebug-match-&define) | |
1602 | (name . edebug-match-name) | |
1603 | (:name . edebug-match-colon-name) | |
1604 | (arg . edebug-match-arg) | |
1605 | (def-body . edebug-match-def-body) | |
1606 | (def-form . edebug-match-def-form) | |
1607 | ;; Less frequently used: | |
1608 | ;; (function . edebug-match-function) | |
1609 | (lambda-expr . edebug-match-lambda-expr) | |
1610 | (¬ . edebug-match-¬) | |
1611 | (&key . edebug-match-&key) | |
1612 | (place . edebug-match-place) | |
1613 | (gate . edebug-match-gate) | |
1614 | ;; (nil . edebug-match-nil) not this one - special case it. | |
1615 | )) | |
1616 | (put (car pair) 'edebug-form-spec (cdr pair))) | |
1fe3d507 DL |
1617 | |
1618 | (defun edebug-match-symbol (cursor symbol) | |
1619 | ;; Match a symbol spec. | |
1620 | (let* ((spec (get-edebug-spec symbol))) | |
1621 | (cond | |
a1506d29 | 1622 | (spec |
1fe3d507 DL |
1623 | (if (consp spec) |
1624 | ;; It is an indirect spec. | |
1625 | (edebug-match cursor spec) | |
1626 | ;; Otherwise it should be the symbol name of a function. | |
1627 | ;; There could be a bug here - maybe need to do edebug-match bindings. | |
1628 | (funcall spec cursor))) | |
a1506d29 | 1629 | |
1fe3d507 DL |
1630 | ((null symbol) ;; special case this. |
1631 | (edebug-match-nil cursor)) | |
1632 | ||
a1506d29 | 1633 | ((fboundp symbol) ; is it a predicate? |
1fe3d507 DL |
1634 | (let ((sexp (edebug-top-element-required cursor "Expected" symbol))) |
1635 | ;; Special case for edebug-`. | |
1636 | (if (and (listp sexp) (eq (car sexp) ',)) | |
1637 | (edebug-match cursor '(("," def-form))) | |
1638 | (if (not (funcall symbol sexp)) | |
1639 | (edebug-no-match cursor symbol "failed")) | |
1640 | (edebug-move-cursor cursor) | |
1641 | (list sexp)))) | |
1642 | (t (error "%s is not a form-spec or function" symbol)) | |
1643 | ))) | |
1644 | ||
1645 | ||
1646 | (defun edebug-match-sexp (cursor) | |
1647 | (list (prog1 (edebug-top-element-required cursor "Expected sexp") | |
1648 | (edebug-move-cursor cursor)))) | |
1649 | ||
1650 | (defun edebug-match-form (cursor) | |
1651 | (list (edebug-form cursor))) | |
1652 | ||
1653 | (defalias 'edebug-match-place 'edebug-match-form) | |
1654 | ;; Currently identical to edebug-match-form. | |
1655 | ;; This is for common lisp setf-style place arguments. | |
1656 | ||
1657 | (defsubst edebug-match-body (cursor) (edebug-forms cursor)) | |
1658 | ||
1659 | (defun edebug-match-&optional (cursor specs) | |
1660 | ;; Keep matching until one spec fails. | |
1661 | (edebug-&optional-wrapper cursor specs 'edebug-&optional-wrapper)) | |
1662 | ||
1663 | (defun edebug-&optional-wrapper (cursor specs remainder-handler) | |
1664 | (let (result | |
1665 | (edebug-&optional specs) | |
1666 | (edebug-gate nil) | |
1667 | (this-form (edebug-cursor-expressions cursor)) | |
1668 | (this-offset (edebug-cursor-offsets cursor))) | |
1669 | (if (null (catch 'no-match | |
1670 | (setq result | |
1671 | (edebug-match-specs cursor specs remainder-handler)) | |
1672 | ;; Returning nil means no no-match was thrown. | |
1673 | nil)) | |
1674 | result | |
1675 | ;; no-match, but don't fail; just reset cursor and return nil. | |
1676 | (edebug-set-cursor cursor this-form this-offset) | |
1677 | nil))) | |
1678 | ||
1679 | ||
1680 | (defun edebug-&rest-wrapper (cursor specs remainder-handler) | |
1681 | (if (null specs) (setq specs edebug-&rest)) | |
1682 | ;; Reuse the &optional handler with this as the remainder handler. | |
1683 | (edebug-&optional-wrapper cursor specs remainder-handler)) | |
a1506d29 | 1684 | |
1fe3d507 DL |
1685 | (defun edebug-match-&rest (cursor specs) |
1686 | ;; Repeatedly use specs until failure. | |
1687 | (let ((edebug-&rest specs) ;; remember these | |
1688 | edebug-best-error | |
1689 | edebug-error-point) | |
1690 | (edebug-&rest-wrapper cursor specs 'edebug-&rest-wrapper))) | |
1691 | ||
1692 | ||
1693 | (defun edebug-match-&or (cursor specs) | |
1694 | ;; Keep matching until one spec succeeds, and return its results. | |
1695 | ;; If none match, fail. | |
1696 | ;; This needs to be optimized since most specs spend time here. | |
1697 | (let ((original-specs specs) | |
1698 | (this-form (edebug-cursor-expressions cursor)) | |
1699 | (this-offset (edebug-cursor-offsets cursor))) | |
1700 | (catch 'matched | |
1701 | (while specs | |
1702 | (catch 'no-match | |
1703 | (throw 'matched | |
1704 | (let (edebug-gate ;; only while matching each spec | |
1705 | edebug-best-error | |
1706 | edebug-error-point) | |
f7359658 | 1707 | ;; Doesn't support e.g. &or symbolp &rest form |
1fe3d507 DL |
1708 | (edebug-match-one-spec cursor (car specs))))) |
1709 | ;; Match failed, so reset and try again. | |
1710 | (setq specs (cdr specs)) | |
1711 | ;; Reset the cursor for the next match. | |
1712 | (edebug-set-cursor cursor this-form this-offset)) | |
1713 | ;; All failed. | |
1714 | (apply 'edebug-no-match cursor "Expected one of" original-specs)) | |
84fc2cfa ER |
1715 | )) |
1716 | ||
1717 | ||
1fe3d507 DL |
1718 | (defun edebug-match-¬ (cursor specs) |
1719 | ;; If any specs match, then fail | |
1720 | (if (null (catch 'no-match | |
1721 | (let ((edebug-gate nil)) | |
1722 | (save-excursion | |
1723 | (edebug-match-&or cursor specs))) | |
1724 | nil)) | |
1725 | ;; This means something matched, so it is a no match. | |
1726 | (edebug-no-match cursor "Unexpected")) | |
1727 | ;; This means nothing matched, so it is OK. | |
1728 | nil) ;; So, return nothing | |
a1506d29 | 1729 | |
1fe3d507 DL |
1730 | |
1731 | (def-edebug-spec &key edebug-match-&key) | |
1732 | ||
1733 | (defun edebug-match-&key (cursor specs) | |
1734 | ;; Following specs must look like (<name> <spec>) ... | |
1735 | ;; where <name> is the name of a keyword, and spec is its spec. | |
f7359658 | 1736 | ;; This really doesn't save much over the expanded form and takes time. |
a1506d29 | 1737 | (edebug-match-&rest |
1fe3d507 | 1738 | cursor |
a1506d29 | 1739 | (cons '&or |
1fe3d507 | 1740 | (mapcar (function (lambda (pair) |
a1506d29 | 1741 | (vector (format ":%s" (car pair)) |
1fe3d507 DL |
1742 | (car (cdr pair))))) |
1743 | specs)))) | |
1744 | ||
1745 | ||
1746 | (defun edebug-match-gate (cursor) | |
1747 | ;; Simply set the gate to prevent backtracking at this level. | |
1748 | (setq edebug-gate t) | |
1749 | nil) | |
1750 | ||
1751 | ||
1752 | (defun edebug-match-list (cursor specs) | |
1753 | ;; The spec is a list, but what kind of list, and what context? | |
1754 | (if edebug-dotted-spec | |
a1506d29 | 1755 | ;; After dotted spec but form did not contain dot, |
1fe3d507 DL |
1756 | ;; so match list spec elements as if spliced in. |
1757 | (prog1 | |
1758 | (let ((edebug-dotted-spec)) | |
1759 | (edebug-match-specs cursor specs 'edebug-match-specs)) | |
1760 | ;; If it matched, really clear the dotted-spec flag. | |
1761 | (setq edebug-dotted-spec nil)) | |
1762 | (let ((spec (car specs)) | |
1763 | (form (edebug-top-element-required cursor "Expected" specs))) | |
1764 | (cond | |
1765 | ((eq 'quote spec) | |
1766 | (let ((spec (car (cdr specs)))) | |
1767 | (cond | |
1768 | ((symbolp spec) | |
1769 | ;; Special case: spec quotes a symbol to match. | |
1770 | ;; Change in future. Use "..." instead. | |
1771 | (if (not (eq spec form)) | |
1772 | (edebug-no-match cursor "Expected" spec)) | |
1773 | (edebug-move-cursor cursor) | |
1774 | (setq edebug-gate t) | |
1775 | form) | |
a1506d29 | 1776 | (t |
1fe3d507 DL |
1777 | (error "Bad spec: %s" specs))))) |
1778 | ||
1779 | ((listp form) | |
1780 | (prog1 | |
a1506d29 | 1781 | (list (edebug-match-sublist |
1fe3d507 DL |
1782 | ;; First offset is for the list form itself. |
1783 | ;; Treat nil as empty list. | |
a1506d29 | 1784 | (edebug-new-cursor form (cdr (edebug-top-offset cursor))) |
1fe3d507 DL |
1785 | specs)) |
1786 | (edebug-move-cursor cursor))) | |
1787 | ||
1788 | ((and (eq 'vector spec) (vectorp form)) | |
1789 | ;; Special case: match a vector with the specs. | |
1790 | (let ((result (edebug-match-sublist | |
a1506d29 | 1791 | (edebug-new-cursor |
1fe3d507 DL |
1792 | form (cdr (edebug-top-offset cursor))) |
1793 | (cdr specs)))) | |
1794 | (edebug-move-cursor cursor) | |
1795 | (list (apply 'vector result)))) | |
a1506d29 | 1796 | |
1fe3d507 DL |
1797 | (t (edebug-no-match cursor "Expected" specs))) |
1798 | ))) | |
84fc2cfa ER |
1799 | |
1800 | ||
1fe3d507 DL |
1801 | (defun edebug-match-sublist (cursor specs) |
1802 | ;; Match a sublist of specs. | |
1803 | (let (edebug-&optional | |
1804 | ;;edebug-best-error | |
1805 | ;;edebug-error-point | |
1806 | ) | |
a1506d29 | 1807 | (prog1 |
1fe3d507 DL |
1808 | ;; match with edebug-match-specs so edebug-best-error is not bound. |
1809 | (edebug-match-specs cursor specs 'edebug-match-specs) | |
1810 | (if (not (edebug-empty-cursor cursor)) | |
a1506d29 | 1811 | (if edebug-best-error |
1fe3d507 DL |
1812 | (apply 'edebug-no-match cursor edebug-best-error) |
1813 | ;; A failed &rest or &optional spec may leave some args. | |
1814 | (edebug-no-match cursor "Failed matching" specs) | |
1815 | ))))) | |
1816 | ||
1817 | ||
1818 | (defun edebug-match-string (cursor spec) | |
1819 | (let ((sexp (edebug-top-element-required cursor "Expected" spec))) | |
1820 | (if (not (eq (intern spec) sexp)) | |
1821 | (edebug-no-match cursor "Expected" spec) | |
1822 | ;; Since it matched, failure means immediate error, unless &optional. | |
1823 | (setq edebug-gate t) | |
1824 | (edebug-move-cursor cursor) | |
1825 | (list sexp) | |
1826 | ))) | |
84fc2cfa | 1827 | |
1fe3d507 DL |
1828 | (defun edebug-match-nil (cursor) |
1829 | ;; There must be nothing left to match a nil. | |
1830 | (if (not (edebug-empty-cursor cursor)) | |
1831 | (edebug-no-match cursor "Unmatched argument(s)") | |
1832 | nil)) | |
1833 | ||
1834 | ||
1835 | (defun edebug-match-function (cursor) | |
1836 | (error "Use function-form instead of function in edebug spec")) | |
1837 | ||
1838 | (defun edebug-match-&define (cursor specs) | |
1839 | ;; Match a defining form. | |
f7359658 | 1840 | ;; Normally, &define is interpreted specially other places. |
1fe3d507 DL |
1841 | ;; This should only be called inside of a spec list to match the remainder |
1842 | ;; of the current list. e.g. ("lambda" &define args def-body) | |
1843 | (edebug-make-form-wrapper | |
a1506d29 | 1844 | cursor |
1fe3d507 DL |
1845 | (edebug-before-offset cursor) |
1846 | ;; Find the last offset in the list. | |
1847 | (let ((offsets (edebug-cursor-offsets cursor))) | |
1848 | (while (consp offsets) (setq offsets (cdr offsets))) | |
1849 | offsets) | |
1850 | specs)) | |
1851 | ||
1852 | (defun edebug-match-lambda-expr (cursor) | |
1853 | ;; The expression must be a function. | |
1854 | ;; This will match any list form that begins with a symbol | |
1855 | ;; that has an edebug-form-spec beginning with &define. In | |
a1506d29 | 1856 | ;; practice, only lambda expressions should be used. |
1fe3d507 | 1857 | ;; I could add a &lambda specification to avoid confusion. |
a1506d29 | 1858 | (let* ((sexp (edebug-top-element-required |
1fe3d507 DL |
1859 | cursor "Expected lambda expression")) |
1860 | (offset (edebug-top-offset cursor)) | |
1861 | (head (and (consp sexp) (car sexp))) | |
1862 | (spec (and (symbolp head) (get-edebug-spec head))) | |
1863 | (edebug-inside-func nil)) | |
1864 | ;; Find out if this is a defining form from first symbol. | |
1865 | (if (and (consp spec) (eq '&define (car spec))) | |
1866 | (prog1 | |
1867 | (list | |
a1506d29 | 1868 | (edebug-defining-form |
1fe3d507 DL |
1869 | (edebug-new-cursor sexp offset) |
1870 | (car offset);; before the sexp | |
a1506d29 | 1871 | (edebug-after-offset cursor) |
1fe3d507 DL |
1872 | (cons (symbol-name head) (cdr spec)))) |
1873 | (edebug-move-cursor cursor)) | |
1874 | (edebug-no-match cursor "Expected lambda expression") | |
1875 | ))) | |
84fc2cfa | 1876 | |
84fc2cfa | 1877 | |
1fe3d507 DL |
1878 | (defun edebug-match-name (cursor) |
1879 | ;; Set the edebug-def-name bound in edebug-defining-form. | |
1880 | (let ((name (edebug-top-element-required cursor "Expected name"))) | |
1881 | ;; Maybe strings and numbers could be used. | |
1882 | (if (not (symbolp name)) | |
1883 | (edebug-no-match cursor "Symbol expected for name of definition")) | |
1884 | (setq edebug-def-name | |
1885 | (if edebug-def-name | |
1886 | ;; Construct a new name by appending to previous name. | |
1887 | (intern (format "%s@%s" edebug-def-name name)) | |
1888 | name)) | |
1889 | (edebug-move-cursor cursor) | |
1890 | (list name))) | |
1891 | ||
1892 | (defun edebug-match-colon-name (cursor spec) | |
1893 | ;; Set the edebug-def-name to the spec. | |
1894 | (setq edebug-def-name | |
1895 | (if edebug-def-name | |
1896 | ;; Construct a new name by appending to previous name. | |
1897 | (intern (format "%s@%s" edebug-def-name spec)) | |
1898 | spec)) | |
1899 | nil) | |
1900 | ||
1901 | (defun edebug-match-arg (cursor) | |
1902 | ;; set the def-args bound in edebug-defining-form | |
1903 | (let ((edebug-arg (edebug-top-element-required cursor "Expected arg"))) | |
1904 | (if (or (not (symbolp edebug-arg)) | |
f7359658 | 1905 | (edebug-lambda-list-keywordp edebug-arg)) |
1fe3d507 DL |
1906 | (edebug-no-match cursor "Bad argument:" edebug-arg)) |
1907 | (edebug-move-cursor cursor) | |
1908 | (setq edebug-def-args (cons edebug-arg edebug-def-args)) | |
1909 | (list edebug-arg))) | |
1910 | ||
1911 | (defun edebug-match-def-form (cursor) | |
1912 | ;; Like form but the form is wrapped in edebug-enter form. | |
1913 | ;; The form is assumed to be executing outside of the function context. | |
1914 | ;; This is a hack for now, since a def-form might execute inside as well. | |
1915 | ;; Not to be used otherwise. | |
1916 | (let ((edebug-inside-func nil)) | |
1917 | (list (edebug-make-enter-wrapper (list (edebug-form cursor)))))) | |
1918 | ||
1919 | (defun edebug-match-def-body (cursor) | |
1920 | ;; Like body but body is wrapped in edebug-enter form. | |
1921 | ;; The body is assumed to be executing inside of the function context. | |
1922 | ;; Not to be used otherwise. | |
1923 | (let ((edebug-inside-func t)) | |
1924 | (list (edebug-wrap-def-body (edebug-forms cursor))))) | |
1925 | ||
1926 | ||
1927 | ;;;; Edebug Form Specs | |
1928 | ;;; ========================================================== | |
1929 | ;;; See cl-specs.el for common lisp specs. | |
1930 | ||
1931 | ;;;;* Spec for def-edebug-spec | |
1932 | ;;; Out of date. | |
1933 | ||
1934 | (defun edebug-spec-p (object) | |
1935 | "Return non-nil if OBJECT is a symbol with an edebug-form-spec property." | |
1936 | (and (symbolp object) | |
1937 | (get object 'edebug-form-spec))) | |
1938 | ||
1939 | (def-edebug-spec def-edebug-spec | |
1940 | ;; Top level is different from lower levels. | |
f71974e1 | 1941 | (&define :name edebug-spec name |
1fe3d507 DL |
1942 | &or "nil" edebug-spec-p "t" "0" (&rest edebug-spec))) |
1943 | ||
1944 | (def-edebug-spec edebug-spec-list | |
1945 | ;; A list must have something in it, or it is nil, a symbolp | |
1946 | ((edebug-spec . [&or nil edebug-spec]))) | |
1947 | ||
1948 | (def-edebug-spec edebug-spec | |
1949 | (&or | |
1950 | (vector &rest edebug-spec) ; matches a vector | |
1951 | ("vector" &rest edebug-spec) ; matches a vector spec | |
1952 | ("quote" symbolp) | |
1953 | edebug-spec-list | |
1954 | stringp | |
f7359658 | 1955 | [edebug-lambda-list-keywordp &rest edebug-spec] |
be0dd657 | 1956 | [keywordp gate edebug-spec] |
1fe3d507 DL |
1957 | edebug-spec-p ;; Including all the special ones e.g. form. |
1958 | symbolp;; a predicate | |
1959 | )) | |
84fc2cfa ER |
1960 | |
1961 | ||
f7359658 | 1962 | ;;;* Emacs special forms and some functions. |
84fc2cfa | 1963 | |
1fe3d507 DL |
1964 | ;; quote expects only one argument, although it allows any number. |
1965 | (def-edebug-spec quote sexp) | |
84fc2cfa | 1966 | |
1fe3d507 DL |
1967 | ;; The standard defining forms. |
1968 | (def-edebug-spec defconst defvar) | |
1969 | (def-edebug-spec defvar (symbolp &optional form stringp)) | |
84fc2cfa | 1970 | |
1fe3d507 DL |
1971 | (def-edebug-spec defun |
1972 | (&define name lambda-list | |
1973 | [&optional stringp] | |
1974 | [&optional ("interactive" interactive)] | |
1975 | def-body)) | |
1976 | (def-edebug-spec defmacro | |
5121ef4c | 1977 | (&define name lambda-list [&optional ("declare" &rest sexp)] def-body)) |
84fc2cfa | 1978 | |
f7359658 | 1979 | (def-edebug-spec arglist lambda-list) ;; deprecated - use lambda-list. |
84fc2cfa | 1980 | |
1fe3d507 DL |
1981 | (def-edebug-spec lambda-list |
1982 | (([&rest arg] | |
1983 | [&optional ["&optional" arg &rest arg]] | |
1984 | &optional ["&rest" arg] | |
1985 | ))) | |
84fc2cfa | 1986 | |
1fe3d507 DL |
1987 | (def-edebug-spec interactive |
1988 | (&optional &or stringp def-form)) | |
84fc2cfa | 1989 | |
1fe3d507 DL |
1990 | ;; A function-form is for an argument that may be a function or a form. |
1991 | ;; This specially recognizes anonymous functions quoted with quote. | |
1992 | (def-edebug-spec function-form | |
1993 | ;; form at the end could also handle "function", | |
1994 | ;; but recognize it specially to avoid wrapping function forms. | |
1995 | (&or ([&or "quote" "function"] &or symbolp lambda-expr) form)) | |
84fc2cfa | 1996 | |
1fe3d507 DL |
1997 | ;; function expects a symbol or a lambda or macro expression |
1998 | ;; A macro is allowed by Emacs. | |
1999 | (def-edebug-spec function (&or symbolp lambda-expr)) | |
84fc2cfa | 2000 | |
1fe3d507 DL |
2001 | ;; lambda is a macro in emacs 19. |
2002 | (def-edebug-spec lambda (&define lambda-list | |
2003 | [&optional stringp] | |
2004 | [&optional ("interactive" interactive)] | |
2005 | def-body)) | |
2006 | ||
2007 | ;; A macro expression is a lambda expression with "macro" prepended. | |
2008 | (def-edebug-spec macro (&define "lambda" lambda-list def-body)) | |
2009 | ||
2010 | ;; (def-edebug-spec anonymous-form ((&or ["lambda" lambda] ["macro" macro]))) | |
2011 | ||
2012 | ;; Standard functions that take function-forms arguments. | |
2013 | (def-edebug-spec mapcar (function-form form)) | |
2014 | (def-edebug-spec mapconcat (function-form form form)) | |
2015 | (def-edebug-spec mapatoms (function-form &optional form)) | |
2016 | (def-edebug-spec apply (function-form &rest form)) | |
2017 | (def-edebug-spec funcall (function-form &rest form)) | |
2018 | ||
2019 | (def-edebug-spec let | |
2020 | ((&rest &or (symbolp &optional form) symbolp) | |
2021 | body)) | |
2022 | ||
2023 | (def-edebug-spec let* let) | |
2024 | ||
2025 | (def-edebug-spec setq (&rest symbolp form)) | |
2026 | (def-edebug-spec setq-default setq) | |
2027 | ||
2028 | (def-edebug-spec cond (&rest (&rest form))) | |
2029 | ||
2030 | (def-edebug-spec condition-case | |
2031 | (symbolp | |
2032 | form | |
284795f8 | 2033 | &rest ([&or symbolp (&rest symbolp)] body))) |
1fe3d507 DL |
2034 | |
2035 | ||
f7359658 | 2036 | (def-edebug-spec \` (backquote-form)) |
1fe3d507 | 2037 | |
a1506d29 | 2038 | ;; Supports quotes inside backquotes, |
1fe3d507 DL |
2039 | ;; but only at the top level inside unquotes. |
2040 | (def-edebug-spec backquote-form | |
2041 | (&or | |
2042 | ([&or "," ",@"] &or ("quote" backquote-form) form) | |
d778509c SM |
2043 | ;; The simple version: |
2044 | ;; (backquote-form &rest backquote-form) | |
2045 | ;; doesn't handle (a . ,b). The straightforward fix: | |
2046 | ;; (backquote-form . [&or nil backquote-form]) | |
2047 | ;; uses up too much stack space. | |
2048 | ;; Note that `(foo . ,@bar) is not legal, so we don't need to handle it. | |
2049 | (backquote-form [&rest [¬ ","] backquote-form] | |
2050 | . [&or nil backquote-form]) | |
1fe3d507 DL |
2051 | ;; If you use dotted forms in backquotes, replace the previous line |
2052 | ;; with the following. This takes quite a bit more stack space, however. | |
2053 | ;; (backquote-form . [&or nil backquote-form]) | |
2054 | (vector &rest backquote-form) | |
2055 | sexp)) | |
84fc2cfa | 2056 | |
1fe3d507 DL |
2057 | ;; Special version of backquote that instruments backquoted forms |
2058 | ;; destined to be evaluated, usually as the result of a | |
2059 | ;; macroexpansion. Backquoted code can only have unquotes (, and ,@) | |
2060 | ;; in places where list forms are allowed, and predicates. If the | |
2061 | ;; backquote is used in a macro, unquoted code that come from | |
2062 | ;; arguments must be instrumented, if at all, with def-form not def-body. | |
84fc2cfa | 2063 | |
1fe3d507 DL |
2064 | ;; We could assume that all forms (not nested in other forms) |
2065 | ;; in arguments of macros should be def-forms, whether or not the macros | |
2066 | ;; are defined with edebug-` but this would be expensive. | |
84fc2cfa | 2067 | |
1fe3d507 DL |
2068 | ;; ,@ might have some problems. |
2069 | ||
f7359658 RS |
2070 | (defalias 'edebug-\` '\`) ;; same macro as regular backquote. |
2071 | (def-edebug-spec edebug-\` (def-form)) | |
1fe3d507 DL |
2072 | |
2073 | ;; Assume immediate quote in unquotes mean backquote at next higher level. | |
99edd7ed | 2074 | (def-edebug-spec , (&or ("quote" edebug-\`) def-form)) |
1fe3d507 | 2075 | (def-edebug-spec ,@ (&define ;; so (,@ form) is never wrapped. |
99edd7ed | 2076 | &or ("quote" edebug-\`) def-form)) |
1fe3d507 DL |
2077 | |
2078 | ;; New byte compiler. | |
2079 | (def-edebug-spec defsubst defun) | |
2080 | (def-edebug-spec dont-compile t) | |
2081 | (def-edebug-spec eval-when-compile t) | |
2082 | (def-edebug-spec eval-and-compile t) | |
2083 | ||
8fd29408 RS |
2084 | (def-edebug-spec save-selected-window t) |
2085 | (def-edebug-spec save-current-buffer t) | |
3ebb8416 | 2086 | (def-edebug-spec delay-mode-hooks t) |
8fd29408 | 2087 | (def-edebug-spec with-temp-file t) |
c5377356 | 2088 | (def-edebug-spec with-temp-message t) |
210bd5c9 | 2089 | (def-edebug-spec with-syntax-table t) |
3f923efe DL |
2090 | (def-edebug-spec push (form sexp)) |
2091 | (def-edebug-spec pop (sexp)) | |
8fd29408 | 2092 | |
6b61353c KH |
2093 | (def-edebug-spec 1value (form)) |
2094 | (def-edebug-spec noreturn (form)) | |
2095 | ||
2096 | ||
1fe3d507 DL |
2097 | ;; Anything else? |
2098 | ||
2099 | ||
1fe3d507 DL |
2100 | ;; Some miscellaneous specs for macros in public packages. |
2101 | ;; Send me yours. | |
2102 | ||
2103 | ;; advice.el by Hans Chalupsky (hans@cs.buffalo.edu) | |
2104 | ||
2105 | (def-edebug-spec ad-dolist ((symbolp form &optional form) body)) | |
a1506d29 | 2106 | (def-edebug-spec defadvice |
1fe3d507 | 2107 | (&define name ;; thing being advised. |
a1506d29 JB |
2108 | (name ;; class is [&or "before" "around" "after" |
2109 | ;; "activation" "deactivation"] | |
1fe3d507 DL |
2110 | name ;; name of advice |
2111 | &rest sexp ;; optional position and flags | |
2112 | ) | |
2113 | [&optional stringp] | |
2114 | [&optional ("interactive" interactive)] | |
2115 | def-body)) | |
2116 | ||
be0dd657 DL |
2117 | (def-edebug-spec easy-menu-define (symbolp body)) |
2118 | ||
2119 | (def-edebug-spec with-custom-print body) | |
2120 | ||
2121 | (def-edebug-spec sregexq (&rest sexp)) | |
78f2fcaf | 2122 | (def-edebug-spec rx (&rest sexp)) |
be0dd657 | 2123 | |
f7359658 | 2124 | ;;; The debugger itself |
1fe3d507 DL |
2125 | |
2126 | (defvar edebug-active nil) ;; Non-nil when edebug is active | |
84fc2cfa ER |
2127 | |
2128 | ;;; add minor-mode-alist entry | |
2129 | (or (assq 'edebug-active minor-mode-alist) | |
2130 | (setq minor-mode-alist (cons (list 'edebug-active " *Debugging*") | |
2131 | minor-mode-alist))) | |
2132 | ||
1fe3d507 DL |
2133 | (defvar edebug-stack nil) |
2134 | ;; Stack of active functions evaluated via edebug. | |
2135 | ;; Should be nil at the top level. | |
2136 | ||
2137 | (defvar edebug-stack-depth -1) | |
2138 | ;; Index of last edebug-stack item. | |
2139 | ||
2140 | (defvar edebug-offset-indices nil) | |
2141 | ;; Stack of offset indices of visited edebug sexps. | |
2142 | ;; Should be nil at the top level. | |
2143 | ;; Each function adds one cons. Top is modified with setcar. | |
84fc2cfa | 2144 | |
84fc2cfa ER |
2145 | |
2146 | (defvar edebug-entered nil | |
1fe3d507 DL |
2147 | ;; Non-nil if edebug has already been entered at this recursive edit level. |
2148 | ;; This should stay nil at the top level. | |
2149 | ) | |
2150 | ||
2151 | ;; Should these be options? | |
2152 | (defconst edebug-debugger 'edebug | |
2153 | ;; Name of function to use for debugging when error or quit occurs. | |
2154 | ;; Set this to 'debug if you want to debug edebug. | |
2155 | ) | |
2156 | ||
2157 | ||
2158 | ;; Dynamically bound variables, declared globally but left unbound. | |
2159 | (defvar edebug-function) ; the function being executed. change name!! | |
2160 | (defvar edebug-args) ; the arguments of the function | |
2161 | (defvar edebug-data) ; the edebug data for the function | |
2162 | (defvar edebug-value) ; the result of the expression | |
2163 | (defvar edebug-after-index) | |
2164 | (defvar edebug-def-mark) ; the mark for the definition | |
2165 | (defvar edebug-freq-count) ; the count of expression visits. | |
2166 | (defvar edebug-coverage) ; the coverage results of each expression of function. | |
2167 | ||
2168 | (defvar edebug-buffer) ; which buffer the function is in. | |
2169 | (defvar edebug-result) ; the result of the function call returned by body | |
2170 | (defvar edebug-outside-executing-macro) | |
2171 | (defvar edebug-outside-defining-kbd-macro) | |
2172 | ||
2173 | (defvar edebug-execution-mode 'step) ; Current edebug mode set by user. | |
2174 | (defvar edebug-next-execution-mode nil) ; Use once instead of initial mode. | |
2175 | ||
2176 | (defvar edebug-outside-debug-on-error) ; the value of debug-on-error outside | |
2177 | (defvar edebug-outside-debug-on-quit) ; the value of debug-on-quit outside | |
2178 | ||
17b76fbd RS |
2179 | (defvar edebug-outside-overriding-local-map) |
2180 | (defvar edebug-outside-overriding-terminal-local-map) | |
2181 | ||
88668147 DL |
2182 | (defvar edebug-outside-pre-command-hook) |
2183 | (defvar edebug-outside-post-command-hook) | |
88668147 DL |
2184 | |
2185 | (defvar cl-lexical-debug) ;; Defined in cl.el | |
2186 | ||
1fe3d507 | 2187 | ;;; Handling signals |
1fe3d507 | 2188 | |
1fe3d507 DL |
2189 | (defun edebug-signal (edebug-signal-name edebug-signal-data) |
2190 | "Signal an error. Args are SIGNAL-NAME, and associated DATA. | |
2191 | A signal name is a symbol with an `error-conditions' property | |
2192 | that is a list of condition names. | |
2193 | A handler for any of those names will get to handle this signal. | |
2194 | The symbol `error' should always be one of them. | |
2195 | ||
2196 | DATA should be a list. Its elements are printed as part of the error message. | |
2197 | If the signal is handled, DATA is made available to the handler. | |
2198 | See `condition-case'. | |
2199 | ||
2200 | This is the Edebug replacement for the standard `signal'. It should | |
2201 | only be active while Edebug is. It checks `debug-on-error' to see | |
2202 | whether it should call the debugger. When execution is resumed, the | |
2203 | error is signaled again." | |
2204 | (if (and (listp debug-on-error) (memq edebug-signal-name debug-on-error)) | |
2205 | (edebug 'error (cons edebug-signal-name edebug-signal-data))) | |
2206 | ;; If we reach here without another non-local exit, then send signal again. | |
2207 | ;; i.e. the signal is not continuable, yet. | |
e76b547b RS |
2208 | ;; Avoid infinite recursion. |
2209 | (let ((signal-hook-function nil)) | |
2210 | (signal edebug-signal-name edebug-signal-data))) | |
1fe3d507 DL |
2211 | |
2212 | ;;; Entering Edebug | |
84fc2cfa | 2213 | |
1fe3d507 DL |
2214 | (defun edebug-enter (edebug-function edebug-args edebug-body) |
2215 | ;; Entering FUNC. The arguments are ARGS, and the body is BODY. | |
2216 | ;; Setup edebug variables and evaluate BODY. This function is called | |
a1506d29 | 2217 | ;; when a function evaluated with edebug-eval-top-level-form is entered. |
1fe3d507 | 2218 | ;; Return the result of BODY. |
84fc2cfa ER |
2219 | |
2220 | ;; Is this the first time we are entering edebug since | |
2221 | ;; lower-level recursive-edit command? | |
1fe3d507 DL |
2222 | ;; More precisely, this tests whether Edebug is currently active. |
2223 | (if (not edebug-entered) | |
2224 | (let ((edebug-entered t) | |
a1506d29 | 2225 | ;; Binding max-lisp-eval-depth here is OK, |
88668147 DL |
2226 | ;; but not inside an unwind-protect. |
2227 | ;; Doing it here also keeps it from growing too large. | |
1fe3d507 DL |
2228 | (max-lisp-eval-depth (+ 100 max-lisp-eval-depth)) ; too much?? |
2229 | (max-specpdl-size (+ 200 max-specpdl-size)) | |
2230 | ||
2231 | (debugger edebug-debugger) ; only while edebug is active. | |
2232 | (edebug-outside-debug-on-error debug-on-error) | |
2233 | (edebug-outside-debug-on-quit debug-on-quit) | |
2234 | ;; Binding these may not be the right thing to do. | |
2235 | ;; We want to allow the global values to be changed. | |
2236 | (debug-on-error (or debug-on-error edebug-on-error)) | |
2237 | (debug-on-quit edebug-on-quit) | |
2238 | ||
88668147 DL |
2239 | ;; Lexical bindings must be uncompiled for this to work. |
2240 | (cl-lexical-debug t) | |
2241 | ||
17b76fbd RS |
2242 | (edebug-outside-overriding-local-map overriding-local-map) |
2243 | (edebug-outside-overriding-terminal-local-map | |
2244 | overriding-terminal-local-map) | |
2245 | ||
1fe3d507 | 2246 | ;; Save the outside value of executing macro. (here??) |
efcf38c7 | 2247 | (edebug-outside-executing-macro executing-kbd-macro) |
6b61353c KH |
2248 | (edebug-outside-pre-command-hook |
2249 | (edebug-var-status 'pre-command-hook)) | |
2250 | (edebug-outside-post-command-hook | |
2251 | (edebug-var-status 'post-command-hook))) | |
1fe3d507 | 2252 | (unwind-protect |
88668147 DL |
2253 | (let (;; Don't keep reading from an executing kbd macro |
2254 | ;; within edebug unless edebug-continue-kbd-macro is | |
2255 | ;; non-nil. Again, local binding may not be best. | |
a1506d29 | 2256 | (executing-kbd-macro |
efcf38c7 | 2257 | (if edebug-continue-kbd-macro executing-kbd-macro)) |
88668147 | 2258 | |
17b76fbd RS |
2259 | ;; Don't get confused by the user's keymap changes. |
2260 | (overriding-local-map nil) | |
2261 | (overriding-terminal-local-map nil) | |
2262 | ||
1e3ab67b RS |
2263 | (signal-hook-function 'edebug-signal) |
2264 | ||
88668147 DL |
2265 | ;; Disable command hooks. This is essential when |
2266 | ;; a hook function is instrumented - to avoid infinite loop. | |
2267 | ;; This may be more than we need, however. | |
2268 | (pre-command-hook nil) | |
ba88fc3a | 2269 | (post-command-hook nil)) |
a1506d29 JB |
2270 | (setq edebug-execution-mode (or edebug-next-execution-mode |
2271 | edebug-initial-mode | |
88668147 DL |
2272 | edebug-execution-mode) |
2273 | edebug-next-execution-mode nil) | |
1e3ab67b | 2274 | (edebug-enter edebug-function edebug-args edebug-body)) |
88668147 | 2275 | ;; Reset global variables in case outside value was changed. |
6b61353c KH |
2276 | (setq executing-kbd-macro edebug-outside-executing-macro) |
2277 | (edebug-restore-status | |
2278 | 'post-command-hook edebug-outside-post-command-hook) | |
2279 | (edebug-restore-status | |
2280 | 'pre-command-hook edebug-outside-pre-command-hook))) | |
a1506d29 | 2281 | |
1fe3d507 DL |
2282 | (let* ((edebug-data (get edebug-function 'edebug)) |
2283 | (edebug-def-mark (car edebug-data)) ; mark at def start | |
2284 | (edebug-freq-count (get edebug-function 'edebug-freq-count)) | |
2285 | (edebug-coverage (get edebug-function 'edebug-coverage)) | |
2286 | (edebug-buffer (marker-buffer edebug-def-mark)) | |
2287 | ||
2288 | (edebug-stack (cons edebug-function edebug-stack)) | |
2289 | (edebug-offset-indices (cons 0 edebug-offset-indices)) | |
2290 | ) | |
2291 | (if (get edebug-function 'edebug-on-entry) | |
2292 | (progn | |
2293 | (setq edebug-execution-mode 'step) | |
2294 | (if (eq (get edebug-function 'edebug-on-entry) 'temp) | |
2295 | (put edebug-function 'edebug-on-entry nil)))) | |
2296 | (if edebug-trace | |
2297 | (edebug-enter-trace edebug-body) | |
2298 | (funcall edebug-body)) | |
84fc2cfa ER |
2299 | ))) |
2300 | ||
6b61353c KH |
2301 | (defun edebug-var-status (var) |
2302 | "Return a cons cell describing the status of VAR's current binding. | |
2303 | The purpose of this function is so you can properly undo | |
2304 | subsequent changes to the same binding, by passing the status | |
2305 | cons cell to `edebug-restore-status'. The status cons cell | |
2306 | has the form (LOCUS . VALUE), where LOCUS can be a buffer | |
2307 | \(for a buffer-local binding), a frame (for a frame-local binding), | |
2308 | or nil (if the default binding is current)." | |
2309 | (cons (variable-binding-locus var) | |
2310 | (symbol-value var))) | |
2311 | ||
2312 | (defun edebug-restore-status (var status) | |
2313 | "Reset VAR based on STATUS. | |
2314 | STATUS should be a list you got from `edebug-var-status'." | |
2315 | (let ((locus (car status)) | |
2316 | (value (cdr status))) | |
2317 | (cond ((bufferp locus) | |
2318 | (if (buffer-live-p locus) | |
2319 | (with-current-buffer locus | |
2320 | (set var value)))) | |
2321 | ((framep locus) | |
2322 | (modify-frame-parameters locus (list (cons var value)))) | |
2323 | (t | |
2324 | (set var value))))) | |
84fc2cfa | 2325 | |
1fe3d507 DL |
2326 | (defun edebug-enter-trace (edebug-body) |
2327 | (let ((edebug-stack-depth (1+ edebug-stack-depth)) | |
2328 | edebug-result) | |
a1506d29 | 2329 | (edebug-print-trace-before |
1fe3d507 DL |
2330 | (format "%s args: %s" edebug-function edebug-args)) |
2331 | (prog1 (setq edebug-result (funcall edebug-body)) | |
2332 | (edebug-print-trace-after | |
2333 | (format "%s result: %s" edebug-function edebug-result))))) | |
2334 | ||
2335 | (def-edebug-spec edebug-tracing (form body)) | |
2336 | ||
2337 | (defmacro edebug-tracing (msg &rest body) | |
2338 | "Print MSG in *edebug-trace* before and after evaluating BODY. | |
2339 | The result of BODY is also printed." | |
d8f1319a GM |
2340 | `(let ((edebug-stack-depth (1+ edebug-stack-depth)) |
2341 | edebug-result) | |
2342 | (edebug-print-trace-before ,msg) | |
2343 | (prog1 (setq edebug-result (progn ,@body)) | |
a1506d29 | 2344 | (edebug-print-trace-after |
d8f1319a | 2345 | (format "%s result: %s" ,msg edebug-result))))) |
1fe3d507 DL |
2346 | |
2347 | (defun edebug-print-trace-before (msg) | |
2348 | "Function called to print trace info before expression evaluation. | |
2349 | MSG is printed after `::::{ '." | |
84fc2cfa | 2350 | (edebug-trace-display |
1fe3d507 | 2351 | edebug-trace-buffer "%s{ %s" (make-string edebug-stack-depth ?\:) msg)) |
84fc2cfa | 2352 | |
1fe3d507 DL |
2353 | (defun edebug-print-trace-after (msg) |
2354 | "Function called to print trace info after expression evaluation. | |
2355 | MSG is printed after `::::} '." | |
84fc2cfa | 2356 | (edebug-trace-display |
1fe3d507 DL |
2357 | edebug-trace-buffer "%s} %s" (make-string edebug-stack-depth ?\:) msg)) |
2358 | ||
2359 | ||
84fc2cfa | 2360 | |
1fe3d507 DL |
2361 | (defun edebug-slow-before (edebug-before-index) |
2362 | ;; Debug current function given BEFORE position. | |
a1506d29 | 2363 | ;; Called from functions compiled with edebug-eval-top-level-form. |
1fe3d507 DL |
2364 | ;; Return the before index. |
2365 | (setcar edebug-offset-indices edebug-before-index) | |
84fc2cfa | 2366 | |
a1506d29 | 2367 | ;; Increment frequency count |
1fe3d507 DL |
2368 | (aset edebug-freq-count edebug-before-index |
2369 | (1+ (aref edebug-freq-count edebug-before-index))) | |
2370 | ||
2371 | (if (or (not (memq edebug-execution-mode '(Go-nonstop next))) | |
2372 | (edebug-input-pending-p)) | |
2373 | (edebug-debugger edebug-before-index 'before nil)) | |
2374 | edebug-before-index) | |
2375 | ||
2376 | (defun edebug-fast-before (edebug-before-index) | |
2377 | ;; Do nothing. | |
2378 | ) | |
2379 | ||
2380 | (defun edebug-slow-after (edebug-before-index edebug-after-index edebug-value) | |
2381 | ;; Debug current function given AFTER position and VALUE. | |
2382 | ;; Called from functions compiled with edebug-eval-top-level-form. | |
2383 | ;; Return VALUE. | |
2384 | (setcar edebug-offset-indices edebug-after-index) | |
2385 | ||
a1506d29 | 2386 | ;; Increment frequency count |
1fe3d507 DL |
2387 | (aset edebug-freq-count edebug-after-index |
2388 | (1+ (aref edebug-freq-count edebug-after-index))) | |
2389 | (if edebug-test-coverage (edebug-update-coverage)) | |
2390 | ||
2391 | (if (and (eq edebug-execution-mode 'Go-nonstop) | |
2392 | (not (edebug-input-pending-p))) | |
2393 | ;; Just return result. | |
2394 | edebug-value | |
2395 | (edebug-debugger edebug-after-index 'after edebug-value) | |
2396 | )) | |
2397 | ||
2398 | (defun edebug-fast-after (edebug-before-index edebug-after-index edebug-value) | |
2399 | ;; Do nothing but return the value. | |
2400 | edebug-value) | |
2401 | ||
2402 | (defun edebug-run-slow () | |
2403 | (defalias 'edebug-before 'edebug-slow-before) | |
2404 | (defalias 'edebug-after 'edebug-slow-after)) | |
2405 | ||
2406 | ;; This is not used, yet. | |
2407 | (defun edebug-run-fast () | |
2408 | (defalias 'edebug-before 'edebug-fast-before) | |
2409 | (defalias 'edebug-after 'edebug-fast-after)) | |
2410 | ||
2411 | (edebug-run-slow) | |
2412 | ||
2413 | ||
2414 | (defun edebug-update-coverage () | |
2415 | (let ((old-result (aref edebug-coverage edebug-after-index))) | |
2416 | (cond | |
2417 | ((eq 'ok-coverage old-result)) | |
2418 | ((eq 'unknown old-result) | |
2419 | (aset edebug-coverage edebug-after-index edebug-value)) | |
2420 | ;; Test if a different result. | |
2421 | ((not (eq edebug-value old-result)) | |
2422 | (aset edebug-coverage edebug-after-index 'ok-coverage))))) | |
2423 | ||
2424 | ||
2425 | ;; Dynamically declared unbound variables. | |
2426 | (defvar edebug-arg-mode) ; the mode, either before, after, or error | |
2427 | (defvar edebug-breakpoints) | |
2428 | (defvar edebug-break-data) ; break data for current function. | |
2429 | (defvar edebug-break) ; whether a break occurred. | |
2430 | (defvar edebug-global-break) ; whether a global break occurred. | |
2431 | (defvar edebug-break-condition) ; whether the breakpoint is conditional. | |
2432 | ||
2433 | (defvar edebug-break-result nil) | |
2434 | (defvar edebug-global-break-result nil) | |
2435 | ||
2436 | ||
2437 | (defun edebug-debugger (edebug-offset-index edebug-arg-mode edebug-value) | |
3795fe52 RS |
2438 | (if inhibit-redisplay |
2439 | ;; Don't really try to enter edebug within an eval from redisplay. | |
2440 | edebug-value | |
2441 | ;; Check breakpoints and pending input. | |
2442 | ;; If edebug display should be updated, call edebug-display. | |
2443 | ;; Return edebug-value. | |
2444 | (let* ( ;; This needs to be here since breakpoints may be changed. | |
2445 | (edebug-breakpoints (car (cdr edebug-data))) ; list of breakpoints | |
2446 | (edebug-break-data (assq edebug-offset-index edebug-breakpoints)) | |
2447 | (edebug-break-condition (car (cdr edebug-break-data))) | |
2448 | (edebug-global-break | |
2449 | (if edebug-global-break-condition | |
2450 | (condition-case nil | |
2451 | (setq edebug-global-break-result | |
2452 | (eval edebug-global-break-condition)) | |
2453 | (error nil)))) | |
2454 | (edebug-break)) | |
1fe3d507 DL |
2455 | |
2456 | ;;; (edebug-trace "exp: %s" edebug-value) | |
3795fe52 | 2457 | ;; Test whether we should break. |
a1506d29 | 2458 | (setq edebug-break |
3795fe52 RS |
2459 | (or edebug-global-break |
2460 | (and edebug-break-data | |
2461 | (or (not edebug-break-condition) | |
2462 | (setq edebug-break-result | |
2463 | (eval edebug-break-condition)))))) | |
2464 | (if (and edebug-break | |
2465 | (nth 2 edebug-break-data)) ; is it temporary? | |
2466 | ;; Delete the breakpoint. | |
2467 | (setcdr edebug-data | |
2468 | (cons (delq edebug-break-data edebug-breakpoints) | |
2469 | (cdr (cdr edebug-data))))) | |
2470 | ||
2471 | ;; Display if mode is not go, continue, or Continue-fast | |
a1506d29 | 2472 | ;; or break, or input is pending, |
3795fe52 RS |
2473 | (if (or (not (memq edebug-execution-mode '(go continue Continue-fast))) |
2474 | edebug-break | |
2475 | (edebug-input-pending-p)) | |
2476 | (edebug-display)) ; <--------------- display | |
a1506d29 | 2477 | |
3795fe52 RS |
2478 | edebug-value |
2479 | ))) | |
84fc2cfa ER |
2480 | |
2481 | ||
1fe3d507 DL |
2482 | ;; window-start now stored with each function. |
2483 | ;;(defvar edebug-window-start nil) | |
2484 | ;; Remember where each buffers' window starts between edebug calls. | |
2485 | ;; This is to avoid spurious recentering. | |
2486 | ;; Does this still need to be buffer-local?? | |
2487 | ;;(setq-default edebug-window-start nil) | |
2488 | ;;(make-variable-buffer-local 'edebug-window-start) | |
2489 | ||
2490 | ||
2491 | ;; Dynamically declared unbound vars | |
2492 | (defvar edebug-point) ; the point in edebug buffer | |
2493 | (defvar edebug-outside-buffer) ; the current-buffer outside of edebug | |
2494 | (defvar edebug-outside-point) ; the point outside of edebug | |
2495 | (defvar edebug-outside-mark) ; the mark outside of edebug | |
2496 | (defvar edebug-window-data) ; window and window-start for current function | |
2497 | (defvar edebug-outside-windows) ; outside window configuration | |
2498 | (defvar edebug-eval-buffer) ; for the evaluation list. | |
2499 | (defvar edebug-outside-o-a-p) ; outside overlay-arrow-position | |
2500 | (defvar edebug-outside-o-a-s) ; outside overlay-arrow-string | |
2501 | (defvar edebug-outside-c-i-e-a) ; outside cursor-in-echo-area | |
2502 | ||
2503 | (defvar edebug-eval-list nil) ;; List of expressions to evaluate. | |
2504 | ||
2505 | (defvar edebug-previous-result nil) ;; Last result returned. | |
2506 | ||
88668147 | 2507 | ;; Emacs 19 adds an arg to mark and mark-marker. |
1fe3d507 | 2508 | (defalias 'edebug-mark-marker 'mark-marker) |
84fc2cfa | 2509 | |
84fc2cfa ER |
2510 | |
2511 | (defun edebug-display () | |
6b61353c KH |
2512 | (unless (marker-position edebug-def-mark) |
2513 | ;; The buffer holding the source has been killed. | |
2514 | ;; Let's at least show a backtrace so the user can figure out | |
2515 | ;; which function we're talking about. | |
2516 | (debug)) | |
1fe3d507 DL |
2517 | ;; Setup windows for edebug, determine mode, maybe enter recursive-edit. |
2518 | ;; Uses local variables of edebug-enter, edebug-before, edebug-after | |
2519 | ;; and edebug-debugger. | |
84fc2cfa ER |
2520 | (let ((edebug-active t) ; for minor mode alist |
2521 | edebug-stop ; should we enter recursive-edit | |
1fe3d507 DL |
2522 | (edebug-point (+ edebug-def-mark |
2523 | (aref (nth 2 edebug-data) edebug-offset-index))) | |
2524 | edebug-buffer-outside-point ; current point in edebug-buffer | |
2525 | ;; window displaying edebug-buffer | |
2526 | (edebug-window-data (nth 3 edebug-data)) | |
84fc2cfa ER |
2527 | (edebug-outside-window (selected-window)) |
2528 | (edebug-outside-buffer (current-buffer)) | |
2529 | (edebug-outside-point (point)) | |
1fe3d507 | 2530 | (edebug-outside-mark (edebug-mark)) |
84fc2cfa | 2531 | edebug-outside-windows ; window or screen configuration |
1fe3d507 | 2532 | edebug-buffer-points |
a1506d29 | 2533 | |
84fc2cfa ER |
2534 | edebug-eval-buffer ; declared here so we can kill it below |
2535 | (edebug-eval-result-list (and edebug-eval-list | |
2536 | (edebug-eval-result-list))) | |
1fe3d507 DL |
2537 | edebug-trace-window |
2538 | edebug-trace-window-start | |
88668147 DL |
2539 | |
2540 | (edebug-outside-o-a-p overlay-arrow-position) | |
2541 | (edebug-outside-o-a-s overlay-arrow-string) | |
2542 | (edebug-outside-c-i-e-a cursor-in-echo-area)) | |
2543 | (unwind-protect | |
2544 | (let ((overlay-arrow-position overlay-arrow-position) | |
2545 | (overlay-arrow-string overlay-arrow-string) | |
2546 | (cursor-in-echo-area nil) | |
2547 | ;; any others?? | |
2548 | ) | |
2549 | (if (not (buffer-name edebug-buffer)) | |
2550 | (let ((debug-on-error nil)) | |
2551 | (error "Buffer defining %s not found" edebug-function))) | |
a1506d29 | 2552 | |
88668147 DL |
2553 | (if (eq 'after edebug-arg-mode) |
2554 | ;; Compute result string now before windows are modified. | |
2555 | (edebug-compute-previous-result edebug-value)) | |
2556 | ||
2557 | (if edebug-save-windows | |
2558 | ;; Save windows now before we modify them. | |
a1506d29 | 2559 | (setq edebug-outside-windows |
88668147 | 2560 | (edebug-current-windows edebug-save-windows))) |
a1506d29 | 2561 | |
88668147 DL |
2562 | (if edebug-save-displayed-buffer-points |
2563 | (setq edebug-buffer-points (edebug-get-displayed-buffer-points))) | |
2564 | ||
2565 | ;; First move the edebug buffer point to edebug-point | |
f7359658 RS |
2566 | ;; so that window start doesn't get changed when we display it. |
2567 | ;; I don't know if this is going to help. | |
88668147 DL |
2568 | ;;(set-buffer edebug-buffer) |
2569 | ;;(goto-char edebug-point) | |
2570 | ||
2571 | ;; If edebug-buffer is not currently displayed, | |
2572 | ;; first find a window for it. | |
2573 | (edebug-pop-to-buffer edebug-buffer (car edebug-window-data)) | |
2574 | (setcar edebug-window-data (selected-window)) | |
2575 | ||
2576 | ;; Now display eval list, if any. | |
a1506d29 | 2577 | ;; This is done after the pop to edebug-buffer |
88668147 DL |
2578 | ;; so that buffer-window correspondence is correct after quitting. |
2579 | (edebug-eval-display edebug-eval-result-list) | |
2580 | ;; The evaluation list better not have deleted edebug-window-data. | |
2581 | (select-window (car edebug-window-data)) | |
2582 | (set-buffer edebug-buffer) | |
2583 | ||
2584 | (setq edebug-buffer-outside-point (point)) | |
2585 | (goto-char edebug-point) | |
a1506d29 | 2586 | |
88668147 DL |
2587 | (if (eq 'before edebug-arg-mode) |
2588 | ;; Check whether positions are up-to-date. | |
2589 | ;; This assumes point is never before symbol. | |
2590 | (if (not (memq (following-char) '(?\( ?\# ?\` ))) | |
2591 | (let ((debug-on-error nil)) | |
a1506d29 | 2592 | (error "Source has changed - reevaluate definition of %s" |
88668147 DL |
2593 | edebug-function) |
2594 | ))) | |
1fe3d507 | 2595 | |
88668147 DL |
2596 | (setcdr edebug-window-data |
2597 | (edebug-adjust-window (cdr edebug-window-data))) | |
a1506d29 | 2598 | |
88668147 | 2599 | ;; Test if there is input, not including keyboard macros. |
a1506d29 | 2600 | (if (edebug-input-pending-p) |
88668147 DL |
2601 | (progn |
2602 | (setq edebug-execution-mode 'step | |
2603 | edebug-stop t) | |
2604 | (edebug-stop) | |
2605 | ;; (discard-input) ; is this unfriendly?? | |
2606 | )) | |
2607 | ;; Now display arrow based on mode. | |
2608 | (edebug-overlay-arrow) | |
a1506d29 | 2609 | |
88668147 DL |
2610 | (cond |
2611 | ((eq 'error edebug-arg-mode) | |
2612 | ;; Display error message | |
2613 | (setq edebug-execution-mode 'step) | |
2614 | (edebug-overlay-arrow) | |
2615 | (beep) | |
2616 | (if (eq 'quit (car edebug-value)) | |
2617 | (message "Quit") | |
2618 | (edebug-report-error edebug-value))) | |
2619 | (edebug-break | |
2620 | (cond | |
2621 | (edebug-global-break | |
a1506d29 | 2622 | (message "Global Break: %s => %s" |
88668147 DL |
2623 | edebug-global-break-condition |
2624 | edebug-global-break-result)) | |
2625 | (edebug-break-condition | |
a1506d29 JB |
2626 | (message "Break: %s => %s" |
2627 | edebug-break-condition | |
88668147 DL |
2628 | edebug-break-result)) |
2629 | ((not (eq edebug-execution-mode 'Continue-fast)) | |
2630 | (message "Break")) | |
2631 | (t))) | |
2632 | ||
2633 | (t (message ""))) | |
2634 | ||
2635 | (if (eq 'after edebug-arg-mode) | |
2636 | (progn | |
2637 | ;; Display result of previous evaluation. | |
2638 | (if (and edebug-break | |
2639 | (not (eq edebug-execution-mode 'Continue-fast))) | |
2640 | (sit-for 1)) ; Show break message. | |
2641 | (edebug-previous-result))) | |
a1506d29 | 2642 | |
88668147 DL |
2643 | (cond |
2644 | (edebug-break | |
2645 | (cond | |
2646 | ((eq edebug-execution-mode 'continue) (edebug-sit-for 1)) | |
2647 | ((eq edebug-execution-mode 'Continue-fast) (edebug-sit-for 0)) | |
2648 | (t (setq edebug-stop t)))) | |
2649 | ;; not edebug-break | |
2650 | ((eq edebug-execution-mode 'trace) | |
5492ef3c | 2651 | (edebug-sit-for edebug-sit-for-seconds)) ; Force update and pause. |
88668147 DL |
2652 | ((eq edebug-execution-mode 'Trace-fast) |
2653 | (edebug-sit-for 0)) ; Force update and continue. | |
2654 | ) | |
a1506d29 | 2655 | |
88668147 DL |
2656 | (unwind-protect |
2657 | (if (or edebug-stop | |
2658 | (memq edebug-execution-mode '(step next)) | |
a1506d29 | 2659 | (eq edebug-arg-mode 'error)) |
88668147 DL |
2660 | (progn |
2661 | ;; (setq edebug-execution-mode 'step) | |
f7359658 | 2662 | ;; (edebug-overlay-arrow) ; This doesn't always show up. |
88668147 DL |
2663 | (edebug-recursive-edit))) ; <---------- Recursive edit |
2664 | ||
2665 | ;; Reset the edebug-window-data to whatever it is now. | |
2666 | (let ((window (if (eq (window-buffer) edebug-buffer) | |
2667 | (selected-window) | |
2668 | (edebug-get-buffer-window edebug-buffer)))) | |
2669 | ;; Remember window-start for edebug-buffer, if still displayed. | |
2670 | (if window | |
2671 | (progn | |
2672 | (setcar edebug-window-data window) | |
2673 | (setcdr edebug-window-data (window-start window))))) | |
1fe3d507 | 2674 | |
88668147 DL |
2675 | ;; Save trace window point before restoring outside windows. |
2676 | ;; Could generalize this for other buffers. | |
2677 | (setq edebug-trace-window (get-buffer-window edebug-trace-buffer)) | |
2678 | (if edebug-trace-window | |
2679 | (setq edebug-trace-window-start | |
a1506d29 | 2680 | (and edebug-trace-window |
88668147 DL |
2681 | (window-start edebug-trace-window)))) |
2682 | ||
2683 | ;; Restore windows before continuing. | |
2684 | (if edebug-save-windows | |
2685 | (progn | |
2686 | (edebug-set-windows edebug-outside-windows) | |
2687 | ||
2688 | ;; Restore displayed buffer points. | |
2689 | ;; Needed even if restoring windows because | |
2690 | ;; window-points are not restored. (should they be??) | |
2691 | (if edebug-save-displayed-buffer-points | |
2692 | (edebug-set-buffer-points edebug-buffer-points)) | |
2693 | ||
2694 | ;; Unrestore trace window's window-point. | |
2695 | (if edebug-trace-window | |
a1506d29 | 2696 | (set-window-start edebug-trace-window |
88668147 DL |
2697 | edebug-trace-window-start)) |
2698 | ||
2699 | ;; Unrestore edebug-buffer's window-start, if displayed. | |
2700 | (let ((window (car edebug-window-data))) | |
a1506d29 | 2701 | (if (and window (edebug-window-live-p window) |
88668147 DL |
2702 | (eq (window-buffer) edebug-buffer)) |
2703 | (progn | |
a1506d29 | 2704 | (set-window-start window (cdr edebug-window-data) |
88668147 DL |
2705 | 'no-force) |
2706 | ;; Unrestore edebug-buffer's window-point. | |
2707 | ;; Needed in addition to setting the buffer point | |
f7359658 | 2708 | ;; - otherwise quitting doesn't leave point as is. |
88668147 DL |
2709 | ;; But this causes point to not be restored at times. |
2710 | ;; Also, it may not be a visible window. | |
2711 | ;; (set-window-point window edebug-point) | |
2712 | ))) | |
2713 | ||
2714 | ;; Unrestore edebug-buffer's point. Rerestored below. | |
2715 | ;; (goto-char edebug-point) ;; in edebug-buffer | |
2716 | ) | |
2717 | ;; Since we may be in a save-excursion, in case of quit, | |
2718 | ;; reselect the outside window only. | |
2719 | ;; Only needed if we are not recovering windows?? | |
2720 | (if (edebug-window-live-p edebug-outside-window) | |
2721 | (select-window edebug-outside-window)) | |
2722 | ) ; if edebug-save-windows | |
2723 | ||
2724 | ;; Restore current buffer always, in case application needs it. | |
2725 | (set-buffer edebug-outside-buffer) | |
2726 | ;; Restore point, and mark. | |
1fe3d507 | 2727 | ;; Needed even if restoring windows because |
f7359658 RS |
2728 | ;; that doesn't restore point and mark in the current buffer. |
2729 | ;; But don't restore point if edebug-buffer is current buffer. | |
88668147 DL |
2730 | (if (not (eq edebug-buffer edebug-outside-buffer)) |
2731 | (goto-char edebug-outside-point)) | |
2732 | (if (marker-buffer (edebug-mark-marker)) | |
2733 | ;; Does zmacs-regions need to be nil while doing set-marker? | |
2734 | (set-marker (edebug-mark-marker) edebug-outside-mark)) | |
2735 | ) ; unwind-protect | |
2736 | ;; None of the following is done if quit or signal occurs. | |
2737 | ||
2738 | ;; Restore edebug-buffer's outside point. | |
a1506d29 | 2739 | ;; (edebug-trace "restore edebug-buffer point: %s" |
88668147 DL |
2740 | ;; edebug-buffer-outside-point) |
2741 | (let ((current-buffer (current-buffer))) | |
2742 | (set-buffer edebug-buffer) | |
2743 | (goto-char edebug-buffer-outside-point) | |
2744 | (set-buffer current-buffer)) | |
2745 | ;; ... nothing more. | |
2746 | ) | |
2747 | ;; Reset global variables to outside values in case they were changed. | |
2748 | (setq | |
2749 | overlay-arrow-position edebug-outside-o-a-p | |
2750 | overlay-arrow-string edebug-outside-o-a-s | |
2751 | cursor-in-echo-area edebug-outside-c-i-e-a) | |
2752 | ))) | |
1fe3d507 | 2753 | |
84fc2cfa | 2754 | |
1fe3d507 DL |
2755 | (defvar edebug-number-of-recursions 0) |
2756 | ;; Number of recursive edits started by edebug. | |
2757 | ;; Should be 0 at the top level. | |
2758 | ||
2759 | (defvar edebug-recursion-depth 0) | |
2760 | ;; Value of recursion-depth when edebug was called. | |
2761 | ||
2762 | ;; Dynamically declared unbound vars | |
2763 | (defvar edebug-outside-match-data) ; match data outside of edebug | |
2764 | (defvar edebug-backtrace-buffer) ; each recursive edit gets its own | |
a1506d29 | 2765 | (defvar edebug-inside-windows) |
1fe3d507 DL |
2766 | (defvar edebug-interactive-p) |
2767 | ||
2768 | (defvar edebug-outside-map) | |
2769 | (defvar edebug-outside-standard-output) | |
2770 | (defvar edebug-outside-standard-input) | |
c820ffeb | 2771 | (defvar edebug-outside-current-prefix-arg) |
1fe3d507 DL |
2772 | (defvar edebug-outside-last-command-char) |
2773 | (defvar edebug-outside-last-command) | |
2774 | (defvar edebug-outside-this-command) | |
2775 | (defvar edebug-outside-last-input-char) | |
2776 | ||
100aa77c RS |
2777 | ;; Note: here we have defvars for variables that are |
2778 | ;; built-in in certain versions. | |
2779 | ;; Each defvar makes a difference | |
2780 | ;; in versions where the variable is *not* built-in. | |
2781 | ||
1fe3d507 DL |
2782 | ;; Emacs 18 |
2783 | (defvar edebug-outside-unread-command-char) | |
1fe3d507 | 2784 | |
1fe3d507 DL |
2785 | ;; Emacs 19. |
2786 | (defvar edebug-outside-last-command-event) | |
2787 | (defvar edebug-outside-unread-command-events) | |
2788 | (defvar edebug-outside-last-input-event) | |
2789 | (defvar edebug-outside-last-event-frame) | |
2790 | (defvar edebug-outside-last-nonmenu-event) | |
2791 | (defvar edebug-outside-track-mouse) | |
2792 | ||
1fe3d507 DL |
2793 | ;; Disable byte compiler warnings about unread-command-char and -event |
2794 | ;; (maybe works with byte-compile-version 2.22 at least) | |
2795 | (defvar edebug-unread-command-char-warning) | |
2796 | (defvar edebug-unread-command-event-warning) | |
2797 | (eval-when-compile | |
2798 | (setq edebug-unread-command-char-warning | |
2799 | (get 'unread-command-char 'byte-obsolete-variable)) | |
6db746da | 2800 | (put 'unread-command-char 'byte-obsolete-variable nil)) |
84fc2cfa ER |
2801 | |
2802 | (defun edebug-recursive-edit () | |
1fe3d507 | 2803 | ;; Start up a recursive edit inside of edebug. |
84fc2cfa | 2804 | ;; The current buffer is the edebug-buffer, which is put into edebug-mode. |
1fe3d507 | 2805 | ;; Assume that none of the variables below are buffer-local. |
84fc2cfa ER |
2806 | (let ((edebug-buffer-read-only buffer-read-only) |
2807 | ;; match-data must be done in the outside buffer | |
2808 | (edebug-outside-match-data | |
1fe3d507 DL |
2809 | (save-excursion ; might be unnecessary now?? |
2810 | (set-buffer edebug-outside-buffer) ; in case match buffer different | |
84fc2cfa ER |
2811 | (match-data))) |
2812 | ||
1fe3d507 | 2813 | ;;(edebug-number-of-recursions (1+ edebug-number-of-recursions)) |
84fc2cfa ER |
2814 | (edebug-recursion-depth (recursion-depth)) |
2815 | edebug-entered ; bind locally to nil | |
1fe3d507 | 2816 | (edebug-interactive-p nil) ; again non-interactive |
84fc2cfa ER |
2817 | edebug-backtrace-buffer ; each recursive edit gets its own |
2818 | ;; The window configuration may be saved and restored | |
2819 | ;; during a recursive-edit | |
2820 | edebug-inside-windows | |
2821 | ||
2822 | (edebug-outside-map (current-local-map)) | |
88668147 | 2823 | |
84fc2cfa ER |
2824 | (edebug-outside-standard-output standard-output) |
2825 | (edebug-outside-standard-input standard-input) | |
88668147 | 2826 | (edebug-outside-defining-kbd-macro defining-kbd-macro) |
84fc2cfa ER |
2827 | |
2828 | (edebug-outside-last-command-char last-command-char) | |
2829 | (edebug-outside-last-command last-command) | |
2830 | (edebug-outside-this-command this-command) | |
2831 | (edebug-outside-last-input-char last-input-char) | |
1fe3d507 DL |
2832 | |
2833 | (edebug-outside-unread-command-char unread-command-char) | |
c820ffeb | 2834 | (edebug-outside-current-prefix-arg current-prefix-arg) |
1fe3d507 DL |
2835 | |
2836 | (edebug-outside-last-input-event last-input-event) | |
2837 | (edebug-outside-last-command-event last-command-event) | |
1fe3d507 DL |
2838 | (edebug-outside-unread-command-events unread-command-events) |
2839 | (edebug-outside-last-event-frame last-event-frame) | |
2840 | (edebug-outside-last-nonmenu-event last-nonmenu-event) | |
2841 | (edebug-outside-track-mouse track-mouse) | |
84fc2cfa ER |
2842 | ) |
2843 | ||
84fc2cfa | 2844 | (unwind-protect |
88668147 DL |
2845 | (let ( |
2846 | ;; Declare global values local but using the same global value. | |
2847 | ;; We could set these to the values for previous edebug call. | |
2848 | (last-command-char last-command-char) | |
a1506d29 | 2849 | (last-command last-command) |
88668147 DL |
2850 | (this-command this-command) |
2851 | (last-input-char last-input-char) | |
2852 | ||
2853 | ;; Assume no edebug command sets unread-command-char. | |
2854 | (unread-command-char -1) | |
c820ffeb | 2855 | (current-prefix-arg nil) |
88668147 DL |
2856 | |
2857 | ;; More for Emacs 19 | |
2858 | (last-input-event nil) | |
2859 | (last-command-event nil) | |
88668147 DL |
2860 | (unread-command-events nil) |
2861 | (last-event-frame nil) | |
2862 | (last-nonmenu-event nil) | |
2863 | (track-mouse nil) | |
2864 | ||
2865 | ;; Bind again to outside values. | |
2866 | (debug-on-error edebug-outside-debug-on-error) | |
2867 | (debug-on-quit edebug-outside-debug-on-quit) | |
2868 | ||
2869 | ;; Don't keep defining a kbd macro. | |
a1506d29 | 2870 | (defining-kbd-macro |
88668147 DL |
2871 | (if edebug-continue-kbd-macro defining-kbd-macro)) |
2872 | ||
2873 | ;; others?? | |
2874 | ) | |
2875 | ||
88668147 DL |
2876 | (if (and (eq edebug-execution-mode 'go) |
2877 | (not (memq edebug-arg-mode '(after error)))) | |
2878 | (message "Break")) | |
2879 | ||
2880 | (setq buffer-read-only t) | |
1e3ab67b | 2881 | (setq signal-hook-function nil) |
88668147 DL |
2882 | |
2883 | (edebug-mode) | |
2884 | (unwind-protect | |
2885 | (recursive-edit) ; <<<<<<<<<< Recursive edit | |
2886 | ||
2887 | ;; Do the following, even if quit occurs. | |
1e3ab67b | 2888 | (setq signal-hook-function 'edebug-signal) |
88668147 DL |
2889 | (if edebug-backtrace-buffer |
2890 | (kill-buffer edebug-backtrace-buffer)) | |
2891 | ;; Could be an option to keep eval display up. | |
2892 | (if edebug-eval-buffer (kill-buffer edebug-eval-buffer)) | |
2893 | ||
2894 | ;; Remember selected-window after recursive-edit. | |
2895 | ;; (setq edebug-inside-window (selected-window)) | |
2896 | ||
ccb61a97 | 2897 | (set-match-data edebug-outside-match-data) |
88668147 DL |
2898 | |
2899 | ;; Recursive edit may have changed buffers, | |
2900 | ;; so set it back before exiting let. | |
2901 | (if (buffer-name edebug-buffer) ; if it still exists | |
2902 | (progn | |
2903 | (set-buffer edebug-buffer) | |
2904 | (if (memq edebug-execution-mode '(go Go-nonstop)) | |
2905 | (edebug-overlay-arrow)) | |
2906 | (setq buffer-read-only edebug-buffer-read-only) | |
2907 | (use-local-map edebug-outside-map) | |
2908 | ) | |
2909 | ;; gotta have a buffer to let its buffer local variables be set | |
2910 | (get-buffer-create " bogus edebug buffer")) | |
2911 | ));; inner let | |
2912 | ||
2913 | ;; Reset global vars to outside values, in case they have been changed. | |
a1506d29 | 2914 | (setq |
88668147 DL |
2915 | last-command-char edebug-outside-last-command-char |
2916 | last-command-event edebug-outside-last-command-event | |
2917 | last-command edebug-outside-last-command | |
2918 | this-command edebug-outside-this-command | |
2919 | unread-command-char edebug-outside-unread-command-char | |
88668147 | 2920 | unread-command-events edebug-outside-unread-command-events |
c820ffeb | 2921 | current-prefix-arg edebug-outside-current-prefix-arg |
88668147 DL |
2922 | last-input-char edebug-outside-last-input-char |
2923 | last-input-event edebug-outside-last-input-event | |
2924 | last-event-frame edebug-outside-last-event-frame | |
2925 | last-nonmenu-event edebug-outside-last-nonmenu-event | |
2926 | track-mouse edebug-outside-track-mouse | |
2927 | ||
2928 | standard-output edebug-outside-standard-output | |
2929 | standard-input edebug-outside-standard-input | |
2930 | defining-kbd-macro edebug-outside-defining-kbd-macro | |
2931 | )) | |
2932 | )) | |
84fc2cfa | 2933 | |
1fe3d507 DL |
2934 | |
2935 | ;;; Display related functions | |
84fc2cfa ER |
2936 | |
2937 | (defun edebug-adjust-window (old-start) | |
1fe3d507 | 2938 | ;; If pos is not visible, adjust current window to fit following context. |
a1506d29 | 2939 | ;;; (message "window: %s old-start: %s window-start: %s pos: %s" |
1fe3d507 | 2940 | ;;; (selected-window) old-start (window-start) (point)) (sit-for 5) |
84fc2cfa ER |
2941 | (if (not (pos-visible-in-window-p)) |
2942 | (progn | |
1fe3d507 DL |
2943 | ;; First try old-start |
2944 | (if old-start | |
2945 | (set-window-start (selected-window) old-start)) | |
84fc2cfa | 2946 | (if (not (pos-visible-in-window-p)) |
1fe3d507 DL |
2947 | (progn |
2948 | ;; (message "resetting window start") (sit-for 2) | |
2949 | (set-window-start | |
2950 | (selected-window) | |
2951 | (save-excursion | |
2952 | (forward-line | |
2953 | (if (< (point) (window-start)) -1 ; one line before if in back | |
2954 | (- (/ (window-height) 2)) ; center the line moving forward | |
2955 | )) | |
2956 | (beginning-of-line) | |
2957 | (point))))))) | |
84fc2cfa | 2958 | (window-start)) |
a1506d29 | 2959 | |
84fc2cfa ER |
2960 | |
2961 | ||
1fe3d507 DL |
2962 | (defconst edebug-arrow-alist |
2963 | '((Continue-fast . "=") | |
2964 | (Trace-fast . "-") | |
2965 | (continue . ">") | |
2966 | (trace . "->") | |
2967 | (step . "=>") | |
2968 | (next . "=>") | |
2969 | (go . "<>") | |
2970 | (Go-nonstop . "..") ; not used | |
2971 | ) | |
2972 | "Association list of arrows for each edebug mode.") | |
2973 | ||
2974 | (defun edebug-overlay-arrow () | |
2975 | ;; Set up the overlay arrow at beginning-of-line in current buffer. | |
a1506d29 | 2976 | ;; The arrow string is derived from edebug-arrow-alist and |
1fe3d507 | 2977 | ;; edebug-execution-mode. |
88668147 | 2978 | (let ((pos (save-excursion (beginning-of-line) (point)))) |
1fe3d507 DL |
2979 | (setq overlay-arrow-string |
2980 | (cdr (assq edebug-execution-mode edebug-arrow-alist))) | |
2981 | (setq overlay-arrow-position (make-marker)) | |
2982 | (set-marker overlay-arrow-position pos (current-buffer)))) | |
84fc2cfa | 2983 | |
1fe3d507 DL |
2984 | |
2985 | (defun edebug-toggle-save-all-windows () | |
2986 | "Toggle the saving and restoring of all windows. | |
2987 | Also, each time you toggle it on, the inside and outside window | |
2988 | configurations become the same as the current configuration." | |
84fc2cfa | 2989 | (interactive) |
1fe3d507 DL |
2990 | (setq edebug-save-windows (not edebug-save-windows)) |
2991 | (if edebug-save-windows | |
84fc2cfa ER |
2992 | (setq edebug-inside-windows |
2993 | (setq edebug-outside-windows | |
1fe3d507 DL |
2994 | (edebug-current-windows |
2995 | edebug-save-windows)))) | |
2996 | (message "Window saving is %s for all windows." | |
84fc2cfa ER |
2997 | (if edebug-save-windows "on" "off"))) |
2998 | ||
1fe3d507 | 2999 | (defmacro edebug-changing-windows (&rest body) |
d8f1319a GM |
3000 | `(let ((window (selected-window))) |
3001 | (setq edebug-inside-windows (edebug-current-windows t)) | |
3002 | (edebug-set-windows edebug-outside-windows) | |
3003 | ,@body;; Code to change edebug-save-windows | |
a1506d29 | 3004 | (setq edebug-outside-windows (edebug-current-windows |
d8f1319a GM |
3005 | edebug-save-windows)) |
3006 | ;; Problem: what about outside windows that are deleted inside? | |
3007 | (edebug-set-windows edebug-inside-windows))) | |
1fe3d507 DL |
3008 | |
3009 | (defun edebug-toggle-save-selected-window () | |
a1506d29 | 3010 | "Toggle the saving and restoring of the selected window. |
1fe3d507 DL |
3011 | Also, each time you toggle it on, the inside and outside window |
3012 | configurations become the same as the current configuration." | |
3013 | (interactive) | |
3014 | (cond | |
3015 | ((eq t edebug-save-windows) | |
3016 | ;; Save all outside windows except the selected one. | |
3017 | ;; Remove (selected-window) from outside-windows. | |
3018 | (edebug-changing-windows | |
3019 | (setq edebug-save-windows (delq window (edebug-window-list))))) | |
3020 | ||
3021 | ((memq (selected-window) edebug-save-windows) | |
3022 | (setq edebug-outside-windows | |
3023 | (delq (assq (selected-window) edebug-outside-windows) | |
3024 | edebug-outside-windows)) | |
3025 | (setq edebug-save-windows | |
3026 | (delq (selected-window) edebug-save-windows))) | |
3027 | (t ; Save a new window. | |
3028 | (edebug-changing-windows | |
3029 | (setq edebug-save-windows (cons window edebug-save-windows))))) | |
3030 | ||
3031 | (message "Window saving is %s for %s." | |
3032 | (if (memq (selected-window) edebug-save-windows) | |
3033 | "on" "off") | |
3034 | (selected-window))) | |
3035 | ||
3036 | (defun edebug-toggle-save-windows (arg) | |
3037 | "Toggle the saving and restoring of windows. | |
3038 | With prefix, toggle for just the selected window. | |
3039 | Otherwise, toggle for all windows." | |
3040 | (interactive "P") | |
3041 | (if arg | |
3042 | (edebug-toggle-save-selected-window) | |
3043 | (edebug-toggle-save-all-windows))) | |
3044 | ||
84fc2cfa ER |
3045 | |
3046 | (defun edebug-where () | |
3047 | "Show the debug windows and where we stopped in the program." | |
3048 | (interactive) | |
3049 | (if (not edebug-active) | |
1fe3d507 DL |
3050 | (error "Edebug is not active")) |
3051 | ;; Restore the window configuration to what it last was inside. | |
3052 | ;; But it is not always set. - experiment | |
3053 | ;;(if edebug-inside-windows | |
3054 | ;; (edebug-set-windows edebug-inside-windows)) | |
84fc2cfa | 3055 | (edebug-pop-to-buffer edebug-buffer) |
1fe3d507 | 3056 | (goto-char edebug-point)) |
84fc2cfa ER |
3057 | |
3058 | (defun edebug-view-outside () | |
3059 | "Change to the outside window configuration." | |
3060 | (interactive) | |
3061 | (if (not edebug-active) | |
1fe3d507 | 3062 | (error "Edebug is not active")) |
a1506d29 | 3063 | (setq edebug-inside-windows |
1fe3d507 DL |
3064 | (edebug-current-windows edebug-save-windows)) |
3065 | (edebug-set-windows edebug-outside-windows) | |
84fc2cfa | 3066 | (goto-char edebug-outside-point) |
1fe3d507 | 3067 | (message "Window configuration outside of Edebug. Return with %s" |
84fc2cfa ER |
3068 | (substitute-command-keys "\\<global-map>\\[edebug-where]"))) |
3069 | ||
3070 | ||
1fe3d507 DL |
3071 | (defun edebug-bounce-point (arg) |
3072 | "Bounce the point in the outside current buffer. | |
3073 | If prefix arg is supplied, sit for that many seconds before returning. | |
3074 | The default is one second." | |
3075 | (interactive "p") | |
84fc2cfa | 3076 | (if (not edebug-active) |
1fe3d507 | 3077 | (error "Edebug is not active")) |
84fc2cfa | 3078 | (save-excursion |
1fe3d507 | 3079 | ;; If the buffer's currently displayed, avoid set-window-configuration. |
84fc2cfa ER |
3080 | (save-window-excursion |
3081 | (edebug-pop-to-buffer edebug-outside-buffer) | |
84fc2cfa | 3082 | (goto-char edebug-outside-point) |
a1506d29 JB |
3083 | (message "Current buffer: %s Point: %s Mark: %s" |
3084 | (current-buffer) (point) | |
1fe3d507 DL |
3085 | (if (marker-buffer (edebug-mark-marker)) |
3086 | (marker-position (edebug-mark-marker)) "<not set>")) | |
3087 | (edebug-sit-for arg) | |
3088 | (edebug-pop-to-buffer edebug-buffer (car edebug-window-data))))) | |
84fc2cfa | 3089 | |
84fc2cfa | 3090 | |
a1506d29 | 3091 | ;; Joe Wells, here is a start at your idea of adding a buffer to the internal |
1fe3d507 | 3092 | ;; display list. Still need to use this list in edebug-display. |
84fc2cfa | 3093 | |
1fe3d507 DL |
3094 | '(defvar edebug-display-buffer-list nil |
3095 | "List of buffers that edebug will display when it is active.") | |
84fc2cfa | 3096 | |
1fe3d507 DL |
3097 | '(defun edebug-display-buffer (buffer) |
3098 | "Toggle display of a buffer inside of edebug." | |
3099 | (interactive "bBuffer: ") | |
3100 | (let ((already-displaying (memq buffer edebug-display-buffer-list))) | |
3101 | (setq edebug-display-buffer-list | |
3102 | (if already-displaying | |
3103 | (delq buffer edebug-display-buffer-list) | |
3104 | (cons buffer edebug-display-buffer-list))) | |
3105 | (message "Displaying %s %s" buffer | |
3106 | (if already-displaying "off" "on")))) | |
84fc2cfa | 3107 | |
1fe3d507 | 3108 | ;;; Breakpoint related functions |
84fc2cfa ER |
3109 | |
3110 | (defun edebug-find-stop-point () | |
1fe3d507 DL |
3111 | ;; Return (function . index) of the nearest edebug stop point. |
3112 | (let* ((edebug-def-name (edebug-form-data-symbol)) | |
84fc2cfa | 3113 | (edebug-data |
1fe3d507 DL |
3114 | (let ((data (get edebug-def-name 'edebug))) |
3115 | (if (or (null data) (markerp data)) | |
3116 | (error "%s is not instrumented for Edebug" edebug-def-name)) | |
3117 | data)) ; we could do it automatically, if data is a marker. | |
84fc2cfa | 3118 | ;; pull out parts of edebug-data. |
1fe3d507 DL |
3119 | (edebug-def-mark (car edebug-data)) |
3120 | ;; (edebug-breakpoints (car (cdr edebug-data))) | |
84fc2cfa | 3121 | |
1fe3d507 | 3122 | (offset-vector (nth 2 edebug-data)) |
84fc2cfa ER |
3123 | (offset (- (save-excursion |
3124 | (if (looking-at "[ \t]") | |
3125 | ;; skip backwards until non-whitespace, or bol | |
3126 | (skip-chars-backward " \t")) | |
3127 | (point)) | |
1fe3d507 | 3128 | edebug-def-mark)) |
84fc2cfa ER |
3129 | len i) |
3130 | ;; the offsets are in order so we can do a linear search | |
3131 | (setq len (length offset-vector)) | |
3132 | (setq i 0) | |
3133 | (while (and (< i len) (> offset (aref offset-vector i))) | |
3134 | (setq i (1+ i))) | |
3135 | (if (and (< i len) | |
3136 | (<= offset (aref offset-vector i))) | |
3137 | ;; return the relevant info | |
1fe3d507 | 3138 | (cons edebug-def-name i) |
84fc2cfa | 3139 | (message "Point is not on an expression in %s." |
1fe3d507 | 3140 | edebug-def-name) |
84fc2cfa ER |
3141 | ))) |
3142 | ||
3143 | ||
3144 | (defun edebug-next-breakpoint () | |
3145 | "Move point to the next breakpoint, or first if none past point." | |
3146 | (interactive) | |
3147 | (let ((edebug-stop-point (edebug-find-stop-point))) | |
3148 | (if edebug-stop-point | |
1fe3d507 | 3149 | (let* ((edebug-def-name (car edebug-stop-point)) |
84fc2cfa | 3150 | (index (cdr edebug-stop-point)) |
1fe3d507 | 3151 | (edebug-data (get edebug-def-name 'edebug)) |
a1506d29 | 3152 | |
84fc2cfa | 3153 | ;; pull out parts of edebug-data |
1fe3d507 | 3154 | (edebug-def-mark (car edebug-data)) |
84fc2cfa | 3155 | (edebug-breakpoints (car (cdr edebug-data))) |
1fe3d507 | 3156 | (offset-vector (nth 2 edebug-data)) |
84fc2cfa ER |
3157 | breakpoint) |
3158 | (if (not edebug-breakpoints) | |
3159 | (message "No breakpoints in this function.") | |
3160 | (let ((breaks edebug-breakpoints)) | |
3161 | (while (and breaks | |
3162 | (<= (car (car breaks)) index)) | |
3163 | (setq breaks (cdr breaks))) | |
3164 | (setq breakpoint | |
3165 | (if breaks | |
3166 | (car breaks) | |
3167 | ;; goto the first breakpoint | |
3168 | (car edebug-breakpoints))) | |
1fe3d507 | 3169 | (goto-char (+ edebug-def-mark |
84fc2cfa | 3170 | (aref offset-vector (car breakpoint)))) |
a1506d29 | 3171 | |
f7359658 RS |
3172 | (message "%s" |
3173 | (concat (if (nth 2 breakpoint) | |
84fc2cfa ER |
3174 | "Temporary " "") |
3175 | (if (car (cdr breakpoint)) | |
3176 | (format "Condition: %s" | |
1fe3d507 | 3177 | (edebug-safe-prin1-to-string |
84fc2cfa ER |
3178 | (car (cdr breakpoint)))) |
3179 | ""))) | |
3180 | )))))) | |
3181 | ||
3182 | ||
3183 | (defun edebug-modify-breakpoint (flag &optional condition temporary) | |
3184 | "Modify the breakpoint for the form at point or after it according | |
3185 | to FLAG: set if t, clear if nil. Then move to that point. | |
3186 | If CONDITION or TEMPORARY are non-nil, add those attributes to | |
a1506d29 | 3187 | the breakpoint. " |
84fc2cfa ER |
3188 | (let ((edebug-stop-point (edebug-find-stop-point))) |
3189 | (if edebug-stop-point | |
1fe3d507 | 3190 | (let* ((edebug-def-name (car edebug-stop-point)) |
84fc2cfa | 3191 | (index (cdr edebug-stop-point)) |
1fe3d507 | 3192 | (edebug-data (get edebug-def-name 'edebug)) |
a1506d29 | 3193 | |
84fc2cfa | 3194 | ;; pull out parts of edebug-data |
1fe3d507 | 3195 | (edebug-def-mark (car edebug-data)) |
84fc2cfa | 3196 | (edebug-breakpoints (car (cdr edebug-data))) |
1fe3d507 | 3197 | (offset-vector (nth 2 edebug-data)) |
84fc2cfa ER |
3198 | present) |
3199 | ;; delete it either way | |
3200 | (setq present (assq index edebug-breakpoints)) | |
3201 | (setq edebug-breakpoints (delq present edebug-breakpoints)) | |
3202 | (if flag | |
3203 | (progn | |
3204 | ;; add it to the list and resort | |
3205 | (setq edebug-breakpoints | |
3206 | (edebug-sort-alist | |
3207 | (cons | |
3208 | (list index condition temporary) | |
3209 | edebug-breakpoints) '<)) | |
1fe3d507 DL |
3210 | (if condition |
3211 | (message "Breakpoint set in %s with condition: %s" | |
3212 | edebug-def-name condition) | |
3213 | (message "Breakpoint set in %s" edebug-def-name))) | |
84fc2cfa | 3214 | (if present |
1fe3d507 DL |
3215 | (message "Breakpoint unset in %s" edebug-def-name) |
3216 | (message "No breakpoint here"))) | |
a1506d29 | 3217 | |
1fe3d507 DL |
3218 | (setcar (cdr edebug-data) edebug-breakpoints) |
3219 | (goto-char (+ edebug-def-mark (aref offset-vector index))) | |
84fc2cfa ER |
3220 | )))) |
3221 | ||
3222 | (defun edebug-set-breakpoint (arg) | |
3223 | "Set the breakpoint of nearest sexp. | |
3224 | With prefix argument, make it a temporary breakpoint." | |
3225 | (interactive "P") | |
3226 | (edebug-modify-breakpoint t nil arg)) | |
3227 | ||
3228 | (defun edebug-unset-breakpoint () | |
3229 | "Clear the breakpoint of nearest sexp." | |
3230 | (interactive) | |
3231 | (edebug-modify-breakpoint nil)) | |
3232 | ||
1fe3d507 | 3233 | |
1fe3d507 | 3234 | (defun edebug-set-global-break-condition (expression) |
a1506d29 JB |
3235 | (interactive (list (read-minibuffer |
3236 | "Global Condition: " | |
1fe3d507 DL |
3237 | (format "%s" edebug-global-break-condition)))) |
3238 | (setq edebug-global-break-condition expression)) | |
3239 | ||
3240 | ||
3241 | ;;; Mode switching functions | |
84fc2cfa ER |
3242 | |
3243 | (defun edebug-set-mode (mode shortmsg msg) | |
1fe3d507 DL |
3244 | ;; Set the edebug mode to MODE. |
3245 | ;; Display SHORTMSG, or MSG if not within edebug. | |
3246 | (if (eq (1+ edebug-recursion-depth) (recursion-depth)) | |
3247 | (progn | |
3248 | (setq edebug-execution-mode mode) | |
3249 | (message shortmsg) | |
3250 | ;; Continue execution | |
3251 | (exit-recursive-edit)) | |
3252 | ;; This is not terribly useful!! | |
3253 | (setq edebug-next-execution-mode mode) | |
84fc2cfa ER |
3254 | (message msg))) |
3255 | ||
3256 | ||
1fe3d507 DL |
3257 | (defalias 'edebug-step-through-mode 'edebug-step-mode) |
3258 | ||
3259 | (defun edebug-step-mode () | |
3260 | "Proceed to next stop point." | |
3261 | (interactive) | |
3262 | (edebug-set-mode 'step "" "Edebug will stop at next stop point.")) | |
3263 | ||
3264 | (defun edebug-next-mode () | |
3265 | "Proceed to next `after' stop point." | |
84fc2cfa | 3266 | (interactive) |
1fe3d507 | 3267 | (edebug-set-mode 'next "" "Edebug will stop after next eval.")) |
84fc2cfa | 3268 | |
1fe3d507 | 3269 | (defun edebug-go-mode (arg) |
84fc2cfa | 3270 | "Go, evaluating until break. |
1fe3d507 | 3271 | With prefix ARG, set temporary break at current point and go." |
84fc2cfa ER |
3272 | (interactive "P") |
3273 | (if arg | |
3274 | (edebug-set-breakpoint t)) | |
1fe3d507 | 3275 | (edebug-set-mode 'go "Go..." "Edebug will go until break.")) |
84fc2cfa | 3276 | |
1fe3d507 | 3277 | (defun edebug-Go-nonstop-mode () |
84fc2cfa ER |
3278 | "Go, evaluating without debugging." |
3279 | (interactive) | |
3280 | (edebug-set-mode 'Go-nonstop "Go-Nonstop..." | |
1fe3d507 DL |
3281 | "Edebug will not stop at breaks.")) |
3282 | ||
3283 | ||
3284 | (defun edebug-trace-mode () | |
3285 | "Begin trace mode." | |
3286 | (interactive) | |
3287 | (edebug-set-mode 'trace "Tracing..." "Edebug will trace with pause.")) | |
3288 | ||
3289 | (defun edebug-Trace-fast-mode () | |
3290 | "Trace with no wait at each step." | |
3291 | (interactive) | |
3292 | (edebug-set-mode 'Trace-fast | |
3293 | "Trace fast..." "Edebug will trace without pause.")) | |
3294 | ||
3295 | (defun edebug-continue-mode () | |
3296 | "Begin continue mode." | |
3297 | (interactive) | |
3298 | (edebug-set-mode 'continue "Continue..." | |
3299 | "Edebug will pause at breakpoints.")) | |
3300 | ||
3301 | (defun edebug-Continue-fast-mode () | |
3302 | "Trace with no wait at each step." | |
3303 | (interactive) | |
3304 | (edebug-set-mode 'Continue-fast "Continue fast..." | |
3305 | "Edebug will stop and go at breakpoints.")) | |
3306 | ||
3307 | ;; ------------------------------------------------------------ | |
3308 | ;; The following use the mode changing commands and breakpoints. | |
3309 | ||
3310 | ||
3311 | (defun edebug-goto-here () | |
3312 | "Proceed to this stop point." | |
3313 | (interactive) | |
3314 | (edebug-go-mode t)) | |
3315 | ||
3316 | ||
3317 | (defun edebug-stop () | |
3318 | "Stop execution and do not continue. | |
3319 | Useful for exiting from trace or continue loop." | |
3320 | (interactive) | |
3321 | (message "Stop")) | |
3322 | ||
3323 | ||
3324 | '(defun edebug-forward () | |
3325 | "Proceed to the exit of the next expression to be evaluated." | |
3326 | (interactive) | |
a1506d29 | 3327 | (edebug-set-mode |
1fe3d507 DL |
3328 | 'forward "Forward" |
3329 | "Edebug will stop after exiting the next expression.")) | |
3330 | ||
84fc2cfa ER |
3331 | |
3332 | (defun edebug-forward-sexp (arg) | |
3333 | "Proceed from the current point to the end of the ARGth sexp ahead. | |
3334 | If there are not ARG sexps ahead, then do edebug-step-out." | |
3335 | (interactive "p") | |
1fe3d507 | 3336 | (condition-case nil |
84fc2cfa ER |
3337 | (let ((parse-sexp-ignore-comments t)) |
3338 | ;; Call forward-sexp repeatedly until done or failure. | |
3339 | (forward-sexp arg) | |
1fe3d507 | 3340 | (edebug-go-mode t)) |
84fc2cfa ER |
3341 | (error |
3342 | (edebug-step-out) | |
3343 | ))) | |
3344 | ||
3345 | (defun edebug-step-out () | |
3346 | "Proceed from the current point to the end of the containing sexp. | |
3347 | If there is no containing sexp that is not the top level defun, | |
3348 | go to the end of the last sexp, or if that is the same point, then step." | |
3349 | (interactive) | |
1fe3d507 | 3350 | (condition-case nil |
84fc2cfa ER |
3351 | (let ((parse-sexp-ignore-comments t)) |
3352 | (up-list 1) | |
3353 | (save-excursion | |
3354 | ;; Is there still a containing expression? | |
3355 | (up-list 1)) | |
1fe3d507 | 3356 | (edebug-go-mode t)) |
84fc2cfa ER |
3357 | (error |
3358 | ;; At top level - 1, so first check if there are more sexps at this level. | |
3359 | (let ((start-point (point))) | |
3360 | ;; (up-list 1) | |
3361 | (down-list -1) | |
3362 | (if (= (point) start-point) | |
1fe3d507 DL |
3363 | (edebug-step-mode) ; No more at this level, so step. |
3364 | (edebug-go-mode t) | |
84fc2cfa ER |
3365 | ))))) |
3366 | ||
1fe3d507 DL |
3367 | (defun edebug-instrument-function (func) |
3368 | ;; Func should be a function symbol. | |
3369 | ;; Return the function symbol, or nil if not instrumented. | |
3ebb8416 | 3370 | (let ((func-marker (get func 'edebug))) |
1fe3d507 DL |
3371 | (cond |
3372 | ((markerp func-marker) | |
3373 | ;; It is uninstrumented, so instrument it. | |
3ebb8416 | 3374 | (with-current-buffer (marker-buffer func-marker) |
1fe3d507 DL |
3375 | (goto-char func-marker) |
3376 | (edebug-eval-top-level-form) | |
3377 | func)) | |
3378 | ((consp func-marker) | |
3379 | (message "%s is already instrumented." func) | |
3380 | func) | |
3ebb8416 SM |
3381 | (t |
3382 | (let ((loc (find-function-noselect func))) | |
3383 | (with-current-buffer (car loc) | |
3384 | (goto-char (cdr loc)) | |
3385 | (edebug-eval-top-level-form) | |
3386 | func)))))) | |
1fe3d507 DL |
3387 | |
3388 | (defun edebug-instrument-callee () | |
a1506d29 | 3389 | "Instrument the definition of the function or macro about to be called. |
1fe3d507 DL |
3390 | Do this when stopped before the form or it will be too late. |
3391 | One side effect of using this command is that the next time the | |
3392 | function or macro is called, Edebug will be called there as well." | |
84fc2cfa | 3393 | (interactive) |
1fe3d507 DL |
3394 | (if (not (looking-at "\(")) |
3395 | (error "You must be before a list form") | |
3396 | (let ((func | |
3397 | (save-excursion | |
3398 | (down-list 1) | |
3399 | (if (looking-at "\(") | |
3400 | (edebug-form-data-name | |
3401 | (edebug-get-form-data-entry (point))) | |
88668147 | 3402 | (edebug-original-read (current-buffer)))))) |
1fe3d507 | 3403 | (edebug-instrument-function func)))) |
84fc2cfa | 3404 | |
84fc2cfa | 3405 | |
1fe3d507 | 3406 | (defun edebug-step-in () |
a1506d29 JB |
3407 | "Step into the definition of the function or macro about to be called. |
3408 | This first does `edebug-instrument-callee' to ensure that it is | |
1fe3d507 | 3409 | instrumented. Then it does `edebug-on-entry' and switches to `go' mode." |
84fc2cfa | 3410 | (interactive) |
1fe3d507 DL |
3411 | (let ((func (edebug-instrument-callee))) |
3412 | (if func | |
3413 | (progn | |
3414 | (edebug-on-entry func 'temp) | |
3415 | (edebug-go-mode nil))))) | |
84fc2cfa | 3416 | |
1fe3d507 DL |
3417 | (defun edebug-on-entry (function &optional flag) |
3418 | "Cause Edebug to stop when FUNCTION is called. | |
3419 | With prefix argument, make this temporary so it is automatically | |
3420 | cancelled the first time the function is entered." | |
3421 | (interactive "aEdebug on entry to: \nP") | |
3422 | ;; Could store this in the edebug data instead. | |
3423 | (put function 'edebug-on-entry (if flag 'temp t))) | |
84fc2cfa | 3424 | |
1fe3d507 DL |
3425 | (defun cancel-edebug-on-entry (function) |
3426 | (interactive "aEdebug on entry to: ") | |
3427 | (put function 'edebug-on-entry nil)) | |
84fc2cfa | 3428 | |
a1506d29 | 3429 | |
88668147 DL |
3430 | (if (not (fboundp 'edebug-original-debug-on-entry)) |
3431 | (fset 'edebug-original-debug-on-entry (symbol-function 'debug-on-entry))) | |
1fe3d507 DL |
3432 | '(fset 'debug-on-entry 'edebug-debug-on-entry) ;; Should we do this? |
3433 | ;; Also need edebug-cancel-debug-on-entry | |
3434 | ||
3435 | '(defun edebug-debug-on-entry (function) | |
3436 | "Request FUNCTION to invoke debugger each time it is called. | |
3437 | If the user continues, FUNCTION's execution proceeds. | |
3438 | Works by modifying the definition of FUNCTION, | |
3439 | which must be written in Lisp, not predefined. | |
3440 | Use `cancel-debug-on-entry' to cancel the effect of this command. | |
3441 | Redefining FUNCTION also does that. | |
3442 | ||
3443 | This version is from Edebug. If the function is instrumented for | |
6db746da | 3444 | Edebug, it calls `edebug-on-entry'." |
1fe3d507 DL |
3445 | (interactive "aDebug on entry (to function): ") |
3446 | (let ((func-data (get function 'edebug))) | |
3447 | (if (or (null func-data) (markerp func-data)) | |
88668147 | 3448 | (edebug-original-debug-on-entry function) |
1fe3d507 DL |
3449 | (edebug-on-entry function)))) |
3450 | ||
3451 | ||
3452 | (defun edebug-top-level-nonstop () | |
3453 | "Set mode to Go-nonstop, and exit to top-level. | |
3454 | This is useful for exiting even if unwind-protect code may be executed." | |
84fc2cfa | 3455 | (interactive) |
1fe3d507 DL |
3456 | (setq edebug-execution-mode 'Go-nonstop) |
3457 | (top-level)) | |
84fc2cfa ER |
3458 | |
3459 | ||
3460 | ;;(defun edebug-exit-out () | |
3461 | ;; "Go until the current function exits." | |
3462 | ;; (interactive) | |
3463 | ;; (edebug-set-mode 'exiting "Exit...")) | |
3464 | ||
3465 | ||
84fc2cfa ER |
3466 | ;;; The following initial mode setting definitions are not used yet. |
3467 | ||
1fe3d507 | 3468 | '(defconst edebug-initial-mode-alist |
84fc2cfa ER |
3469 | '((edebug-Continue-fast . Continue-fast) |
3470 | (edebug-Trace-fast . Trace-fast) | |
3471 | (edebug-continue . continue) | |
3472 | (edebug-trace . trace) | |
3473 | (edebug-go . go) | |
3474 | (edebug-step-through . step) | |
3475 | (edebug-Go-nonstop . Go-nonstop) | |
3476 | ) | |
3477 | "Association list between commands and the modes they set.") | |
3478 | ||
3479 | ||
1fe3d507 | 3480 | '(defun edebug-set-initial-mode () |
84fc2cfa ER |
3481 | "Ask for the initial mode of the enclosing function. |
3482 | The mode is requested via the key that would be used to set the mode in | |
3483 | edebug-mode." | |
3484 | (interactive) | |
3485 | (let* ((this-function (edebug-which-function)) | |
3486 | (keymap (if (eq edebug-mode-map (current-local-map)) | |
3487 | edebug-mode-map)) | |
3488 | (old-mode (or (get this-function 'edebug-initial-mode) | |
3489 | edebug-initial-mode)) | |
3490 | (key (read-key-sequence | |
3491 | (format | |
3492 | "Change initial edebug mode for %s from %s (%s) to (enter key): " | |
3493 | this-function | |
3494 | old-mode | |
3495 | (where-is-internal | |
3496 | (car (rassq old-mode edebug-initial-mode-alist)) | |
3497 | keymap 'firstonly | |
3498 | )))) | |
3499 | (mode (cdr (assq (key-binding key) edebug-initial-mode-alist))) | |
3500 | ) | |
3501 | (if (and mode | |
3502 | (or (get this-function 'edebug-initial-mode) | |
3503 | (not (eq mode edebug-initial-mode)))) | |
3504 | (progn | |
3505 | (put this-function 'edebug-initial-mode mode) | |
3506 | (message "Initial mode for %s is now: %s" | |
3507 | this-function mode)) | |
4897b0a0 | 3508 | (error "Key must map to one of the mode changing commands") |
84fc2cfa ER |
3509 | ))) |
3510 | ||
1fe3d507 | 3511 | ;;; Evaluation of expressions |
84fc2cfa | 3512 | |
1fe3d507 | 3513 | (def-edebug-spec edebug-outside-excursion t) |
84fc2cfa | 3514 | |
1fe3d507 DL |
3515 | (defmacro edebug-outside-excursion (&rest body) |
3516 | "Evaluate an expression list in the outside context. | |
3517 | Return the result of the last expression." | |
d8f1319a GM |
3518 | `(save-excursion ; of current-buffer |
3519 | (if edebug-save-windows | |
3520 | (progn | |
a1506d29 | 3521 | ;; After excursion, we will |
d8f1319a GM |
3522 | ;; restore to current window configuration. |
3523 | (setq edebug-inside-windows | |
3524 | (edebug-current-windows edebug-save-windows)) | |
3525 | ;; Restore outside windows. | |
3526 | (edebug-set-windows edebug-outside-windows))) | |
3527 | ||
3528 | (set-buffer edebug-buffer) ; why? | |
3529 | ;; (use-local-map edebug-outside-map) | |
3530 | (set-match-data edebug-outside-match-data) | |
3531 | ;; Restore outside context. | |
3532 | (let (;; (edebug-inside-map (current-local-map)) ;; restore map?? | |
3533 | (last-command-char edebug-outside-last-command-char) | |
3534 | (last-command-event edebug-outside-last-command-event) | |
3535 | (last-command edebug-outside-last-command) | |
3536 | (this-command edebug-outside-this-command) | |
3537 | (unread-command-char edebug-outside-unread-command-char) | |
d8f1319a GM |
3538 | (unread-command-events edebug-outside-unread-command-events) |
3539 | (current-prefix-arg edebug-outside-current-prefix-arg) | |
3540 | (last-input-char edebug-outside-last-input-char) | |
3541 | (last-input-event edebug-outside-last-input-event) | |
3542 | (last-event-frame edebug-outside-last-event-frame) | |
3543 | (last-nonmenu-event edebug-outside-last-nonmenu-event) | |
3544 | (track-mouse edebug-outside-track-mouse) | |
3545 | (standard-output edebug-outside-standard-output) | |
3546 | (standard-input edebug-outside-standard-input) | |
3547 | ||
3548 | (executing-kbd-macro edebug-outside-executing-macro) | |
3549 | (defining-kbd-macro edebug-outside-defining-kbd-macro) | |
6b61353c KH |
3550 | ;; Get the values out of the saved statuses. |
3551 | (pre-command-hook (cdr edebug-outside-pre-command-hook)) | |
3552 | (post-command-hook (cdr edebug-outside-post-command-hook)) | |
d8f1319a GM |
3553 | |
3554 | ;; See edebug-display | |
3555 | (overlay-arrow-position edebug-outside-o-a-p) | |
3556 | (overlay-arrow-string edebug-outside-o-a-s) | |
3557 | (cursor-in-echo-area edebug-outside-c-i-e-a) | |
3558 | ) | |
3559 | (unwind-protect | |
3560 | (save-excursion ; of edebug-buffer | |
3561 | (set-buffer edebug-outside-buffer) | |
3562 | (goto-char edebug-outside-point) | |
3563 | (if (marker-buffer (edebug-mark-marker)) | |
3564 | (set-marker (edebug-mark-marker) edebug-outside-mark)) | |
3565 | ,@body) | |
3566 | ||
3567 | ;; Back to edebug-buffer. Restore rest of inside context. | |
3568 | ;; (use-local-map edebug-inside-map) | |
3569 | (if edebug-save-windows | |
3570 | ;; Restore inside windows. | |
3571 | (edebug-set-windows edebug-inside-windows)) | |
3572 | ||
3573 | ;; Save values that may have been changed. | |
a1506d29 | 3574 | (setq |
d8f1319a GM |
3575 | edebug-outside-last-command-char last-command-char |
3576 | edebug-outside-last-command-event last-command-event | |
3577 | edebug-outside-last-command last-command | |
3578 | edebug-outside-this-command this-command | |
3579 | edebug-outside-unread-command-char unread-command-char | |
d8f1319a GM |
3580 | edebug-outside-unread-command-events unread-command-events |
3581 | edebug-outside-current-prefix-arg current-prefix-arg | |
3582 | edebug-outside-last-input-char last-input-char | |
3583 | edebug-outside-last-input-event last-input-event | |
3584 | edebug-outside-last-event-frame last-event-frame | |
3585 | edebug-outside-last-nonmenu-event last-nonmenu-event | |
3586 | edebug-outside-track-mouse track-mouse | |
3587 | edebug-outside-standard-output standard-output | |
3588 | edebug-outside-standard-input standard-input | |
3589 | ||
3590 | edebug-outside-executing-macro executing-kbd-macro | |
3591 | edebug-outside-defining-kbd-macro defining-kbd-macro | |
d8f1319a GM |
3592 | |
3593 | edebug-outside-o-a-p overlay-arrow-position | |
3594 | edebug-outside-o-a-s overlay-arrow-string | |
3595 | edebug-outside-c-i-e-a cursor-in-echo-area | |
6b61353c KH |
3596 | ) |
3597 | ||
3598 | ;; Restore the outside saved values; don't alter | |
3599 | ;; the outside binding loci. | |
3600 | (setcdr edebug-outside-pre-command-hook pre-command-hook) | |
3601 | (setcdr edebug-outside-post-command-hook post-command-hook) | |
3602 | ||
3603 | )) ; let | |
d8f1319a | 3604 | )) |
1fe3d507 DL |
3605 | |
3606 | (defvar cl-debug-env nil) ;; defined in cl; non-nil when lexical env used. | |
3607 | ||
3608 | (defun edebug-eval (edebug-expr) | |
3609 | ;; Are there cl lexical variables active? | |
3610 | (if cl-debug-env | |
3611 | (eval (cl-macroexpand-all edebug-expr cl-debug-env)) | |
3612 | (eval edebug-expr))) | |
3613 | ||
3614 | (defun edebug-safe-eval (edebug-expr) | |
a1506d29 | 3615 | ;; Evaluate EXPR safely. |
1fe3d507 DL |
3616 | ;; If there is an error, a string is returned describing the error. |
3617 | (condition-case edebug-err | |
3618 | (edebug-eval edebug-expr) | |
a1506d29 | 3619 | (error (edebug-format "%s: %s" ;; could |
1fe3d507 DL |
3620 | (get (car edebug-err) 'error-message) |
3621 | (car (cdr edebug-err)))))) | |
3622 | ||
f7359658 RS |
3623 | ;;; Printing |
3624 | ||
1fe3d507 DL |
3625 | ;; Replace printing functions. |
3626 | ||
3627 | ;; obsolete names | |
3628 | (defalias 'edebug-install-custom-print-funcs 'edebug-install-custom-print) | |
3629 | (defalias 'edebug-reset-print-funcs 'edebug-uninstall-custom-print) | |
3630 | (defalias 'edebug-uninstall-custom-print-funcs 'edebug-uninstall-custom-print) | |
3631 | ||
3632 | (defun edebug-install-custom-print () | |
3633 | "Replace print functions used by Edebug with custom versions." | |
3634 | ;; Modifying the custom print functions, or changing print-length, | |
3635 | ;; print-level, print-circle, custom-print-list or custom-print-vector | |
3636 | ;; have immediate effect. | |
84fc2cfa | 3637 | (interactive) |
1fe3d507 DL |
3638 | (require 'cust-print) |
3639 | (defalias 'edebug-prin1 'custom-prin1) | |
3640 | (defalias 'edebug-print 'custom-print) | |
3641 | (defalias 'edebug-prin1-to-string 'custom-prin1-to-string) | |
3642 | (defalias 'edebug-format 'custom-format) | |
3643 | (defalias 'edebug-message 'custom-message) | |
3644 | "Installed") | |
3645 | ||
3646 | (eval-and-compile | |
3647 | (defun edebug-uninstall-custom-print () | |
3648 | "Replace edebug custom print functions with internal versions." | |
3649 | (interactive) | |
3650 | (defalias 'edebug-prin1 'prin1) | |
3651 | (defalias 'edebug-print 'print) | |
3652 | (defalias 'edebug-prin1-to-string 'prin1-to-string) | |
3653 | (defalias 'edebug-format 'format) | |
3654 | (defalias 'edebug-message 'message) | |
3655 | "Uninstalled") | |
3656 | ||
3657 | ;; Default print functions are the same as Emacs'. | |
3658 | (edebug-uninstall-custom-print)) | |
3659 | ||
3660 | ||
3661 | (defun edebug-report-error (edebug-value) | |
3662 | ;; Print an error message like command level does. | |
3663 | ;; This also prints the error name if it has no error-message. | |
a1506d29 | 3664 | (message "%s: %s" |
1fe3d507 DL |
3665 | (or (get (car edebug-value) 'error-message) |
3666 | (format "peculiar error (%s)" (car edebug-value))) | |
a1506d29 | 3667 | (mapconcat (function (lambda (edebug-arg) |
1fe3d507 DL |
3668 | ;; continuing after an error may |
3669 | ;; complain about edebug-arg. why?? | |
3670 | (prin1-to-string edebug-arg))) | |
3671 | (cdr edebug-value) ", "))) | |
3672 | ||
3673 | ;; Define here in case they are not already defined. | |
3674 | (defvar print-level nil) | |
3675 | (defvar print-circle nil) | |
3676 | (defvar print-readably) ;; defined by lemacs | |
a1506d29 | 3677 | ;; Alternatively, we could change the definition of |
88668147 | 3678 | ;; edebug-safe-prin1-to-string to only use these if defined. |
1fe3d507 DL |
3679 | |
3680 | (defun edebug-safe-prin1-to-string (value) | |
84fc2cfa | 3681 | (let ((print-escape-newlines t) |
1fe3d507 DL |
3682 | (print-length (or edebug-print-length print-length)) |
3683 | (print-level (or edebug-print-level print-level)) | |
3684 | (print-circle (or edebug-print-circle print-circle)) | |
3685 | (print-readably nil)) ;; lemacs uses this. | |
3686 | (edebug-prin1-to-string value))) | |
3687 | ||
3688 | (defun edebug-compute-previous-result (edebug-previous-value) | |
6b61353c KH |
3689 | (if edebug-unwrap-results |
3690 | (setq edebug-previous-value | |
3691 | (edebug-unwrap* edebug-previous-value))) | |
1fe3d507 | 3692 | (setq edebug-previous-result |
6b61353c KH |
3693 | (concat "Result: " |
3694 | (edebug-safe-prin1-to-string edebug-previous-value) | |
3695 | (let ((name (prin1-char edebug-previous-value))) | |
3696 | (if name (concat " = " name)))))) | |
84fc2cfa | 3697 | |
1fe3d507 DL |
3698 | (defun edebug-previous-result () |
3699 | "Print the previous result." | |
3700 | (interactive) | |
3701 | (message "%s" edebug-previous-result)) | |
84fc2cfa | 3702 | |
f7359658 | 3703 | ;;; Read, Eval and Print |
84fc2cfa | 3704 | |
1fe3d507 | 3705 | (defun edebug-eval-expression (edebug-expr) |
a1506d29 | 3706 | "Evaluate an expression in the outside environment. |
1fe3d507 | 3707 | If interactive, prompt for the expression. |
84fc2cfa | 3708 | Print result in minibuffer." |
a1506d29 | 3709 | (interactive (list (read-from-minibuffer |
10b088c6 RS |
3710 | "Eval: " nil read-expression-map t |
3711 | 'read-expression-history))) | |
1fe3d507 DL |
3712 | (princ |
3713 | (edebug-outside-excursion | |
3714 | (setq values (cons (edebug-eval edebug-expr) values)) | |
3715 | (edebug-safe-prin1-to-string (car values))))) | |
84fc2cfa ER |
3716 | |
3717 | (defun edebug-eval-last-sexp () | |
6b61353c | 3718 | "Evaluate sexp before point in the outside environment; value in minibuffer." |
84fc2cfa | 3719 | (interactive) |
1fe3d507 | 3720 | (edebug-eval-expression (edebug-last-sexp))) |
84fc2cfa ER |
3721 | |
3722 | (defun edebug-eval-print-last-sexp () | |
6b61353c KH |
3723 | "Evaluate sexp before point in the outside environment; insert the value. |
3724 | This prints the value into current buffer." | |
84fc2cfa | 3725 | (interactive) |
1fe3d507 DL |
3726 | (let* ((edebug-form (edebug-last-sexp)) |
3727 | (edebug-result-string | |
a1506d29 | 3728 | (edebug-outside-excursion |
1fe3d507 DL |
3729 | (edebug-safe-prin1-to-string (edebug-safe-eval edebug-form)))) |
3730 | (standard-output (current-buffer))) | |
3731 | (princ "\n") | |
3732 | ;; princ the string to get rid of quotes. | |
3733 | (princ edebug-result-string) | |
3734 | (princ "\n") | |
3735 | )) | |
3736 | ||
a1506d29 | 3737 | ;;; Edebug Minor Mode |
84fc2cfa | 3738 | |
6b61353c KH |
3739 | (defvar gud-inhibit-global-bindings |
3740 | "*Non-nil means don't do global rebindings of C-x C-a subcommands.") | |
a1506d29 | 3741 | |
6b61353c KH |
3742 | ;; Global GUD bindings for all emacs-lisp-mode buffers. |
3743 | (unless gud-inhibit-global-bindings | |
3744 | (define-key emacs-lisp-mode-map "\C-x\C-a\C-s" 'edebug-step-mode) | |
3745 | (define-key emacs-lisp-mode-map "\C-x\C-a\C-n" 'edebug-next-mode) | |
3746 | (define-key emacs-lisp-mode-map "\C-x\C-a\C-c" 'edebug-go-mode) | |
3747 | (define-key emacs-lisp-mode-map "\C-x\C-a\C-l" 'edebug-where)) | |
84fc2cfa | 3748 | |
d778509c SM |
3749 | (defvar edebug-mode-map |
3750 | (let ((map (copy-keymap emacs-lisp-mode-map))) | |
84fc2cfa | 3751 | ;; control |
d778509c SM |
3752 | (define-key map " " 'edebug-step-mode) |
3753 | (define-key map "n" 'edebug-next-mode) | |
3754 | (define-key map "g" 'edebug-go-mode) | |
3755 | (define-key map "G" 'edebug-Go-nonstop-mode) | |
3756 | (define-key map "t" 'edebug-trace-mode) | |
3757 | (define-key map "T" 'edebug-Trace-fast-mode) | |
3758 | (define-key map "c" 'edebug-continue-mode) | |
3759 | (define-key map "C" 'edebug-Continue-fast-mode) | |
3760 | ||
3761 | ;;(define-key map "f" 'edebug-forward) not implemented | |
3762 | (define-key map "f" 'edebug-forward-sexp) | |
3763 | (define-key map "h" 'edebug-goto-here) | |
3764 | ||
3765 | (define-key map "I" 'edebug-instrument-callee) | |
3766 | (define-key map "i" 'edebug-step-in) | |
3767 | (define-key map "o" 'edebug-step-out) | |
a1506d29 | 3768 | |
1fe3d507 | 3769 | ;; quitting and stopping |
d778509c SM |
3770 | (define-key map "q" 'top-level) |
3771 | (define-key map "Q" 'edebug-top-level-nonstop) | |
3772 | (define-key map "a" 'abort-recursive-edit) | |
3773 | (define-key map "S" 'edebug-stop) | |
84fc2cfa ER |
3774 | |
3775 | ;; breakpoints | |
d778509c SM |
3776 | (define-key map "b" 'edebug-set-breakpoint) |
3777 | (define-key map "u" 'edebug-unset-breakpoint) | |
3778 | (define-key map "B" 'edebug-next-breakpoint) | |
3779 | (define-key map "x" 'edebug-set-conditional-breakpoint) | |
3780 | (define-key map "X" 'edebug-set-global-break-condition) | |
a1506d29 | 3781 | |
84fc2cfa | 3782 | ;; evaluation |
d778509c SM |
3783 | (define-key map "r" 'edebug-previous-result) |
3784 | (define-key map "e" 'edebug-eval-expression) | |
3785 | (define-key map "\C-x\C-e" 'edebug-eval-last-sexp) | |
3786 | (define-key map "E" 'edebug-visit-eval-list) | |
a1506d29 | 3787 | |
84fc2cfa | 3788 | ;; views |
d778509c SM |
3789 | (define-key map "w" 'edebug-where) |
3790 | (define-key map "v" 'edebug-view-outside) ;; maybe obsolete?? | |
3791 | (define-key map "p" 'edebug-bounce-point) | |
3792 | (define-key map "P" 'edebug-view-outside) ;; same as v | |
3793 | (define-key map "W" 'edebug-toggle-save-windows) | |
1fe3d507 | 3794 | |
84fc2cfa | 3795 | ;; misc |
d778509c SM |
3796 | (define-key map "?" 'edebug-help) |
3797 | (define-key map "d" 'edebug-backtrace) | |
a1506d29 | 3798 | |
d778509c | 3799 | (define-key map "-" 'negative-argument) |
1fe3d507 DL |
3800 | |
3801 | ;; statistics | |
d778509c | 3802 | (define-key map "=" 'edebug-temp-display-freq-count) |
1fe3d507 DL |
3803 | |
3804 | ;; GUD bindings | |
d778509c SM |
3805 | (define-key map "\C-c\C-s" 'edebug-step-mode) |
3806 | (define-key map "\C-c\C-n" 'edebug-next-mode) | |
3807 | (define-key map "\C-c\C-c" 'edebug-go-mode) | |
3808 | ||
3809 | (define-key map "\C-x " 'edebug-set-breakpoint) | |
3810 | (define-key map "\C-c\C-d" 'edebug-unset-breakpoint) | |
3811 | (define-key map "\C-c\C-t" | |
3812 | (lambda () (interactive) (edebug-set-breakpoint t))) | |
3813 | (define-key map "\C-c\C-l" 'edebug-where) | |
3814 | map)) | |
84fc2cfa | 3815 | |
1fe3d507 DL |
3816 | ;; Autoloading these global bindings doesn't make sense because |
3817 | ;; they cannot be used anyway unless Edebug is already loaded and active. | |
3818 | ||
84fc2cfa ER |
3819 | (defvar global-edebug-prefix "\^XX" |
3820 | "Prefix key for global edebug commands, available from any buffer.") | |
3821 | ||
d778509c SM |
3822 | (defvar global-edebug-map |
3823 | (let ((map (make-sparse-keymap))) | |
3824 | ||
3825 | (define-key map " " 'edebug-step-mode) | |
3826 | (define-key map "g" 'edebug-go-mode) | |
3827 | (define-key map "G" 'edebug-Go-nonstop-mode) | |
3828 | (define-key map "t" 'edebug-trace-mode) | |
3829 | (define-key map "T" 'edebug-Trace-fast-mode) | |
3830 | (define-key map "c" 'edebug-continue-mode) | |
3831 | (define-key map "C" 'edebug-Continue-fast-mode) | |
3832 | ||
3833 | ;; breakpoints | |
3834 | (define-key map "b" 'edebug-set-breakpoint) | |
3835 | (define-key map "u" 'edebug-unset-breakpoint) | |
3836 | (define-key map "x" 'edebug-set-conditional-breakpoint) | |
3837 | (define-key map "X" 'edebug-set-global-break-condition) | |
3838 | ||
3839 | ;; views | |
3840 | (define-key map "w" 'edebug-where) | |
3841 | (define-key map "W" 'edebug-toggle-save-windows) | |
3842 | ||
3843 | ;; quitting | |
3844 | (define-key map "q" 'top-level) | |
3845 | (define-key map "Q" 'edebug-top-level-nonstop) | |
3846 | (define-key map "a" 'abort-recursive-edit) | |
3847 | ||
3848 | ;; statistics | |
3849 | (define-key map "=" 'edebug-display-freq-count) | |
3850 | map) | |
84fc2cfa ER |
3851 | "Global map of edebug commands, available from any buffer.") |
3852 | ||
d778509c SM |
3853 | (global-unset-key global-edebug-prefix) |
3854 | (global-set-key global-edebug-prefix global-edebug-map) | |
3855 | ||
84fc2cfa ER |
3856 | |
3857 | (defun edebug-help () | |
3858 | (interactive) | |
3859 | (describe-function 'edebug-mode)) | |
3860 | ||
84fc2cfa | 3861 | (defun edebug-mode () |
1fe3d507 DL |
3862 | "Mode for Emacs Lisp buffers while in Edebug. |
3863 | ||
3864 | In addition to all Emacs Lisp commands (except those that modify the | |
3865 | buffer) there are local and global key bindings to several Edebug | |
a1506d29 | 3866 | specific commands. E.g. `edebug-step-mode' is bound to \\[edebug-step-mode] |
1fe3d507 | 3867 | in the Edebug buffer and \\<global-map>\\[edebug-step-mode] in any buffer. |
84fc2cfa | 3868 | |
1fe3d507 | 3869 | Also see bindings for the eval list buffer, *edebug*. |
84fc2cfa | 3870 | |
1fe3d507 | 3871 | The edebug buffer commands: |
84fc2cfa ER |
3872 | \\{edebug-mode-map} |
3873 | ||
1fe3d507 | 3874 | Global commands prefixed by `global-edebug-prefix': |
84fc2cfa ER |
3875 | \\{global-edebug-map} |
3876 | ||
3877 | Options: | |
1fe3d507 DL |
3878 | edebug-setup-hook |
3879 | edebug-all-defs | |
3880 | edebug-all-forms | |
84fc2cfa | 3881 | edebug-save-windows |
1fe3d507 | 3882 | edebug-save-displayed-buffer-points |
84fc2cfa ER |
3883 | edebug-initial-mode |
3884 | edebug-trace | |
1fe3d507 DL |
3885 | edebug-test-coverage |
3886 | edebug-continue-kbd-macro | |
3887 | edebug-print-length | |
3888 | edebug-print-level | |
3889 | edebug-print-circle | |
3890 | edebug-on-error | |
3891 | edebug-on-quit | |
3892 | edebug-on-signal | |
3893 | edebug-unwrap-results | |
3894 | edebug-global-break-condition | |
84fc2cfa ER |
3895 | " |
3896 | (use-local-map edebug-mode-map)) | |
3897 | ||
f7359658 | 3898 | ;;; edebug eval list mode |
84fc2cfa | 3899 | |
1fe3d507 | 3900 | ;; A list of expressions and their evaluations is displayed in *edebug*. |
84fc2cfa ER |
3901 | |
3902 | (defun edebug-eval-result-list () | |
3903 | "Return a list of evaluations of edebug-eval-list" | |
3904 | ;; Assumes in outside environment. | |
88668147 DL |
3905 | ;; Don't do any edebug things now. |
3906 | (let ((edebug-execution-mode 'Go-nonstop) | |
a1506d29 | 3907 | (edebug-trace nil)) |
88668147 | 3908 | (mapcar 'edebug-safe-eval edebug-eval-list))) |
84fc2cfa ER |
3909 | |
3910 | (defun edebug-eval-display-list (edebug-eval-result-list) | |
3911 | ;; Assumes edebug-eval-buffer exists. | |
3912 | (let ((edebug-eval-list-temp edebug-eval-list) | |
3913 | (standard-output edebug-eval-buffer) | |
1fe3d507 | 3914 | (edebug-comment-line |
84fc2cfa | 3915 | (format ";%s\n" (make-string (- (window-width) 2) ?-)))) |
1fe3d507 | 3916 | (set-buffer edebug-eval-buffer) |
84fc2cfa ER |
3917 | (erase-buffer) |
3918 | (while edebug-eval-list-temp | |
3919 | (prin1 (car edebug-eval-list-temp)) (terpri) | |
3920 | (prin1 (car edebug-eval-result-list)) (terpri) | |
1fe3d507 | 3921 | (princ edebug-comment-line) |
84fc2cfa ER |
3922 | (setq edebug-eval-list-temp (cdr edebug-eval-list-temp)) |
3923 | (setq edebug-eval-result-list (cdr edebug-eval-result-list))) | |
1fe3d507 | 3924 | (edebug-pop-to-buffer edebug-eval-buffer) |
84fc2cfa ER |
3925 | )) |
3926 | ||
3927 | (defun edebug-create-eval-buffer () | |
3928 | (if (not (and edebug-eval-buffer (buffer-name edebug-eval-buffer))) | |
3929 | (progn | |
3930 | (set-buffer (setq edebug-eval-buffer (get-buffer-create "*edebug*"))) | |
3931 | (edebug-eval-mode)))) | |
3932 | ||
3933 | ;; Should generalize this to be callable outside of edebug | |
3934 | ;; with calls in user functions, e.g. (edebug-eval-display) | |
3935 | ||
3936 | (defun edebug-eval-display (edebug-eval-result-list) | |
3937 | "Display expressions and evaluations in EVAL-LIST. | |
3938 | It modifies the context by popping up the eval display." | |
3939 | (if edebug-eval-result-list | |
3940 | (progn | |
3941 | (edebug-create-eval-buffer) | |
84fc2cfa ER |
3942 | (edebug-eval-display-list edebug-eval-result-list) |
3943 | ))) | |
3944 | ||
3945 | (defun edebug-eval-redisplay () | |
3946 | "Redisplay eval list in outside environment. | |
3947 | May only be called from within edebug-recursive-edit." | |
3948 | (edebug-create-eval-buffer) | |
84fc2cfa ER |
3949 | (edebug-outside-excursion |
3950 | (edebug-eval-display-list (edebug-eval-result-list)) | |
3951 | )) | |
3952 | ||
3953 | (defun edebug-visit-eval-list () | |
3954 | (interactive) | |
3955 | (edebug-eval-redisplay) | |
3956 | (edebug-pop-to-buffer edebug-eval-buffer)) | |
3957 | ||
3958 | ||
3959 | (defun edebug-update-eval-list () | |
3960 | "Replace the evaluation list with the sexps now in the eval buffer." | |
3961 | (interactive) | |
3962 | (let ((starting-point (point)) | |
3963 | new-list) | |
3964 | (goto-char (point-min)) | |
3965 | ;; get the first expression | |
3966 | (edebug-skip-whitespace) | |
3967 | (if (not (eobp)) | |
3968 | (progn | |
3969 | (forward-sexp 1) | |
3970 | (setq new-list (cons (edebug-last-sexp) new-list)))) | |
a1506d29 | 3971 | |
84fc2cfa ER |
3972 | (while (re-search-forward "^;" nil t) |
3973 | (forward-line 1) | |
3974 | (skip-chars-forward " \t\n\r") | |
3975 | (if (and (/= ?\; (following-char)) | |
3976 | (not (eobp))) | |
3977 | (progn | |
3978 | (forward-sexp 1) | |
3979 | (setq new-list (cons (edebug-last-sexp) new-list))))) | |
a1506d29 | 3980 | |
84fc2cfa ER |
3981 | (setq edebug-eval-list (nreverse new-list)) |
3982 | (edebug-eval-redisplay) | |
3983 | (goto-char starting-point))) | |
3984 | ||
3985 | ||
3986 | (defun edebug-delete-eval-item () | |
3987 | "Delete the item under point and redisplay." | |
3988 | ;; could add arg to do repeatedly | |
3989 | (interactive) | |
3990 | (if (re-search-backward "^;" nil 'nofail) | |
3991 | (forward-line 1)) | |
3992 | (delete-region | |
3993 | (point) (progn (re-search-forward "^;" nil 'nofail) | |
3994 | (beginning-of-line) | |
3995 | (point))) | |
3996 | (edebug-update-eval-list)) | |
3997 | ||
3998 | ||
3999 | ||
4000 | (defvar edebug-eval-mode-map nil | |
6392137f | 4001 | "Keymap for Edebug Eval mode. Superset of Lisp Interaction mode.") |
84fc2cfa ER |
4002 | |
4003 | (if edebug-eval-mode-map | |
4004 | nil | |
4005 | (setq edebug-eval-mode-map (copy-keymap lisp-interaction-mode-map)) | |
a1506d29 | 4006 | |
84fc2cfa ER |
4007 | (define-key edebug-eval-mode-map "\C-c\C-w" 'edebug-where) |
4008 | (define-key edebug-eval-mode-map "\C-c\C-d" 'edebug-delete-eval-item) | |
4009 | (define-key edebug-eval-mode-map "\C-c\C-u" 'edebug-update-eval-list) | |
4010 | (define-key edebug-eval-mode-map "\C-x\C-e" 'edebug-eval-last-sexp) | |
4011 | (define-key edebug-eval-mode-map "\C-j" 'edebug-eval-print-last-sexp) | |
4012 | ) | |
4013 | ||
b7414395 | 4014 | (put 'edebug-eval-mode 'mode-class 'special) |
84fc2cfa ER |
4015 | |
4016 | (defun edebug-eval-mode () | |
1fe3d507 DL |
4017 | "Mode for evaluation list buffer while in Edebug. |
4018 | ||
4019 | In addition to all Interactive Emacs Lisp commands there are local and | |
4020 | global key bindings to several Edebug specific commands. E.g. | |
4021 | `edebug-step-mode' is bound to \\[edebug-step-mode] in the Edebug | |
4022 | buffer and \\<global-map>\\[edebug-step-mode] in any buffer. | |
84fc2cfa ER |
4023 | |
4024 | Eval list buffer commands: | |
4025 | \\{edebug-eval-mode-map} | |
4026 | ||
1fe3d507 | 4027 | Global commands prefixed by global-edebug-prefix: |
84fc2cfa ER |
4028 | \\{global-edebug-map} |
4029 | " | |
4030 | (lisp-interaction-mode) | |
4031 | (setq major-mode 'edebug-eval-mode) | |
6392137f | 4032 | (setq mode-name "Edebug Eval") |
84fc2cfa ER |
4033 | (use-local-map edebug-eval-mode-map)) |
4034 | ||
f7359658 | 4035 | ;;; Interface with standard debugger. |
84fc2cfa | 4036 | |
1fe3d507 DL |
4037 | ;; (setq debugger 'edebug) ; to use the edebug debugger |
4038 | ;; (setq debugger 'debug) ; use the standard debugger | |
84fc2cfa | 4039 | |
1fe3d507 DL |
4040 | ;; Note that debug and its utilities must be byte-compiled to work, |
4041 | ;; since they depend on the backtrace looking a certain way. But | |
4042 | ;; edebug is not dependent on this, yet. | |
84fc2cfa | 4043 | |
1fe3d507 | 4044 | (defun edebug (&optional edebug-arg-mode &rest debugger-args) |
a1506d29 | 4045 | "Replacement for debug. |
1fe3d507 | 4046 | If we are running an edebugged function, |
84fc2cfa | 4047 | show where we last were. Otherwise call debug normally." |
1fe3d507 DL |
4048 | ;; (message "entered: %s depth: %s edebug-recursion-depth: %s" |
4049 | ;; edebug-entered (recursion-depth) edebug-recursion-depth) (sit-for 1) | |
4050 | (if (and edebug-entered ; anything active? | |
4051 | (eq (recursion-depth) edebug-recursion-depth)) | |
4052 | (let (;; Where were we before the error occurred? | |
4053 | (edebug-offset-index (car edebug-offset-indices)) | |
4054 | ;; Bind variables required by edebug-display | |
4055 | (edebug-value (car debugger-args)) | |
4056 | edebug-breakpoints | |
4057 | edebug-break-data | |
4058 | edebug-break-condition | |
4059 | edebug-global-break | |
4060 | (edebug-break (null edebug-arg-mode)) ;; if called explicitly | |
4061 | ) | |
84fc2cfa | 4062 | (edebug-display) |
a1506d29 | 4063 | (if (eq edebug-arg-mode 'error) |
1fe3d507 DL |
4064 | nil |
4065 | edebug-value)) | |
84fc2cfa ER |
4066 | |
4067 | ;; Otherwise call debug normally. | |
4068 | ;; Still need to remove extraneous edebug calls from stack. | |
1fe3d507 | 4069 | (apply 'debug edebug-arg-mode debugger-args) |
84fc2cfa ER |
4070 | )) |
4071 | ||
4072 | ||
4073 | (defun edebug-backtrace () | |
4074 | "Display a non-working backtrace. Better than nothing..." | |
4075 | (interactive) | |
1fe3d507 DL |
4076 | (if (or (not edebug-backtrace-buffer) |
4077 | (null (buffer-name edebug-backtrace-buffer))) | |
4078 | (setq edebug-backtrace-buffer | |
4079 | (generate-new-buffer "*Backtrace*")) | |
4080 | ;; else, could just display edebug-backtrace-buffer | |
4081 | ) | |
4082 | (with-output-to-temp-buffer (buffer-name edebug-backtrace-buffer) | |
4083 | (setq edebug-backtrace-buffer standard-output) | |
4084 | (let ((print-escape-newlines t) | |
84fc2cfa | 4085 | (print-length 50) |
1fe3d507 | 4086 | last-ok-point) |
84fc2cfa ER |
4087 | (backtrace) |
4088 | ||
a1506d29 | 4089 | ;; Clean up the backtrace. |
1fe3d507 DL |
4090 | ;; Not quite right for current edebug scheme. |
4091 | (set-buffer edebug-backtrace-buffer) | |
4092 | (setq truncate-lines t) | |
84fc2cfa | 4093 | (goto-char (point-min)) |
84fc2cfa | 4094 | (setq last-ok-point (point)) |
1fe3d507 | 4095 | (if t (progn |
84fc2cfa ER |
4096 | |
4097 | ;; Delete interspersed edebug internals. | |
1fe3d507 DL |
4098 | (while (re-search-forward "^ \(?edebug" nil t) |
4099 | (beginning-of-line) | |
a1506d29 | 4100 | (cond |
1fe3d507 DL |
4101 | ((looking-at "^ \(edebug-after") |
4102 | ;; Previous lines may contain code, so just delete this line | |
4103 | (setq last-ok-point (point)) | |
4104 | (forward-line 1) | |
4105 | (delete-region last-ok-point (point))) | |
4106 | ||
4107 | ((looking-at "^ edebug") | |
4108 | (forward-line 1) | |
4109 | (delete-region last-ok-point (point)) | |
4110 | ))) | |
4111 | ))))) | |
84fc2cfa ER |
4112 | |
4113 | \f | |
f7359658 | 4114 | ;;; Trace display |
84fc2cfa ER |
4115 | |
4116 | (defun edebug-trace-display (buf-name fmt &rest args) | |
4117 | "In buffer BUF-NAME, display FMT and ARGS at the end and make it visible. | |
4118 | The buffer is created if it does not exist. | |
1fe3d507 DL |
4119 | You must include newlines in FMT to break lines, but one newline is appended." |
4120 | ;; e.g. | |
4121 | ;; (edebug-trace-display "*trace-point*" | |
4122 | ;; "saving: point = %s window-start = %s" | |
4123 | ;; (point) (window-start)) | |
dc0e03f3 RS |
4124 | (let* ((oldbuf (current-buffer)) |
4125 | (selected-window (selected-window)) | |
84fc2cfa | 4126 | (buffer (get-buffer-create buf-name)) |
1fe3d507 DL |
4127 | buf-window) |
4128 | ;; (message "before pop-to-buffer") (sit-for 1) | |
84fc2cfa | 4129 | (edebug-pop-to-buffer buffer) |
1fe3d507 DL |
4130 | (setq truncate-lines t) |
4131 | (setq buf-window (selected-window)) | |
4132 | (goto-char (point-max)) | |
4133 | (insert (apply 'edebug-format fmt args) "\n") | |
4134 | ;; Make it visible. | |
4135 | (vertical-motion (- 1 (window-height))) | |
4136 | (set-window-start buf-window (point)) | |
4137 | (goto-char (point-max)) | |
4138 | ;; (set-window-point buf-window (point)) | |
4139 | ;; (edebug-sit-for 0) | |
4140 | (bury-buffer buffer) | |
dc0e03f3 RS |
4141 | (select-window selected-window) |
4142 | (set-buffer oldbuf)) | |
1fe3d507 DL |
4143 | buf-name) |
4144 | ||
4145 | ||
4146 | (defun edebug-trace (fmt &rest args) | |
4147 | "Convenience call to edebug-trace-display using edebug-trace-buffer" | |
4148 | (apply 'edebug-trace-display edebug-trace-buffer fmt args)) | |
4149 | ||
4150 | \f | |
f7359658 | 4151 | ;;; Frequency count and coverage |
1fe3d507 DL |
4152 | |
4153 | (defun edebug-display-freq-count () | |
6b61353c KH |
4154 | "Display the frequency count data for each line of the current definition. |
4155 | The frequency counts are inserted as comment lines after | |
1fe3d507 DL |
4156 | each line, and you can undo all insertions with one `undo' command. |
4157 | ||
4158 | The counts are inserted starting under the `(' before an expression | |
4159 | or the `)' after an expression, or on the last char of a symbol. | |
4160 | The counts are only displayed when they differ from previous counts on | |
4161 | the same line. | |
4162 | ||
4163 | If coverage is being tested, whenever all known results of an expression | |
4164 | are `eq', the char `=' will be appended after the count | |
4165 | for that expression. Note that this is always the case for an | |
4166 | expression only evaluated once. | |
4167 | ||
4168 | To clear the frequency count and coverage data for a definition, | |
4169 | reinstrument it." | |
4170 | (interactive) | |
4171 | (let* ((function (edebug-form-data-symbol)) | |
4172 | (counts (get function 'edebug-freq-count)) | |
4173 | (coverages (get function 'edebug-coverage)) | |
4174 | (data (get function 'edebug)) | |
4175 | (def-mark (car data)) ; mark at def start | |
4176 | (edebug-points (nth 2 data)) | |
4177 | (i (1- (length edebug-points))) | |
4178 | (last-index) | |
4179 | (first-index) | |
4180 | (start-of-line) | |
4181 | (start-of-count-line) | |
4182 | (last-count) | |
4183 | ) | |
84fc2cfa | 4184 | (save-excursion |
1fe3d507 DL |
4185 | ;; Traverse in reverse order so offsets are correct. |
4186 | (while (<= 0 i) | |
4187 | ;; Start at last expression in line. | |
4188 | (goto-char (+ def-mark (aref edebug-points i))) | |
4189 | (beginning-of-line) | |
4190 | (setq start-of-line (- (point) def-mark) | |
4191 | last-index i) | |
4192 | ||
4193 | ;; Find all indexes on same line. | |
a1506d29 | 4194 | (while (and (<= 0 (setq i (1- i))) |
1fe3d507 DL |
4195 | (<= start-of-line (aref edebug-points i)))) |
4196 | ;; Insert all the indices for this line. | |
4197 | (forward-line 1) | |
4198 | (setq start-of-count-line (point) | |
4199 | first-index i ; really last index for line above this one. | |
4200 | last-count -1) ; cause first count to always appear. | |
4201 | (insert ";#") | |
4202 | ;; i == first-index still | |
4203 | (while (<= (setq i (1+ i)) last-index) | |
4204 | (let ((count (aref counts i)) | |
4205 | (coverage (aref coverages i)) | |
4206 | (col (save-excursion | |
4207 | (goto-char (+ (aref edebug-points i) def-mark)) | |
4208 | (- (current-column) | |
4209 | (if (= ?\( (following-char)) 0 1))))) | |
a1506d29 | 4210 | (insert (make-string |
1fe3d507 DL |
4211 | (max 0 (- col (- (point) start-of-count-line))) ?\ ) |
4212 | (if (and (< 0 count) | |
a1506d29 | 4213 | (not (memq coverage |
1fe3d507 DL |
4214 | '(unknown ok-coverage)))) |
4215 | "=" "") | |
4216 | (if (= count last-count) "" (int-to-string count)) | |
4217 | " ") | |
4218 | (setq last-count count))) | |
4219 | (insert "\n") | |
4220 | (setq i first-index))))) | |
4221 | ||
4222 | (defun edebug-temp-display-freq-count () | |
4223 | "Temporarily display the frequency count data for the current definition. | |
4224 | It is removed when you hit any char." | |
4225 | ;; This seems not to work with Emacs 18.59. It undoes too far. | |
4226 | (interactive) | |
4227 | (let ((buffer-read-only nil)) | |
4228 | (undo-boundary) | |
4229 | (edebug-display-freq-count) | |
4230 | (setq unread-command-char (read-char)) | |
4231 | (undo))) | |
4232 | ||
4233 | \f | |
f7359658 | 4234 | ;;; Menus |
1fe3d507 DL |
4235 | |
4236 | (defun edebug-toggle (variable) | |
4237 | (set variable (not (eval variable))) | |
4238 | (message "%s: %s" variable (eval variable))) | |
4239 | ||
4240 | ;; We have to require easymenu (even for Emacs 18) just so | |
4241 | ;; the easy-menu-define macro call is compiled correctly. | |
4242 | (require 'easymenu) | |
4243 | ||
4244 | (defconst edebug-mode-menus | |
4245 | '("Edebug" | |
1fe3d507 DL |
4246 | ["Stop" edebug-stop t] |
4247 | ["Step" edebug-step-mode t] | |
4248 | ["Next" edebug-next-mode t] | |
4249 | ["Trace" edebug-trace-mode t] | |
4250 | ["Trace Fast" edebug-Trace-fast-mode t] | |
4251 | ["Continue" edebug-continue-mode t] | |
4252 | ["Continue Fast" edebug-Continue-fast-mode t] | |
4253 | ["Go" edebug-go-mode t] | |
4254 | ["Go Nonstop" edebug-Go-nonstop-mode t] | |
4255 | "----" | |
4256 | ["Help" edebug-help t] | |
4257 | ["Abort" abort-recursive-edit t] | |
4258 | ["Quit to Top Level" top-level t] | |
4259 | ["Quit Nonstop" edebug-top-level-nonstop t] | |
4260 | "----" | |
4261 | ("Jumps" | |
4262 | ["Forward Sexp" edebug-forward-sexp t] | |
4263 | ["Step In" edebug-step-in t] | |
4264 | ["Step Out" edebug-step-out t] | |
4265 | ["Goto Here" edebug-goto-here t]) | |
4266 | ||
4267 | ("Breaks" | |
4268 | ["Set Breakpoint" edebug-set-breakpoint t] | |
4269 | ["Unset Breakpoint" edebug-unset-breakpoint t] | |
4270 | ["Set Conditional Breakpoint" edebug-set-conditional-breakpoint t] | |
4271 | ["Set Global Break Condition" edebug-set-global-break-condition t] | |
4272 | ["Show Next Breakpoint" edebug-next-breakpoint t]) | |
4273 | ||
4274 | ("Views" | |
4275 | ["Where am I?" edebug-where t] | |
4276 | ["Bounce to Current Point" edebug-bounce-point t] | |
4277 | ["View Outside Windows" edebug-view-outside t] | |
4278 | ["Previous Result" edebug-previous-result t] | |
4279 | ["Show Backtrace" edebug-backtrace t] | |
4280 | ["Display Freq Count" edebug-display-freq-count t]) | |
4281 | ||
4282 | ("Eval" | |
4283 | ["Expression" edebug-eval-expression t] | |
4284 | ["Last Sexp" edebug-eval-last-sexp t] | |
4285 | ["Visit Eval List" edebug-visit-eval-list t]) | |
4286 | ||
4287 | ("Options" | |
6db746da DL |
4288 | ["Edebug All Defs" edebug-all-defs |
4289 | :style toggle :selected edebug-all-defs] | |
4290 | ["Edebug All Forms" edebug-all-forms | |
4291 | :style toggle :selected edebug-all-forms] | |
1fe3d507 | 4292 | "----" |
6db746da DL |
4293 | ["Tracing" (edebug-toggle 'edebug-trace) |
4294 | :style toggle :selected edebug-trace] | |
4295 | ["Test Coverage" (edebug-toggle 'edebug-test-coverage) | |
4296 | :style toggle :selected edebug-test-coverage] | |
4297 | ["Save Windows" edebug-toggle-save-windows | |
4298 | :style toggle :selected edebug-save-windows] | |
a1506d29 | 4299 | ["Save Point" |
6db746da DL |
4300 | (edebug-toggle 'edebug-save-displayed-buffer-points) |
4301 | :style toggle :selected edebug-save-displayed-buffer-points] | |
1fe3d507 | 4302 | )) |
6db746da | 4303 | "Menus for Edebug.") |
1fe3d507 DL |
4304 | |
4305 | \f | |
f7359658 RS |
4306 | ;;; Emacs version specific code |
4307 | ||
10b088c6 | 4308 | (defalias 'edebug-window-live-p 'window-live-p) |
1fe3d507 | 4309 | |
10b088c6 RS |
4310 | ;; Mark takes an argument in Emacs 19. |
4311 | (defun edebug-mark () | |
4312 | (mark t)) ;; Does this work for lemacs too? | |
4313 | ||
4314 | (defun edebug-set-conditional-breakpoint (arg condition) | |
4315 | "Set a conditional breakpoint at nearest sexp. | |
4316 | The condition is evaluated in the outside context. | |
4317 | With prefix argument, make it a temporary breakpoint." | |
4318 | ;; (interactive "P\nxCondition: ") | |
a1506d29 | 4319 | (interactive |
10b088c6 RS |
4320 | (list |
4321 | current-prefix-arg | |
4322 | ;; Read condition as follows; getting previous condition is cumbersome: | |
4323 | (let ((edebug-stop-point (edebug-find-stop-point))) | |
4324 | (if edebug-stop-point | |
4325 | (let* ((edebug-def-name (car edebug-stop-point)) | |
4326 | (index (cdr edebug-stop-point)) | |
4327 | (edebug-data (get edebug-def-name 'edebug)) | |
4328 | (edebug-breakpoints (car (cdr edebug-data))) | |
4329 | (edebug-break-data (assq index edebug-breakpoints)) | |
4330 | (edebug-break-condition (car (cdr edebug-break-data))) | |
4331 | (edebug-expression-history | |
4332 | ;; Prepend the current condition, if any. | |
4333 | (if edebug-break-condition | |
4334 | (cons edebug-break-condition read-expression-history) | |
4335 | read-expression-history))) | |
4336 | (prog1 | |
a1506d29 | 4337 | (read-from-minibuffer |
10b088c6 RS |
4338 | "Condition: " nil read-expression-map t |
4339 | 'edebug-expression-history) | |
4340 | (setq read-expression-history edebug-expression-history) | |
4341 | )))))) | |
4342 | (edebug-modify-breakpoint t condition arg)) | |
4343 | ||
4344 | ;;; The default for all above is Emacs. | |
4345 | ||
4346 | ;; Epoch specific code was in a separate file: edebug-epoch.el. | |
1fe3d507 | 4347 | |
0b936a1e | 4348 | (easy-menu-define edebug-menu edebug-mode-map "Edebug menus" edebug-mode-menus) |
1fe3d507 | 4349 | \f |
f7359658 RS |
4350 | ;;; Byte-compiler |
4351 | ||
1fe3d507 DL |
4352 | ;; Extension for bytecomp to resolve undefined function references. |
4353 | ;; Requires new byte compiler. | |
4354 | ||
4355 | ;; Reenable byte compiler warnings about unread-command-char and -event. | |
4356 | ;; Disabled before edebug-recursive-edit. | |
4357 | (eval-when-compile | |
4358 | (if edebug-unread-command-char-warning | |
a1506d29 | 4359 | (put 'unread-command-char 'byte-obsolete-variable |
6db746da | 4360 | edebug-unread-command-char-warning))) |
1fe3d507 DL |
4361 | |
4362 | (eval-when-compile | |
4363 | ;; The body of eval-when-compile seems to get evaluated with eval-defun. | |
4364 | ;; We only want to evaluate when actually byte compiling. | |
4365 | ;; But it is OK to evaluate as long as byte-compiler has been loaded. | |
4366 | (if (featurep 'byte-compile) (progn | |
4367 | ||
4368 | (defun byte-compile-resolve-functions (funcs) | |
4369 | "Say it is OK for the named functions to be unresolved." | |
a1506d29 JB |
4370 | (mapcar |
4371 | (function | |
1fe3d507 DL |
4372 | (lambda (func) |
4373 | (setq byte-compile-unresolved-functions | |
4374 | (delq (assq func byte-compile-unresolved-functions) | |
4375 | byte-compile-unresolved-functions)))) | |
4376 | funcs) | |
4377 | nil) | |
a1506d29 | 4378 | |
1fe3d507 DL |
4379 | '(defun byte-compile-resolve-free-references (vars) |
4380 | "Say it is OK for the named variables to be referenced." | |
a1506d29 JB |
4381 | (mapcar |
4382 | (function | |
1fe3d507 DL |
4383 | (lambda (var) |
4384 | (setq byte-compile-free-references | |
4385 | (delq var byte-compile-free-references)))) | |
4386 | vars) | |
4387 | nil) | |
4388 | ||
4389 | '(defun byte-compile-resolve-free-assignments (vars) | |
4390 | "Say it is OK for the named variables to be assigned." | |
a1506d29 JB |
4391 | (mapcar |
4392 | (function | |
1fe3d507 DL |
4393 | (lambda (var) |
4394 | (setq byte-compile-free-assignments | |
4395 | (delq var byte-compile-free-assignments)))) | |
4396 | vars) | |
4397 | nil) | |
4398 | ||
a1506d29 JB |
4399 | (byte-compile-resolve-functions |
4400 | '(reporter-submit-bug-report | |
f7359658 | 4401 | edebug-gensym ;; also in cl.el |
1fe3d507 | 4402 | ;; Interfaces to standard functions. |
a1506d29 | 4403 | edebug-original-eval-defun |
1fe3d507 DL |
4404 | edebug-original-read |
4405 | edebug-get-buffer-window | |
4406 | edebug-mark | |
4407 | edebug-mark-marker | |
a1506d29 | 4408 | edebug-input-pending-p |
1fe3d507 | 4409 | edebug-sit-for |
a1506d29 | 4410 | edebug-prin1-to-string |
1fe3d507 | 4411 | edebug-format |
1fe3d507 DL |
4412 | ;; lemacs |
4413 | zmacs-deactivate-region | |
4414 | popup-menu | |
4415 | ;; CL | |
4416 | cl-macroexpand-all | |
f7359658 | 4417 | ;; And believe it or not, the byte compiler doesn't know about: |
1fe3d507 DL |
4418 | byte-compile-resolve-functions |
4419 | )) | |
4420 | ||
4421 | '(byte-compile-resolve-free-references | |
4422 | '(read-expression-history | |
4423 | read-expression-map)) | |
4424 | ||
4425 | '(byte-compile-resolve-free-assignments | |
4426 | '(read-expression-history)) | |
4427 | ||
4428 | ))) | |
4429 | ||
4430 | \f | |
f7359658 | 4431 | ;;; Autoloading of Edebug accessories |
1fe3d507 DL |
4432 | |
4433 | (if (featurep 'cl) | |
4434 | (add-hook 'edebug-setup-hook | |
4435 | (function (lambda () (require 'cl-specs)))) | |
4436 | ;; The following causes cl-specs to be loaded if you load cl.el. | |
4437 | (add-hook 'cl-load-hook | |
4438 | (function (lambda () (require 'cl-specs))))) | |
4439 | ||
a1506d29 | 4440 | ;;; edebug-cl-read and cl-read are available from liberte@cs.uiuc.edu |
1fe3d507 DL |
4441 | (if (featurep 'cl-read) |
4442 | (add-hook 'edebug-setup-hook | |
4443 | (function (lambda () (require 'edebug-cl-read)))) | |
4444 | ;; The following causes edebug-cl-read to be loaded when you load cl-read.el. | |
4445 | (add-hook 'cl-read-load-hooks | |
4446 | (function (lambda () (require 'edebug-cl-read))))) | |
4447 | ||
4448 | \f | |
f7359658 | 4449 | ;;; Finalize Loading |
1fe3d507 DL |
4450 | |
4451 | ;;; Finally, hook edebug into the rest of Emacs. | |
4452 | ;;; There are probably some other things that could go here. | |
4453 | ||
4454 | ;; Install edebug read and eval functions. | |
4455 | (edebug-install-read-eval-functions) | |
84fc2cfa | 4456 | |
e8544af2 RS |
4457 | (provide 'edebug) |
4458 | ||
6b61353c | 4459 | ;;; arch-tag: 19c8d05c-4554-426e-ac72-e0fa1fcb0808 |
84fc2cfa | 4460 | ;;; edebug.el ends here |