| blob | 2777ea775e9a8285c6b8fbbe43a0c0aadb86e459 |
1 ;;; edebug.el --- a source-level debugger for Emacs Lisp
3 ;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1997, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
6 ;; Author: Daniel LaLiberte <liberte@holonexus.org>
7 ;; Maintainer: FSF
8 ;; Keywords: lisp, tools, maint
10 ;; This file is part of GNU Emacs.
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.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
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.
36 ;;; Minimal Instructions
37 ;; =====================
39 ;; First evaluate a defun with C-M-x, then run the function. Step
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
42 ;; "?" command in edebug to describe other commands.
43 ;; See the Emacs Lisp Reference Manual for more details.
45 ;; If you wish to change the default edebug global command prefix, change:
46 ;; (setq edebug-global-prefix "\C-xX")
48 ;; Edebug was written by
49 ;; Daniel LaLiberte
50 ;; GTE Labs
51 ;; 40 Sylvan Rd
52 ;; Waltham, MA 02254
53 ;; liberte@holonexus.org
55 ;;; Code:
57 ;;; Bug reporting
61 ;;; Options
64 "A source-level debugger for Emacs Lisp."
69 "*Functions to call before edebug is used.
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
73 using but only when you also use Edebug."
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.
81 ;;;###autoload
83 "*If non-nil, evaluating defining forms instruments for Edebug.
84 This applies to `eval-defun', `eval-region', `eval-buffer', and
85 `eval-current-buffer'. `eval-region' is also called by
86 `eval-last-sexp', and `eval-print-last-sexp'.
88 You can use the command `edebug-all-defs' to toggle the value of this
89 variable. You may wish to make it local to each buffer with
90 \(make-local-variable 'edebug-all-defs) in your
91 `emacs-lisp-mode-hook'."
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.
99 ;;;###autoload
101 "*Non-nil evaluation of all forms will instrument for Edebug.
102 This doesn't apply to loading or evaluations in the minibuffer.
103 Use the command `edebug-all-forms' to toggle the value of this option."
108 "*Non-nil means all macro call arguments may be evaluated.
109 If this variable is nil, the default, Edebug will *not* wrap
110 macro call arguments as if they will be evaluated.
111 For each macro, a `edebug-form-spec' overrides this option.
112 So to specify exceptions for macros that have some arguments evaluated
113 and some not, you should specify an `edebug-form-spec'."
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.
122 If the value is a list, only the listed windows are saved and
123 restored.
125 `edebug-toggle-save-windows' may be used to change this variable."
130 "*If non-nil, save and restore point in all displayed buffers.
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
135 window, the buffer's point will be changed to the window's point.
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
139 it."
144 "*Initial execution mode for Edebug, if non-nil.
145 If this variable is non-nil, it specifies the initial execution mode
146 for Edebug when it is first activated. Possible values are step, next,
147 go, Go-nonstop, trace, Trace-fast, continue, and Continue-fast."
155 "*Non-nil means display a trace of function entry and exit.
156 Tracing output is displayed in a buffer named `*edebug-trace*', one
157 function entry or exit per line, indented by the recursion level.
159 You can customize by replacing functions `edebug-print-trace-before'
160 and `edebug-print-trace-after'."
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
168 results are found.
170 Use `edebug-display-freq-count' to display the frequency count and
171 coverage information for a definition."
176 "*If non-nil, continue defining or executing any keyboard macro.
177 Use this with caution since it is not debugged."
183 "*Default value of `print-length' for printing results in Edebug."
187 "*Default value of `print-level' for printing results in Edebug."
191 "*Default value of `print-circle' for printing results in Edebug."
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
199 circular or an infinite loop will result."
204 "*Value bound to `debug-on-error' while Edebug is active.
206 If `debug-on-error' is non-nil, that value is still used.
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.
212 After execution is resumed, the error is signaled again."
221 "*Value bound to `debug-on-quit' while Edebug is active."
226 "*If non-nil, an expression to test for at every stop point.
227 If the result is non-nil, then break. Errors are ignored."
232 "*Number of seconds to pause when execution mode is `trace'."
236 ;;; Form spec utilities.
239 "For compatibility with old version."
244 ;; Get the spec of symbol resolving all indirection.
246 indirect)
249 ;; (edebug-trace "indirection: %s" edebug-form-spec)
251 edebug-form-spec
252 ))
254 ;;;###autoload
256 "Return t if SPEC uses only extant spec symbols.
257 An extant spec symbol is a symbol that is not a function and has a
258 `edebug-form-spec' property."
264 t))
268 ;;; Utilities
270 ;; Define edebug-gensym - from old cl.el
275 "Generate a fresh uninterned symbol.
276 There is an optional argument, PREFIX. PREFIX is the
277 string that begins the new name. Most people take just the default,
278 except when debugging needs suggest otherwise."
288 newsymbol))
291 "Return t if OBJECT is a lambda list keyword.
292 A lambda list keyword is a symbol that starts with `&'."
298 ;; Return the last sexp before point in current buffer.
299 ;; Assumes Emacs Lisp syntax is active.
309 "Return a list of windows, in order of `next-window'."
310 ;; This doesn't work for epoch.
315 ;; Not used.
317 "Return t if there are two windows."
325 object)
328 "Return the macro named by OBJECT, or nil if it is not a macro."
333 object))
336 ;; Return the ALIST sorted with comparison function FUNCTION.
337 ;; This uses 'sort so the sorting is destructive.
342 ;;(def-edebug-spec edebug-save-restriction t)
344 ;; Not used. If it is used, def-edebug-spec must be defined before use.
346 "Evaluate BODY while saving the current buffers restriction.
347 BODY may change buffer outside of current restriction, unlike
348 save-restriction. BODY may change the current buffer,
349 and the restriction will be restored to the original buffer,
350 and the current buffer remains current.
351 Return the result of the last expression in BODY."
360 ;;; Display
366 ;; Like pop-to-buffer, but select window where BUFFER was last shown.
367 ;; Select WINDOW if it provided and it still exists. Otherwise,
368 ;; if buffer is currently shown in several windows, choose one.
369 ;; Otherwise, find a new window, possibly splitting one.
372 window
380 ;; (message "next window: %s" (next-window)) (sit-for 1)
382 ;; Don't select trace window
383 nil
387 ;; Selecting the window does not set the buffer until command loop.
388 ;;(set-buffer buffer)
389 )
393 ;; Return a list of buffer point pairs, for all displayed buffers.
399 list))))
400 list))
404 ;; Restore the buffer-points created by edebug-get-displayed-buffer-points.
410 buffer-points)))
413 ;; Get either a full window configuration or some window information.
422 which-windows)
426 ;; Set either a full window configuration or some window information.
439 one-window-info))))
440 window-info)
448 ;;; Redefine read and eval functions
449 ;; read is redefined to maybe instrument forms.
450 ;; eval-defun is redefined to check edebug-all-forms and edebug-all-defs.
452 ;; Save the original read function
457 "Read one Lisp expression as text from STREAM, return as Lisp object.
458 If STREAM is nil, use the value of `standard-input' (which see).
459 STREAM or the value of `standard-input' may be:
460 a buffer (read from point and advance it)
461 a marker (read from where it points and advance it)
462 a function (call it with no arguments for each character,
463 call it with a char as argument to push a char back)
464 a string (takes text from string, starting at the beginning)
465 t (read text line using minibuffer and use it).
467 This version, from Edebug, maybe instruments the expression. But the
468 STREAM must be the current buffer to do so. Whether it instruments is
469 also dependent on the values of `edebug-all-defs' and
470 `edebug-all-forms'."
479 ;; We should somehow arrange to be able to do this
480 ;; without actually replacing the eval-defun command.
482 "Evaluate the top-level form containing point, or after point.
484 If the current defun is actually a call to `defvar', then reset the
485 variable using its initial value expression even if the variable
486 already has some other value. (Normally `defvar' does not change the
487 variable's value if it already has a value.) Treat `defcustom'
488 similarly. Reinitialize the face according to `defface' specification.
490 With a prefix argument, instrument the code for Edebug.
492 Setting `edebug-all-defs' to a non-nil value reverses the meaning of
493 the prefix argument. Code is then instrumented when this function is
494 invoked without a prefix argument
496 If acting on a `defun' for FUNCTION, and the function was
497 instrumented, `Edebug: FUNCTION' is printed in the minibuffer. If not
498 instrumented, just FUNCTION is printed.
500 If not acting on a `defun', the result of evaluation is displayed in
501 the minibuffer."
509 ;; This should be consistent with `eval-defun-1', but not the
510 ;; same, since that gets a macroexpanded form.
513 ;; Force variable to be bound.
517 ;; Force variable to be bound.
520 ;; Reset the face.
524 ;; See comments in `eval-defun-1' for purpose of code below
534 edebug-result)))
537 ;;;###autoload
540 ;;;###autoload
542 "Evaluate the top level form point is in, stepping through with Edebug.
543 This is like `eval-defun' except that it steps the code for Edebug
544 before evaluating it. It displays the value in the echo area
545 using `eval-expression' (which see).
547 If you do this on a function definition
548 such as a defun or defmacro, it defines the function and instruments
549 its definition for Edebug, so it will do Edebug stepping when called
550 later. It displays `Edebug: FUNCTION' in the echo area to indicate
551 that FUNCTION is now instrumented for Edebug.
553 If the current defun is actually a call to `defvar' or `defcustom',
554 evaluating it this way resets the variable using its initial value
555 expression even if the variable already has some other value.
556 \(Normally `defvar' and `defcustom' do not alter the value if there
557 already is one.)"
560 ;; Bind edebug-all-forms only while reading, not while evalling
561 ;; but this causes problems while edebugging edebug.
573 ;; Recover point, but only if no error occurred.
577 ;; Compatibility with old versions.
580 ;;;###autoload
582 "Toggle edebugging of all definitions."
589 ;;;###autoload
591 "Toggle edebugging of all forms."
600 ;; Don't install if already installed.
611 ;;; Edebug internal data
613 ;; The internal data that is needed for edebugging is kept in the
614 ;; buffer-local variable `edebug-form-data'.
619 ;; A list of entries associating symbols with buffer regions.
620 ;; This is an automatic buffer local variable. Each entry looks like:
621 ;; @code{(@var{symbol} @var{begin-marker} @var{end-marker}). The markers
622 ;; are at the beginning and end of an entry level form and @var{symbol} is
623 ;; a symbol that holds all edebug related information for the form on its
624 ;; property list.
626 ;; In the future, the symbol will be irrelevant and edebug data will
627 ;; be stored in the definitions themselves rather than in the property
628 ;; list of a symbol.
648 ;; Find the edebug form data entry which is closest to PNT.
649 ;; If END-POINT is supplied, match must be exact.
650 ;; Return `nil' if none found.
652 closest-entry
665 closest-entry entry))))
666 closest-entry))
668 ;; Also need to find all contained entries,
669 ;; and find an entry given a symbol, which should be just assq.
672 ;; Return the edebug data symbol of the form where point is in.
673 ;; If point is not inside a edebuggable form, cause error.
678 ;; Make NEW-ENTRY the first element in the `edebug-form-data' list.
683 ;; If non-nil, clear ENTRY out of the form data.
684 ;; Maybe clear the markers and delete the symbol's edebug property?
687 ;; Instead of this, we could just find all contained forms.
688 ;; (put (car entry) 'edebug nil) ;
689 ;; (mapcar 'edebug-clear-form-data-entry ; dangerous
690 ;; (get (car entry) 'edebug-dependents))
691 ;; (set-marker (nth 1 entry) nil)
692 ;; (set-marker (nth 2 entry) nil)
695 ;;; Parser utilities
698 ;; Signal an invalid-read-syntax with ARGS.
703 ;; Lookup table for significant characters indicating the class of the
704 ;; token that follows. This is not a \"real\" syntax table.
721 ;; We treat numbers as symbols, because of confusion with -, -1, and 1-.
722 ;; We don't care about any other chars since they won't be seen.
723 table))
726 ;; Move to the next token and return its class. We only care about
727 ;; lparen, rparen, dot, quote, backquote, comma, string, char, vector,
728 ;; or symbol.
737 'symbol
742 ;; Leave point before the next token, skipping white space and comments.
749 ;; Mostly obsolete reader; still used in one case.
752 ;; Read one sexp from the current buffer starting at point.
753 ;; Leave point immediately after it. A sexp can be a list or atom.
754 ;; An atom is a symbol (or number), character, string, or vector.
755 ;; This works for reading anything legitimate, but it
756 ;; is gummed up by parser inconsistencies (bugs?)
759 ;; read goes one too far if a (possibly quoted) string or symbol
760 ;; is immediately followed by non-whitespace.
772 ;;; Offsets for reader
774 ;; Define a structure to represent offset positions of expressions.
775 ;; Each offset structure looks like: (before . after) for constituents,
776 ;; or for structures that have elements: (before <subexpressions> . after)
777 ;; where the <subexpressions> are the offset structures for subexpressions
778 ;; including the head of a list.
781 ;; Stack of offset structures in reverse order of the nesting.
782 ;; This is used to get back to previous levels.
786 ;; We must store whether we just read a list with a dotted form that
787 ;; is itself a list. This structure will be condensed, so the offsets
788 ;; must also be condensed.
792 ;; Reinitialize offset recording.
796 ;; Add a new offset pair with POINT as the before offset.
801 ;; Otherwise, we are at the top level, so initialize.
803 edebug-offsets-stack nil
804 edebug-read-dotted-list nil))
805 ;; Cons the new offset to the front of the stack.
807 edebug-current-offset new-offset)
808 ))
811 ;; Finalize the current offset struct by reversing it and
812 ;; store POINT as the after offset.
814 ;; Just reverse the offsets of all subexpressions.
817 ;; We just read a list after a dot, which will be abbreviated out.
819 ;; Drop the corresponding offset pair.
820 ;; That is, nconc the reverse of the rest of the offsets
821 ;; with the cdr of last offset.
826 ;; Now append the point using nconc.
828 ;; Pop the stack.
833 ;; Ignore the last created offset pair.
845 ;;; Reader for Emacs Lisp.
847 ;; Uses edebug-next-token-class (and edebug-skip-whitespace) above.
858 ))
865 ;; anything else, just read it.
867 stream))))
876 ;; Turn 'thing into (quote thing)
883 "If non-zero, we're in a new-style backquote.
887 ;; Turn `thing into (\` thing)
895 ;; Turn ,thing into (\, thing). Handle ,@ and ,. also.
905 ;; Generate the same structure of offsets we would have
906 ;; if the resulting list appeared verbatim in the input text.
915 ;; Turn #'thing into (function thing)
938 ;; Old style backquote.
940 ;; Call edebug-storing-offsets here so that we
941 ;; produce the same offsets we would have had
942 ;; if the backquote were an ordinary symbol.
954 ))
955 elements)
957 ))
967 ))
969 ;;; Cursors for traversal of list and vector elements with offsets.
974 ;; Return a new cursor for EXPRESSIONS with OFFSETS.
980 ;; Set the CURSOR's EXPRESSIONS and OFFSETS to the given.
981 ;; Return the cursor.
984 cursor)
987 ;; Copy the cursor using the same object and offsets.
996 ;; Return non-nil if CURSOR is empty - meaning no more elements.
1000 ;; Return the top element at the cursor.
1001 ;; Assumes not empty.
1005 ;; Check if a dotted form is required.
1007 ;; Check if there is at least one more argument.
1009 ;; Return that top element.
1013 ;; Return the top offset pair corresponding to the top element.
1017 ;; Advance and return the cursor to the next element and offset.
1018 ;; throw no-match if empty before moving.
1019 ;; This is a violation of the cursor encapsulation, but
1020 ;; there is plenty of that going on while matching.
1021 ;; The following test should always fail.
1026 cursor)
1030 ;; Return the before offset of the cursor.
1031 ;; If there is nothing left in the offsets,
1032 ;; return one less than the offset itself,
1033 ;; which is the after offset for a list.
1040 ;; Return the after offset of the cursor object.
1044 offset))
1046 ;;; The Parser
1048 ;; The top level function for parsing forms is
1049 ;; edebug-read-and-maybe-wrap-form; it calls all the rest. It checks the
1050 ;; syntax a bit and leaves point at any error it finds, but otherwise
1051 ;; should appear to work like eval-defun.
1053 ;; The basic plan is to surround each expression with a call to
1054 ;; the edebug debugger together with indexes into a table of positions of
1055 ;; all expressions. Thus an expression "exp" becomes:
1057 ;; (edebug-after (edebug-before 1) 2 exp)
1059 ;; When this is evaluated, first point is moved to the beginning of
1060 ;; exp at offset 1 of the current function. The expression is
1061 ;; evaluated, which may cause more edebug calls, and then point is
1062 ;; moved to offset 2 after the end of exp.
1064 ;; The highest level expressions of the function are wrapped in a call to
1065 ;; edebug-enter, which supplies the function name and the actual
1066 ;; arguments to the function. See functions edebug-enter, edebug-before,
1067 ;; and edebug-after for more details.
1069 ;; Dynamically bound vars, left unbound, but globally declared.
1070 ;; This is to quiet the byte compiler.
1072 ;; Window data of the highest definition being wrapped.
1073 ;; This data is shared by all embedded definitions.
1088 ;; Read a form and wrap it with edebug calls, if the conditions are right.
1089 ;; Here we just catch any no-match not caught below and signal an error.
1091 ;; Run the setup hook.
1092 ;; If it gets an error, make it nil.
1098 edebug-top-window-data
1099 edebug-def-name;; make sure it is locally nil
1100 ;; I don't like these here!!
1101 edebug-&optional
1102 edebug-&rest
1103 edebug-gate
1104 edebug-best-error
1105 edebug-error-point
1106 no-match
1107 ;; Do this once here instead of several times.
1113 nil))
1116 result))
1121 def-kind
1122 defining-form-p
1123 def-name
1124 ;; These offset things don't belong here, but to support recursive
1125 ;; calls to edebug-read, they need to be here.
1126 edebug-offsets
1127 edebug-offsets-stack
1128 edebug-current-offset ; reset to nil
1129 )
1133 ;; Find out if this is a defining form from first symbol
1138 ;; This is incorrect in general!! But OK most of the time.
1143 ;;;(message "all defs: %s all forms: %s" edebug-all-defs edebug-all-forms)
1147 ;; If it is a defining form and we are edebugging defs,
1148 ;; then let edebug-list-form start it.
1154 cursor
1159 ;; Not edebugging this form, so reset the symbol's edebug
1160 ;; property to be just a marker at the definition's source code.
1161 ;; This only works for defs with simple names.
1163 ;; Also nil out dependent defs.
1170 ;; If all forms are being edebugged, explicitly wrap it.
1176 cursor
1179 nil)))
1181 ;; Not a defining form, and not edebugging.
1183 ))
1189 ;; Currently def-form sets this to nil; def-body sets it to t.
1192 ;; Return a unique symbol for the variable used to store the
1193 ;; status of interactive-p for this function.
1198 "Wrap the FORMS of a definition body."
1207 ;; Generate the enter wrapper for some forms of a definition.
1208 ;; This is not to be used for the body of other forms, e.g. `while',
1209 ;; since it wraps the list of forms with a call to `edebug-enter'.
1210 ;; Uses the dynamically bound vars edebug-def-name and edebug-def-args.
1211 ;; Do this after parsing since that may find a name.
1218 ;; Doesn't work with more than one def-body!!
1219 ;; But the list will just be reversed.
1223 ))
1232 ;; modifies edebug-offset-index and edebug-offset-list
1233 ;; accesses edebug-func-marc and buffer point
1235 edebug-offset-index
1237 edebug-offset-list)
1242 ;; Return the edebug form for the current function at offset BEFORE-INDEX
1243 ;; given FORM. Looks like:
1244 ;; (edebug-after (edebug-before BEFORE-INDEX) AFTER-INDEX FORM)
1245 ;; Also increment the offset index for subsequent use.
1248 after-index form))
1251 ;; Like edebug-make-before-and-after-form, but only after.
1256 "Return the unwrapped SEXP or return it as is if it is not wrapped.
1257 The SEXP might be the result of wrapping a body, which is a list of
1258 expressions; a `progn' form will be returned enclosing these forms."
1269 )
1270 sexp))
1273 "Return the sexp recursively unwrapped."
1280 new-sexp)))
1284 ;; Process the defining form, starting outside the form.
1285 ;; The speclist is a generated list spec that looks like:
1286 ;; (("def-symbol" defining-form-spec-sans-&define))
1287 ;; Skip the first offset.
1291 cursor
1293 speclist))
1297 ;; Wrap a form, usually a defining form, but any evaluated one.
1298 ;; If speclist is non-nil, this is being called by edebug-defining-form.
1299 ;; Otherwise it is being called from edebug-read-and-maybe-wrap-form1.
1300 ;; This is a hack, but I havent figured out a simpler way yet.
1302 ;; Set this marker before parsing.
1306 ;; Buffer must be current-buffer for this to work:
1311 result
1312 ;; For definitions.
1313 ;; (edebug-containing-def-name edebug-def-name)
1314 ;; Get name from form-data, if any.
1316 edebug-def-name
1317 edebug-def-args
1318 edebug-def-interactive
1319 edebug-inside-func;; whether wrapped code executes inside a function.
1320 )
1326 ;; else wrap as an enter-form.
1329 ;; Set the name here if it was not set by edebug-make-enter-wrapper.
1333 ;; Add this def as a dependent of containing def. Buggy.
1341 ;; Create a form-data-entry or modify existing entry's markers.
1342 ;; In the latter case, pointers to the entry remain eq.
1346 edebug-def-name
1347 edebug-form-begin-marker
1348 ;; Buffer must be current-buffer.
1350 ))
1352 form-data-entry edebug-def-name ;; in case name is changed
1353 form-begin form-end))
1355 ;; (message "defining: %s" edebug-def-name) (sit-for 2)
1358 ;;(debug edebug-def-name)
1360 ;; Destructively reverse edebug-offset-list and make vector from it.
1363 ;; Side effects on the property list of edebug-def-name.
1367 ;; Set up the initial window data.
1375 ;; Store the edebug data in symbol's property list.
1377 ;; A struct or vector would be better here!!
1379 nil ; clear breakpoints
1380 edebug-offset-list
1381 edebug-top-window-data
1382 ))
1383 result
1384 )))
1388 ;; Create initial frequency count vector.
1389 ;; For each stop point, the counter is incremented each time it is visited.
1395 ;; Create initial coverage vector.
1396 ;; Only need one per expression, but it is simpler to use stop points.
1402 ;; Return the instrumented form for the following form.
1403 ;; Add the point offsets to the edebug-offset-list for the form.
1409 ;; The first offset for a list form is for the list form itself.
1411 form
1415 ;; Find out if this is a defining form from first symbol.
1416 ;; An indirect spec would not work here, yet.
1419 new-cursor
1423 ;; Wrap a regular form.
1427 ;; After processing the list form, the new-cursor is left
1428 ;; with the offset after the form.
1430 )))
1434 ;; Check for constant symbols that don't get wrapped.
1437 form)
1442 ;; Anything else is self-evaluating.
1451 ;; Process the arguments of a list form given that head of form is a symbol.
1452 ;; Helper for edebug-list-form
1458 ;; It is a speclist.
1465 ; but leave it in for compatibility.
1466 ))
1467 ;; No edebug-form-spec provided.
1477 ;; Return an instrumented form built from the list form.
1478 ;; The after offset will be left in the cursor after processing the form.
1480 ;; Prevent backtracking whenever instrumenting.
1482 ;; A list form is never optional because it matches anything.
1485 ;; Skip the first offset.
1493 ;; Special case: replace (interactive-p) with variable
1503 ;; The head of a form should normally be a symbol or a lambda
1504 ;; expression but it can also be an unquote form to be filled
1505 ;; before evaluation. We evaluate the arguments anyway, on the
1506 ;; assumption that the unquote form will place a proper function
1507 ;; name (rather than a macro name).
1509 ;; Process anonymous function and args.
1510 ;; This assumes no anonymous macros.
1515 ))
1517 ;;; Matching of specs.
1525 ;;; Failure to match
1527 ;; This throws to no-match, if there are higher alternatives.
1528 ;; Otherwise it signals an error. The place of the error is found
1529 ;; with the two before- and after-offset functions.
1532 ;; Throw a no-match, or signal an error immediately if gate is active.
1533 ;; Remember this point in case we need to report this error.
1546 ;; Top level spec matching function.
1547 ;; Used also at each lower level of specs.
1549 edebug-&rest
1550 edebug-best-error
1551 edebug-error-point
1553 )
1558 ;; Match one spec, which is not a keyword &-spec.
1564 ))
1568 ;; Append results of matching the list of specs.
1569 ;; The first spec is handled and the remainder-handler handles the rest.
1577 ;; Is the spec dotted?
1582 ;; Is the form dotted?
1586 ;; Cancel dotted spec and dotted form.
1590 ;; Wrap the form in a list, (by changing the cursor??)...
1592 ;; and process normally, then unwrap the result.
1599 ;;(message "spec = %s first char = %s" spec first-char) (sit-for 1)
1613 ;; Define specs for all the symbol specs with functions used to process them.
1614 ;; Perhaps we shouldn't be doing this with edebug-form-specs since the
1615 ;; user may want to define macros or functions with the same names.
1616 ;; We could use an internal obarray for these primitive specs.
1630 ;; Less frequently used:
1631 ;; (function . edebug-match-function)
1637 ;; (nil . edebug-match-nil) not this one - special case it.
1638 ))
1642 ;; Match a symbol spec.
1647 ;; It is an indirect spec.
1649 ;; Otherwise it should be the symbol name of a function.
1650 ;; There could be a bug here - maybe need to do edebug-match bindings.
1658 ;; Special case for edebug-`.
1666 )))
1677 ;; Currently identical to edebug-match-form.
1678 ;; This is for common lisp setf-style place arguments.
1683 ;; Keep matching until one spec fails.
1695 ;; Returning nil means no no-match was thrown.
1696 nil))
1697 result
1698 ;; no-match, but don't fail; just reset cursor and return nil.
1700 nil)))
1705 ;; Reuse the &optional handler with this as the remainder handler.
1709 ;; Repeatedly use specs until failure.
1711 edebug-best-error
1712 edebug-error-point)
1717 ;; Keep matching until one spec succeeds, and return its results.
1718 ;; If none match, fail.
1719 ;; This needs to be optimized since most specs spend time here.
1728 edebug-best-error
1729 edebug-error-point)
1730 ;; Doesn't support e.g. &or symbolp &rest form
1732 ;; Match failed, so reset and try again.
1734 ;; Reset the cursor for the next match.
1736 ;; All failed.
1738 ))
1742 ;; If any specs match, then fail
1747 nil))
1748 ;; This means something matched, so it is a no match.
1750 ;; This means nothing matched, so it is OK.
1757 ;; Following specs must look like (<name> <spec>) ...
1758 ;; where <name> is the name of a keyword, and spec is its spec.
1759 ;; This really doesn't save much over the expanded form and takes time.
1761 cursor
1766 specs))))
1770 ;; Simply set the gate to prevent backtracking at this level.
1772 nil)
1776 ;; The spec is a list, but what kind of list, and what context?
1778 ;; After dotted spec but form did not contain dot,
1779 ;; so match list spec elements as if spliced in.
1783 ;; If it matched, really clear the dotted-spec flag.
1792 ;; Special case: spec quotes a symbol to match.
1793 ;; Change in future. Use "..." instead.
1798 form)
1805 ;; First offset is for the list form itself.
1806 ;; Treat nil as empty list.
1808 specs))
1812 ;; Special case: match a vector with the specs.
1821 )))
1825 ;; Match a sublist of specs.
1827 ;;edebug-best-error
1828 ;;edebug-error-point
1829 )
1831 ;; match with edebug-match-specs so edebug-best-error is not bound.
1836 ;; A failed &rest or &optional spec may leave some args.
1838 )))))
1845 ;; Since it matched, failure means immediate error, unless &optional.
1849 )))
1852 ;; There must be nothing left to match a nil.
1855 nil))
1862 ;; Match a defining form.
1863 ;; Normally, &define is interpreted specially other places.
1864 ;; This should only be called inside of a spec list to match the remainder
1865 ;; of the current list. e.g. ("lambda" &define args def-body)
1867 cursor
1869 ;; Find the last offset in the list.
1872 offsets)
1873 specs))
1876 ;; The expression must be a function.
1877 ;; This will match any list form that begins with a symbol
1878 ;; that has an edebug-form-spec beginning with &define. In
1879 ;; practice, only lambda expressions should be used.
1880 ;; I could add a &lambda specification to avoid confusion.
1887 ;; Find out if this is a defining form from first symbol.
1898 )))
1902 ;; Set the edebug-def-name bound in edebug-defining-form.
1904 ;; Maybe strings and numbers could be used.
1909 ;; Construct a new name by appending to previous name.
1911 name))
1916 ;; Set the edebug-def-name to the spec.
1919 ;; Construct a new name by appending to previous name.
1921 spec))
1922 nil)
1925 ;; set the def-args bound in edebug-defining-form
1935 ;; Like form but the form is wrapped in edebug-enter form.
1936 ;; The form is assumed to be executing outside of the function context.
1937 ;; This is a hack for now, since a def-form might execute inside as well.
1938 ;; Not to be used otherwise.
1943 ;; Like body but body is wrapped in edebug-enter form.
1944 ;; The body is assumed to be executing inside of the function context.
1945 ;; Not to be used otherwise.
1950 ;;;; Edebug Form Specs
1951 ;;; ==========================================================
1952 ;;; See cl-specs.el for common lisp specs.
1954 ;;;;* Spec for def-edebug-spec
1955 ;;; Out of date.
1958 "Return non-nil if OBJECT is a symbol with an edebug-form-spec property."
1963 ;; Top level is different from lower levels.
1968 ;; A list must have something in it, or it is nil, a symbolp
1972 (&or
1976 edebug-spec-list
1977 stringp
1980 edebug-spec-p ;; Including all the special ones e.g. form.
1981 symbolp;; a predicate
1982 ))
1985 ;;;* Emacs special forms and some functions.
1987 ;; quote expects only one argument, although it allows any number.
1990 ;; The standard defining forms.
1995 (&define name lambda-list
1998 def-body))
2008 )))
2013 ;; A function-form is for an argument that may be a function or a form.
2014 ;; This specially recognizes anonymous functions quoted with quote.
2016 ;; form at the end could also handle "function",
2017 ;; but recognize it specially to avoid wrapping function forms.
2020 ;; function expects a symbol or a lambda or macro expression
2021 ;; A macro is allowed by Emacs.
2024 ;; lambda is a macro in emacs 19.
2028 def-body))
2030 ;; A macro expression is a lambda expression with "macro" prepended.
2033 ;; (def-edebug-spec anonymous-form ((&or ["lambda" lambda] ["macro" macro])))
2035 ;; Standard functions that take function-forms arguments.
2044 body))
2055 form
2061 ;; Supports quotes inside backquotes,
2062 ;; but only at the top level inside unquotes.
2064 (&or
2066 ;; The simple version:
2067 ;; (backquote-form &rest backquote-form)
2068 ;; doesn't handle (a . ,b). The straightforward fix:
2069 ;; (backquote-form . [&or nil backquote-form])
2070 ;; uses up too much stack space.
2071 ;; Note that `(foo . ,@bar) is not legal, so we don't need to handle it.
2074 ;; If you use dotted forms in backquotes, replace the previous line
2075 ;; with the following. This takes quite a bit more stack space, however.
2076 ;; (backquote-form . [&or nil backquote-form])
2078 sexp))
2080 ;; Special version of backquote that instruments backquoted forms
2081 ;; destined to be evaluated, usually as the result of a
2082 ;; macroexpansion. Backquoted code can only have unquotes (, and ,@)
2083 ;; in places where list forms are allowed, and predicates. If the
2084 ;; backquote is used in a macro, unquoted code that come from
2085 ;; arguments must be instrumented, if at all, with def-form not def-body.
2087 ;; We could assume that all forms (not nested in other forms)
2088 ;; in arguments of macros should be def-forms, whether or not the macros
2089 ;; are defined with edebug-` but this would be expensive.
2091 ;; ,@ might have some problems.
2096 ;; Assume immediate quote in unquotes mean backquote at next higher level.
2101 ;; New byte compiler.
2120 ;; Anything else?
2123 ;; Some miscellaneous specs for macros in public packages.
2124 ;; Send me yours.
2126 ;; advice.el by Hans Chalupsky (hans@cs.buffalo.edu)
2132 ;; "activation" "deactivation"]
2133 name ;; name of advice
2135 )
2138 def-body))
2147 ;;; The debugger itself
2151 ;;; add minor-mode-alist entry
2154 minor-mode-alist)))
2157 ;; Stack of active functions evaluated via edebug.
2158 ;; Should be nil at the top level.
2161 ;; Index of last edebug-stack item.
2164 ;; Stack of offset indices of visited edebug sexps.
2165 ;; Should be nil at the top level.
2166 ;; Each function adds one cons. Top is modified with setcar.
2170 ;; Non-nil if edebug has already been entered at this recursive edit level.
2171 ;; This should stay nil at the top level.
2172 )
2174 ;; Should these be options?
2176 ;; Name of function to use for debugging when error or quit occurs.
2177 ;; Set this to 'debug if you want to debug edebug.
2178 )
2181 ;; Dynamically bound variables, declared globally but left unbound.
2210 ;;; Handling signals
2213 "Signal an error. Args are SIGNAL-NAME, and associated DATA.
2214 A signal name is a symbol with an `error-conditions' property
2215 that is a list of condition names.
2216 A handler for any of those names will get to handle this signal.
2217 The symbol `error' should always be one of them.
2219 DATA should be a list. Its elements are printed as part of the error message.
2220 If the signal is handled, DATA is made available to the handler.
2221 See `condition-case'.
2223 This is the Edebug replacement for the standard `signal'. It should
2224 only be active while Edebug is. It checks `debug-on-error' to see
2225 whether it should call the debugger. When execution is resumed, the
2226 error is signaled again."
2229 ;; If we reach here without another non-local exit, then send signal again.
2230 ;; i.e. the signal is not continuable, yet.
2231 ;; Avoid infinite recursion.
2235 ;;; Entering Edebug
2238 ;; Entering FUNC. The arguments are ARGS, and the body is BODY.
2239 ;; Setup edebug variables and evaluate BODY. This function is called
2240 ;; when a function evaluated with edebug-eval-top-level-form is entered.
2241 ;; Return the result of BODY.
2243 ;; Is this the first time we are entering edebug since
2244 ;; lower-level recursive-edit command?
2245 ;; More precisely, this tests whether Edebug is currently active.
2248 ;; Binding max-lisp-eval-depth here is OK,
2249 ;; but not inside an unwind-protect.
2250 ;; Doing it here also keeps it from growing too large.
2257 ;; Binding these may not be the right thing to do.
2258 ;; We want to allow the global values to be changed.
2262 ;; Lexical bindings must be uncompiled for this to work.
2267 overriding-terminal-local-map)
2269 ;; Save the outside value of executing macro. (here??)
2277 ;; within edebug unless edebug-continue-kbd-macro is
2278 ;; non-nil. Again, local binding may not be best.
2282 ;; Don't get confused by the user's keymap changes.
2288 ;; Disable command hooks. This is essential when
2289 ;; a hook function is instrumented - to avoid infinite loop.
2290 ;; This may be more than we need, however.
2294 edebug-initial-mode
2295 edebug-execution-mode)
2296 edebug-next-execution-mode nil)
2298 ;; Reset global variables in case outside value was changed.
2313 )
2322 )))
2325 "Return a cons cell describing the status of VAR's current binding.
2326 The purpose of this function is so you can properly undo
2327 subsequent changes to the same binding, by passing the status
2328 cons cell to `edebug-restore-status'. The status cons cell
2329 has the form (LOCUS . VALUE), where LOCUS can be a buffer
2330 \(for a buffer-local binding), a frame (for a frame-local binding),
2331 or nil (if the default binding is current)."
2336 "Reset VAR based on STATUS.
2337 STATUS should be a list you got from `edebug-var-status'."
2351 edebug-result)
2361 "Print MSG in *edebug-trace* before and after evaluating BODY.
2362 The result of BODY is also printed."
2364 edebug-result)
2371 "Function called to print trace info before expression evaluation.
2372 MSG is printed after `::::{ '."
2377 "Function called to print trace info after expression evaluation.
2378 MSG is printed after `::::} '."
2386 ;; Debug current function given BEFORE position.
2387 ;; Called from functions compiled with edebug-eval-top-level-form.
2388 ;; Return the before index.
2391 ;; Increment frequency count
2398 edebug-before-index)
2401 ;; Do nothing.
2402 )
2406 edebug-value
2407 ;; Debug current function given AFTER position and VALUE.
2408 ;; Called from functions compiled with edebug-eval-top-level-form.
2409 ;; Return VALUE.
2412 ;; Increment frequency count
2419 ;; Just return result.
2420 edebug-value
2422 )))
2425 ;; Do nothing but return the value.
2426 edebug-value)
2432 ;; This is not used, yet.
2446 ;; Test if a different result.
2451 ;; Dynamically declared unbound variables.
2465 ;; Don't really try to enter edebug within an eval from redisplay.
2466 edebug-value
2467 ;; Check breakpoints and pending input.
2468 ;; If edebug display should be updated, call edebug-display.
2469 ;; Return edebug-value.
2482 ;;; (edebug-trace "exp: %s" edebug-value)
2483 ;; Test whether we should break.
2492 ;; Delete the breakpoint.
2497 ;; Display if mode is not go, continue, or Continue-fast
2498 ;; or break, or input is pending,
2500 edebug-break
2504 edebug-value
2505 )))
2508 ;; window-start now stored with each function.
2509 ;;(defvar edebug-window-start nil)
2510 ;; Remember where each buffers' window starts between edebug calls.
2511 ;; This is to avoid spurious recentering.
2512 ;; Does this still need to be buffer-local??
2513 ;;(setq-default edebug-window-start nil)
2514 ;;(make-variable-buffer-local 'edebug-window-start)
2517 ;; Dynamically declared unbound vars
2534 ;; Emacs 19 adds an arg to mark and mark-marker.
2540 ;; The buffer holding the source has been killed.
2541 ;; Let's at least show a backtrace so the user can figure out
2542 ;; which function we're talking about.
2544 ;; Setup windows for edebug, determine mode, maybe enter recursive-edit.
2545 ;; Uses local variables of edebug-enter, edebug-before, edebug-after
2546 ;; and edebug-debugger.
2549 edebug-stop ; should we enter recursive-edit
2552 edebug-buffer-outside-point ; current point in edebug-buffer
2553 ;; window displaying edebug-buffer
2560 edebug-outside-windows ; window or screen configuration
2561 edebug-buffer-points
2563 edebug-eval-buffer ; declared here so we can kill it below
2566 edebug-trace-window
2567 edebug-trace-window-start
2579 ;; any others??
2580 )
2586 ;; Compute result string now before windows are modified.
2590 ;; Save windows now before we modify them.
2597 ;; First move the edebug buffer point to edebug-point
2598 ;; so that window start doesn't get changed when we display it.
2599 ;; I don't know if this is going to help.
2600 ;;(set-buffer edebug-buffer)
2601 ;;(goto-char edebug-point)
2603 ;; If edebug-buffer is not currently displayed,
2604 ;; first find a window for it.
2608 ;; Now display eval list, if any.
2609 ;; This is done after the pop to edebug-buffer
2610 ;; so that buffer-window correspondence is correct after quitting.
2612 ;; The evaluation list better not have deleted edebug-window-data.
2620 ;; Check whether positions are up-to-date.
2621 ;; This assumes point is never before symbol.
2625 edebug-function)
2626 )))
2631 ;; Test if there is input, not including keyboard macros.
2635 edebug-stop t)
2637 ;; (discard-input) ; is this unfriendly??
2638 ))
2639 ;; Now display arrow based on mode.
2644 ;; Display error message
2655 edebug-global-break-condition
2656 edebug-global-break-result))
2659 edebug-break-condition
2660 edebug-break-result))
2670 ;; Display result of previous evaluation.
2683 ;; not edebug-break
2694 ;; (setq edebug-execution-mode 'step)
2695 ;; (edebug-overlay-arrow) ; This doesn't always show up.
2698 ;; Reset the edebug-window-data to whatever it is now.
2702 ;; Remember window-start for edebug-buffer, if still displayed.
2708 ;; Save trace window point before restoring outside windows.
2709 ;; Could generalize this for other buffers.
2716 ;; Restore windows before continuing.
2721 ;; Restore displayed buffer points.
2722 ;; Needed even if restoring windows because
2723 ;; window-points are not restored. (should they be??)
2727 ;; Unrestore trace window's window-point.
2730 edebug-trace-window-start))
2732 ;; Unrestore edebug-buffer's window-start, if displayed.
2739 ;; Unrestore edebug-buffer's window-point.
2740 ;; Needed in addition to setting the buffer point
2741 ;; - otherwise quitting doesn't leave point as is.
2742 ;; But this causes point to not be restored at times.
2743 ;; Also, it may not be a visible window.
2744 ;; (set-window-point window edebug-point)
2745 )))
2747 ;; Unrestore edebug-buffer's point. Rerestored below.
2748 ;; (goto-char edebug-point) ;; in edebug-buffer
2749 )
2750 ;; Since we may be in a save-excursion, in case of quit,
2751 ;; reselect the outside window only.
2752 ;; Only needed if we are not recovering windows??
2757 ;; Restore current buffer always, in case application needs it.
2759 ;; Restore point, and mark.
2760 ;; Needed even if restoring windows because
2761 ;; that doesn't restore point and mark in the current buffer.
2762 ;; But don't restore point if edebug-buffer is current buffer.
2766 ;; Does zmacs-regions need to be nil while doing set-marker?
2769 ;; None of the following is done if quit or signal occurs.
2771 ;; Restore edebug-buffer's outside point.
2772 ;; (edebug-trace "restore edebug-buffer point: %s"
2773 ;; edebug-buffer-outside-point)
2778 ;; ... nothing more.
2779 )
2781 ;; Reset global variables to outside values in case they were changed.
2783 unread-command-events edebug-outside-unread-command-events
2784 overlay-arrow-position edebug-outside-o-a-p
2785 overlay-arrow-string edebug-outside-o-a-s
2786 cursor-in-echo-area edebug-outside-c-i-e-a
2787 default-cursor-in-non-selected-windows edebug-outside-d-c-i-n-s-w)
2788 )))
2792 ;; Number of recursive edits started by edebug.
2793 ;; Should be 0 at the top level.
2796 ;; Value of recursion-depth when edebug was called.
2798 ;; Dynamically declared unbound vars
2813 ;; Note: here we have defvars for variables that are
2814 ;; built-in in certain versions.
2815 ;; Each defvar makes a difference
2816 ;; in versions where the variable is *not* built-in.
2818 ;; Emacs 18
2821 ;; Emacs 19.
2829 ;; Disable byte compiler warnings about unread-command-char and -event
2830 ;; (maybe works with byte-compile-version 2.22 at least)
2839 ;; Start up a recursive edit inside of edebug.
2840 ;; The current buffer is the edebug-buffer, which is put into edebug-mode.
2841 ;; Assume that none of the variables below are buffer-local.
2843 ;; match-data must be done in the outside buffer
2849 ;;(edebug-number-of-recursions (1+ edebug-number-of-recursions))
2851 edebug-entered ; bind locally to nil
2853 edebug-backtrace-buffer ; each recursive edit gets its own
2854 ;; The window configuration may be saved and restored
2855 ;; during a recursive-edit
2856 edebug-inside-windows
2877 )
2881 ;; Declare global values local but using the same global value.
2882 ;; We could set these to the values for previous edebug call.
2888 ;; Assume no edebug command sets unread-command-char.
2892 ;; More for Emacs 19
2899 ;; Bind again to outside values.
2903 ;; Don't keep defining a kbd macro.
2907 ;; others??
2908 )
2921 ;; Do the following, even if quit occurs.
2925 ;; Could be an option to keep eval display up.
2928 ;; Remember selected-window after recursive-edit.
2929 ;; (setq edebug-inside-window (selected-window))
2933 ;; Recursive edit may have changed buffers,
2934 ;; so set it back before exiting let.
2943 )
2944 ;; gotta have a buffer to let its buffer local variables be set
2948 ;; Reset global vars to outside values, in case they have been changed.
2950 last-command-char edebug-outside-last-command-char
2951 last-command-event edebug-outside-last-command-event
2952 last-command edebug-outside-last-command
2953 this-command edebug-outside-this-command
2954 unread-command-char edebug-outside-unread-command-char
2955 current-prefix-arg edebug-outside-current-prefix-arg
2956 last-input-char edebug-outside-last-input-char
2957 last-input-event edebug-outside-last-input-event
2958 last-event-frame edebug-outside-last-event-frame
2959 last-nonmenu-event edebug-outside-last-nonmenu-event
2960 track-mouse edebug-outside-track-mouse
2962 standard-output edebug-outside-standard-output
2963 standard-input edebug-outside-standard-input
2964 defining-kbd-macro edebug-outside-defining-kbd-macro
2965 ))
2966 ))
2969 ;;; Display related functions
2972 ;; If pos is not visible, adjust current window to fit following context.
2973 ;;; (message "window: %s old-start: %s window-start: %s pos: %s"
2974 ;;; (selected-window) old-start (window-start) (point)) (sit-for 5)
2977 ;; First try old-start
2982 ;; (message "resetting window start") (sit-for 2)
2989 ))
3005 )
3009 ;; Set up the overlay arrow at beginning-of-line in current buffer.
3010 ;; The arrow string is derived from edebug-arrow-alist and
3011 ;; edebug-execution-mode.
3020 "Toggle the saving and restoring of all windows.
3021 Also, each time you toggle it on, the inside and outside window
3022 configurations become the same as the current configuration."
3029 edebug-save-windows))))
3039 edebug-save-windows))
3040 ;; Problem: what about outside windows that are deleted inside?
3044 "Toggle the saving and restoring of the selected window.
3045 Also, each time you toggle it on, the inside and outside window
3046 configurations become the same as the current configuration."
3050 ;; Save all outside windows except the selected one.
3051 ;; Remove (selected-window) from outside-windows.
3058 edebug-outside-windows))
3071 "Toggle the saving and restoring of windows.
3072 With prefix, toggle for just the selected window.
3073 Otherwise, toggle for all windows."
3081 "Show the debug windows and where we stopped in the program."
3085 ;; Restore the window configuration to what it last was inside.
3086 ;; But it is not always set. - experiment
3087 ;;(if edebug-inside-windows
3088 ;; (edebug-set-windows edebug-inside-windows))
3093 "Change to the outside window configuration."
3106 "Bounce the point in the outside current buffer.
3107 If prefix arg is supplied, sit for that many seconds before returning.
3108 The default is one second."
3113 ;; If the buffer's currently displayed, avoid set-window-configuration.
3125 ;; Joe Wells, here is a start at your idea of adding a buffer to the internal
3126 ;; display list. Still need to use this list in edebug-display.
3132 "Toggle display of a buffer inside of edebug."
3142 ;;; Breakpoint related functions
3145 ;; Return (function . index) of the nearest edebug stop point.
3152 ;; pull out parts of edebug-data.
3154 ;; (edebug-breakpoints (car (cdr edebug-data)))
3159 ;; skip backwards until non-whitespace, or bol
3162 edebug-def-mark))
3163 len i)
3164 ;; the offsets are in order so we can do a linear search
3171 ;; return the relevant info
3174 edebug-def-name)
3175 )))
3179 "Move point to the next breakpoint, or first if none past point."
3187 ;; pull out parts of edebug-data
3191 breakpoint)
3201 ;; goto the first breakpoint
3214 ))))))
3218 "Modify the breakpoint for the form at point or after it.
3219 Set it if FLAG is non-nil, clear it otherwise. Then move to that point.
3220 If CONDITION or TEMPORARY are non-nil, add those attributes to
3221 the breakpoint. "
3228 ;; pull out parts of edebug-data
3232 present)
3233 ;; delete it either way
3238 ;; add it to the list and resort
3243 edebug-breakpoints) '<))
3246 edebug-def-name condition)
3254 ))))
3257 "Set the breakpoint of nearest sexp.
3258 With prefix argument, make it a temporary breakpoint."
3263 "Clear the breakpoint of nearest sexp."
3274 "Global Condition: " initial read-expression-map t
3281 ;;; Mode switching functions
3284 ;; Set the edebug mode to MODE.
3285 ;; Display SHORTMSG, or MSG if not within edebug.
3290 ;; Continue execution
3292 ;; This is not terribly useful!!
3300 "Proceed to next stop point."
3305 "Proceed to next `after' stop point."
3310 "Go, evaluating until break.
3311 With prefix ARG, set temporary break at current point and go."
3318 "Go, evaluating without debugging."
3325 "Begin trace mode."
3330 "Trace with no wait at each step."
3336 "Begin continue mode."
3342 "Trace with no wait at each step."
3347 ;; ------------------------------------------------------------
3348 ;; The following use the mode changing commands and breakpoints.
3352 "Proceed to first stop-point at or after current position of point."
3358 "Stop execution and do not continue.
3359 Useful for exiting from trace or continue loop."
3365 "Proceed to the exit of the next expression to be evaluated."
3373 "Proceed from the current point to the end of the ARGth sexp ahead.
3374 If there are not ARG sexps ahead, then do edebug-step-out."
3378 ;; Call forward-sexp repeatedly until done or failure.
3383 )))
3386 "Proceed from the current point to the end of the containing sexp.
3387 If there is no containing sexp that is not the top level defun,
3388 go to the end of the last sexp, or if that is the same point, then step."
3394 ;; Is there still a containing expression?
3398 ;; At top level - 1, so first check if there are more sexps at this level.
3400 ;; (up-list 1)
3405 )))))
3408 ;; Func should be a function symbol.
3409 ;; Return the function symbol, or nil if not instrumented.
3413 ;; It is uninstrumented, so instrument it.
3417 func))
3420 func)
3428 func))))))
3431 "Instrument the definition of the function or macro about to be called.
3432 Do this when stopped before the form or it will be too late.
3433 One side effect of using this command is that the next time the
3434 function or macro is called, Edebug will be called there as well."
3449 "Step into the definition of the function or macro about to be called.
3450 This first does `edebug-instrument-callee' to ensure that it is
3451 instrumented. Then it does `edebug-on-entry' and switches to `go' mode."
3460 "Cause Edebug to stop when FUNCTION is called.
3461 With prefix argument, make this temporary so it is automatically
3462 cancelled the first time the function is entered."
3464 ;; Could store this in the edebug data instead.
3475 ;; Also need edebug-cancel-debug-on-entry
3478 "Request FUNCTION to invoke debugger each time it is called.
3479 If the user continues, FUNCTION's execution proceeds.
3480 Works by modifying the definition of FUNCTION,
3481 which must be written in Lisp, not predefined.
3482 Use `cancel-debug-on-entry' to cancel the effect of this command.
3483 Redefining FUNCTION also does that.
3485 This version is from Edebug. If the function is instrumented for
3486 Edebug, it calls `edebug-on-entry'."
3495 "Set mode to Go-nonstop, and exit to top-level.
3496 This is useful for exiting even if unwind-protect code may be executed."
3502 ;;(defun edebug-exit-out ()
3503 ;; "Go until the current function exits."
3504 ;; (interactive)
3505 ;; (edebug-set-mode 'exiting "Exit..."))
3508 ;;; The following initial mode setting definitions are not used yet.
3518 )
3523 "Ask for the initial mode of the enclosing function.
3524 The mode is requested via the key that would be used to set the mode in
3525 edebug-mode."
3529 edebug-mode-map))
3531 edebug-initial-mode))
3534 "Change initial edebug mode for %s from %s (%s) to (enter key): "
3535 this-function
3536 old-mode
3539 keymap 'firstonly
3540 ))))
3542 )
3549 this-function mode))
3551 )))
3553 ;;; Evaluation of expressions
3558 "Evaluate an expression list in the outside context.
3559 Return the result of the last expression."
3563 ;; After excursion, we will
3564 ;; restore to current window configuration.
3567 ;; Restore outside windows.
3571 ;; (use-local-map edebug-outside-map)
3573 ;; Restore outside context.
3592 ;; Get the values out of the saved statuses.
3596 ;; See edebug-display
3601 )
3610 ;; Back to edebug-buffer. Restore rest of inside context.
3611 ;; (use-local-map edebug-inside-map)
3613 ;; Restore inside windows.
3616 ;; Save values that may have been changed.
3618 edebug-outside-last-command-char last-command-char
3619 edebug-outside-last-command-event last-command-event
3620 edebug-outside-last-command last-command
3621 edebug-outside-this-command this-command
3622 edebug-outside-unread-command-char unread-command-char
3623 edebug-outside-unread-command-events unread-command-events
3624 edebug-outside-current-prefix-arg current-prefix-arg
3625 edebug-outside-last-input-char last-input-char
3626 edebug-outside-last-input-event last-input-event
3627 edebug-outside-last-event-frame last-event-frame
3628 edebug-outside-last-nonmenu-event last-nonmenu-event
3629 edebug-outside-track-mouse track-mouse
3630 edebug-outside-standard-output standard-output
3631 edebug-outside-standard-input standard-input
3633 edebug-outside-executing-macro executing-kbd-macro
3634 edebug-outside-defining-kbd-macro defining-kbd-macro
3636 edebug-outside-o-a-p overlay-arrow-position
3637 edebug-outside-o-a-s overlay-arrow-string
3638 edebug-outside-c-i-e-a cursor-in-echo-area
3639 edebug-outside-d-c-i-n-s-w default-cursor-in-non-selected-windows
3640 )
3642 ;; Restore the outside saved values; don't alter
3643 ;; the outside binding loci.
3648 ))
3653 ;; Are there cl lexical variables active?
3659 ;; Evaluate EXPR safely.
3660 ;; If there is an error, a string is returned describing the error.
3667 ;;; Printing
3669 ;; Replace printing functions.
3671 ;; obsolete names
3680 "Replace print functions used by Edebug with custom versions."
3681 ;; Modifying the custom print functions, or changing print-length,
3682 ;; print-level, print-circle, custom-print-list or custom-print-vector
3683 ;; have immediate effect.
3695 "Replace edebug custom print functions with internal versions."
3704 ;; Default print functions are the same as Emacs'.
3709 ;; Print an error message like command level does.
3710 ;; This also prints the error name if it has no error-message.
3715 ;; continuing after an error may
3716 ;; complain about edebug-arg. why??
3720 ;; Define here in case they are not already defined.
3724 ;; Alternatively, we could change the definition of
3725 ;; edebug-safe-prin1-to-string to only use these if defined.
3747 "Print the previous result."
3751 ;;; Read, Eval and Print
3754 "Evaluate an expression in the outside environment.
3755 If interactive, prompt for the expression.
3756 Print result in minibuffer."
3758 "Eval: " nil read-expression-map t
3767 "Evaluate sexp before point in the outside environment.
3768 Print value in minibuffer."
3773 "Evaluate sexp before point in outside environment; insert value.
3774 This prints the value into current buffer."
3782 ;; princ the string to get rid of quotes.
3785 ))
3787 ;;; Edebug Minor Mode
3792 ;; Global GUD bindings for all emacs-lisp-mode buffers.
3801 ;; control
3811 ;;(define-key map "f" 'edebug-forward) not implemented
3819 ;; quitting and stopping
3825 ;; breakpoints
3832 ;; evaluation
3838 ;; views
3845 ;; misc
3851 ;; statistics
3854 ;; GUD bindings
3864 map))
3866 ;; Autoloading these global bindings doesn't make sense because
3867 ;; they cannot be used anyway unless Edebug is already loaded and active.
3883 ;; breakpoints
3889 ;; views
3893 ;; quitting
3898 ;; statistics
3900 map)
3912 "Mode for Emacs Lisp buffers while in Edebug.
3914 In addition to all Emacs Lisp commands (except those that modify the
3915 buffer) there are local and global key bindings to several Edebug
3919 Also see bindings for the eval list buffer *edebug* in `edebug-eval-mode'.
3921 The edebug buffer commands:
3924 Global commands prefixed by `global-edebug-prefix':
3927 Options:
3928 edebug-setup-hook
3929 edebug-all-defs
3930 edebug-all-forms
3931 edebug-save-windows
3932 edebug-save-displayed-buffer-points
3933 edebug-initial-mode
3934 edebug-trace
3935 edebug-test-coverage
3936 edebug-continue-kbd-macro
3937 edebug-print-length
3938 edebug-print-level
3939 edebug-print-circle
3940 edebug-on-error
3941 edebug-on-quit
3942 edebug-on-signal
3943 edebug-unwrap-results
3944 edebug-global-break-condition
3945 "
3946 ;; If the user kills the buffer in which edebug is currently active,
3947 ;; exit to top level, because the edebug command loop can't usefully
3948 ;; continue running in such a case.
3953 "Used on `kill-buffer-hook' when Edebug is operating in a buffer of Lisp code."
3958 ;;; edebug eval list mode
3960 ;; A list of expressions and their evaluations is displayed in *edebug*.
3963 "Return a list of evaluations of edebug-eval-list"
3964 ;; Assumes in outside environment.
3965 ;; Don't do any edebug things now.
3971 ;; Assumes edebug-eval-buffer exists.
3985 ))
3993 ;; Should generalize this to be callable outside of edebug
3994 ;; with calls in user functions, e.g. (edebug-eval-display)
3997 "Display expressions and evaluations in EVAL-LIST.
3998 It modifies the context by popping up the eval display."
4003 )))
4006 "Redisplay eval list in outside environment.
4007 May only be called from within edebug-recursive-edit."
4011 ))
4020 "Replace the evaluation list with the sexps now in the eval buffer."
4023 new-list)
4025 ;; get the first expression
4047 "Delete the item under point and redisplay."
4048 ;; could add arg to do repeatedly
4076 "Mode for evaluation list buffer while in Edebug.
4078 In addition to all Interactive Emacs Lisp commands there are local and
4079 global key bindings to several Edebug specific commands. E.g.
4083 Eval list buffer commands:
4086 Global commands prefixed by `global-edebug-prefix':
4089 ;;; Interface with standard debugger.
4091 ;; (setq debugger 'edebug) ; to use the edebug debugger
4092 ;; (setq debugger 'debug) ; use the standard debugger
4094 ;; Note that debug and its utilities must be byte-compiled to work,
4095 ;; since they depend on the backtrace looking a certain way. But
4096 ;; edebug is not dependent on this, yet.
4099 "Replacement for debug.
4100 If we are running an edebugged function,
4101 show where we last were. Otherwise call debug normally."
4102 ;; (message "entered: %s depth: %s edebug-recursion-depth: %s"
4103 ;; edebug-entered (recursion-depth) edebug-recursion-depth) (sit-for 1)
4108 ;; Bind variables required by edebug-display
4110 edebug-breakpoints
4111 edebug-break-data
4112 edebug-break-condition
4113 edebug-global-break
4115 )
4118 nil
4119 edebug-value))
4121 ;; Otherwise call debug normally.
4122 ;; Still need to remove extraneous edebug calls from stack.
4124 ))
4128 "Display a non-working backtrace. Better than nothing..."
4134 ;; else, could just display edebug-backtrace-buffer
4135 )
4140 last-ok-point)
4143 ;; Clean up the backtrace.
4144 ;; Not quite right for current edebug scheme.
4151 ;; Delete interspersed edebug internals.
4156 ;; Previous lines may contain code, so just delete this line
4164 )))
4165 )))))
4167 \f
4168 ;;; Trace display
4171 "In buffer BUF-NAME, display FMT and ARGS at the end and make it visible.
4172 The buffer is created if it does not exist.
4173 You must include newlines in FMT to break lines, but one newline is appended."
4174 ;; e.g.
4175 ;; (edebug-trace-display "*trace-point*"
4176 ;; "saving: point = %s window-start = %s"
4177 ;; (point) (window-start))
4181 buf-window)
4182 ;; (message "before pop-to-buffer") (sit-for 1)
4188 ;; Make it visible.
4192 ;; (set-window-point buf-window (point))
4193 ;; (edebug-sit-for 0)
4197 buf-name)
4201 "Convenience call to edebug-trace-display using edebug-trace-buffer"
4204 \f
4205 ;;; Frequency count and coverage
4208 "Display the frequency count data for each line of the current definition.
4209 The frequency counts are inserted as comment lines after
4210 each line, and you can undo all insertions with one `undo' command.
4212 The counts are inserted starting under the `(' before an expression
4213 or the `)' after an expression, or on the last char of a symbol.
4214 The counts are only displayed when they differ from previous counts on
4215 the same line.
4217 If coverage is being tested, whenever all known results of an expression
4218 are `eq', the char `=' will be appended after the count
4219 for that expression. Note that this is always the case for an
4220 expression only evaluated once.
4222 To clear the frequency count and coverage data for a definition,
4223 reinstrument it."
4237 )
4239 ;; Traverse in reverse order so offsets are correct.
4241 ;; Start at last expression in line.
4245 last-index i)
4247 ;; Find all indexes on same line.
4250 ;; Insert all the indices for this line.
4253 first-index i ; really last index for line above this one.
4256 ;; i == first-index still
4277 "Temporarily display the frequency count data for the current definition.
4278 It is removed when you hit any char."
4279 ;; This seems not to work with Emacs 18.59. It undoes too far.
4287 \f
4288 ;;; Menus
4294 ;; We have to require easymenu (even for Emacs 18) just so
4295 ;; the easy-menu-define macro call is compiled correctly.
4309 "----"
4314 "----"
4346 "----"
4356 ))
4359 \f
4360 ;;; Emacs version specific code
4368 "Set a conditional breakpoint at nearest sexp.
4369 The condition is evaluated in the outside context.
4370 With prefix argument, make it a temporary breakpoint."
4371 ;; (interactive "P\nxCondition: ")
4374 current-prefix-arg
4375 ;; Read condition as follows; getting previous condition is cumbersome:
4387 "Condition: " initial read-expression-map t
4394 \f
4395 ;;; Byte-compiler
4397 ;; Extension for bytecomp to resolve undefined function references.
4398 ;; Requires new byte compiler.
4400 ;; Reenable byte compiler warnings about unread-command-char and -event.
4401 ;; Disabled before edebug-recursive-edit.
4405 edebug-unread-command-char-warning)))
4408 ;; The body of eval-when-compile seems to get evaluated with eval-defun.
4409 ;; We only want to evaluate when actually byte compiling.
4410 ;; But it is OK to evaluate as long as byte-compiler has been loaded.
4414 "Say it is OK for the named functions to be unresolved."
4420 byte-compile-unresolved-functions))))
4421 funcs)
4422 nil)
4425 "Say it is OK for the named variables to be referenced."
4431 vars)
4432 nil)
4435 "Say it is OK for the named variables to be assigned."
4441 vars)
4442 nil)
4446 edebug-gensym ;; also in cl.el
4447 ;; Interfaces to standard functions.
4448 edebug-original-eval-defun
4449 edebug-original-read
4450 edebug-get-buffer-window
4451 edebug-mark
4452 edebug-mark-marker
4453 edebug-input-pending-p
4454 edebug-sit-for
4455 edebug-prin1-to-string
4456 edebug-format
4457 ;; lemacs
4458 zmacs-deactivate-region
4459 popup-menu
4460 ;; CL
4461 cl-macroexpand-all
4462 ;; And believe it or not, the byte compiler doesn't know about:
4463 byte-compile-resolve-functions
4464 ))
4468 read-expression-map))
4473 )))
4475 \f
4476 ;;; Autoloading of Edebug accessories
4481 ;; The following causes cl-specs to be loaded if you load cl.el.
4485 ;;; edebug-cl-read and cl-read are available from liberte@cs.uiuc.edu
4489 ;; The following causes edebug-cl-read to be loaded when you load cl-read.el.
4493 \f
4494 ;;; Finalize Loading
4496 ;;; Finally, hook edebug into the rest of Emacs.
4497 ;;; There are probably some other things that could go here.
4499 ;; Install edebug read and eval functions.
4504 ;;; arch-tag: 19c8d05c-4554-426e-ac72-e0fa1fcb0808
4505 ;;; edebug.el ends here