| blob | eb06c6128a7b7a938abca69c07020c0de1a49fcf |
1 ;;; edebug.el --- a source-level debugger for Emacs Lisp
3 ;; Copyright (C) 1988, 89, 90, 91, 92, 93, 94, 95, 97, 1999, 2000, 2001
4 ;; Free Software Foundation, Inc.
6 ;; Author: Daniel LaLiberte <liberte@holonexus.org>
7 ;; Maintainer: FSF
8 ;; Keywords: lisp, tools, maint
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; This minor mode allows programmers to step through Emacs Lisp
30 ;; source code while executing functions. You can also set
31 ;; breakpoints, trace (stopping at each expression), evaluate
32 ;; expressions as if outside Edebug, reevaluate and display a list of
33 ;; expressions, trap errors normally caught by debug, and display a
34 ;; debug style backtrace.
36 ;;; Minimal Instructions
37 ;; =====================
39 ;; First evaluate a defun with C-M-x, then run the function. Step
40 ;; through the code with SPC, mark breakpoints with b, go until a
41 ;; breakpoint is reached with g, and quit execution with q. Use the
42 ;; "?" command in edebug to describe other commands.
43 ;; See the Emacs Lisp Reference Manual for more details.
45 ;; If you wish to change the default edebug global command prefix, change:
46 ;; (setq edebug-global-prefix "\C-xX")
48 ;; Edebug was written by
49 ;; Daniel LaLiberte
50 ;; GTE Labs
51 ;; 40 Sylvan Rd
52 ;; Waltham, MA 02254
53 ;; liberte@holonexus.org
55 ;;; Code:
57 ;;; Bug reporting
61 ;;; Options
64 "A source-level debugger for Emacs Lisp"
69 "*Functions to call before edebug is used.
70 Each time it is set to a new value, Edebug will call those functions
71 once and then `edebug-setup-hook' is reset to nil. You could use this
72 to load up Edebug specifications associated with a package you are
73 using but only when you also use Edebug."
77 ;; edebug-all-defs and edebug-all-forms need to be autoloaded
78 ;; because the byte compiler binds them; as a result, if edebug
79 ;; is first loaded for a require in a compilation, they will be left unbound.
81 ;;;###autoload
83 "*If non-nil, evaluation of any defining forms will instrument for Edebug.
84 This applies to `eval-defun', `eval-region', `eval-buffer', and
85 `eval-current-buffer'. `eval-region' is also called by
86 `eval-last-sexp', and `eval-print-last-sexp'.
88 You can use the command `edebug-all-defs' to toggle the value of this
89 variable. You may wish to make it local to each buffer with
90 \(make-local-variable 'edebug-all-defs) in your
91 `emacs-lisp-mode-hook'."
95 ;; edebug-all-defs and edebug-all-forms need to be autoloaded
96 ;; because the byte compiler binds them; as a result, if edebug
97 ;; is first loaded for a require in a compilation, they will be left unbound.
99 ;;;###autoload
101 "*Non-nil evaluation of all forms will instrument for Edebug.
102 This doesn't apply to loading or evaluations in the minibuffer.
103 Use the command `edebug-all-forms' to toggle the value of this option."
108 "*Non-nil means all macro call arguments may be evaluated.
109 If this variable is nil, the default, Edebug will *not* wrap
110 macro call arguments as if they will be evaluated.
111 For each macro, a `edebug-form-spec' overrides this option.
112 So to specify exceptions for macros that have some arguments evaluated
113 and some not, you should specify an `edebug-form-spec'."
118 "*If non-nil, Edebug saves and restores the window configuration.
119 That takes some time, so if your program does not care what happens to
120 the window configurations, it is better to set this variable to nil.
122 If the value is a list, only the listed windows are saved and
123 restored.
125 `edebug-toggle-save-windows' may be used to change this variable."
130 "*If non-nil, save and restore point in all displayed buffers.
132 Saving and restoring point in other buffers is necessary if you are
133 debugging code that changes the point of a buffer which is displayed
134 in a non-selected window. If Edebug or the user then selects the
135 window, the buffer's point will be changed to the window's point.
137 Saving and restoring point in all buffers is expensive, since it
138 requires selecting each window twice, so enable this only if you need
139 it."
144 "*Initial execution mode for Edebug, if non-nil. If this variable
145 is non-@code{nil}, it specifies the initial execution mode for Edebug
146 when it is first activated. Possible values are step, next, go,
147 Go-nonstop, trace, Trace-fast, continue, and Continue-fast."
155 "*Non-nil means display a trace of function entry and exit.
156 Tracing output is displayed in a buffer named `*edebug-trace*', one
157 function entry or exit per line, indented by the recursion level.
159 You can customize by replacing functions `edebug-print-trace-before'
160 and `edebug-print-trace-after'."
165 "*If non-nil, Edebug tests coverage of all expressions debugged.
166 This is done by comparing the result of each expression
167 with the previous result. Coverage is considered OK if two different
168 results are found.
170 Use `edebug-display-freq-count' to display the frequency count and
171 coverage information for a definition."
176 "*If non-nil, continue defining or executing any keyboard macro.
177 Use this with caution since it is not debugged."
183 "*Default value of `print-length' to use while printing results in Edebug."
187 "*Default value of `print-level' to use while printing results in Edebug."
191 "*Default value of `print-circle' to use while printing results in Edebug."
196 "*Non-nil if Edebug should unwrap results of expressions.
197 This is useful when debugging macros where the results of expressions
198 are instrumented expressions. But don't do this when results might be
199 circular or an infinite loop will result."
204 "*Value bound to `debug-on-error' while Edebug is active.
206 If `debug-on-error' is non-nil, that value is still used.
208 If the value is a list of signal names, Edebug will stop when any of
209 these errors are signaled from Lisp code whether or not the signal is
210 handled by a `condition-case'. This option is useful for debugging
211 signals that *are* handled since they would otherwise be missed.
212 After execution is resumed, the error is signaled again."
221 "*Value bound to `debug-on-quit' while Edebug is active."
226 "*If non-nil, an expression to test for at every stop point.
227 If the result is non-nil, then break. Errors are ignored."
232 "*Number of seconds to pause when execution mode is `trace'."
236 ;;; Form spec utilities.
238 ;;;###autoload
240 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
241 Both SYMBOL and SPEC are unevaluated. The SPEC can be 0, t, a symbol
242 \(naming a function), or a list."
246 "For compatibility with old version. Use `def-edebug-spec' instead."
251 ;; Get the spec of symbol resolving all indirection.
253 indirect)
256 ;; (edebug-trace "indirection: %s" edebug-form-spec)
258 edebug-form-spec
259 ))
261 ;;; Utilities
263 ;; Define edebug-gensym - from old cl.el
268 "Generate a fresh uninterned symbol.
269 There is an optional argument, PREFIX. PREFIX is the
270 string that begins the new name. Most people take just the default,
271 except when debugging needs suggest otherwise."
281 newsymbol))
284 "Return t if OBJECT is a lambda list keyword.
285 A lambda list keyword is a symbol that starts with `&'."
291 ;; Return the last sexp before point in current buffer.
292 ;; Assumes Emacs Lisp syntax is active.
302 "Return a list of windows, in order of `next-window'."
303 ;; This doesn't work for epoch.
308 ;; Not used.
310 "Return t if there are two windows."
318 object)
321 "Return the macro named by OBJECT, or nil if it is not a macro."
326 object))
329 "Returns the function named by OBJECT, or nil if it is not a function."
336 object))
339 ;; Return the ALIST sorted with comparison function FUNCTION.
340 ;; This uses 'sort so the sorting is destructive.
345 ;;(def-edebug-spec edebug-save-restriction t)
347 ;; Not used. If it is used, def-edebug-spec must be defined before use.
349 "Evaluate BODY while saving the current buffers restriction.
350 BODY may change buffer outside of current restriction, unlike
351 save-restriction. BODY may change the current buffer,
352 and the restriction will be restored to the original buffer,
353 and the current buffer remains current.
354 Return the result of the last expression in BODY."
363 ;;; Display
369 ;; Like pop-to-buffer, but select window where BUFFER was last shown.
370 ;; Select WINDOW if it provided and it still exists. Otherwise,
371 ;; if buffer is currently shown in several windows, choose one.
372 ;; Otherwise, find a new window, possibly splitting one.
375 window
383 ;; (message "next window: %s" (next-window)) (sit-for 1)
385 ;; Don't select trace window
386 nil
390 ;; Selecting the window does not set the buffer until command loop.
391 ;;(set-buffer buffer)
392 )
396 ;; Return a list of buffer point pairs, for all displayed buffers.
402 list)))))
403 list))
407 ;; Restore the buffer-points created by edebug-get-displayed-buffer-points.
414 buffer-points)
418 ;; Get either a full window configuration or some window information.
427 which-windows)
431 ;; Set either a full window configuration or some window information.
444 one-window-info))))
445 window-info)
453 ;;; Redefine read and eval functions
454 ;; read is redefined to maybe instrument forms.
455 ;; eval-defun is redefined to check edebug-all-forms and edebug-all-defs.
457 ;; Save the original read function
462 "Read one Lisp expression as text from STREAM, return as Lisp object.
463 If STREAM is nil, use the value of `standard-input' (which see).
464 STREAM or the value of `standard-input' may be:
465 a buffer (read from point and advance it)
466 a marker (read from where it points and advance it)
467 a function (call it with no arguments for each character,
468 call it with a char as argument to push a char back)
469 a string (takes text from string, starting at the beginning)
470 t (read text line using minibuffer and use it).
472 This version, from Edebug, maybe instruments the expression. But the
473 STREAM must be the current buffer to do so. Whether it instruments is
474 also dependent on the values of `edebug-all-defs' and
475 `edebug-all-forms'."
484 ;; We should somehow arrange to be able to do this
485 ;; without actually replacing the eval-defun command.
487 "Evaluate the top-level form containing point, or after point.
489 If the current defun is actually a call to `defvar', then reset the
490 variable using its initial value expression even if the variable
491 already has some other value. (Normally `defvar' does not change the
492 variable's value if it already has a value.)
494 With a prefix argument, instrument the code for Edebug.
496 Setting `edebug-all-defs' to a non-nil value reverses the meaning of
497 the prefix argument. Code is then instrumented when this function is
498 invoked without a prefix argument
500 If acting on a `defun' for FUNCTION, and the function was
501 instrumented, `Edebug: FUNCTION' is printed in the minibuffer. If not
502 instrumented, just FUNCTION is printed.
504 If not acting on a `defun', the result of evaluation is displayed in
505 the minibuffer."
513 ;; This should be consistent with `eval-defun-1', but not the
514 ;; same, since that gets a macroexpended form.
517 ;; Force variable to be bound.
521 ;; Force variable to be bound.
526 edebug-result)))
529 ;;;###autoload
532 ;;;###autoload
534 "Evaluate a top level form, such as a defun or defmacro.
535 This is like `eval-defun', but the code is always instrumented for Edebug.
536 Print its name in the minibuffer and leave point where it is,
537 or if an error occurs, leave point after it with mark at the original point."
540 ;; Bind edebug-all-forms only while reading, not while evalling
541 ;; but this causes problems while edebugging edebug.
553 ;; Recover point, but only if no error occurred.
557 ;; Compatibility with old versions.
561 "Toggle edebugging of all definitions."
569 "Toggle edebugging of all forms."
578 ;; Don't install if already installed.
589 ;;; Edebug internal data
591 ;; The internal data that is needed for edebugging is kept in the
592 ;; buffer-local variable `edebug-form-data'.
597 ;; A list of entries associating symbols with buffer regions.
598 ;; This is an automatic buffer local variable. Each entry looks like:
599 ;; @code{(@var{symbol} @var{begin-marker} @var{end-marker}). The markers
600 ;; are at the beginning and end of an entry level form and @var{symbol} is
601 ;; a symbol that holds all edebug related information for the form on its
602 ;; property list.
604 ;; In the future, the symbol will be irrelevant and edebug data will
605 ;; be stored in the definitions themselves rather than in the property
606 ;; list of a symbol.
626 ;; Find the edebug form data entry which is closest to PNT.
627 ;; If END-POINT is supplied, match must be exact.
628 ;; Return `nil' if none found.
630 closest-entry
643 closest-entry entry))))
644 closest-entry))
646 ;; Also need to find all contained entries,
647 ;; and find an entry given a symbol, which should be just assq.
650 ;; Return the edebug data symbol of the form where point is in.
651 ;; If point is not inside a edebuggable form, cause error.
656 ;; Make NEW-ENTRY the first element in the `edebug-form-data' list.
661 ;; If non-nil, clear ENTRY out of the form data.
662 ;; Maybe clear the markers and delete the symbol's edebug property?
665 ;; Instead of this, we could just find all contained forms.
666 ;; (put (car entry) 'edebug nil) ;
667 ;; (mapcar 'edebug-clear-form-data-entry ; dangerous
668 ;; (get (car entry) 'edebug-dependents))
669 ;; (set-marker (nth 1 entry) nil)
670 ;; (set-marker (nth 2 entry) nil)
673 ;;; Parser utilities
676 ;; Signal an invalid-read-syntax with ARGS.
681 ;; Lookup table for significant characters indicating the class of the
682 ;; token that follows. This is not a \"real\" syntax table.
699 ;; We treat numbers as symbols, because of confusion with -, -1, and 1-.
700 ;; We don't care about any other chars since they won't be seen.
701 table))
704 ;; Move to the next token and return its class. We only care about
705 ;; lparen, rparen, dot, quote, backquote, comma, string, char, vector,
706 ;; or symbol.
713 'symbol
718 ;; Leave point before the next token, skipping white space and comments.
721 ;; \r is counted as a comment terminator to support selective display.
726 ;; Mostly obsolete reader; still used in one case.
729 ;; Read one sexp from the current buffer starting at point.
730 ;; Leave point immediately after it. A sexp can be a list or atom.
731 ;; An atom is a symbol (or number), character, string, or vector.
732 ;; This works for reading anything legitimate, but it
733 ;; is gummed up by parser inconsistencies (bugs?)
736 ;; read goes one too far if a (possibly quoted) string or symbol
737 ;; is immediately followed by non-whitespace.
749 ;;; Offsets for reader
751 ;; Define a structure to represent offset positions of expressions.
752 ;; Each offset structure looks like: (before . after) for constituents,
753 ;; or for structures that have elements: (before <subexpressions> . after)
754 ;; where the <subexpressions> are the offset structures for subexpressions
755 ;; including the head of a list.
758 ;; Stack of offset structures in reverse order of the nesting.
759 ;; This is used to get back to previous levels.
763 ;; We must store whether we just read a list with a dotted form that
764 ;; is itself a list. This structure will be condensed, so the offsets
765 ;; must also be condensed.
769 ;; Reinitialize offset recording.
773 ;; Add a new offset pair with POINT as the before offset.
778 ;; Otherwise, we are at the top level, so initialize.
780 edebug-offsets-stack nil
781 edebug-read-dotted-list nil))
782 ;; Cons the new offset to the front of the stack.
784 edebug-current-offset new-offset)
785 ))
788 ;; Finalize the current offset struct by reversing it and
789 ;; store POINT as the after offset.
791 ;; Just reverse the offsets of all subexpressions.
794 ;; We just read a list after a dot, which will be abbreviated out.
796 ;; Drop the corresponding offset pair.
797 ;; That is, nconc the reverse of the rest of the offsets
798 ;; with the cdr of last offset.
803 ;; Now append the point using nconc.
805 ;; Pop the stack.
810 ;; Ignore the last created offset pair.
824 ;;; Reader for Emacs Lisp.
826 ;; Uses edebug-next-token-class (and edebug-skip-whitespace) above.
837 ))
841 func
846 ;; anything else, just read it.
848 )))
857 ;; Turn 'thing into (quote thing)
864 ;; Turn `thing into (\` thing)
867 ;; Generate the same structure of offsets we would have
868 ;; if the resulting list appeared verbatim in the input text.
875 "Non-nil if reading the inside of a new-style backquote with no parens around it.
876 Value of nil means reading the inside of an old-style backquote construct
877 which is surrounded by an extra set of parentheses.
881 ;; Turn ,thing into (\, thing). Handle ,@ and ,. also.
891 ;; Generate the same structure of offsets we would have
892 ;; if the resulting list appeared verbatim in the input text.
900 ;; Turn #'thing into (function thing)
925 ;; Call edebug-storing-offsets here so that we
926 ;; produce the same offsets we would have had
927 ;; if the backquote were an ordinary symbol.
929 elements))))
940 ))
941 elements)
943 ))
953 ))
955 ;;; Cursors for traversal of list and vector elements with offsets.
960 ;; Return a new cursor for EXPRESSIONS with OFFSETS.
966 ;; Set the CURSOR's EXPRESSIONS and OFFSETS to the given.
967 ;; Return the cursor.
970 cursor)
973 ;; Copy the cursor using the same object and offsets.
982 ;; Return non-nil if CURSOR is empty - meaning no more elements.
986 ;; Return the top element at the cursor.
987 ;; Assumes not empty.
991 ;; Check if a dotted form is required.
993 ;; Check if there is at least one more argument.
995 ;; Return that top element.
999 ;; Return the top offset pair corresponding to the top element.
1003 ;; Advance and return the cursor to the next element and offset.
1004 ;; throw no-match if empty before moving.
1005 ;; This is a violation of the cursor encapsulation, but
1006 ;; there is plenty of that going on while matching.
1007 ;; The following test should always fail.
1012 cursor)
1016 ;; Return the before offset of the cursor.
1017 ;; If there is nothing left in the offsets,
1018 ;; return one less than the offset itself,
1019 ;; which is the after offset for a list.
1026 ;; Return the after offset of the cursor object.
1030 offset))
1032 ;;; The Parser
1034 ;; The top level function for parsing forms is
1035 ;; edebug-read-and-maybe-wrap-form; it calls all the rest. It checks the
1036 ;; syntax a bit and leaves point at any error it finds, but otherwise
1037 ;; should appear to work like eval-defun.
1039 ;; The basic plan is to surround each expression with a call to
1040 ;; the edebug debugger together with indexes into a table of positions of
1041 ;; all expressions. Thus an expression "exp" becomes:
1043 ;; (edebug-after (edebug-before 1) 2 exp)
1045 ;; When this is evaluated, first point is moved to the beginning of
1046 ;; exp at offset 1 of the current function. The expression is
1047 ;; evaluated, which may cause more edebug calls, and then point is
1048 ;; moved to offset 2 after the end of exp.
1050 ;; The highest level expressions of the function are wrapped in a call to
1051 ;; edebug-enter, which supplies the function name and the actual
1052 ;; arguments to the function. See functions edebug-enter, edebug-before,
1053 ;; and edebug-after for more details.
1055 ;; Dynamically bound vars, left unbound, but globally declared.
1056 ;; This is to quiet the byte compiler.
1058 ;; Window data of the highest definition being wrapped.
1059 ;; This data is shared by all embedded definitions.
1074 ;; Read a form and wrap it with edebug calls, if the conditions are right.
1075 ;; Here we just catch any no-match not caught below and signal an error.
1077 ;; Run the setup hook.
1078 ;; If it gets an error, make it nil.
1084 edebug-top-window-data
1085 edebug-def-name;; make sure it is locally nil
1086 ;; I don't like these here!!
1087 edebug-&optional
1088 edebug-&rest
1089 edebug-gate
1090 edebug-best-error
1091 edebug-error-point
1092 no-match
1093 ;; Do this once here instead of several times.
1099 nil))
1102 result))
1107 def-kind
1108 defining-form-p
1109 def-name
1110 ;; These offset things don't belong here, but to support recursive
1111 ;; calls to edebug-read, they need to be here.
1112 edebug-offsets
1113 edebug-offsets-stack
1114 edebug-current-offset ; reset to nil
1115 )
1119 ;; Find out if this is a defining form from first symbol
1124 ;; This is incorrect in general!! But OK most of the time.
1129 ;;;(message "all defs: %s all forms: %s" edebug-all-defs edebug-all-forms)
1133 ;; If it is a defining form and we are edebugging defs,
1134 ;; then let edebug-list-form start it.
1140 cursor
1145 ;; Not edebugging this form, so reset the symbol's edebug
1146 ;; property to be just a marker at the definition's source code.
1147 ;; This only works for defs with simple names.
1149 ;; Also nil out dependent defs.
1156 ;; If all forms are being edebugged, explicitly wrap it.
1162 cursor
1165 nil)))
1167 ;; Not a defining form, and not edebugging.
1169 ))
1175 ;; Currently def-form sets this to nil; def-body sets it to t.
1178 ;; Return a unique symbol for the variable used to store the
1179 ;; status of interactive-p for this function.
1184 "Wrap the FORMS of a definition body."
1193 ;; Generate the enter wrapper for some forms of a definition.
1194 ;; This is not to be used for the body of other forms, e.g. `while',
1195 ;; since it wraps the list of forms with a call to `edebug-enter'.
1196 ;; Uses the dynamically bound vars edebug-def-name and edebug-def-args.
1197 ;; Do this after parsing since that may find a name.
1204 ;; Doesn't work with more than one def-body!!
1205 ;; But the list will just be reversed.
1209 ))
1218 ;; modifies edebug-offset-index and edebug-offset-list
1219 ;; accesses edebug-func-marc and buffer point
1221 edebug-offset-index
1223 edebug-offset-list)
1228 ;; Return the edebug form for the current function at offset BEFORE-INDEX
1229 ;; given FORM. Looks like:
1230 ;; (edebug-after (edebug-before BEFORE-INDEX) AFTER-INDEX FORM)
1231 ;; Also increment the offset index for subsequent use.
1234 after-index form))
1237 ;; Like edebug-make-before-and-after-form, but only after.
1242 "Return the unwrapped SEXP or return it as is if it is not wrapped.
1243 The SEXP might be the result of wrapping a body, which is a list of
1244 expressions; a `progn' form will be returned enclosing these forms."
1255 )
1256 sexp))
1259 "Return the sexp recursively unwrapped."
1266 new-sexp)))
1270 ;; Process the defining form, starting outside the form.
1271 ;; The speclist is a generated list spec that looks like:
1272 ;; (("def-symbol" defining-form-spec-sans-&define))
1273 ;; Skip the first offset.
1277 cursor
1279 speclist))
1283 ;; Wrap a form, usually a defining form, but any evaluated one.
1284 ;; If speclist is non-nil, this is being called by edebug-defining-form.
1285 ;; Otherwise it is being called from edebug-read-and-maybe-wrap-form1.
1286 ;; This is a hack, but I havent figured out a simpler way yet.
1288 ;; Set this marker before parsing.
1292 ;; Buffer must be current-buffer for this to work:
1297 result
1298 ;; For definitions.
1299 ;; (edebug-containing-def-name edebug-def-name)
1300 ;; Get name from form-data, if any.
1302 edebug-def-name
1303 edebug-def-args
1304 edebug-def-interactive
1305 edebug-inside-func;; whether wrapped code executes inside a function.
1306 )
1312 ;; else wrap as an enter-form.
1315 ;; Set the name here if it was not set by edebug-make-enter-wrapper.
1319 ;; Add this def as a dependent of containing def. Buggy.
1327 ;; Create a form-data-entry or modify existing entry's markers.
1328 ;; In the latter case, pointers to the entry remain eq.
1332 edebug-def-name
1333 edebug-form-begin-marker
1334 ;; Buffer must be current-buffer.
1336 ))
1338 form-data-entry edebug-def-name ;; in case name is changed
1339 form-begin form-end))
1341 ;; (message "defining: %s" edebug-def-name) (sit-for 2)
1344 ;;(debug edebug-def-name)
1346 ;; Destructively reverse edebug-offset-list and make vector from it.
1349 ;; Side effects on the property list of edebug-def-name.
1353 ;; Set up the initial window data.
1361 ;; Store the edebug data in symbol's property list.
1363 ;; A struct or vector would be better here!!
1365 nil ; clear breakpoints
1366 edebug-offset-list
1367 edebug-top-window-data
1368 ))
1369 result
1370 )))
1374 ;; Create initial frequency count vector.
1375 ;; For each stop point, the counter is incremented each time it is visited.
1381 ;; Create initial coverage vector.
1382 ;; Only need one per expression, but it is simpler to use stop points.
1388 ;; Return the instrumented form for the following form.
1389 ;; Add the point offsets to the edebug-offset-list for the form.
1395 ;; The first offset for a list form is for the list form itself.
1397 form
1401 ;; Find out if this is a defining form from first symbol.
1402 ;; An indirect spec would not work here, yet.
1405 new-cursor
1409 ;; Wrap a regular form.
1413 ;; After processing the list form, the new-cursor is left
1414 ;; with the offset after the form.
1416 )))
1420 ;; Check for constant symbols that don't get wrapped.
1423 form)
1428 ;; Anything else is self-evaluating.
1437 ;; Process the arguments of a list form given that head of form is a symbol.
1438 ;; Helper for edebug-list-form
1444 ;; It is a speclist.
1451 ; but leave it in for compatibility.
1452 ))
1453 ;; No edebug-form-spec provided.
1463 ;; Return an instrumented form built from the list form.
1464 ;; The after offset will be left in the cursor after processing the form.
1466 ;; Prevent backtracking whenever instrumenting.
1468 ;; A list form is never optional because it matches anything.
1471 ;; Skip the first offset.
1482 ;; Special case: replace (interactive-p) with variable
1493 ;; Process anonymous function and args.
1494 ;; This assumes no anonymous macros.
1499 ))
1501 ;;; Matching of specs.
1509 ;;; Failure to match
1511 ;; This throws to no-match, if there are higher alternatives.
1512 ;; Otherwise it signals an error. The place of the error is found
1513 ;; with the two before- and after-offset functions.
1516 ;; Throw a no-match, or signal an error immediately if gate is active.
1517 ;; Remember this point in case we need to report this error.
1530 ;; Top level spec matching function.
1531 ;; Used also at each lower level of specs.
1533 edebug-&rest
1534 edebug-best-error
1535 edebug-error-point
1537 )
1542 ;; Match one spec, which is not a keyword &-spec.
1548 ))
1552 ;; Append results of matching the list of specs.
1553 ;; The first spec is handled and the remainder-handler handles the rest.
1561 ;; Is the spec dotted?
1566 ;; Is the form dotted?
1570 ;; Cancel dotted spec and dotted form.
1574 ;; Wrap the form in a list, (by changing the cursor??)...
1576 ;; and process normally, then unwrap the result.
1583 ;;(message "spec = %s first char = %s" spec first-char) (sit-for 1)
1597 ;; Define specs for all the symbol specs with functions used to process them.
1598 ;; Perhaps we shouldn't be doing this with edebug-form-specs since the
1599 ;; user may want to define macros or functions with the same names.
1600 ;; We could use an internal obarray for these primitive specs.
1614 ;; Less frequently used:
1615 ;; (function . edebug-match-function)
1621 ;; (nil . edebug-match-nil) not this one - special case it.
1622 ))
1626 ;; Match a symbol spec.
1631 ;; It is an indirect spec.
1633 ;; Otherwise it should be the symbol name of a function.
1634 ;; There could be a bug here - maybe need to do edebug-match bindings.
1642 ;; Special case for edebug-`.
1650 )))
1661 ;; Currently identical to edebug-match-form.
1662 ;; This is for common lisp setf-style place arguments.
1667 ;; Keep matching until one spec fails.
1679 ;; Returning nil means no no-match was thrown.
1680 nil))
1681 result
1682 ;; no-match, but don't fail; just reset cursor and return nil.
1684 nil)))
1689 ;; Reuse the &optional handler with this as the remainder handler.
1693 ;; Repeatedly use specs until failure.
1695 edebug-best-error
1696 edebug-error-point)
1701 ;; Keep matching until one spec succeeds, and return its results.
1702 ;; If none match, fail.
1703 ;; This needs to be optimized since most specs spend time here.
1712 edebug-best-error
1713 edebug-error-point)
1714 ;; Doesn't support e.g. &or symbolp &rest form
1716 ;; Match failed, so reset and try again.
1718 ;; Reset the cursor for the next match.
1720 ;; All failed.
1722 ))
1726 ;; If any specs match, then fail
1731 nil))
1732 ;; This means something matched, so it is a no match.
1734 ;; This means nothing matched, so it is OK.
1741 ;; Following specs must look like (<name> <spec>) ...
1742 ;; where <name> is the name of a keyword, and spec is its spec.
1743 ;; This really doesn't save much over the expanded form and takes time.
1745 cursor
1750 specs))))
1754 ;; Simply set the gate to prevent backtracking at this level.
1756 nil)
1760 ;; The spec is a list, but what kind of list, and what context?
1762 ;; After dotted spec but form did not contain dot,
1763 ;; so match list spec elements as if spliced in.
1767 ;; If it matched, really clear the dotted-spec flag.
1776 ;; Special case: spec quotes a symbol to match.
1777 ;; Change in future. Use "..." instead.
1782 form)
1789 ;; First offset is for the list form itself.
1790 ;; Treat nil as empty list.
1792 specs))
1796 ;; Special case: match a vector with the specs.
1805 )))
1809 ;; Match a sublist of specs.
1811 ;;edebug-best-error
1812 ;;edebug-error-point
1813 )
1815 ;; match with edebug-match-specs so edebug-best-error is not bound.
1820 ;; A failed &rest or &optional spec may leave some args.
1822 )))))
1829 ;; Since it matched, failure means immediate error, unless &optional.
1833 )))
1836 ;; There must be nothing left to match a nil.
1839 nil))
1846 ;; Match a defining form.
1847 ;; Normally, &define is interpreted specially other places.
1848 ;; This should only be called inside of a spec list to match the remainder
1849 ;; of the current list. e.g. ("lambda" &define args def-body)
1851 cursor
1853 ;; Find the last offset in the list.
1856 offsets)
1857 specs))
1860 ;; The expression must be a function.
1861 ;; This will match any list form that begins with a symbol
1862 ;; that has an edebug-form-spec beginning with &define. In
1863 ;; practice, only lambda expressions should be used.
1864 ;; I could add a &lambda specification to avoid confusion.
1871 ;; Find out if this is a defining form from first symbol.
1882 )))
1886 ;; Set the edebug-def-name bound in edebug-defining-form.
1888 ;; Maybe strings and numbers could be used.
1893 ;; Construct a new name by appending to previous name.
1895 name))
1900 ;; Set the edebug-def-name to the spec.
1903 ;; Construct a new name by appending to previous name.
1905 spec))
1906 nil)
1909 ;; set the def-args bound in edebug-defining-form
1919 ;; Like form but the form is wrapped in edebug-enter form.
1920 ;; The form is assumed to be executing outside of the function context.
1921 ;; This is a hack for now, since a def-form might execute inside as well.
1922 ;; Not to be used otherwise.
1927 ;; Like body but body is wrapped in edebug-enter form.
1928 ;; The body is assumed to be executing inside of the function context.
1929 ;; Not to be used otherwise.
1934 ;;;; Edebug Form Specs
1935 ;;; ==========================================================
1936 ;;; See cl-specs.el for common lisp specs.
1938 ;;;;* Spec for def-edebug-spec
1939 ;;; Out of date.
1942 "Return non-nil if OBJECT is a symbol with an edebug-form-spec property."
1947 ;; Top level is different from lower levels.
1952 ;; A list must have something in it, or it is nil, a symbolp
1956 (&or
1960 edebug-spec-list
1961 stringp
1964 edebug-spec-p ;; Including all the special ones e.g. form.
1965 symbolp;; a predicate
1966 ))
1969 ;;;* Emacs special forms and some functions.
1971 ;; quote expects only one argument, although it allows any number.
1974 ;; The standard defining forms.
1979 (&define name lambda-list
1982 def-body))
1988 (&define name stringp
1991 def-body))
1992 ;; This plain doesn't work ;-( -sm
1993 ;; (def-edebug-spec define-skeleton
1994 ;; (&define name stringp def-body))
2002 )))
2007 ;; A function-form is for an argument that may be a function or a form.
2008 ;; This specially recognizes anonymous functions quoted with quote.
2010 ;; form at the end could also handle "function",
2011 ;; but recognize it specially to avoid wrapping function forms.
2014 ;; function expects a symbol or a lambda or macro expression
2015 ;; A macro is allowed by Emacs.
2018 ;; lambda is a macro in emacs 19.
2022 def-body))
2024 ;; A macro expression is a lambda expression with "macro" prepended.
2027 ;; (def-edebug-spec anonymous-form ((&or ["lambda" lambda] ["macro" macro])))
2029 ;; Standard functions that take function-forms arguments.
2038 body))
2049 form
2055 ;; Supports quotes inside backquotes,
2056 ;; but only at the top level inside unquotes.
2058 (&or
2061 ;; If you use dotted forms in backquotes, replace the previous line
2062 ;; with the following. This takes quite a bit more stack space, however.
2063 ;; (backquote-form . [&or nil backquote-form])
2065 sexp))
2067 ;; Special version of backquote that instruments backquoted forms
2068 ;; destined to be evaluated, usually as the result of a
2069 ;; macroexpansion. Backquoted code can only have unquotes (, and ,@)
2070 ;; in places where list forms are allowed, and predicates. If the
2071 ;; backquote is used in a macro, unquoted code that come from
2072 ;; arguments must be instrumented, if at all, with def-form not def-body.
2074 ;; We could assume that all forms (not nested in other forms)
2075 ;; in arguments of macros should be def-forms, whether or not the macros
2076 ;; are defined with edebug-` but this would be expensive.
2078 ;; ,@ might have some problems.
2083 ;; Assume immediate quote in unquotes mean backquote at next higher level.
2088 ;; New byte compiler.
2112 ;; Anything else?
2115 ;; Some miscellaneous specs for macros in public packages.
2116 ;; Send me yours.
2118 ;; advice.el by Hans Chalupsky (hans@cs.buffalo.edu)
2124 ;; "activation" "deactivation"]
2125 name ;; name of advice
2127 )
2130 def-body))
2139 ;;; The debugger itself
2143 ;;; add minor-mode-alist entry
2146 minor-mode-alist)))
2149 ;; Stack of active functions evaluated via edebug.
2150 ;; Should be nil at the top level.
2153 ;; Index of last edebug-stack item.
2156 ;; Stack of offset indices of visited edebug sexps.
2157 ;; Should be nil at the top level.
2158 ;; Each function adds one cons. Top is modified with setcar.
2162 ;; Non-nil if edebug has already been entered at this recursive edit level.
2163 ;; This should stay nil at the top level.
2164 )
2166 ;; Should these be options?
2168 ;; Name of function to use for debugging when error or quit occurs.
2169 ;; Set this to 'debug if you want to debug edebug.
2170 )
2173 ;; Dynamically bound variables, declared globally but left unbound.
2202 ;;; Handling signals
2205 "Signal an error. Args are SIGNAL-NAME, and associated DATA.
2206 A signal name is a symbol with an `error-conditions' property
2207 that is a list of condition names.
2208 A handler for any of those names will get to handle this signal.
2209 The symbol `error' should always be one of them.
2211 DATA should be a list. Its elements are printed as part of the error message.
2212 If the signal is handled, DATA is made available to the handler.
2213 See `condition-case'.
2215 This is the Edebug replacement for the standard `signal'. It should
2216 only be active while Edebug is. It checks `debug-on-error' to see
2217 whether it should call the debugger. When execution is resumed, the
2218 error is signaled again."
2221 ;; If we reach here without another non-local exit, then send signal again.
2222 ;; i.e. the signal is not continuable, yet.
2223 ;; Avoid infinite recursion.
2227 ;;; Entering Edebug
2230 ;; Entering FUNC. The arguments are ARGS, and the body is BODY.
2231 ;; Setup edebug variables and evaluate BODY. This function is called
2232 ;; when a function evaluated with edebug-eval-top-level-form is entered.
2233 ;; Return the result of BODY.
2235 ;; Is this the first time we are entering edebug since
2236 ;; lower-level recursive-edit command?
2237 ;; More precisely, this tests whether Edebug is currently active.
2240 ;; Binding max-lisp-eval-depth here is OK,
2241 ;; but not inside an unwind-protect.
2242 ;; Doing it here also keeps it from growing too large.
2249 ;; Binding these may not be the right thing to do.
2250 ;; We want to allow the global values to be changed.
2254 ;; Lexical bindings must be uncompiled for this to work.
2259 overriding-terminal-local-map)
2261 ;; Save the outside value of executing macro. (here??)
2267 ;; within edebug unless edebug-continue-kbd-macro is
2268 ;; non-nil. Again, local binding may not be best.
2272 ;; Don't get confused by the user's keymap changes.
2278 ;; Disable command hooks. This is essential when
2279 ;; a hook function is instrumented - to avoid infinite loop.
2280 ;; This may be more than we need, however.
2284 edebug-initial-mode
2285 edebug-execution-mode)
2286 edebug-next-execution-mode nil)
2288 ;; Reset global variables in case outside value was changed.
2290 pre-command-hook edebug-outside-pre-command-hook
2291 post-command-hook edebug-outside-post-command-hook
2292 )))
2302 )
2311 )))
2316 edebug-result)
2326 "Print MSG in *edebug-trace* before and after evaluating BODY.
2327 The result of BODY is also printed."
2329 edebug-result)
2336 "Function called to print trace info before expression evaluation.
2337 MSG is printed after `::::{ '."
2342 "Function called to print trace info after expression evaluation.
2343 MSG is printed after `::::} '."
2350 ;; Debug current function given BEFORE position.
2351 ;; Called from functions compiled with edebug-eval-top-level-form.
2352 ;; Return the before index.
2355 ;; Increment frequency count
2362 edebug-before-index)
2365 ;; Do nothing.
2366 )
2369 ;; Debug current function given AFTER position and VALUE.
2370 ;; Called from functions compiled with edebug-eval-top-level-form.
2371 ;; Return VALUE.
2374 ;; Increment frequency count
2381 ;; Just return result.
2382 edebug-value
2384 ))
2387 ;; Do nothing but return the value.
2388 edebug-value)
2394 ;; This is not used, yet.
2408 ;; Test if a different result.
2413 ;; Dynamically declared unbound variables.
2426 ;; Check breakpoints and pending input.
2427 ;; If edebug display should be updated, call edebug-display.
2428 ;; Return edebug-value.
2441 ;;; (edebug-trace "exp: %s" edebug-value)
2442 ;; Test whether we should break.
2451 ;; Delete the breakpoint.
2456 ;; Display if mode is not go, continue, or Continue-fast
2457 ;; or break, or input is pending,
2459 edebug-break
2463 edebug-value
2464 ))
2467 ;; window-start now stored with each function.
2468 ;;(defvar edebug-window-start nil)
2469 ;; Remember where each buffers' window starts between edebug calls.
2470 ;; This is to avoid spurious recentering.
2471 ;; Does this still need to be buffer-local??
2472 ;;(setq-default edebug-window-start nil)
2473 ;;(make-variable-buffer-local 'edebug-window-start)
2476 ;; Dynamically declared unbound vars
2492 ;; Emacs 19 adds an arg to mark and mark-marker.
2497 ;; Setup windows for edebug, determine mode, maybe enter recursive-edit.
2498 ;; Uses local variables of edebug-enter, edebug-before, edebug-after
2499 ;; and edebug-debugger.
2501 edebug-stop ; should we enter recursive-edit
2504 edebug-buffer-outside-point ; current point in edebug-buffer
2505 ;; window displaying edebug-buffer
2511 edebug-outside-windows ; window or screen configuration
2512 edebug-buffer-points
2514 edebug-eval-buffer ; declared here so we can kill it below
2517 edebug-trace-window
2518 edebug-trace-window-start
2527 ;; any others??
2528 )
2534 ;; Compute result string now before windows are modified.
2538 ;; Save windows now before we modify them.
2545 ;; First move the edebug buffer point to edebug-point
2546 ;; so that window start doesn't get changed when we display it.
2547 ;; I don't know if this is going to help.
2548 ;;(set-buffer edebug-buffer)
2549 ;;(goto-char edebug-point)
2551 ;; If edebug-buffer is not currently displayed,
2552 ;; first find a window for it.
2556 ;; Now display eval list, if any.
2557 ;; This is done after the pop to edebug-buffer
2558 ;; so that buffer-window correspondence is correct after quitting.
2560 ;; The evaluation list better not have deleted edebug-window-data.
2568 ;; Check whether positions are up-to-date.
2569 ;; This assumes point is never before symbol.
2573 edebug-function)
2574 )))
2579 ;; Test if there is input, not including keyboard macros.
2583 edebug-stop t)
2585 ;; (discard-input) ; is this unfriendly??
2586 ))
2587 ;; Now display arrow based on mode.
2592 ;; Display error message
2603 edebug-global-break-condition
2604 edebug-global-break-result))
2607 edebug-break-condition
2608 edebug-break-result))
2617 ;; Display result of previous evaluation.
2629 ;; not edebug-break
2634 )
2641 ;; (setq edebug-execution-mode 'step)
2642 ;; (edebug-overlay-arrow) ; This doesn't always show up.
2645 ;; Reset the edebug-window-data to whatever it is now.
2649 ;; Remember window-start for edebug-buffer, if still displayed.
2655 ;; Save trace window point before restoring outside windows.
2656 ;; Could generalize this for other buffers.
2663 ;; Restore windows before continuing.
2668 ;; Restore displayed buffer points.
2669 ;; Needed even if restoring windows because
2670 ;; window-points are not restored. (should they be??)
2674 ;; Unrestore trace window's window-point.
2677 edebug-trace-window-start))
2679 ;; Unrestore edebug-buffer's window-start, if displayed.
2686 ;; Unrestore edebug-buffer's window-point.
2687 ;; Needed in addition to setting the buffer point
2688 ;; - otherwise quitting doesn't leave point as is.
2689 ;; But this causes point to not be restored at times.
2690 ;; Also, it may not be a visible window.
2691 ;; (set-window-point window edebug-point)
2692 )))
2694 ;; Unrestore edebug-buffer's point. Rerestored below.
2695 ;; (goto-char edebug-point) ;; in edebug-buffer
2696 )
2697 ;; Since we may be in a save-excursion, in case of quit,
2698 ;; reselect the outside window only.
2699 ;; Only needed if we are not recovering windows??
2704 ;; Restore current buffer always, in case application needs it.
2706 ;; Restore point, and mark.
2707 ;; Needed even if restoring windows because
2708 ;; that doesn't restore point and mark in the current buffer.
2709 ;; But don't restore point if edebug-buffer is current buffer.
2713 ;; Does zmacs-regions need to be nil while doing set-marker?
2716 ;; None of the following is done if quit or signal occurs.
2718 ;; Restore edebug-buffer's outside point.
2719 ;; (edebug-trace "restore edebug-buffer point: %s"
2720 ;; edebug-buffer-outside-point)
2725 ;; ... nothing more.
2726 )
2727 ;; Reset global variables to outside values in case they were changed.
2729 overlay-arrow-position edebug-outside-o-a-p
2730 overlay-arrow-string edebug-outside-o-a-s
2731 cursor-in-echo-area edebug-outside-c-i-e-a)
2732 )))
2736 ;; Number of recursive edits started by edebug.
2737 ;; Should be 0 at the top level.
2740 ;; Value of recursion-depth when edebug was called.
2742 ;; Dynamically declared unbound vars
2757 ;; Note: here we have defvars for variables that are
2758 ;; built-in in certain versions.
2759 ;; Each defvar makes a difference
2760 ;; in versions where the variable is *not* built-in.
2762 ;; Emacs 18
2765 ;; Emacs 19.
2773 ;; Disable byte compiler warnings about unread-command-char and -event
2774 ;; (maybe works with byte-compile-version 2.22 at least)
2783 ;; Start up a recursive edit inside of edebug.
2784 ;; The current buffer is the edebug-buffer, which is put into edebug-mode.
2785 ;; Assume that none of the variables below are buffer-local.
2787 ;; match-data must be done in the outside buffer
2793 ;;(edebug-number-of-recursions (1+ edebug-number-of-recursions))
2795 edebug-entered ; bind locally to nil
2797 edebug-backtrace-buffer ; each recursive edit gets its own
2798 ;; The window configuration may be saved and restored
2799 ;; during a recursive-edit
2800 edebug-inside-windows
2822 )
2826 ;; Declare global values local but using the same global value.
2827 ;; We could set these to the values for previous edebug call.
2833 ;; Assume no edebug command sets unread-command-char.
2837 ;; More for Emacs 19
2845 ;; Bind again to outside values.
2849 ;; Don't keep defining a kbd macro.
2853 ;; others??
2854 )
2867 ;; Do the following, even if quit occurs.
2871 ;; Could be an option to keep eval display up.
2874 ;; Remember selected-window after recursive-edit.
2875 ;; (setq edebug-inside-window (selected-window))
2879 ;; Recursive edit may have changed buffers,
2880 ;; so set it back before exiting let.
2888 )
2889 ;; gotta have a buffer to let its buffer local variables be set
2893 ;; Reset global vars to outside values, in case they have been changed.
2895 last-command-char edebug-outside-last-command-char
2896 last-command-event edebug-outside-last-command-event
2897 last-command edebug-outside-last-command
2898 this-command edebug-outside-this-command
2899 unread-command-char edebug-outside-unread-command-char
2900 unread-command-events edebug-outside-unread-command-events
2901 current-prefix-arg edebug-outside-current-prefix-arg
2902 last-input-char edebug-outside-last-input-char
2903 last-input-event edebug-outside-last-input-event
2904 last-event-frame edebug-outside-last-event-frame
2905 last-nonmenu-event edebug-outside-last-nonmenu-event
2906 track-mouse edebug-outside-track-mouse
2908 standard-output edebug-outside-standard-output
2909 standard-input edebug-outside-standard-input
2910 defining-kbd-macro edebug-outside-defining-kbd-macro
2911 ))
2912 ))
2915 ;;; Display related functions
2918 ;; If pos is not visible, adjust current window to fit following context.
2919 ;;; (message "window: %s old-start: %s window-start: %s pos: %s"
2920 ;;; (selected-window) old-start (window-start) (point)) (sit-for 5)
2923 ;; First try old-start
2928 ;; (message "resetting window start") (sit-for 2)
2935 ))
2951 )
2955 ;; Set up the overlay arrow at beginning-of-line in current buffer.
2956 ;; The arrow string is derived from edebug-arrow-alist and
2957 ;; edebug-execution-mode.
2966 "Toggle the saving and restoring of all windows.
2967 Also, each time you toggle it on, the inside and outside window
2968 configurations become the same as the current configuration."
2975 edebug-save-windows))))
2985 edebug-save-windows))
2986 ;; Problem: what about outside windows that are deleted inside?
2990 "Toggle the saving and restoring of the selected window.
2991 Also, each time you toggle it on, the inside and outside window
2992 configurations become the same as the current configuration."
2996 ;; Save all outside windows except the selected one.
2997 ;; Remove (selected-window) from outside-windows.
3004 edebug-outside-windows))
3017 "Toggle the saving and restoring of windows.
3018 With prefix, toggle for just the selected window.
3019 Otherwise, toggle for all windows."
3027 "Show the debug windows and where we stopped in the program."
3031 ;; Restore the window configuration to what it last was inside.
3032 ;; But it is not always set. - experiment
3033 ;;(if edebug-inside-windows
3034 ;; (edebug-set-windows edebug-inside-windows))
3039 "Change to the outside window configuration."
3052 "Bounce the point in the outside current buffer.
3053 If prefix arg is supplied, sit for that many seconds before returning.
3054 The default is one second."
3059 ;; If the buffer's currently displayed, avoid set-window-configuration.
3071 ;; Joe Wells, here is a start at your idea of adding a buffer to the internal
3072 ;; display list. Still need to use this list in edebug-display.
3078 "Toggle display of a buffer inside of edebug."
3088 ;;; Breakpoint related functions
3091 ;; Return (function . index) of the nearest edebug stop point.
3098 ;; pull out parts of edebug-data.
3100 ;; (edebug-breakpoints (car (cdr edebug-data)))
3105 ;; skip backwards until non-whitespace, or bol
3108 edebug-def-mark))
3109 len i)
3110 ;; the offsets are in order so we can do a linear search
3117 ;; return the relevant info
3120 edebug-def-name)
3121 )))
3125 "Move point to the next breakpoint, or first if none past point."
3133 ;; pull out parts of edebug-data
3137 breakpoint)
3147 ;; goto the first breakpoint
3160 ))))))
3164 "Modify the breakpoint for the form at point or after it according
3165 to FLAG: set if t, clear if nil. Then move to that point.
3166 If CONDITION or TEMPORARY are non-nil, add those attributes to
3167 the breakpoint. "
3174 ;; pull out parts of edebug-data
3178 present)
3179 ;; delete it either way
3184 ;; add it to the list and resort
3189 edebug-breakpoints) '<))
3192 edebug-def-name condition)
3200 ))))
3203 "Set the breakpoint of nearest sexp.
3204 With prefix argument, make it a temporary breakpoint."
3209 "Clear the breakpoint of nearest sexp."
3216 "Global Condition: "
3221 ;;; Mode switching functions
3224 ;; Set the edebug mode to MODE.
3225 ;; Display SHORTMSG, or MSG if not within edebug.
3230 ;; Continue execution
3232 ;; This is not terribly useful!!
3240 "Proceed to next stop point."
3245 "Proceed to next `after' stop point."
3250 "Go, evaluating until break.
3251 With prefix ARG, set temporary break at current point and go."
3258 "Go, evaluating without debugging."
3265 "Begin trace mode."
3270 "Trace with no wait at each step."
3276 "Begin continue mode."
3282 "Trace with no wait at each step."
3287 ;; ------------------------------------------------------------
3288 ;; The following use the mode changing commands and breakpoints.
3292 "Proceed to this stop point."
3298 "Stop execution and do not continue.
3299 Useful for exiting from trace or continue loop."
3305 "Proceed to the exit of the next expression to be evaluated."
3313 "Proceed from the current point to the end of the ARGth sexp ahead.
3314 If there are not ARG sexps ahead, then do edebug-step-out."
3318 ;; Call forward-sexp repeatedly until done or failure.
3323 )))
3326 "Proceed from the current point to the end of the containing sexp.
3327 If there is no containing sexp that is not the top level defun,
3328 go to the end of the last sexp, or if that is the same point, then step."
3334 ;; Is there still a containing expression?
3338 ;; At top level - 1, so first check if there are more sexps at this level.
3340 ;; (up-list 1)
3345 )))))
3348 ;; Func should be a function symbol.
3349 ;; Return the function symbol, or nil if not instrumented.
3353 ;; It is uninstrumented, so instrument it.
3357 func))
3360 func)
3366 func))))))
3369 "Instrument the definition of the function or macro about to be called.
3370 Do this when stopped before the form or it will be too late.
3371 One side effect of using this command is that the next time the
3372 function or macro is called, Edebug will be called there as well."
3387 "Step into the definition of the function or macro about to be called.
3388 This first does `edebug-instrument-callee' to ensure that it is
3389 instrumented. Then it does `edebug-on-entry' and switches to `go' mode."
3398 "Cause Edebug to stop when FUNCTION is called.
3399 With prefix argument, make this temporary so it is automatically
3400 cancelled the first time the function is entered."
3402 ;; Could store this in the edebug data instead.
3413 ;; Also need edebug-cancel-debug-on-entry
3416 "Request FUNCTION to invoke debugger each time it is called.
3417 If the user continues, FUNCTION's execution proceeds.
3418 Works by modifying the definition of FUNCTION,
3419 which must be written in Lisp, not predefined.
3420 Use `cancel-debug-on-entry' to cancel the effect of this command.
3421 Redefining FUNCTION also does that.
3423 This version is from Edebug. If the function is instrumented for
3424 Edebug, it calls `edebug-on-entry'."
3433 "Set mode to Go-nonstop, and exit to top-level.
3434 This is useful for exiting even if unwind-protect code may be executed."
3440 ;;(defun edebug-exit-out ()
3441 ;; "Go until the current function exits."
3442 ;; (interactive)
3443 ;; (edebug-set-mode 'exiting "Exit..."))
3446 ;;; The following initial mode setting definitions are not used yet.
3456 )
3461 "Ask for the initial mode of the enclosing function.
3462 The mode is requested via the key that would be used to set the mode in
3463 edebug-mode."
3467 edebug-mode-map))
3469 edebug-initial-mode))
3472 "Change initial edebug mode for %s from %s (%s) to (enter key): "
3473 this-function
3474 old-mode
3477 keymap 'firstonly
3478 ))))
3480 )
3487 this-function mode))
3489 )))
3491 ;;; Evaluation of expressions
3496 "Evaluate an expression list in the outside context.
3497 Return the result of the last expression."
3501 ;; After excursion, we will
3502 ;; restore to current window configuration.
3505 ;; Restore outside windows.
3509 ;; (use-local-map edebug-outside-map)
3511 ;; Restore outside context.
3533 ;; See edebug-display
3537 )
3546 ;; Back to edebug-buffer. Restore rest of inside context.
3547 ;; (use-local-map edebug-inside-map)
3549 ;; Restore inside windows.
3552 ;; Save values that may have been changed.
3554 edebug-outside-last-command-char last-command-char
3555 edebug-outside-last-command-event last-command-event
3556 edebug-outside-last-command last-command
3557 edebug-outside-this-command this-command
3558 edebug-outside-unread-command-char unread-command-char
3559 edebug-outside-unread-command-events unread-command-events
3560 edebug-outside-current-prefix-arg current-prefix-arg
3561 edebug-outside-last-input-char last-input-char
3562 edebug-outside-last-input-event last-input-event
3563 edebug-outside-last-event-frame last-event-frame
3564 edebug-outside-last-nonmenu-event last-nonmenu-event
3565 edebug-outside-track-mouse track-mouse
3566 edebug-outside-standard-output standard-output
3567 edebug-outside-standard-input standard-input
3569 edebug-outside-executing-macro executing-kbd-macro
3570 edebug-outside-defining-kbd-macro defining-kbd-macro
3571 edebug-outside-pre-command-hook pre-command-hook
3572 edebug-outside-post-command-hook post-command-hook
3574 edebug-outside-o-a-p overlay-arrow-position
3575 edebug-outside-o-a-s overlay-arrow-string
3576 edebug-outside-c-i-e-a cursor-in-echo-area
3578 ))
3583 ;; Are there cl lexical variables active?
3589 ;; Evaluate EXPR safely.
3590 ;; If there is an error, a string is returned describing the error.
3597 ;;; Printing
3599 ;; Replace printing functions.
3601 ;; obsolete names
3607 "Replace print functions used by Edebug with custom versions."
3608 ;; Modifying the custom print functions, or changing print-length,
3609 ;; print-level, print-circle, custom-print-list or custom-print-vector
3610 ;; have immediate effect.
3622 "Replace edebug custom print functions with internal versions."
3631 ;; Default print functions are the same as Emacs'.
3636 ;; Print an error message like command level does.
3637 ;; This also prints the error name if it has no error-message.
3642 ;; continuing after an error may
3643 ;; complain about edebug-arg. why??
3647 ;; Define here in case they are not already defined.
3651 ;; Alternatively, we could change the definition of
3652 ;; edebug-safe-prin1-to-string to only use these if defined.
3676 "Print the previous result."
3680 ;;; Read, Eval and Print
3683 "Evaluate an expression in the outside environment.
3684 If interactive, prompt for the expression.
3685 Print result in minibuffer."
3687 "Eval: " nil read-expression-map t
3695 "Evaluate sexp before point in the outside environment;
3696 print value in minibuffer."
3701 "Evaluate sexp before point in the outside environment;
3702 print value into current buffer."
3710 ;; princ the string to get rid of quotes.
3713 ))
3715 ;;; Edebug Minor Mode
3717 ;; Global GUD bindings for all emacs-lisp-mode buffers.
3726 nil
3729 ;; control
3739 ;;(define-key edebug-mode-map "f" 'edebug-forward) not implemented
3747 ;; quitting and stopping
3753 ;; breakpoints
3760 ;; evaluation
3766 ;; views
3773 ;; misc
3779 ;; statistics
3782 ;; GUD bindings
3792 ))
3794 ;; Autoloading these global bindings doesn't make sense because
3795 ;; they cannot be used anyway unless Edebug is already loaded and active.
3804 nil
3818 ;; breakpoints
3824 ;; views
3828 ;; quitting
3833 ;; statistics
3835 )
3842 "Mode for Emacs Lisp buffers while in Edebug.
3844 In addition to all Emacs Lisp commands (except those that modify the
3845 buffer) there are local and global key bindings to several Edebug
3849 Also see bindings for the eval list buffer, *edebug*.
3851 The edebug buffer commands:
3854 Global commands prefixed by `global-edebug-prefix':
3857 Options:
3858 edebug-setup-hook
3859 edebug-all-defs
3860 edebug-all-forms
3861 edebug-save-windows
3862 edebug-save-displayed-buffer-points
3863 edebug-initial-mode
3864 edebug-trace
3865 edebug-test-coverage
3866 edebug-continue-kbd-macro
3867 edebug-print-length
3868 edebug-print-level
3869 edebug-print-circle
3870 edebug-on-error
3871 edebug-on-quit
3872 edebug-on-signal
3873 edebug-unwrap-results
3874 edebug-global-break-condition
3875 "
3878 ;;; edebug eval list mode
3880 ;; A list of expressions and their evaluations is displayed in *edebug*.
3883 "Return a list of evaluations of edebug-eval-list"
3884 ;; Assumes in outside environment.
3885 ;; Don't do any edebug things now.
3891 ;; Assumes edebug-eval-buffer exists.
3905 ))
3913 ;; Should generalize this to be callable outside of edebug
3914 ;; with calls in user functions, e.g. (edebug-eval-display)
3917 "Display expressions and evaluations in EVAL-LIST.
3918 It modifies the context by popping up the eval display."
3923 )))
3926 "Redisplay eval list in outside environment.
3927 May only be called from within edebug-recursive-edit."
3931 ))
3940 "Replace the evaluation list with the sexps now in the eval buffer."
3943 new-list)
3945 ;; get the first expression
3967 "Delete the item under point and redisplay."
3968 ;; could add arg to do repeatedly
3984 nil
3992 )
3997 "Mode for evaluation list buffer while in Edebug.
3999 In addition to all Interactive Emacs Lisp commands there are local and
4000 global key bindings to several Edebug specific commands. E.g.
4004 Eval list buffer commands:
4007 Global commands prefixed by global-edebug-prefix:
4009 "
4015 ;;; Interface with standard debugger.
4017 ;; (setq debugger 'edebug) ; to use the edebug debugger
4018 ;; (setq debugger 'debug) ; use the standard debugger
4020 ;; Note that debug and its utilities must be byte-compiled to work,
4021 ;; since they depend on the backtrace looking a certain way. But
4022 ;; edebug is not dependent on this, yet.
4025 "Replacement for debug.
4026 If we are running an edebugged function,
4027 show where we last were. Otherwise call debug normally."
4028 ;; (message "entered: %s depth: %s edebug-recursion-depth: %s"
4029 ;; edebug-entered (recursion-depth) edebug-recursion-depth) (sit-for 1)
4034 ;; Bind variables required by edebug-display
4036 edebug-breakpoints
4037 edebug-break-data
4038 edebug-break-condition
4039 edebug-global-break
4041 )
4044 nil
4045 edebug-value))
4047 ;; Otherwise call debug normally.
4048 ;; Still need to remove extraneous edebug calls from stack.
4050 ))
4054 "Display a non-working backtrace. Better than nothing..."
4060 ;; else, could just display edebug-backtrace-buffer
4061 )
4066 last-ok-point)
4069 ;; Clean up the backtrace.
4070 ;; Not quite right for current edebug scheme.
4077 ;; Delete interspersed edebug internals.
4082 ;; Previous lines may contain code, so just delete this line
4090 )))
4091 )))))
4093 \f
4094 ;;; Trace display
4097 "In buffer BUF-NAME, display FMT and ARGS at the end and make it visible.
4098 The buffer is created if it does not exist.
4099 You must include newlines in FMT to break lines, but one newline is appended."
4100 ;; e.g.
4101 ;; (edebug-trace-display "*trace-point*"
4102 ;; "saving: point = %s window-start = %s"
4103 ;; (point) (window-start))
4107 buf-window)
4108 ;; (message "before pop-to-buffer") (sit-for 1)
4114 ;; Make it visible.
4118 ;; (set-window-point buf-window (point))
4119 ;; (edebug-sit-for 0)
4123 buf-name)
4127 "Convenience call to edebug-trace-display using edebug-trace-buffer"
4130 \f
4131 ;;; Frequency count and coverage
4134 "Display the frequency count data for each line of the current
4135 definition. The frequency counts are inserted as comment lines after
4136 each line, and you can undo all insertions with one `undo' command.
4138 The counts are inserted starting under the `(' before an expression
4139 or the `)' after an expression, or on the last char of a symbol.
4140 The counts are only displayed when they differ from previous counts on
4141 the same line.
4143 If coverage is being tested, whenever all known results of an expression
4144 are `eq', the char `=' will be appended after the count
4145 for that expression. Note that this is always the case for an
4146 expression only evaluated once.
4148 To clear the frequency count and coverage data for a definition,
4149 reinstrument it."
4163 )
4165 ;; Traverse in reverse order so offsets are correct.
4167 ;; Start at last expression in line.
4171 last-index i)
4173 ;; Find all indexes on same line.
4176 ;; Insert all the indices for this line.
4179 first-index i ; really last index for line above this one.
4182 ;; i == first-index still
4203 "Temporarily display the frequency count data for the current definition.
4204 It is removed when you hit any char."
4205 ;; This seems not to work with Emacs 18.59. It undoes too far.
4213 \f
4214 ;;; Menus
4220 ;; We have to require easymenu (even for Emacs 18) just so
4221 ;; the easy-menu-define macro call is compiled correctly.
4226 "----"
4236 "----"
4241 "----"
4273 "----"
4283 ))
4286 \f
4287 ;;; Emacs version specific code
4291 ;; Mark takes an argument in Emacs 19.
4296 "Set a conditional breakpoint at nearest sexp.
4297 The condition is evaluated in the outside context.
4298 With prefix argument, make it a temporary breakpoint."
4299 ;; (interactive "P\nxCondition: ")
4302 current-prefix-arg
4303 ;; Read condition as follows; getting previous condition is cumbersome:
4313 ;; Prepend the current condition, if any.
4316 read-expression-history)))
4319 "Condition: " nil read-expression-map t
4322 ))))))
4325 ;;; The default for all above is Emacs.
4327 ;; Epoch specific code was in a separate file: edebug-epoch.el.
4332 \f
4333 ;;; Byte-compiler
4335 ;; Extension for bytecomp to resolve undefined function references.
4336 ;; Requires new byte compiler.
4338 ;; Reenable byte compiler warnings about unread-command-char and -event.
4339 ;; Disabled before edebug-recursive-edit.
4343 edebug-unread-command-char-warning)))
4346 ;; The body of eval-when-compile seems to get evaluated with eval-defun.
4347 ;; We only want to evaluate when actually byte compiling.
4348 ;; But it is OK to evaluate as long as byte-compiler has been loaded.
4352 "Say it is OK for the named functions to be unresolved."
4358 byte-compile-unresolved-functions))))
4359 funcs)
4360 nil)
4363 "Say it is OK for the named variables to be referenced."
4369 vars)
4370 nil)
4373 "Say it is OK for the named variables to be assigned."
4379 vars)
4380 nil)
4384 edebug-gensym ;; also in cl.el
4385 ;; Interfaces to standard functions.
4386 edebug-original-eval-defun
4387 edebug-original-read
4388 edebug-get-buffer-window
4389 edebug-mark
4390 edebug-mark-marker
4391 edebug-input-pending-p
4392 edebug-sit-for
4393 edebug-prin1-to-string
4394 edebug-format
4395 ;; lemacs
4396 zmacs-deactivate-region
4397 popup-menu
4398 ;; CL
4399 cl-macroexpand-all
4400 ;; And believe it or not, the byte compiler doesn't know about:
4401 byte-compile-resolve-functions
4402 ))
4406 read-expression-map))
4411 )))
4413 \f
4414 ;;; Autoloading of Edebug accessories
4419 ;; The following causes cl-specs to be loaded if you load cl.el.
4423 ;;; edebug-cl-read and cl-read are available from liberte@cs.uiuc.edu
4427 ;; The following causes edebug-cl-read to be loaded when you load cl-read.el.
4431 \f
4432 ;;; Finalize Loading
4434 ;;; Finally, hook edebug into the rest of Emacs.
4435 ;;; There are probably some other things that could go here.
4437 ;; Install edebug read and eval functions.
4442 ;;; edebug.el ends here