| blob | 601330556239c352d36225572a36df5c31c2818d |
1 ;;; edebug.el --- a source-level debugger for Emacs Lisp -*- lexical-binding: t -*-
3 ;; Copyright (C) 1988-1995, 1997, 1999-2017 Free Software Foundation,
4 ;; Inc.
6 ;; Author: Daniel LaLiberte <liberte@holonexus.org>
7 ;; Maintainer: emacs-devel@gnu.org
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 3 of the License, or
15 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; This minor mode allows programmers to step through Emacs Lisp
28 ;; source code while executing functions. You can also set
29 ;; breakpoints, trace (stopping at each expression), evaluate
30 ;; expressions as if outside Edebug, reevaluate and display a list of
31 ;; expressions, trap errors normally caught by debug, and display a
32 ;; debug style backtrace.
34 ;;; Minimal Instructions
35 ;; =====================
37 ;; First evaluate a defun with C-M-x, then run the function. Step
38 ;; through the code with SPC, mark breakpoints with b, go until a
39 ;; breakpoint is reached with g, and quit execution with q. Use the
40 ;; "?" command in edebug to describe other commands.
41 ;; See the Emacs Lisp Reference Manual for more details.
43 ;; If you wish to change the default edebug global command prefix, change:
44 ;; (setq edebug-global-prefix "\C-xX")
46 ;; Edebug was written by
47 ;; Daniel LaLiberte
48 ;; GTE Labs
49 ;; 40 Sylvan Rd
50 ;; Waltham, MA 02254
51 ;; liberte@holonexus.org
53 ;;; Code:
59 ;;; Options
62 "A source-level debugger for Emacs Lisp."
67 "Functions to call before edebug is used.
68 Each time it is set to a new value, Edebug will call those functions
69 once and then reset `edebug-setup-hook' to nil. You could use this
70 to load up Edebug specifications associated with a package you are
71 using, but only when you also use Edebug."
75 ;; edebug-all-defs and edebug-all-forms need to be autoloaded
76 ;; because the byte compiler binds them; as a result, if edebug
77 ;; is first loaded for a require in a compilation, they will be left unbound.
79 ;;;###autoload
81 "If non-nil, evaluating defining forms instruments for Edebug.
82 This applies to `eval-defun', `eval-region', `eval-buffer', and
83 `eval-current-buffer'. `eval-region' is also called by
84 `eval-last-sexp', and `eval-print-last-sexp'.
86 You can use the command `edebug-all-defs' to toggle the value of this
87 variable. You may wish to make it local to each buffer with
89 `emacs-lisp-mode-hook'."
93 ;; edebug-all-defs and edebug-all-forms need to be autoloaded
94 ;; because the byte compiler binds them; as a result, if edebug
95 ;; is first loaded for a require in a compilation, they will be left unbound.
97 ;;;###autoload
99 "Non-nil means evaluation of all forms will instrument for Edebug.
100 This doesn't apply to loading or evaluations in the minibuffer.
101 Use the command `edebug-all-forms' to toggle the value of this option."
106 "Non-nil means all macro call arguments may be evaluated.
107 If this variable is nil, the default, Edebug will *not* wrap
108 macro call arguments as if they will be evaluated.
109 For each macro, an `edebug-form-spec' overrides this option.
110 So to specify exceptions for macros that have some arguments evaluated
111 and some not, use `def-edebug-spec' to specify an `edebug-form-spec'."
116 "Maximum recursion depth when instrumenting code.
117 This limit is intended to stop recursion if an Edebug specification
118 contains an infinite loop. When Edebug is instrumenting code
119 containing very large quoted lists, it may reach this limit and give
121 Make this limit larger to countermand that, but you may also need to
122 increase `max-lisp-eval-depth' and `max-specpdl-size'."
128 "If non-nil, Edebug saves and restores the window configuration.
129 That takes some time, so if your program does not care what happens to
130 the window configurations, it is better to set this variable to nil.
132 If the value is a list, only the listed windows are saved and
133 restored.
135 `edebug-toggle-save-windows' may be used to change this variable."
140 "If non-nil, save and restore point in all displayed buffers.
142 Saving and restoring point in other buffers is necessary if you are
143 debugging code that changes the point of a buffer that is displayed
144 in a non-selected window. If Edebug or the user then selects the
145 window, the buffer's point will be changed to the window's point.
147 Saving and restoring point in all buffers is expensive, since it
148 requires selecting each window twice, so enable this only if you
149 need it."
154 "Initial execution mode for Edebug, if non-nil.
155 If this variable is non-nil, it specifies the initial execution mode
156 for Edebug when it is first activated. Possible values are step, next,
157 go, Go-nonstop, trace, Trace-fast, continue, and Continue-fast."
165 "Non-nil means display a trace of function entry and exit.
166 Tracing output is displayed in a buffer named `*edebug-trace*', one
167 function entry or exit per line, indented by the recursion level.
169 You can customize by replacing functions `edebug-print-trace-before'
170 and `edebug-print-trace-after'."
175 "If non-nil, Edebug tests coverage of all expressions debugged.
176 This is done by comparing the result of each expression with the
177 previous result. Coverage is considered OK if two different
178 results are found.
180 Use `edebug-display-freq-count' to display the frequency count and
181 coverage information for a definition."
186 "If non-nil, continue defining or executing any keyboard macro.
187 Use this with caution since it is not debugged."
193 "If non-nil, default value of `print-length' for printing results in Edebug."
197 "If non-nil, default value of `print-level' for printing results in Edebug."
201 "If non-nil, default value of `print-circle' for printing results in Edebug."
206 "Non-nil if Edebug should unwrap results of expressions.
207 That is, Edebug will try to remove its own instrumentation from the result.
208 This is useful when debugging macros where the results of expressions
209 are instrumented expressions. But don't do this when results might be
210 circular or an infinite loop will result."
215 "Value bound to `debug-on-error' while Edebug is active.
217 If `debug-on-error' is non-nil, that value is still used.
219 If the value is a list of signal names, Edebug will stop when any of
220 these errors are signaled from Lisp code whether or not the signal is
221 handled by a `condition-case'. This option is useful for debugging
222 signals that *are* handled since they would otherwise be missed.
223 After execution is resumed, the error is signaled again."
232 "Value bound to `debug-on-quit' while Edebug is active."
237 "If non-nil, an expression to test for at every stop point.
238 If the result is non-nil, then break. Errors are ignored."
240 :risky t
244 "Number of seconds to pause when execution mode is `trace' or `continue'."
249 "Whether or not to pause for `edebug-sit-for-seconds' on reaching a break."
254 ;;; Form spec utilities.
257 ;; Get the spec of symbol resolving all indirection.
265 ;; (edebug-trace "indirection: %s" edebug-form-spec)
267 spec))
269 ;;;###autoload
271 "Return t if SPEC uses only extant spec symbols.
272 An extant spec symbol is a symbol that is not a function and has a
273 `edebug-form-spec' property."
279 t))
283 ;;; Utilities
286 "Return t if OBJECT is a lambda list keyword.
287 A lambda list keyword is a symbol that starts with `&'."
293 ;; Return the last sexp before point in current buffer.
294 ;; Assumes Emacs Lisp syntax is active.
304 "Return a list of windows, in order of `next-window'."
305 ;; This doesn't work for epoch.
310 ;; Not used.
312 "Return t if there are two windows."
318 ;; Return the ALIST sorted with comparison function FUNCTION.
319 ;; This uses 'sort so the sorting is destructive.
324 ;; Not used.
326 "Evaluate BODY while saving the current buffers restriction.
327 BODY may change buffer outside of current restriction, unlike
328 save-restriction. BODY may change the current buffer,
329 and the restriction will be restored to the original buffer,
330 and the current buffer remains current.
331 Return the result of the last expression in BODY."
340 ;;; Display
346 ;; Like pop-to-buffer, but select window where BUFFER was last shown.
347 ;; Select WINDOW if it is provided and still exists. Otherwise,
348 ;; if buffer is currently shown in several windows, choose one.
349 ;; Otherwise, find a new window, possibly splitting one.
350 ;; FIXME: We should probably just be using `pop-to-buffer'.
355 window)
357 ;; Selected window already displays BUFFER.
361 ;; When there's one window only, split it.
368 ;; Found a non-dedicated window not showing
369 ;; `edebug-trace-buffer', use it.
371 ;; All windows are dedicated or show `edebug-trace-buffer', split
372 ;; selected one.
379 ;; Return a list of buffer point pairs, for all displayed buffers.
385 list))))
386 list))
390 ;; Restore the buffer-points created by edebug-get-displayed-buffer-points.
396 buffer-points)))
399 ;; Get either a full window configuration or some window information.
408 which-windows)
412 ;; Set either a full window configuration or some window information.
424 one-window-info)))
425 window-info)
428 ;;; Redefine read and eval functions
429 ;; read is redefined to maybe instrument forms.
430 ;; eval-defun is redefined to check edebug-all-forms and edebug-all-defs.
433 "Read one Lisp expression as text from STREAM, return as Lisp object.
434 If STREAM is nil, use the value of `standard-input' (which see).
435 STREAM or the value of `standard-input' may be:
436 a buffer (read from point and advance it)
437 a marker (read from where it points and advance it)
438 a function (call it with no arguments for each character,
439 call it with a char as argument to push a char back)
440 a string (takes text from string, starting at the beginning)
441 t (read text line using minibuffer and use it).
443 This version, from Edebug, maybe instruments the expression. But the
444 STREAM must be the current buffer to do so. Whether it instruments is
445 also dependent on the values of the option `edebug-all-defs' and
446 the option `edebug-all-forms'."
454 ;; We should somehow arrange to be able to do this
455 ;; without actually replacing the eval-defun command.
457 "Evaluate the top-level form containing point, or after point.
459 If the current defun is actually a call to `defvar', then reset the
460 variable using its initial value expression even if the variable
461 already has some other value. (Normally `defvar' does not change the
462 variable's value if it already has a value.) Treat `defcustom'
463 similarly. Reinitialize the face according to `defface' specification.
465 With a prefix argument, instrument the code for Edebug.
467 Setting option `edebug-all-defs' to a non-nil value reverses the meaning
468 of the prefix argument. Code is then instrumented when this function is
469 invoked without a prefix argument.
471 If acting on a `defun' for FUNCTION, and the function was instrumented,
472 `Edebug: FUNCTION' is printed in the minibuffer. If not instrumented,
473 just FUNCTION is printed.
475 If not acting on a `defun', the result of evaluation is displayed in
476 the minibuffer."
484 ;; This should be consistent with `eval-defun-1', but not the
485 ;; same, since that gets a macroexpanded form.
488 ;; Force variable to be bound.
492 ;; Force variable to be bound.
493 ;; FIXME: Shouldn't this use the :setter or :initializer?
496 ;; Reset the face.
501 ;; See comments in `eval-defun-1' for purpose of code below
514 edebug-result)))
517 ;;;###autoload
520 ;;;###autoload
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).
527 If you do this on a function definition such as a defun or defmacro,
528 it defines the function and instruments its definition for Edebug,
529 so it will do Edebug stepping when called later. It displays
530 `Edebug: FUNCTION' in the echo area to indicate that FUNCTION is now
531 instrumented for Edebug.
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.)"
540 ;; Bind edebug-all-forms only while reading, not while evalling
541 ;; but this causes problems while edebugging edebug.
554 ;; Recover point, but only if no error occurred.
558 ;; Compatibility with old versions.
561 ;;;###autoload
563 "Toggle edebugging of all definitions."
570 ;;;###autoload
572 "Toggle edebugging of all forms."
589 ;;; Edebug internal data
591 ;; The internal data that is needed for edebugging is kept in the
592 ;; buffer-local variable `edebug-form-data'.
595 "A list of entries associating symbols with buffer regions.
596 Each entry is an `edebug--form-data' struct with fields:
597 SYMBOL, BEGIN-MARKER, and END-MARKER. The markers
598 are at the beginning and end of an entry level form and SYMBOL is
599 a symbol that holds all edebug related information for the form on its
600 property list.
602 In the future (haha!), the symbol will be irrelevant and edebug data will
603 be stored in the definitions themselves rather than in the property
607 ;; Some callers expect accessors to return nil when passed nil.
611 name begin end)
619 ;; Find the edebug form data entry which is closest to PNT.
620 ;; If END-POINT is supplied, match must be exact.
621 ;; Return nil if none found.
623 closest-entry
636 closest-entry entry))))
637 closest-entry))
639 ;; Also need to find all contained entries,
640 ;; and find an entry given a symbol, which should be just assq.
643 "Return the edebug data symbol of the form where point is in.
644 If point is not inside a edebuggable form, cause error."
649 ;; Make NEW-ENTRY the first element in the `edebug-form-data' list.
654 "If non-nil, clear ENTRY out of the form data.
655 Maybe clear the markers and delete the symbol's edebug property?"
658 ;; Instead of this, we could just find all contained forms.
659 ;; (put (car entry) 'edebug nil) ;
660 ;; (mapcar #'edebug-clear-form-data-entry ; dangerous
661 ;; (get (car entry) 'edebug-dependents))
662 ;; (set-marker (nth 1 entry) nil)
663 ;; (set-marker (nth 2 entry) nil)
666 ;;; Parser utilities
669 ;; Signal an invalid-read-syntax with ARGS.
674 ;; Lookup table for significant characters indicating the class of the
675 ;; token that follows. This is not a \"real\" syntax table.
692 ;; We treat numbers as symbols, because of confusion with -, -1, and 1-.
693 ;; We don't care about any other chars since they won't be seen.
694 table))
697 ;; Move to the next token and return its class. We only care about
698 ;; lparen, rparen, dot, quote, backquote, comma, string, char, vector,
699 ;; or symbol.
708 'symbol
713 ;; Leave point before the next token, skipping white space and comments.
720 ;; Mostly obsolete reader; still used in one case.
723 ;; Read one sexp from the current buffer starting at point.
724 ;; Leave point immediately after it. A sexp can be a list or atom.
725 ;; An atom is a symbol (or number), character, string, or vector.
726 ;; This works for reading anything legitimate, but it
727 ;; is gummed up by parser inconsistencies (bugs?)
730 ;; read goes one too far if a (possibly quoted) string or symbol
731 ;; is immediately followed by non-whitespace.
743 ;;; Offsets for reader
745 ;; Define a structure to represent offset positions of expressions.
746 ;; Each offset structure looks like: (before . after) for constituents,
747 ;; or for structures that have elements: (before <subexpressions> . after)
748 ;; where the <subexpressions> are the offset structures for subexpressions
749 ;; including the head of a list.
752 ;; Stack of offset structures in reverse order of the nesting.
753 ;; This is used to get back to previous levels.
757 ;; The association list of objects read with the #n=object form.
758 ;; Each member of the list has the form (n . object), and is used to
759 ;; look up the object for the corresponding #n# construct.
762 ;; We must store whether we just read a list with a dotted form that
763 ;; is itself a list. This structure will be condensed, so the offsets
764 ;; must also be condensed.
768 ;; Reinitialize offset recording.
772 ;; Add a new offset pair with POINT as the before offset.
777 ;; Otherwise, we are at the top level, so initialize.
779 edebug-offsets-stack nil
780 edebug-read-dotted-list nil))
781 ;; Cons the new offset to the front of the stack.
783 edebug-current-offset new-offset)
784 ))
787 ;; Finalize the current offset struct by reversing it and
788 ;; store POINT as the after offset.
790 ;; Just reverse the offsets of all subexpressions.
793 ;; We just read a list after a dot, which will be abbreviated out.
795 ;; Drop the corresponding offset pair.
796 ;; That is, nconc the reverse of the rest of the offsets
797 ;; with the cdr of last offset.
802 ;; Now append the point using nconc.
804 ;; Pop the stack.
809 ;; Ignore the last created offset pair.
821 ;;; Reader for Emacs Lisp.
823 ;; Uses edebug-next-token-class (and edebug-skip-whitespace) above.
834 ))
841 ;; anything else, just read it.
843 stream))))
849 ;; Turn 'thing into (quote thing)
856 ;; Turn `thing into (\` thing)
863 ;; Turn ,thing into (\, thing). Handle ,@ and ,. also.
873 ;; Generate the same structure of offsets we would have
874 ;; if the resulting list appeared verbatim in the input text.
880 "Read from STREAM a Lisp object beginning with #.
881 Turn #'thing into (function thing) and handle the read syntax for
882 circular objects. Let `read' read everything else."
901 ;; Make a placeholder for #n# to use temporarily.
905 ;; Read the object and then replace the placeholder
906 ;; with the object itself, wherever it occurs.
912 ;; #n# returns a previously read object.
917 ;; Let read handle errors, radix notation, and anything else.
936 ))
937 elements)
939 ))
949 ))
951 ;;; Cursors for traversal of list and vector elements with offsets.
956 ;; Return a new cursor for EXPRESSIONS with OFFSETS.
962 ;; Set the CURSOR's EXPRESSIONS and OFFSETS to the given.
963 ;; Return the cursor.
966 cursor)
969 ;; Copy the cursor using the same object and offsets.
978 ;; Return non-nil if CURSOR is empty - meaning no more elements.
982 ;; Return the top element at the cursor.
983 ;; Assumes not empty.
987 ;; Check if a dotted form is required.
989 ;; Check if there is at least one more argument.
991 ;; Return that top element.
995 ;; Return the top offset pair corresponding to the top element.
999 ;; Advance and return the cursor to the next element and offset.
1000 ;; throw no-match if empty before moving.
1001 ;; This is a violation of the cursor encapsulation, but
1002 ;; there is plenty of that going on while matching.
1003 ;; The following test should always fail.
1008 cursor)
1012 ;; Return the before offset of the cursor.
1013 ;; If there is nothing left in the offsets,
1014 ;; return one less than the offset itself,
1015 ;; which is the after offset for a list.
1022 ;; Return the after offset of the cursor object.
1026 offset))
1028 ;;; The Parser
1030 ;; The top level function for parsing forms is
1031 ;; edebug-read-and-maybe-wrap-form; it calls all the rest. It checks the
1032 ;; syntax a bit and leaves point at any error it finds, but otherwise
1033 ;; should appear to work like eval-defun.
1035 ;; The basic plan is to surround each expression with a call to
1036 ;; the edebug debugger together with indexes into a table of positions of
1037 ;; all expressions. Thus an expression "exp" becomes:
1039 ;; (edebug-after (edebug-before 1) 2 exp)
1041 ;; When this is evaluated, first point is moved to the beginning of
1042 ;; exp at offset 1 of the current function. The expression is
1043 ;; evaluated, which may cause more edebug calls, and then point is
1044 ;; moved to offset 2 after the end of exp.
1046 ;; The highest level expressions of the function are wrapped in a call to
1047 ;; edebug-enter, which supplies the function name and the actual
1048 ;; arguments to the function. See functions edebug-enter, edebug-before,
1049 ;; and edebug-after for more details.
1051 ;; Dynamically bound vars, left unbound, but globally declared.
1052 ;; This is to quiet the byte compiler.
1054 ;; Window data of the highest definition being wrapped.
1055 ;; This data is shared by all embedded definitions.
1070 ;; Read a form and wrap it with edebug calls, if the conditions are right.
1071 ;; Here we just catch any no-match not caught below and signal an error.
1073 ;; Run the setup hook.
1074 ;; If it gets an error, make it nil.
1081 edebug-top-window-data
1082 edebug-def-name;; make sure it is locally nil
1083 ;; I don't like these here!!
1084 edebug-&optional
1085 edebug-&rest
1086 edebug-gate
1087 edebug-best-error
1088 edebug-error-point
1089 ;; Do this once here instead of several times.
1095 nil)))
1098 result))
1103 def-kind
1104 defining-form-p
1105 def-name
1106 ;; These offset things don't belong here, but to support recursive
1107 ;; calls to edebug-read, they need to be here.
1108 edebug-offsets
1109 edebug-offsets-stack
1110 edebug-current-offset ; reset to nil
1111 edebug-read-objects
1112 )
1116 ;; Find out if this is a defining form from first symbol
1121 ;; This is incorrect in general!! But OK most of the time.
1126 ;;;(message "all defs: %s all forms: %s" edebug-all-defs edebug-all-forms)
1130 ;; If it is a defining form and we are edebugging defs,
1131 ;; then let edebug-list-form start it.
1137 cursor
1142 ;; Not edebugging this form, so reset the symbol's edebug
1143 ;; property to be just a marker at the definition's source code.
1144 ;; This only works for defs with simple names.
1146 ;; Also nil out dependent defs.
1153 ;; If all forms are being edebugged, explicitly wrap it.
1159 cursor
1162 nil)))
1164 ;; Not a defining form, and not edebugging.
1166 ))
1172 ;; Currently def-form sets this to nil; def-body sets it to t.
1175 ;; Return a unique symbol for the variable used to store the
1176 ;; status of interactive-p for this function.
1181 "Wrap the FORMS of a definition body."
1190 ;; Generate the enter wrapper for some forms of a definition.
1191 ;; This is not to be used for the body of other forms, e.g. `while',
1192 ;; since it wraps the list of forms with a call to `edebug-enter'.
1193 ;; Uses the dynamically bound vars edebug-def-name and edebug-def-args.
1194 ;; Do this after parsing since that may find a name.
1201 ;; Doesn't work with more than one def-body!!
1202 ;; But the list will just be reversed.
1206 ))
1215 ;; Modifies edebug-offset-index and edebug-offset-list
1216 ;; accesses edebug-func-marc and buffer point.
1218 edebug-offset-index
1220 edebug-offset-list)
1225 ;; Return the edebug form for the current function at offset BEFORE-INDEX
1226 ;; given FORM. Looks like:
1227 ;; (edebug-after (edebug-before BEFORE-INDEX) AFTER-INDEX FORM)
1228 ;; Also increment the offset index for subsequent use.
1232 ;; Like edebug-make-before-and-after-form, but only after.
1237 "Return the unwrapped SEXP or return it as is if it is not wrapped.
1238 The SEXP might be the result of wrapping a body, which is a list of
1239 expressions; a `progn' form will be returned enclosing these forms."
1247 )
1248 sexp))
1251 "Return the SEXP recursively unwrapped."
1258 new-sexp)))
1262 ;; Process the defining form, starting outside the form.
1263 ;; The speclist is a generated list spec that looks like:
1264 ;; (("def-symbol" defining-form-spec-sans-&define))
1265 ;; Skip the first offset.
1269 cursor
1271 speclist))
1275 ;; Wrap a form, usually a defining form, but any evaluated one.
1276 ;; If speclist is non-nil, this is being called by edebug-defining-form.
1277 ;; Otherwise it is being called from edebug-read-and-maybe-wrap-form1.
1278 ;; This is a hack, but I haven't figured out a simpler way yet.
1280 ;; Set this marker before parsing.
1284 ;; Buffer must be current-buffer for this to work:
1289 result
1290 ;; For definitions.
1291 ;; (edebug-containing-def-name edebug-def-name)
1292 ;; Get name from form-data, if any.
1294 edebug-def-name
1295 edebug-def-args
1296 edebug-def-interactive
1297 edebug-inside-func;; whether wrapped code executes inside a function.
1298 )
1304 ;; else wrap as an enter-form.
1307 ;; Set the name here if it was not set by edebug-make-enter-wrapper.
1311 ;; Add this def as a dependent of containing def. Buggy.
1319 ;; Create a form-data-entry or modify existing entry's markers.
1320 ;; In the latter case, pointers to the entry remain eq.
1324 edebug-def-name
1325 edebug-form-begin-marker
1326 ;; Buffer must be current-buffer.
1328 ))
1330 form-data-entry edebug-def-name ;; in case name is changed
1331 form-begin form-end))
1333 ;; (message "defining: %s" edebug-def-name) (sit-for 2)
1336 ;;(debug edebug-def-name)
1338 ;; Destructively reverse edebug-offset-list and make vector from it.
1341 ;; Side effects on the property list of edebug-def-name.
1345 ;; Set up the initial window data.
1353 ;; Store the edebug data in symbol's property list.
1355 ;; A struct or vector would be better here!!
1357 nil ; clear breakpoints
1358 edebug-offset-list
1359 edebug-top-window-data
1360 ))
1361 result
1362 )))
1366 ;; Create initial frequency count vector.
1367 ;; For each stop point, the counter is incremented each time it is visited.
1373 ;; Create initial coverage vector.
1374 ;; Only need one per expression, but it is simpler to use stop points.
1380 ;; Return the instrumented form for the following form.
1381 ;; Add the point offsets to the edebug-offset-list for the form.
1387 ;; The first offset for a list form is for the list form itself.
1389 form
1393 ;; Find out if this is a defining form from first symbol.
1394 ;; An indirect spec would not work here, yet.
1397 new-cursor
1401 ;; Wrap a regular form.
1405 ;; After processing the list form, the new-cursor is left
1406 ;; with the offset after the form.
1408 )))
1412 ;; Check for constant symbols that don't get wrapped.
1415 form)
1420 ;; Anything else is self-evaluating.
1429 ;; Process the arguments of a list form given that head of form is a symbol.
1430 ;; Helper for edebug-list-form
1436 ;; It is a speclist.
1443 ; but leave it in for compatibility.
1444 ))
1445 ;; No edebug-form-spec provided.
1455 ;; Return an instrumented form built from the list form.
1456 ;; The after offset will be left in the cursor after processing the form.
1458 ;; Prevent backtracking whenever instrumenting.
1460 ;; A list form is never optional because it matches anything.
1463 ;; Skip the first offset.
1471 ;; Special case: replace (interactive-p) with variable
1481 ;; The head of a form should normally be a symbol or a lambda
1482 ;; expression but it can also be an unquote form to be filled
1483 ;; before evaluation. We evaluate the arguments anyway, on the
1484 ;; assumption that the unquote form will place a proper function
1485 ;; name (rather than a macro name).
1487 ;; Process anonymous function and args.
1488 ;; This assumes no anonymous macros.
1493 ))
1495 ;;; Matching of specs.
1502 ;;; Failure to match
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.
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.
1523 ;; Top level spec matching function.
1524 ;; Used also at each lower level of specs.
1526 edebug-&rest
1527 edebug-best-error
1528 edebug-error-point
1530 )
1535 ;; Match one spec, which is not a keyword &-spec.
1541 ))
1545 ;; Append results of matching the list of specs.
1546 ;; The first spec is handled and the remainder-handler handles the rest.
1554 ;; Is the spec dotted?
1559 ;; Is the form dotted?
1563 ;; Cancel dotted spec and dotted form.
1567 ;; Wrap the form in a list, (by changing the cursor??)...
1569 ;; and process normally, then unwrap the result.
1576 ;;(message "spec = %s first char = %s" spec first-char) (sit-for 1)
1590 ;; Define specs for all the symbol specs with functions used to process them.
1591 ;; Perhaps we shouldn't be doing this with edebug-form-specs since the
1592 ;; user may want to define macros or functions with the same names.
1593 ;; We could use an internal obarray for these primitive specs.
1607 ;; Less frequently used:
1608 ;; (function . edebug-match-function)
1614 ;; (nil . edebug-match-nil) not this one - special case it.
1615 ))
1619 ;; Match a symbol spec.
1624 ;; It is an indirect 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.
1635 ;; Special case for edebug-`.
1643 )))
1654 ;; Currently identical to edebug-match-form.
1655 ;; This is for common lisp setf-style place arguments.
1660 ;; Keep matching until one spec fails.
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.
1677 nil)))
1682 ;; Reuse the &optional handler with this as the remainder handler.
1686 ;; Repeatedly use specs until failure.
1688 edebug-best-error
1689 edebug-error-point)
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.
1705 edebug-best-error
1706 edebug-error-point)
1707 ;; Doesn't support e.g. &or symbolp &rest form
1709 ;; Match failed, so reset and try again.
1711 ;; Reset the cursor for the next match.
1713 ;; All failed.
1715 ))
1719 ;; If any specs match, then fail
1724 nil))
1725 ;; This means something matched, so it is a no match.
1727 ;; This means nothing matched, so it is OK.
1734 ;; Following specs must look like (<name> <spec>) ...
1735 ;; where <name> is the name of a keyword, and spec is its spec.
1736 ;; This really doesn't save much over the expanded form and takes time.
1738 cursor
1743 specs))))
1747 ;; Simply set the gate to prevent backtracking at this level.
1749 nil)
1753 ;; The spec is a list, but what kind of list, and what context?
1755 ;; After dotted spec but form did not contain dot,
1756 ;; so match list spec elements as if spliced in.
1760 ;; If it matched, really clear the dotted-spec flag.
1769 ;; Special case: spec quotes a symbol to match.
1770 ;; Change in future. Use "..." instead.
1775 form)
1781 ;; Special case: match a vector with the specs.
1793 ;; First offset is for the list form itself.
1794 ;; Treat nil as empty list.
1796 specs))
1800 )))
1804 ;; Match a sublist of specs.
1806 ;;edebug-best-error
1807 ;;edebug-error-point
1808 )
1810 ;; match with edebug-match-specs so edebug-best-error is not bound.
1815 ;; A failed &rest or &optional spec may leave some args.
1817 )))))
1824 ;; Since it matched, failure means immediate error, unless &optional.
1828 )))
1831 ;; There must be nothing left to match a nil.
1834 nil))
1841 ;; Match a defining form.
1842 ;; Normally, &define is interpreted specially other places.
1843 ;; This should only be called inside of a spec list to match the remainder
1844 ;; of the current list. e.g. ("lambda" &define args def-body)
1846 cursor
1848 ;; Find the last offset in the list.
1851 offsets)
1852 specs))
1855 ;; The expression must be a function.
1856 ;; This will match any list form that begins with a symbol
1857 ;; that has an edebug-form-spec beginning with &define. In
1858 ;; practice, only lambda expressions should be used.
1859 ;; I could add a &lambda specification to avoid confusion.
1866 ;; Find out if this is a defining form from first symbol.
1877 )))
1881 ;; Set the edebug-def-name bound in edebug-defining-form.
1883 ;; Maybe strings and numbers could be used.
1888 ;; Construct a new name by appending to previous name.
1890 name))
1895 ;; Set the edebug-def-name to the spec.
1898 ;; Construct a new name by appending to previous name.
1900 spec))
1901 nil)
1904 ;; set the def-args bound in edebug-defining-form
1914 ;; Like form but the form is wrapped in edebug-enter form.
1915 ;; The form is assumed to be executing outside of the function context.
1916 ;; This is a hack for now, since a def-form might execute inside as well.
1917 ;; Not to be used otherwise.
1922 ;; Like body but body is wrapped in edebug-enter form.
1923 ;; The body is assumed to be executing inside of the function context.
1924 ;; Not to be used otherwise.
1927 ;; If there's no form, there's nothing to wrap!
1928 ;; This happens to handle bug#20281, tho maybe a better fix would be to
1929 ;; improve the `defun' spec.
1934 ;;;; Edebug Form Specs
1935 ;;; ==========================================================
1937 ;;;;* Spec for def-edebug-spec
1938 ;;; Out of date.
1941 "Return non-nil if OBJECT is a symbol with an edebug-form-spec property."
1946 ;; Top level is different from lower levels.
1951 ;; A list must have something in it, or it is nil, a symbolp
1955 (&or
1959 edebug-spec-list
1960 stringp
1963 edebug-spec-p ;; Including all the special ones e.g. form.
1964 symbolp;; a predicate
1965 ))
1968 ;;;* Emacs special forms and some functions.
1970 ;; quote expects only one argument, although it allows any number.
1973 ;; The standard defining forms.
1978 (&define name lambda-list
1982 def-body))
1984 ;; FIXME: Improve `declare' so we can Edebug gv-expander and
1985 ;; gv-setter declarations.
1995 )))
2000 ;; A function-form is for an argument that may be a function or a form.
2001 ;; This specially recognizes anonymous functions quoted with quote.
2003 ;; form at the end could also handle "function",
2004 ;; but recognize it specially to avoid wrapping function forms.
2007 ;; function expects a symbol or a lambda or macro expression
2008 ;; A macro is allowed by Emacs.
2011 ;; A macro expression is a lambda expression with "macro" prepended.
2014 ;; (def-edebug-spec anonymous-form ((&or ["lambda" lambda] ["macro" macro])))
2016 ;; Standard functions that take function-forms arguments.
2018 ;; FIXME? The manual uses this form (maybe that's just for illustration?):
2019 ;; (def-edebug-spec let
2020 ;; ((&rest &or symbolp (gate symbolp &optional form))
2021 ;; body))
2024 body))
2035 form
2041 ;; Supports quotes inside backquotes,
2042 ;; but only at the top level inside unquotes.
2044 (&or
2046 ;; The simple version:
2047 ;; (backquote-form &rest backquote-form)
2048 ;; doesn't handle (a . ,b). The straightforward fix:
2049 ;; (backquote-form . [&or nil backquote-form])
2050 ;; uses up too much stack space.
2051 ;; Note that `(foo . ,@bar) is not valid, so we don't need to handle it.
2054 ;; If you use dotted forms in backquotes, replace the previous line
2055 ;; with the following. This takes quite a bit more stack space, however.
2056 ;; (backquote-form . [&or nil backquote-form])
2058 sexp))
2060 ;; Special version of backquote that instruments backquoted forms
2061 ;; destined to be evaluated, usually as the result of a
2062 ;; macroexpansion. Backquoted code can only have unquotes (, and ,@)
2063 ;; in places where list forms are allowed, and predicates. If the
2064 ;; backquote is used in a macro, unquoted code that come from
2065 ;; arguments must be instrumented, if at all, with def-form not def-body.
2067 ;; We could assume that all forms (not nested in other forms)
2068 ;; in arguments of macros should be def-forms, whether or not the macros
2069 ;; are defined with edebug-` but this would be expensive.
2071 ;; ,@ might have some problems.
2076 ;; Assume immediate quote in unquotes mean backquote at next higher level.
2081 ;; New byte compiler.
2086 ;; Anything else?
2088 ;;; The debugger itself
2093 ;; Stack of active functions evaluated via edebug.
2094 ;; Should be nil at the top level.
2097 ;; Index of last edebug-stack item.
2100 ;; Stack of offset indices of visited edebug sexps.
2101 ;; Should be nil at the top level.
2102 ;; Each function adds one cons. Top is modified with setcar.
2106 ;; Non-nil if edebug has already been entered at this recursive edit level.
2107 ;; This should stay nil at the top level.
2108 )
2110 ;; Should these be options?
2112 ;; Name of function to use for debugging when error or quit occurs.
2113 ;; Set this to 'debug if you want to debug edebug.
2114 )
2117 ;; Dynamically bound variables, declared globally but left unbound.
2132 ;;; Handling signals
2135 "Signal an error. Args are SIGNAL-NAME, and associated DATA.
2136 A signal name is a symbol with an `error-conditions' property
2137 that is a list of condition names.
2138 A handler for any of those names will get to handle this signal.
2139 The symbol `error' should always be one of them.
2141 DATA should be a list. Its elements are printed as part of the error message.
2142 If the signal is handled, DATA is made available to the handler.
2143 See `condition-case'.
2145 This is the Edebug replacement for the standard `signal'. It should
2146 only be active while Edebug is. It checks `debug-on-error' to see
2147 whether it should call the debugger. When execution is resumed, the
2148 error is signaled again."
2151 ;; If we reach here without another non-local exit, then send signal again.
2152 ;; i.e. the signal is not continuable, yet.
2153 ;; Avoid infinite recursion.
2157 ;;; Entering Edebug
2160 ;; Entering FUNC. The arguments are ARGS, and the body is BODY.
2161 ;; Setup edebug variables and evaluate BODY. This function is called
2162 ;; when a function evaluated with edebug-eval-top-level-form is entered.
2163 ;; Return the result of BODY.
2165 ;; Is this the first time we are entering edebug since
2166 ;; lower-level recursive-edit command?
2167 ;; More precisely, this tests whether Edebug is currently active.
2171 ;; Binding max-lisp-eval-depth here is OK,
2172 ;; but not inside an unwind-protect.
2173 ;; Doing it here also keeps it from growing too large.
2180 ;; Binding these may not be the right thing to do.
2181 ;; We want to allow the global values to be changed.
2187 edebug-initial-mode
2188 edebug-execution-mode)
2189 edebug-next-execution-mode nil)
2200 )
2209 ))))
2212 "Return a cons cell describing the status of VAR's current binding.
2213 The purpose of this function is so you can properly undo
2214 subsequent changes to the same binding, by passing the status
2215 cons cell to `edebug-restore-status'. The status cons cell
2216 has the form (LOCUS . VALUE), where LOCUS can be a buffer
2217 \(for a buffer-local binding), or nil (if the default binding is current)."
2222 "Reset VAR based on STATUS.
2223 STATUS should be a list returned by `edebug-var-status'."
2237 edebug-result)
2247 "Print MSG in *edebug-trace* before and after evaluating BODY.
2248 The result of BODY is also printed."
2250 edebug-result)
2257 "Function called to print trace info before expression evaluation.
2258 MSG is printed after `::::{ '."
2263 "Function called to print trace info after expression evaluation.
2264 MSG is printed after `::::} '."
2272 ;; Debug current function given BEFORE position.
2273 ;; Called from functions compiled with edebug-eval-top-level-form.
2274 ;; Return the before index.
2277 ;; Increment frequency count
2284 before-index)
2287 ;; Do nothing.
2288 )
2292 value
2293 ;; Debug current function given AFTER position and VALUE.
2294 ;; Called from functions compiled with edebug-eval-top-level-form.
2295 ;; Return VALUE.
2298 ;; Increment frequency count
2305 ;; Just return result.
2306 value
2308 )))
2311 ;; Do nothing but return the value.
2312 value)
2318 ;; This is not used, yet.
2332 ;; Test if a different result.
2337 ;; Dynamically declared unbound variables.
2350 ;; Don't really try to enter edebug within an eval from redisplay.
2351 value
2352 ;; Check breakpoints and pending input.
2353 ;; If edebug display should be updated, call edebug--display.
2354 ;; Return value.
2367 ;;(edebug-trace "exp: %s" value)
2368 ;; Test whether we should break.
2377 ;; Delete the breakpoint.
2382 ;; Display if mode is not go, continue, or Continue-fast
2383 ;; or break, or input is pending,
2385 edebug-break
2389 value)))
2392 ;; window-start now stored with each function.
2393 ;;(defvar edebug-window-start nil)
2394 ;; Remember where each buffers' window starts between edebug calls.
2395 ;; This is to avoid spurious recentering.
2396 ;; Does this still need to be buffer-local??
2397 ;;(setq-default edebug-window-start nil)
2398 ;;(make-variable-buffer-local 'edebug-window-start)
2401 ;; Dynamically declared unbound vars
2415 ;; Emacs 19 adds an arg to mark and mark-marker.
2419 ;; edebug--display-1 is too big, we should split it. This function
2420 ;; here was just introduced to avoid making edebug--display-1
2421 ;; yet a bit deeper.
2426 ;; The buffer holding the source has been killed.
2427 ;; Let's at least show a backtrace so the user can figure out
2428 ;; which function we're talking about.
2430 ;; Setup windows for edebug, determine mode, maybe enter recursive-edit.
2431 ;; Uses local variables of edebug-enter, edebug-before, edebug-after
2432 ;; and edebug-debugger.
2435 edebug-stop ; Should we enter recursive-edit?
2438 edebug-buffer-outside-point ; current point in edebug-buffer
2439 ;; window displaying edebug-buffer
2445 edebug-outside-windows ; Window or screen configuration.
2446 edebug-buffer-points
2448 edebug-eval-buffer ; Declared here so we can kill it below.
2451 edebug-trace-window
2452 edebug-trace-window-start
2459 ;; any others??
2460 )
2466 ;; Compute result string now before windows are modified.
2470 ;; Save windows now before we modify them.
2477 ;; First move the edebug buffer point to edebug-point
2478 ;; so that window start doesn't get changed when we display it.
2479 ;; I don't know if this is going to help.
2480 ;;(set-buffer edebug-buffer)
2481 ;;(goto-char edebug-point)
2483 ;; If edebug-buffer is not currently displayed,
2484 ;; first find a window for it.
2488 ;; Now display eval list, if any.
2489 ;; This is done after the pop to edebug-buffer
2490 ;; so that buffer-window correspondence is correct after quitting.
2492 ;; The evaluation list better not have deleted edebug-window-data.
2500 ;; Check whether positions are up-to-date.
2501 ;; This assumes point is never before symbol.
2504 edebug-function)
2505 ))
2507 ;; Make sure we bind those in the right buffer (bug#16410).
2510 ;; Now display arrow based on mode.
2515 ;; Display error message
2526 edebug-global-break-condition
2527 edebug-global-break-result))
2530 edebug-break-condition
2531 edebug-break-result))
2540 ;; Display result of previous evaluation.
2542 edebug-sit-on-break
2554 ;; not edebug-break
2573 ;; Reset the edebug-window-data to whatever it is now.
2577 ;; Remember window-start for edebug-buffer, if still displayed.
2583 ;; Save trace window point before restoring outside windows.
2584 ;; Could generalize this for other buffers.
2592 ;; Restore windows before continuing.
2597 ;; Restore displayed buffer points.
2598 ;; Needed even if restoring windows because
2599 ;; window-points are not restored. (should they be??)
2603 ;; Unrestore trace window's window-point.
2606 edebug-trace-window-start))
2608 ;; Unrestore edebug-buffer's window-start, if displayed.
2615 ;; Unrestore edebug-buffer's window-point.
2616 ;; Needed in addition to setting the buffer point
2617 ;; - otherwise quitting doesn't leave point as is.
2618 ;; But can this causes point to not be restored.
2619 ;; Also, it may not be a visible window.
2620 ;; (set-window-point window edebug-point)
2621 )))
2623 ;; Unrestore edebug-buffer's point. Rerestored below.
2624 ;; (goto-char edebug-point) ;; in edebug-buffer
2625 )
2626 ;; Since we may be in a save-excursion, in case of quit,
2627 ;; reselect the outside window only.
2628 ;; Only needed if we are not recovering windows??
2633 ;; Restore current buffer always, in case application needs it.
2636 ;; Restore point, and mark.
2637 ;; Needed even if restoring windows because
2638 ;; that doesn't restore point and mark in the current buffer.
2639 ;; But don't restore point if edebug-buffer is current buffer.
2643 ;; Does zmacs-regions need to be nil while doing set-marker?
2646 ;; None of the following is done if quit or signal occurs.
2648 ;; Restore edebug-buffer's outside point.
2649 ;; (edebug-trace "restore edebug-buffer point: %s"
2650 ;; edebug-buffer-outside-point)
2653 ;; ... nothing more.
2654 )
2655 ;; Could be an option to keep eval display up.
2658 ;; Reset global variables to outside values in case they were changed.
2660 )))
2664 ;; Number of recursive edits started by edebug.
2665 ;; Should be 0 at the top level.
2668 ;; Value of recursion-depth when edebug was called.
2670 ;; Dynamically declared unbound vars
2677 ;; Start up a recursive edit inside of edebug.
2678 ;; The current buffer is the edebug-buffer, which is put into edebug-mode.
2679 ;; Assume that none of the variables below are buffer-local.
2685 ;;(edebug-number-of-recursions (1+ edebug-number-of-recursions))
2687 edebug-entered ; bind locally to nil
2689 edebug-backtrace-buffer ; each recursive edit gets its own
2690 ;; The window configuration may be saved and restored
2691 ;; during a recursive-edit
2692 edebug-inside-windows
2693 )
2697 ;; Declare global values local but using the same global value.
2698 ;; We could set these to the values for previous edebug call.
2703 ;; More for Emacs 19
2713 ;; Don't keep reading from an executing kbd macro
2714 ;; within edebug unless edebug-continue-kbd-macro is
2715 ;; non-nil. Again, local binding may not be best.
2719 ;; Don't get confused by the user's keymap changes.
2723 ;; Bind again to outside values.
2727 ;; Don't keep defining a kbd macro.
2731 ;; others??
2732 )
2744 ;; Do the following, even if quit occurs.
2749 ;; Remember selected-window after recursive-edit.
2750 ;; (setq edebug-inside-window (selected-window))
2754 ;; Recursive edit may have changed buffers,
2755 ;; so set it back before exiting let.
2763 ;; gotta have a buffer to let its buffer local variables be set
2766 )))
2769 ;;; Display related functions
2780 )
2784 ;; Set up the overlay arrow at beginning-of-line in current buffer.
2785 ;; The arrow string is derived from edebug-arrow-alist and
2786 ;; edebug-execution-mode.
2795 "Toggle the saving and restoring of all windows.
2796 Also, each time you toggle it on, the inside and outside window
2797 configurations become the same as the current configuration."
2804 edebug-save-windows))))
2814 edebug-save-windows))
2815 ;; Problem: what about outside windows that are deleted inside?
2819 "Toggle the saving and restoring of the selected window.
2820 Also, each time you toggle it on, the inside and outside window
2821 configurations become the same as the current configuration."
2825 ;; Save all outside windows except the selected one.
2826 ;; Remove (selected-window) from outside-windows.
2833 edebug-outside-windows))
2846 "Toggle the saving and restoring of windows.
2847 With prefix, toggle for just the selected window.
2848 Otherwise, toggle for all windows."
2855 "Show the debug windows and where we stopped in the program."
2859 ;; Restore the window configuration to what it last was inside.
2860 ;; But it is not always set. - experiment
2861 ;;(if edebug-inside-windows
2862 ;; (edebug-set-windows edebug-inside-windows))
2867 "Change to the outside window configuration.
2868 Use `edebug-where' to return."
2881 "Bounce the point in the outside current buffer.
2882 If prefix argument ARG is supplied, sit for that many seconds
2883 before returning. The default is one second."
2888 ;; If the buffer's currently displayed, avoid set-window-configuration.
2900 ;; Joe Wells, here is a start at your idea of adding a buffer to the internal
2901 ;; display list. Still need to use this list in edebug--display.
2907 "Toggle display of a buffer inside of edebug."
2917 ;;; Breakpoint related functions
2920 ;; Return (function . index) of the nearest edebug stop point.
2927 ;; pull out parts of edebug-data.
2929 ;; (edebug-breakpoints (car (cdr edebug-data)))
2934 ;; skip backwards until non-whitespace, or bol
2937 edebug-def-mark))
2938 len i)
2939 ;; the offsets are in order so we can do a linear search
2946 ;; return the relevant info
2949 edebug-def-name)
2950 )))
2954 "Move point to the next breakpoint, or first if none past point."
2962 ;; pull out parts of edebug-data
2966 breakpoint)
2976 ;; goto the first breakpoint
2989 ))))))
2993 "Modify the breakpoint for the form at point or after it.
2994 Set it if FLAG is non-nil, clear it otherwise. Then move to that point.
2995 If CONDITION or TEMPORARY are non-nil, add those attributes to
2996 the breakpoint."
3003 ;; pull out parts of edebug-data
3007 present)
3008 ;; delete it either way
3013 ;; add it to the list and resort
3018 edebug-breakpoints) '<))
3021 edebug-def-name condition)
3029 ))))
3032 "Set the breakpoint of nearest sexp.
3033 With prefix argument, make it a temporary breakpoint."
3038 "Clear the breakpoint of nearest sexp."
3044 "Set `edebug-global-break-condition' to EXPRESSION."
3050 "Global Condition: " initial read-expression-map t
3057 ;;; Mode switching functions
3060 ;; Set the edebug mode to MODE.
3061 ;; Display SHORTMSG, or MSG if not within edebug.
3066 ;; Continue execution
3068 ;; This is not terribly useful!!
3076 "Proceed to next stop point."
3081 "Proceed to next `after' stop point."
3086 "Go, evaluating until break.
3087 With prefix ARG, set temporary break at current point and go."
3094 "Go, evaluating without debugging.
3095 You can use `edebug-stop', or any editing command, to stop."
3102 "Begin trace mode.
3103 Pauses for `edebug-sit-for-seconds' at each stop point."
3108 "Trace with no wait at each step.
3109 Updates the display at each stop point, but does not pause."
3115 "Begin continue mode.
3116 Pauses for `edebug-sit-for-seconds' at each break point."
3122 "Trace with no wait at each step.
3123 Updates the display at each break point, but does not pause."
3128 ;; ------------------------------------------------------------
3129 ;; The following use the mode changing commands and breakpoints.
3133 "Proceed to first stop-point at or after current position of point."
3139 "Stop execution and do not continue.
3140 Useful for exiting from trace or continue loop."
3146 "Proceed to the exit of the next expression to be evaluated."
3154 "Proceed from the current point to the end of the ARGth sexp ahead.
3155 If there are not ARG sexps ahead, then do `edebug-step-out'."
3159 ;; Call forward-sexp repeatedly until done or failure.
3164 )))
3167 "Proceed from the current point to the end of the containing sexp.
3168 If there is no containing sexp that is not the top level defun,
3169 go to the end of the last sexp, or if that is the same point, then step."
3175 ;; Is there still a containing expression?
3179 ;; At top level - 1, so first check if there are more sexps at this level.
3181 ;; (up-list 1)
3186 )))))
3189 ;; Func should be a function symbol.
3190 ;; Return the function symbol, or nil if not instrumented.
3194 ;; It is uninstrumented, so instrument it.
3198 func))
3201 func)
3209 func))))))
3212 "Instrument the definition of the function or macro about to be called.
3213 Do this when stopped before the form or it will be too late.
3214 One side effect of using this command is that the next time the
3215 function or macro is called, Edebug will be called there as well."
3230 "Step into the definition of the function or macro about to be called.
3231 This first does `edebug-instrument-callee' to ensure that it is
3232 instrumented. Then it does `edebug-on-entry' and switches to `go' mode."
3241 "Cause Edebug to stop when FUNCTION is called.
3242 With prefix argument, make this temporary so it is automatically
3243 canceled the first time the function is entered."
3245 ;; Could store this in the edebug data instead.
3254 ;; Also need edebug-cancel-debug-on-entry
3257 "If the function is instrumented for Edebug, call `edebug-on-entry'."
3265 "Set mode to Go-nonstop, and exit to top-level.
3266 This is useful for exiting even if `unwind-protect' code may be executed."
3271 ;;(defun edebug-exit-out ()
3272 ;; "Go until the current function exits."
3273 ;; (interactive)
3274 ;; (edebug-set-mode 'exiting "Exit..."))
3290 "Set the initial execution mode of Edebug.
3291 The mode is requested via the key that would be used to set the mode in
3292 edebug-mode."
3297 "Change initial edebug mode from %s (%c) to (enter key): "
3298 old-mode
3304 edebug-initial-mode-alist))))
3311 ;;; Evaluation of expressions
3314 "Evaluate an expression list in the outside context.
3315 Return the result of the last expression."
3316 ;; Only restores the non-variables context since all the variables let-bound
3317 ;; by Edebug will be properly reset to the appropriate context's value by
3318 ;; backtrace-eval.
3323 ;; After excursion, we will
3324 ;; restore to current window configuration.
3327 ;; Restore outside windows.
3332 ;; Restore outside context.
3335 ;; FIXME: This restoring of edebug-outside-buffer and
3336 ;; edebug-outside-point is redundant now that backtrace-eval does it
3337 ;; for us.
3344 ;; Back to edebug-buffer. Restore rest of inside context.
3345 ;; (use-local-map edebug-inside-map)
3347 ;; Restore inside windows.
3350 ;; Save values that may have been changed.
3354 ;; Restore the outside saved values; don't alter
3355 ;; the outside binding loci.
3362 ;; Evaluate EXPR safely.
3363 ;; If there is an error, a string is returned describing the error.
3370 ;;; Printing
3374 ;; Print an error message like command level does.
3375 ;; This also prints the error name if it has no error-message.
3380 ;; continuing after an error may
3381 ;; complain about edebug-arg. why??
3386 ;; Alternatively, we could change the definition of
3387 ;; edebug-safe-prin1-to-string to only use these if defined.
3407 "Print the previous result."
3411 ;;; Read, Eval and Print
3418 "Evaluate an expression in the outside environment.
3419 If interactive, prompt for the expression.
3420 Print result in minibuffer."
3422 "Eval: " nil read-expression-map t
3431 "Evaluate sexp before point in the outside environment.
3432 Print value in minibuffer."
3437 "Evaluate sexp before point in outside environment; insert value.
3438 This prints the value into current buffer."
3446 ;; princ the string to get rid of quotes.
3449 ))
3451 ;;; Edebug Minor Mode
3454 "If non-nil, inhibit Edebug bindings on the C-x C-a key.
3455 By default, loading the `edebug' library causes these bindings to
3461 ;; Global GUD bindings for all emacs-lisp-mode buffers.
3467 ;; The following isn't a GUD binding.
3472 ;; control
3482 ;;(define-key map "f" 'edebug-forward) not implemented
3490 ;; quitting and stopping
3496 ;; breakpoints
3503 ;; evaluation
3509 ;; views
3516 ;; misc
3522 ;; statistics
3525 ;; GUD bindings
3535 map))
3537 ;; Autoloading these global bindings doesn't make sense because
3538 ;; they cannot be used anyway unless Edebug is already loaded and active.
3554 ;; breakpoints
3560 ;; views
3564 ;; quitting
3569 ;; statistics
3571 map)
3579 "Describe `edebug-mode'."
3586 "Mode for Emacs Lisp buffers while in Edebug.
3588 In addition to all Emacs Lisp commands (except those that modify the
3589 buffer) there are local and global key bindings to several Edebug
3593 Also see bindings for the eval list buffer *edebug* in `edebug-eval-mode'.
3595 The edebug buffer commands:
3598 Global commands prefixed by `global-edebug-prefix':
3601 Options:
3602 `edebug-setup-hook'
3603 `edebug-all-defs'
3604 `edebug-all-forms'
3605 `edebug-save-windows'
3606 `edebug-save-displayed-buffer-points'
3607 `edebug-initial-mode'
3608 `edebug-trace'
3609 `edebug-test-coverage'
3610 `edebug-continue-kbd-macro'
3611 `edebug-print-length'
3612 `edebug-print-level'
3613 `edebug-print-circle'
3614 `edebug-on-error'
3615 `edebug-on-quit'
3616 `edebug-on-signal'
3617 `edebug-unwrap-results'
3618 `edebug-global-break-condition'"
3620 :keymap edebug-mode-map
3621 ;; If the user kills the buffer in which edebug is currently active,
3622 ;; exit to top level, because the edebug command loop can't usefully
3623 ;; continue running in such a case.
3624 ;;
3636 edebug--mode-saved-vars)
3638 ;; Append `edebug-kill-buffer' to the hook to avoid interfering with
3639 ;; other entries that are unguarded against deleted buffer.
3643 "Used on `kill-buffer-hook' when Edebug is operating in a buffer of Lisp code."
3646 ;;; edebug eval list mode
3648 ;; A list of expressions and their evaluations is displayed in *edebug*.
3651 "Return a list of evaluations of `edebug-eval-list'."
3652 ;; Assumes in outside environment.
3653 ;; Don't do any edebug things now.
3659 ;; Assumes edebug-eval-buffer exists.
3670 ))
3677 ;; Should generalize this to be callable outside of edebug
3678 ;; with calls in user functions, e.g. (edebug-eval-display)
3681 "Display expressions and evaluations in EVAL-RESULT-LIST.
3682 It modifies the context by popping up the eval display."
3688 "Redisplay eval list in outside environment.
3689 May only be called from within `edebug--recursive-edit'."
3693 ))
3703 "Replace the evaluation list with the sexps now in the eval buffer."
3706 new-list)
3708 ;; get the first expression
3730 "Delete the item under point and redisplay."
3731 ;; could add arg to do repeatedly
3751 map)
3757 "Mode for evaluation list buffer while in Edebug.
3759 In addition to all Interactive Emacs Lisp commands there are local and
3760 global key bindings to several Edebug specific commands. E.g.
3764 Eval list buffer commands:
3767 Global commands prefixed by `global-edebug-prefix':
3770 ;;; Interface with standard debugger.
3772 ;; (setq debugger 'edebug) ; to use the edebug debugger
3773 ;; (setq debugger 'debug) ; use the standard debugger
3775 ;; Note that debug and its utilities must be byte-compiled to work,
3776 ;; since they depend on the backtrace looking a certain way. But
3777 ;; edebug is not dependent on this, yet.
3780 "Replacement for `debug'.
3781 If we are running an edebugged function, show where we last were.
3782 Otherwise call `debug' normally."
3783 ;;(message "entered: %s depth: %s edebug-recursion-depth: %s"
3784 ;; edebug-entered (recursion-depth) edebug-recursion-depth) (sit-for 1)
3790 ;; Bind variables required by edebug--display.
3791 edebug-breakpoints
3792 edebug-break-data
3793 edebug-break-condition
3794 edebug-global-break
3796 )
3799 nil
3800 value))
3802 ;; Otherwise call debug normally.
3803 ;; Still need to remove extraneous edebug calls from stack.
3805 ))
3809 "Display a non-working backtrace. Better than nothing..."
3815 ;; Else, could just display edebug-backtrace-buffer.
3816 )
3821 last-ok-point)
3824 ;; Clean up the backtrace.
3825 ;; Not quite right for current edebug scheme.
3832 ;; Delete interspersed edebug internals.
3837 ;; Previous lines may contain code, so just delete this line.
3843 "^ (edebug"
3847 )))
3848 )))))
3850 \f
3851 ;;; Trace display
3854 "In buffer BUF-NAME, display FMT and ARGS at the end and make it visible.
3855 The buffer is created if it does not exist.
3856 You must include newlines in FMT to break lines, but one newline is appended."
3857 ;; e.g.
3858 ;; (edebug-trace-display "*trace-point*"
3859 ;; "saving: point = %s window-start = %s"
3860 ;; (point) (window-start))
3864 buf-window)
3865 ;; (message "before pop-to-buffer") (sit-for 1)
3871 ;; Make it visible.
3875 ;; (set-window-point buf-window (point))
3876 ;; (sit-for 0)
3880 buf-name)
3884 "Convenience call to `edebug-trace-display' using `edebug-trace-buffer'."
3887 \f
3888 ;;; Frequency count and coverage
3890 ;; FIXME should this use overlays instead?
3891 ;; Definitely, IMO. The current business with undo in
3892 ;; edebug-temp-display-freq-count is horrid.
3894 "Display the frequency count data for each line of the current definition.
3895 The frequency counts are inserted as comment lines after each line,
3896 and you can undo all insertions with one `undo' command.
3898 The counts are inserted starting under the `(' before an expression
3899 or the `)' after an expression, or on the last char of a symbol.
3900 The counts are only displayed when they differ from previous counts on
3901 the same line.
3903 If coverage is being tested, whenever all known results of an expression
3904 are `eq', the char `=' will be appended after the count
3905 for that expression. Note that this is always the case for an
3906 expression only evaluated once.
3908 To clear the frequency count and coverage data for a definition,
3909 reinstrument it."
3923 )
3925 ;; Traverse in reverse order so offsets are correct.
3927 ;; Start at last expression in line.
3931 last-index i)
3933 ;; Find all indexes on same line.
3936 ;; Insert all the indices for this line.
3939 first-index i ; Really, last index for line above this one.
3942 ;; i == first-index still
3962 ;; FIXME this does not work very well. Eg if you press an arrow key,
3963 ;; or make a mouse-click, it fails with "Non-character input-event".
3965 "Temporarily display the frequency count data for the current definition.
3966 It is removed when you hit any char."
3967 ;; This seems not to work with Emacs 18.59. It undoes too far.
3974 ;; Yuck! This doesn't seem to work at all for me.
3977 \f
3978 ;;; Menus
3984 ;; We have to require easymenu (even for Emacs 18) just so
3985 ;; the easy-menu-define macro call is compiled correctly.
3999 "----"
4004 "----"
4036 "----"
4046 ))
4049 \f
4050 ;;; Emacs version specific code
4058 "Set a conditional breakpoint at nearest sexp.
4059 The condition is evaluated in the outside context.
4060 With prefix argument, make it a temporary breakpoint."
4061 ;; (interactive "P\nxCondition: ")
4064 current-prefix-arg
4065 ;; Read condition as follows; getting previous condition is cumbersome:
4077 "Condition: " initial read-expression-map t
4084 \f
4085 ;;; Autoloading of Edebug accessories
4087 ;; edebug-cl-read and cl-read are available from liberte@cs.uiuc.edu
4093 ;; The following causes edebug-cl-read to be loaded when you load cl-read.el.
4096 \f
4097 ;;; Finalize Loading
4099 ;; When edebugging a function, some of the sub-expressions are
4100 ;; wrapped in (edebug-enter (lambda () ..)), so we need to teach
4101 ;; called-interactively-p that calls within the inner lambda should refer to
4102 ;; the outside function.
4109 ;; `edebug-enter' calls itself on its first invocation.
4114 ;; Finally, hook edebug into the rest of Emacs.
4115 ;; There are probably some other things that could go here.
4117 ;; Install edebug read and eval functions.
4121 "Unload the Edebug source level debugger."
4126 ;; We still want to run unload-feature to completion
4132 ;; Continue standard unloading.
4133 nil)
4136 ;;; edebug.el ends here