| blob | 15a8b7ff346a7814439462859a4328e1c8a2b558 |
1 ;;; edebug.el --- a source-level debugger for Emacs Lisp
3 ;; Copyright (C) 1988, 89, 90, 91, 92, 93, 94, 95, 97, 1999
4 ;; Free Software Foundation, Inc.
6 ;; Author: Daniel LaLiberte <dlaliberte@gte.com>
7 ;; Maintainer: FSF
8 ;; Keywords: lisp, tools, maint
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; This minor mode allows programmers to step through Emacs Lisp
30 ;; source code while executing functions. You can also set
31 ;; breakpoints, trace (stopping at each expression), evaluate
32 ;; expressions as if outside Edebug, reevaluate and display a list of
33 ;; expressions, trap errors normally caught by debug, and display a
34 ;; debug style backtrace.
36 ;;; Minimal Instructions
37 ;; =====================
39 ;; First evaluate a defun with C-M-x, then run the function. Step
40 ;; through the code with SPC, mark breakpoints with b, go until a
41 ;; breakpoint is reached with g, and quit execution with q. Use the
42 ;; "?" command in edebug to describe other commands.
43 ;; See the Emacs Lisp Reference Manual for more details.
45 ;; If you wish to change the default edebug global command prefix, change:
46 ;; (setq edebug-global-prefix "\C-xX")
48 ;; Edebug was written by
49 ;; Daniel LaLiberte
50 ;; GTE Labs
51 ;; 40 Sylvan Rd
52 ;; Waltham, MA 02254
53 ;; dlaliberte@gte.com
55 ;;; Code:
60 ;;; Bug reporting
65 "Submit, via mail, a bug report on edebug."
70 edebug-maintainer-address
73 'edebug-all-defs
74 'edebug-all-forms
75 'edebug-eval-macro-args
76 'edebug-save-windows
77 'edebug-save-displayed-buffer-points
78 'edebug-initial-mode
79 'edebug-trace
80 'edebug-test-coverage
81 'edebug-continue-kbd-macro
82 'edebug-print-length
83 'edebug-print-level
84 'edebug-print-circle
85 ))))
87 ;;; Options
90 "A source-level debugger for Emacs Lisp"
95 "*Functions to call before edebug is used.
96 Each time it is set to a new value, Edebug will call those functions
97 once and then `edebug-setup-hook' is reset to nil. You could use this
98 to load up Edebug specifications associated with a package you are
99 using but only when you also use Edebug."
103 ;; edebug-all-defs and edebug-all-forms need to be autoloaded
104 ;; because the byte compiler binds them; as a result, if edebug
105 ;; is first loaded for a require in a compilation, they will be left unbound.
107 ;;;###autoload
109 "*If non-nil, evaluation of any defining forms will instrument for Edebug.
110 This applies to `eval-defun', `eval-region', `eval-buffer', and
111 `eval-current-buffer'. `eval-region' is also called by
112 `eval-last-sexp', and `eval-print-last-sexp'.
114 You can use the command `edebug-all-defs' to toggle the value of this
115 variable. You may wish to make it local to each buffer with
116 \(make-local-variable 'edebug-all-defs) in your
117 `emacs-lisp-mode-hook'."
121 ;; edebug-all-defs and edebug-all-forms need to be autoloaded
122 ;; because the byte compiler binds them; as a result, if edebug
123 ;; is first loaded for a require in a compilation, they will be left unbound.
125 ;;;###autoload
127 "*Non-nil evaluation of all forms will instrument for Edebug.
128 This doesn't apply to loading or evaluations in the minibuffer.
129 Use the command `edebug-all-forms' to toggle the value of this option."
134 "*Non-nil means all macro call arguments may be evaluated.
135 If this variable is nil, the default, Edebug will *not* wrap
136 macro call arguments as if they will be evaluated.
137 For each macro, a `edebug-form-spec' overrides this option.
138 So to specify exceptions for macros that have some arguments evaluated
139 and some not, you should specify an `edebug-form-spec'."
144 "*If non-nil, Edebug saves and restores the window configuration.
145 That takes some time, so if your program does not care what happens to
146 the window configurations, it is better to set this variable to nil.
148 If the value is a list, only the listed windows are saved and
149 restored.
151 `edebug-toggle-save-windows' may be used to change this variable."
156 "*If non-nil, save and restore point in all displayed buffers.
158 Saving and restoring point in other buffers is necessary if you are
159 debugging code that changes the point of a buffer which is displayed
160 in a non-selected window. If Edebug or the user then selects the
161 window, the buffer's point will be changed to the window's point.
163 Saving and restoring point in all buffers is expensive, since it
164 requires selecting each window twice, so enable this only if you need
165 it."
170 "*Initial execution mode for Edebug, if non-nil. If this variable
171 is non-@code{nil}, it specifies the initial execution mode for Edebug
172 when it is first activated. Possible values are step, next, go,
173 Go-nonstop, trace, Trace-fast, continue, and Continue-fast."
181 "*Non-nil means display a trace of function entry and exit.
182 Tracing output is displayed in a buffer named `*edebug-trace*', one
183 function entry or exit per line, indented by the recursion level.
185 You can customize by replacing functions `edebug-print-trace-before'
186 and `edebug-print-trace-after'."
191 "*If non-nil, Edebug tests coverage of all expressions debugged.
192 This is done by comparing the result of each expression
193 with the previous result. Coverage is considered OK if two different
194 results are found.
196 Use `edebug-display-freq-count' to display the frequency count and
197 coverage information for a definition."
202 "*If non-nil, continue defining or executing any keyboard macro.
203 Use this with caution since it is not debugged."
209 "*Default value of `print-length' to use while printing results in Edebug."
213 "*Default value of `print-level' to use while printing results in Edebug."
217 "*Default value of `print-circle' to use while printing results in Edebug."
222 "*Non-nil if Edebug should unwrap results of expressions.
223 This is useful when debugging macros where the results of expressions
224 are instrumented expressions. But don't do this when results might be
225 circular or an infinite loop will result."
230 "*Value bound to `debug-on-error' while Edebug is active.
232 If `debug-on-error' is non-nil, that value is still used.
234 If the value is a list of signal names, Edebug will stop when any of
235 these errors are signaled from Lisp code whether or not the signal is
236 handled by a `condition-case'. This option is useful for debugging
237 signals that *are* handled since they would otherwise be missed.
238 After execution is resumed, the error is signaled again."
247 "*Value bound to `debug-on-quit' while Edebug is active."
252 "*If non-nil, an expression to test for at every stop point.
253 If the result is non-nil, then break. Errors are ignored."
258 "*Number of seconds to pause when execution mode is `trace'."
262 ;;; Form spec utilities.
264 ;;;###autoload
266 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
267 Both SYMBOL and SPEC are unevaluated. The SPEC can be 0, t, a symbol
268 \(naming a function), or a list."
272 "For compatibility with old version. Use `def-edebug-spec' instead."
277 ;; Get the spec of symbol resolving all indirection.
279 indirect)
282 ;; (edebug-trace "indirection: %s" edebug-form-spec)
284 edebug-form-spec
285 ))
287 ;;; Utilities
289 ;; Define edebug-gensym - from old cl.el
294 "Generate a fresh uninterned symbol.
295 There is an optional argument, PREFIX. PREFIX is the
296 string that begins the new name. Most people take just the default,
297 except when debugging needs suggest otherwise."
307 newsymbol))
309 ;; Only used by CL-like code.
311 "Return t if OBJECT is a keyword.
312 A keyword is a symbol that starts with `:'."
317 "Return t if OBJECT is a lambda list keyword.
318 A lambda list keyword is a symbol that starts with `&'."
324 ;; Return the last sexp before point in current buffer.
325 ;; Assumes Emacs Lisp syntax is active.
335 "Return a list of windows, in order of `next-window'."
336 ;; This doesn't work for epoch.
346 "Return non-nil if WINDOW is visible."
354 ;; Not used.
356 "Return t if there are two windows."
364 object)
367 "Return the macro named by OBJECT, or nil if it is not a macro."
372 object))
375 "Returns the function named by OBJECT, or nil if it is not a function."
382 object))
385 ;; Return the ALIST sorted with comparison function FUNCTION.
386 ;; This uses 'sort so the sorting is destructive.
391 ;;(def-edebug-spec edebug-save-restriction t)
393 ;; Not used. If it is used, def-edebug-spec must be defined before use.
395 "Evaluate BODY while saving the current buffers restriction.
396 BODY may change buffer outside of current restriction, unlike
397 save-restriction. BODY may change the current buffer,
398 and the restriction will be restored to the original buffer,
399 and the current buffer remains current.
400 Return the result of the last expression in BODY."
409 ;;; Display
415 ;; Like pop-to-buffer, but select window where BUFFER was last shown.
416 ;; Select WINDOW if it provided and it still exists. Otherwise,
417 ;; if buffer is currently shown in several windows, choose one.
418 ;; Otherwise, find a new window, possibly splitting one.
421 window
429 ;; (message "next window: %s" (next-window)) (sit-for 1)
431 ;; Don't select trace window
432 nil
436 ;; Selecting the window does not set the buffer until command loop.
437 ;;(set-buffer buffer)
438 )
442 ;; Return a list of buffer point pairs, for all displayed buffers.
447 buffer)
453 buffer-point-list)))
457 ;; Restore the buffer-points created by edebug-get-displayed-buffer-points.
464 buffer-points)
468 ;; Get either a full window configuration or some window information.
477 which-windows)
481 ;; Set either a full window configuration or some window information.
494 one-window-info))))
495 window-info)
503 ;;; Redefine read and eval functions
504 ;; read is redefined to maybe instrument forms.
505 ;; eval-defun is redefined to check edebug-all-forms and edebug-all-defs.
507 ;; Save the original read function
512 "Read one Lisp expression as text from STREAM, return as Lisp object.
513 If STREAM is nil, use the value of `standard-input' (which see).
514 STREAM or the value of `standard-input' may be:
515 a buffer (read from point and advance it)
516 a marker (read from where it points and advance it)
517 a function (call it with no arguments for each character,
518 call it with a char as argument to push a char back)
519 a string (takes text from string, starting at the beginning)
520 t (read text line using minibuffer and use it).
522 This version, from Edebug, maybe instruments the expression. But the
523 STREAM must be the current buffer to do so. Whether it instruments is
524 also dependent on the values of `edebug-all-defs' and
525 `edebug-all-forms'."
534 ;; We should somehow arrange to be able to do this
535 ;; without actually replacing the eval-defun command.
537 "Evaluate the top-level form containing point, or after point.
539 This version, from Edebug, has the following differences: With a
540 prefix argument instrument the code for Edebug. If `edebug-all-defs' is
541 non-nil, then the code is instrumented *unless* there is a prefix
542 argument. If instrumenting, it prints: `Edebug: FUNCTIONNAME'.
543 Otherwise, it prints in the minibuffer."
553 ;; Force variable to be bound.
557 ;; Force variable to be bound.
562 edebug-result)))
565 ;;;###autoload
568 ;;;###autoload
570 "Evaluate a top level form, such as a defun or defmacro.
571 This is like `eval-defun', but the code is always instrumented for Edebug.
572 Print its name in the minibuffer and leave point where it is,
573 or if an error occurs, leave point after it with mark at the original point."
576 ;; Bind edebug-all-forms only while reading, not while evalling
577 ;; but this causes problems while edebugging edebug.
589 ;; Recover point, but only if no error occurred.
593 ;; Compatibility with old versions.
597 "Toggle edebugging of all definitions."
605 "Toggle edebugging of all forms."
614 ;; Don't install if already installed.
625 ;;; Edebug internal data
627 ;; The internal data that is needed for edebugging is kept in the
628 ;; buffer-local variable `edebug-form-data'.
633 ;; A list of entries associating symbols with buffer regions.
634 ;; This is an automatic buffer local variable. Each entry looks like:
635 ;; @code{(@var{symbol} @var{begin-marker} @var{end-marker}). The markers
636 ;; are at the beginning and end of an entry level form and @var{symbol} is
637 ;; a symbol that holds all edebug related information for the form on its
638 ;; property list.
640 ;; In the future, the symbol will be irrelevant and edebug data will
641 ;; be stored in the definitions themselves rather than in the property
642 ;; list of a symbol.
662 ;; Find the edebug form data entry which is closest to PNT.
663 ;; If END-POINT is supplied, match must be exact.
664 ;; Return `nil' if none found.
666 closest-entry
679 closest-entry entry))))
680 closest-entry))
682 ;; Also need to find all contained entries,
683 ;; and find an entry given a symbol, which should be just assq.
686 ;; Return the edebug data symbol of the form where point is in.
687 ;; If point is not inside a edebuggable form, cause error.
692 ;; Make NEW-ENTRY the first element in the `edebug-form-data' list.
697 ;; If non-nil, clear ENTRY out of the form data.
698 ;; Maybe clear the markers and delete the symbol's edebug property?
701 ;; Instead of this, we could just find all contained forms.
702 ;; (put (car entry) 'edebug nil) ;
703 ;; (mapcar 'edebug-clear-form-data-entry ; dangerous
704 ;; (get (car entry) 'edebug-dependents))
705 ;; (set-marker (nth 1 entry) nil)
706 ;; (set-marker (nth 2 entry) nil)
709 ;;; Parser utilities
712 ;; Signal an invalid-read-syntax with ARGS.
717 ;; Lookup table for significant characters indicating the class of the
718 ;; token that follows. This is not a \"real\" syntax table.
735 ;; We treat numbers as symbols, because of confusion with -, -1, and 1-.
736 ;; We don't care about any other chars since they won't be seen.
737 table))
740 ;; Move to the next token and return its class. We only care about
741 ;; lparen, rparen, dot, quote, backquote, comma, string, char, vector,
742 ;; or symbol.
749 'symbol
754 ;; Leave point before the next token, skipping white space and comments.
757 ;; \r is counted as a comment terminator to support selective display.
762 ;; Mostly obsolete reader; still used in one case.
765 ;; Read one sexp from the current buffer starting at point.
766 ;; Leave point immediately after it. A sexp can be a list or atom.
767 ;; An atom is a symbol (or number), character, string, or vector.
768 ;; This works for reading anything legitimate, but it
769 ;; is gummed up by parser inconsistencies (bugs?)
772 ;; read goes one too far if a (possibly quoted) string or symbol
773 ;; is immediately followed by non-whitespace.
785 ;;; Offsets for reader
787 ;; Define a structure to represent offset positions of expressions.
788 ;; Each offset structure looks like: (before . after) for constituents,
789 ;; or for structures that have elements: (before <subexpressions> . after)
790 ;; where the <subexpressions> are the offset structures for subexpressions
791 ;; including the head of a list.
794 ;; Stack of offset structures in reverse order of the nesting.
795 ;; This is used to get back to previous levels.
799 ;; We must store whether we just read a list with a dotted form that
800 ;; is itself a list. This structure will be condensed, so the offsets
801 ;; must also be condensed.
805 ;; Reinitialize offset recording.
809 ;; Add a new offset pair with POINT as the before offset.
814 ;; Otherwise, we are at the top level, so initialize.
816 edebug-offsets-stack nil
817 edebug-read-dotted-list nil))
818 ;; Cons the new offset to the front of the stack.
820 edebug-current-offset new-offset)
821 ))
824 ;; Finalize the current offset struct by reversing it and
825 ;; store POINT as the after offset.
827 ;; Just reverse the offsets of all subexpressions.
830 ;; We just read a list after a dot, which will be abbreviated out.
832 ;; Drop the corresponding offset pair.
833 ;; That is, nconc the reverse of the rest of the offsets
834 ;; with the cdr of last offset.
839 ;; Now append the point using nconc.
841 ;; Pop the stack.
846 ;; Ignore the last created offset pair.
860 ;;; Reader for Emacs Lisp.
862 ;; Uses edebug-next-token-class (and edebug-skip-whitespace) above.
873 ))
877 func
882 ;; anything else, just read it.
884 )))
893 ;; Turn 'thing into (quote thing)
900 ;; Turn `thing into (\` thing)
903 ;; Generate the same structure of offsets we would have
904 ;; if the resulting list appeared verbatim in the input text.
911 "Non-nil if reading the inside of a new-style backquote with no parens around it.
912 Value of nil means reading the inside of an old-style backquote construct
913 which is surrounded by an extra set of parentheses.
917 ;; Turn ,thing into (\, thing). Handle ,@ and ,. also.
927 ;; Generate the same structure of offsets we would have
928 ;; if the resulting list appeared verbatim in the input text.
936 ;; Turn #'thing into (function thing)
956 ;; Call edebug-storing-offsets here so that we
957 ;; produce the same offsets we would have had
958 ;; if the backquote were an ordinary symbol.
960 elements))))
971 ))
972 elements)
974 ))
984 ))
986 ;;; Cursors for traversal of list and vector elements with offsets.
991 ;; Return a new cursor for EXPRESSIONS with OFFSETS.
997 ;; Set the CURSOR's EXPRESSIONS and OFFSETS to the given.
998 ;; Return the cursor.
1001 cursor)
1004 ;; Copy the cursor using the same object and offsets.
1013 ;; Return non-nil if CURSOR is empty - meaning no more elements.
1017 ;; Return the top element at the cursor.
1018 ;; Assumes not empty.
1022 ;; Check if a dotted form is required.
1024 ;; Check if there is at least one more argument.
1026 ;; Return that top element.
1030 ;; Return the top offset pair corresponding to the top element.
1034 ;; Advance and return the cursor to the next element and offset.
1035 ;; throw no-match if empty before moving.
1036 ;; This is a violation of the cursor encapsulation, but
1037 ;; there is plenty of that going on while matching.
1038 ;; The following test should always fail.
1043 cursor)
1047 ;; Return the before offset of the cursor.
1048 ;; If there is nothing left in the offsets,
1049 ;; return one less than the offset itself,
1050 ;; which is the after offset for a list.
1057 ;; Return the after offset of the cursor object.
1061 offset))
1063 ;;; The Parser
1065 ;; The top level function for parsing forms is
1066 ;; edebug-read-and-maybe-wrap-form; it calls all the rest. It checks the
1067 ;; syntax a bit and leaves point at any error it finds, but otherwise
1068 ;; should appear to work like eval-defun.
1070 ;; The basic plan is to surround each expression with a call to
1071 ;; the edebug debugger together with indexes into a table of positions of
1072 ;; all expressions. Thus an expression "exp" becomes:
1074 ;; (edebug-after (edebug-before 1) 2 exp)
1076 ;; When this is evaluated, first point is moved to the beginning of
1077 ;; exp at offset 1 of the current function. The expression is
1078 ;; evaluated, which may cause more edebug calls, and then point is
1079 ;; moved to offset 2 after the end of exp.
1081 ;; The highest level expressions of the function are wrapped in a call to
1082 ;; edebug-enter, which supplies the function name and the actual
1083 ;; arguments to the function. See functions edebug-enter, edebug-before,
1084 ;; and edebug-after for more details.
1086 ;; Dynamically bound vars, left unbound, but globally declared.
1087 ;; This is to quiet the byte compiler.
1089 ;; Window data of the highest definition being wrapped.
1090 ;; This data is shared by all embedded definitions.
1105 ;; Read a form and wrap it with edebug calls, if the conditions are right.
1106 ;; Here we just catch any no-match not caught below and signal an error.
1108 ;; Run the setup hook.
1109 ;; If it gets an error, make it nil.
1115 edebug-top-window-data
1116 edebug-def-name;; make sure it is locally nil
1117 ;; I don't like these here!!
1118 edebug-&optional
1119 edebug-&rest
1120 edebug-gate
1121 edebug-best-error
1122 edebug-error-point
1123 no-match
1124 ;; Do this once here instead of several times.
1130 nil))
1133 result))
1138 def-kind
1139 defining-form-p
1140 def-name
1141 ;; These offset things don't belong here, but to support recursive
1142 ;; calls to edebug-read, they need to be here.
1143 edebug-offsets
1144 edebug-offsets-stack
1145 edebug-current-offset ; reset to nil
1146 )
1150 ;; Find out if this is a defining form from first symbol
1155 ;; This is incorrect in general!! But OK most of the time.
1160 ;;;(message "all defs: %s all forms: %s" edebug-all-defs edebug-all-forms)
1164 ;; If it is a defining form and we are edebugging defs,
1165 ;; then let edebug-list-form start it.
1171 cursor
1176 ;; Not edebugging this form, so reset the symbol's edebug
1177 ;; property to be just a marker at the definition's source code.
1178 ;; This only works for defs with simple names.
1180 ;; Also nil out dependent defs.
1187 ;; If all forms are being edebugged, explicitly wrap it.
1193 cursor
1196 nil)))
1198 ;; Not a defining form, and not edebugging.
1200 ))
1206 ;; Currently def-form sets this to nil; def-body sets it to t.
1209 ;; Return a unique symbol for the variable used to store the
1210 ;; status of interactive-p for this function.
1215 "Wrap the FORMS of a definition body."
1224 ;; Generate the enter wrapper for some forms of a definition.
1225 ;; This is not to be used for the body of other forms, e.g. `while',
1226 ;; since it wraps the list of forms with a call to `edebug-enter'.
1227 ;; Uses the dynamically bound vars edebug-def-name and edebug-def-args.
1228 ;; Do this after parsing since that may find a name.
1235 ;; Doesn't work with more than one def-body!!
1236 ;; But the list will just be reversed.
1240 ))
1249 ;; modifies edebug-offset-index and edebug-offset-list
1250 ;; accesses edebug-func-marc and buffer point
1252 edebug-offset-index
1254 edebug-offset-list)
1259 ;; Return the edebug form for the current function at offset BEFORE-INDEX
1260 ;; given FORM. Looks like:
1261 ;; (edebug-after (edebug-before BEFORE-INDEX) AFTER-INDEX FORM)
1262 ;; Also increment the offset index for subsequent use.
1265 after-index form))
1268 ;; Like edebug-make-before-and-after-form, but only after.
1273 "Return the unwrapped SEXP or return it as is if it is not wrapped.
1274 The SEXP might be the result of wrapping a body, which is a list of
1275 expressions; a `progn' form will be returned enclosing these forms."
1286 )
1287 sexp))
1290 "Return the sexp recursively unwrapped."
1297 new-sexp)))
1301 ;; Process the defining form, starting outside the form.
1302 ;; The speclist is a generated list spec that looks like:
1303 ;; (("def-symbol" defining-form-spec-sans-&define))
1304 ;; Skip the first offset.
1308 cursor
1310 speclist))
1314 ;; Wrap a form, usually a defining form, but any evaluated one.
1315 ;; If speclist is non-nil, this is being called by edebug-defining-form.
1316 ;; Otherwise it is being called from edebug-read-and-maybe-wrap-form1.
1317 ;; This is a hack, but I havent figured out a simpler way yet.
1319 ;; Set this marker before parsing.
1323 ;; Buffer must be current-buffer for this to work:
1328 result
1329 ;; For definitions.
1330 ;; (edebug-containing-def-name edebug-def-name)
1331 ;; Get name from form-data, if any.
1333 edebug-def-name
1334 edebug-def-args
1335 edebug-def-interactive
1336 edebug-inside-func;; whether wrapped code executes inside a function.
1337 )
1343 ;; else wrap as an enter-form.
1346 ;; Set the name here if it was not set by edebug-make-enter-wrapper.
1350 ;; Add this def as a dependent of containing def. Buggy.
1358 ;; Create a form-data-entry or modify existing entry's markers.
1359 ;; In the latter case, pointers to the entry remain eq.
1363 edebug-def-name
1364 edebug-form-begin-marker
1365 ;; Buffer must be current-buffer.
1367 ))
1369 form-data-entry edebug-def-name ;; in case name is changed
1370 form-begin form-end))
1372 ;; (message "defining: %s" edebug-def-name) (sit-for 2)
1375 ;;(debug edebug-def-name)
1377 ;; Destructively reverse edebug-offset-list and make vector from it.
1380 ;; Side effects on the property list of edebug-def-name.
1384 ;; Set up the initial window data.
1392 ;; Store the edebug data in symbol's property list.
1394 ;; A struct or vector would be better here!!
1396 nil ; clear breakpoints
1397 edebug-offset-list
1398 edebug-top-window-data
1399 ))
1400 result
1401 )))
1405 ;; Create initial frequency count vector.
1406 ;; For each stop point, the counter is incremented each time it is visited.
1412 ;; Create initial coverage vector.
1413 ;; Only need one per expression, but it is simpler to use stop points.
1419 ;; Return the instrumented form for the following form.
1420 ;; Add the point offsets to the edebug-offset-list for the form.
1426 ;; The first offset for a list form is for the list form itself.
1428 form
1432 ;; Find out if this is a defining form from first symbol.
1433 ;; An indirect spec would not work here, yet.
1436 new-cursor
1440 ;; Wrap a regular form.
1444 ;; After processing the list form, the new-cursor is left
1445 ;; with the offset after the form.
1447 )))
1451 ;; Check for constant symbols that don't get wrapped.
1454 form)
1459 ;; Anything else is self-evaluating.
1468 ;; Process the arguments of a list form given that head of form is a symbol.
1469 ;; Helper for edebug-list-form
1475 ;; It is a speclist.
1482 ; but leave it in for compatibility.
1483 ))
1484 ;; No edebug-form-spec provided.
1494 ;; Return an instrumented form built from the list form.
1495 ;; The after offset will be left in the cursor after processing the form.
1497 ;; Prevent backtracking whenever instrumenting.
1499 ;; A list form is never optional because it matches anything.
1502 ;; Skip the first offset.
1513 ;; Special case: replace (interactive-p) with variable
1524 ;; Process anonymous function and args.
1525 ;; This assumes no anonymous macros.
1530 ))
1532 ;;; Matching of specs.
1540 ;;; Failure to match
1542 ;; This throws to no-match, if there are higher alternatives.
1543 ;; Otherwise it signals an error. The place of the error is found
1544 ;; with the two before- and after-offset functions.
1547 ;; Throw a no-match, or signal an error immediately if gate is active.
1548 ;; Remember this point in case we need to report this error.
1561 ;; Top level spec matching function.
1562 ;; Used also at each lower level of specs.
1564 edebug-&rest
1565 edebug-best-error
1566 edebug-error-point
1568 )
1573 ;; Match one spec, which is not a keyword &-spec.
1579 ))
1583 ;; Append results of matching the list of specs.
1584 ;; The first spec is handled and the remainder-handler handles the rest.
1592 ;; Is the spec dotted?
1597 ;; Is the form dotted?
1601 ;; Cancel dotted spec and dotted form.
1605 ;; Wrap the form in a list, (by changing the cursor??)...
1607 ;; and process normally, then unwrap the result.
1614 ;;(message "spec = %s first char = %s" spec first-char) (sit-for 1)
1628 ;; Define specs for all the symbol specs with functions used to process them.
1629 ;; Perhaps we shouldn't be doing this with edebug-form-specs since the
1630 ;; user may want to define macros or functions with the same names.
1631 ;; We could use an internal obarray for these primitive specs.
1648 ;; Less frequently used:
1649 ;; (function . edebug-match-function)
1655 ;; (nil . edebug-match-nil) not this one - special case it.
1656 ))
1659 ;; Match a symbol spec.
1664 ;; It is an indirect spec.
1666 ;; Otherwise it should be the symbol name of a function.
1667 ;; There could be a bug here - maybe need to do edebug-match bindings.
1675 ;; Special case for edebug-`.
1683 )))
1694 ;; Currently identical to edebug-match-form.
1695 ;; This is for common lisp setf-style place arguments.
1700 ;; Keep matching until one spec fails.
1712 ;; Returning nil means no no-match was thrown.
1713 nil))
1714 result
1715 ;; no-match, but don't fail; just reset cursor and return nil.
1717 nil)))
1722 ;; Reuse the &optional handler with this as the remainder handler.
1726 ;; Repeatedly use specs until failure.
1728 edebug-best-error
1729 edebug-error-point)
1734 ;; Keep matching until one spec succeeds, and return its results.
1735 ;; If none match, fail.
1736 ;; This needs to be optimized since most specs spend time here.
1745 edebug-best-error
1746 edebug-error-point)
1747 ;; Doesn't support e.g. &or symbolp &rest form
1749 ;; Match failed, so reset and try again.
1751 ;; Reset the cursor for the next match.
1753 ;; All failed.
1755 ))
1759 ;; If any specs match, then fail
1764 nil))
1765 ;; This means something matched, so it is a no match.
1767 ;; This means nothing matched, so it is OK.
1774 ;; Following specs must look like (<name> <spec>) ...
1775 ;; where <name> is the name of a keyword, and spec is its spec.
1776 ;; This really doesn't save much over the expanded form and takes time.
1778 cursor
1783 specs))))
1787 ;; Simply set the gate to prevent backtracking at this level.
1789 nil)
1793 ;; The spec is a list, but what kind of list, and what context?
1795 ;; After dotted spec but form did not contain dot,
1796 ;; so match list spec elements as if spliced in.
1800 ;; If it matched, really clear the dotted-spec flag.
1809 ;; Special case: spec quotes a symbol to match.
1810 ;; Change in future. Use "..." instead.
1815 form)
1822 ;; First offset is for the list form itself.
1823 ;; Treat nil as empty list.
1825 specs))
1829 ;; Special case: match a vector with the specs.
1838 )))
1842 ;; Match a sublist of specs.
1844 ;;edebug-best-error
1845 ;;edebug-error-point
1846 )
1848 ;; match with edebug-match-specs so edebug-best-error is not bound.
1853 ;; A failed &rest or &optional spec may leave some args.
1855 )))))
1862 ;; Since it matched, failure means immediate error, unless &optional.
1866 )))
1869 ;; There must be nothing left to match a nil.
1872 nil))
1879 ;; Match a defining form.
1880 ;; Normally, &define is interpreted specially other places.
1881 ;; This should only be called inside of a spec list to match the remainder
1882 ;; of the current list. e.g. ("lambda" &define args def-body)
1884 cursor
1886 ;; Find the last offset in the list.
1889 offsets)
1890 specs))
1893 ;; The expression must be a function.
1894 ;; This will match any list form that begins with a symbol
1895 ;; that has an edebug-form-spec beginning with &define. In
1896 ;; practice, only lambda expressions should be used.
1897 ;; I could add a &lambda specification to avoid confusion.
1904 ;; Find out if this is a defining form from first symbol.
1915 )))
1919 ;; Set the edebug-def-name bound in edebug-defining-form.
1921 ;; Maybe strings and numbers could be used.
1926 ;; Construct a new name by appending to previous name.
1928 name))
1933 ;; Set the edebug-def-name to the spec.
1936 ;; Construct a new name by appending to previous name.
1938 spec))
1939 nil)
1942 ;; set the def-args bound in edebug-defining-form
1952 ;; Like form but the form is wrapped in edebug-enter form.
1953 ;; The form is assumed to be executing outside of the function context.
1954 ;; This is a hack for now, since a def-form might execute inside as well.
1955 ;; Not to be used otherwise.
1960 ;; Like body but body is wrapped in edebug-enter form.
1961 ;; The body is assumed to be executing inside of the function context.
1962 ;; Not to be used otherwise.
1967 ;;;; Edebug Form Specs
1968 ;;; ==========================================================
1969 ;;; See cl-specs.el for common lisp specs.
1971 ;;;;* Spec for def-edebug-spec
1972 ;;; Out of date.
1975 "Return non-nil if OBJECT is a symbol with an edebug-form-spec property."
1980 ;; Top level is different from lower levels.
1985 ;; A list must have something in it, or it is nil, a symbolp
1989 (&or
1993 edebug-spec-list
1994 stringp
1996 ;; [edebug-keywordp gate edebug-spec] ;; need edebug-keywordp for this.
1997 edebug-spec-p ;; Including all the special ones e.g. form.
1998 symbolp;; a predicate
1999 ))
2002 ;;;* Emacs special forms and some functions.
2004 ;; quote expects only one argument, although it allows any number.
2007 ;; The standard defining forms.
2012 (&define name lambda-list
2015 def-body))
2025 )))
2030 ;; A function-form is for an argument that may be a function or a form.
2031 ;; This specially recognizes anonymous functions quoted with quote.
2033 ;; form at the end could also handle "function",
2034 ;; but recognize it specially to avoid wrapping function forms.
2037 ;; function expects a symbol or a lambda or macro expression
2038 ;; A macro is allowed by Emacs.
2041 ;; lambda is a macro in emacs 19.
2045 def-body))
2047 ;; A macro expression is a lambda expression with "macro" prepended.
2050 ;; (def-edebug-spec anonymous-form ((&or ["lambda" lambda] ["macro" macro])))
2052 ;; Standard functions that take function-forms arguments.
2061 body))
2072 form
2078 ;; Supports quotes inside backquotes,
2079 ;; but only at the top level inside unquotes.
2081 (&or
2084 ;; If you use dotted forms in backquotes, replace the previous line
2085 ;; with the following. This takes quite a bit more stack space, however.
2086 ;; (backquote-form . [&or nil backquote-form])
2088 sexp))
2090 ;; Special version of backquote that instruments backquoted forms
2091 ;; destined to be evaluated, usually as the result of a
2092 ;; macroexpansion. Backquoted code can only have unquotes (, and ,@)
2093 ;; in places where list forms are allowed, and predicates. If the
2094 ;; backquote is used in a macro, unquoted code that come from
2095 ;; arguments must be instrumented, if at all, with def-form not def-body.
2097 ;; We could assume that all forms (not nested in other forms)
2098 ;; in arguments of macros should be def-forms, whether or not the macros
2099 ;; are defined with edebug-` but this would be expensive.
2101 ;; ,@ might have some problems.
2106 ;; Assume immediate quote in unquotes mean backquote at next higher level.
2111 ;; New byte compiler.
2134 ;; Anything else?
2137 ;; Some miscellaneous specs for macros in public packages.
2138 ;; Send me yours.
2140 ;; advice.el by Hans Chalupsky (hans@cs.buffalo.edu)
2146 ;; "activation" "deactivation"]
2147 name ;; name of advice
2149 )
2152 def-body))
2154 ;;; The debugger itself
2158 ;;; add minor-mode-alist entry
2161 minor-mode-alist)))
2164 ;; Stack of active functions evaluated via edebug.
2165 ;; Should be nil at the top level.
2168 ;; Index of last edebug-stack item.
2171 ;; Stack of offset indices of visited edebug sexps.
2172 ;; Should be nil at the top level.
2173 ;; Each function adds one cons. Top is modified with setcar.
2177 ;; Non-nil if edebug has already been entered at this recursive edit level.
2178 ;; This should stay nil at the top level.
2179 )
2181 ;; Should these be options?
2183 ;; Name of function to use for debugging when error or quit occurs.
2184 ;; Set this to 'debug if you want to debug edebug.
2185 )
2188 ;; Dynamically bound variables, declared globally but left unbound.
2217 ;;; Handling signals
2220 "Signal an error. Args are SIGNAL-NAME, and associated DATA.
2221 A signal name is a symbol with an `error-conditions' property
2222 that is a list of condition names.
2223 A handler for any of those names will get to handle this signal.
2224 The symbol `error' should always be one of them.
2226 DATA should be a list. Its elements are printed as part of the error message.
2227 If the signal is handled, DATA is made available to the handler.
2228 See `condition-case'.
2230 This is the Edebug replacement for the standard `signal'. It should
2231 only be active while Edebug is. It checks `debug-on-error' to see
2232 whether it should call the debugger. When execution is resumed, the
2233 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??)
2282 ;; within edebug unless edebug-continue-kbd-macro is
2283 ;; non-nil. Again, local binding may not be best.
2287 ;; Don't get confused by the user's keymap changes.
2293 ;; Disable command hooks. This is essential when
2294 ;; a hook function is instrumented - to avoid infinite loop.
2295 ;; This may be more than we need, however.
2299 edebug-initial-mode
2300 edebug-execution-mode)
2301 edebug-next-execution-mode nil)
2303 ;; Reset global variables in case outside value was changed.
2305 pre-command-hook edebug-outside-pre-command-hook
2306 post-command-hook edebug-outside-post-command-hook
2307 )))
2317 )
2326 )))
2331 edebug-result)
2341 "Print MSG in *edebug-trace* before and after evaluating BODY.
2342 The result of BODY is also printed."
2344 edebug-result)
2351 "Function called to print trace info before expression evaluation.
2352 MSG is printed after `::::{ '."
2357 "Function called to print trace info after expression evaluation.
2358 MSG is printed after `::::} '."
2365 ;; Debug current function given BEFORE position.
2366 ;; Called from functions compiled with edebug-eval-top-level-form.
2367 ;; Return the before index.
2370 ;; Increment frequency count
2377 edebug-before-index)
2380 ;; Do nothing.
2381 )
2384 ;; Debug current function given AFTER position and VALUE.
2385 ;; Called from functions compiled with edebug-eval-top-level-form.
2386 ;; Return VALUE.
2389 ;; Increment frequency count
2396 ;; Just return result.
2397 edebug-value
2399 ))
2402 ;; Do nothing but return the value.
2403 edebug-value)
2409 ;; This is not used, yet.
2423 ;; Test if a different result.
2428 ;; Dynamically declared unbound variables.
2441 ;; Check breakpoints and pending input.
2442 ;; If edebug display should be updated, call edebug-display.
2443 ;; Return edebug-value.
2456 ;;; (edebug-trace "exp: %s" edebug-value)
2457 ;; Test whether we should break.
2466 ;; Delete the breakpoint.
2471 ;; Display if mode is not go, continue, or Continue-fast
2472 ;; or break, or input is pending,
2474 edebug-break
2478 edebug-value
2479 ))
2482 ;; window-start now stored with each function.
2483 ;;(defvar edebug-window-start nil)
2484 ;; Remember where each buffers' window starts between edebug calls.
2485 ;; This is to avoid spurious recentering.
2486 ;; Does this still need to be buffer-local??
2487 ;;(setq-default edebug-window-start nil)
2488 ;;(make-variable-buffer-local 'edebug-window-start)
2491 ;; Dynamically declared unbound vars
2507 ;; Emacs 19 adds an arg to mark and mark-marker.
2513 ;; Setup windows for edebug, determine mode, maybe enter recursive-edit.
2514 ;; Uses local variables of edebug-enter, edebug-before, edebug-after
2515 ;; and edebug-debugger.
2517 edebug-stop ; should we enter recursive-edit
2520 edebug-buffer-outside-point ; current point in edebug-buffer
2521 ;; window displaying edebug-buffer
2527 edebug-outside-windows ; window or screen configuration
2528 edebug-buffer-points
2530 edebug-eval-buffer ; declared here so we can kill it below
2533 edebug-trace-window
2534 edebug-trace-window-start
2543 ;; any others??
2544 )
2550 ;; Compute result string now before windows are modified.
2554 ;; Save windows now before we modify them.
2561 ;; First move the edebug buffer point to edebug-point
2562 ;; so that window start doesn't get changed when we display it.
2563 ;; I don't know if this is going to help.
2564 ;;(set-buffer edebug-buffer)
2565 ;;(goto-char edebug-point)
2567 ;; If edebug-buffer is not currently displayed,
2568 ;; first find a window for it.
2572 ;; Now display eval list, if any.
2573 ;; This is done after the pop to edebug-buffer
2574 ;; so that buffer-window correspondence is correct after quitting.
2576 ;; The evaluation list better not have deleted edebug-window-data.
2584 ;; Check whether positions are up-to-date.
2585 ;; This assumes point is never before symbol.
2589 edebug-function)
2590 )))
2595 ;; Test if there is input, not including keyboard macros.
2599 edebug-stop t)
2601 ;; (discard-input) ; is this unfriendly??
2602 ))
2603 ;; Now display arrow based on mode.
2608 ;; Display error message
2619 edebug-global-break-condition
2620 edebug-global-break-result))
2623 edebug-break-condition
2624 edebug-break-result))
2633 ;; Display result of previous evaluation.
2645 ;; not edebug-break
2650 )
2657 ;; (setq edebug-execution-mode 'step)
2658 ;; (edebug-overlay-arrow) ; This doesn't always show up.
2661 ;; Reset the edebug-window-data to whatever it is now.
2665 ;; Remember window-start for edebug-buffer, if still displayed.
2671 ;; Save trace window point before restoring outside windows.
2672 ;; Could generalize this for other buffers.
2679 ;; Restore windows before continuing.
2684 ;; Restore displayed buffer points.
2685 ;; Needed even if restoring windows because
2686 ;; window-points are not restored. (should they be??)
2690 ;; Unrestore trace window's window-point.
2693 edebug-trace-window-start))
2695 ;; Unrestore edebug-buffer's window-start, if displayed.
2702 ;; Unrestore edebug-buffer's window-point.
2703 ;; Needed in addition to setting the buffer point
2704 ;; - otherwise quitting doesn't leave point as is.
2705 ;; But this causes point to not be restored at times.
2706 ;; Also, it may not be a visible window.
2707 ;; (set-window-point window edebug-point)
2708 )))
2710 ;; Unrestore edebug-buffer's point. Rerestored below.
2711 ;; (goto-char edebug-point) ;; in edebug-buffer
2712 )
2713 ;; Since we may be in a save-excursion, in case of quit,
2714 ;; reselect the outside window only.
2715 ;; Only needed if we are not recovering windows??
2720 ;; Restore current buffer always, in case application needs it.
2722 ;; Restore point, and mark.
2723 ;; Needed even if restoring windows because
2724 ;; that doesn't restore point and mark in the current buffer.
2725 ;; But don't restore point if edebug-buffer is current buffer.
2729 ;; Does zmacs-regions need to be nil while doing set-marker?
2732 ;; None of the following is done if quit or signal occurs.
2734 ;; Restore edebug-buffer's outside point.
2735 ;; (edebug-trace "restore edebug-buffer point: %s"
2736 ;; edebug-buffer-outside-point)
2741 ;; ... nothing more.
2742 )
2743 ;; Reset global variables to outside values in case they were changed.
2745 overlay-arrow-position edebug-outside-o-a-p
2746 overlay-arrow-string edebug-outside-o-a-s
2747 cursor-in-echo-area edebug-outside-c-i-e-a)
2748 )))
2752 ;; Number of recursive edits started by edebug.
2753 ;; Should be 0 at the top level.
2756 ;; Value of recursion-depth when edebug was called.
2758 ;; Dynamically declared unbound vars
2773 ;; Note: here we have defvars for variables that are
2774 ;; built-in in certain versions.
2775 ;; Each defvar makes a difference
2776 ;; in versions where the variable is *not* built-in.
2778 ;; Emacs 18
2781 ;; Lucid Emacs
2785 ;; Emacs 19.
2793 ;; Disable byte compiler warnings about unread-command-char and -event
2794 ;; (maybe works with byte-compile-version 2.22 at least)
2806 ;; Start up a recursive edit inside of edebug.
2807 ;; The current buffer is the edebug-buffer, which is put into edebug-mode.
2808 ;; Assume that none of the variables below are buffer-local.
2810 ;; match-data must be done in the outside buffer
2816 ;;(edebug-number-of-recursions (1+ edebug-number-of-recursions))
2818 edebug-entered ; bind locally to nil
2820 edebug-backtrace-buffer ; each recursive edit gets its own
2821 ;; The window configuration may be saved and restored
2822 ;; during a recursive-edit
2823 edebug-inside-windows
2846 )
2850 ;; Declare global values local but using the same global value.
2851 ;; We could set these to the values for previous edebug call.
2857 ;; Assume no edebug command sets unread-command-char.
2861 ;; More for Emacs 19
2870 ;; Bind again to outside values.
2874 ;; Don't keep defining a kbd macro.
2878 ;; others??
2879 )
2894 ;; Do the following, even if quit occurs.
2898 ;; Could be an option to keep eval display up.
2901 ;; Remember selected-window after recursive-edit.
2902 ;; (setq edebug-inside-window (selected-window))
2906 ;; Recursive edit may have changed buffers,
2907 ;; so set it back before exiting let.
2915 )
2916 ;; gotta have a buffer to let its buffer local variables be set
2920 ;; Reset global vars to outside values, in case they have been changed.
2922 last-command-char edebug-outside-last-command-char
2923 last-command-event edebug-outside-last-command-event
2924 last-command edebug-outside-last-command
2925 this-command edebug-outside-this-command
2926 unread-command-char edebug-outside-unread-command-char
2927 unread-command-event edebug-outside-unread-command-event
2928 unread-command-events edebug-outside-unread-command-events
2929 current-prefix-arg edebug-outside-current-prefix-arg
2930 last-input-char edebug-outside-last-input-char
2931 last-input-event edebug-outside-last-input-event
2932 last-event-frame edebug-outside-last-event-frame
2933 last-nonmenu-event edebug-outside-last-nonmenu-event
2934 track-mouse edebug-outside-track-mouse
2936 standard-output edebug-outside-standard-output
2937 standard-input edebug-outside-standard-input
2938 defining-kbd-macro edebug-outside-defining-kbd-macro
2939 ))
2940 ))
2943 ;;; Display related functions
2946 ;; If pos is not visible, adjust current window to fit following context.
2947 ;;; (message "window: %s old-start: %s window-start: %s pos: %s"
2948 ;;; (selected-window) old-start (window-start) (point)) (sit-for 5)
2951 ;; First try old-start
2956 ;; (message "resetting window start") (sit-for 2)
2963 ))
2979 )
2983 ;; Set up the overlay arrow at beginning-of-line in current buffer.
2984 ;; The arrow string is derived from edebug-arrow-alist and
2985 ;; edebug-execution-mode.
2994 "Toggle the saving and restoring of all windows.
2995 Also, each time you toggle it on, the inside and outside window
2996 configurations become the same as the current configuration."
3003 edebug-save-windows))))
3013 edebug-save-windows))
3014 ;; Problem: what about outside windows that are deleted inside?
3018 "Toggle the saving and restoring of the selected window.
3019 Also, each time you toggle it on, the inside and outside window
3020 configurations become the same as the current configuration."
3024 ;; Save all outside windows except the selected one.
3025 ;; Remove (selected-window) from outside-windows.
3032 edebug-outside-windows))
3045 "Toggle the saving and restoring of windows.
3046 With prefix, toggle for just the selected window.
3047 Otherwise, toggle for all windows."
3055 "Show the debug windows and where we stopped in the program."
3059 ;; Restore the window configuration to what it last was inside.
3060 ;; But it is not always set. - experiment
3061 ;;(if edebug-inside-windows
3062 ;; (edebug-set-windows edebug-inside-windows))
3067 "Change to the outside window configuration."
3080 "Bounce the point in the outside current buffer.
3081 If prefix arg is supplied, sit for that many seconds before returning.
3082 The default is one second."
3087 ;; If the buffer's currently displayed, avoid set-window-configuration.
3099 ;; Joe Wells, here is a start at your idea of adding a buffer to the internal
3100 ;; display list. Still need to use this list in edebug-display.
3106 "Toggle display of a buffer inside of edebug."
3116 ;;; Breakpoint related functions
3119 ;; Return (function . index) of the nearest edebug stop point.
3126 ;; pull out parts of edebug-data.
3128 ;; (edebug-breakpoints (car (cdr edebug-data)))
3133 ;; skip backwards until non-whitespace, or bol
3136 edebug-def-mark))
3137 len i)
3138 ;; the offsets are in order so we can do a linear search
3145 ;; return the relevant info
3148 edebug-def-name)
3149 )))
3153 "Move point to the next breakpoint, or first if none past point."
3161 ;; pull out parts of edebug-data
3165 breakpoint)
3175 ;; goto the first breakpoint
3188 ))))))
3192 "Modify the breakpoint for the form at point or after it according
3193 to FLAG: set if t, clear if nil. Then move to that point.
3194 If CONDITION or TEMPORARY are non-nil, add those attributes to
3195 the breakpoint. "
3202 ;; pull out parts of edebug-data
3206 present)
3207 ;; delete it either way
3212 ;; add it to the list and resort
3217 edebug-breakpoints) '<))
3220 edebug-def-name condition)
3228 ))))
3231 "Set the breakpoint of nearest sexp.
3232 With prefix argument, make it a temporary breakpoint."
3237 "Clear the breakpoint of nearest sexp."
3242 ;; For emacs 18, no read-expression-history
3244 "Set a conditional breakpoint at nearest sexp.
3245 The condition is evaluated in the outside context.
3246 With prefix argument, make it a temporary breakpoint."
3247 ;; (interactive "P\nxCondition: ")
3250 current-prefix-arg
3251 ;; Edit previous condition as follows, but it is cumbersome:
3270 "Global Condition: "
3275 ;;; Mode switching functions
3278 ;; Set the edebug mode to MODE.
3279 ;; Display SHORTMSG, or MSG if not within edebug.
3284 ;; Continue execution
3286 ;; This is not terribly useful!!
3294 "Proceed to next stop point."
3299 "Proceed to next `after' stop point."
3304 "Go, evaluating until break.
3305 With prefix ARG, set temporary break at current point and go."
3312 "Go, evaluating without debugging."
3319 "Begin trace mode."
3324 "Trace with no wait at each step."
3330 "Begin continue mode."
3336 "Trace with no wait at each step."
3341 ;; ------------------------------------------------------------
3342 ;; The following use the mode changing commands and breakpoints.
3346 "Proceed to this stop point."
3352 "Stop execution and do not continue.
3353 Useful for exiting from trace or continue loop."
3359 "Proceed to the exit of the next expression to be evaluated."
3367 "Proceed from the current point to the end of the ARGth sexp ahead.
3368 If there are not ARG sexps ahead, then do edebug-step-out."
3372 ;; Call forward-sexp repeatedly until done or failure.
3377 )))
3380 "Proceed from the current point to the end of the containing sexp.
3381 If there is no containing sexp that is not the top level defun,
3382 go to the end of the last sexp, or if that is the same point, then step."
3388 ;; Is there still a containing expression?
3392 ;; At top level - 1, so first check if there are more sexps at this level.
3394 ;; (up-list 1)
3399 )))))
3402 ;; Func should be a function symbol.
3403 ;; Return the function symbol, or nil if not instrumented.
3408 ;; It is uninstrumented, so instrument it.
3413 func))
3416 func)
3418 ;; We could try harder, e.g. do a tags search.
3420 nil))))
3423 "Instrument the definition of the function or macro about to be called.
3424 Do this when stopped before the form or it will be too late.
3425 One side effect of using this command is that the next time the
3426 function or macro is called, Edebug will be called there as well."
3441 "Step into the definition of the function or macro about to be called.
3442 This first does `edebug-instrument-callee' to ensure that it is
3443 instrumented. Then it does `edebug-on-entry' and switches to `go' mode."
3452 "Cause Edebug to stop when FUNCTION is called.
3453 With prefix argument, make this temporary so it is automatically
3454 cancelled the first time the function is entered."
3456 ;; Could store this in the edebug data instead.
3467 ;; Also need edebug-cancel-debug-on-entry
3470 "Request FUNCTION to invoke debugger each time it is called.
3471 If the user continues, FUNCTION's execution proceeds.
3472 Works by modifying the definition of FUNCTION,
3473 which must be written in Lisp, not predefined.
3474 Use `cancel-debug-on-entry' to cancel the effect of this command.
3475 Redefining FUNCTION also does that.
3477 This version is from Edebug. If the function is instrumented for
3478 Edebug, it calls `edebug-on-entry'"
3487 "Set mode to Go-nonstop, and exit to top-level.
3488 This is useful for exiting even if unwind-protect code may be executed."
3494 ;;(defun edebug-exit-out ()
3495 ;; "Go until the current function exits."
3496 ;; (interactive)
3497 ;; (edebug-set-mode 'exiting "Exit..."))
3500 ;;; The following initial mode setting definitions are not used yet.
3510 )
3515 "Ask for the initial mode of the enclosing function.
3516 The mode is requested via the key that would be used to set the mode in
3517 edebug-mode."
3521 edebug-mode-map))
3523 edebug-initial-mode))
3526 "Change initial edebug mode for %s from %s (%s) to (enter key): "
3527 this-function
3528 old-mode
3531 keymap 'firstonly
3532 ))))
3534 )
3541 this-function mode))
3543 )))
3545 ;;; Evaluation of expressions
3550 "Evaluate an expression list in the outside context.
3551 Return the result of the last expression."
3555 ;; After excursion, we will
3556 ;; restore to current window configuration.
3559 ;; Restore outside windows.
3563 ;; (use-local-map edebug-outside-map)
3565 ;; Restore outside context.
3588 ;; See edebug-display
3592 )
3601 ;; Back to edebug-buffer. Restore rest of inside context.
3602 ;; (use-local-map edebug-inside-map)
3604 ;; Restore inside windows.
3607 ;; Save values that may have been changed.
3609 edebug-outside-last-command-char last-command-char
3610 edebug-outside-last-command-event last-command-event
3611 edebug-outside-last-command last-command
3612 edebug-outside-this-command this-command
3613 edebug-outside-unread-command-char unread-command-char
3614 edebug-outside-unread-command-event unread-command-event
3615 edebug-outside-unread-command-events unread-command-events
3616 edebug-outside-current-prefix-arg current-prefix-arg
3617 edebug-outside-last-input-char last-input-char
3618 edebug-outside-last-input-event last-input-event
3619 edebug-outside-last-event-frame last-event-frame
3620 edebug-outside-last-nonmenu-event last-nonmenu-event
3621 edebug-outside-track-mouse track-mouse
3622 edebug-outside-standard-output standard-output
3623 edebug-outside-standard-input standard-input
3625 edebug-outside-executing-macro executing-kbd-macro
3626 edebug-outside-defining-kbd-macro defining-kbd-macro
3627 edebug-outside-pre-command-hook pre-command-hook
3628 edebug-outside-post-command-hook post-command-hook
3630 edebug-outside-o-a-p overlay-arrow-position
3631 edebug-outside-o-a-s overlay-arrow-string
3632 edebug-outside-c-i-e-a cursor-in-echo-area
3634 ))
3639 ;; Are there cl lexical variables active?
3645 ;; Evaluate EXPR safely.
3646 ;; If there is an error, a string is returned describing the error.
3653 ;;; Printing
3655 ;; Replace printing functions.
3657 ;; obsolete names
3663 "Replace print functions used by Edebug with custom versions."
3664 ;; Modifying the custom print functions, or changing print-length,
3665 ;; print-level, print-circle, custom-print-list or custom-print-vector
3666 ;; have immediate effect.
3678 "Replace edebug custom print functions with internal versions."
3687 ;; Default print functions are the same as Emacs'.
3692 ;; Print an error message like command level does.
3693 ;; This also prints the error name if it has no error-message.
3698 ;; continuing after an error may
3699 ;; complain about edebug-arg. why??
3703 ;; Define here in case they are not already defined.
3707 ;; Alternatively, we could change the definition of
3708 ;; edebug-safe-prin1-to-string to only use these if defined.
3732 "Print the previous result."
3736 ;;; Read, Eval and Print
3739 "Evaluate an expression in the outside environment.
3740 If interactive, prompt for the expression.
3741 Print result in minibuffer."
3749 "Evaluate sexp before point in the outside environment;
3750 print value in minibuffer."
3755 "Evaluate sexp before point in the outside environment;
3756 print value into current buffer."
3764 ;; princ the string to get rid of quotes.
3767 ))
3769 ;;; Edebug Minor Mode
3771 ;; Global GUD bindings for all emacs-lisp-mode buffers.
3780 nil
3783 ;; control
3793 ;;(define-key edebug-mode-map "f" 'edebug-forward) not implemented
3801 ;; quitting and stopping
3807 ;; breakpoints
3814 ;; evaluation
3820 ;; views
3827 ;; misc
3833 ;; statistics
3836 ;; GUD bindings
3846 ))
3848 ;; Autoloading these global bindings doesn't make sense because
3849 ;; they cannot be used anyway unless Edebug is already loaded and active.
3858 nil
3872 ;; breakpoints
3878 ;; views
3882 ;; quitting
3887 ;; statistics
3889 )
3896 "Mode for Emacs Lisp buffers while in Edebug.
3898 In addition to all Emacs Lisp commands (except those that modify the
3899 buffer) there are local and global key bindings to several Edebug
3903 Also see bindings for the eval list buffer, *edebug*.
3905 The edebug buffer commands:
3908 Global commands prefixed by `global-edebug-prefix':
3911 Options:
3912 edebug-setup-hook
3913 edebug-all-defs
3914 edebug-all-forms
3915 edebug-save-windows
3916 edebug-save-displayed-buffer-points
3917 edebug-initial-mode
3918 edebug-trace
3919 edebug-test-coverage
3920 edebug-continue-kbd-macro
3921 edebug-print-length
3922 edebug-print-level
3923 edebug-print-circle
3924 edebug-on-error
3925 edebug-on-quit
3926 edebug-on-signal
3927 edebug-unwrap-results
3928 edebug-global-break-condition
3929 "
3932 ;;; edebug eval list mode
3934 ;; A list of expressions and their evaluations is displayed in *edebug*.
3937 "Return a list of evaluations of edebug-eval-list"
3938 ;; Assumes in outside environment.
3939 ;; Don't do any edebug things now.
3945 ;; Assumes edebug-eval-buffer exists.
3959 ))
3967 ;; Should generalize this to be callable outside of edebug
3968 ;; with calls in user functions, e.g. (edebug-eval-display)
3971 "Display expressions and evaluations in EVAL-LIST.
3972 It modifies the context by popping up the eval display."
3977 )))
3980 "Redisplay eval list in outside environment.
3981 May only be called from within edebug-recursive-edit."
3985 ))
3994 "Replace the evaluation list with the sexps now in the eval buffer."
3997 new-list)
3999 ;; get the first expression
4021 "Delete the item under point and redisplay."
4022 ;; could add arg to do repeatedly
4038 nil
4046 )
4051 "Mode for evaluation list buffer while in Edebug.
4053 In addition to all Interactive Emacs Lisp commands there are local and
4054 global key bindings to several Edebug specific commands. E.g.
4058 Eval list buffer commands:
4061 Global commands prefixed by global-edebug-prefix:
4063 "
4069 ;;; Interface with standard debugger.
4071 ;; (setq debugger 'edebug) ; to use the edebug debugger
4072 ;; (setq debugger 'debug) ; use the standard debugger
4074 ;; Note that debug and its utilities must be byte-compiled to work,
4075 ;; since they depend on the backtrace looking a certain way. But
4076 ;; edebug is not dependent on this, yet.
4079 "Replacement for debug.
4080 If we are running an edebugged function,
4081 show where we last were. Otherwise call debug normally."
4082 ;; (message "entered: %s depth: %s edebug-recursion-depth: %s"
4083 ;; edebug-entered (recursion-depth) edebug-recursion-depth) (sit-for 1)
4088 ;; Bind variables required by edebug-display
4090 edebug-breakpoints
4091 edebug-break-data
4092 edebug-break-condition
4093 edebug-global-break
4095 )
4098 nil
4099 edebug-value))
4101 ;; Otherwise call debug normally.
4102 ;; Still need to remove extraneous edebug calls from stack.
4104 ))
4108 "Display a non-working backtrace. Better than nothing..."
4114 ;; else, could just display edebug-backtrace-buffer
4115 )
4120 last-ok-point)
4123 ;; Clean up the backtrace.
4124 ;; Not quite right for current edebug scheme.
4131 ;; Delete interspersed edebug internals.
4136 ;; Previous lines may contain code, so just delete this line
4144 )))
4145 )))))
4147 \f
4148 ;;; Trace display
4151 "In buffer BUF-NAME, display FMT and ARGS at the end and make it visible.
4152 The buffer is created if it does not exist.
4153 You must include newlines in FMT to break lines, but one newline is appended."
4154 ;; e.g.
4155 ;; (edebug-trace-display "*trace-point*"
4156 ;; "saving: point = %s window-start = %s"
4157 ;; (point) (window-start))
4161 buf-window)
4162 ;; (message "before pop-to-buffer") (sit-for 1)
4168 ;; Make it visible.
4172 ;; (set-window-point buf-window (point))
4173 ;; (edebug-sit-for 0)
4177 buf-name)
4181 "Convenience call to edebug-trace-display using edebug-trace-buffer"
4184 \f
4185 ;;; Frequency count and coverage
4188 "Display the frequency count data for each line of the current
4189 definition. The frequency counts are inserted as comment lines after
4190 each line, and you can undo all insertions with one `undo' command.
4192 The counts are inserted starting under the `(' before an expression
4193 or the `)' after an expression, or on the last char of a symbol.
4194 The counts are only displayed when they differ from previous counts on
4195 the same line.
4197 If coverage is being tested, whenever all known results of an expression
4198 are `eq', the char `=' will be appended after the count
4199 for that expression. Note that this is always the case for an
4200 expression only evaluated once.
4202 To clear the frequency count and coverage data for a definition,
4203 reinstrument it."
4217 )
4219 ;; Traverse in reverse order so offsets are correct.
4221 ;; Start at last expression in line.
4225 last-index i)
4227 ;; Find all indexes on same line.
4230 ;; Insert all the indices for this line.
4233 first-index i ; really last index for line above this one.
4236 ;; i == first-index still
4257 "Temporarily display the frequency count data for the current definition.
4258 It is removed when you hit any char."
4259 ;; This seems not to work with Emacs 18.59. It undoes too far.
4267 \f
4268 ;;; Menus
4274 ;; We have to require easymenu (even for Emacs 18) just so
4275 ;; the easy-menu-define macro call is compiled correctly.
4280 "----"
4290 "----"
4295 "----"
4325 "----"
4331 ))
4334 \f
4335 ;;; Emacs version specific code
4337 ;;; The default for all above is Emacs 18, because it is easier to compile
4338 ;;; Emacs 18 code in Emacs 19 than vice versa. This default will
4339 ;;; change once most people are using Emacs 19 or derivatives.
4341 ;; Epoch specific code is in a separate file: edebug-epoch.el.
4343 ;; The byte-compiler will complain about changes in number of arguments
4344 ;; to functions like mark and read-from-minibuffer. These warnings
4345 ;; may be ignored because the right call should always be made.
4351 ;; Mark takes an argument in Emacs 19.
4356 "Set a conditional breakpoint at nearest sexp.
4357 The condition is evaluated in the outside context.
4358 With prefix argument, make it a temporary breakpoint."
4359 ;; (interactive "P\nxCondition: ")
4362 current-prefix-arg
4363 ;; Read condition as follows; getting previous condition is cumbersome:
4373 ;; Prepend the current condition, if any.
4376 read-expression-history)))
4379 "Condition: " nil read-expression-map t
4382 ))))))
4386 "Evaluate an expression in the outside environment.
4387 If interactive, prompt for the expression.
4388 Print result in minibuffer."
4390 "Eval: " nil read-expression-map t
4400 )
4405 ;; We need to bind zmacs-regions to nil around all calls to `mark' and
4406 ;; `mark-marker' but don't bind it to nil before entering a recursive edit,
4407 ;; that is, don't interfere with the binding the user might see while
4408 ;; executing a command.
4426 )
4438 \f
4439 ;;; Byte-compiler
4441 ;; Extension for bytecomp to resolve undefined function references.
4442 ;; Requires new byte compiler.
4444 ;; Reenable byte compiler warnings about unread-command-char and -event.
4445 ;; Disabled before edebug-recursive-edit.
4449 edebug-unread-command-char-warning))
4452 edebug-unread-command-event-warning)))
4455 ;; The body of eval-when-compile seems to get evaluated with eval-defun.
4456 ;; We only want to evaluate when actually byte compiling.
4457 ;; But it is OK to evaluate as long as byte-compiler has been loaded.
4461 "Say it is OK for the named functions to be unresolved."
4467 byte-compile-unresolved-functions))))
4468 funcs)
4469 nil)
4472 "Say it is OK for the named variables to be referenced."
4478 vars)
4479 nil)
4482 "Say it is OK for the named variables to be assigned."
4488 vars)
4489 nil)
4493 edebug-gensym ;; also in cl.el
4494 ;; Interfaces to standard functions.
4495 edebug-original-eval-defun
4496 edebug-original-read
4497 edebug-get-buffer-window
4498 edebug-mark
4499 edebug-mark-marker
4500 edebug-input-pending-p
4501 edebug-sit-for
4502 edebug-prin1-to-string
4503 edebug-format
4504 ;; lemacs
4505 zmacs-deactivate-region
4506 popup-menu
4507 ;; CL
4508 cl-macroexpand-all
4509 ;; And believe it or not, the byte compiler doesn't know about:
4510 byte-compile-resolve-functions
4511 ))
4515 read-expression-map))
4520 )))
4522 \f
4523 ;;; Autoloading of Edebug accessories
4528 ;; The following causes cl-specs to be loaded if you load cl.el.
4532 ;;; edebug-cl-read and cl-read are available from liberte@cs.uiuc.edu
4536 ;; The following causes edebug-cl-read to be loaded when you load cl-read.el.
4540 \f
4541 ;;; Finalize Loading
4543 ;;; Finally, hook edebug into the rest of Emacs.
4544 ;;; There are probably some other things that could go here.
4546 ;; Install edebug read and eval functions.
4551 ;;; edebug.el ends here