| blob | 1a00c45447ca6544cb236d2209bfd740142f23a8 |
1 ;;; edebug.el --- a source-level debugger for Emacs Lisp -*- lexical-binding: t -*-
3 ;; Copyright (C) 1988-1995, 1997, 1999-2016 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 "If non-nil, Edebug saves and restores the window configuration.
117 That takes some time, so if your program does not care what happens to
118 the window configurations, it is better to set this variable to nil.
120 If the value is a list, only the listed windows are saved and
121 restored.
123 `edebug-toggle-save-windows' may be used to change this variable."
128 "If non-nil, save and restore point in all displayed buffers.
130 Saving and restoring point in other buffers is necessary if you are
131 debugging code that changes the point of a buffer that is displayed
132 in a non-selected window. If Edebug or the user then selects the
133 window, the buffer's point will be changed to the window's point.
135 Saving and restoring point in all buffers is expensive, since it
136 requires selecting each window twice, so enable this only if you
137 need it."
142 "Initial execution mode for Edebug, if non-nil.
143 If this variable is non-nil, it specifies the initial execution mode
144 for Edebug when it is first activated. Possible values are step, next,
145 go, Go-nonstop, trace, Trace-fast, continue, and Continue-fast."
153 "Non-nil means display a trace of function entry and exit.
154 Tracing output is displayed in a buffer named `*edebug-trace*', one
155 function entry or exit per line, indented by the recursion level.
157 You can customize by replacing functions `edebug-print-trace-before'
158 and `edebug-print-trace-after'."
163 "If non-nil, Edebug tests coverage of all expressions debugged.
164 This is done by comparing the result of each expression with the
165 previous result. Coverage is considered OK if two different
166 results are found.
168 Use `edebug-display-freq-count' to display the frequency count and
169 coverage information for a definition."
174 "If non-nil, continue defining or executing any keyboard macro.
175 Use this with caution since it is not debugged."
181 "If non-nil, default value of `print-length' for printing results in Edebug."
185 "If non-nil, default value of `print-level' for printing results in Edebug."
189 "If non-nil, default value of `print-circle' for printing results in Edebug."
194 "Non-nil if Edebug should unwrap results of expressions.
195 That is, Edebug will try to remove its own instrumentation from the result.
196 This is useful when debugging macros where the results of expressions
197 are instrumented expressions. But don't do this when results might be
198 circular or an infinite loop will result."
203 "Value bound to `debug-on-error' while Edebug is active.
205 If `debug-on-error' is non-nil, that value is still used.
207 If the value is a list of signal names, Edebug will stop when any of
208 these errors are signaled from Lisp code whether or not the signal is
209 handled by a `condition-case'. This option is useful for debugging
210 signals that *are* handled since they would otherwise be missed.
211 After execution is resumed, the error is signaled again."
220 "Value bound to `debug-on-quit' while Edebug is active."
225 "If non-nil, an expression to test for at every stop point.
226 If the result is non-nil, then break. Errors are ignored."
228 :risky t
232 "Number of seconds to pause when execution mode is `trace' or `continue'."
237 "Whether or not to pause for `edebug-sit-for-seconds' on reaching a break."
242 ;;; Form spec utilities.
245 ;; Get the spec of symbol resolving all indirection.
253 ;; (edebug-trace "indirection: %s" edebug-form-spec)
255 spec))
257 ;;;###autoload
259 "Return t if SPEC uses only extant spec symbols.
260 An extant spec symbol is a symbol that is not a function and has a
261 `edebug-form-spec' property."
267 t))
271 ;;; Utilities
274 "Return t if OBJECT is a lambda list keyword.
275 A lambda list keyword is a symbol that starts with `&'."
281 ;; Return the last sexp before point in current buffer.
282 ;; Assumes Emacs Lisp syntax is active.
292 "Return a list of windows, in order of `next-window'."
293 ;; This doesn't work for epoch.
298 ;; Not used.
300 "Return t if there are two windows."
306 ;; Return the ALIST sorted with comparison function FUNCTION.
307 ;; This uses 'sort so the sorting is destructive.
312 ;; Not used.
314 "Evaluate BODY while saving the current buffers restriction.
315 BODY may change buffer outside of current restriction, unlike
316 save-restriction. BODY may change the current buffer,
317 and the restriction will be restored to the original buffer,
318 and the current buffer remains current.
319 Return the result of the last expression in BODY."
328 ;;; Display
334 ;; Like pop-to-buffer, but select window where BUFFER was last shown.
335 ;; Select WINDOW if it is provided and still exists. Otherwise,
336 ;; if buffer is currently shown in several windows, choose one.
337 ;; Otherwise, find a new window, possibly splitting one.
338 ;; FIXME: We should probably just be using `pop-to-buffer'.
343 window)
345 ;; Selected window already displays BUFFER.
349 ;; When there's one window only, split it.
356 ;; Found a non-dedicated window not showing
357 ;; `edebug-trace-buffer', use it.
359 ;; All windows are dedicated or show `edebug-trace-buffer', split
360 ;; selected one.
367 ;; Return a list of buffer point pairs, for all displayed buffers.
373 list))))
374 list))
378 ;; Restore the buffer-points created by edebug-get-displayed-buffer-points.
384 buffer-points)))
387 ;; Get either a full window configuration or some window information.
396 which-windows)
400 ;; Set either a full window configuration or some window information.
413 one-window-info))))
414 window-info)
417 ;;; Redefine read and eval functions
418 ;; read is redefined to maybe instrument forms.
419 ;; eval-defun is redefined to check edebug-all-forms and edebug-all-defs.
422 "Read one Lisp expression as text from STREAM, return as Lisp object.
423 If STREAM is nil, use the value of `standard-input' (which see).
424 STREAM or the value of `standard-input' may be:
425 a buffer (read from point and advance it)
426 a marker (read from where it points and advance it)
427 a function (call it with no arguments for each character,
428 call it with a char as argument to push a char back)
429 a string (takes text from string, starting at the beginning)
430 t (read text line using minibuffer and use it).
432 This version, from Edebug, maybe instruments the expression. But the
433 STREAM must be the current buffer to do so. Whether it instruments is
434 also dependent on the values of the option `edebug-all-defs' and
435 the option `edebug-all-forms'."
443 ;; We should somehow arrange to be able to do this
444 ;; without actually replacing the eval-defun command.
446 "Evaluate the top-level form containing point, or after point.
448 If the current defun is actually a call to `defvar', then reset the
449 variable using its initial value expression even if the variable
450 already has some other value. (Normally `defvar' does not change the
451 variable's value if it already has a value.) Treat `defcustom'
452 similarly. Reinitialize the face according to `defface' specification.
454 With a prefix argument, instrument the code for Edebug.
456 Setting option `edebug-all-defs' to a non-nil value reverses the meaning
457 of the prefix argument. Code is then instrumented when this function is
458 invoked without a prefix argument.
460 If acting on a `defun' for FUNCTION, and the function was instrumented,
461 `Edebug: FUNCTION' is printed in the minibuffer. If not instrumented,
462 just FUNCTION is printed.
464 If not acting on a `defun', the result of evaluation is displayed in
465 the minibuffer."
473 ;; This should be consistent with `eval-defun-1', but not the
474 ;; same, since that gets a macroexpanded form.
477 ;; Force variable to be bound.
481 ;; Force variable to be bound.
482 ;; FIXME: Shouldn't this use the :setter or :initializer?
485 ;; Reset the face.
490 ;; See comments in `eval-defun-1' for purpose of code below
503 edebug-result)))
506 ;;;###autoload
509 ;;;###autoload
511 "Evaluate the top level form point is in, stepping through with Edebug.
512 This is like `eval-defun' except that it steps the code for Edebug
513 before evaluating it. It displays the value in the echo area
514 using `eval-expression' (which see).
516 If you do this on a function definition such as a defun or defmacro,
517 it defines the function and instruments its definition for Edebug,
518 so it will do Edebug stepping when called later. It displays
519 `Edebug: FUNCTION' in the echo area to indicate that FUNCTION is now
520 instrumented for Edebug.
522 If the current defun is actually a call to `defvar' or `defcustom',
523 evaluating it this way resets the variable using its initial value
524 expression even if the variable already has some other value.
525 \(Normally `defvar' and `defcustom' do not alter the value if there
526 already is one.)"
529 ;; Bind edebug-all-forms only while reading, not while evalling
530 ;; but this causes problems while edebugging edebug.
543 ;; Recover point, but only if no error occurred.
547 ;; Compatibility with old versions.
550 ;;;###autoload
552 "Toggle edebugging of all definitions."
559 ;;;###autoload
561 "Toggle edebugging of all forms."
578 ;;; Edebug internal data
580 ;; The internal data that is needed for edebugging is kept in the
581 ;; buffer-local variable `edebug-form-data'.
584 "A list of entries associating symbols with buffer regions.
585 Each entry is an `edebug--form-data' struct with fields:
586 SYMBOL, BEGIN-MARKER, and END-MARKER. The markers
587 are at the beginning and end of an entry level form and SYMBOL is
588 a symbol that holds all edebug related information for the form on its
589 property list.
591 In the future (haha!), the symbol will be irrelevant and edebug data will
592 be stored in the definitions themselves rather than in the property
596 ;; Some callers expect accessors to return nil when passed nil.
600 name begin end)
608 ;; Find the edebug form data entry which is closest to PNT.
609 ;; If END-POINT is supplied, match must be exact.
610 ;; Return nil if none found.
612 closest-entry
625 closest-entry entry))))
626 closest-entry))
628 ;; Also need to find all contained entries,
629 ;; and find an entry given a symbol, which should be just assq.
632 "Return the edebug data symbol of the form where point is in.
633 If point is not inside a edebuggable form, cause error."
638 ;; Make NEW-ENTRY the first element in the `edebug-form-data' list.
643 "If non-nil, clear ENTRY out of the form data.
644 Maybe clear the markers and delete the symbol's edebug property?"
647 ;; Instead of this, we could just find all contained forms.
648 ;; (put (car entry) 'edebug nil) ;
649 ;; (mapcar 'edebug-clear-form-data-entry ; dangerous
650 ;; (get (car entry) 'edebug-dependents))
651 ;; (set-marker (nth 1 entry) nil)
652 ;; (set-marker (nth 2 entry) nil)
655 ;;; Parser utilities
658 ;; Signal an invalid-read-syntax with ARGS.
663 ;; Lookup table for significant characters indicating the class of the
664 ;; token that follows. This is not a \"real\" syntax table.
681 ;; We treat numbers as symbols, because of confusion with -, -1, and 1-.
682 ;; We don't care about any other chars since they won't be seen.
683 table))
686 ;; Move to the next token and return its class. We only care about
687 ;; lparen, rparen, dot, quote, backquote, comma, string, char, vector,
688 ;; or symbol.
697 'symbol
702 ;; Leave point before the next token, skipping white space and comments.
709 ;; Mostly obsolete reader; still used in one case.
712 ;; Read one sexp from the current buffer starting at point.
713 ;; Leave point immediately after it. A sexp can be a list or atom.
714 ;; An atom is a symbol (or number), character, string, or vector.
715 ;; This works for reading anything legitimate, but it
716 ;; is gummed up by parser inconsistencies (bugs?)
719 ;; read goes one too far if a (possibly quoted) string or symbol
720 ;; is immediately followed by non-whitespace.
732 ;;; Offsets for reader
734 ;; Define a structure to represent offset positions of expressions.
735 ;; Each offset structure looks like: (before . after) for constituents,
736 ;; or for structures that have elements: (before <subexpressions> . after)
737 ;; where the <subexpressions> are the offset structures for subexpressions
738 ;; including the head of a list.
741 ;; Stack of offset structures in reverse order of the nesting.
742 ;; This is used to get back to previous levels.
746 ;; We must store whether we just read a list with a dotted form that
747 ;; is itself a list. This structure will be condensed, so the offsets
748 ;; must also be condensed.
752 ;; Reinitialize offset recording.
756 ;; Add a new offset pair with POINT as the before offset.
761 ;; Otherwise, we are at the top level, so initialize.
763 edebug-offsets-stack nil
764 edebug-read-dotted-list nil))
765 ;; Cons the new offset to the front of the stack.
767 edebug-current-offset new-offset)
768 ))
771 ;; Finalize the current offset struct by reversing it and
772 ;; store POINT as the after offset.
774 ;; Just reverse the offsets of all subexpressions.
777 ;; We just read a list after a dot, which will be abbreviated out.
779 ;; Drop the corresponding offset pair.
780 ;; That is, nconc the reverse of the rest of the offsets
781 ;; with the cdr of last offset.
786 ;; Now append the point using nconc.
788 ;; Pop the stack.
793 ;; Ignore the last created offset pair.
805 ;;; Reader for Emacs Lisp.
807 ;; Uses edebug-next-token-class (and edebug-skip-whitespace) above.
818 ))
825 ;; anything else, just read it.
827 stream))))
833 ;; Turn 'thing into (quote thing)
840 ;; Turn `thing into (\` thing)
847 ;; Turn ,thing into (\, thing). Handle ,@ and ,. also.
857 ;; Generate the same structure of offsets we would have
858 ;; if the resulting list appeared verbatim in the input text.
864 ;; Turn #'thing into (function thing)
892 ))
893 elements)
895 ))
905 ))
907 ;;; Cursors for traversal of list and vector elements with offsets.
912 ;; Return a new cursor for EXPRESSIONS with OFFSETS.
918 ;; Set the CURSOR's EXPRESSIONS and OFFSETS to the given.
919 ;; Return the cursor.
922 cursor)
925 ;; Copy the cursor using the same object and offsets.
934 ;; Return non-nil if CURSOR is empty - meaning no more elements.
938 ;; Return the top element at the cursor.
939 ;; Assumes not empty.
943 ;; Check if a dotted form is required.
945 ;; Check if there is at least one more argument.
947 ;; Return that top element.
951 ;; Return the top offset pair corresponding to the top element.
955 ;; Advance and return the cursor to the next element and offset.
956 ;; throw no-match if empty before moving.
957 ;; This is a violation of the cursor encapsulation, but
958 ;; there is plenty of that going on while matching.
959 ;; The following test should always fail.
964 cursor)
968 ;; Return the before offset of the cursor.
969 ;; If there is nothing left in the offsets,
970 ;; return one less than the offset itself,
971 ;; which is the after offset for a list.
978 ;; Return the after offset of the cursor object.
982 offset))
984 ;;; The Parser
986 ;; The top level function for parsing forms is
987 ;; edebug-read-and-maybe-wrap-form; it calls all the rest. It checks the
988 ;; syntax a bit and leaves point at any error it finds, but otherwise
989 ;; should appear to work like eval-defun.
991 ;; The basic plan is to surround each expression with a call to
992 ;; the edebug debugger together with indexes into a table of positions of
993 ;; all expressions. Thus an expression "exp" becomes:
995 ;; (edebug-after (edebug-before 1) 2 exp)
997 ;; When this is evaluated, first point is moved to the beginning of
998 ;; exp at offset 1 of the current function. The expression is
999 ;; evaluated, which may cause more edebug calls, and then point is
1000 ;; moved to offset 2 after the end of exp.
1002 ;; The highest level expressions of the function are wrapped in a call to
1003 ;; edebug-enter, which supplies the function name and the actual
1004 ;; arguments to the function. See functions edebug-enter, edebug-before,
1005 ;; and edebug-after for more details.
1007 ;; Dynamically bound vars, left unbound, but globally declared.
1008 ;; This is to quiet the byte compiler.
1010 ;; Window data of the highest definition being wrapped.
1011 ;; This data is shared by all embedded definitions.
1026 ;; Read a form and wrap it with edebug calls, if the conditions are right.
1027 ;; Here we just catch any no-match not caught below and signal an error.
1029 ;; Run the setup hook.
1030 ;; If it gets an error, make it nil.
1037 edebug-top-window-data
1038 edebug-def-name;; make sure it is locally nil
1039 ;; I don't like these here!!
1040 edebug-&optional
1041 edebug-&rest
1042 edebug-gate
1043 edebug-best-error
1044 edebug-error-point
1045 ;; Do this once here instead of several times.
1051 nil)))
1054 result))
1059 def-kind
1060 defining-form-p
1061 def-name
1062 ;; These offset things don't belong here, but to support recursive
1063 ;; calls to edebug-read, they need to be here.
1064 edebug-offsets
1065 edebug-offsets-stack
1066 edebug-current-offset ; reset to nil
1067 )
1071 ;; Find out if this is a defining form from first symbol
1076 ;; This is incorrect in general!! But OK most of the time.
1081 ;;;(message "all defs: %s all forms: %s" edebug-all-defs edebug-all-forms)
1085 ;; If it is a defining form and we are edebugging defs,
1086 ;; then let edebug-list-form start it.
1092 cursor
1097 ;; Not edebugging this form, so reset the symbol's edebug
1098 ;; property to be just a marker at the definition's source code.
1099 ;; This only works for defs with simple names.
1101 ;; Also nil out dependent defs.
1108 ;; If all forms are being edebugged, explicitly wrap it.
1114 cursor
1117 nil)))
1119 ;; Not a defining form, and not edebugging.
1121 ))
1127 ;; Currently def-form sets this to nil; def-body sets it to t.
1130 ;; Return a unique symbol for the variable used to store the
1131 ;; status of interactive-p for this function.
1136 "Wrap the FORMS of a definition body."
1145 ;; Generate the enter wrapper for some forms of a definition.
1146 ;; This is not to be used for the body of other forms, e.g. `while',
1147 ;; since it wraps the list of forms with a call to `edebug-enter'.
1148 ;; Uses the dynamically bound vars edebug-def-name and edebug-def-args.
1149 ;; Do this after parsing since that may find a name.
1156 ;; Doesn't work with more than one def-body!!
1157 ;; But the list will just be reversed.
1161 ))
1170 ;; Modifies edebug-offset-index and edebug-offset-list
1171 ;; accesses edebug-func-marc and buffer point.
1173 edebug-offset-index
1175 edebug-offset-list)
1180 ;; Return the edebug form for the current function at offset BEFORE-INDEX
1181 ;; given FORM. Looks like:
1182 ;; (edebug-after (edebug-before BEFORE-INDEX) AFTER-INDEX FORM)
1183 ;; Also increment the offset index for subsequent use.
1187 ;; Like edebug-make-before-and-after-form, but only after.
1192 "Return the unwrapped SEXP or return it as is if it is not wrapped.
1193 The SEXP might be the result of wrapping a body, which is a list of
1194 expressions; a `progn' form will be returned enclosing these forms."
1202 )
1203 sexp))
1206 "Return the SEXP recursively unwrapped."
1213 new-sexp)))
1217 ;; Process the defining form, starting outside the form.
1218 ;; The speclist is a generated list spec that looks like:
1219 ;; (("def-symbol" defining-form-spec-sans-&define))
1220 ;; Skip the first offset.
1224 cursor
1226 speclist))
1230 ;; Wrap a form, usually a defining form, but any evaluated one.
1231 ;; If speclist is non-nil, this is being called by edebug-defining-form.
1232 ;; Otherwise it is being called from edebug-read-and-maybe-wrap-form1.
1233 ;; This is a hack, but I haven't figured out a simpler way yet.
1235 ;; Set this marker before parsing.
1239 ;; Buffer must be current-buffer for this to work:
1244 result
1245 ;; For definitions.
1246 ;; (edebug-containing-def-name edebug-def-name)
1247 ;; Get name from form-data, if any.
1249 edebug-def-name
1250 edebug-def-args
1251 edebug-def-interactive
1252 edebug-inside-func;; whether wrapped code executes inside a function.
1253 )
1259 ;; else wrap as an enter-form.
1262 ;; Set the name here if it was not set by edebug-make-enter-wrapper.
1266 ;; Add this def as a dependent of containing def. Buggy.
1274 ;; Create a form-data-entry or modify existing entry's markers.
1275 ;; In the latter case, pointers to the entry remain eq.
1279 edebug-def-name
1280 edebug-form-begin-marker
1281 ;; Buffer must be current-buffer.
1283 ))
1285 form-data-entry edebug-def-name ;; in case name is changed
1286 form-begin form-end))
1288 ;; (message "defining: %s" edebug-def-name) (sit-for 2)
1291 ;;(debug edebug-def-name)
1293 ;; Destructively reverse edebug-offset-list and make vector from it.
1296 ;; Side effects on the property list of edebug-def-name.
1300 ;; Set up the initial window data.
1308 ;; Store the edebug data in symbol's property list.
1310 ;; A struct or vector would be better here!!
1312 nil ; clear breakpoints
1313 edebug-offset-list
1314 edebug-top-window-data
1315 ))
1316 result
1317 )))
1321 ;; Create initial frequency count vector.
1322 ;; For each stop point, the counter is incremented each time it is visited.
1328 ;; Create initial coverage vector.
1329 ;; Only need one per expression, but it is simpler to use stop points.
1335 ;; Return the instrumented form for the following form.
1336 ;; Add the point offsets to the edebug-offset-list for the form.
1342 ;; The first offset for a list form is for the list form itself.
1344 form
1348 ;; Find out if this is a defining form from first symbol.
1349 ;; An indirect spec would not work here, yet.
1352 new-cursor
1356 ;; Wrap a regular form.
1360 ;; After processing the list form, the new-cursor is left
1361 ;; with the offset after the form.
1363 )))
1367 ;; Check for constant symbols that don't get wrapped.
1370 form)
1375 ;; Anything else is self-evaluating.
1384 ;; Process the arguments of a list form given that head of form is a symbol.
1385 ;; Helper for edebug-list-form
1391 ;; It is a speclist.
1398 ; but leave it in for compatibility.
1399 ))
1400 ;; No edebug-form-spec provided.
1410 ;; Return an instrumented form built from the list form.
1411 ;; The after offset will be left in the cursor after processing the form.
1413 ;; Prevent backtracking whenever instrumenting.
1415 ;; A list form is never optional because it matches anything.
1418 ;; Skip the first offset.
1426 ;; Special case: replace (interactive-p) with variable
1436 ;; The head of a form should normally be a symbol or a lambda
1437 ;; expression but it can also be an unquote form to be filled
1438 ;; before evaluation. We evaluate the arguments anyway, on the
1439 ;; assumption that the unquote form will place a proper function
1440 ;; name (rather than a macro name).
1442 ;; Process anonymous function and args.
1443 ;; This assumes no anonymous macros.
1448 ))
1450 ;;; Matching of specs.
1458 ;;; Failure to match
1460 ;; This throws to no-match, if there are higher alternatives.
1461 ;; Otherwise it signals an error. The place of the error is found
1462 ;; with the two before- and after-offset functions.
1465 ;; Throw a no-match, or signal an error immediately if gate is active.
1466 ;; Remember this point in case we need to report this error.
1479 ;; Top level spec matching function.
1480 ;; Used also at each lower level of specs.
1482 edebug-&rest
1483 edebug-best-error
1484 edebug-error-point
1486 )
1491 ;; Match one spec, which is not a keyword &-spec.
1497 ))
1501 ;; Append results of matching the list of specs.
1502 ;; The first spec is handled and the remainder-handler handles the rest.
1510 ;; Is the spec dotted?
1515 ;; Is the form dotted?
1519 ;; Cancel dotted spec and dotted form.
1523 ;; Wrap the form in a list, (by changing the cursor??)...
1525 ;; and process normally, then unwrap the result.
1532 ;;(message "spec = %s first char = %s" spec first-char) (sit-for 1)
1546 ;; Define specs for all the symbol specs with functions used to process them.
1547 ;; Perhaps we shouldn't be doing this with edebug-form-specs since the
1548 ;; user may want to define macros or functions with the same names.
1549 ;; We could use an internal obarray for these primitive specs.
1563 ;; Less frequently used:
1564 ;; (function . edebug-match-function)
1570 ;; (nil . edebug-match-nil) not this one - special case it.
1571 ))
1575 ;; Match a symbol spec.
1580 ;; It is an indirect spec.
1582 ;; Otherwise it should be the symbol name of a function.
1583 ;; There could be a bug here - maybe need to do edebug-match bindings.
1591 ;; Special case for edebug-`.
1599 )))
1610 ;; Currently identical to edebug-match-form.
1611 ;; This is for common lisp setf-style place arguments.
1616 ;; Keep matching until one spec fails.
1628 ;; Returning nil means no no-match was thrown.
1629 nil))
1630 result
1631 ;; no-match, but don't fail; just reset cursor and return nil.
1633 nil)))
1638 ;; Reuse the &optional handler with this as the remainder handler.
1642 ;; Repeatedly use specs until failure.
1644 edebug-best-error
1645 edebug-error-point)
1650 ;; Keep matching until one spec succeeds, and return its results.
1651 ;; If none match, fail.
1652 ;; This needs to be optimized since most specs spend time here.
1661 edebug-best-error
1662 edebug-error-point)
1663 ;; Doesn't support e.g. &or symbolp &rest form
1665 ;; Match failed, so reset and try again.
1667 ;; Reset the cursor for the next match.
1669 ;; All failed.
1671 ))
1675 ;; If any specs match, then fail
1680 nil))
1681 ;; This means something matched, so it is a no match.
1683 ;; This means nothing matched, so it is OK.
1690 ;; Following specs must look like (<name> <spec>) ...
1691 ;; where <name> is the name of a keyword, and spec is its spec.
1692 ;; This really doesn't save much over the expanded form and takes time.
1694 cursor
1699 specs))))
1703 ;; Simply set the gate to prevent backtracking at this level.
1705 nil)
1709 ;; The spec is a list, but what kind of list, and what context?
1711 ;; After dotted spec but form did not contain dot,
1712 ;; so match list spec elements as if spliced in.
1716 ;; If it matched, really clear the dotted-spec flag.
1725 ;; Special case: spec quotes a symbol to match.
1726 ;; Change in future. Use "..." instead.
1731 form)
1737 ;; Special case: match a vector with the specs.
1749 ;; First offset is for the list form itself.
1750 ;; Treat nil as empty list.
1752 specs))
1756 )))
1760 ;; Match a sublist of specs.
1762 ;;edebug-best-error
1763 ;;edebug-error-point
1764 )
1766 ;; match with edebug-match-specs so edebug-best-error is not bound.
1771 ;; A failed &rest or &optional spec may leave some args.
1773 )))))
1780 ;; Since it matched, failure means immediate error, unless &optional.
1784 )))
1787 ;; There must be nothing left to match a nil.
1790 nil))
1797 ;; Match a defining form.
1798 ;; Normally, &define is interpreted specially other places.
1799 ;; This should only be called inside of a spec list to match the remainder
1800 ;; of the current list. e.g. ("lambda" &define args def-body)
1802 cursor
1804 ;; Find the last offset in the list.
1807 offsets)
1808 specs))
1811 ;; The expression must be a function.
1812 ;; This will match any list form that begins with a symbol
1813 ;; that has an edebug-form-spec beginning with &define. In
1814 ;; practice, only lambda expressions should be used.
1815 ;; I could add a &lambda specification to avoid confusion.
1822 ;; Find out if this is a defining form from first symbol.
1833 )))
1837 ;; Set the edebug-def-name bound in edebug-defining-form.
1839 ;; Maybe strings and numbers could be used.
1844 ;; Construct a new name by appending to previous name.
1846 name))
1851 ;; Set the edebug-def-name to the spec.
1854 ;; Construct a new name by appending to previous name.
1856 spec))
1857 nil)
1860 ;; set the def-args bound in edebug-defining-form
1870 ;; Like form but the form is wrapped in edebug-enter form.
1871 ;; The form is assumed to be executing outside of the function context.
1872 ;; This is a hack for now, since a def-form might execute inside as well.
1873 ;; Not to be used otherwise.
1878 ;; Like body but body is wrapped in edebug-enter form.
1879 ;; The body is assumed to be executing inside of the function context.
1880 ;; Not to be used otherwise.
1883 ;; If there's no form, there's nothing to wrap!
1884 ;; This happens to handle bug#20281, tho maybe a better fix would be to
1885 ;; improve the `defun' spec.
1890 ;;;; Edebug Form Specs
1891 ;;; ==========================================================
1893 ;;;;* Spec for def-edebug-spec
1894 ;;; Out of date.
1897 "Return non-nil if OBJECT is a symbol with an edebug-form-spec property."
1902 ;; Top level is different from lower levels.
1907 ;; A list must have something in it, or it is nil, a symbolp
1911 (&or
1915 edebug-spec-list
1916 stringp
1919 edebug-spec-p ;; Including all the special ones e.g. form.
1920 symbolp;; a predicate
1921 ))
1924 ;;;* Emacs special forms and some functions.
1926 ;; quote expects only one argument, although it allows any number.
1929 ;; The standard defining forms.
1934 (&define name lambda-list
1938 def-body))
1940 ;; FIXME: Improve `declare' so we can Edebug gv-expander and
1941 ;; gv-setter declarations.
1951 )))
1956 ;; A function-form is for an argument that may be a function or a form.
1957 ;; This specially recognizes anonymous functions quoted with quote.
1959 ;; form at the end could also handle "function",
1960 ;; but recognize it specially to avoid wrapping function forms.
1963 ;; function expects a symbol or a lambda or macro expression
1964 ;; A macro is allowed by Emacs.
1967 ;; A macro expression is a lambda expression with "macro" prepended.
1970 ;; (def-edebug-spec anonymous-form ((&or ["lambda" lambda] ["macro" macro])))
1972 ;; Standard functions that take function-forms arguments.
1974 ;; FIXME? The manual uses this form (maybe that's just for illustration?):
1975 ;; (def-edebug-spec let
1976 ;; ((&rest &or symbolp (gate symbolp &optional form))
1977 ;; body))
1980 body))
1991 form
1997 ;; Supports quotes inside backquotes,
1998 ;; but only at the top level inside unquotes.
2000 (&or
2002 ;; The simple version:
2003 ;; (backquote-form &rest backquote-form)
2004 ;; doesn't handle (a . ,b). The straightforward fix:
2005 ;; (backquote-form . [&or nil backquote-form])
2006 ;; uses up too much stack space.
2007 ;; Note that `(foo . ,@bar) is not valid, so we don't need to handle it.
2010 ;; If you use dotted forms in backquotes, replace the previous line
2011 ;; with the following. This takes quite a bit more stack space, however.
2012 ;; (backquote-form . [&or nil backquote-form])
2014 sexp))
2016 ;; Special version of backquote that instruments backquoted forms
2017 ;; destined to be evaluated, usually as the result of a
2018 ;; macroexpansion. Backquoted code can only have unquotes (, and ,@)
2019 ;; in places where list forms are allowed, and predicates. If the
2020 ;; backquote is used in a macro, unquoted code that come from
2021 ;; arguments must be instrumented, if at all, with def-form not def-body.
2023 ;; We could assume that all forms (not nested in other forms)
2024 ;; in arguments of macros should be def-forms, whether or not the macros
2025 ;; are defined with edebug-` but this would be expensive.
2027 ;; ,@ might have some problems.
2032 ;; Assume immediate quote in unquotes mean backquote at next higher level.
2037 ;; New byte compiler.
2042 ;; Anything else?
2044 ;;; The debugger itself
2049 ;; Stack of active functions evaluated via edebug.
2050 ;; Should be nil at the top level.
2053 ;; Index of last edebug-stack item.
2056 ;; Stack of offset indices of visited edebug sexps.
2057 ;; Should be nil at the top level.
2058 ;; Each function adds one cons. Top is modified with setcar.
2062 ;; Non-nil if edebug has already been entered at this recursive edit level.
2063 ;; This should stay nil at the top level.
2064 )
2066 ;; Should these be options?
2068 ;; Name of function to use for debugging when error or quit occurs.
2069 ;; Set this to 'debug if you want to debug edebug.
2070 )
2073 ;; Dynamically bound variables, declared globally but left unbound.
2088 ;;; Handling signals
2091 "Signal an error. Args are SIGNAL-NAME, and associated DATA.
2092 A signal name is a symbol with an `error-conditions' property
2093 that is a list of condition names.
2094 A handler for any of those names will get to handle this signal.
2095 The symbol `error' should always be one of them.
2097 DATA should be a list. Its elements are printed as part of the error message.
2098 If the signal is handled, DATA is made available to the handler.
2099 See `condition-case'.
2101 This is the Edebug replacement for the standard `signal'. It should
2102 only be active while Edebug is. It checks `debug-on-error' to see
2103 whether it should call the debugger. When execution is resumed, the
2104 error is signaled again."
2107 ;; If we reach here without another non-local exit, then send signal again.
2108 ;; i.e. the signal is not continuable, yet.
2109 ;; Avoid infinite recursion.
2113 ;;; Entering Edebug
2116 ;; Entering FUNC. The arguments are ARGS, and the body is BODY.
2117 ;; Setup edebug variables and evaluate BODY. This function is called
2118 ;; when a function evaluated with edebug-eval-top-level-form is entered.
2119 ;; Return the result of BODY.
2121 ;; Is this the first time we are entering edebug since
2122 ;; lower-level recursive-edit command?
2123 ;; More precisely, this tests whether Edebug is currently active.
2127 ;; Binding max-lisp-eval-depth here is OK,
2128 ;; but not inside an unwind-protect.
2129 ;; Doing it here also keeps it from growing too large.
2136 ;; Binding these may not be the right thing to do.
2137 ;; We want to allow the global values to be changed.
2143 edebug-initial-mode
2144 edebug-execution-mode)
2145 edebug-next-execution-mode nil)
2156 )
2165 ))))
2168 "Return a cons cell describing the status of VAR's current binding.
2169 The purpose of this function is so you can properly undo
2170 subsequent changes to the same binding, by passing the status
2171 cons cell to `edebug-restore-status'. The status cons cell
2172 has the form (LOCUS . VALUE), where LOCUS can be a buffer
2173 \(for a buffer-local binding), a frame (for a frame-local binding),
2174 or nil (if the default binding is current)."
2179 "Reset VAR based on STATUS.
2180 STATUS should be a list returned by `edebug-var-status'."
2194 edebug-result)
2204 "Print MSG in *edebug-trace* before and after evaluating BODY.
2205 The result of BODY is also printed."
2207 edebug-result)
2214 "Function called to print trace info before expression evaluation.
2215 MSG is printed after `::::{ '."
2220 "Function called to print trace info after expression evaluation.
2221 MSG is printed after `::::} '."
2229 ;; Debug current function given BEFORE position.
2230 ;; Called from functions compiled with edebug-eval-top-level-form.
2231 ;; Return the before index.
2234 ;; Increment frequency count
2241 before-index)
2244 ;; Do nothing.
2245 )
2249 value
2250 ;; Debug current function given AFTER position and VALUE.
2251 ;; Called from functions compiled with edebug-eval-top-level-form.
2252 ;; Return VALUE.
2255 ;; Increment frequency count
2262 ;; Just return result.
2263 value
2265 )))
2268 ;; Do nothing but return the value.
2269 value)
2275 ;; This is not used, yet.
2289 ;; Test if a different result.
2294 ;; Dynamically declared unbound variables.
2307 ;; Don't really try to enter edebug within an eval from redisplay.
2308 value
2309 ;; Check breakpoints and pending input.
2310 ;; If edebug display should be updated, call edebug--display.
2311 ;; Return value.
2324 ;;(edebug-trace "exp: %s" value)
2325 ;; Test whether we should break.
2334 ;; Delete the breakpoint.
2339 ;; Display if mode is not go, continue, or Continue-fast
2340 ;; or break, or input is pending,
2342 edebug-break
2346 value)))
2349 ;; window-start now stored with each function.
2350 ;;(defvar edebug-window-start nil)
2351 ;; Remember where each buffers' window starts between edebug calls.
2352 ;; This is to avoid spurious recentering.
2353 ;; Does this still need to be buffer-local??
2354 ;;(setq-default edebug-window-start nil)
2355 ;;(make-variable-buffer-local 'edebug-window-start)
2358 ;; Dynamically declared unbound vars
2372 ;; Emacs 19 adds an arg to mark and mark-marker.
2376 ;; edebug--display-1 is too big, we should split it. This function
2377 ;; here was just introduced to avoid making edebug--display-1
2378 ;; yet a bit deeper.
2383 ;; The buffer holding the source has been killed.
2384 ;; Let's at least show a backtrace so the user can figure out
2385 ;; which function we're talking about.
2387 ;; Setup windows for edebug, determine mode, maybe enter recursive-edit.
2388 ;; Uses local variables of edebug-enter, edebug-before, edebug-after
2389 ;; and edebug-debugger.
2392 edebug-stop ; Should we enter recursive-edit?
2395 edebug-buffer-outside-point ; current point in edebug-buffer
2396 ;; window displaying edebug-buffer
2402 edebug-outside-windows ; Window or screen configuration.
2403 edebug-buffer-points
2405 edebug-eval-buffer ; Declared here so we can kill it below.
2408 edebug-trace-window
2409 edebug-trace-window-start
2416 ;; any others??
2417 )
2423 ;; Compute result string now before windows are modified.
2427 ;; Save windows now before we modify them.
2434 ;; First move the edebug buffer point to edebug-point
2435 ;; so that window start doesn't get changed when we display it.
2436 ;; I don't know if this is going to help.
2437 ;;(set-buffer edebug-buffer)
2438 ;;(goto-char edebug-point)
2440 ;; If edebug-buffer is not currently displayed,
2441 ;; first find a window for it.
2445 ;; Now display eval list, if any.
2446 ;; This is done after the pop to edebug-buffer
2447 ;; so that buffer-window correspondence is correct after quitting.
2449 ;; The evaluation list better not have deleted edebug-window-data.
2457 ;; Check whether positions are up-to-date.
2458 ;; This assumes point is never before symbol.
2461 edebug-function)
2462 ))
2464 ;; Make sure we bind those in the right buffer (bug#16410).
2467 ;; Now display arrow based on mode.
2472 ;; Display error message
2483 edebug-global-break-condition
2484 edebug-global-break-result))
2487 edebug-break-condition
2488 edebug-break-result))
2497 ;; Display result of previous evaluation.
2499 edebug-sit-on-break
2511 ;; not edebug-break
2530 ;; Reset the edebug-window-data to whatever it is now.
2534 ;; Remember window-start for edebug-buffer, if still displayed.
2540 ;; Save trace window point before restoring outside windows.
2541 ;; Could generalize this for other buffers.
2549 ;; Restore windows before continuing.
2554 ;; Restore displayed buffer points.
2555 ;; Needed even if restoring windows because
2556 ;; window-points are not restored. (should they be??)
2560 ;; Unrestore trace window's window-point.
2563 edebug-trace-window-start))
2565 ;; Unrestore edebug-buffer's window-start, if displayed.
2572 ;; Unrestore edebug-buffer's window-point.
2573 ;; Needed in addition to setting the buffer point
2574 ;; - otherwise quitting doesn't leave point as is.
2575 ;; But can this causes point to not be restored.
2576 ;; Also, it may not be a visible window.
2577 ;; (set-window-point window edebug-point)
2578 )))
2580 ;; Unrestore edebug-buffer's point. Rerestored below.
2581 ;; (goto-char edebug-point) ;; in edebug-buffer
2582 )
2583 ;; Since we may be in a save-excursion, in case of quit,
2584 ;; reselect the outside window only.
2585 ;; Only needed if we are not recovering windows??
2590 ;; Restore current buffer always, in case application needs it.
2593 ;; Restore point, and mark.
2594 ;; Needed even if restoring windows because
2595 ;; that doesn't restore point and mark in the current buffer.
2596 ;; But don't restore point if edebug-buffer is current buffer.
2600 ;; Does zmacs-regions need to be nil while doing set-marker?
2603 ;; None of the following is done if quit or signal occurs.
2605 ;; Restore edebug-buffer's outside point.
2606 ;; (edebug-trace "restore edebug-buffer point: %s"
2607 ;; edebug-buffer-outside-point)
2610 ;; ... nothing more.
2611 )
2612 ;; Could be an option to keep eval display up.
2615 ;; Reset global variables to outside values in case they were changed.
2617 )))
2621 ;; Number of recursive edits started by edebug.
2622 ;; Should be 0 at the top level.
2625 ;; Value of recursion-depth when edebug was called.
2627 ;; Dynamically declared unbound vars
2634 ;; Start up a recursive edit inside of edebug.
2635 ;; The current buffer is the edebug-buffer, which is put into edebug-mode.
2636 ;; Assume that none of the variables below are buffer-local.
2642 ;;(edebug-number-of-recursions (1+ edebug-number-of-recursions))
2644 edebug-entered ; bind locally to nil
2646 edebug-backtrace-buffer ; each recursive edit gets its own
2647 ;; The window configuration may be saved and restored
2648 ;; during a recursive-edit
2649 edebug-inside-windows
2650 )
2654 ;; Declare global values local but using the same global value.
2655 ;; We could set these to the values for previous edebug call.
2660 ;; More for Emacs 19
2670 ;; Don't keep reading from an executing kbd macro
2671 ;; within edebug unless edebug-continue-kbd-macro is
2672 ;; non-nil. Again, local binding may not be best.
2676 ;; Don't get confused by the user's keymap changes.
2680 ;; Bind again to outside values.
2684 ;; Don't keep defining a kbd macro.
2688 ;; others??
2689 )
2701 ;; Do the following, even if quit occurs.
2706 ;; Remember selected-window after recursive-edit.
2707 ;; (setq edebug-inside-window (selected-window))
2711 ;; Recursive edit may have changed buffers,
2712 ;; so set it back before exiting let.
2720 ;; gotta have a buffer to let its buffer local variables be set
2723 )))
2726 ;;; Display related functions
2737 )
2741 ;; Set up the overlay arrow at beginning-of-line in current buffer.
2742 ;; The arrow string is derived from edebug-arrow-alist and
2743 ;; edebug-execution-mode.
2752 "Toggle the saving and restoring of all windows.
2753 Also, each time you toggle it on, the inside and outside window
2754 configurations become the same as the current configuration."
2761 edebug-save-windows))))
2771 edebug-save-windows))
2772 ;; Problem: what about outside windows that are deleted inside?
2776 "Toggle the saving and restoring of the selected window.
2777 Also, each time you toggle it on, the inside and outside window
2778 configurations become the same as the current configuration."
2782 ;; Save all outside windows except the selected one.
2783 ;; Remove (selected-window) from outside-windows.
2790 edebug-outside-windows))
2803 "Toggle the saving and restoring of windows.
2804 With prefix, toggle for just the selected window.
2805 Otherwise, toggle for all windows."
2812 "Show the debug windows and where we stopped in the program."
2816 ;; Restore the window configuration to what it last was inside.
2817 ;; But it is not always set. - experiment
2818 ;;(if edebug-inside-windows
2819 ;; (edebug-set-windows edebug-inside-windows))
2824 "Change to the outside window configuration.
2825 Use `edebug-where' to return."
2838 "Bounce the point in the outside current buffer.
2839 If prefix argument ARG is supplied, sit for that many seconds
2840 before returning. The default is one second."
2845 ;; If the buffer's currently displayed, avoid set-window-configuration.
2857 ;; Joe Wells, here is a start at your idea of adding a buffer to the internal
2858 ;; display list. Still need to use this list in edebug--display.
2864 "Toggle display of a buffer inside of edebug."
2874 ;;; Breakpoint related functions
2877 ;; Return (function . index) of the nearest edebug stop point.
2884 ;; pull out parts of edebug-data.
2886 ;; (edebug-breakpoints (car (cdr edebug-data)))
2891 ;; skip backwards until non-whitespace, or bol
2894 edebug-def-mark))
2895 len i)
2896 ;; the offsets are in order so we can do a linear search
2903 ;; return the relevant info
2906 edebug-def-name)
2907 )))
2911 "Move point to the next breakpoint, or first if none past point."
2919 ;; pull out parts of edebug-data
2923 breakpoint)
2933 ;; goto the first breakpoint
2946 ))))))
2950 "Modify the breakpoint for the form at point or after it.
2951 Set it if FLAG is non-nil, clear it otherwise. Then move to that point.
2952 If CONDITION or TEMPORARY are non-nil, add those attributes to
2953 the breakpoint."
2960 ;; pull out parts of edebug-data
2964 present)
2965 ;; delete it either way
2970 ;; add it to the list and resort
2975 edebug-breakpoints) '<))
2978 edebug-def-name condition)
2986 ))))
2989 "Set the breakpoint of nearest sexp.
2990 With prefix argument, make it a temporary breakpoint."
2995 "Clear the breakpoint of nearest sexp."
3001 "Set `edebug-global-break-condition' to EXPRESSION."
3007 "Global Condition: " initial read-expression-map t
3014 ;;; Mode switching functions
3017 ;; Set the edebug mode to MODE.
3018 ;; Display SHORTMSG, or MSG if not within edebug.
3023 ;; Continue execution
3025 ;; This is not terribly useful!!
3033 "Proceed to next stop point."
3038 "Proceed to next `after' stop point."
3043 "Go, evaluating until break.
3044 With prefix ARG, set temporary break at current point and go."
3051 "Go, evaluating without debugging.
3052 You can use `edebug-stop', or any editing command, to stop."
3059 "Begin trace mode.
3060 Pauses for `edebug-sit-for-seconds' at each stop point."
3065 "Trace with no wait at each step.
3066 Updates the display at each stop point, but does not pause."
3072 "Begin continue mode.
3073 Pauses for `edebug-sit-for-seconds' at each break point."
3079 "Trace with no wait at each step.
3080 Updates the display at each break point, but does not pause."
3085 ;; ------------------------------------------------------------
3086 ;; The following use the mode changing commands and breakpoints.
3090 "Proceed to first stop-point at or after current position of point."
3096 "Stop execution and do not continue.
3097 Useful for exiting from trace or continue loop."
3103 "Proceed to the exit of the next expression to be evaluated."
3111 "Proceed from the current point to the end of the ARGth sexp ahead.
3112 If there are not ARG sexps ahead, then do `edebug-step-out'."
3116 ;; Call forward-sexp repeatedly until done or failure.
3121 )))
3124 "Proceed from the current point to the end of the containing sexp.
3125 If there is no containing sexp that is not the top level defun,
3126 go to the end of the last sexp, or if that is the same point, then step."
3132 ;; Is there still a containing expression?
3136 ;; At top level - 1, so first check if there are more sexps at this level.
3138 ;; (up-list 1)
3143 )))))
3146 ;; Func should be a function symbol.
3147 ;; Return the function symbol, or nil if not instrumented.
3151 ;; It is uninstrumented, so instrument it.
3155 func))
3158 func)
3166 func))))))
3169 "Instrument the definition of the function or macro about to be called.
3170 Do this when stopped before the form or it will be too late.
3171 One side effect of using this command is that the next time the
3172 function or macro is called, Edebug will be called there as well."
3187 "Step into the definition of the function or macro about to be called.
3188 This first does `edebug-instrument-callee' to ensure that it is
3189 instrumented. Then it does `edebug-on-entry' and switches to `go' mode."
3198 "Cause Edebug to stop when FUNCTION is called.
3199 With prefix argument, make this temporary so it is automatically
3200 canceled the first time the function is entered."
3202 ;; Could store this in the edebug data instead.
3211 ;; Also need edebug-cancel-debug-on-entry
3214 "If the function is instrumented for Edebug, call `edebug-on-entry'."
3222 "Set mode to Go-nonstop, and exit to top-level.
3223 This is useful for exiting even if `unwind-protect' code may be executed."
3228 ;;(defun edebug-exit-out ()
3229 ;; "Go until the current function exits."
3230 ;; (interactive)
3231 ;; (edebug-set-mode 'exiting "Exit..."))
3247 "Set the initial execution mode of Edebug.
3248 The mode is requested via the key that would be used to set the mode in
3249 edebug-mode."
3254 "Change initial edebug mode from %s (%c) to (enter key): "
3255 old-mode
3261 edebug-initial-mode-alist))))
3268 ;;; Evaluation of expressions
3271 "Evaluate an expression list in the outside context.
3272 Return the result of the last expression."
3273 ;; Only restores the non-variables context since all the variables let-bound
3274 ;; by Edebug will be properly reset to the appropriate context's value by
3275 ;; backtrace-eval.
3280 ;; After excursion, we will
3281 ;; restore to current window configuration.
3284 ;; Restore outside windows.
3289 ;; Restore outside context.
3292 ;; FIXME: This restoring of edebug-outside-buffer and
3293 ;; edebug-outside-point is redundant now that backtrace-eval does it
3294 ;; for us.
3301 ;; Back to edebug-buffer. Restore rest of inside context.
3302 ;; (use-local-map edebug-inside-map)
3304 ;; Restore inside windows.
3307 ;; Save values that may have been changed.
3311 ;; Restore the outside saved values; don't alter
3312 ;; the outside binding loci.
3319 ;; Evaluate EXPR safely.
3320 ;; If there is an error, a string is returned describing the error.
3327 ;;; Printing
3331 ;; Print an error message like command level does.
3332 ;; This also prints the error name if it has no error-message.
3337 ;; continuing after an error may
3338 ;; complain about edebug-arg. why??
3343 ;; Alternatively, we could change the definition of
3344 ;; edebug-safe-prin1-to-string to only use these if defined.
3364 "Print the previous result."
3368 ;;; Read, Eval and Print
3377 "Evaluate an expression in the outside environment.
3378 If interactive, prompt for the expression.
3379 Print result in minibuffer."
3381 "Eval: " nil read-expression-map t
3390 "Evaluate sexp before point in the outside environment.
3391 Print value in minibuffer."
3396 "Evaluate sexp before point in outside environment; insert value.
3397 This prints the value into current buffer."
3405 ;; princ the string to get rid of quotes.
3408 ))
3410 ;;; Edebug Minor Mode
3413 "If non-nil, inhibit Edebug bindings on the C-x C-a key.
3414 By default, loading the `edebug' library causes these bindings to
3420 ;; Global GUD bindings for all emacs-lisp-mode buffers.
3426 ;; The following isn't a GUD binding.
3431 ;; control
3441 ;;(define-key map "f" 'edebug-forward) not implemented
3449 ;; quitting and stopping
3455 ;; breakpoints
3462 ;; evaluation
3468 ;; views
3475 ;; misc
3481 ;; statistics
3484 ;; GUD bindings
3494 map))
3496 ;; Autoloading these global bindings doesn't make sense because
3497 ;; they cannot be used anyway unless Edebug is already loaded and active.
3513 ;; breakpoints
3519 ;; views
3523 ;; quitting
3528 ;; statistics
3530 map)
3538 "Describe `edebug-mode'."
3545 "Mode for Emacs Lisp buffers while in Edebug.
3547 In addition to all Emacs Lisp commands (except those that modify the
3548 buffer) there are local and global key bindings to several Edebug
3552 Also see bindings for the eval list buffer *edebug* in `edebug-eval-mode'.
3554 The edebug buffer commands:
3557 Global commands prefixed by `global-edebug-prefix':
3560 Options:
3561 `edebug-setup-hook'
3562 `edebug-all-defs'
3563 `edebug-all-forms'
3564 `edebug-save-windows'
3565 `edebug-save-displayed-buffer-points'
3566 `edebug-initial-mode'
3567 `edebug-trace'
3568 `edebug-test-coverage'
3569 `edebug-continue-kbd-macro'
3570 `edebug-print-length'
3571 `edebug-print-level'
3572 `edebug-print-circle'
3573 `edebug-on-error'
3574 `edebug-on-quit'
3575 `edebug-on-signal'
3576 `edebug-unwrap-results'
3577 `edebug-global-break-condition'"
3579 :keymap edebug-mode-map
3580 ;; If the user kills the buffer in which edebug is currently active,
3581 ;; exit to top level, because the edebug command loop can't usefully
3582 ;; continue running in such a case.
3583 ;;
3595 edebug--mode-saved-vars)
3597 ;; Append `edebug-kill-buffer' to the hook to avoid interfering with
3598 ;; other entries that are unguarded against deleted buffer.
3602 "Used on `kill-buffer-hook' when Edebug is operating in a buffer of Lisp code."
3605 ;;; edebug eval list mode
3607 ;; A list of expressions and their evaluations is displayed in *edebug*.
3610 "Return a list of evaluations of `edebug-eval-list'."
3611 ;; Assumes in outside environment.
3612 ;; Don't do any edebug things now.
3618 ;; Assumes edebug-eval-buffer exists.
3629 ))
3636 ;; Should generalize this to be callable outside of edebug
3637 ;; with calls in user functions, e.g. (edebug-eval-display)
3640 "Display expressions and evaluations in EVAL-RESULT-LIST.
3641 It modifies the context by popping up the eval display."
3647 "Redisplay eval list in outside environment.
3648 May only be called from within `edebug--recursive-edit'."
3652 ))
3662 "Replace the evaluation list with the sexps now in the eval buffer."
3665 new-list)
3667 ;; get the first expression
3689 "Delete the item under point and redisplay."
3690 ;; could add arg to do repeatedly
3710 map)
3716 "Mode for evaluation list buffer while in Edebug.
3718 In addition to all Interactive Emacs Lisp commands there are local and
3719 global key bindings to several Edebug specific commands. E.g.
3723 Eval list buffer commands:
3726 Global commands prefixed by `global-edebug-prefix':
3729 ;;; Interface with standard debugger.
3731 ;; (setq debugger 'edebug) ; to use the edebug debugger
3732 ;; (setq debugger 'debug) ; use the standard debugger
3734 ;; Note that debug and its utilities must be byte-compiled to work,
3735 ;; since they depend on the backtrace looking a certain way. But
3736 ;; edebug is not dependent on this, yet.
3739 "Replacement for `debug'.
3740 If we are running an edebugged function, show where we last were.
3741 Otherwise call `debug' normally."
3742 ;;(message "entered: %s depth: %s edebug-recursion-depth: %s"
3743 ;; edebug-entered (recursion-depth) edebug-recursion-depth) (sit-for 1)
3749 ;; Bind variables required by edebug--display.
3750 edebug-breakpoints
3751 edebug-break-data
3752 edebug-break-condition
3753 edebug-global-break
3755 )
3758 nil
3759 value))
3761 ;; Otherwise call debug normally.
3762 ;; Still need to remove extraneous edebug calls from stack.
3764 ))
3768 "Display a non-working backtrace. Better than nothing..."
3774 ;; Else, could just display edebug-backtrace-buffer.
3775 )
3780 last-ok-point)
3783 ;; Clean up the backtrace.
3784 ;; Not quite right for current edebug scheme.
3791 ;; Delete interspersed edebug internals.
3796 ;; Previous lines may contain code, so just delete this line.
3804 )))
3805 )))))
3807 \f
3808 ;;; Trace display
3811 "In buffer BUF-NAME, display FMT and ARGS at the end and make it visible.
3812 The buffer is created if it does not exist.
3813 You must include newlines in FMT to break lines, but one newline is appended."
3814 ;; e.g.
3815 ;; (edebug-trace-display "*trace-point*"
3816 ;; "saving: point = %s window-start = %s"
3817 ;; (point) (window-start))
3821 buf-window)
3822 ;; (message "before pop-to-buffer") (sit-for 1)
3828 ;; Make it visible.
3832 ;; (set-window-point buf-window (point))
3833 ;; (sit-for 0)
3837 buf-name)
3841 "Convenience call to `edebug-trace-display' using `edebug-trace-buffer'."
3844 \f
3845 ;;; Frequency count and coverage
3847 ;; FIXME should this use overlays instead?
3848 ;; Definitely, IMO. The current business with undo in
3849 ;; edebug-temp-display-freq-count is horrid.
3851 "Display the frequency count data for each line of the current definition.
3852 The frequency counts are inserted as comment lines after each line,
3853 and you can undo all insertions with one `undo' command.
3855 The counts are inserted starting under the `(' before an expression
3856 or the `)' after an expression, or on the last char of a symbol.
3857 The counts are only displayed when they differ from previous counts on
3858 the same line.
3860 If coverage is being tested, whenever all known results of an expression
3861 are `eq', the char `=' will be appended after the count
3862 for that expression. Note that this is always the case for an
3863 expression only evaluated once.
3865 To clear the frequency count and coverage data for a definition,
3866 reinstrument it."
3880 )
3882 ;; Traverse in reverse order so offsets are correct.
3884 ;; Start at last expression in line.
3888 last-index i)
3890 ;; Find all indexes on same line.
3893 ;; Insert all the indices for this line.
3896 first-index i ; Really, last index for line above this one.
3899 ;; i == first-index still
3919 ;; FIXME this does not work very well. Eg if you press an arrow key,
3920 ;; or make a mouse-click, it fails with "Non-character input-event".
3922 "Temporarily display the frequency count data for the current definition.
3923 It is removed when you hit any char."
3924 ;; This seems not to work with Emacs 18.59. It undoes too far.
3931 ;; Yuck! This doesn't seem to work at all for me.
3934 \f
3935 ;;; Menus
3941 ;; We have to require easymenu (even for Emacs 18) just so
3942 ;; the easy-menu-define macro call is compiled correctly.
3956 "----"
3961 "----"
3993 "----"
4003 ))
4006 \f
4007 ;;; Emacs version specific code
4015 "Set a conditional breakpoint at nearest sexp.
4016 The condition is evaluated in the outside context.
4017 With prefix argument, make it a temporary breakpoint."
4018 ;; (interactive "P\nxCondition: ")
4021 current-prefix-arg
4022 ;; Read condition as follows; getting previous condition is cumbersome:
4034 "Condition: " initial read-expression-map t
4041 \f
4042 ;;; Autoloading of Edebug accessories
4044 ;; edebug-cl-read and cl-read are available from liberte@cs.uiuc.edu
4050 ;; The following causes edebug-cl-read to be loaded when you load cl-read.el.
4053 \f
4054 ;;; Finalize Loading
4056 ;; When edebugging a function, some of the sub-expressions are
4057 ;; wrapped in (edebug-enter (lambda () ..)), so we need to teach
4058 ;; called-interactively-p that calls within the inner lambda should refer to
4059 ;; the outside function.
4066 ;; `edebug-enter' calls itself on its first invocation.
4071 ;; Finally, hook edebug into the rest of Emacs.
4072 ;; There are probably some other things that could go here.
4074 ;; Install edebug read and eval functions.
4078 "Unload the Edebug source level debugger."
4083 ;; We still want to run unload-feature to completion
4089 ;; Continue standard unloading.
4090 nil)
4093 ;;; edebug.el ends here