| blob | 10918775f49671f48d078602fc58e9ddd8f34adc |
1 ;;; edebug.el --- a source-level debugger for Emacs Lisp -*- lexical-binding: t -*-
3 ;; Copyright (C) 1988-1995, 1997, 1999-2015 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
88 \(make-local-variable 'edebug-all-defs) in your
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."
231 "Number of seconds to pause when execution mode is `trace' or `continue'."
235 ;;; Form spec utilities.
238 ;; Get the spec of symbol resolving all indirection.
246 ;; (edebug-trace "indirection: %s" edebug-form-spec)
248 spec))
250 ;;;###autoload
252 "Return t if SPEC uses only extant spec symbols.
253 An extant spec symbol is a symbol that is not a function and has a
254 `edebug-form-spec' property."
260 t))
264 ;;; Utilities
267 "Return t if OBJECT is a lambda list keyword.
268 A lambda list keyword is a symbol that starts with `&'."
274 ;; Return the last sexp before point in current buffer.
275 ;; Assumes Emacs Lisp syntax is active.
285 "Return a list of windows, in order of `next-window'."
286 ;; This doesn't work for epoch.
291 ;; Not used.
293 "Return t if there are two windows."
299 ;; Return the ALIST sorted with comparison function FUNCTION.
300 ;; This uses 'sort so the sorting is destructive.
305 ;; Not used.
307 "Evaluate BODY while saving the current buffers restriction.
308 BODY may change buffer outside of current restriction, unlike
309 save-restriction. BODY may change the current buffer,
310 and the restriction will be restored to the original buffer,
311 and the current buffer remains current.
312 Return the result of the last expression in BODY."
321 ;;; Display
327 ;; Like pop-to-buffer, but select window where BUFFER was last shown.
328 ;; Select WINDOW if it is provided and still exists. Otherwise,
329 ;; if buffer is currently shown in several windows, choose one.
330 ;; Otherwise, find a new window, possibly splitting one.
331 ;; FIXME: We should probably just be using `pop-to-buffer'.
336 window)
338 ;; Selected window already displays BUFFER.
342 ;; When there's one window only, split it.
349 ;; Found a non-dedicated window not showing
350 ;; `edebug-trace-buffer', use it.
352 ;; All windows are dedicated or show `edebug-trace-buffer', split
353 ;; selected one.
360 ;; Return a list of buffer point pairs, for all displayed buffers.
366 list))))
367 list))
371 ;; Restore the buffer-points created by edebug-get-displayed-buffer-points.
377 buffer-points)))
380 ;; Get either a full window configuration or some window information.
389 which-windows)
393 ;; Set either a full window configuration or some window information.
406 one-window-info))))
407 window-info)
410 ;;; Redefine read and eval functions
411 ;; read is redefined to maybe instrument forms.
412 ;; eval-defun is redefined to check edebug-all-forms and edebug-all-defs.
415 "Read one Lisp expression as text from STREAM, return as Lisp object.
416 If STREAM is nil, use the value of `standard-input' (which see).
417 STREAM or the value of `standard-input' may be:
418 a buffer (read from point and advance it)
419 a marker (read from where it points and advance it)
420 a function (call it with no arguments for each character,
421 call it with a char as argument to push a char back)
422 a string (takes text from string, starting at the beginning)
423 t (read text line using minibuffer and use it).
425 This version, from Edebug, maybe instruments the expression. But the
426 STREAM must be the current buffer to do so. Whether it instruments is
427 also dependent on the values of the option `edebug-all-defs' and
428 the option `edebug-all-forms'."
436 ;; We should somehow arrange to be able to do this
437 ;; without actually replacing the eval-defun command.
439 "Evaluate the top-level form containing point, or after point.
441 If the current defun is actually a call to `defvar', then reset the
442 variable using its initial value expression even if the variable
443 already has some other value. (Normally `defvar' does not change the
444 variable's value if it already has a value.) Treat `defcustom'
445 similarly. Reinitialize the face according to `defface' specification.
447 With a prefix argument, instrument the code for Edebug.
449 Setting option `edebug-all-defs' to a non-nil value reverses the meaning
450 of the prefix argument. Code is then instrumented when this function is
451 invoked without a prefix argument.
453 If acting on a `defun' for FUNCTION, and the function was instrumented,
454 `Edebug: FUNCTION' is printed in the minibuffer. If not instrumented,
455 just FUNCTION is printed.
457 If not acting on a `defun', the result of evaluation is displayed in
458 the minibuffer."
466 ;; This should be consistent with `eval-defun-1', but not the
467 ;; same, since that gets a macroexpanded form.
470 ;; Force variable to be bound.
474 ;; Force variable to be bound.
475 ;; FIXME: Shouldn't this use the :setter or :initializer?
478 ;; Reset the face.
483 ;; See comments in `eval-defun-1' for purpose of code below
496 edebug-result)))
499 ;;;###autoload
502 ;;;###autoload
504 "Evaluate the top level form point is in, stepping through with Edebug.
505 This is like `eval-defun' except that it steps the code for Edebug
506 before evaluating it. It displays the value in the echo area
507 using `eval-expression' (which see).
509 If you do this on a function definition such as a defun or defmacro,
510 it defines the function and instruments its definition for Edebug,
511 so it will do Edebug stepping when called later. It displays
512 `Edebug: FUNCTION' in the echo area to indicate that FUNCTION is now
513 instrumented for Edebug.
515 If the current defun is actually a call to `defvar' or `defcustom',
516 evaluating it this way resets the variable using its initial value
517 expression even if the variable already has some other value.
518 \(Normally `defvar' and `defcustom' do not alter the value if there
519 already is one.)"
522 ;; Bind edebug-all-forms only while reading, not while evalling
523 ;; but this causes problems while edebugging edebug.
536 ;; Recover point, but only if no error occurred.
540 ;; Compatibility with old versions.
543 ;;;###autoload
545 "Toggle edebugging of all definitions."
552 ;;;###autoload
554 "Toggle edebugging of all forms."
571 ;;; Edebug internal data
573 ;; The internal data that is needed for edebugging is kept in the
574 ;; buffer-local variable `edebug-form-data'.
577 "A list of entries associating symbols with buffer regions.
578 Each entry is an `edebug--form-data' struct with fields:
579 SYMBOL, BEGIN-MARKER, and END-MARKER. The markers
580 are at the beginning and end of an entry level form and SYMBOL is
581 a symbol that holds all edebug related information for the form on its
582 property list.
584 In the future (haha!), the symbol will be irrelevant and edebug data will
585 be stored in the definitions themselves rather than in the property
589 ;; Some callers expect accessors to return nil when passed nil.
593 name begin end)
601 ;; Find the edebug form data entry which is closest to PNT.
602 ;; If END-POINT is supplied, match must be exact.
603 ;; Return `nil' if none found.
605 closest-entry
618 closest-entry entry))))
619 closest-entry))
621 ;; Also need to find all contained entries,
622 ;; and find an entry given a symbol, which should be just assq.
625 "Return the edebug data symbol of the form where point is in.
626 If point is not inside a edebuggable form, cause error."
631 ;; Make NEW-ENTRY the first element in the `edebug-form-data' list.
636 "If non-nil, clear ENTRY out of the form data.
637 Maybe clear the markers and delete the symbol's edebug property?"
640 ;; Instead of this, we could just find all contained forms.
641 ;; (put (car entry) 'edebug nil) ;
642 ;; (mapcar 'edebug-clear-form-data-entry ; dangerous
643 ;; (get (car entry) 'edebug-dependents))
644 ;; (set-marker (nth 1 entry) nil)
645 ;; (set-marker (nth 2 entry) nil)
648 ;;; Parser utilities
651 ;; Signal an invalid-read-syntax with ARGS.
656 ;; Lookup table for significant characters indicating the class of the
657 ;; token that follows. This is not a \"real\" syntax table.
674 ;; We treat numbers as symbols, because of confusion with -, -1, and 1-.
675 ;; We don't care about any other chars since they won't be seen.
676 table))
679 ;; Move to the next token and return its class. We only care about
680 ;; lparen, rparen, dot, quote, backquote, comma, string, char, vector,
681 ;; or symbol.
690 'symbol
695 ;; Leave point before the next token, skipping white space and comments.
702 ;; Mostly obsolete reader; still used in one case.
705 ;; Read one sexp from the current buffer starting at point.
706 ;; Leave point immediately after it. A sexp can be a list or atom.
707 ;; An atom is a symbol (or number), character, string, or vector.
708 ;; This works for reading anything legitimate, but it
709 ;; is gummed up by parser inconsistencies (bugs?)
712 ;; read goes one too far if a (possibly quoted) string or symbol
713 ;; is immediately followed by non-whitespace.
725 ;;; Offsets for reader
727 ;; Define a structure to represent offset positions of expressions.
728 ;; Each offset structure looks like: (before . after) for constituents,
729 ;; or for structures that have elements: (before <subexpressions> . after)
730 ;; where the <subexpressions> are the offset structures for subexpressions
731 ;; including the head of a list.
734 ;; Stack of offset structures in reverse order of the nesting.
735 ;; This is used to get back to previous levels.
739 ;; We must store whether we just read a list with a dotted form that
740 ;; is itself a list. This structure will be condensed, so the offsets
741 ;; must also be condensed.
745 ;; Reinitialize offset recording.
749 ;; Add a new offset pair with POINT as the before offset.
754 ;; Otherwise, we are at the top level, so initialize.
756 edebug-offsets-stack nil
757 edebug-read-dotted-list nil))
758 ;; Cons the new offset to the front of the stack.
760 edebug-current-offset new-offset)
761 ))
764 ;; Finalize the current offset struct by reversing it and
765 ;; store POINT as the after offset.
767 ;; Just reverse the offsets of all subexpressions.
770 ;; We just read a list after a dot, which will be abbreviated out.
772 ;; Drop the corresponding offset pair.
773 ;; That is, nconc the reverse of the rest of the offsets
774 ;; with the cdr of last offset.
779 ;; Now append the point using nconc.
781 ;; Pop the stack.
786 ;; Ignore the last created offset pair.
798 ;;; Reader for Emacs Lisp.
800 ;; Uses edebug-next-token-class (and edebug-skip-whitespace) above.
811 ))
818 ;; anything else, just read it.
820 stream))))
826 ;; Turn 'thing into (quote thing)
833 ;; Turn `thing into (\` thing)
840 ;; Turn ,thing into (\, thing). Handle ,@ and ,. also.
850 ;; Generate the same structure of offsets we would have
851 ;; if the resulting list appeared verbatim in the input text.
857 ;; Turn #'thing into (function thing)
885 ))
886 elements)
888 ))
898 ))
900 ;;; Cursors for traversal of list and vector elements with offsets.
905 ;; Return a new cursor for EXPRESSIONS with OFFSETS.
911 ;; Set the CURSOR's EXPRESSIONS and OFFSETS to the given.
912 ;; Return the cursor.
915 cursor)
918 ;; Copy the cursor using the same object and offsets.
927 ;; Return non-nil if CURSOR is empty - meaning no more elements.
931 ;; Return the top element at the cursor.
932 ;; Assumes not empty.
936 ;; Check if a dotted form is required.
938 ;; Check if there is at least one more argument.
940 ;; Return that top element.
944 ;; Return the top offset pair corresponding to the top element.
948 ;; Advance and return the cursor to the next element and offset.
949 ;; throw no-match if empty before moving.
950 ;; This is a violation of the cursor encapsulation, but
951 ;; there is plenty of that going on while matching.
952 ;; The following test should always fail.
957 cursor)
961 ;; Return the before offset of the cursor.
962 ;; If there is nothing left in the offsets,
963 ;; return one less than the offset itself,
964 ;; which is the after offset for a list.
971 ;; Return the after offset of the cursor object.
975 offset))
977 ;;; The Parser
979 ;; The top level function for parsing forms is
980 ;; edebug-read-and-maybe-wrap-form; it calls all the rest. It checks the
981 ;; syntax a bit and leaves point at any error it finds, but otherwise
982 ;; should appear to work like eval-defun.
984 ;; The basic plan is to surround each expression with a call to
985 ;; the edebug debugger together with indexes into a table of positions of
986 ;; all expressions. Thus an expression "exp" becomes:
988 ;; (edebug-after (edebug-before 1) 2 exp)
990 ;; When this is evaluated, first point is moved to the beginning of
991 ;; exp at offset 1 of the current function. The expression is
992 ;; evaluated, which may cause more edebug calls, and then point is
993 ;; moved to offset 2 after the end of exp.
995 ;; The highest level expressions of the function are wrapped in a call to
996 ;; edebug-enter, which supplies the function name and the actual
997 ;; arguments to the function. See functions edebug-enter, edebug-before,
998 ;; and edebug-after for more details.
1000 ;; Dynamically bound vars, left unbound, but globally declared.
1001 ;; This is to quiet the byte compiler.
1003 ;; Window data of the highest definition being wrapped.
1004 ;; This data is shared by all embedded definitions.
1019 ;; Read a form and wrap it with edebug calls, if the conditions are right.
1020 ;; Here we just catch any no-match not caught below and signal an error.
1022 ;; Run the setup hook.
1023 ;; If it gets an error, make it nil.
1030 edebug-top-window-data
1031 edebug-def-name;; make sure it is locally nil
1032 ;; I don't like these here!!
1033 edebug-&optional
1034 edebug-&rest
1035 edebug-gate
1036 edebug-best-error
1037 edebug-error-point
1038 ;; Do this once here instead of several times.
1044 nil)))
1047 result))
1052 def-kind
1053 defining-form-p
1054 def-name
1055 ;; These offset things don't belong here, but to support recursive
1056 ;; calls to edebug-read, they need to be here.
1057 edebug-offsets
1058 edebug-offsets-stack
1059 edebug-current-offset ; reset to nil
1060 )
1064 ;; Find out if this is a defining form from first symbol
1069 ;; This is incorrect in general!! But OK most of the time.
1074 ;;;(message "all defs: %s all forms: %s" edebug-all-defs edebug-all-forms)
1078 ;; If it is a defining form and we are edebugging defs,
1079 ;; then let edebug-list-form start it.
1085 cursor
1090 ;; Not edebugging this form, so reset the symbol's edebug
1091 ;; property to be just a marker at the definition's source code.
1092 ;; This only works for defs with simple names.
1094 ;; Also nil out dependent defs.
1101 ;; If all forms are being edebugged, explicitly wrap it.
1107 cursor
1110 nil)))
1112 ;; Not a defining form, and not edebugging.
1114 ))
1120 ;; Currently def-form sets this to nil; def-body sets it to t.
1123 ;; Return a unique symbol for the variable used to store the
1124 ;; status of interactive-p for this function.
1129 "Wrap the FORMS of a definition body."
1138 ;; Generate the enter wrapper for some forms of a definition.
1139 ;; This is not to be used for the body of other forms, e.g. `while',
1140 ;; since it wraps the list of forms with a call to `edebug-enter'.
1141 ;; Uses the dynamically bound vars edebug-def-name and edebug-def-args.
1142 ;; Do this after parsing since that may find a name.
1149 ;; Doesn't work with more than one def-body!!
1150 ;; But the list will just be reversed.
1154 ))
1163 ;; Modifies edebug-offset-index and edebug-offset-list
1164 ;; accesses edebug-func-marc and buffer point.
1166 edebug-offset-index
1168 edebug-offset-list)
1173 ;; Return the edebug form for the current function at offset BEFORE-INDEX
1174 ;; given FORM. Looks like:
1175 ;; (edebug-after (edebug-before BEFORE-INDEX) AFTER-INDEX FORM)
1176 ;; Also increment the offset index for subsequent use.
1180 ;; Like edebug-make-before-and-after-form, but only after.
1185 "Return the unwrapped SEXP or return it as is if it is not wrapped.
1186 The SEXP might be the result of wrapping a body, which is a list of
1187 expressions; a `progn' form will be returned enclosing these forms."
1195 )
1196 sexp))
1199 "Return the SEXP recursively unwrapped."
1206 new-sexp)))
1210 ;; Process the defining form, starting outside the form.
1211 ;; The speclist is a generated list spec that looks like:
1212 ;; (("def-symbol" defining-form-spec-sans-&define))
1213 ;; Skip the first offset.
1217 cursor
1219 speclist))
1223 ;; Wrap a form, usually a defining form, but any evaluated one.
1224 ;; If speclist is non-nil, this is being called by edebug-defining-form.
1225 ;; Otherwise it is being called from edebug-read-and-maybe-wrap-form1.
1226 ;; This is a hack, but I haven't figured out a simpler way yet.
1228 ;; Set this marker before parsing.
1232 ;; Buffer must be current-buffer for this to work:
1237 result
1238 ;; For definitions.
1239 ;; (edebug-containing-def-name edebug-def-name)
1240 ;; Get name from form-data, if any.
1242 edebug-def-name
1243 edebug-def-args
1244 edebug-def-interactive
1245 edebug-inside-func;; whether wrapped code executes inside a function.
1246 )
1252 ;; else wrap as an enter-form.
1255 ;; Set the name here if it was not set by edebug-make-enter-wrapper.
1259 ;; Add this def as a dependent of containing def. Buggy.
1267 ;; Create a form-data-entry or modify existing entry's markers.
1268 ;; In the latter case, pointers to the entry remain eq.
1272 edebug-def-name
1273 edebug-form-begin-marker
1274 ;; Buffer must be current-buffer.
1276 ))
1278 form-data-entry edebug-def-name ;; in case name is changed
1279 form-begin form-end))
1281 ;; (message "defining: %s" edebug-def-name) (sit-for 2)
1284 ;;(debug edebug-def-name)
1286 ;; Destructively reverse edebug-offset-list and make vector from it.
1289 ;; Side effects on the property list of edebug-def-name.
1293 ;; Set up the initial window data.
1301 ;; Store the edebug data in symbol's property list.
1303 ;; A struct or vector would be better here!!
1305 nil ; clear breakpoints
1306 edebug-offset-list
1307 edebug-top-window-data
1308 ))
1309 result
1310 )))
1314 ;; Create initial frequency count vector.
1315 ;; For each stop point, the counter is incremented each time it is visited.
1321 ;; Create initial coverage vector.
1322 ;; Only need one per expression, but it is simpler to use stop points.
1328 ;; Return the instrumented form for the following form.
1329 ;; Add the point offsets to the edebug-offset-list for the form.
1335 ;; The first offset for a list form is for the list form itself.
1337 form
1341 ;; Find out if this is a defining form from first symbol.
1342 ;; An indirect spec would not work here, yet.
1345 new-cursor
1349 ;; Wrap a regular form.
1353 ;; After processing the list form, the new-cursor is left
1354 ;; with the offset after the form.
1356 )))
1360 ;; Check for constant symbols that don't get wrapped.
1363 form)
1368 ;; Anything else is self-evaluating.
1377 ;; Process the arguments of a list form given that head of form is a symbol.
1378 ;; Helper for edebug-list-form
1384 ;; It is a speclist.
1391 ; but leave it in for compatibility.
1392 ))
1393 ;; No edebug-form-spec provided.
1403 ;; Return an instrumented form built from the list form.
1404 ;; The after offset will be left in the cursor after processing the form.
1406 ;; Prevent backtracking whenever instrumenting.
1408 ;; A list form is never optional because it matches anything.
1411 ;; Skip the first offset.
1419 ;; Special case: replace (interactive-p) with variable
1429 ;; The head of a form should normally be a symbol or a lambda
1430 ;; expression but it can also be an unquote form to be filled
1431 ;; before evaluation. We evaluate the arguments anyway, on the
1432 ;; assumption that the unquote form will place a proper function
1433 ;; name (rather than a macro name).
1435 ;; Process anonymous function and args.
1436 ;; This assumes no anonymous macros.
1441 ))
1443 ;;; Matching of specs.
1451 ;;; Failure to match
1453 ;; This throws to no-match, if there are higher alternatives.
1454 ;; Otherwise it signals an error. The place of the error is found
1455 ;; with the two before- and after-offset functions.
1458 ;; Throw a no-match, or signal an error immediately if gate is active.
1459 ;; Remember this point in case we need to report this error.
1472 ;; Top level spec matching function.
1473 ;; Used also at each lower level of specs.
1475 edebug-&rest
1476 edebug-best-error
1477 edebug-error-point
1479 )
1484 ;; Match one spec, which is not a keyword &-spec.
1490 ))
1494 ;; Append results of matching the list of specs.
1495 ;; The first spec is handled and the remainder-handler handles the rest.
1503 ;; Is the spec dotted?
1508 ;; Is the form dotted?
1512 ;; Cancel dotted spec and dotted form.
1516 ;; Wrap the form in a list, (by changing the cursor??)...
1518 ;; and process normally, then unwrap the result.
1525 ;;(message "spec = %s first char = %s" spec first-char) (sit-for 1)
1539 ;; Define specs for all the symbol specs with functions used to process them.
1540 ;; Perhaps we shouldn't be doing this with edebug-form-specs since the
1541 ;; user may want to define macros or functions with the same names.
1542 ;; We could use an internal obarray for these primitive specs.
1556 ;; Less frequently used:
1557 ;; (function . edebug-match-function)
1563 ;; (nil . edebug-match-nil) not this one - special case it.
1564 ))
1568 ;; Match a symbol spec.
1573 ;; It is an indirect spec.
1575 ;; Otherwise it should be the symbol name of a function.
1576 ;; There could be a bug here - maybe need to do edebug-match bindings.
1584 ;; Special case for edebug-`.
1592 )))
1603 ;; Currently identical to edebug-match-form.
1604 ;; This is for common lisp setf-style place arguments.
1609 ;; Keep matching until one spec fails.
1621 ;; Returning nil means no no-match was thrown.
1622 nil))
1623 result
1624 ;; no-match, but don't fail; just reset cursor and return nil.
1626 nil)))
1631 ;; Reuse the &optional handler with this as the remainder handler.
1635 ;; Repeatedly use specs until failure.
1637 edebug-best-error
1638 edebug-error-point)
1643 ;; Keep matching until one spec succeeds, and return its results.
1644 ;; If none match, fail.
1645 ;; This needs to be optimized since most specs spend time here.
1654 edebug-best-error
1655 edebug-error-point)
1656 ;; Doesn't support e.g. &or symbolp &rest form
1658 ;; Match failed, so reset and try again.
1660 ;; Reset the cursor for the next match.
1662 ;; All failed.
1664 ))
1668 ;; If any specs match, then fail
1673 nil))
1674 ;; This means something matched, so it is a no match.
1676 ;; This means nothing matched, so it is OK.
1683 ;; Following specs must look like (<name> <spec>) ...
1684 ;; where <name> is the name of a keyword, and spec is its spec.
1685 ;; This really doesn't save much over the expanded form and takes time.
1687 cursor
1692 specs))))
1696 ;; Simply set the gate to prevent backtracking at this level.
1698 nil)
1702 ;; The spec is a list, but what kind of list, and what context?
1704 ;; After dotted spec but form did not contain dot,
1705 ;; so match list spec elements as if spliced in.
1709 ;; If it matched, really clear the dotted-spec flag.
1718 ;; Special case: spec quotes a symbol to match.
1719 ;; Change in future. Use "..." instead.
1724 form)
1731 ;; First offset is for the list form itself.
1732 ;; Treat nil as empty list.
1734 specs))
1738 ;; Special case: match a vector with the specs.
1747 )))
1751 ;; Match a sublist of specs.
1753 ;;edebug-best-error
1754 ;;edebug-error-point
1755 )
1757 ;; match with edebug-match-specs so edebug-best-error is not bound.
1762 ;; A failed &rest or &optional spec may leave some args.
1764 )))))
1771 ;; Since it matched, failure means immediate error, unless &optional.
1775 )))
1778 ;; There must be nothing left to match a nil.
1781 nil))
1788 ;; Match a defining form.
1789 ;; Normally, &define is interpreted specially other places.
1790 ;; This should only be called inside of a spec list to match the remainder
1791 ;; of the current list. e.g. ("lambda" &define args def-body)
1793 cursor
1795 ;; Find the last offset in the list.
1798 offsets)
1799 specs))
1802 ;; The expression must be a function.
1803 ;; This will match any list form that begins with a symbol
1804 ;; that has an edebug-form-spec beginning with &define. In
1805 ;; practice, only lambda expressions should be used.
1806 ;; I could add a &lambda specification to avoid confusion.
1813 ;; Find out if this is a defining form from first symbol.
1824 )))
1828 ;; Set the edebug-def-name bound in edebug-defining-form.
1830 ;; Maybe strings and numbers could be used.
1835 ;; Construct a new name by appending to previous name.
1837 name))
1842 ;; Set the edebug-def-name to the spec.
1845 ;; Construct a new name by appending to previous name.
1847 spec))
1848 nil)
1851 ;; set the def-args bound in edebug-defining-form
1861 ;; Like form but the form is wrapped in edebug-enter form.
1862 ;; The form is assumed to be executing outside of the function context.
1863 ;; This is a hack for now, since a def-form might execute inside as well.
1864 ;; Not to be used otherwise.
1869 ;; Like body but body is wrapped in edebug-enter form.
1870 ;; The body is assumed to be executing inside of the function context.
1871 ;; Not to be used otherwise.
1876 ;;;; Edebug Form Specs
1877 ;;; ==========================================================
1879 ;;;;* Spec for def-edebug-spec
1880 ;;; Out of date.
1883 "Return non-nil if OBJECT is a symbol with an edebug-form-spec property."
1888 ;; Top level is different from lower levels.
1893 ;; A list must have something in it, or it is nil, a symbolp
1897 (&or
1901 edebug-spec-list
1902 stringp
1905 edebug-spec-p ;; Including all the special ones e.g. form.
1906 symbolp;; a predicate
1907 ))
1910 ;;;* Emacs special forms and some functions.
1912 ;; quote expects only one argument, although it allows any number.
1915 ;; The standard defining forms.
1920 (&define name lambda-list
1923 def-body))
1925 ;; FIXME: Improve `declare' so we can Edebug gv-expander and
1926 ;; gv-setter declarations.
1936 )))
1941 ;; A function-form is for an argument that may be a function or a form.
1942 ;; This specially recognizes anonymous functions quoted with quote.
1944 ;; form at the end could also handle "function",
1945 ;; but recognize it specially to avoid wrapping function forms.
1948 ;; function expects a symbol or a lambda or macro expression
1949 ;; A macro is allowed by Emacs.
1952 ;; A macro expression is a lambda expression with "macro" prepended.
1955 ;; (def-edebug-spec anonymous-form ((&or ["lambda" lambda] ["macro" macro])))
1957 ;; Standard functions that take function-forms arguments.
1959 ;; FIXME? The manual uses this form (maybe that's just for illustration?):
1960 ;; (def-edebug-spec let
1961 ;; ((&rest &or symbolp (gate symbolp &optional form))
1962 ;; body))
1965 body))
1976 form
1982 ;; Supports quotes inside backquotes,
1983 ;; but only at the top level inside unquotes.
1985 (&or
1987 ;; The simple version:
1988 ;; (backquote-form &rest backquote-form)
1989 ;; doesn't handle (a . ,b). The straightforward fix:
1990 ;; (backquote-form . [&or nil backquote-form])
1991 ;; uses up too much stack space.
1992 ;; Note that `(foo . ,@bar) is not valid, so we don't need to handle it.
1995 ;; If you use dotted forms in backquotes, replace the previous line
1996 ;; with the following. This takes quite a bit more stack space, however.
1997 ;; (backquote-form . [&or nil backquote-form])
1999 sexp))
2001 ;; Special version of backquote that instruments backquoted forms
2002 ;; destined to be evaluated, usually as the result of a
2003 ;; macroexpansion. Backquoted code can only have unquotes (, and ,@)
2004 ;; in places where list forms are allowed, and predicates. If the
2005 ;; backquote is used in a macro, unquoted code that come from
2006 ;; arguments must be instrumented, if at all, with def-form not def-body.
2008 ;; We could assume that all forms (not nested in other forms)
2009 ;; in arguments of macros should be def-forms, whether or not the macros
2010 ;; are defined with edebug-` but this would be expensive.
2012 ;; ,@ might have some problems.
2017 ;; Assume immediate quote in unquotes mean backquote at next higher level.
2022 ;; New byte compiler.
2027 ;; Anything else?
2029 ;;; The debugger itself
2034 ;; Stack of active functions evaluated via edebug.
2035 ;; Should be nil at the top level.
2038 ;; Index of last edebug-stack item.
2041 ;; Stack of offset indices of visited edebug sexps.
2042 ;; Should be nil at the top level.
2043 ;; Each function adds one cons. Top is modified with setcar.
2047 ;; Non-nil if edebug has already been entered at this recursive edit level.
2048 ;; This should stay nil at the top level.
2049 )
2051 ;; Should these be options?
2053 ;; Name of function to use for debugging when error or quit occurs.
2054 ;; Set this to 'debug if you want to debug edebug.
2055 )
2058 ;; Dynamically bound variables, declared globally but left unbound.
2073 ;;; Handling signals
2076 "Signal an error. Args are SIGNAL-NAME, and associated DATA.
2077 A signal name is a symbol with an `error-conditions' property
2078 that is a list of condition names.
2079 A handler for any of those names will get to handle this signal.
2080 The symbol `error' should always be one of them.
2082 DATA should be a list. Its elements are printed as part of the error message.
2083 If the signal is handled, DATA is made available to the handler.
2084 See `condition-case'.
2086 This is the Edebug replacement for the standard `signal'. It should
2087 only be active while Edebug is. It checks `debug-on-error' to see
2088 whether it should call the debugger. When execution is resumed, the
2089 error is signaled again."
2092 ;; If we reach here without another non-local exit, then send signal again.
2093 ;; i.e. the signal is not continuable, yet.
2094 ;; Avoid infinite recursion.
2098 ;;; Entering Edebug
2101 ;; Entering FUNC. The arguments are ARGS, and the body is BODY.
2102 ;; Setup edebug variables and evaluate BODY. This function is called
2103 ;; when a function evaluated with edebug-eval-top-level-form is entered.
2104 ;; Return the result of BODY.
2106 ;; Is this the first time we are entering edebug since
2107 ;; lower-level recursive-edit command?
2108 ;; More precisely, this tests whether Edebug is currently active.
2112 ;; Binding max-lisp-eval-depth here is OK,
2113 ;; but not inside an unwind-protect.
2114 ;; Doing it here also keeps it from growing too large.
2121 ;; Binding these may not be the right thing to do.
2122 ;; We want to allow the global values to be changed.
2128 edebug-initial-mode
2129 edebug-execution-mode)
2130 edebug-next-execution-mode nil)
2141 )
2150 ))))
2153 "Return a cons cell describing the status of VAR's current binding.
2154 The purpose of this function is so you can properly undo
2155 subsequent changes to the same binding, by passing the status
2156 cons cell to `edebug-restore-status'. The status cons cell
2157 has the form (LOCUS . VALUE), where LOCUS can be a buffer
2158 \(for a buffer-local binding), a frame (for a frame-local binding),
2159 or nil (if the default binding is current)."
2164 "Reset VAR based on STATUS.
2165 STATUS should be a list returned by `edebug-var-status'."
2179 edebug-result)
2189 "Print MSG in *edebug-trace* before and after evaluating BODY.
2190 The result of BODY is also printed."
2192 edebug-result)
2199 "Function called to print trace info before expression evaluation.
2200 MSG is printed after `::::{ '."
2205 "Function called to print trace info after expression evaluation.
2206 MSG is printed after `::::} '."
2214 ;; Debug current function given BEFORE position.
2215 ;; Called from functions compiled with edebug-eval-top-level-form.
2216 ;; Return the before index.
2219 ;; Increment frequency count
2226 before-index)
2229 ;; Do nothing.
2230 )
2234 value
2235 ;; Debug current function given AFTER position and VALUE.
2236 ;; Called from functions compiled with edebug-eval-top-level-form.
2237 ;; Return VALUE.
2240 ;; Increment frequency count
2247 ;; Just return result.
2248 value
2250 )))
2253 ;; Do nothing but return the value.
2254 value)
2260 ;; This is not used, yet.
2274 ;; Test if a different result.
2279 ;; Dynamically declared unbound variables.
2292 ;; Don't really try to enter edebug within an eval from redisplay.
2293 value
2294 ;; Check breakpoints and pending input.
2295 ;; If edebug display should be updated, call edebug--display.
2296 ;; Return value.
2309 ;;(edebug-trace "exp: %s" value)
2310 ;; Test whether we should break.
2319 ;; Delete the breakpoint.
2324 ;; Display if mode is not go, continue, or Continue-fast
2325 ;; or break, or input is pending,
2327 edebug-break
2331 value)))
2334 ;; window-start now stored with each function.
2335 ;;(defvar edebug-window-start nil)
2336 ;; Remember where each buffers' window starts between edebug calls.
2337 ;; This is to avoid spurious recentering.
2338 ;; Does this still need to be buffer-local??
2339 ;;(setq-default edebug-window-start nil)
2340 ;;(make-variable-buffer-local 'edebug-window-start)
2343 ;; Dynamically declared unbound vars
2357 ;; Emacs 19 adds an arg to mark and mark-marker.
2361 ;; edebug--display-1 is too big, we should split it. This function
2362 ;; here was just introduced to avoid making edebug--display-1
2363 ;; yet a bit deeper.
2368 ;; The buffer holding the source has been killed.
2369 ;; Let's at least show a backtrace so the user can figure out
2370 ;; which function we're talking about.
2372 ;; Setup windows for edebug, determine mode, maybe enter recursive-edit.
2373 ;; Uses local variables of edebug-enter, edebug-before, edebug-after
2374 ;; and edebug-debugger.
2377 edebug-stop ; Should we enter recursive-edit?
2380 edebug-buffer-outside-point ; current point in edebug-buffer
2381 ;; window displaying edebug-buffer
2387 edebug-outside-windows ; Window or screen configuration.
2388 edebug-buffer-points
2390 edebug-eval-buffer ; Declared here so we can kill it below.
2393 edebug-trace-window
2394 edebug-trace-window-start
2401 ;; any others??
2402 )
2408 ;; Compute result string now before windows are modified.
2412 ;; Save windows now before we modify them.
2419 ;; First move the edebug buffer point to edebug-point
2420 ;; so that window start doesn't get changed when we display it.
2421 ;; I don't know if this is going to help.
2422 ;;(set-buffer edebug-buffer)
2423 ;;(goto-char edebug-point)
2425 ;; If edebug-buffer is not currently displayed,
2426 ;; first find a window for it.
2430 ;; Now display eval list, if any.
2431 ;; This is done after the pop to edebug-buffer
2432 ;; so that buffer-window correspondence is correct after quitting.
2434 ;; The evaluation list better not have deleted edebug-window-data.
2442 ;; Check whether positions are up-to-date.
2443 ;; This assumes point is never before symbol.
2446 edebug-function)
2447 ))
2452 ;; Test if there is input, not including keyboard macros.
2456 edebug-stop t)
2458 ;; (discard-input) ; is this unfriendly??
2459 ))
2461 ;; Make sure we bind those in the right buffer (bug#16410).
2464 ;; Now display arrow based on mode.
2469 ;; Display error message
2480 edebug-global-break-condition
2481 edebug-global-break-result))
2484 edebug-break-condition
2485 edebug-break-result))
2494 ;; Display result of previous evaluation.
2507 ;; not edebug-break
2518 ;; (setq edebug-execution-mode 'step)
2519 ;; (edebug-overlay-arrow) ; This doesn't always show up.
2522 ;; Reset the edebug-window-data to whatever it is now.
2526 ;; Remember window-start for edebug-buffer, if still displayed.
2532 ;; Save trace window point before restoring outside windows.
2533 ;; Could generalize this for other buffers.
2541 ;; Restore windows before continuing.
2546 ;; Restore displayed buffer points.
2547 ;; Needed even if restoring windows because
2548 ;; window-points are not restored. (should they be??)
2552 ;; Unrestore trace window's window-point.
2555 edebug-trace-window-start))
2557 ;; Unrestore edebug-buffer's window-start, if displayed.
2564 ;; Unrestore edebug-buffer's window-point.
2565 ;; Needed in addition to setting the buffer point
2566 ;; - otherwise quitting doesn't leave point as is.
2567 ;; But can this causes point to not be restored.
2568 ;; Also, it may not be a visible window.
2569 ;; (set-window-point window edebug-point)
2570 )))
2572 ;; Unrestore edebug-buffer's point. Rerestored below.
2573 ;; (goto-char edebug-point) ;; in edebug-buffer
2574 )
2575 ;; Since we may be in a save-excursion, in case of quit,
2576 ;; reselect the outside window only.
2577 ;; Only needed if we are not recovering windows??
2582 ;; Restore current buffer always, in case application needs it.
2585 ;; Restore point, and mark.
2586 ;; Needed even if restoring windows because
2587 ;; that doesn't restore point and mark in the current buffer.
2588 ;; But don't restore point if edebug-buffer is current buffer.
2592 ;; Does zmacs-regions need to be nil while doing set-marker?
2595 ;; None of the following is done if quit or signal occurs.
2597 ;; Restore edebug-buffer's outside point.
2598 ;; (edebug-trace "restore edebug-buffer point: %s"
2599 ;; edebug-buffer-outside-point)
2602 ;; ... nothing more.
2603 )
2604 ;; Could be an option to keep eval display up.
2607 ;; Reset global variables to outside values in case they were changed.
2609 )))
2613 ;; Number of recursive edits started by edebug.
2614 ;; Should be 0 at the top level.
2617 ;; Value of recursion-depth when edebug was called.
2619 ;; Dynamically declared unbound vars
2626 ;; Start up a recursive edit inside of edebug.
2627 ;; The current buffer is the edebug-buffer, which is put into edebug-mode.
2628 ;; Assume that none of the variables below are buffer-local.
2634 ;;(edebug-number-of-recursions (1+ edebug-number-of-recursions))
2636 edebug-entered ; bind locally to nil
2638 edebug-backtrace-buffer ; each recursive edit gets its own
2639 ;; The window configuration may be saved and restored
2640 ;; during a recursive-edit
2641 edebug-inside-windows
2642 )
2646 ;; Declare global values local but using the same global value.
2647 ;; We could set these to the values for previous edebug call.
2652 ;; More for Emacs 19
2662 ;; Don't keep reading from an executing kbd macro
2663 ;; within edebug unless edebug-continue-kbd-macro is
2664 ;; non-nil. Again, local binding may not be best.
2668 ;; Don't get confused by the user's keymap changes.
2672 ;; Bind again to outside values.
2676 ;; Don't keep defining a kbd macro.
2680 ;; Disable command hooks. This is essential when
2681 ;; a hook function is instrumented - to avoid infinite loop.
2682 ;; This may be more than we need, however.
2686 ;; others??
2687 )
2699 ;; Do the following, even if quit occurs.
2704 ;; Remember selected-window after recursive-edit.
2705 ;; (setq edebug-inside-window (selected-window))
2709 ;; Recursive edit may have changed buffers,
2710 ;; so set it back before exiting let.
2717 ;; gotta have a buffer to let its buffer local variables be set
2720 )))
2723 ;;; Display related functions
2726 ;; If pos is not visible, adjust current window to fit following context.
2727 ;; (message "window: %s old-start: %s window-start: %s pos: %s"
2728 ;; (selected-window) old-start (window-start) (point)) (sit-for 5)
2731 ;; First try old-start
2736 ;; (message "resetting window start") (sit-for 2)
2743 ))
2759 )
2763 ;; Set up the overlay arrow at beginning-of-line in current buffer.
2764 ;; The arrow string is derived from edebug-arrow-alist and
2765 ;; edebug-execution-mode.
2774 "Toggle the saving and restoring of all windows.
2775 Also, each time you toggle it on, the inside and outside window
2776 configurations become the same as the current configuration."
2783 edebug-save-windows))))
2793 edebug-save-windows))
2794 ;; Problem: what about outside windows that are deleted inside?
2798 "Toggle the saving and restoring of the selected window.
2799 Also, each time you toggle it on, the inside and outside window
2800 configurations become the same as the current configuration."
2804 ;; Save all outside windows except the selected one.
2805 ;; Remove (selected-window) from outside-windows.
2812 edebug-outside-windows))
2825 "Toggle the saving and restoring of windows.
2826 With prefix, toggle for just the selected window.
2827 Otherwise, toggle for all windows."
2834 "Show the debug windows and where we stopped in the program."
2838 ;; Restore the window configuration to what it last was inside.
2839 ;; But it is not always set. - experiment
2840 ;;(if edebug-inside-windows
2841 ;; (edebug-set-windows edebug-inside-windows))
2846 "Change to the outside window configuration.
2847 Use `edebug-where' to return."
2860 "Bounce the point in the outside current buffer.
2861 If prefix argument ARG is supplied, sit for that many seconds
2862 before returning. The default is one second."
2867 ;; If the buffer's currently displayed, avoid set-window-configuration.
2879 ;; Joe Wells, here is a start at your idea of adding a buffer to the internal
2880 ;; display list. Still need to use this list in edebug--display.
2886 "Toggle display of a buffer inside of edebug."
2896 ;;; Breakpoint related functions
2899 ;; Return (function . index) of the nearest edebug stop point.
2906 ;; pull out parts of edebug-data.
2908 ;; (edebug-breakpoints (car (cdr edebug-data)))
2913 ;; skip backwards until non-whitespace, or bol
2916 edebug-def-mark))
2917 len i)
2918 ;; the offsets are in order so we can do a linear search
2925 ;; return the relevant info
2928 edebug-def-name)
2929 )))
2933 "Move point to the next breakpoint, or first if none past point."
2941 ;; pull out parts of edebug-data
2945 breakpoint)
2955 ;; goto the first breakpoint
2968 ))))))
2972 "Modify the breakpoint for the form at point or after it.
2973 Set it if FLAG is non-nil, clear it otherwise. Then move to that point.
2974 If CONDITION or TEMPORARY are non-nil, add those attributes to
2975 the breakpoint."
2982 ;; pull out parts of edebug-data
2986 present)
2987 ;; delete it either way
2992 ;; add it to the list and resort
2997 edebug-breakpoints) '<))
3000 edebug-def-name condition)
3008 ))))
3011 "Set the breakpoint of nearest sexp.
3012 With prefix argument, make it a temporary breakpoint."
3017 "Clear the breakpoint of nearest sexp."
3023 "Set `edebug-global-break-condition' to EXPRESSION."
3029 "Global Condition: " initial read-expression-map t
3036 ;;; Mode switching functions
3039 ;; Set the edebug mode to MODE.
3040 ;; Display SHORTMSG, or MSG if not within edebug.
3045 ;; Continue execution
3047 ;; This is not terribly useful!!
3055 "Proceed to next stop point."
3060 "Proceed to next `after' stop point."
3065 "Go, evaluating until break.
3066 With prefix ARG, set temporary break at current point and go."
3073 "Go, evaluating without debugging.
3074 You can use `edebug-stop', or any editing command, to stop."
3081 "Begin trace mode.
3082 Pauses for `edebug-sit-for-seconds' at each stop point."
3087 "Trace with no wait at each step.
3088 Updates the display at each stop point, but does not pause."
3094 "Begin continue mode.
3095 Pauses for `edebug-sit-for-seconds' at each break point."
3101 "Trace with no wait at each step.
3102 Updates the display at each break point, but does not pause."
3107 ;; ------------------------------------------------------------
3108 ;; The following use the mode changing commands and breakpoints.
3112 "Proceed to first stop-point at or after current position of point."
3118 "Stop execution and do not continue.
3119 Useful for exiting from trace or continue loop."
3125 "Proceed to the exit of the next expression to be evaluated."
3133 "Proceed from the current point to the end of the ARGth sexp ahead.
3134 If there are not ARG sexps ahead, then do `edebug-step-out'."
3138 ;; Call forward-sexp repeatedly until done or failure.
3143 )))
3146 "Proceed from the current point to the end of the containing sexp.
3147 If there is no containing sexp that is not the top level defun,
3148 go to the end of the last sexp, or if that is the same point, then step."
3154 ;; Is there still a containing expression?
3158 ;; At top level - 1, so first check if there are more sexps at this level.
3160 ;; (up-list 1)
3165 )))))
3168 ;; Func should be a function symbol.
3169 ;; Return the function symbol, or nil if not instrumented.
3173 ;; It is uninstrumented, so instrument it.
3177 func))
3180 func)
3188 func))))))
3191 "Instrument the definition of the function or macro about to be called.
3192 Do this when stopped before the form or it will be too late.
3193 One side effect of using this command is that the next time the
3194 function or macro is called, Edebug will be called there as well."
3209 "Step into the definition of the function or macro about to be called.
3210 This first does `edebug-instrument-callee' to ensure that it is
3211 instrumented. Then it does `edebug-on-entry' and switches to `go' mode."
3220 "Cause Edebug to stop when FUNCTION is called.
3221 With prefix argument, make this temporary so it is automatically
3222 canceled the first time the function is entered."
3224 ;; Could store this in the edebug data instead.
3233 ;; Also need edebug-cancel-debug-on-entry
3236 "If the function is instrumented for Edebug, call `edebug-on-entry'."
3244 "Set mode to Go-nonstop, and exit to top-level.
3245 This is useful for exiting even if `unwind-protect' code may be executed."
3251 ;;(defun edebug-exit-out ()
3252 ;; "Go until the current function exits."
3253 ;; (interactive)
3254 ;; (edebug-set-mode 'exiting "Exit..."))
3257 ;;; The following initial mode setting definitions are not used yet.
3267 )
3272 "Ask for the initial mode of the enclosing function.
3273 The mode is requested via the key that would be used to set the mode in
3274 edebug-mode."
3278 edebug-mode-map))
3280 edebug-initial-mode))
3283 "Change initial edebug mode for %s from %s (%s) to (enter key): "
3284 this-function
3285 old-mode
3288 keymap 'firstonly
3289 ))))
3291 )
3298 this-function mode))
3300 )))
3302 ;;; Evaluation of expressions
3305 "Evaluate an expression list in the outside context.
3306 Return the result of the last expression."
3307 ;; Only restores the non-variables context since all the variables let-bound
3308 ;; by Edebug will be properly reset to the appropriate context's value by
3309 ;; backtrace-eval.
3314 ;; After excursion, we will
3315 ;; restore to current window configuration.
3318 ;; Restore outside windows.
3323 ;; Restore outside context.
3326 ;; FIXME: This restoring of edebug-outside-buffer and
3327 ;; edebug-outside-point is redundant now that backtrace-eval does it
3328 ;; for us.
3335 ;; Back to edebug-buffer. Restore rest of inside context.
3336 ;; (use-local-map edebug-inside-map)
3338 ;; Restore inside windows.
3341 ;; Save values that may have been changed.
3345 ;; Restore the outside saved values; don't alter
3346 ;; the outside binding loci.
3353 ;; Evaluate EXPR safely.
3354 ;; If there is an error, a string is returned describing the error.
3361 ;;; Printing
3365 ;; Print an error message like command level does.
3366 ;; This also prints the error name if it has no error-message.
3371 ;; continuing after an error may
3372 ;; complain about edebug-arg. why??
3377 ;; Alternatively, we could change the definition of
3378 ;; edebug-safe-prin1-to-string to only use these if defined.
3398 "Print the previous result."
3402 ;;; Read, Eval and Print
3411 "Evaluate an expression in the outside environment.
3412 If interactive, prompt for the expression.
3413 Print result in minibuffer."
3415 "Eval: " nil read-expression-map t
3424 "Evaluate sexp before point in the outside environment.
3425 Print value in minibuffer."
3430 "Evaluate sexp before point in outside environment; insert value.
3431 This prints the value into current buffer."
3439 ;; princ the string to get rid of quotes.
3442 ))
3444 ;;; Edebug Minor Mode
3447 "If non-nil, inhibit Edebug bindings on the C-x C-a key.
3448 By default, loading the `edebug' library causes these bindings to
3454 ;; Global GUD bindings for all emacs-lisp-mode buffers.
3463 ;; control
3473 ;;(define-key map "f" 'edebug-forward) not implemented
3481 ;; quitting and stopping
3487 ;; breakpoints
3494 ;; evaluation
3500 ;; views
3507 ;; misc
3513 ;; statistics
3516 ;; GUD bindings
3526 map))
3528 ;; Autoloading these global bindings doesn't make sense because
3529 ;; they cannot be used anyway unless Edebug is already loaded and active.
3545 ;; breakpoints
3551 ;; views
3555 ;; quitting
3560 ;; statistics
3562 map)
3570 "Describe `edebug-mode'."
3577 "Mode for Emacs Lisp buffers while in Edebug.
3579 In addition to all Emacs Lisp commands (except those that modify the
3580 buffer) there are local and global key bindings to several Edebug
3584 Also see bindings for the eval list buffer *edebug* in `edebug-eval-mode'.
3586 The edebug buffer commands:
3589 Global commands prefixed by `global-edebug-prefix':
3592 Options:
3593 `edebug-setup-hook'
3594 `edebug-all-defs'
3595 `edebug-all-forms'
3596 `edebug-save-windows'
3597 `edebug-save-displayed-buffer-points'
3598 `edebug-initial-mode'
3599 `edebug-trace'
3600 `edebug-test-coverage'
3601 `edebug-continue-kbd-macro'
3602 `edebug-print-length'
3603 `edebug-print-level'
3604 `edebug-print-circle'
3605 `edebug-on-error'
3606 `edebug-on-quit'
3607 `edebug-on-signal'
3608 `edebug-unwrap-results'
3609 `edebug-global-break-condition'"
3611 :keymap edebug-mode-map
3612 ;; If the user kills the buffer in which edebug is currently active,
3613 ;; exit to top level, because the edebug command loop can't usefully
3614 ;; continue running in such a case.
3615 ;;
3627 edebug--mode-saved-vars)
3629 ;; Append `edebug-kill-buffer' to the hook to avoid interfering with
3630 ;; other entries that are unguarded against deleted buffer.
3634 "Used on `kill-buffer-hook' when Edebug is operating in a buffer of Lisp code."
3637 ;;; edebug eval list mode
3639 ;; A list of expressions and their evaluations is displayed in *edebug*.
3642 "Return a list of evaluations of `edebug-eval-list'."
3643 ;; Assumes in outside environment.
3644 ;; Don't do any edebug things now.
3650 ;; Assumes edebug-eval-buffer exists.
3661 ))
3668 ;; Should generalize this to be callable outside of edebug
3669 ;; with calls in user functions, e.g. (edebug-eval-display)
3672 "Display expressions and evaluations in EVAL-RESULT-LIST.
3673 It modifies the context by popping up the eval display."
3679 "Redisplay eval list in outside environment.
3680 May only be called from within `edebug--recursive-edit'."
3684 ))
3694 "Replace the evaluation list with the sexps now in the eval buffer."
3697 new-list)
3699 ;; get the first expression
3721 "Delete the item under point and redisplay."
3722 ;; could add arg to do repeatedly
3742 map)
3748 "Mode for evaluation list buffer while in Edebug.
3750 In addition to all Interactive Emacs Lisp commands there are local and
3751 global key bindings to several Edebug specific commands. E.g.
3755 Eval list buffer commands:
3758 Global commands prefixed by `global-edebug-prefix':
3761 ;;; Interface with standard debugger.
3763 ;; (setq debugger 'edebug) ; to use the edebug debugger
3764 ;; (setq debugger 'debug) ; use the standard debugger
3766 ;; Note that debug and its utilities must be byte-compiled to work,
3767 ;; since they depend on the backtrace looking a certain way. But
3768 ;; edebug is not dependent on this, yet.
3771 "Replacement for `debug'.
3772 If we are running an edebugged function, show where we last were.
3773 Otherwise call `debug' normally."
3774 ;;(message "entered: %s depth: %s edebug-recursion-depth: %s"
3775 ;; edebug-entered (recursion-depth) edebug-recursion-depth) (sit-for 1)
3781 ;; Bind variables required by edebug--display.
3782 edebug-breakpoints
3783 edebug-break-data
3784 edebug-break-condition
3785 edebug-global-break
3787 )
3790 nil
3791 value))
3793 ;; Otherwise call debug normally.
3794 ;; Still need to remove extraneous edebug calls from stack.
3796 ))
3800 "Display a non-working backtrace. Better than nothing..."
3806 ;; Else, could just display edebug-backtrace-buffer.
3807 )
3812 last-ok-point)
3815 ;; Clean up the backtrace.
3816 ;; Not quite right for current edebug scheme.
3823 ;; Delete interspersed edebug internals.
3828 ;; Previous lines may contain code, so just delete this line.
3836 )))
3837 )))))
3839 \f
3840 ;;; Trace display
3843 "In buffer BUF-NAME, display FMT and ARGS at the end and make it visible.
3844 The buffer is created if it does not exist.
3845 You must include newlines in FMT to break lines, but one newline is appended."
3846 ;; e.g.
3847 ;; (edebug-trace-display "*trace-point*"
3848 ;; "saving: point = %s window-start = %s"
3849 ;; (point) (window-start))
3853 buf-window)
3854 ;; (message "before pop-to-buffer") (sit-for 1)
3860 ;; Make it visible.
3864 ;; (set-window-point buf-window (point))
3865 ;; (sit-for 0)
3869 buf-name)
3873 "Convenience call to `edebug-trace-display' using `edebug-trace-buffer'."
3876 \f
3877 ;;; Frequency count and coverage
3879 ;; FIXME should this use overlays instead?
3880 ;; Definitely, IMO. The current business with undo in
3881 ;; edebug-temp-display-freq-count is horrid.
3883 "Display the frequency count data for each line of the current definition.
3884 The frequency counts are inserted as comment lines after each line,
3885 and you can undo all insertions with one `undo' command.
3887 The counts are inserted starting under the `(' before an expression
3888 or the `)' after an expression, or on the last char of a symbol.
3889 The counts are only displayed when they differ from previous counts on
3890 the same line.
3892 If coverage is being tested, whenever all known results of an expression
3893 are `eq', the char `=' will be appended after the count
3894 for that expression. Note that this is always the case for an
3895 expression only evaluated once.
3897 To clear the frequency count and coverage data for a definition,
3898 reinstrument it."
3912 )
3914 ;; Traverse in reverse order so offsets are correct.
3916 ;; Start at last expression in line.
3920 last-index i)
3922 ;; Find all indexes on same line.
3925 ;; Insert all the indices for this line.
3928 first-index i ; Really, last index for line above this one.
3931 ;; i == first-index still
3951 ;; FIXME this does not work very well. Eg if you press an arrow key,
3952 ;; or make a mouse-click, it fails with "Non-character input-event".
3954 "Temporarily display the frequency count data for the current definition.
3955 It is removed when you hit any char."
3956 ;; This seems not to work with Emacs 18.59. It undoes too far.
3963 ;; Yuck! This doesn't seem to work at all for me.
3966 \f
3967 ;;; Menus
3973 ;; We have to require easymenu (even for Emacs 18) just so
3974 ;; the easy-menu-define macro call is compiled correctly.
3988 "----"
3993 "----"
4025 "----"
4035 ))
4038 \f
4039 ;;; Emacs version specific code
4047 "Set a conditional breakpoint at nearest sexp.
4048 The condition is evaluated in the outside context.
4049 With prefix argument, make it a temporary breakpoint."
4050 ;; (interactive "P\nxCondition: ")
4053 current-prefix-arg
4054 ;; Read condition as follows; getting previous condition is cumbersome:
4066 "Condition: " initial read-expression-map t
4073 \f
4074 ;;; Autoloading of Edebug accessories
4076 ;; edebug-cl-read and cl-read are available from liberte@cs.uiuc.edu
4082 ;; The following causes edebug-cl-read to be loaded when you load cl-read.el.
4085 \f
4086 ;;; Finalize Loading
4088 ;; When edebugging a function, some of the sub-expressions are
4089 ;; wrapped in (edebug-enter (lambda () ..)), so we need to teach
4090 ;; called-interactively-p that calls within the inner lambda should refer to
4091 ;; the outside function.
4098 ;; `edebug-enter' calls itself on its first invocation.
4103 ;; Finally, hook edebug into the rest of Emacs.
4104 ;; There are probably some other things that could go here.
4106 ;; Install edebug read and eval functions.
4110 "Unload the Edebug source level debugger."
4115 ;; We still want to run unload-feature to completion
4121 ;; Continue standard unloading.
4122 nil)
4125 ;;; edebug.el ends here