| blob | c1c65b6f66188aacb2d454b725f5fef78507fc75 |
1 ;;; edebug.el --- a source-level debugger for Emacs Lisp
3 ;; Copyright (C) 1988-1995, 1997, 1999-2012 Free Software Foundation, Inc.
5 ;; Author: Daniel LaLiberte <liberte@holonexus.org>
6 ;; Maintainer: FSF
7 ;; Keywords: lisp, tools, maint
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; This minor mode allows programmers to step through Emacs Lisp
27 ;; source code while executing functions. You can also set
28 ;; breakpoints, trace (stopping at each expression), evaluate
29 ;; expressions as if outside Edebug, reevaluate and display a list of
30 ;; expressions, trap errors normally caught by debug, and display a
31 ;; debug style backtrace.
33 ;;; Minimal Instructions
34 ;; =====================
36 ;; First evaluate a defun with C-M-x, then run the function. Step
37 ;; through the code with SPC, mark breakpoints with b, go until a
38 ;; breakpoint is reached with g, and quit execution with q. Use the
39 ;; "?" command in edebug to describe other commands.
40 ;; See the Emacs Lisp Reference Manual for more details.
42 ;; If you wish to change the default edebug global command prefix, change:
43 ;; (setq edebug-global-prefix "\C-xX")
45 ;; Edebug was written by
46 ;; Daniel LaLiberte
47 ;; GTE Labs
48 ;; 40 Sylvan Rd
49 ;; Waltham, MA 02254
50 ;; liberte@holonexus.org
52 ;;; Code:
56 ;;; Bug reporting
60 ;;; Options
63 "A source-level debugger for Emacs Lisp."
68 "Functions to call before edebug is used.
69 Each time it is set to a new value, Edebug will call those functions
70 once and then reset `edebug-setup-hook' to nil. You could use this
71 to load up Edebug specifications associated with a package you are
72 using, but only when you also use Edebug."
76 ;; edebug-all-defs and edebug-all-forms need to be autoloaded
77 ;; because the byte compiler binds them; as a result, if edebug
78 ;; is first loaded for a require in a compilation, they will be left unbound.
80 ;;;###autoload
82 "If non-nil, evaluating defining forms instruments for Edebug.
83 This applies to `eval-defun', `eval-region', `eval-buffer', and
84 `eval-current-buffer'. `eval-region' is also called by
85 `eval-last-sexp', and `eval-print-last-sexp'.
87 You can use the command `edebug-all-defs' to toggle the value of this
88 variable. You may wish to make it local to each buffer with
89 \(make-local-variable 'edebug-all-defs) in your
90 `emacs-lisp-mode-hook'."
94 ;; edebug-all-defs and edebug-all-forms need to be autoloaded
95 ;; because the byte compiler binds them; as a result, if edebug
96 ;; is first loaded for a require in a compilation, they will be left unbound.
98 ;;;###autoload
100 "Non-nil means evaluation of all forms will instrument for Edebug.
101 This doesn't apply to loading or evaluations in the minibuffer.
102 Use the command `edebug-all-forms' to toggle the value of this option."
107 "Non-nil means all macro call arguments may be evaluated.
108 If this variable is nil, the default, Edebug will *not* wrap
109 macro call arguments as if they will be evaluated.
110 For each macro, an `edebug-form-spec' overrides this option.
111 So to specify exceptions for macros that have some arguments evaluated
112 and some not, use `def-edebug-spec' to specify an `edebug-form-spec'."
117 "If non-nil, Edebug saves and restores the window configuration.
118 That takes some time, so if your program does not care what happens to
119 the window configurations, it is better to set this variable to nil.
121 If the value is a list, only the listed windows are saved and
122 restored.
124 `edebug-toggle-save-windows' may be used to change this variable."
129 "If non-nil, save and restore point in all displayed buffers.
131 Saving and restoring point in other buffers is necessary if you are
132 debugging code that changes the point of a buffer that is displayed
133 in a non-selected window. If Edebug or the user then selects the
134 window, the buffer's point will be changed to the window's point.
136 Saving and restoring point in all buffers is expensive, since it
137 requires selecting each window twice, so enable this only if you
138 need it."
143 "Initial execution mode for Edebug, if non-nil.
144 If this variable is non-nil, it specifies the initial execution mode
145 for Edebug when it is first activated. Possible values are step, next,
146 go, Go-nonstop, trace, Trace-fast, continue, and Continue-fast."
154 "Non-nil means display a trace of function entry and exit.
155 Tracing output is displayed in a buffer named `*edebug-trace*', one
156 function entry or exit per line, indented by the recursion level.
158 You can customize by replacing functions `edebug-print-trace-before'
159 and `edebug-print-trace-after'."
164 "If non-nil, Edebug tests coverage of all expressions debugged.
165 This is done by comparing the result of each expression with the
166 previous result. Coverage is considered OK if two different
167 results are found.
169 Use `edebug-display-freq-count' to display the frequency count and
170 coverage information for a definition."
175 "If non-nil, continue defining or executing any keyboard macro.
176 Use this with caution since it is not debugged."
182 "If non-nil, default value of `print-length' for printing results in Edebug."
186 "If non-nil, default value of `print-level' for printing results in Edebug."
190 "If non-nil, default value of `print-circle' for printing results in Edebug."
195 "Non-nil if Edebug should unwrap results of expressions.
196 That is, Edebug will try to remove its own instrumentation from the result.
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' or `continue'."
236 ;;; Form spec utilities.
239 "For compatibility with old version."
244 ;; Get the spec of symbol resolving all indirection.
246 indirect)
249 ;; (edebug-trace "indirection: %s" edebug-form-spec)
251 edebug-form-spec
252 ))
254 ;;;###autoload
256 "Return t if SPEC uses only extant spec symbols.
257 An extant spec symbol is a symbol that is not a function and has a
258 `edebug-form-spec' property."
264 t))
268 ;;; Utilities
270 ;; Define edebug-gensym - from old cl.el
275 "Generate a fresh uninterned symbol.
276 There is an optional argument, PREFIX. PREFIX is the string
277 that begins the new name. Most people take just the default,
278 except when debugging needs suggest otherwise."
288 newsymbol))
291 "Return t if OBJECT is a lambda list keyword.
292 A lambda list keyword is a symbol that starts with `&'."
298 ;; Return the last sexp before point in current buffer.
299 ;; Assumes Emacs Lisp syntax is active.
309 "Return a list of windows, in order of `next-window'."
310 ;; This doesn't work for epoch.
315 ;; Not used.
317 "Return t if there are two windows."
325 object)
328 "Return the macro named by OBJECT, or nil if it is not a macro."
333 object))
336 ;; Return the ALIST sorted with comparison function FUNCTION.
337 ;; This uses 'sort so the sorting is destructive.
342 ;;(def-edebug-spec edebug-save-restriction t)
344 ;; Not used. If it is used, def-edebug-spec must be defined before use.
346 "Evaluate BODY while saving the current buffers restriction.
347 BODY may change buffer outside of current restriction, unlike
348 save-restriction. BODY may change the current buffer,
349 and the restriction will be restored to the original buffer,
350 and the current buffer remains current.
351 Return the result of the last expression in BODY."
359 ;;; Display
365 ;; Like pop-to-buffer, but select window where BUFFER was last shown.
366 ;; Select WINDOW if it is provided and still exists. Otherwise,
367 ;; if buffer is currently shown in several windows, choose one.
368 ;; Otherwise, find a new window, possibly splitting one.
373 window)
375 ;; Selected window already displays BUFFER.
379 ;; When there's one window only, split it.
386 ;; Found a non-dedicated window not showing
387 ;; `edebug-trace-buffer', use it.
389 ;; All windows are dedicated or show `edebug-trace-buffer', split
390 ;; selected one.
395 ;; Selecting the window does not set the buffer until command loop.
396 ;;(set-buffer buffer)
397 )
400 ;; Return a list of buffer point pairs, for all displayed buffers.
406 list))))
407 list))
411 ;; Restore the buffer-points created by edebug-get-displayed-buffer-points.
417 buffer-points)))
420 ;; Get either a full window configuration or some window information.
429 which-windows)
433 ;; Set either a full window configuration or some window information.
446 one-window-info))))
447 window-info)
455 ;;; Redefine read and eval functions
456 ;; read is redefined to maybe instrument forms.
457 ;; eval-defun is redefined to check edebug-all-forms and edebug-all-defs.
459 ;; Save the original read function
464 "Read one Lisp expression as text from STREAM, return as Lisp object.
465 If STREAM is nil, use the value of `standard-input' (which see).
466 STREAM or the value of `standard-input' may be:
467 a buffer (read from point and advance it)
468 a marker (read from where it points and advance it)
469 a function (call it with no arguments for each character,
470 call it with a char as argument to push a char back)
471 a string (takes text from string, starting at the beginning)
472 t (read text line using minibuffer and use it).
474 This version, from Edebug, maybe instruments the expression. But the
475 STREAM must be the current buffer to do so. Whether it instruments is
476 also dependent on the values of `edebug-all-defs' and
477 `edebug-all-forms'."
486 ;; We should somehow arrange to be able to do this
487 ;; without actually replacing the eval-defun command.
489 "Evaluate the top-level form containing point, or after point.
491 If the current defun is actually a call to `defvar', then reset the
492 variable using its initial value expression even if the variable
493 already has some other value. (Normally `defvar' does not change the
494 variable's value if it already has a value.) Treat `defcustom'
495 similarly. Reinitialize the face according to `defface' specification.
497 With a prefix argument, instrument the code for Edebug.
499 Setting `edebug-all-defs' to a non-nil value reverses the meaning of
500 the prefix argument. Code is then instrumented when this function is
501 invoked without a prefix argument
503 If acting on a `defun' for FUNCTION, and the function was instrumented,
504 `Edebug: FUNCTION' is printed in the minibuffer. If not instrumented,
505 just FUNCTION is printed.
507 If not acting on a `defun', the result of evaluation is displayed in
508 the minibuffer."
516 ;; This should be consistent with `eval-defun-1', but not the
517 ;; same, since that gets a macroexpanded form.
520 ;; Force variable to be bound.
524 ;; Force variable to be bound.
525 ;; FIXME: Shouldn't this use the :setter or :initializer?
528 ;; Reset the face.
533 ;; See comments in `eval-defun-1' for purpose of code below
543 edebug-result)))
546 ;;;###autoload
549 ;;;###autoload
551 "Evaluate the top level form point is in, stepping through with Edebug.
552 This is like `eval-defun' except that it steps the code for Edebug
553 before evaluating it. It displays the value in the echo area
554 using `eval-expression' (which see).
556 If you do this on a function definition such as a defun or defmacro,
557 it defines the function and instruments its definition for Edebug,
558 so it will do Edebug stepping when called later. It displays
559 `Edebug: FUNCTION' in the echo area to indicate that FUNCTION is now
560 instrumented for Edebug.
562 If the current defun is actually a call to `defvar' or `defcustom',
563 evaluating it this way resets the variable using its initial value
564 expression even if the variable already has some other value.
565 \(Normally `defvar' and `defcustom' do not alter the value if there
566 already is one.)"
569 ;; Bind edebug-all-forms only while reading, not while evalling
570 ;; but this causes problems while edebugging edebug.
583 ;; Recover point, but only if no error occurred.
587 ;; Compatibility with old versions.
590 ;;;###autoload
592 "Toggle edebugging of all definitions."
599 ;;;###autoload
601 "Toggle edebugging of all forms."
610 ;; Don't install if already installed.
621 ;;; Edebug internal data
623 ;; The internal data that is needed for edebugging is kept in the
624 ;; buffer-local variable `edebug-form-data'.
629 ;; A list of entries associating symbols with buffer regions.
630 ;; This is an automatic buffer local variable. Each entry looks like:
631 ;; @code{(@var{symbol} @var{begin-marker} @var{end-marker}). The markers
632 ;; are at the beginning and end of an entry level form and @var{symbol} is
633 ;; a symbol that holds all edebug related information for the form on its
634 ;; property list.
636 ;; In the future, the symbol will be irrelevant and edebug data will
637 ;; be stored in the definitions themselves rather than in the property
638 ;; list of a symbol.
658 ;; Find the edebug form data entry which is closest to PNT.
659 ;; If END-POINT is supplied, match must be exact.
660 ;; Return `nil' if none found.
662 closest-entry
675 closest-entry entry))))
676 closest-entry))
678 ;; Also need to find all contained entries,
679 ;; and find an entry given a symbol, which should be just assq.
682 ;; Return the edebug data symbol of the form where point is in.
683 ;; If point is not inside a edebuggable form, cause error.
688 ;; Make NEW-ENTRY the first element in the `edebug-form-data' list.
693 ;; If non-nil, clear ENTRY out of the form data.
694 ;; Maybe clear the markers and delete the symbol's edebug property?
697 ;; Instead of this, we could just find all contained forms.
698 ;; (put (car entry) 'edebug nil) ;
699 ;; (mapcar 'edebug-clear-form-data-entry ; dangerous
700 ;; (get (car entry) 'edebug-dependents))
701 ;; (set-marker (nth 1 entry) nil)
702 ;; (set-marker (nth 2 entry) nil)
705 ;;; Parser utilities
708 ;; Signal an invalid-read-syntax with ARGS.
713 ;; Lookup table for significant characters indicating the class of the
714 ;; token that follows. This is not a \"real\" syntax table.
731 ;; We treat numbers as symbols, because of confusion with -, -1, and 1-.
732 ;; We don't care about any other chars since they won't be seen.
733 table))
736 ;; Move to the next token and return its class. We only care about
737 ;; lparen, rparen, dot, quote, backquote, comma, string, char, vector,
738 ;; or symbol.
747 'symbol
752 ;; Leave point before the next token, skipping white space and comments.
759 ;; Mostly obsolete reader; still used in one case.
762 ;; Read one sexp from the current buffer starting at point.
763 ;; Leave point immediately after it. A sexp can be a list or atom.
764 ;; An atom is a symbol (or number), character, string, or vector.
765 ;; This works for reading anything legitimate, but it
766 ;; is gummed up by parser inconsistencies (bugs?)
769 ;; read goes one too far if a (possibly quoted) string or symbol
770 ;; is immediately followed by non-whitespace.
782 ;;; Offsets for reader
784 ;; Define a structure to represent offset positions of expressions.
785 ;; Each offset structure looks like: (before . after) for constituents,
786 ;; or for structures that have elements: (before <subexpressions> . after)
787 ;; where the <subexpressions> are the offset structures for subexpressions
788 ;; including the head of a list.
791 ;; Stack of offset structures in reverse order of the nesting.
792 ;; This is used to get back to previous levels.
796 ;; We must store whether we just read a list with a dotted form that
797 ;; is itself a list. This structure will be condensed, so the offsets
798 ;; must also be condensed.
802 ;; Reinitialize offset recording.
806 ;; Add a new offset pair with POINT as the before offset.
811 ;; Otherwise, we are at the top level, so initialize.
813 edebug-offsets-stack nil
814 edebug-read-dotted-list nil))
815 ;; Cons the new offset to the front of the stack.
817 edebug-current-offset new-offset)
818 ))
821 ;; Finalize the current offset struct by reversing it and
822 ;; store POINT as the after offset.
824 ;; Just reverse the offsets of all subexpressions.
827 ;; We just read a list after a dot, which will be abbreviated out.
829 ;; Drop the corresponding offset pair.
830 ;; That is, nconc the reverse of the rest of the offsets
831 ;; with the cdr of last offset.
836 ;; Now append the point using nconc.
838 ;; Pop the stack.
843 ;; Ignore the last created offset pair.
855 ;;; Reader for Emacs Lisp.
857 ;; Uses edebug-next-token-class (and edebug-skip-whitespace) above.
868 ))
875 ;; anything else, just read it.
877 stream))))
886 ;; Turn 'thing into (quote thing)
893 ;; Turn `thing into (\` thing)
900 ;; Turn ,thing into (\, thing). Handle ,@ and ,. also.
910 ;; Generate the same structure of offsets we would have
911 ;; if the resulting list appeared verbatim in the input text.
917 ;; Turn #'thing into (function thing)
945 ))
946 elements)
948 ))
958 ))
960 ;;; Cursors for traversal of list and vector elements with offsets.
965 ;; Return a new cursor for EXPRESSIONS with OFFSETS.
971 ;; Set the CURSOR's EXPRESSIONS and OFFSETS to the given.
972 ;; Return the cursor.
975 cursor)
978 ;; Copy the cursor using the same object and offsets.
987 ;; Return non-nil if CURSOR is empty - meaning no more elements.
991 ;; Return the top element at the cursor.
992 ;; Assumes not empty.
996 ;; Check if a dotted form is required.
998 ;; Check if there is at least one more argument.
1000 ;; Return that top element.
1004 ;; Return the top offset pair corresponding to the top element.
1008 ;; Advance and return the cursor to the next element and offset.
1009 ;; throw no-match if empty before moving.
1010 ;; This is a violation of the cursor encapsulation, but
1011 ;; there is plenty of that going on while matching.
1012 ;; The following test should always fail.
1017 cursor)
1021 ;; Return the before offset of the cursor.
1022 ;; If there is nothing left in the offsets,
1023 ;; return one less than the offset itself,
1024 ;; which is the after offset for a list.
1031 ;; Return the after offset of the cursor object.
1035 offset))
1037 ;;; The Parser
1039 ;; The top level function for parsing forms is
1040 ;; edebug-read-and-maybe-wrap-form; it calls all the rest. It checks the
1041 ;; syntax a bit and leaves point at any error it finds, but otherwise
1042 ;; should appear to work like eval-defun.
1044 ;; The basic plan is to surround each expression with a call to
1045 ;; the edebug debugger together with indexes into a table of positions of
1046 ;; all expressions. Thus an expression "exp" becomes:
1048 ;; (edebug-after (edebug-before 1) 2 exp)
1050 ;; When this is evaluated, first point is moved to the beginning of
1051 ;; exp at offset 1 of the current function. The expression is
1052 ;; evaluated, which may cause more edebug calls, and then point is
1053 ;; moved to offset 2 after the end of exp.
1055 ;; The highest level expressions of the function are wrapped in a call to
1056 ;; edebug-enter, which supplies the function name and the actual
1057 ;; arguments to the function. See functions edebug-enter, edebug-before,
1058 ;; and edebug-after for more details.
1060 ;; Dynamically bound vars, left unbound, but globally declared.
1061 ;; This is to quiet the byte compiler.
1063 ;; Window data of the highest definition being wrapped.
1064 ;; This data is shared by all embedded definitions.
1079 ;; Read a form and wrap it with edebug calls, if the conditions are right.
1080 ;; Here we just catch any no-match not caught below and signal an error.
1082 ;; Run the setup hook.
1083 ;; If it gets an error, make it nil.
1089 edebug-top-window-data
1090 edebug-def-name;; make sure it is locally nil
1091 ;; I don't like these here!!
1092 edebug-&optional
1093 edebug-&rest
1094 edebug-gate
1095 edebug-best-error
1096 edebug-error-point
1097 no-match
1098 ;; Do this once here instead of several times.
1104 nil))
1107 result))
1112 def-kind
1113 defining-form-p
1114 def-name
1115 ;; These offset things don't belong here, but to support recursive
1116 ;; calls to edebug-read, they need to be here.
1117 edebug-offsets
1118 edebug-offsets-stack
1119 edebug-current-offset ; reset to nil
1120 )
1124 ;; Find out if this is a defining form from first symbol
1129 ;; This is incorrect in general!! But OK most of the time.
1134 ;;;(message "all defs: %s all forms: %s" edebug-all-defs edebug-all-forms)
1138 ;; If it is a defining form and we are edebugging defs,
1139 ;; then let edebug-list-form start it.
1145 cursor
1150 ;; Not edebugging this form, so reset the symbol's edebug
1151 ;; property to be just a marker at the definition's source code.
1152 ;; This only works for defs with simple names.
1154 ;; Also nil out dependent defs.
1161 ;; If all forms are being edebugged, explicitly wrap it.
1167 cursor
1170 nil)))
1172 ;; Not a defining form, and not edebugging.
1174 ))
1180 ;; Currently def-form sets this to nil; def-body sets it to t.
1183 ;; Return a unique symbol for the variable used to store the
1184 ;; status of interactive-p for this function.
1189 "Wrap the FORMS of a definition body."
1198 ;; Generate the enter wrapper for some forms of a definition.
1199 ;; This is not to be used for the body of other forms, e.g. `while',
1200 ;; since it wraps the list of forms with a call to `edebug-enter'.
1201 ;; Uses the dynamically bound vars edebug-def-name and edebug-def-args.
1202 ;; Do this after parsing since that may find a name.
1209 ;; Doesn't work with more than one def-body!!
1210 ;; But the list will just be reversed.
1214 ))
1223 ;; modifies edebug-offset-index and edebug-offset-list
1224 ;; accesses edebug-func-marc and buffer point
1226 edebug-offset-index
1228 edebug-offset-list)
1233 ;; Return the edebug form for the current function at offset BEFORE-INDEX
1234 ;; given FORM. Looks like:
1235 ;; (edebug-after (edebug-before BEFORE-INDEX) AFTER-INDEX FORM)
1236 ;; Also increment the offset index for subsequent use.
1239 after-index form))
1242 ;; Like edebug-make-before-and-after-form, but only after.
1247 "Return the unwrapped SEXP or return it as is if it is not wrapped.
1248 The SEXP might be the result of wrapping a body, which is a list of
1249 expressions; a `progn' form will be returned enclosing these forms."
1257 )
1258 sexp))
1261 "Return the SEXP recursively unwrapped."
1268 new-sexp)))
1272 ;; Process the defining form, starting outside the form.
1273 ;; The speclist is a generated list spec that looks like:
1274 ;; (("def-symbol" defining-form-spec-sans-&define))
1275 ;; Skip the first offset.
1279 cursor
1281 speclist))
1285 ;; Wrap a form, usually a defining form, but any evaluated one.
1286 ;; If speclist is non-nil, this is being called by edebug-defining-form.
1287 ;; Otherwise it is being called from edebug-read-and-maybe-wrap-form1.
1288 ;; This is a hack, but I haven't figured out a simpler way yet.
1290 ;; Set this marker before parsing.
1294 ;; Buffer must be current-buffer for this to work:
1299 result
1300 ;; For definitions.
1301 ;; (edebug-containing-def-name edebug-def-name)
1302 ;; Get name from form-data, if any.
1304 edebug-def-name
1305 edebug-def-args
1306 edebug-def-interactive
1307 edebug-inside-func;; whether wrapped code executes inside a function.
1308 )
1314 ;; else wrap as an enter-form.
1317 ;; Set the name here if it was not set by edebug-make-enter-wrapper.
1321 ;; Add this def as a dependent of containing def. Buggy.
1329 ;; Create a form-data-entry or modify existing entry's markers.
1330 ;; In the latter case, pointers to the entry remain eq.
1334 edebug-def-name
1335 edebug-form-begin-marker
1336 ;; Buffer must be current-buffer.
1338 ))
1340 form-data-entry edebug-def-name ;; in case name is changed
1341 form-begin form-end))
1343 ;; (message "defining: %s" edebug-def-name) (sit-for 2)
1346 ;;(debug edebug-def-name)
1348 ;; Destructively reverse edebug-offset-list and make vector from it.
1351 ;; Side effects on the property list of edebug-def-name.
1355 ;; Set up the initial window data.
1363 ;; Store the edebug data in symbol's property list.
1365 ;; A struct or vector would be better here!!
1367 nil ; clear breakpoints
1368 edebug-offset-list
1369 edebug-top-window-data
1370 ))
1371 result
1372 )))
1376 ;; Create initial frequency count vector.
1377 ;; For each stop point, the counter is incremented each time it is visited.
1383 ;; Create initial coverage vector.
1384 ;; Only need one per expression, but it is simpler to use stop points.
1390 ;; Return the instrumented form for the following form.
1391 ;; Add the point offsets to the edebug-offset-list for the form.
1397 ;; The first offset for a list form is for the list form itself.
1399 form
1403 ;; Find out if this is a defining form from first symbol.
1404 ;; An indirect spec would not work here, yet.
1407 new-cursor
1411 ;; Wrap a regular form.
1415 ;; After processing the list form, the new-cursor is left
1416 ;; with the offset after the form.
1418 )))
1422 ;; Check for constant symbols that don't get wrapped.
1425 form)
1430 ;; Anything else is self-evaluating.
1439 ;; Process the arguments of a list form given that head of form is a symbol.
1440 ;; Helper for edebug-list-form
1446 ;; It is a speclist.
1453 ; but leave it in for compatibility.
1454 ))
1455 ;; No edebug-form-spec provided.
1465 ;; Return an instrumented form built from the list form.
1466 ;; The after offset will be left in the cursor after processing the form.
1468 ;; Prevent backtracking whenever instrumenting.
1470 ;; A list form is never optional because it matches anything.
1473 ;; Skip the first offset.
1481 ;; Special case: replace (interactive-p) with variable
1491 ;; The head of a form should normally be a symbol or a lambda
1492 ;; expression but it can also be an unquote form to be filled
1493 ;; before evaluation. We evaluate the arguments anyway, on the
1494 ;; assumption that the unquote form will place a proper function
1495 ;; name (rather than a macro name).
1497 ;; Process anonymous function and args.
1498 ;; This assumes no anonymous macros.
1503 ))
1505 ;;; Matching of specs.
1513 ;;; Failure to match
1515 ;; This throws to no-match, if there are higher alternatives.
1516 ;; Otherwise it signals an error. The place of the error is found
1517 ;; with the two before- and after-offset functions.
1520 ;; Throw a no-match, or signal an error immediately if gate is active.
1521 ;; Remember this point in case we need to report this error.
1534 ;; Top level spec matching function.
1535 ;; Used also at each lower level of specs.
1537 edebug-&rest
1538 edebug-best-error
1539 edebug-error-point
1541 )
1546 ;; Match one spec, which is not a keyword &-spec.
1552 ))
1556 ;; Append results of matching the list of specs.
1557 ;; The first spec is handled and the remainder-handler handles the rest.
1565 ;; Is the spec dotted?
1570 ;; Is the form dotted?
1574 ;; Cancel dotted spec and dotted form.
1578 ;; Wrap the form in a list, (by changing the cursor??)...
1580 ;; and process normally, then unwrap the result.
1587 ;;(message "spec = %s first char = %s" spec first-char) (sit-for 1)
1601 ;; Define specs for all the symbol specs with functions used to process them.
1602 ;; Perhaps we shouldn't be doing this with edebug-form-specs since the
1603 ;; user may want to define macros or functions with the same names.
1604 ;; We could use an internal obarray for these primitive specs.
1618 ;; Less frequently used:
1619 ;; (function . edebug-match-function)
1625 ;; (nil . edebug-match-nil) not this one - special case it.
1626 ))
1630 ;; Match a symbol spec.
1635 ;; It is an indirect spec.
1637 ;; Otherwise it should be the symbol name of a function.
1638 ;; There could be a bug here - maybe need to do edebug-match bindings.
1646 ;; Special case for edebug-`.
1654 )))
1665 ;; Currently identical to edebug-match-form.
1666 ;; This is for common lisp setf-style place arguments.
1671 ;; Keep matching until one spec fails.
1683 ;; Returning nil means no no-match was thrown.
1684 nil))
1685 result
1686 ;; no-match, but don't fail; just reset cursor and return nil.
1688 nil)))
1693 ;; Reuse the &optional handler with this as the remainder handler.
1697 ;; Repeatedly use specs until failure.
1699 edebug-best-error
1700 edebug-error-point)
1705 ;; Keep matching until one spec succeeds, and return its results.
1706 ;; If none match, fail.
1707 ;; This needs to be optimized since most specs spend time here.
1716 edebug-best-error
1717 edebug-error-point)
1718 ;; Doesn't support e.g. &or symbolp &rest form
1720 ;; Match failed, so reset and try again.
1722 ;; Reset the cursor for the next match.
1724 ;; All failed.
1726 ))
1730 ;; If any specs match, then fail
1735 nil))
1736 ;; This means something matched, so it is a no match.
1738 ;; This means nothing matched, so it is OK.
1745 ;; Following specs must look like (<name> <spec>) ...
1746 ;; where <name> is the name of a keyword, and spec is its spec.
1747 ;; This really doesn't save much over the expanded form and takes time.
1749 cursor
1754 specs))))
1758 ;; Simply set the gate to prevent backtracking at this level.
1760 nil)
1764 ;; The spec is a list, but what kind of list, and what context?
1766 ;; After dotted spec but form did not contain dot,
1767 ;; so match list spec elements as if spliced in.
1771 ;; If it matched, really clear the dotted-spec flag.
1780 ;; Special case: spec quotes a symbol to match.
1781 ;; Change in future. Use "..." instead.
1786 form)
1793 ;; First offset is for the list form itself.
1794 ;; Treat nil as empty list.
1796 specs))
1800 ;; Special case: match a vector with the specs.
1809 )))
1813 ;; Match a sublist of specs.
1815 ;;edebug-best-error
1816 ;;edebug-error-point
1817 )
1819 ;; match with edebug-match-specs so edebug-best-error is not bound.
1824 ;; A failed &rest or &optional spec may leave some args.
1826 )))))
1833 ;; Since it matched, failure means immediate error, unless &optional.
1837 )))
1840 ;; There must be nothing left to match a nil.
1843 nil))
1850 ;; Match a defining form.
1851 ;; Normally, &define is interpreted specially other places.
1852 ;; This should only be called inside of a spec list to match the remainder
1853 ;; of the current list. e.g. ("lambda" &define args def-body)
1855 cursor
1857 ;; Find the last offset in the list.
1860 offsets)
1861 specs))
1864 ;; The expression must be a function.
1865 ;; This will match any list form that begins with a symbol
1866 ;; that has an edebug-form-spec beginning with &define. In
1867 ;; practice, only lambda expressions should be used.
1868 ;; I could add a &lambda specification to avoid confusion.
1875 ;; Find out if this is a defining form from first symbol.
1886 )))
1890 ;; Set the edebug-def-name bound in edebug-defining-form.
1892 ;; Maybe strings and numbers could be used.
1897 ;; Construct a new name by appending to previous name.
1899 name))
1904 ;; Set the edebug-def-name to the spec.
1907 ;; Construct a new name by appending to previous name.
1909 spec))
1910 nil)
1913 ;; set the def-args bound in edebug-defining-form
1923 ;; Like form but the form is wrapped in edebug-enter form.
1924 ;; The form is assumed to be executing outside of the function context.
1925 ;; This is a hack for now, since a def-form might execute inside as well.
1926 ;; Not to be used otherwise.
1931 ;; Like body but body is wrapped in edebug-enter form.
1932 ;; The body is assumed to be executing inside of the function context.
1933 ;; Not to be used otherwise.
1938 ;;;; Edebug Form Specs
1939 ;;; ==========================================================
1941 ;;;;* Spec for def-edebug-spec
1942 ;;; Out of date.
1945 "Return non-nil if OBJECT is a symbol with an edebug-form-spec property."
1950 ;; Top level is different from lower levels.
1955 ;; A list must have something in it, or it is nil, a symbolp
1959 (&or
1963 edebug-spec-list
1964 stringp
1967 edebug-spec-p ;; Including all the special ones e.g. form.
1968 symbolp;; a predicate
1969 ))
1972 ;;;* Emacs special forms and some functions.
1974 ;; quote expects only one argument, although it allows any number.
1977 ;; The standard defining forms.
1982 (&define name lambda-list
1985 def-body))
1986 ;; FIXME? Isn't this missing the doc-string? Cf defun.
1996 )))
2001 ;; A function-form is for an argument that may be a function or a form.
2002 ;; This specially recognizes anonymous functions quoted with quote.
2004 ;; form at the end could also handle "function",
2005 ;; but recognize it specially to avoid wrapping function forms.
2008 ;; function expects a symbol or a lambda or macro expression
2009 ;; A macro is allowed by Emacs.
2012 ;; A macro expression is a lambda expression with "macro" prepended.
2015 ;; (def-edebug-spec anonymous-form ((&or ["lambda" lambda] ["macro" macro])))
2017 ;; Standard functions that take function-forms arguments.
2024 ;; FIXME? The manual uses this form (maybe that's just for illustration?):
2025 ;; (def-edebug-spec let
2026 ;; ((&rest &or symbolp (gate symbolp &optional form))
2027 ;; body))
2030 body))
2041 form
2047 ;; Supports quotes inside backquotes,
2048 ;; but only at the top level inside unquotes.
2050 (&or
2052 ;; The simple version:
2053 ;; (backquote-form &rest backquote-form)
2054 ;; doesn't handle (a . ,b). The straightforward fix:
2055 ;; (backquote-form . [&or nil backquote-form])
2056 ;; uses up too much stack space.
2057 ;; Note that `(foo . ,@bar) is not valid, so we don't need to handle it.
2060 ;; If you use dotted forms in backquotes, replace the previous line
2061 ;; with the following. This takes quite a bit more stack space, however.
2062 ;; (backquote-form . [&or nil backquote-form])
2064 sexp))
2066 ;; Special version of backquote that instruments backquoted forms
2067 ;; destined to be evaluated, usually as the result of a
2068 ;; macroexpansion. Backquoted code can only have unquotes (, and ,@)
2069 ;; in places where list forms are allowed, and predicates. If the
2070 ;; backquote is used in a macro, unquoted code that come from
2071 ;; arguments must be instrumented, if at all, with def-form not def-body.
2073 ;; We could assume that all forms (not nested in other forms)
2074 ;; in arguments of macros should be def-forms, whether or not the macros
2075 ;; are defined with edebug-` but this would be expensive.
2077 ;; ,@ might have some problems.
2082 ;; Assume immediate quote in unquotes mean backquote at next higher level.
2087 ;; New byte compiler.
2106 ;; Anything else?
2109 ;; Some miscellaneous specs for macros in public packages.
2110 ;; Send me yours.
2112 ;; advice.el by Hans Chalupsky (hans@cs.buffalo.edu)
2118 ;; "activation" "deactivation"]
2119 name ;; name of advice
2121 )
2124 def-body))
2131 ;;; The debugger itself
2135 ;;; add minor-mode-alist entry
2138 minor-mode-alist)))
2141 ;; Stack of active functions evaluated via edebug.
2142 ;; Should be nil at the top level.
2145 ;; Index of last edebug-stack item.
2148 ;; Stack of offset indices of visited edebug sexps.
2149 ;; Should be nil at the top level.
2150 ;; Each function adds one cons. Top is modified with setcar.
2154 ;; Non-nil if edebug has already been entered at this recursive edit level.
2155 ;; This should stay nil at the top level.
2156 )
2158 ;; Should these be options?
2160 ;; Name of function to use for debugging when error or quit occurs.
2161 ;; Set this to 'debug if you want to debug edebug.
2162 )
2165 ;; Dynamically bound variables, declared globally but left unbound.
2194 ;;; Handling signals
2197 "Signal an error. Args are SIGNAL-NAME, and associated DATA.
2198 A signal name is a symbol with an `error-conditions' property
2199 that is a list of condition names.
2200 A handler for any of those names will get to handle this signal.
2201 The symbol `error' should always be one of them.
2203 DATA should be a list. Its elements are printed as part of the error message.
2204 If the signal is handled, DATA is made available to the handler.
2205 See `condition-case'.
2207 This is the Edebug replacement for the standard `signal'. It should
2208 only be active while Edebug is. It checks `debug-on-error' to see
2209 whether it should call the debugger. When execution is resumed, the
2210 error is signaled again.
2214 ;; If we reach here without another non-local exit, then send signal again.
2215 ;; i.e. the signal is not continuable, yet.
2216 ;; Avoid infinite recursion.
2220 ;;; Entering Edebug
2223 ;; Entering FUNC. The arguments are ARGS, and the body is BODY.
2224 ;; Setup edebug variables and evaluate BODY. This function is called
2225 ;; when a function evaluated with edebug-eval-top-level-form is entered.
2226 ;; Return the result of BODY.
2228 ;; Is this the first time we are entering edebug since
2229 ;; lower-level recursive-edit command?
2230 ;; More precisely, this tests whether Edebug is currently active.
2233 ;; Binding max-lisp-eval-depth here is OK,
2234 ;; but not inside an unwind-protect.
2235 ;; Doing it here also keeps it from growing too large.
2242 ;; Binding these may not be the right thing to do.
2243 ;; We want to allow the global values to be changed.
2247 ;; Lexical bindings must be uncompiled for this to work.
2252 overriding-terminal-local-map)
2254 ;; Save the outside value of executing macro. (here??)
2262 ;; within edebug unless edebug-continue-kbd-macro is
2263 ;; non-nil. Again, local binding may not be best.
2267 ;; Don't get confused by the user's keymap changes.
2273 ;; Disable command hooks. This is essential when
2274 ;; a hook function is instrumented - to avoid infinite loop.
2275 ;; This may be more than we need, however.
2279 edebug-initial-mode
2280 edebug-execution-mode)
2281 edebug-next-execution-mode nil)
2283 ;; Reset global variables in case outside value was changed.
2298 )
2307 )))
2310 "Return a cons cell describing the status of VAR's current binding.
2311 The purpose of this function is so you can properly undo
2312 subsequent changes to the same binding, by passing the status
2313 cons cell to `edebug-restore-status'. The status cons cell
2314 has the form (LOCUS . VALUE), where LOCUS can be a buffer
2315 \(for a buffer-local binding), a frame (for a frame-local binding),
2316 or nil (if the default binding is current)."
2321 "Reset VAR based on STATUS.
2322 STATUS should be a list returned by `edebug-var-status'."
2336 edebug-result)
2346 "Print MSG in *edebug-trace* before and after evaluating BODY.
2347 The result of BODY is also printed."
2349 edebug-result)
2356 "Function called to print trace info before expression evaluation.
2357 MSG is printed after `::::{ '."
2362 "Function called to print trace info after expression evaluation.
2363 MSG is printed after `::::} '."
2371 ;; Debug current function given BEFORE position.
2372 ;; Called from functions compiled with edebug-eval-top-level-form.
2373 ;; Return the before index.
2376 ;; Increment frequency count
2383 edebug-before-index)
2386 ;; Do nothing.
2387 )
2391 edebug-value
2392 ;; Debug current function given AFTER position and VALUE.
2393 ;; Called from functions compiled with edebug-eval-top-level-form.
2394 ;; Return VALUE.
2397 ;; Increment frequency count
2404 ;; Just return result.
2405 edebug-value
2407 )))
2410 ;; Do nothing but return the value.
2411 edebug-value)
2417 ;; This is not used, yet.
2431 ;; Test if a different result.
2436 ;; Dynamically declared unbound variables.
2450 ;; Don't really try to enter edebug within an eval from redisplay.
2451 edebug-value
2452 ;; Check breakpoints and pending input.
2453 ;; If edebug display should be updated, call edebug-display.
2454 ;; Return edebug-value.
2463 ;; FIXME: lexbind.
2468 ;;; (edebug-trace "exp: %s" edebug-value)
2469 ;; Test whether we should break.
2475 ;; FIXME: lexbind.
2479 ;; Delete the breakpoint.
2484 ;; Display if mode is not go, continue, or Continue-fast
2485 ;; or break, or input is pending,
2487 edebug-break
2491 edebug-value
2492 )))
2495 ;; window-start now stored with each function.
2496 ;;(defvar edebug-window-start nil)
2497 ;; Remember where each buffers' window starts between edebug calls.
2498 ;; This is to avoid spurious recentering.
2499 ;; Does this still need to be buffer-local??
2500 ;;(setq-default edebug-window-start nil)
2501 ;;(make-variable-buffer-local 'edebug-window-start)
2504 ;; Dynamically declared unbound vars
2521 ;; Emacs 19 adds an arg to mark and mark-marker.
2527 ;; The buffer holding the source has been killed.
2528 ;; Let's at least show a backtrace so the user can figure out
2529 ;; which function we're talking about.
2531 ;; Setup windows for edebug, determine mode, maybe enter recursive-edit.
2532 ;; Uses local variables of edebug-enter, edebug-before, edebug-after
2533 ;; and edebug-debugger.
2536 edebug-stop ; should we enter recursive-edit
2539 edebug-buffer-outside-point ; current point in edebug-buffer
2540 ;; window displaying edebug-buffer
2547 edebug-outside-windows ; window or screen configuration
2548 edebug-buffer-points
2550 edebug-eval-buffer ; declared here so we can kill it below
2553 edebug-trace-window
2554 edebug-trace-window-start
2566 ;; any others??
2567 )
2574 ;; Compute result string now before windows are modified.
2578 ;; Save windows now before we modify them.
2585 ;; First move the edebug buffer point to edebug-point
2586 ;; so that window start doesn't get changed when we display it.
2587 ;; I don't know if this is going to help.
2588 ;;(set-buffer edebug-buffer)
2589 ;;(goto-char edebug-point)
2591 ;; If edebug-buffer is not currently displayed,
2592 ;; first find a window for it.
2596 ;; Now display eval list, if any.
2597 ;; This is done after the pop to edebug-buffer
2598 ;; so that buffer-window correspondence is correct after quitting.
2600 ;; The evaluation list better not have deleted edebug-window-data.
2608 ;; Check whether positions are up-to-date.
2609 ;; This assumes point is never before symbol.
2613 edebug-function)
2614 )))
2619 ;; Test if there is input, not including keyboard macros.
2623 edebug-stop t)
2625 ;; (discard-input) ; is this unfriendly??
2626 ))
2627 ;; Now display arrow based on mode.
2632 ;; Display error message
2643 edebug-global-break-condition
2644 edebug-global-break-result))
2647 edebug-break-condition
2648 edebug-break-result))
2658 ;; Display result of previous evaluation.
2671 ;; not edebug-break
2682 ;; (setq edebug-execution-mode 'step)
2683 ;; (edebug-overlay-arrow) ; This doesn't always show up.
2686 ;; Reset the edebug-window-data to whatever it is now.
2690 ;; Remember window-start for edebug-buffer, if still displayed.
2696 ;; Save trace window point before restoring outside windows.
2697 ;; Could generalize this for other buffers.
2704 ;; Restore windows before continuing.
2709 ;; Restore displayed buffer points.
2710 ;; Needed even if restoring windows because
2711 ;; window-points are not restored. (should they be??)
2715 ;; Unrestore trace window's window-point.
2718 edebug-trace-window-start))
2720 ;; Unrestore edebug-buffer's window-start, if displayed.
2727 ;; Unrestore edebug-buffer's window-point.
2728 ;; Needed in addition to setting the buffer point
2729 ;; - otherwise quitting doesn't leave point as is.
2730 ;; But this causes point to not be restored at times.
2731 ;; Also, it may not be a visible window.
2732 ;; (set-window-point window edebug-point)
2733 )))
2735 ;; Unrestore edebug-buffer's point. Rerestored below.
2736 ;; (goto-char edebug-point) ;; in edebug-buffer
2737 )
2738 ;; Since we may be in a save-excursion, in case of quit,
2739 ;; reselect the outside window only.
2740 ;; Only needed if we are not recovering windows??
2745 ;; Restore current buffer always, in case application needs it.
2748 ;; Restore point, and mark.
2749 ;; Needed even if restoring windows because
2750 ;; that doesn't restore point and mark in the current buffer.
2751 ;; But don't restore point if edebug-buffer is current buffer.
2755 ;; Does zmacs-regions need to be nil while doing set-marker?
2758 ;; None of the following is done if quit or signal occurs.
2760 ;; Restore edebug-buffer's outside point.
2761 ;; (edebug-trace "restore edebug-buffer point: %s"
2762 ;; edebug-buffer-outside-point)
2765 ;; ... nothing more.
2766 )
2768 ;; Reset global variables to outside values in case they were changed.
2770 unread-command-events edebug-outside-unread-command-events
2771 overlay-arrow-position edebug-outside-o-a-p
2772 overlay-arrow-string edebug-outside-o-a-s
2773 cursor-in-echo-area edebug-outside-c-i-e-a)
2775 )))
2779 ;; Number of recursive edits started by edebug.
2780 ;; Should be 0 at the top level.
2783 ;; Value of recursion-depth when edebug was called.
2785 ;; Dynamically declared unbound vars
2798 ;; Note: here we have defvars for variables that are
2799 ;; built-in in certain versions.
2800 ;; Each defvar makes a difference
2801 ;; in versions where the variable is *not* built-in.
2803 ;; Emacs 18 FIXME
2806 ;; Emacs 19.
2814 ;; Disable byte compiler warnings about unread-command-char and -event
2815 ;; (maybe works with byte-compile-version 2.22 at least)
2824 ;; Start up a recursive edit inside of edebug.
2825 ;; The current buffer is the edebug-buffer, which is put into edebug-mode.
2826 ;; Assume that none of the variables below are buffer-local.
2828 ;; match-data must be done in the outside buffer
2833 ;;(edebug-number-of-recursions (1+ edebug-number-of-recursions))
2835 edebug-entered ; bind locally to nil
2837 edebug-backtrace-buffer ; each recursive edit gets its own
2838 ;; The window configuration may be saved and restored
2839 ;; during a recursive-edit
2840 edebug-inside-windows
2859 )
2863 ;; Declare global values local but using the same global value.
2864 ;; We could set these to the values for previous edebug call.
2868 ;; Assume no edebug command sets unread-command-char.
2872 ;; More for Emacs 19
2879 ;; Bind again to outside values.
2883 ;; Don't keep defining a kbd macro.
2887 ;; others??
2888 )
2901 ;; Do the following, even if quit occurs.
2905 ;; Could be an option to keep eval display up.
2908 ;; Remember selected-window after recursive-edit.
2909 ;; (setq edebug-inside-window (selected-window))
2913 ;; Recursive edit may have changed buffers,
2914 ;; so set it back before exiting let.
2923 )
2924 ;; gotta have a buffer to let its buffer local variables be set
2928 ;; Reset global vars to outside values, in case they have been changed.
2930 last-command-event edebug-outside-last-command-event
2931 last-command edebug-outside-last-command
2932 this-command edebug-outside-this-command
2933 unread-command-char edebug-outside-unread-command-char
2934 current-prefix-arg edebug-outside-current-prefix-arg
2935 last-input-event edebug-outside-last-input-event
2936 last-event-frame edebug-outside-last-event-frame
2937 last-nonmenu-event edebug-outside-last-nonmenu-event
2938 track-mouse edebug-outside-track-mouse
2940 standard-output edebug-outside-standard-output
2941 standard-input edebug-outside-standard-input
2942 defining-kbd-macro edebug-outside-defining-kbd-macro
2943 ))
2944 ))
2947 ;;; Display related functions
2950 ;; If pos is not visible, adjust current window to fit following context.
2951 ;;; (message "window: %s old-start: %s window-start: %s pos: %s"
2952 ;;; (selected-window) old-start (window-start) (point)) (sit-for 5)
2955 ;; First try old-start
2960 ;; (message "resetting window start") (sit-for 2)
2967 ))
2983 )
2987 ;; Set up the overlay arrow at beginning-of-line in current buffer.
2988 ;; The arrow string is derived from edebug-arrow-alist and
2989 ;; edebug-execution-mode.
2998 "Toggle the saving and restoring of all windows.
2999 Also, each time you toggle it on, the inside and outside window
3000 configurations become the same as the current configuration."
3007 edebug-save-windows))))
3017 edebug-save-windows))
3018 ;; Problem: what about outside windows that are deleted inside?
3022 "Toggle the saving and restoring of the selected window.
3023 Also, each time you toggle it on, the inside and outside window
3024 configurations become the same as the current configuration."
3028 ;; Save all outside windows except the selected one.
3029 ;; Remove (selected-window) from outside-windows.
3036 edebug-outside-windows))
3049 "Toggle the saving and restoring of windows.
3050 With prefix, toggle for just the selected window.
3051 Otherwise, toggle for all windows."
3058 "Show the debug windows and where we stopped in the program."
3062 ;; Restore the window configuration to what it last was inside.
3063 ;; But it is not always set. - experiment
3064 ;;(if edebug-inside-windows
3065 ;; (edebug-set-windows edebug-inside-windows))
3070 "Change to the outside window configuration.
3071 Use `edebug-where' to return."
3084 "Bounce the point in the outside current buffer.
3085 If prefix argument ARG is supplied, sit for that many seconds
3086 before returning. The default is one second."
3091 ;; If the buffer's currently displayed, avoid set-window-configuration.
3103 ;; Joe Wells, here is a start at your idea of adding a buffer to the internal
3104 ;; display list. Still need to use this list in edebug-display.
3110 "Toggle display of a buffer inside of edebug."
3120 ;;; Breakpoint related functions
3123 ;; Return (function . index) of the nearest edebug stop point.
3130 ;; pull out parts of edebug-data.
3132 ;; (edebug-breakpoints (car (cdr edebug-data)))
3137 ;; skip backwards until non-whitespace, or bol
3140 edebug-def-mark))
3141 len i)
3142 ;; the offsets are in order so we can do a linear search
3149 ;; return the relevant info
3152 edebug-def-name)
3153 )))
3157 "Move point to the next breakpoint, or first if none past point."
3165 ;; pull out parts of edebug-data
3169 breakpoint)
3179 ;; goto the first breakpoint
3192 ))))))
3196 "Modify the breakpoint for the form at point or after it.
3197 Set it if FLAG is non-nil, clear it otherwise. Then move to that point.
3198 If CONDITION or TEMPORARY are non-nil, add those attributes to
3199 the breakpoint."
3206 ;; pull out parts of edebug-data
3210 present)
3211 ;; delete it either way
3216 ;; add it to the list and resort
3221 edebug-breakpoints) '<))
3224 edebug-def-name condition)
3232 ))))
3235 "Set the breakpoint of nearest sexp.
3236 With prefix argument, make it a temporary breakpoint."
3241 "Clear the breakpoint of nearest sexp."
3247 "Set `edebug-global-break-condition' to EXPRESSION."
3253 "Global Condition: " initial read-expression-map t
3260 ;;; Mode switching functions
3263 ;; Set the edebug mode to MODE.
3264 ;; Display SHORTMSG, or MSG if not within edebug.
3269 ;; Continue execution
3271 ;; This is not terribly useful!!
3279 "Proceed to next stop point."
3284 "Proceed to next `after' stop point."
3289 "Go, evaluating until break.
3290 With prefix ARG, set temporary break at current point and go."
3297 "Go, evaluating without debugging.
3298 You can use `edebug-stop', or any editing command, to stop."
3305 "Begin trace mode.
3306 Pauses for `edebug-sit-for-seconds' at each stop point."
3311 "Trace with no wait at each step.
3312 Updates the display at each stop point, but does not pause."
3318 "Begin continue mode.
3319 Pauses for `edebug-sit-for-seconds' at each break point."
3325 "Trace with no wait at each step.
3326 Updates the display at each break point, but does not pause."
3331 ;; ------------------------------------------------------------
3332 ;; The following use the mode changing commands and breakpoints.
3336 "Proceed to first stop-point at or after current position of point."
3342 "Stop execution and do not continue.
3343 Useful for exiting from trace or continue loop."
3349 "Proceed to the exit of the next expression to be evaluated."
3357 "Proceed from the current point to the end of the ARGth sexp ahead.
3358 If there are not ARG sexps ahead, then do `edebug-step-out'."
3362 ;; Call forward-sexp repeatedly until done or failure.
3367 )))
3370 "Proceed from the current point to the end of the containing sexp.
3371 If there is no containing sexp that is not the top level defun,
3372 go to the end of the last sexp, or if that is the same point, then step."
3378 ;; Is there still a containing expression?
3382 ;; At top level - 1, so first check if there are more sexps at this level.
3384 ;; (up-list 1)
3389 )))))
3392 ;; Func should be a function symbol.
3393 ;; Return the function symbol, or nil if not instrumented.
3397 ;; It is uninstrumented, so instrument it.
3401 func))
3404 func)
3412 func))))))
3415 "Instrument the definition of the function or macro about to be called.
3416 Do this when stopped before the form or it will be too late.
3417 One side effect of using this command is that the next time the
3418 function or macro is called, Edebug will be called there as well."
3433 "Step into the definition of the function or macro about to be called.
3434 This first does `edebug-instrument-callee' to ensure that it is
3435 instrumented. Then it does `edebug-on-entry' and switches to `go' mode."
3444 "Cause Edebug to stop when FUNCTION is called.
3445 With prefix argument, make this temporary so it is automatically
3446 canceled the first time the function is entered."
3448 ;; Could store this in the edebug data instead.
3459 ;; Also need edebug-cancel-debug-on-entry
3462 "Request FUNCTION to invoke debugger each time it is called.
3463 If the user continues, FUNCTION's execution proceeds.
3464 Works by modifying the definition of FUNCTION,
3465 which must be written in Lisp, not predefined.
3466 Use `cancel-debug-on-entry' to cancel the effect of this command.
3467 Redefining FUNCTION also does that.
3469 This version is from Edebug. If the function is instrumented for
3470 Edebug, it calls `edebug-on-entry'."
3479 "Set mode to Go-nonstop, and exit to top-level.
3480 This is useful for exiting even if `unwind-protect' code may be executed."
3486 ;;(defun edebug-exit-out ()
3487 ;; "Go until the current function exits."
3488 ;; (interactive)
3489 ;; (edebug-set-mode 'exiting "Exit..."))
3492 ;;; The following initial mode setting definitions are not used yet.
3502 )
3507 "Ask for the initial mode of the enclosing function.
3508 The mode is requested via the key that would be used to set the mode in
3509 edebug-mode."
3513 edebug-mode-map))
3515 edebug-initial-mode))
3518 "Change initial edebug mode for %s from %s (%s) to (enter key): "
3519 this-function
3520 old-mode
3523 keymap 'firstonly
3524 ))))
3526 )
3533 this-function mode))
3535 )))
3537 ;;; Evaluation of expressions
3542 "Evaluate an expression list in the outside context.
3543 Return the result of the last expression."
3547 ;; After excursion, we will
3548 ;; restore to current window configuration.
3551 ;; Restore outside windows.
3555 ;; (use-local-map edebug-outside-map)
3557 ;; Restore outside context.
3574 ;; Get the values out of the saved statuses.
3578 ;; See edebug-display
3582 )
3591 ;; Back to edebug-buffer. Restore rest of inside context.
3592 ;; (use-local-map edebug-inside-map)
3594 ;; Restore inside windows.
3597 ;; Save values that may have been changed.
3599 edebug-outside-last-command-event last-command-event
3600 edebug-outside-last-command last-command
3601 edebug-outside-this-command this-command
3602 edebug-outside-unread-command-char unread-command-char
3603 edebug-outside-unread-command-events unread-command-events
3604 edebug-outside-current-prefix-arg current-prefix-arg
3605 edebug-outside-last-input-event last-input-event
3606 edebug-outside-last-event-frame last-event-frame
3607 edebug-outside-last-nonmenu-event last-nonmenu-event
3608 edebug-outside-track-mouse track-mouse
3609 edebug-outside-standard-output standard-output
3610 edebug-outside-standard-input standard-input
3612 edebug-outside-executing-macro executing-kbd-macro
3613 edebug-outside-defining-kbd-macro defining-kbd-macro
3615 edebug-outside-o-a-p overlay-arrow-position
3616 edebug-outside-o-a-s overlay-arrow-string
3617 edebug-outside-c-i-e-a cursor-in-echo-area
3620 )
3622 ;; Restore the outside saved values; don't alter
3623 ;; the outside binding loci.
3629 ))
3634 ;; Are there cl lexical variables active?
3637 edebug-expr)
3638 lexical-binding))
3641 ;; Evaluate EXPR safely.
3642 ;; If there is an error, a string is returned describing the error.
3649 ;;; Printing
3653 ;; Print an error message like command level does.
3654 ;; This also prints the error name if it has no error-message.
3659 ;; continuing after an error may
3660 ;; complain about edebug-arg. why??
3665 ;; Alternatively, we could change the definition of
3666 ;; edebug-safe-prin1-to-string to only use these if defined.
3688 "Print the previous result."
3692 ;;; Read, Eval and Print
3701 "Evaluate an expression in the outside environment.
3702 If interactive, prompt for the expression.
3703 Print result in minibuffer."
3705 "Eval: " nil read-expression-map t
3714 "Evaluate sexp before point in the outside environment.
3715 Print value in minibuffer."
3720 "Evaluate sexp before point in outside environment; insert value.
3721 This prints the value into current buffer."
3729 ;; princ the string to get rid of quotes.
3732 ))
3734 ;;; Edebug Minor Mode
3737 "If non-nil, inhibit Edebug bindings on the C-x C-a key.
3738 By default, loading the `edebug' library causes these bindings to
3744 ;; Global GUD bindings for all emacs-lisp-mode buffers.
3753 ;; control
3763 ;;(define-key map "f" 'edebug-forward) not implemented
3771 ;; quitting and stopping
3777 ;; breakpoints
3784 ;; evaluation
3790 ;; views
3797 ;; misc
3803 ;; statistics
3806 ;; GUD bindings
3816 map))
3818 ;; Autoloading these global bindings doesn't make sense because
3819 ;; they cannot be used anyway unless Edebug is already loaded and active.
3835 ;; breakpoints
3841 ;; views
3845 ;; quitting
3850 ;; statistics
3852 map)
3860 "Describe `edebug-mode'."
3865 "Mode for Emacs Lisp buffers while in Edebug.
3867 In addition to all Emacs Lisp commands (except those that modify the
3868 buffer) there are local and global key bindings to several Edebug
3872 Also see bindings for the eval list buffer *edebug* in `edebug-eval-mode'.
3874 The edebug buffer commands:
3877 Global commands prefixed by `global-edebug-prefix':
3880 Options:
3881 `edebug-setup-hook'
3882 `edebug-all-defs'
3883 `edebug-all-forms'
3884 `edebug-save-windows'
3885 `edebug-save-displayed-buffer-points'
3886 `edebug-initial-mode'
3887 `edebug-trace'
3888 `edebug-test-coverage'
3889 `edebug-continue-kbd-macro'
3890 `edebug-print-length'
3891 `edebug-print-level'
3892 `edebug-print-circle'
3893 `edebug-on-error'
3894 `edebug-on-quit'
3895 `edebug-on-signal'
3896 `edebug-unwrap-results'
3897 `edebug-global-break-condition'"
3898 ;; If the user kills the buffer in which edebug is currently active,
3899 ;; exit to top level, because the edebug command loop can't usefully
3900 ;; continue running in such a case.
3905 "Used on `kill-buffer-hook' when Edebug is operating in a buffer of Lisp code."
3910 ;;; edebug eval list mode
3912 ;; A list of expressions and their evaluations is displayed in *edebug*.
3915 "Return a list of evaluations of `edebug-eval-list'."
3916 ;; Assumes in outside environment.
3917 ;; Don't do any edebug things now.
3923 ;; Assumes edebug-eval-buffer exists.
3937 ))
3945 ;; Should generalize this to be callable outside of edebug
3946 ;; with calls in user functions, e.g. (edebug-eval-display)
3949 "Display expressions and evaluations in EDEBUG-EVAL-RESULT-LIST.
3950 It modifies the context by popping up the eval display."
3955 )))
3958 "Redisplay eval list in outside environment.
3959 May only be called from within `edebug-recursive-edit'."
3963 ))
3973 "Replace the evaluation list with the sexps now in the eval buffer."
3976 new-list)
3978 ;; get the first expression
4000 "Delete the item under point and redisplay."
4001 ;; could add arg to do repeatedly
4021 map)
4027 "Mode for evaluation list buffer while in Edebug.
4029 In addition to all Interactive Emacs Lisp commands there are local and
4030 global key bindings to several Edebug specific commands. E.g.
4034 Eval list buffer commands:
4037 Global commands prefixed by `global-edebug-prefix':
4040 ;;; Interface with standard debugger.
4042 ;; (setq debugger 'edebug) ; to use the edebug debugger
4043 ;; (setq debugger 'debug) ; use the standard debugger
4045 ;; Note that debug and its utilities must be byte-compiled to work,
4046 ;; since they depend on the backtrace looking a certain way. But
4047 ;; edebug is not dependent on this, yet.
4050 "Replacement for `debug'.
4051 If we are running an edebugged function, show where we last were.
4052 Otherwise call `debug' normally."
4053 ;; (message "entered: %s depth: %s edebug-recursion-depth: %s"
4054 ;; edebug-entered (recursion-depth) edebug-recursion-depth) (sit-for 1)
4059 ;; Bind variables required by edebug-display
4061 edebug-breakpoints
4062 edebug-break-data
4063 edebug-break-condition
4064 edebug-global-break
4066 )
4069 nil
4070 edebug-value))
4072 ;; Otherwise call debug normally.
4073 ;; Still need to remove extraneous edebug calls from stack.
4075 ))
4079 "Display a non-working backtrace. Better than nothing..."
4085 ;; else, could just display edebug-backtrace-buffer
4086 )
4091 last-ok-point)
4094 ;; Clean up the backtrace.
4095 ;; Not quite right for current edebug scheme.
4102 ;; Delete interspersed edebug internals.
4107 ;; Previous lines may contain code, so just delete this line
4115 )))
4116 )))))
4118 \f
4119 ;;; Trace display
4122 "In buffer BUF-NAME, display FMT and ARGS at the end and make it visible.
4123 The buffer is created if it does not exist.
4124 You must include newlines in FMT to break lines, but one newline is appended."
4125 ;; e.g.
4126 ;; (edebug-trace-display "*trace-point*"
4127 ;; "saving: point = %s window-start = %s"
4128 ;; (point) (window-start))
4132 buf-window)
4133 ;; (message "before pop-to-buffer") (sit-for 1)
4139 ;; Make it visible.
4143 ;; (set-window-point buf-window (point))
4144 ;; (edebug-sit-for 0)
4148 buf-name)
4152 "Convenience call to `edebug-trace-display' using `edebug-trace-buffer'."
4155 \f
4156 ;;; Frequency count and coverage
4158 ;; FIXME should this use overlays instead?
4159 ;; Definitely, IMO. The current business with undo in
4160 ;; edebug-temp-display-freq-count is horrid.
4162 "Display the frequency count data for each line of the current definition.
4163 The frequency counts are inserted as comment lines after each line,
4164 and you can undo all insertions with one `undo' command.
4166 The counts are inserted starting under the `(' before an expression
4167 or the `)' after an expression, or on the last char of a symbol.
4168 The counts are only displayed when they differ from previous counts on
4169 the same line.
4171 If coverage is being tested, whenever all known results of an expression
4172 are `eq', the char `=' will be appended after the count
4173 for that expression. Note that this is always the case for an
4174 expression only evaluated once.
4176 To clear the frequency count and coverage data for a definition,
4177 reinstrument it."
4191 )
4193 ;; Traverse in reverse order so offsets are correct.
4195 ;; Start at last expression in line.
4199 last-index i)
4201 ;; Find all indexes on same line.
4204 ;; Insert all the indices for this line.
4207 first-index i ; really last index for line above this one.
4210 ;; i == first-index still
4230 ;; FIXME this does not work very well. Eg if you press an arrow key,
4231 ;; or make a mouse-click, it fails with "Non-character input-event".
4233 "Temporarily display the frequency count data for the current definition.
4234 It is removed when you hit any char."
4235 ;; This seems not to work with Emacs 18.59. It undoes too far.
4241 ;; Yuck! This doesn't seem to work at all for me.
4244 \f
4245 ;;; Menus
4251 ;; We have to require easymenu (even for Emacs 18) just so
4252 ;; the easy-menu-define macro call is compiled correctly.
4266 "----"
4271 "----"
4303 "----"
4313 ))
4316 \f
4317 ;;; Emacs version specific code
4325 "Set a conditional breakpoint at nearest sexp.
4326 The condition is evaluated in the outside context.
4327 With prefix argument, make it a temporary breakpoint."
4328 ;; (interactive "P\nxCondition: ")
4331 current-prefix-arg
4332 ;; Read condition as follows; getting previous condition is cumbersome:
4344 "Condition: " initial read-expression-map t
4351 \f
4352 ;;; Byte-compiler
4354 ;; Extension for bytecomp to resolve undefined function references.
4355 ;; Requires new byte compiler.
4357 ;; Reenable byte compiler warnings about unread-command-char and -event.
4358 ;; Disabled before edebug-recursive-edit.
4362 edebug-unread-command-char-warning)))
4365 ;; The body of eval-when-compile seems to get evaluated with eval-defun.
4366 ;; We only want to evaluate when actually byte compiling.
4367 ;; But it is OK to evaluate as long as byte-compiler has been loaded.
4371 "Say it is OK for the named functions to be unresolved."
4377 byte-compile-unresolved-functions))))
4378 funcs)
4379 nil)
4382 "Say it is OK for the named variables to be referenced."
4388 vars)
4389 nil)
4392 "Say it is OK for the named variables to be assigned."
4398 vars)
4399 nil)
4403 edebug-gensym ;; also in cl.el
4404 ;; Interfaces to standard functions.
4405 edebug-original-eval-defun
4406 edebug-original-read
4407 edebug-get-buffer-window
4408 edebug-mark
4409 edebug-mark-marker
4410 edebug-input-pending-p
4411 edebug-sit-for
4412 edebug-prin1-to-string
4413 edebug-format
4414 ;; lemacs
4415 zmacs-deactivate-region
4416 popup-menu
4417 ;; CL
4418 cl-macroexpand-all
4419 ;; And believe it or not, the byte compiler doesn't know about:
4420 byte-compile-resolve-functions
4421 ))
4425 read-expression-map))
4430 )))
4432 \f
4433 ;;; Autoloading of Edebug accessories
4435 ;; edebug-cl-read and cl-read are available from liberte@cs.uiuc.edu
4439 ;; The following causes edebug-cl-read to be loaded when you load cl-read.el.
4443 \f
4444 ;;; Finalize Loading
4446 ;; Finally, hook edebug into the rest of Emacs.
4447 ;; There are probably some other things that could go here.
4449 ;; Install edebug read and eval functions.
4454 ;;; edebug.el ends here