| blob | 3395259a04f2b0b65702ebdc6e3035986eefeab4 |
1 ;;; edebug.el --- a source-level debugger for Emacs Lisp
3 ;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1997, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 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 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; This minor mode allows programmers to step through Emacs Lisp
28 ;; source code while executing functions. You can also set
29 ;; breakpoints, trace (stopping at each expression), evaluate
30 ;; expressions as if outside Edebug, reevaluate and display a list of
31 ;; expressions, trap errors normally caught by debug, and display a
32 ;; debug style backtrace.
34 ;;; Minimal Instructions
35 ;; =====================
37 ;; First evaluate a defun with C-M-x, then run the function. Step
38 ;; through the code with SPC, mark breakpoints with b, go until a
39 ;; breakpoint is reached with g, and quit execution with q. Use the
40 ;; "?" command in edebug to describe other commands.
41 ;; See the Emacs Lisp Reference Manual for more details.
43 ;; If you wish to change the default edebug global command prefix, change:
44 ;; (setq edebug-global-prefix "\C-xX")
46 ;; Edebug was written by
47 ;; Daniel LaLiberte
48 ;; GTE Labs
49 ;; 40 Sylvan Rd
50 ;; Waltham, MA 02254
51 ;; liberte@holonexus.org
53 ;;; Code:
55 ;;; Bug reporting
59 ;;; Options
62 "A source-level debugger for Emacs Lisp."
67 "Functions to call before edebug is used.
68 Each time it is set to a new value, Edebug will call those functions
69 once and then `edebug-setup-hook' is reset to nil. You could use this
70 to load up Edebug specifications associated with a package you are
71 using but only when you also use Edebug."
75 ;; edebug-all-defs and edebug-all-forms need to be autoloaded
76 ;; because the byte compiler binds them; as a result, if edebug
77 ;; is first loaded for a require in a compilation, they will be left unbound.
79 ;;;###autoload
81 "If non-nil, evaluating defining forms instruments for Edebug.
82 This applies to `eval-defun', `eval-region', `eval-buffer', and
83 `eval-current-buffer'. `eval-region' is also called by
84 `eval-last-sexp', and `eval-print-last-sexp'.
86 You can use the command `edebug-all-defs' to toggle the value of this
87 variable. You may wish to make it local to each buffer with
88 \(make-local-variable 'edebug-all-defs) in your
89 `emacs-lisp-mode-hook'."
93 ;; edebug-all-defs and edebug-all-forms need to be autoloaded
94 ;; because the byte compiler binds them; as a result, if edebug
95 ;; is first loaded for a require in a compilation, they will be left unbound.
97 ;;;###autoload
99 "Non-nil evaluation of all forms will instrument for Edebug.
100 This doesn't apply to loading or evaluations in the minibuffer.
101 Use the command `edebug-all-forms' to toggle the value of this option."
106 "Non-nil means all macro call arguments may be evaluated.
107 If this variable is nil, the default, Edebug will *not* wrap
108 macro call arguments as if they will be evaluated.
109 For each macro, a `edebug-form-spec' overrides this option.
110 So to specify exceptions for macros that have some arguments evaluated
111 and some not, you should specify an `edebug-form-spec'."
116 "If non-nil, Edebug saves and restores the window configuration.
117 That takes some time, so if your program does not care what happens to
118 the window configurations, it is better to set this variable to nil.
120 If the value is a list, only the listed windows are saved and
121 restored.
123 `edebug-toggle-save-windows' may be used to change this variable."
128 "If non-nil, save and restore point in all displayed buffers.
130 Saving and restoring point in other buffers is necessary if you are
131 debugging code that changes the point of a buffer which is displayed
132 in a non-selected window. If Edebug or the user then selects the
133 window, the buffer's point will be changed to the window's point.
135 Saving and restoring point in all buffers is expensive, since it
136 requires selecting each window twice, so enable this only if you need
137 it."
142 "Initial execution mode for Edebug, if non-nil.
143 If this variable is non-nil, it specifies the initial execution mode
144 for Edebug when it is first activated. Possible values are step, next,
145 go, Go-nonstop, trace, Trace-fast, continue, and Continue-fast."
153 "Non-nil means display a trace of function entry and exit.
154 Tracing output is displayed in a buffer named `*edebug-trace*', one
155 function entry or exit per line, indented by the recursion level.
157 You can customize by replacing functions `edebug-print-trace-before'
158 and `edebug-print-trace-after'."
163 "If non-nil, Edebug tests coverage of all expressions debugged.
164 This is done by comparing the result of each expression with the
165 previous result. Coverage is considered OK if two different
166 results are found.
168 Use `edebug-display-freq-count' to display the frequency count and
169 coverage information for a definition."
174 "If non-nil, continue defining or executing any keyboard macro.
175 Use this with caution since it is not debugged."
181 "Default value of `print-length' for printing results in Edebug."
185 "Default value of `print-level' for printing results in Edebug."
189 "Default value of `print-circle' for printing results in Edebug."
194 "Non-nil if Edebug should unwrap results of expressions.
195 This is useful when debugging macros where the results of expressions
196 are instrumented expressions. But don't do this when results might be
197 circular or an infinite loop will result."
202 "Value bound to `debug-on-error' while Edebug is active.
204 If `debug-on-error' is non-nil, that value is still used.
206 If the value is a list of signal names, Edebug will stop when any of
207 these errors are signaled from Lisp code whether or not the signal is
208 handled by a `condition-case'. This option is useful for debugging
209 signals that *are* handled since they would otherwise be missed.
210 After execution is resumed, the error is signaled again."
219 "Value bound to `debug-on-quit' while Edebug is active."
224 "If non-nil, an expression to test for at every stop point.
225 If the result is non-nil, then break. Errors are ignored."
230 "Number of seconds to pause when execution mode is `trace'."
234 ;;; Form spec utilities.
237 "For compatibility with old version."
242 ;; Get the spec of symbol resolving all indirection.
244 indirect)
247 ;; (edebug-trace "indirection: %s" edebug-form-spec)
249 edebug-form-spec
250 ))
252 ;;;###autoload
254 "Return t if SPEC uses only extant spec symbols.
255 An extant spec symbol is a symbol that is not a function and has a
256 `edebug-form-spec' property."
262 t))
266 ;;; Utilities
268 ;; Define edebug-gensym - from old cl.el
273 "Generate a fresh uninterned symbol.
274 There is an optional argument, PREFIX. PREFIX is the string
275 that begins the new name. Most people take just the default,
276 except when debugging needs suggest otherwise."
286 newsymbol))
289 "Return t if OBJECT is a lambda list keyword.
290 A lambda list keyword is a symbol that starts with `&'."
296 ;; Return the last sexp before point in current buffer.
297 ;; Assumes Emacs Lisp syntax is active.
307 "Return a list of windows, in order of `next-window'."
308 ;; This doesn't work for epoch.
313 ;; Not used.
315 "Return t if there are two windows."
323 object)
326 "Return the macro named by OBJECT, or nil if it is not a macro."
331 object))
334 ;; Return the ALIST sorted with comparison function FUNCTION.
335 ;; This uses 'sort so the sorting is destructive.
340 ;;(def-edebug-spec edebug-save-restriction t)
342 ;; Not used. If it is used, def-edebug-spec must be defined before use.
344 "Evaluate BODY while saving the current buffers restriction.
345 BODY may change buffer outside of current restriction, unlike
346 save-restriction. BODY may change the current buffer,
347 and the restriction will be restored to the original buffer,
348 and the current buffer remains current.
349 Return the result of the last expression in BODY."
358 ;;; Display
364 ;; Like pop-to-buffer, but select window where BUFFER was last shown.
365 ;; Select WINDOW if it is provided and still exists. Otherwise,
366 ;; if buffer is currently shown in several windows, choose one.
367 ;; Otherwise, find a new window, possibly splitting one.
372 window)
374 ;; Selected window already displays BUFFER.
378 ;; When there's one window only, split it.
385 ;; Found a non-dedicated window not showing
386 ;; `edebug-trace-buffer', use it.
388 ;; All windows are dedicated or show `edebug-trace-buffer', split
389 ;; selected one.
394 ;; Selecting the window does not set the buffer until command loop.
395 ;;(set-buffer buffer)
396 )
399 ;; Return a list of buffer point pairs, for all displayed buffers.
405 list))))
406 list))
410 ;; Restore the buffer-points created by edebug-get-displayed-buffer-points.
416 buffer-points)))
419 ;; Get either a full window configuration or some window information.
428 which-windows)
432 ;; Set either a full window configuration or some window information.
445 one-window-info))))
446 window-info)
454 ;;; Redefine read and eval functions
455 ;; read is redefined to maybe instrument forms.
456 ;; eval-defun is redefined to check edebug-all-forms and edebug-all-defs.
458 ;; Save the original read function
463 "Read one Lisp expression as text from STREAM, return as Lisp object.
464 If STREAM is nil, use the value of `standard-input' (which see).
465 STREAM or the value of `standard-input' may be:
466 a buffer (read from point and advance it)
467 a marker (read from where it points and advance it)
468 a function (call it with no arguments for each character,
469 call it with a char as argument to push a char back)
470 a string (takes text from string, starting at the beginning)
471 t (read text line using minibuffer and use it).
473 This version, from Edebug, maybe instruments the expression. But the
474 STREAM must be the current buffer to do so. Whether it instruments is
475 also dependent on the values of `edebug-all-defs' and
476 `edebug-all-forms'."
485 ;; We should somehow arrange to be able to do this
486 ;; without actually replacing the eval-defun command.
488 "Evaluate the top-level form containing point, or after point.
490 If the current defun is actually a call to `defvar', then reset the
491 variable using its initial value expression even if the variable
492 already has some other value. (Normally `defvar' does not change the
493 variable's value if it already has a value.) Treat `defcustom'
494 similarly. Reinitialize the face according to `defface' specification.
496 With a prefix argument, instrument the code for Edebug.
498 Setting `edebug-all-defs' to a non-nil value reverses the meaning of
499 the prefix argument. Code is then instrumented when this function is
500 invoked without a prefix argument
502 If acting on a `defun' for FUNCTION, and the function was instrumented,
503 `Edebug: FUNCTION' is printed in the minibuffer. If not instrumented,
504 just FUNCTION is printed.
506 If not acting on a `defun', the result of evaluation is displayed in
507 the minibuffer."
515 ;; This should be consistent with `eval-defun-1', but not the
516 ;; same, since that gets a macroexpanded form.
519 ;; Force variable to be bound.
523 ;; Force variable to be bound.
526 ;; Reset the face.
530 ;; See comments in `eval-defun-1' for purpose of code below
540 edebug-result)))
543 ;;;###autoload
546 ;;;###autoload
548 "Evaluate the top level form point is in, stepping through with Edebug.
549 This is like `eval-defun' except that it steps the code for Edebug
550 before evaluating it. It displays the value in the echo area
551 using `eval-expression' (which see).
553 If you do this on a function definition such as a defun or defmacro,
554 it defines the function and instruments its definition for Edebug,
555 so it will do Edebug stepping when called later. It displays
556 `Edebug: FUNCTION' in the echo area to indicate that FUNCTION is now
557 instrumented for Edebug.
559 If the current defun is actually a call to `defvar' or `defcustom',
560 evaluating it this way resets the variable using its initial value
561 expression even if the variable already has some other value.
562 \(Normally `defvar' and `defcustom' do not alter the value if there
563 already is one.)"
566 ;; Bind edebug-all-forms only while reading, not while evalling
567 ;; but this causes problems while edebugging edebug.
579 ;; Recover point, but only if no error occurred.
583 ;; Compatibility with old versions.
586 ;;;###autoload
588 "Toggle edebugging of all definitions."
595 ;;;###autoload
597 "Toggle edebugging of all forms."
606 ;; Don't install if already installed.
617 ;;; Edebug internal data
619 ;; The internal data that is needed for edebugging is kept in the
620 ;; buffer-local variable `edebug-form-data'.
625 ;; A list of entries associating symbols with buffer regions.
626 ;; This is an automatic buffer local variable. Each entry looks like:
627 ;; @code{(@var{symbol} @var{begin-marker} @var{end-marker}). The markers
628 ;; are at the beginning and end of an entry level form and @var{symbol} is
629 ;; a symbol that holds all edebug related information for the form on its
630 ;; property list.
632 ;; In the future, the symbol will be irrelevant and edebug data will
633 ;; be stored in the definitions themselves rather than in the property
634 ;; list of a symbol.
654 ;; Find the edebug form data entry which is closest to PNT.
655 ;; If END-POINT is supplied, match must be exact.
656 ;; Return `nil' if none found.
658 closest-entry
671 closest-entry entry))))
672 closest-entry))
674 ;; Also need to find all contained entries,
675 ;; and find an entry given a symbol, which should be just assq.
678 ;; Return the edebug data symbol of the form where point is in.
679 ;; If point is not inside a edebuggable form, cause error.
684 ;; Make NEW-ENTRY the first element in the `edebug-form-data' list.
689 ;; If non-nil, clear ENTRY out of the form data.
690 ;; Maybe clear the markers and delete the symbol's edebug property?
693 ;; Instead of this, we could just find all contained forms.
694 ;; (put (car entry) 'edebug nil) ;
695 ;; (mapcar 'edebug-clear-form-data-entry ; dangerous
696 ;; (get (car entry) 'edebug-dependents))
697 ;; (set-marker (nth 1 entry) nil)
698 ;; (set-marker (nth 2 entry) nil)
701 ;;; Parser utilities
704 ;; Signal an invalid-read-syntax with ARGS.
709 ;; Lookup table for significant characters indicating the class of the
710 ;; token that follows. This is not a \"real\" syntax table.
727 ;; We treat numbers as symbols, because of confusion with -, -1, and 1-.
728 ;; We don't care about any other chars since they won't be seen.
729 table))
732 ;; Move to the next token and return its class. We only care about
733 ;; lparen, rparen, dot, quote, backquote, comma, string, char, vector,
734 ;; or symbol.
743 'symbol
748 ;; Leave point before the next token, skipping white space and comments.
755 ;; Mostly obsolete reader; still used in one case.
758 ;; Read one sexp from the current buffer starting at point.
759 ;; Leave point immediately after it. A sexp can be a list or atom.
760 ;; An atom is a symbol (or number), character, string, or vector.
761 ;; This works for reading anything legitimate, but it
762 ;; is gummed up by parser inconsistencies (bugs?)
765 ;; read goes one too far if a (possibly quoted) string or symbol
766 ;; is immediately followed by non-whitespace.
778 ;;; Offsets for reader
780 ;; Define a structure to represent offset positions of expressions.
781 ;; Each offset structure looks like: (before . after) for constituents,
782 ;; or for structures that have elements: (before <subexpressions> . after)
783 ;; where the <subexpressions> are the offset structures for subexpressions
784 ;; including the head of a list.
787 ;; Stack of offset structures in reverse order of the nesting.
788 ;; This is used to get back to previous levels.
792 ;; We must store whether we just read a list with a dotted form that
793 ;; is itself a list. This structure will be condensed, so the offsets
794 ;; must also be condensed.
798 ;; Reinitialize offset recording.
802 ;; Add a new offset pair with POINT as the before offset.
807 ;; Otherwise, we are at the top level, so initialize.
809 edebug-offsets-stack nil
810 edebug-read-dotted-list nil))
811 ;; Cons the new offset to the front of the stack.
813 edebug-current-offset new-offset)
814 ))
817 ;; Finalize the current offset struct by reversing it and
818 ;; store POINT as the after offset.
820 ;; Just reverse the offsets of all subexpressions.
823 ;; We just read a list after a dot, which will be abbreviated out.
825 ;; Drop the corresponding offset pair.
826 ;; That is, nconc the reverse of the rest of the offsets
827 ;; with the cdr of last offset.
832 ;; Now append the point using nconc.
834 ;; Pop the stack.
839 ;; Ignore the last created offset pair.
851 ;;; Reader for Emacs Lisp.
853 ;; Uses edebug-next-token-class (and edebug-skip-whitespace) above.
864 ))
871 ;; anything else, just read it.
873 stream))))
882 ;; Turn 'thing into (quote thing)
889 "If non-zero, we're in a new-style backquote.
893 ;; Turn `thing into (\` thing)
901 ;; Turn ,thing into (\, thing). Handle ,@ and ,. also.
911 ;; Generate the same structure of offsets we would have
912 ;; if the resulting list appeared verbatim in the input text.
921 ;; Turn #'thing into (function thing)
944 ;; Old style backquote.
946 ;; Call edebug-storing-offsets here so that we
947 ;; produce the same offsets we would have had
948 ;; if the backquote were an ordinary symbol.
960 ))
961 elements)
963 ))
973 ))
975 ;;; Cursors for traversal of list and vector elements with offsets.
980 ;; Return a new cursor for EXPRESSIONS with OFFSETS.
986 ;; Set the CURSOR's EXPRESSIONS and OFFSETS to the given.
987 ;; Return the cursor.
990 cursor)
993 ;; Copy the cursor using the same object and offsets.
1002 ;; Return non-nil if CURSOR is empty - meaning no more elements.
1006 ;; Return the top element at the cursor.
1007 ;; Assumes not empty.
1011 ;; Check if a dotted form is required.
1013 ;; Check if there is at least one more argument.
1015 ;; Return that top element.
1019 ;; Return the top offset pair corresponding to the top element.
1023 ;; Advance and return the cursor to the next element and offset.
1024 ;; throw no-match if empty before moving.
1025 ;; This is a violation of the cursor encapsulation, but
1026 ;; there is plenty of that going on while matching.
1027 ;; The following test should always fail.
1032 cursor)
1036 ;; Return the before offset of the cursor.
1037 ;; If there is nothing left in the offsets,
1038 ;; return one less than the offset itself,
1039 ;; which is the after offset for a list.
1046 ;; Return the after offset of the cursor object.
1050 offset))
1052 ;;; The Parser
1054 ;; The top level function for parsing forms is
1055 ;; edebug-read-and-maybe-wrap-form; it calls all the rest. It checks the
1056 ;; syntax a bit and leaves point at any error it finds, but otherwise
1057 ;; should appear to work like eval-defun.
1059 ;; The basic plan is to surround each expression with a call to
1060 ;; the edebug debugger together with indexes into a table of positions of
1061 ;; all expressions. Thus an expression "exp" becomes:
1063 ;; (edebug-after (edebug-before 1) 2 exp)
1065 ;; When this is evaluated, first point is moved to the beginning of
1066 ;; exp at offset 1 of the current function. The expression is
1067 ;; evaluated, which may cause more edebug calls, and then point is
1068 ;; moved to offset 2 after the end of exp.
1070 ;; The highest level expressions of the function are wrapped in a call to
1071 ;; edebug-enter, which supplies the function name and the actual
1072 ;; arguments to the function. See functions edebug-enter, edebug-before,
1073 ;; and edebug-after for more details.
1075 ;; Dynamically bound vars, left unbound, but globally declared.
1076 ;; This is to quiet the byte compiler.
1078 ;; Window data of the highest definition being wrapped.
1079 ;; This data is shared by all embedded definitions.
1094 ;; Read a form and wrap it with edebug calls, if the conditions are right.
1095 ;; Here we just catch any no-match not caught below and signal an error.
1097 ;; Run the setup hook.
1098 ;; If it gets an error, make it nil.
1104 edebug-top-window-data
1105 edebug-def-name;; make sure it is locally nil
1106 ;; I don't like these here!!
1107 edebug-&optional
1108 edebug-&rest
1109 edebug-gate
1110 edebug-best-error
1111 edebug-error-point
1112 no-match
1113 ;; Do this once here instead of several times.
1119 nil))
1122 result))
1127 def-kind
1128 defining-form-p
1129 def-name
1130 ;; These offset things don't belong here, but to support recursive
1131 ;; calls to edebug-read, they need to be here.
1132 edebug-offsets
1133 edebug-offsets-stack
1134 edebug-current-offset ; reset to nil
1135 )
1139 ;; Find out if this is a defining form from first symbol
1144 ;; This is incorrect in general!! But OK most of the time.
1149 ;;;(message "all defs: %s all forms: %s" edebug-all-defs edebug-all-forms)
1153 ;; If it is a defining form and we are edebugging defs,
1154 ;; then let edebug-list-form start it.
1160 cursor
1165 ;; Not edebugging this form, so reset the symbol's edebug
1166 ;; property to be just a marker at the definition's source code.
1167 ;; This only works for defs with simple names.
1169 ;; Also nil out dependent defs.
1176 ;; If all forms are being edebugged, explicitly wrap it.
1182 cursor
1185 nil)))
1187 ;; Not a defining form, and not edebugging.
1189 ))
1195 ;; Currently def-form sets this to nil; def-body sets it to t.
1198 ;; Return a unique symbol for the variable used to store the
1199 ;; status of interactive-p for this function.
1204 "Wrap the FORMS of a definition body."
1213 ;; Generate the enter wrapper for some forms of a definition.
1214 ;; This is not to be used for the body of other forms, e.g. `while',
1215 ;; since it wraps the list of forms with a call to `edebug-enter'.
1216 ;; Uses the dynamically bound vars edebug-def-name and edebug-def-args.
1217 ;; Do this after parsing since that may find a name.
1224 ;; Doesn't work with more than one def-body!!
1225 ;; But the list will just be reversed.
1229 ))
1238 ;; modifies edebug-offset-index and edebug-offset-list
1239 ;; accesses edebug-func-marc and buffer point
1241 edebug-offset-index
1243 edebug-offset-list)
1248 ;; Return the edebug form for the current function at offset BEFORE-INDEX
1249 ;; given FORM. Looks like:
1250 ;; (edebug-after (edebug-before BEFORE-INDEX) AFTER-INDEX FORM)
1251 ;; Also increment the offset index for subsequent use.
1254 after-index form))
1257 ;; Like edebug-make-before-and-after-form, but only after.
1262 "Return the unwrapped SEXP or return it as is if it is not wrapped.
1263 The SEXP might be the result of wrapping a body, which is a list of
1264 expressions; a `progn' form will be returned enclosing these forms."
1275 )
1276 sexp))
1279 "Return the SEXP recursively unwrapped."
1286 new-sexp)))
1290 ;; Process the defining form, starting outside the form.
1291 ;; The speclist is a generated list spec that looks like:
1292 ;; (("def-symbol" defining-form-spec-sans-&define))
1293 ;; Skip the first offset.
1297 cursor
1299 speclist))
1303 ;; Wrap a form, usually a defining form, but any evaluated one.
1304 ;; If speclist is non-nil, this is being called by edebug-defining-form.
1305 ;; Otherwise it is being called from edebug-read-and-maybe-wrap-form1.
1306 ;; This is a hack, but I havent figured out a simpler way yet.
1308 ;; Set this marker before parsing.
1312 ;; Buffer must be current-buffer for this to work:
1317 result
1318 ;; For definitions.
1319 ;; (edebug-containing-def-name edebug-def-name)
1320 ;; Get name from form-data, if any.
1322 edebug-def-name
1323 edebug-def-args
1324 edebug-def-interactive
1325 edebug-inside-func;; whether wrapped code executes inside a function.
1326 )
1332 ;; else wrap as an enter-form.
1335 ;; Set the name here if it was not set by edebug-make-enter-wrapper.
1339 ;; Add this def as a dependent of containing def. Buggy.
1347 ;; Create a form-data-entry or modify existing entry's markers.
1348 ;; In the latter case, pointers to the entry remain eq.
1352 edebug-def-name
1353 edebug-form-begin-marker
1354 ;; Buffer must be current-buffer.
1356 ))
1358 form-data-entry edebug-def-name ;; in case name is changed
1359 form-begin form-end))
1361 ;; (message "defining: %s" edebug-def-name) (sit-for 2)
1364 ;;(debug edebug-def-name)
1366 ;; Destructively reverse edebug-offset-list and make vector from it.
1369 ;; Side effects on the property list of edebug-def-name.
1373 ;; Set up the initial window data.
1381 ;; Store the edebug data in symbol's property list.
1383 ;; A struct or vector would be better here!!
1385 nil ; clear breakpoints
1386 edebug-offset-list
1387 edebug-top-window-data
1388 ))
1389 result
1390 )))
1394 ;; Create initial frequency count vector.
1395 ;; For each stop point, the counter is incremented each time it is visited.
1401 ;; Create initial coverage vector.
1402 ;; Only need one per expression, but it is simpler to use stop points.
1408 ;; Return the instrumented form for the following form.
1409 ;; Add the point offsets to the edebug-offset-list for the form.
1415 ;; The first offset for a list form is for the list form itself.
1417 form
1421 ;; Find out if this is a defining form from first symbol.
1422 ;; An indirect spec would not work here, yet.
1425 new-cursor
1429 ;; Wrap a regular form.
1433 ;; After processing the list form, the new-cursor is left
1434 ;; with the offset after the form.
1436 )))
1440 ;; Check for constant symbols that don't get wrapped.
1443 form)
1448 ;; Anything else is self-evaluating.
1457 ;; Process the arguments of a list form given that head of form is a symbol.
1458 ;; Helper for edebug-list-form
1464 ;; It is a speclist.
1471 ; but leave it in for compatibility.
1472 ))
1473 ;; No edebug-form-spec provided.
1483 ;; Return an instrumented form built from the list form.
1484 ;; The after offset will be left in the cursor after processing the form.
1486 ;; Prevent backtracking whenever instrumenting.
1488 ;; A list form is never optional because it matches anything.
1491 ;; Skip the first offset.
1499 ;; Special case: replace (interactive-p) with variable
1509 ;; The head of a form should normally be a symbol or a lambda
1510 ;; expression but it can also be an unquote form to be filled
1511 ;; before evaluation. We evaluate the arguments anyway, on the
1512 ;; assumption that the unquote form will place a proper function
1513 ;; name (rather than a macro name).
1515 ;; Process anonymous function and args.
1516 ;; This assumes no anonymous macros.
1521 ))
1523 ;;; Matching of specs.
1531 ;;; Failure to match
1533 ;; This throws to no-match, if there are higher alternatives.
1534 ;; Otherwise it signals an error. The place of the error is found
1535 ;; with the two before- and after-offset functions.
1538 ;; Throw a no-match, or signal an error immediately if gate is active.
1539 ;; Remember this point in case we need to report this error.
1552 ;; Top level spec matching function.
1553 ;; Used also at each lower level of specs.
1555 edebug-&rest
1556 edebug-best-error
1557 edebug-error-point
1559 )
1564 ;; Match one spec, which is not a keyword &-spec.
1570 ))
1574 ;; Append results of matching the list of specs.
1575 ;; The first spec is handled and the remainder-handler handles the rest.
1583 ;; Is the spec dotted?
1588 ;; Is the form dotted?
1592 ;; Cancel dotted spec and dotted form.
1596 ;; Wrap the form in a list, (by changing the cursor??)...
1598 ;; and process normally, then unwrap the result.
1605 ;;(message "spec = %s first char = %s" spec first-char) (sit-for 1)
1619 ;; Define specs for all the symbol specs with functions used to process them.
1620 ;; Perhaps we shouldn't be doing this with edebug-form-specs since the
1621 ;; user may want to define macros or functions with the same names.
1622 ;; We could use an internal obarray for these primitive specs.
1636 ;; Less frequently used:
1637 ;; (function . edebug-match-function)
1643 ;; (nil . edebug-match-nil) not this one - special case it.
1644 ))
1648 ;; Match a symbol spec.
1653 ;; It is an indirect spec.
1655 ;; Otherwise it should be the symbol name of a function.
1656 ;; There could be a bug here - maybe need to do edebug-match bindings.
1664 ;; Special case for edebug-`.
1672 )))
1683 ;; Currently identical to edebug-match-form.
1684 ;; This is for common lisp setf-style place arguments.
1689 ;; Keep matching until one spec fails.
1701 ;; Returning nil means no no-match was thrown.
1702 nil))
1703 result
1704 ;; no-match, but don't fail; just reset cursor and return nil.
1706 nil)))
1711 ;; Reuse the &optional handler with this as the remainder handler.
1715 ;; Repeatedly use specs until failure.
1717 edebug-best-error
1718 edebug-error-point)
1723 ;; Keep matching until one spec succeeds, and return its results.
1724 ;; If none match, fail.
1725 ;; This needs to be optimized since most specs spend time here.
1734 edebug-best-error
1735 edebug-error-point)
1736 ;; Doesn't support e.g. &or symbolp &rest form
1738 ;; Match failed, so reset and try again.
1740 ;; Reset the cursor for the next match.
1742 ;; All failed.
1744 ))
1748 ;; If any specs match, then fail
1753 nil))
1754 ;; This means something matched, so it is a no match.
1756 ;; This means nothing matched, so it is OK.
1763 ;; Following specs must look like (<name> <spec>) ...
1764 ;; where <name> is the name of a keyword, and spec is its spec.
1765 ;; This really doesn't save much over the expanded form and takes time.
1767 cursor
1772 specs))))
1776 ;; Simply set the gate to prevent backtracking at this level.
1778 nil)
1782 ;; The spec is a list, but what kind of list, and what context?
1784 ;; After dotted spec but form did not contain dot,
1785 ;; so match list spec elements as if spliced in.
1789 ;; If it matched, really clear the dotted-spec flag.
1798 ;; Special case: spec quotes a symbol to match.
1799 ;; Change in future. Use "..." instead.
1804 form)
1811 ;; First offset is for the list form itself.
1812 ;; Treat nil as empty list.
1814 specs))
1818 ;; Special case: match a vector with the specs.
1827 )))
1831 ;; Match a sublist of specs.
1833 ;;edebug-best-error
1834 ;;edebug-error-point
1835 )
1837 ;; match with edebug-match-specs so edebug-best-error is not bound.
1842 ;; A failed &rest or &optional spec may leave some args.
1844 )))))
1851 ;; Since it matched, failure means immediate error, unless &optional.
1855 )))
1858 ;; There must be nothing left to match a nil.
1861 nil))
1868 ;; Match a defining form.
1869 ;; Normally, &define is interpreted specially other places.
1870 ;; This should only be called inside of a spec list to match the remainder
1871 ;; of the current list. e.g. ("lambda" &define args def-body)
1873 cursor
1875 ;; Find the last offset in the list.
1878 offsets)
1879 specs))
1882 ;; The expression must be a function.
1883 ;; This will match any list form that begins with a symbol
1884 ;; that has an edebug-form-spec beginning with &define. In
1885 ;; practice, only lambda expressions should be used.
1886 ;; I could add a &lambda specification to avoid confusion.
1893 ;; Find out if this is a defining form from first symbol.
1904 )))
1908 ;; Set the edebug-def-name bound in edebug-defining-form.
1910 ;; Maybe strings and numbers could be used.
1915 ;; Construct a new name by appending to previous name.
1917 name))
1922 ;; Set the edebug-def-name to the spec.
1925 ;; Construct a new name by appending to previous name.
1927 spec))
1928 nil)
1931 ;; set the def-args bound in edebug-defining-form
1941 ;; Like form but the form is wrapped in edebug-enter form.
1942 ;; The form is assumed to be executing outside of the function context.
1943 ;; This is a hack for now, since a def-form might execute inside as well.
1944 ;; Not to be used otherwise.
1949 ;; Like body but body is wrapped in edebug-enter form.
1950 ;; The body is assumed to be executing inside of the function context.
1951 ;; Not to be used otherwise.
1956 ;;;; Edebug Form Specs
1957 ;;; ==========================================================
1958 ;;; See cl-specs.el for common lisp specs.
1960 ;;;;* Spec for def-edebug-spec
1961 ;;; Out of date.
1964 "Return non-nil if OBJECT is a symbol with an edebug-form-spec property."
1969 ;; Top level is different from lower levels.
1974 ;; A list must have something in it, or it is nil, a symbolp
1978 (&or
1982 edebug-spec-list
1983 stringp
1986 edebug-spec-p ;; Including all the special ones e.g. form.
1987 symbolp;; a predicate
1988 ))
1991 ;;;* Emacs special forms and some functions.
1993 ;; quote expects only one argument, although it allows any number.
1996 ;; The standard defining forms.
2001 (&define name lambda-list
2004 def-body))
2014 )))
2019 ;; A function-form is for an argument that may be a function or a form.
2020 ;; This specially recognizes anonymous functions quoted with quote.
2022 ;; form at the end could also handle "function",
2023 ;; but recognize it specially to avoid wrapping function forms.
2026 ;; function expects a symbol or a lambda or macro expression
2027 ;; A macro is allowed by Emacs.
2030 ;; lambda is a macro in emacs 19.
2034 def-body))
2036 ;; A macro expression is a lambda expression with "macro" prepended.
2039 ;; (def-edebug-spec anonymous-form ((&or ["lambda" lambda] ["macro" macro])))
2041 ;; Standard functions that take function-forms arguments.
2050 body))
2061 form
2067 ;; Supports quotes inside backquotes,
2068 ;; but only at the top level inside unquotes.
2070 (&or
2072 ;; The simple version:
2073 ;; (backquote-form &rest backquote-form)
2074 ;; doesn't handle (a . ,b). The straightforward fix:
2075 ;; (backquote-form . [&or nil backquote-form])
2076 ;; uses up too much stack space.
2077 ;; Note that `(foo . ,@bar) is not valid, so we don't need to handle it.
2080 ;; If you use dotted forms in backquotes, replace the previous line
2081 ;; with the following. This takes quite a bit more stack space, however.
2082 ;; (backquote-form . [&or nil backquote-form])
2084 sexp))
2086 ;; Special version of backquote that instruments backquoted forms
2087 ;; destined to be evaluated, usually as the result of a
2088 ;; macroexpansion. Backquoted code can only have unquotes (, and ,@)
2089 ;; in places where list forms are allowed, and predicates. If the
2090 ;; backquote is used in a macro, unquoted code that come from
2091 ;; arguments must be instrumented, if at all, with def-form not def-body.
2093 ;; We could assume that all forms (not nested in other forms)
2094 ;; in arguments of macros should be def-forms, whether or not the macros
2095 ;; are defined with edebug-` but this would be expensive.
2097 ;; ,@ might have some problems.
2102 ;; Assume immediate quote in unquotes mean backquote at next higher level.
2107 ;; New byte compiler.
2126 ;; Anything else?
2129 ;; Some miscellaneous specs for macros in public packages.
2130 ;; Send me yours.
2132 ;; advice.el by Hans Chalupsky (hans@cs.buffalo.edu)
2138 ;; "activation" "deactivation"]
2139 name ;; name of advice
2141 )
2144 def-body))
2153 ;;; The debugger itself
2157 ;;; add minor-mode-alist entry
2160 minor-mode-alist)))
2163 ;; Stack of active functions evaluated via edebug.
2164 ;; Should be nil at the top level.
2167 ;; Index of last edebug-stack item.
2170 ;; Stack of offset indices of visited edebug sexps.
2171 ;; Should be nil at the top level.
2172 ;; Each function adds one cons. Top is modified with setcar.
2176 ;; Non-nil if edebug has already been entered at this recursive edit level.
2177 ;; This should stay nil at the top level.
2178 )
2180 ;; Should these be options?
2182 ;; Name of function to use for debugging when error or quit occurs.
2183 ;; Set this to 'debug if you want to debug edebug.
2184 )
2187 ;; Dynamically bound variables, declared globally but left unbound.
2216 ;;; Handling signals
2219 "Signal an error. Args are SIGNAL-NAME, and associated DATA.
2220 A signal name is a symbol with an `error-conditions' property
2221 that is a list of condition names.
2222 A handler for any of those names will get to handle this signal.
2223 The symbol `error' should always be one of them.
2225 DATA should be a list. Its elements are printed as part of the error message.
2226 If the signal is handled, DATA is made available to the handler.
2227 See `condition-case'.
2229 This is the Edebug replacement for the standard `signal'. It should
2230 only be active while Edebug is. It checks `debug-on-error' to see
2231 whether it should call the debugger. When execution is resumed, the
2232 error is signaled again.
2236 ;; If we reach here without another non-local exit, then send signal again.
2237 ;; i.e. the signal is not continuable, yet.
2238 ;; Avoid infinite recursion.
2242 ;;; Entering Edebug
2245 ;; Entering FUNC. The arguments are ARGS, and the body is BODY.
2246 ;; Setup edebug variables and evaluate BODY. This function is called
2247 ;; when a function evaluated with edebug-eval-top-level-form is entered.
2248 ;; Return the result of BODY.
2250 ;; Is this the first time we are entering edebug since
2251 ;; lower-level recursive-edit command?
2252 ;; More precisely, this tests whether Edebug is currently active.
2255 ;; Binding max-lisp-eval-depth here is OK,
2256 ;; but not inside an unwind-protect.
2257 ;; Doing it here also keeps it from growing too large.
2264 ;; Binding these may not be the right thing to do.
2265 ;; We want to allow the global values to be changed.
2269 ;; Lexical bindings must be uncompiled for this to work.
2274 overriding-terminal-local-map)
2276 ;; Save the outside value of executing macro. (here??)
2284 ;; within edebug unless edebug-continue-kbd-macro is
2285 ;; non-nil. Again, local binding may not be best.
2289 ;; Don't get confused by the user's keymap changes.
2295 ;; Disable command hooks. This is essential when
2296 ;; a hook function is instrumented - to avoid infinite loop.
2297 ;; This may be more than we need, however.
2301 edebug-initial-mode
2302 edebug-execution-mode)
2303 edebug-next-execution-mode nil)
2305 ;; Reset global variables in case outside value was changed.
2320 )
2329 )))
2332 "Return a cons cell describing the status of VAR's current binding.
2333 The purpose of this function is so you can properly undo
2334 subsequent changes to the same binding, by passing the status
2335 cons cell to `edebug-restore-status'. The status cons cell
2336 has the form (LOCUS . VALUE), where LOCUS can be a buffer
2337 \(for a buffer-local binding), a frame (for a frame-local binding),
2338 or nil (if the default binding is current)."
2343 "Reset VAR based on STATUS.
2344 STATUS should be a list returned by `edebug-var-status'."
2358 edebug-result)
2368 "Print MSG in *edebug-trace* before and after evaluating BODY.
2369 The result of BODY is also printed."
2371 edebug-result)
2378 "Function called to print trace info before expression evaluation.
2379 MSG is printed after `::::{ '."
2384 "Function called to print trace info after expression evaluation.
2385 MSG is printed after `::::} '."
2393 ;; Debug current function given BEFORE position.
2394 ;; Called from functions compiled with edebug-eval-top-level-form.
2395 ;; Return the before index.
2398 ;; Increment frequency count
2405 edebug-before-index)
2408 ;; Do nothing.
2409 )
2413 edebug-value
2414 ;; Debug current function given AFTER position and VALUE.
2415 ;; Called from functions compiled with edebug-eval-top-level-form.
2416 ;; Return VALUE.
2419 ;; Increment frequency count
2426 ;; Just return result.
2427 edebug-value
2429 )))
2432 ;; Do nothing but return the value.
2433 edebug-value)
2439 ;; This is not used, yet.
2453 ;; Test if a different result.
2458 ;; Dynamically declared unbound variables.
2472 ;; Don't really try to enter edebug within an eval from redisplay.
2473 edebug-value
2474 ;; Check breakpoints and pending input.
2475 ;; If edebug display should be updated, call edebug-display.
2476 ;; Return edebug-value.
2489 ;;; (edebug-trace "exp: %s" edebug-value)
2490 ;; Test whether we should break.
2499 ;; Delete the breakpoint.
2504 ;; Display if mode is not go, continue, or Continue-fast
2505 ;; or break, or input is pending,
2507 edebug-break
2511 edebug-value
2512 )))
2515 ;; window-start now stored with each function.
2516 ;;(defvar edebug-window-start nil)
2517 ;; Remember where each buffers' window starts between edebug calls.
2518 ;; This is to avoid spurious recentering.
2519 ;; Does this still need to be buffer-local??
2520 ;;(setq-default edebug-window-start nil)
2521 ;;(make-variable-buffer-local 'edebug-window-start)
2524 ;; Dynamically declared unbound vars
2541 ;; Emacs 19 adds an arg to mark and mark-marker.
2547 ;; The buffer holding the source has been killed.
2548 ;; Let's at least show a backtrace so the user can figure out
2549 ;; which function we're talking about.
2551 ;; Setup windows for edebug, determine mode, maybe enter recursive-edit.
2552 ;; Uses local variables of edebug-enter, edebug-before, edebug-after
2553 ;; and edebug-debugger.
2556 edebug-stop ; should we enter recursive-edit
2559 edebug-buffer-outside-point ; current point in edebug-buffer
2560 ;; window displaying edebug-buffer
2567 edebug-outside-windows ; window or screen configuration
2568 edebug-buffer-points
2570 edebug-eval-buffer ; declared here so we can kill it below
2573 edebug-trace-window
2574 edebug-trace-window-start
2586 ;; any others??
2587 )
2593 ;; Compute result string now before windows are modified.
2597 ;; Save windows now before we modify them.
2604 ;; First move the edebug buffer point to edebug-point
2605 ;; so that window start doesn't get changed when we display it.
2606 ;; I don't know if this is going to help.
2607 ;;(set-buffer edebug-buffer)
2608 ;;(goto-char edebug-point)
2610 ;; If edebug-buffer is not currently displayed,
2611 ;; first find a window for it.
2615 ;; Now display eval list, if any.
2616 ;; This is done after the pop to edebug-buffer
2617 ;; so that buffer-window correspondence is correct after quitting.
2619 ;; The evaluation list better not have deleted edebug-window-data.
2627 ;; Check whether positions are up-to-date.
2628 ;; This assumes point is never before symbol.
2632 edebug-function)
2633 )))
2638 ;; Test if there is input, not including keyboard macros.
2642 edebug-stop t)
2644 ;; (discard-input) ; is this unfriendly??
2645 ))
2646 ;; Now display arrow based on mode.
2651 ;; Display error message
2662 edebug-global-break-condition
2663 edebug-global-break-result))
2666 edebug-break-condition
2667 edebug-break-result))
2677 ;; Display result of previous evaluation.
2690 ;; not edebug-break
2701 ;; (setq edebug-execution-mode 'step)
2702 ;; (edebug-overlay-arrow) ; This doesn't always show up.
2705 ;; Reset the edebug-window-data to whatever it is now.
2709 ;; Remember window-start for edebug-buffer, if still displayed.
2715 ;; Save trace window point before restoring outside windows.
2716 ;; Could generalize this for other buffers.
2723 ;; Restore windows before continuing.
2728 ;; Restore displayed buffer points.
2729 ;; Needed even if restoring windows because
2730 ;; window-points are not restored. (should they be??)
2734 ;; Unrestore trace window's window-point.
2737 edebug-trace-window-start))
2739 ;; Unrestore edebug-buffer's window-start, if displayed.
2746 ;; Unrestore edebug-buffer's window-point.
2747 ;; Needed in addition to setting the buffer point
2748 ;; - otherwise quitting doesn't leave point as is.
2749 ;; But this causes point to not be restored at times.
2750 ;; Also, it may not be a visible window.
2751 ;; (set-window-point window edebug-point)
2752 )))
2754 ;; Unrestore edebug-buffer's point. Rerestored below.
2755 ;; (goto-char edebug-point) ;; in edebug-buffer
2756 )
2757 ;; Since we may be in a save-excursion, in case of quit,
2758 ;; reselect the outside window only.
2759 ;; Only needed if we are not recovering windows??
2764 ;; Restore current buffer always, in case application needs it.
2767 ;; Restore point, and mark.
2768 ;; Needed even if restoring windows because
2769 ;; that doesn't restore point and mark in the current buffer.
2770 ;; But don't restore point if edebug-buffer is current buffer.
2774 ;; Does zmacs-regions need to be nil while doing set-marker?
2777 ;; None of the following is done if quit or signal occurs.
2779 ;; Restore edebug-buffer's outside point.
2780 ;; (edebug-trace "restore edebug-buffer point: %s"
2781 ;; edebug-buffer-outside-point)
2786 ;; ... nothing more.
2787 )
2789 ;; Reset global variables to outside values in case they were changed.
2791 unread-command-events edebug-outside-unread-command-events
2792 overlay-arrow-position edebug-outside-o-a-p
2793 overlay-arrow-string edebug-outside-o-a-s
2794 cursor-in-echo-area edebug-outside-c-i-e-a
2795 default-cursor-in-non-selected-windows edebug-outside-d-c-i-n-s-w)
2796 )))
2800 ;; Number of recursive edits started by edebug.
2801 ;; Should be 0 at the top level.
2804 ;; Value of recursion-depth when edebug was called.
2806 ;; Dynamically declared unbound vars
2821 ;; Note: here we have defvars for variables that are
2822 ;; built-in in certain versions.
2823 ;; Each defvar makes a difference
2824 ;; in versions where the variable is *not* built-in.
2826 ;; Emacs 18
2829 ;; Emacs 19.
2837 ;; Disable byte compiler warnings about unread-command-char and -event
2838 ;; (maybe works with byte-compile-version 2.22 at least)
2847 ;; Start up a recursive edit inside of edebug.
2848 ;; The current buffer is the edebug-buffer, which is put into edebug-mode.
2849 ;; Assume that none of the variables below are buffer-local.
2851 ;; match-data must be done in the outside buffer
2857 ;;(edebug-number-of-recursions (1+ edebug-number-of-recursions))
2859 edebug-entered ; bind locally to nil
2861 edebug-backtrace-buffer ; each recursive edit gets its own
2862 ;; The window configuration may be saved and restored
2863 ;; during a recursive-edit
2864 edebug-inside-windows
2885 )
2889 ;; Declare global values local but using the same global value.
2890 ;; We could set these to the values for previous edebug call.
2896 ;; Assume no edebug command sets unread-command-char.
2900 ;; More for Emacs 19
2907 ;; Bind again to outside values.
2911 ;; Don't keep defining a kbd macro.
2915 ;; others??
2916 )
2929 ;; Do the following, even if quit occurs.
2933 ;; Could be an option to keep eval display up.
2936 ;; Remember selected-window after recursive-edit.
2937 ;; (setq edebug-inside-window (selected-window))
2941 ;; Recursive edit may have changed buffers,
2942 ;; so set it back before exiting let.
2951 )
2952 ;; gotta have a buffer to let its buffer local variables be set
2956 ;; Reset global vars to outside values, in case they have been changed.
2958 last-command-char edebug-outside-last-command-char
2959 last-command-event edebug-outside-last-command-event
2960 last-command edebug-outside-last-command
2961 this-command edebug-outside-this-command
2962 unread-command-char edebug-outside-unread-command-char
2963 current-prefix-arg edebug-outside-current-prefix-arg
2964 last-input-char edebug-outside-last-input-char
2965 last-input-event edebug-outside-last-input-event
2966 last-event-frame edebug-outside-last-event-frame
2967 last-nonmenu-event edebug-outside-last-nonmenu-event
2968 track-mouse edebug-outside-track-mouse
2970 standard-output edebug-outside-standard-output
2971 standard-input edebug-outside-standard-input
2972 defining-kbd-macro edebug-outside-defining-kbd-macro
2973 ))
2974 ))
2977 ;;; Display related functions
2980 ;; If pos is not visible, adjust current window to fit following context.
2981 ;;; (message "window: %s old-start: %s window-start: %s pos: %s"
2982 ;;; (selected-window) old-start (window-start) (point)) (sit-for 5)
2985 ;; First try old-start
2990 ;; (message "resetting window start") (sit-for 2)
2997 ))
3013 )
3017 ;; Set up the overlay arrow at beginning-of-line in current buffer.
3018 ;; The arrow string is derived from edebug-arrow-alist and
3019 ;; edebug-execution-mode.
3028 "Toggle the saving and restoring of all windows.
3029 Also, each time you toggle it on, the inside and outside window
3030 configurations become the same as the current configuration."
3037 edebug-save-windows))))
3047 edebug-save-windows))
3048 ;; Problem: what about outside windows that are deleted inside?
3052 "Toggle the saving and restoring of the selected window.
3053 Also, each time you toggle it on, the inside and outside window
3054 configurations become the same as the current configuration."
3058 ;; Save all outside windows except the selected one.
3059 ;; Remove (selected-window) from outside-windows.
3066 edebug-outside-windows))
3079 "Toggle the saving and restoring of windows.
3080 With prefix, toggle for just the selected window.
3081 Otherwise, toggle for all windows."
3089 "Show the debug windows and where we stopped in the program."
3093 ;; Restore the window configuration to what it last was inside.
3094 ;; But it is not always set. - experiment
3095 ;;(if edebug-inside-windows
3096 ;; (edebug-set-windows edebug-inside-windows))
3101 "Change to the outside window configuration."
3114 "Bounce the point in the outside current buffer.
3115 If prefix arg is supplied, sit for that many seconds before returning.
3116 The default is one second."
3121 ;; If the buffer's currently displayed, avoid set-window-configuration.
3133 ;; Joe Wells, here is a start at your idea of adding a buffer to the internal
3134 ;; display list. Still need to use this list in edebug-display.
3140 "Toggle display of a buffer inside of edebug."
3150 ;;; Breakpoint related functions
3153 ;; Return (function . index) of the nearest edebug stop point.
3160 ;; pull out parts of edebug-data.
3162 ;; (edebug-breakpoints (car (cdr edebug-data)))
3167 ;; skip backwards until non-whitespace, or bol
3170 edebug-def-mark))
3171 len i)
3172 ;; the offsets are in order so we can do a linear search
3179 ;; return the relevant info
3182 edebug-def-name)
3183 )))
3187 "Move point to the next breakpoint, or first if none past point."
3195 ;; pull out parts of edebug-data
3199 breakpoint)
3209 ;; goto the first breakpoint
3222 ))))))
3226 "Modify the breakpoint for the form at point or after it.
3227 Set it if FLAG is non-nil, clear it otherwise. Then move to that point.
3228 If CONDITION or TEMPORARY are non-nil, add those attributes to
3229 the breakpoint. "
3236 ;; pull out parts of edebug-data
3240 present)
3241 ;; delete it either way
3246 ;; add it to the list and resort
3251 edebug-breakpoints) '<))
3254 edebug-def-name condition)
3262 ))))
3265 "Set the breakpoint of nearest sexp.
3266 With prefix argument, make it a temporary breakpoint."
3271 "Clear the breakpoint of nearest sexp."
3282 "Global Condition: " initial read-expression-map t
3289 ;;; Mode switching functions
3292 ;; Set the edebug mode to MODE.
3293 ;; Display SHORTMSG, or MSG if not within edebug.
3298 ;; Continue execution
3300 ;; This is not terribly useful!!
3308 "Proceed to next stop point."
3313 "Proceed to next `after' stop point."
3318 "Go, evaluating until break.
3319 With prefix ARG, set temporary break at current point and go."
3326 "Go, evaluating without debugging."
3333 "Begin trace mode."
3338 "Trace with no wait at each step."
3344 "Begin continue mode."
3350 "Trace with no wait at each step."
3355 ;; ------------------------------------------------------------
3356 ;; The following use the mode changing commands and breakpoints.
3360 "Proceed to first stop-point at or after current position of point."
3366 "Stop execution and do not continue.
3367 Useful for exiting from trace or continue loop."
3373 "Proceed to the exit of the next expression to be evaluated."
3381 "Proceed from the current point to the end of the ARGth sexp ahead.
3382 If there are not ARG sexps ahead, then do edebug-step-out."
3386 ;; Call forward-sexp repeatedly until done or failure.
3391 )))
3394 "Proceed from the current point to the end of the containing sexp.
3395 If there is no containing sexp that is not the top level defun,
3396 go to the end of the last sexp, or if that is the same point, then step."
3402 ;; Is there still a containing expression?
3406 ;; At top level - 1, so first check if there are more sexps at this level.
3408 ;; (up-list 1)
3413 )))))
3416 ;; Func should be a function symbol.
3417 ;; Return the function symbol, or nil if not instrumented.
3421 ;; It is uninstrumented, so instrument it.
3425 func))
3428 func)
3436 func))))))
3439 "Instrument the definition of the function or macro about to be called.
3440 Do this when stopped before the form or it will be too late.
3441 One side effect of using this command is that the next time the
3442 function or macro is called, Edebug will be called there as well."
3457 "Step into the definition of the function or macro about to be called.
3458 This first does `edebug-instrument-callee' to ensure that it is
3459 instrumented. Then it does `edebug-on-entry' and switches to `go' mode."
3468 "Cause Edebug to stop when FUNCTION is called.
3469 With prefix argument, make this temporary so it is automatically
3470 cancelled the first time the function is entered."
3472 ;; Could store this in the edebug data instead.
3483 ;; Also need edebug-cancel-debug-on-entry
3486 "Request FUNCTION to invoke debugger each time it is called.
3487 If the user continues, FUNCTION's execution proceeds.
3488 Works by modifying the definition of FUNCTION,
3489 which must be written in Lisp, not predefined.
3490 Use `cancel-debug-on-entry' to cancel the effect of this command.
3491 Redefining FUNCTION also does that.
3493 This version is from Edebug. If the function is instrumented for
3494 Edebug, it calls `edebug-on-entry'."
3503 "Set mode to Go-nonstop, and exit to top-level.
3504 This is useful for exiting even if `unwind-protect' code may be executed."
3510 ;;(defun edebug-exit-out ()
3511 ;; "Go until the current function exits."
3512 ;; (interactive)
3513 ;; (edebug-set-mode 'exiting "Exit..."))
3516 ;;; The following initial mode setting definitions are not used yet.
3526 )
3531 "Ask for the initial mode of the enclosing function.
3532 The mode is requested via the key that would be used to set the mode in
3533 edebug-mode."
3537 edebug-mode-map))
3539 edebug-initial-mode))
3542 "Change initial edebug mode for %s from %s (%s) to (enter key): "
3543 this-function
3544 old-mode
3547 keymap 'firstonly
3548 ))))
3550 )
3557 this-function mode))
3559 )))
3561 ;;; Evaluation of expressions
3566 "Evaluate an expression list in the outside context.
3567 Return the result of the last expression."
3571 ;; After excursion, we will
3572 ;; restore to current window configuration.
3575 ;; Restore outside windows.
3579 ;; (use-local-map edebug-outside-map)
3581 ;; Restore outside context.
3600 ;; Get the values out of the saved statuses.
3604 ;; See edebug-display
3609 )
3618 ;; Back to edebug-buffer. Restore rest of inside context.
3619 ;; (use-local-map edebug-inside-map)
3621 ;; Restore inside windows.
3624 ;; Save values that may have been changed.
3626 edebug-outside-last-command-char last-command-char
3627 edebug-outside-last-command-event last-command-event
3628 edebug-outside-last-command last-command
3629 edebug-outside-this-command this-command
3630 edebug-outside-unread-command-char unread-command-char
3631 edebug-outside-unread-command-events unread-command-events
3632 edebug-outside-current-prefix-arg current-prefix-arg
3633 edebug-outside-last-input-char last-input-char
3634 edebug-outside-last-input-event last-input-event
3635 edebug-outside-last-event-frame last-event-frame
3636 edebug-outside-last-nonmenu-event last-nonmenu-event
3637 edebug-outside-track-mouse track-mouse
3638 edebug-outside-standard-output standard-output
3639 edebug-outside-standard-input standard-input
3641 edebug-outside-executing-macro executing-kbd-macro
3642 edebug-outside-defining-kbd-macro defining-kbd-macro
3644 edebug-outside-o-a-p overlay-arrow-position
3645 edebug-outside-o-a-s overlay-arrow-string
3646 edebug-outside-c-i-e-a cursor-in-echo-area
3647 edebug-outside-d-c-i-n-s-w default-cursor-in-non-selected-windows
3648 )
3650 ;; Restore the outside saved values; don't alter
3651 ;; the outside binding loci.
3656 ))
3661 ;; Are there cl lexical variables active?
3667 ;; Evaluate EXPR safely.
3668 ;; If there is an error, a string is returned describing the error.
3675 ;;; Printing
3679 ;; Print an error message like command level does.
3680 ;; This also prints the error name if it has no error-message.
3685 ;; continuing after an error may
3686 ;; complain about edebug-arg. why??
3690 ;; Define here in case they are not already defined.
3694 ;; Alternatively, we could change the definition of
3695 ;; edebug-safe-prin1-to-string to only use these if defined.
3717 "Print the previous result."
3721 ;;; Read, Eval and Print
3730 "Evaluate an expression in the outside environment.
3731 If interactive, prompt for the expression.
3732 Print result in minibuffer."
3734 "Eval: " nil read-expression-map t
3743 "Evaluate sexp before point in the outside environment.
3744 Print value in minibuffer."
3749 "Evaluate sexp before point in outside environment; insert value.
3750 This prints the value into current buffer."
3758 ;; princ the string to get rid of quotes.
3761 ))
3763 ;;; Edebug Minor Mode
3768 ;; Global GUD bindings for all emacs-lisp-mode buffers.
3777 ;; control
3787 ;;(define-key map "f" 'edebug-forward) not implemented
3795 ;; quitting and stopping
3801 ;; breakpoints
3808 ;; evaluation
3814 ;; views
3821 ;; misc
3827 ;; statistics
3830 ;; GUD bindings
3840 map))
3842 ;; Autoloading these global bindings doesn't make sense because
3843 ;; they cannot be used anyway unless Edebug is already loaded and active.
3859 ;; breakpoints
3865 ;; views
3869 ;; quitting
3874 ;; statistics
3876 map)
3888 "Mode for Emacs Lisp buffers while in Edebug.
3890 In addition to all Emacs Lisp commands (except those that modify the
3891 buffer) there are local and global key bindings to several Edebug
3895 Also see bindings for the eval list buffer *edebug* in `edebug-eval-mode'.
3897 The edebug buffer commands:
3900 Global commands prefixed by `global-edebug-prefix':
3903 Options:
3904 edebug-setup-hook
3905 edebug-all-defs
3906 edebug-all-forms
3907 edebug-save-windows
3908 edebug-save-displayed-buffer-points
3909 edebug-initial-mode
3910 edebug-trace
3911 edebug-test-coverage
3912 edebug-continue-kbd-macro
3913 edebug-print-length
3914 edebug-print-level
3915 edebug-print-circle
3916 edebug-on-error
3917 edebug-on-quit
3918 edebug-on-signal
3919 edebug-unwrap-results
3920 edebug-global-break-condition
3921 "
3922 ;; If the user kills the buffer in which edebug is currently active,
3923 ;; exit to top level, because the edebug command loop can't usefully
3924 ;; continue running in such a case.
3929 "Used on `kill-buffer-hook' when Edebug is operating in a buffer of Lisp code."
3934 ;;; edebug eval list mode
3936 ;; A list of expressions and their evaluations is displayed in *edebug*.
3939 "Return a list of evaluations of `edebug-eval-list'."
3940 ;; Assumes in outside environment.
3941 ;; Don't do any edebug things now.
3947 ;; Assumes edebug-eval-buffer exists.
3961 ))
3969 ;; Should generalize this to be callable outside of edebug
3970 ;; with calls in user functions, e.g. (edebug-eval-display)
3973 "Display expressions and evaluations in EDEBUG-EVAL-RESULT-LIST.
3974 It modifies the context by popping up the eval display."
3979 )))
3982 "Redisplay eval list in outside environment.
3983 May only be called from within `edebug-recursive-edit'."
3987 ))
3996 "Replace the evaluation list with the sexps now in the eval buffer."
3999 new-list)
4001 ;; get the first expression
4023 "Delete the item under point and redisplay."
4024 ;; could add arg to do repeatedly
4052 "Mode for evaluation list buffer while in Edebug.
4054 In addition to all Interactive Emacs Lisp commands there are local and
4055 global key bindings to several Edebug specific commands. E.g.
4059 Eval list buffer commands:
4062 Global commands prefixed by `global-edebug-prefix':
4065 ;;; Interface with standard debugger.
4067 ;; (setq debugger 'edebug) ; to use the edebug debugger
4068 ;; (setq debugger 'debug) ; use the standard debugger
4070 ;; Note that debug and its utilities must be byte-compiled to work,
4071 ;; since they depend on the backtrace looking a certain way. But
4072 ;; edebug is not dependent on this, yet.
4075 "Replacement for `debug'.
4076 If we are running an edebugged function, show where we last were.
4077 Otherwise call `debug' normally."
4078 ;; (message "entered: %s depth: %s edebug-recursion-depth: %s"
4079 ;; edebug-entered (recursion-depth) edebug-recursion-depth) (sit-for 1)
4084 ;; Bind variables required by edebug-display
4086 edebug-breakpoints
4087 edebug-break-data
4088 edebug-break-condition
4089 edebug-global-break
4091 )
4094 nil
4095 edebug-value))
4097 ;; Otherwise call debug normally.
4098 ;; Still need to remove extraneous edebug calls from stack.
4100 ))
4104 "Display a non-working backtrace. Better than nothing..."
4110 ;; else, could just display edebug-backtrace-buffer
4111 )
4116 last-ok-point)
4119 ;; Clean up the backtrace.
4120 ;; Not quite right for current edebug scheme.
4127 ;; Delete interspersed edebug internals.
4132 ;; Previous lines may contain code, so just delete this line
4140 )))
4141 )))))
4143 \f
4144 ;;; Trace display
4147 "In buffer BUF-NAME, display FMT and ARGS at the end and make it visible.
4148 The buffer is created if it does not exist.
4149 You must include newlines in FMT to break lines, but one newline is appended."
4150 ;; e.g.
4151 ;; (edebug-trace-display "*trace-point*"
4152 ;; "saving: point = %s window-start = %s"
4153 ;; (point) (window-start))
4157 buf-window)
4158 ;; (message "before pop-to-buffer") (sit-for 1)
4164 ;; Make it visible.
4168 ;; (set-window-point buf-window (point))
4169 ;; (edebug-sit-for 0)
4173 buf-name)
4177 "Convenience call to `edebug-trace-display' using `edebug-trace-buffer'."
4180 \f
4181 ;;; Frequency count and coverage
4184 "Display the frequency count data for each line of the current definition.
4185 The frequency counts are inserted as comment lines after each line,
4186 and you can undo all insertions with one `undo' command.
4188 The counts are inserted starting under the `(' before an expression
4189 or the `)' after an expression, or on the last char of a symbol.
4190 The counts are only displayed when they differ from previous counts on
4191 the same line.
4193 If coverage is being tested, whenever all known results of an expression
4194 are `eq', the char `=' will be appended after the count
4195 for that expression. Note that this is always the case for an
4196 expression only evaluated once.
4198 To clear the frequency count and coverage data for a definition,
4199 reinstrument it."
4213 )
4215 ;; Traverse in reverse order so offsets are correct.
4217 ;; Start at last expression in line.
4221 last-index i)
4223 ;; Find all indexes on same line.
4226 ;; Insert all the indices for this line.
4229 first-index i ; really last index for line above this one.
4232 ;; i == first-index still
4253 "Temporarily display the frequency count data for the current definition.
4254 It is removed when you hit any char."
4255 ;; This seems not to work with Emacs 18.59. It undoes too far.
4263 \f
4264 ;;; Menus
4270 ;; We have to require easymenu (even for Emacs 18) just so
4271 ;; the easy-menu-define macro call is compiled correctly.
4285 "----"
4290 "----"
4322 "----"
4332 ))
4335 \f
4336 ;;; Emacs version specific code
4344 "Set a conditional breakpoint at nearest sexp.
4345 The condition is evaluated in the outside context.
4346 With prefix argument, make it a temporary breakpoint."
4347 ;; (interactive "P\nxCondition: ")
4350 current-prefix-arg
4351 ;; Read condition as follows; getting previous condition is cumbersome:
4363 "Condition: " initial read-expression-map t
4370 \f
4371 ;;; Byte-compiler
4373 ;; Extension for bytecomp to resolve undefined function references.
4374 ;; Requires new byte compiler.
4376 ;; Reenable byte compiler warnings about unread-command-char and -event.
4377 ;; Disabled before edebug-recursive-edit.
4381 edebug-unread-command-char-warning)))
4384 ;; The body of eval-when-compile seems to get evaluated with eval-defun.
4385 ;; We only want to evaluate when actually byte compiling.
4386 ;; But it is OK to evaluate as long as byte-compiler has been loaded.
4390 "Say it is OK for the named functions to be unresolved."
4396 byte-compile-unresolved-functions))))
4397 funcs)
4398 nil)
4401 "Say it is OK for the named variables to be referenced."
4407 vars)
4408 nil)
4411 "Say it is OK for the named variables to be assigned."
4417 vars)
4418 nil)
4422 edebug-gensym ;; also in cl.el
4423 ;; Interfaces to standard functions.
4424 edebug-original-eval-defun
4425 edebug-original-read
4426 edebug-get-buffer-window
4427 edebug-mark
4428 edebug-mark-marker
4429 edebug-input-pending-p
4430 edebug-sit-for
4431 edebug-prin1-to-string
4432 edebug-format
4433 ;; lemacs
4434 zmacs-deactivate-region
4435 popup-menu
4436 ;; CL
4437 cl-macroexpand-all
4438 ;; And believe it or not, the byte compiler doesn't know about:
4439 byte-compile-resolve-functions
4440 ))
4444 read-expression-map))
4449 )))
4451 \f
4452 ;;; Autoloading of Edebug accessories
4457 ;; The following causes cl-specs to be loaded if you load cl.el.
4461 ;;; edebug-cl-read and cl-read are available from liberte@cs.uiuc.edu
4465 ;; The following causes edebug-cl-read to be loaded when you load cl-read.el.
4469 \f
4470 ;;; Finalize Loading
4472 ;;; Finally, hook edebug into the rest of Emacs.
4473 ;;; There are probably some other things that could go here.
4475 ;; Install edebug read and eval functions.
4480 ;; arch-tag: 19c8d05c-4554-426e-ac72-e0fa1fcb0808
4481 ;;; edebug.el ends here